OpenSSLCryptoSymmetricKey.hpp

Go to the documentation of this file.

/*
 * Copyright 2002-2005 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * XSEC
 *
 * XSECCryptoSymmetricKey := Bulk encryption algorithms should all be
 *                          implemented via this interface
 *
 * Author(s): Berin Lautenbach
 *
 * $Id: OpenSSLCryptoSymmetricKey.hpp,v 1.10 2005/06/04 11:30:26 blautenb Exp $
 *
 */



#ifndef OPENSSLCRYPTOSYMMETRICKEY_INCLUDE
#define OPENSSLCRYPTOSYMMETRICKEY_INCLUDE

#include <xsec/framework/XSECDefs.hpp>
#include <xsec/enc/XSECCryptoSymmetricKey.hpp>

#if defined (HAVE_OPENSSL)

// OpenSSL Includes

#include <openssl/evp.h>

#define MAX_BLOCK_SIZE      32

class DSIG_EXPORT OpenSSLCryptoSymmetricKey : public XSECCryptoSymmetricKey {

public :

    
    OpenSSLCryptoSymmetricKey(XSECCryptoSymmetricKey::SymmetricKeyType type);

    virtual ~OpenSSLCryptoSymmetricKey();



    virtual const XMLCh * getProviderName();

    virtual XSECCryptoKey * clone();



    SymmetricKeyType getSymmetricKeyType(void);

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

    virtual bool decryptInit(bool doPad = true,
                             SymmetricKeyMode mode = MODE_CBC,
                             const unsigned char * iv = NULL);

    virtual unsigned int decrypt(const unsigned char * inBuf, 
                                 unsigned char * plainBuf, 
                                 unsigned int inLength,
                                 unsigned int maxOutLength);

    virtual unsigned int decryptFinish(unsigned char * plainBuf,
                                       unsigned int maxOutLength);

    virtual bool encryptInit(bool doPad = true, 
                             SymmetricKeyMode mode = MODE_CBC,
                             const unsigned char * iv = NULL);

    virtual unsigned int encrypt(const unsigned char * inBuf, 
                                 unsigned char * cipherBuf, 
                                 unsigned int inLength,
                                 unsigned int maxOutLength);

    virtual unsigned int encryptFinish(unsigned char * plainBuf,
                                       unsigned int maxOutLength);


private:

    // Unimplemented constructors
    
    OpenSSLCryptoSymmetricKey();
    OpenSSLCryptoSymmetricKey(const OpenSSLCryptoSymmetricKey &);
    OpenSSLCryptoSymmetricKey & operator= (const OpenSSLCryptoSymmetricKey &);

    // Private functions
    int decryptCtxInit(const unsigned char * iv);

    // Private variables
    SymmetricKeyType                m_keyType;
    SymmetricKeyMode                m_keyMode;
    EVP_CIPHER_CTX                  m_ctx;          // OpenSSL Cipher Context structure
    safeBuffer                      m_keyBuf;       // Holder of the key
    unsigned int                    m_keyLen;
    bool                            m_initialised;  // Is the context ready to work?
    unsigned char                   m_lastBlock[MAX_BLOCK_SIZE];
    int                             m_blockSize;
    int                             m_ivSize;
    int                             m_bytesInLastBlock;
    bool                            m_ivSent;       // Has the IV been put in the stream
    bool                            m_doPad;        // Do we pad last block?
};

#endif /* HAVE_OPENSSL */
#endif /* OPENSSLCRYPTOSYMMETRICKEY_INCLUDE */

---