OsEncryption.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 _OsEncryption_h_
#define _OsEncryption_h_

// SYSTEM INCLUDES
#ifdef HAVE_SSL
#define OSENCRYPTION
#endif

#if defined (OSENCRYPTION)
#include <openssl/evp.h>
#include <openssl/x509.h>
#endif

// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsStatus.h"
#include "os/OsTime.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
#define OE_MAX_KEY_LEN 64

#define OE_MAX_RESULTS_HEADER_LEN 32

// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS


class OsEncryption
{
 public:
    OsEncryption(void);

    virtual ~OsEncryption(void);

    void setDataPointer(unsigned char *pIn, int inLen);

    int getDataLen(void);

    unsigned char *getDataPointer(void);

    void setResultsHeader(const unsigned char *header, int headerLen);

    unsigned char *getResults(void);

    int getResultsLen(void);

    void setKey(const unsigned char *key, int keyLen);

    OsStatus decrypt(void);

    OsStatus encrypt(void);
    
    OsStatus release(void);

    static UtlBoolean sIgnoreEncryption;

 protected:

    enum Direction 
    {
        DECRYPT = 0,
        ENCRYPT = 1
    };

    OsStatus init(Direction direction);
    
    UtlBoolean openSslError(void);

    OsStatus crypto(Direction direction);

 private:


#if defined (OSENCRYPTION)
    X509_ALGOR *mAlgorithm;

    EVP_CIPHER_CTX mContext;
#endif

    unsigned char *mSalt;     // defeats brute force decryption via appling dictionary

    int mSaltLen;

    unsigned char mKey[OE_MAX_KEY_LEN]; // storage of password

    int mKeyLen;

    unsigned char *mData;            // pointer to storage of data

    int mDataLen;

    unsigned char *mResults;         // allocated storage of results

    int mResultsLen;

    unsigned char mHeader[OE_MAX_RESULTS_HEADER_LEN];    // set/expect extra data in results buffer

    int mHeaderLen;

    // TEST: See unittests/EncryptionTest

};

#endif // _OsEncryption_h_