261cfdfedee45a93751928d7a3411cb788841d48
[shibboleth/cpp-opensaml.git] / saml / signature / VerifyingContext.h
1 /*\r
2  *  Copyright 2001-2006 Internet2\r
3  * \r
4  * Licensed under the Apache License, Version 2.0 (the "License");\r
5  * you may not use this file except in compliance with the License.\r
6  * You may obtain a copy of the License at\r
7  *\r
8  *     http://www.apache.org/licenses/LICENSE-2.0\r
9  *\r
10  * Unless required by applicable law or agreed to in writing, software\r
11  * distributed under the License is distributed on an "AS IS" BASIS,\r
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
13  * See the License for the specific language governing permissions and\r
14  * limitations under the License.\r
15  */\r
16 \r
17 /**\r
18  * @file VerifyingContext.h\r
19  * \r
20  * SAML-specific signature verification \r
21  */\r
22 \r
23 #ifndef __saml_verctx_h__\r
24 #define __saml_verctx_h__\r
25 \r
26 #include <saml/base.h>\r
27 #include <xmltooling/signature/VerifyingContext.h>\r
28 \r
29 namespace opensaml {\r
30 \r
31     /**\r
32      * SAML-specific signature profile verification.\r
33      */\r
34     class SAML_API VerifyingContext : public virtual xmlsignature::VerifyingContext\r
35     {\r
36     public:\r
37         /**\r
38          * Constructor.\r
39          * \r
40          * @param id    identifier of object being verified\r
41          */\r
42         VerifyingContext(const XMLCh* id) : m_id(id) {}\r
43         \r
44         virtual ~VerifyingContext() {}\r
45 \r
46         /**\r
47          * Given a native signature, verifies that the signature content\r
48          * is appropriate for the SAML assertion/message being verified.\r
49          * Does <strong>NOT</strong> perform actual cryptographic evaluation\r
50          * of the signature in the absence of policy. Subclasses should\r
51          * override this method with their policies, call the base class\r
52          * and then evaluate further.\r
53          * \r
54          * @param sig   native signature object\r
55          * \r
56          * @throws SignatureException   raised if signature is invalid\r
57          */\r
58         virtual void verifySignature(DSIGSignature* sig) const;\r
59         \r
60     protected:\r
61         /** Identifier of object to verify. */\r
62         const XMLCh* m_id;\r
63     };\r
64 \r
65 };\r
66 \r
67 #endif /* __saml_verctx_h__ */\r