Merge branch '1.x' of ssh://authdev.it.ohio-state.edu/~scantor/git/cpp-xmltooling...

[shibboleth/cpp-xmltooling.git] / xmltooling / signature / SignatureValidator.h

diff --git a/xmltooling/signature/SignatureValidator.h b/xmltooling/signature/SignatureValidator.h
index 5ba231d..ce94637 100644 (file)
--- a/xmltooling/signature/SignatureValidator.h
+++ b/xmltooling/signature/SignatureValidator.h
@@ -1,92 +1,95 @@
-/*
- *  Copyright 2001-2006 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
- * @file SignatureValidator.h
+ * @file xmltooling/signature/SignatureValidator.h
  * 
- * Validator for signatures based on an externally-supplied key 
+ * Validator for signatures based on an externally-supplied key.
  */
 
 #if !defined(__xmltooling_sigval_h__) && !defined(XMLTOOLING_NO_XMLSEC)
 #define __xmltooling_sigval_h__
 
-#include <xmltooling/signature/KeyResolver.h>
-#include <xmltooling/signature/Signature.h>
 #include <xmltooling/validation/Validator.h>
 
+class XSECCryptoKey;
+
+namespace xmltooling {
+    class XMLTOOL_API Credential;
+};
+
 namespace xmlsignature {
 
+    class XMLTOOL_API Signature;
+
     /**
-     * Validator for signatures based on a Key or a KeyResolver
+     * Validator for signatures based on a Credential
      */
     class XMLTOOL_API SignatureValidator : public xmltooling::Validator
     {
     public:
         /**
-         * Constructor using a KeyResolver
+         * Constructor using a key
          * 
-         * @param resolver the key resolver to use, will be freed by Validator
+         * @param key the key to use
          */
-        SignatureValidator(KeyResolver* resolver) : m_key(NULL), m_resolver(resolver) {
-        }
+        SignatureValidator(XSECCryptoKey* key=nullptr);
 
         /**
-         * Constructor using a Key
+         * Constructor using a Credential
          * 
-         * @param key the verification key to use, will be freed by Validator
+         * @param credential the credential to use
          */
-        SignatureValidator(XSECCryptoKey* key=NULL) : m_key(key), m_resolver(NULL) {
-        }
-        
-        virtual ~SignatureValidator() {
-            delete m_key;
-            delete m_resolver;
-        }
+        SignatureValidator(const xmltooling::Credential* credential);
+
+        virtual ~SignatureValidator();
 
-        virtual void validate(const xmltooling::XMLObject* xmlObject) const;
+        void validate(const xmltooling::XMLObject* xmlObject) const;
 
+        /**
+         * Type-safe validator.
+         * 
+         * @param signature object to validate
+         */
         virtual void validate(const Signature* signature) const;
         
         /**
-         * Replace the current Key, if any, with a new one.
+         * Replace the current key, if any, with a new one.
          * 
-         * @param key  the Key to attach 
+         * @param key  the key to attach 
          */
-        void setKey(XSECCryptoKey* key) {
-            delete m_key;
-            delete m_resolver;
-            m_resolver=NULL;
-            m_key=key;
-        }
+        void setKey(XSECCryptoKey* key);
 
         /**
-         * Replace the current KeyResolver, if any, with a new one.
+         * Replace the current Credential, if any, with a new one.
          * 
-         * @param resolver  the KeyResolver to attach 
+         * @param credential  the Credential to attach 
          */
-        void setKeyResolver(KeyResolver* resolver) {
-            delete m_key;
-            delete m_resolver;
-            m_key=NULL;
-            m_resolver=resolver;
-        }
+        void setCredential(const xmltooling::Credential* credential);
     
     protected:
+        /** Verification key. */
         XSECCryptoKey* m_key;
-        KeyResolver* m_resolver;
+
+        /** Verification credential. */
+        const xmltooling::Credential* m_credential;
     };
 
 };