Fix linefeeds
[shibboleth/cpp-opensaml.git] / saml / security / TrustEngine.h
index 69ebe26..3ca02b4 100644 (file)
@@ -1,89 +1,89 @@
-/*\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 saml/security/TrustEngine.h\r
- * \r
- * SAML-specific TrustEngine API\r
- */\r
-\r
-#ifndef __saml_trust_h__\r
-#define __saml_trust_h__\r
-\r
-#include <saml/base.h>\r
-#include <saml/saml2/metadata/Metadata.h>\r
-#include <xmltooling/signature/KeyResolver.h>\r
-\r
-namespace opensaml {\r
-\r
-    /**\r
-     * Adapts SAML metadata as a source of KeyInfo for a TrustEngine\r
-     * and adds SAML-specific signature validation.\r
-     */\r
-    class SAML_API TrustEngine {\r
-        MAKE_NONCOPYABLE(TrustEngine);\r
-    protected:\r
-        /**\r
-         * Constructor.\r
-         * \r
-         * If a DOM is supplied, the following XML content is supported:\r
-         * \r
-         * <ul>\r
-         *  <li>&lt;KeyResolver&gt; elements with a type attribute\r
-         * </ul>\r
-         * \r
-         * XML namespaces are ignored in the processing of this content.\r
-         * \r
-         * @param e DOM to supply configuration for provider\r
-         */\r
-        TrustEngine(const DOMElement* e=NULL) {}\r
-        \r
-    public:\r
-        virtual ~TrustEngine() {}\r
-\r
-        /**\r
-         * Determines whether a signed SAML object is correct and valid with respect\r
-         * to the information known about the issuer.\r
-         * \r
-         * A custom KeyResolver can be supplied from outside the TrustEngine.\r
-         * Alternatively, one may be specified to the plugin constructor.\r
-         * A non-caching, inline resolver will be used as a fallback.\r
-         * \r
-         * @param sig           reference to a signature object to validate\r
-         * @param role          metadata role supplying key information\r
-         * @param keyResolver   optional externally supplied KeyResolver, or NULL\r
-         */\r
-        virtual bool validate(\r
-            xmlsignature::Signature& sig,\r
-            const saml2md::RoleDescriptor& role,\r
-            const xmlsignature::KeyResolver* keyResolver=NULL\r
-            ) const=0;\r
-    };\r
-    \r
-\r
-    /**\r
-     * Registers TrustEngine classes into the runtime.\r
-     */\r
-    void SAML_API registerTrustEngines();\r
-\r
-    /** TrustEngine based on explicit key information resolved from metadata. */\r
-    #define EXPLICIT_KEY_SAMLTRUSTENGINE  "org.opensaml.security.ExplicitKeyTrustEngine"\r
-\r
-    /** TrustEngine that tries multiple engines in sequence. */\r
-    #define CHAINING_SAMLTRUSTENGINE  "org.opensaml.security.ChainingTrustEngine"\r
-};\r
-\r
-#endif /* __saml_trust_h__ */\r
+/*
+ *  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
+ *
+ *     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 saml/security/TrustEngine.h
+ * 
+ * SAML-specific TrustEngine API
+ */
+
+#ifndef __saml_trust_h__
+#define __saml_trust_h__
+
+#include <saml/base.h>
+#include <saml/saml2/metadata/Metadata.h>
+#include <xmltooling/signature/KeyResolver.h>
+
+namespace opensaml {
+
+    /**
+     * Adapts SAML metadata as a source of KeyInfo for a TrustEngine
+     * and adds SAML-specific signature validation.
+     */
+    class SAML_API TrustEngine {
+        MAKE_NONCOPYABLE(TrustEngine);
+    protected:
+        /**
+         * Constructor.
+         * 
+         * If a DOM is supplied, the following XML content is supported:
+         * 
+         * <ul>
+         *  <li>&lt;KeyResolver&gt; elements with a type attribute
+         * </ul>
+         * 
+         * XML namespaces are ignored in the processing of this content.
+         * 
+         * @param e DOM to supply configuration for provider
+         */
+        TrustEngine(const DOMElement* e=NULL) {}
+        
+    public:
+        virtual ~TrustEngine() {}
+
+        /**
+         * Determines whether a signed SAML object is correct and valid with respect
+         * to the information known about the issuer.
+         * 
+         * A custom KeyResolver can be supplied from outside the TrustEngine.
+         * Alternatively, one may be specified to the plugin constructor.
+         * A non-caching, inline resolver will be used as a fallback.
+         * 
+         * @param sig           reference to a signature object to validate
+         * @param role          metadata role supplying key information
+         * @param keyResolver   optional externally supplied KeyResolver, or NULL
+         */
+        virtual bool validate(
+            xmlsignature::Signature& sig,
+            const saml2md::RoleDescriptor& role,
+            const xmlsignature::KeyResolver* keyResolver=NULL
+            ) const=0;
+    };
+    
+
+    /**
+     * Registers TrustEngine classes into the runtime.
+     */
+    void SAML_API registerTrustEngines();
+
+    /** TrustEngine based on explicit key information resolved from metadata. */
+    #define EXPLICIT_KEY_SAMLTRUSTENGINE  "org.opensaml.security.ExplicitKeyTrustEngine"
+
+    /** TrustEngine that tries multiple engines in sequence. */
+    #define CHAINING_SAMLTRUSTENGINE  "org.opensaml.security.ChainingTrustEngine"
+};
+
+#endif /* __saml_trust_h__ */