OsTLS.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _OsTLS_h_
#define _OsTLS_h_



// SYSTEM INCLUDES

// APPLICATION INCLUDES                      
#include "os/OsBSem.h"
#include "os/OsSysLog.h"
#include "utl/UtlString.h"
#include "utl/UtlHashMap.h"

#include <nspr.h>
#include <seccomon.h>
#include <secmod.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS                                       
// EXTERNAL VARIABLES
// CONSTANTS
#define MAX_CERT_DIR_LENGTH 256
// STRUCTS
// ENUMERATIONS
typedef enum SECURITY_CAUSE
{
    E_SECURITY_CAUSE_UNKNOWN = 0,                      
    E_SECURITY_CAUSE_NORMAL,                           
    E_SECURITY_CAUSE_ENCRYPT_SUCCESS,                  
    E_SECURITY_CAUSE_ENCRYPT_FAILURE_LIB_INIT,         
    E_SECURITY_CAUSE_ENCRYPT_FAILURE_BAD_PUBLIC_KEY,   
    E_SECURITY_CAUSE_ENCRYPT_FAILURE_INVALID_PARAMETER,
    E_SECURITY_CAUSE_DECRYPT_SUCCESS,                  
    E_SECURITY_CAUSE_DECRYPT_FAILURE_DB_INIT,          
    E_SECURITY_CAUSE_DECRYPT_FAILURE_BAD_DB_PASSWORD,  
    E_SECURITY_CAUSE_DECRYPT_FAILURE_INVALID_PARAMETER,
    E_SECURITY_CAUSE_DECRYPT_BAD_SIGNATURE,            
    E_SECURITY_CAUSE_DECRYPT_MISSING_SIGNATURE,        
    E_SECURITY_CAUSE_DECRYPT_SIGNATURE_REJECTED,       
    E_SECURITY_CAUSE_TLS_SERVER_CERTIFICATE,
    E_SECURITY_CAUSE_TLS_BAD_PASSWORD,
    E_SECURITY_CAUSE_TLS_LIBRARY_FAILURE,
    E_SECURITY_CAUSE_REMOTE_HOST_UNREACHABLE,
    E_SECURITY_CAUSE_TLS_CONNECTION_FAILURE,
    E_SECURITY_CAUSE_TLS_HANDSHAKE_FAILURE,
    E_SECURITY_CAUSE_SIGNATURE_NOTIFY,                
    E_SECURITY_CAUSE_TLS_CERTIFICATE_REJECTED         
} SECURITY_CAUSE;

// TYPEDEFS
// FORWARD DECLARATIONS


class ITlsSink
{
public:
    virtual bool onServerCertificate(void* pCert, char* serverHostName) = 0;
    virtual bool onTlsEvent(int cause) = 0;
};

#ifdef SIP_TLS_NSS
// Singleton class for invoking NSS functions.
class OsTLS
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
private:
    OsTLS();
public:
    virtual ~OsTLS();


    static OsStatus Initialize(const char* szCertDir);
    static SECStatus GetClientAuthData(void *arg,
                                   PRFileDesc *socket,
                                   struct CERTDistNamesStr *caNames,
                                   struct CERTCertificateStr **pRetCert,
                                   struct SECKEYPrivateKeyStr **pRetKey);

    static SECStatus AuthCertificate(void *arg,
                                     PRFileDesc *socket,
                                     PRBool checksig,
                                     PRBool isServer) ;

    static SECStatus BadCertHandler(void *arg, PRFileDesc *socket);
    static SECStatus HandshakeCallback(PRFileDesc *socket, void *arg); 
    static char* PasswordCallback(PK11SlotInfo *slot, PRBool retry, void *arg);
    
    static void setTlsSink(PRFileDesc* key, ITlsSink* pSink);
    static ITlsSink* getTlsSink(PRFileDesc* key);
    static void removeTlsSink(PRFileDesc* key);
private:

    static UtlHashMap* mpSinkMap;
};




/* ============================ INLINE METHODS ============================ */

#endif

#endif  // _OsTLS_h_