pssl.h

Go to the documentation of this file.

/*
 * pssl.h
 *
 * Secure Sockets Layer channel interface class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-2002 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: pssl.h,v $
 * Revision 1.20  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.19  2002/11/06 22:47:24  robertj
 * Fixed header comment (copyright etc)
 *
 * Revision 1.18  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.17  2002/03/28 07:26:36  robertj
 * Added Diffie-Hellman parameters wrapper class.
 *
 * Revision 1.16  2001/12/13 09:15:20  robertj
 * Added function to get private key as ray DER binary data or as base64 string.
 *
 * Revision 1.15  2001/12/06 04:06:03  robertj
 * Removed "Win32 SSL xxx" build configurations in favour of system
 *   environment variables to select optional libraries.
 *
 * Revision 1.14  2001/10/31 01:30:40  robertj
 * Added enhancements for saving/loading/creating certificates and keys.
 *
 * Revision 1.13  2001/09/10 02:51:22  robertj
 * Major change to fix problem with error codes being corrupted in a
 *   PChannel when have simultaneous reads and writes in threads.
 *
 * Revision 1.12  2001/06/01 00:53:59  robertj
 * Added certificate constructor that takes a PBYTEArray
 *
 * Revision 1.11  2001/05/16 06:02:05  craigs
 * Changed to allow detection of non-SSL connection to SecureHTTPServiceProcess
 *
 * Revision 1.10  2000/11/14 08:33:16  robertj
 * Added certificate and private key classes.
 *
 * Revision 1.9  2000/08/25 08:11:02  robertj
 * Fixed OpenSSL support so can operate as a server channel.
 *
 * Revision 1.8  2000/08/04 12:52:18  robertj
 * SSL changes, added error functions, removed need to have openssl include directory in app.
 *
 * Revision 1.7  2000/01/10 02:23:18  craigs
 * Update for new OpenSSL
 *
 * Revision 1.6  1999/02/16 08:07:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.5  1998/12/04 13:01:51  craigs
 * Changed for SSLeay 0.9
 *
 * Revision 1.4  1998/09/23 06:19:50  robertj
 * Added open source copyright license.
 *
 * Revision 1.3  1997/05/04 02:49:52  craigs
 * Added support for client and server certificates
 *
 * Revision 1.1  1996/11/15 07:37:48  craigs
 * Initial revision
 *
 */

#ifndef _PSSL_H
#define _PSSL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/sockets.h>


struct ssl_st;
struct ssl_ctx_st;
struct x509_st;
struct evp_pkey_st;
struct dh_st;

enum PSSLFileTypes {
  PSSLFileTypePEM,
  PSSLFileTypeASN1,
  PSSLFileTypeDEFAULT
};


class PSSLPrivateKey : public PObject
{
  PCLASSINFO(PSSLPrivateKey, PObject);
  public:
    PSSLPrivateKey();

    PSSLPrivateKey(
      unsigned modulus,   
      void (*callback)(int,int,void *) = NULL,  
      void *cb_arg = NULL                       
    );

    PSSLPrivateKey(
      const PFilePath & keyFile,  
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

    PSSLPrivateKey(
      const BYTE * keyData,   
      PINDEX keySize          
    );

    PSSLPrivateKey(
      const PBYTEArray & keyData  
    );

    PSSLPrivateKey(
      const PSSLPrivateKey & privKey
    );

    PSSLPrivateKey & operator=(
      const PSSLPrivateKey & privKay
    );

    ~PSSLPrivateKey();

    operator evp_pkey_st *() const { return key; }

    BOOL Create(
      unsigned modulus,   
      void (*callback)(int,int,void *) = NULL,  
      void *cb_arg = NULL                       
    );

    PBYTEArray GetData() const;

    PString AsString() const;

    BOOL Load(
      const PFilePath & keyFile,  
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

    BOOL Save(
      const PFilePath & keyFile,  
      BOOL append = FALSE,        
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );


  protected:
    evp_pkey_st * key;
};


class PSSLCertificate : public PObject
{
  PCLASSINFO(PSSLCertificate, PObject);
  public:
    PSSLCertificate();

    PSSLCertificate(
      const PFilePath & certFile, 
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

    PSSLCertificate(
      const BYTE * certData,  
      PINDEX certSize        
    );

    PSSLCertificate(
      const PBYTEArray & certData  
    );

    PSSLCertificate(
      const PString & certString  
    );

    PSSLCertificate(
      const PSSLCertificate & cert
    );

    PSSLCertificate & operator=(
      const PSSLCertificate & cert
    );

    ~PSSLCertificate();

    operator x509_st *() const { return certificate; }

    BOOL CreateRoot(
      const PString & subject,    
      const PSSLPrivateKey & key  
    );

    PBYTEArray GetData() const;

    PString AsString() const;

    BOOL Load(
      const PFilePath & certFile, 
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

    BOOL Save(
      const PFilePath & keyFile,  
      BOOL append = FALSE,        
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );


  protected:
    x509_st * certificate;
};


class PSSLDiffieHellman : public PObject
{
  PCLASSINFO(PSSLDiffieHellman, PObject);
  public:
    PSSLDiffieHellman();

    PSSLDiffieHellman(
      const PFilePath & dhFile, 
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

    PSSLDiffieHellman(
      const BYTE * pData, 
      PINDEX pSize,       
      const BYTE * gData, 
      PINDEX gSize        
    );

    PSSLDiffieHellman(
      const PSSLDiffieHellman & dh
    );

    PSSLDiffieHellman & operator=(
      const PSSLDiffieHellman & dh
    );

    ~PSSLDiffieHellman();

    operator dh_st *() const { return dh; }

    BOOL Load(
      const PFilePath & dhFile, 
      PSSLFileTypes fileType = PSSLFileTypeDEFAULT  
    );

  protected:
    dh_st * dh;
};


class PSSLContext {
  public:
    PSSLContext(
      const void * sessionId = NULL,  
      PINDEX idSize = 0               
    );

    ~PSSLContext();

    operator ssl_ctx_st *() const { return context; }

    BOOL SetCAPath(
      const PDirectory & caPath   
    );

    BOOL SetCAFile(
      const PFilePath & caFile    
    );

    BOOL UseCertificate(
      const PSSLCertificate & certificate
    );

    BOOL UsePrivateKey(
      const PSSLPrivateKey & key
    );

    BOOL UseDiffieHellman(
      const PSSLDiffieHellman & dh
    );

    BOOL SetCipherList(
      const PString & ciphers   
    );

  protected:
    ssl_ctx_st * context;
};


class PSSLChannel : public PIndirectChannel
{
  PCLASSINFO(PSSLChannel, PIndirectChannel)
  public:
    PSSLChannel(
      PSSLContext * context = NULL,   
      BOOL autoDeleteContext = FALSE  
    );
    PSSLChannel(
      PSSLContext & context           
    );

    ~PSSLChannel();

    // Overrides from PChannel
    virtual BOOL Read(void * buf, PINDEX len);
    virtual BOOL Write(const void * buf, PINDEX len);
    virtual BOOL Close();
    virtual BOOL Shutdown(ShutdownValue) { return TRUE; }
    virtual PString GetErrorText(ErrorGroup group = NumErrorGroups) const;
    virtual BOOL ConvertOSError(int error, ErrorGroup group = LastGeneralError);

    // New functions
    BOOL Accept();

    BOOL Accept(
      PChannel & channel  
    );

    BOOL Accept(
      PChannel * channel,     
      BOOL autoDelete = TRUE  
    );


    BOOL Connect();

    BOOL Connect(
      PChannel & channel  
    );

    BOOL Connect(
      PChannel * channel,     
      BOOL autoDelete = TRUE  
    );

    BOOL UseCertificate(
      const PSSLCertificate & certificate
    );

    BOOL UsePrivateKey(
      const PSSLPrivateKey & key
    );

    enum VerifyMode {
      VerifyNone,
      VerifyPeer,
      VerifyPeerMandatory,
    };

    void SetVerifyMode(
      VerifyMode mode
    );

    PSSLContext * GetContext() const { return context; }

    virtual BOOL RawSSLRead(void * buf, PINDEX & len);

  protected:
    virtual BOOL OnOpen();

  protected:
    PSSLContext * context;
    BOOL          autoDeleteContext;
    ssl_st      * ssl;
};

#endif // _PSSL_H

---