XENCCipher.hpp

Go to the documentation of this file.

/*
 * Copyright 2003-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
 *
 * XENCCipher := Interface definition for main encryption worker class
 *
 * $Id: XENCCipher.hpp,v 1.14 2005/02/03 13:58:14 milan Exp $
 *
 */

#ifndef XENCCIPHER_INCLUDE
#define XENCCIPHER_INCLUDE

// XSEC Includes

#include <xsec/framework/XSECDefs.hpp>
#include <xsec/xenc/XENCCipherData.hpp>
#include <xsec/dsig/DSIGConstants.hpp>

// Xerces

XSEC_DECLARE_XERCES_CLASS(DOMElement);
XSEC_DECLARE_XERCES_CLASS(DOMDocument);
XSEC_DECLARE_XERCES_CLASS(BinInputStream);

class XSECCryptoKey;
class XENCEncryptedData;
class XENCEncryptedKey;
class XSECKeyInfoResolver;
class XSECBinTXFMInputStream;
class TXFMChain;

class XENCCipher {

public:
    
    
    virtual ~XENCCipher() {};



    virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * decryptElement(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * element
    ) = 0;

    virtual XSECBinTXFMInputStream * decryptToBinInputStream(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * element
    ) = 0;

    virtual int decryptKey(
        XENCEncryptedKey * encryptedKey,
        XMLByte * rawKey,
        int maxKeySize
    ) = 0;

    virtual int decryptKey(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * keyNode,
        XMLByte * rawKey,
        int maxKeySize
    ) = 0;



    virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * encryptElement(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * element,
        encryptionMethod em,
        const XMLCh * algorithmURI = NULL
    ) = 0;

    virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * encryptElementContent(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * element,
        encryptionMethod em,
        const XMLCh * algorithmURI = NULL
    ) = 0;

    virtual XENCEncryptedKey * encryptKey(
        const unsigned char * keyBuffer,
        unsigned int keyLen,
        encryptionMethod em,
        const XMLCh * algorithmURI = NULL
    ) = 0;

    virtual XENCEncryptedData * encryptBinInputStream(
        XERCES_CPP_NAMESPACE_QUALIFIER BinInputStream * plainText,
        encryptionMethod em,
        const XMLCh * algorithmURI = NULL
    ) = 0;

    virtual XENCEncryptedData * encryptTXFMChain(
        TXFMChain * plainText,
        encryptionMethod em,
        const XMLCh * algorithmURI = NULL
    ) = 0;



    virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * getDocument(void) = 0;

    virtual const XMLCh * getXENCNSPrefix(void) const = 0;

    virtual XENCEncryptedData * getEncryptedData(void) = 0;

    virtual bool getPrettyPrint(void) = 0;



    virtual void setKey(XSECCryptoKey * key) = 0;

    virtual void setKEK(XSECCryptoKey * key) = 0;

    virtual void setKeyInfoResolver(const XSECKeyInfoResolver * resolver) = 0;

    virtual void setXENCNSPrefix(const XMLCh * prefix) = 0;

    virtual void setPrettyPrint(bool flag) = 0;



    virtual XENCEncryptedData * createEncryptedData(XENCCipherData::XENCCipherDataType type,
                                                    const XMLCh * algorithm,
                                                    const XMLCh * value) = 0;

    virtual XENCEncryptedKey * loadEncryptedKey(
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * keyNode
        ) = 0;


};

/*\@}*/

#endif /* XENCCIPHER_INCLUDE */

---