Credential resolver plugin
[shibboleth/cpp-xmltooling.git] / xmltooling / signature / OpenSSLCredentialResolver.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 xmltooling/signature/OpenSSLCredentialResolver.h\r
19  * \r
20  * OpenSSL-specific credential resolver\r
21  */\r
22 \r
23 #if !defined(__xmltooling_opensslcredres_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
24 #define __xmltooling_opensslcredres_h__\r
25 \r
26 #include <xmltooling/signature/CredentialResolver.h>\r
27 \r
28 #include <openssl/ssl.h>\r
29 \r
30 namespace xmlsignature {\r
31 \r
32     /**\r
33      * An OpenSSL-specific API for resolving local/owned keys and certificates\r
34      */\r
35     class XMLTOOL_API OpenSSLCredentialResolver : public CredentialResolver\r
36     {\r
37     protected:\r
38         OpenSSLCredentialResolver() {}\r
39         \r
40     public:\r
41         virtual ~OpenSSLCredentialResolver() {}\r
42         \r
43         /**\r
44          * Attaches credentials to an OpenSSL SSL context object.\r
45          * The resolver is unlockable after attachment.\r
46          * \r
47          * @param ctx   an SSL context\r
48          */\r
49         virtual void attach(SSL_CTX* ctx) const=0;\r
50     };\r
51 \r
52 };\r
53 \r
54 #endif /* __xmltooling_opensslcredres_h__ */\r