xmltooling/security/OpenSSLCredential.h

   1 /*
   2  *  Copyright 2001-2009 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/security/OpenSSLCredential.h
  19  *
  20  * OpenSSL-specific credential
  21  */
  22
  23 #if !defined(__xmltooling_opensslcred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_opensslcred_h__
  25
  26 #include <xmltooling/security/X509Credential.h>
  27
  28 #include <openssl/ssl.h>
  29
  30 namespace xmltooling {
  31
  32     /**
  33      * An OpenSSL-specific credential
  34      */
  35     class XMLTOOL_API OpenSSLCredential : public virtual X509Credential
  36     {
  37     protected:
  38         OpenSSLCredential();
  39
  40     public:
  41         virtual ~OpenSSLCredential();
  42
  43         /**
  44          * Attaches credential to an OpenSSL SSL context object.
  45          * The credential <strong>MUST</strong> be disposable 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_opensslcred_h__ */