Update copyright.
[shibboleth/cpp-xmltooling.git] / xmltooling / signature / OpenSSLCredentialResolver.h
1 /*
2  *  Copyright 2001-2007 Internet2
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /**
18  * @file xmltooling/signature/OpenSSLCredentialResolver.h
19  * 
20  * OpenSSL-specific credential resolver
21  */
22
23 #if !defined(__xmltooling_opensslcredres_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_opensslcredres_h__
25
26 #include <xmltooling/signature/CredentialResolver.h>
27
28 #include <openssl/ssl.h>
29
30 namespace xmlsignature {
31
32     /**
33      * An OpenSSL-specific API for resolving local/owned keys and certificates
34      */
35     class XMLTOOL_API OpenSSLCredentialResolver : public CredentialResolver
36     {
37     protected:
38         OpenSSLCredentialResolver() {}
39         
40     public:
41         virtual ~OpenSSLCredentialResolver() {}
42         
43         /**
44          * Attaches credentials to an OpenSSL SSL context object.
45          * The resolver <strong>MUST</strong> be unlockable after attachment.
46          * 
47          * @param ctx   an SSL context
48          */
49         virtual void attach(SSL_CTX* ctx) const=0;
50     };
51
52 };
53
54 #endif /* __xmltooling_opensslcredres_h__ */