XSECCryptoSymmetricKey.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: XSECCryptoSymmetricKey.hpp,v 1.10 2005/06/04 11:30:26 blautenb Exp $
 *
 */



#ifndef XSECCRYPTOSYMMETRICKEY_INCLUDE
#define XSECCRYPTOSYMMETRICKEY_INCLUDE

#include <xsec/framework/XSECDefs.hpp>
#include <xsec/dsig/DSIGConstants.hpp>
#include <xsec/enc/XSECCryptoKey.hpp>

class DSIG_EXPORT XSECCryptoSymmetricKey : public XSECCryptoKey {

public :

    enum SymmetricKeyType {

        KEY_NONE,
        KEY_3DES_192,           
        KEY_AES_128,            
        KEY_AES_192,            
        KEY_AES_256             
    };

    enum SymmetricKeyMode {

        MODE_NONE,                  
        MODE_ECB,                   
        MODE_CBC                    
    };


    
    XSECCryptoSymmetricKey() {};

    virtual ~XSECCryptoSymmetricKey() {};



    virtual KeyType getKeyType() {return KEY_SYMMETRIC;}

    virtual const XMLCh * getProviderName() = 0;

    virtual XSECCryptoKey * clone() = 0;



    virtual SymmetricKeyType getSymmetricKeyType(void) = 0;

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

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

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

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

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

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

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


};


#endif /* XSECCRYPTOSYMMETRICKEY_INCLUDE */

---