xmltooling/signature/SignatureValidator.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/signature/SignatureValidator.h
  23  *
  24  * Validator for signatures based on an externally-supplied key.
  25  */
  26
  27 #if !defined(__xmltooling_sigval_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_sigval_h__
  29
  30 #include <xmltooling/validation/Validator.h>
  31
  32 class XSECCryptoKey;
  33
  34 namespace xmltooling {
  35     class XMLTOOL_API Credential;
  36 };
  37
  38 namespace xmlsignature {
  39
  40     class XMLTOOL_API Signature;
  41
  42     /**
  43      * Validator for signatures based on a Credential
  44      */
  45     class XMLTOOL_API SignatureValidator : public xmltooling::Validator
  46     {
  47     public:
  48         /**
  49          * Constructor using a key
  50          *
  51          * @param key the key to use
  52          */
  53         SignatureValidator(XSECCryptoKey* key=nullptr);
  54
  55         /**
  56          * Constructor using a Credential
  57          *
  58          * @param credential the credential to use
  59          */
  60         SignatureValidator(const xmltooling::Credential* credential);
  61
  62         virtual ~SignatureValidator();
  63
  64         void validate(const xmltooling::XMLObject* xmlObject) const;
  65
  66         /**
  67          * Type-safe validator.
  68          *
  69          * @param signature object to validate
  70          */
  71         virtual void validate(const Signature* signature) const;
  72
  73         /**
  74          * Replace the current key, if any, with a new one.
  75          *
  76          * @param key  the key to attach
  77          */
  78         void setKey(XSECCryptoKey* key);
  79
  80         /**
  81          * Replace the current Credential, if any, with a new one.
  82          *
  83          * @param credential  the Credential to attach
  84          */
  85         void setCredential(const xmltooling::Credential* credential);
  86
  87     protected:
  88         /** Verification key. */
  89         XSECCryptoKey* m_key;
  90
  91         /** Verification credential. */
  92         const xmltooling::Credential* m_credential;
  93     };
  94
  95 };
  96
  97 #endif /* __xmltooling_sigval_h__ */