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 4dc362a..ce94637 100644 (file)
--- a/xmltooling/signature/SignatureValidator.h
+++ b/xmltooling/signature/SignatureValidator.h
@@ -1,78 +1,97 @@
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file SignatureValidator.h\r
- * \r
- * Validator for signatures based on an externally-supplied key \r
- */\r
-\r
-#if !defined(__xmltooling_sigval_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
-#define __xmltooling_sigval_h__\r
-\r
-#include <xmltooling/signature/KeyResolver.h>\r
-#include <xmltooling/signature/Signature.h>\r
-#include <xmltooling/validation/Validator.h>\r
-\r
-namespace xmlsignature {\r
-\r
-    /**\r
-     * Validator for signatures based on a KeyResolver\r
-     */\r
-    class XMLTOOL_API SignatureValidator : public virtual xmltooling::Validator\r
-    {\r
-    public:\r
-        /**\r
-         * Constructor\r
-         * \r
-         * @param resolver   the key resolver to use, will be freed by Validator\r
-         */\r
-        SignatureValidator(KeyResolver* resolver) : m_resolver(resolver) {\r
-        }\r
-        \r
-        virtual ~SignatureValidator() {\r
-            delete m_resolver;\r
-        }\r
-\r
-        void validate(const xmltooling::XMLObject* xmlObject) const;\r
-\r
-        virtual void validate(const Signature* signature) const;\r
-        \r
-        SignatureValidator* clone() const {\r
-            return new SignatureValidator(*this);\r
-        }\r
-\r
-        /**\r
-         * Replace the current KeyResolver, if any, with a new one.\r
-         * \r
-         * @param resolver  the KeyResolver to attach \r
-         */\r
-        void setKeyResolver(KeyResolver* resolver) {\r
-            delete m_resolver;\r
-            m_resolver=resolver;\r
-        }\r
-    \r
-    protected:\r
-        SignatureValidator(const SignatureValidator& src) {\r
-            m_resolver=src.m_resolver ? src.m_resolver->clone() : NULL;\r
-        }\r
-\r
-        KeyResolver* m_resolver;\r
-    };\r
-\r
-};\r
-\r
-#endif /* __xmltooling_sigval_h__ */\r
+/**
+ * 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.
+ *
+ * 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
+ *
+ * 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 xmltooling/signature/SignatureValidator.h
+ * 
+ * Validator for signatures based on an externally-supplied key.
+ */
+
+#if !defined(__xmltooling_sigval_h__) && !defined(XMLTOOLING_NO_XMLSEC)
+#define __xmltooling_sigval_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 Credential
+     */
+    class XMLTOOL_API SignatureValidator : public xmltooling::Validator
+    {
+    public:
+        /**
+         * Constructor using a key
+         * 
+         * @param key the key to use
+         */
+        SignatureValidator(XSECCryptoKey* key=nullptr);
+
+        /**
+         * Constructor using a Credential
+         * 
+         * @param credential the credential to use
+         */
+        SignatureValidator(const xmltooling::Credential* credential);
+
+        virtual ~SignatureValidator();
+
+        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.
+         * 
+         * @param key  the key to attach 
+         */
+        void setKey(XSECCryptoKey* key);
+
+        /**
+         * Replace the current Credential, if any, with a new one.
+         * 
+         * @param credential  the Credential to attach 
+         */
+        void setCredential(const xmltooling::Credential* credential);
+    
+    protected:
+        /** Verification key. */
+        XSECCryptoKey* m_key;
+
+        /** Verification credential. */
+        const xmltooling::Credential* m_credential;
+    };
+
+};
+
+#endif /* __xmltooling_sigval_h__ */