xmltooling/security/OpenSSLCredential.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/security/OpenSSLCredential.h
  23  *
  24  * OpenSSL-specific credential
  25  */
  26
  27 #if !defined(__xmltooling_opensslcred_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  28 #define __xmltooling_opensslcred_h__
  29
  30 #include <xmltooling/security/X509Credential.h>
  31
  32 #include <openssl/ssl.h>
  33
  34 namespace xmltooling {
  35
  36     /**
  37      * An OpenSSL-specific credential
  38      */
  39     class XMLTOOL_API OpenSSLCredential : public virtual X509Credential
  40     {
  41     protected:
  42         OpenSSLCredential();
  43
  44     public:
  45         virtual ~OpenSSLCredential();
  46
  47         /**
  48          * Attaches credential to an OpenSSL SSL context object.
  49          * The credential <strong>MUST</strong> be disposable after attachment.
  50          *
  51          * @param ctx   an SSL context
  52          */
  53         virtual void attach(SSL_CTX* ctx) const=0;
  54     };
  55
  56 };
  57
  58 #endif /* __xmltooling_opensslcred_h__ */