DSIGKeyInfoList.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
 *
 * DSIGKeyInfoList := Class for Loading and storing a list of KeyInfo elements
 *                   
 * $Id: DSIGKeyInfoList.hpp,v 1.12 2005/06/04 11:30:25 blautenb Exp $
 *
 */

#ifndef DSIGKEYINFOLIST_INCLUDE
#define DSIGKEYINFOLIST_INCLUDE


// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/dsig/DSIGKeyInfo.hpp>
#include <xsec/utils/XSECSafeBufferFormatter.hpp>
#include <xsec/enc/XSECCryptoKey.hpp>

// Xerces
#include <xercesc/dom/DOM.hpp>

// General includes
#include <vector>

// Forward definitions
class DSIGKeyInfoValue;
class DSIGKeyInfoX509;
class DSIGKeyInfoName;
class DSIGKeyInfoPGPData;
class DSIGKeyInfoSPKIData;
class DSIGKeyInfoMgmtData;
class DSIGSignature;

class DSIG_EXPORT DSIGKeyInfoList {

public:

#if defined(XSEC_NO_NAMESPACES)
    typedef vector<DSIGKeyInfo *>           KeyInfoListVectorType;
#else
    typedef std::vector<DSIGKeyInfo *>      KeyInfoListVectorType;
#endif

#if defined(XSEC_SIZE_T_IN_NAMESPACE_STD)
    typedef std::size_t     size_type;
#else
    typedef size_t          size_type;
#endif


    DSIGKeyInfoList(const XSECEnv * env);

    ~DSIGKeyInfoList();



    size_t getSize();

    /*
     * \brief Get an item
     *
     * Returns the item at index point in the list
     *
     * @note This is an internal function and should not be called directly
     *
     * @param index Pointer into the list
     * @returns The indicated element or 0 if it does not exist.
     */

    DSIGKeyInfo * item(size_type index);



    void addKeyInfo(DSIGKeyInfo * ref);

    void addAndInsertKeyInfo(DSIGKeyInfo * ref);    
    
    bool addXMLKeyInfo(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *ki);

    bool loadListFromXML(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * node);

    /*
     * \brief Remove a KeyInfo from the list
     *
     * Removes the KeyInfo element at the indicated index point in the list
     *
     * @param index Pointer in the list to remove element from
     * @returns The removed KeyInfo element
     */

    DSIGKeyInfo * removeKeyInfo(size_type index);

    void setEnvironment(const XSECEnv * env) {mp_env = env;}

    void empty();
    
    bool isEmpty();



    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * 
        DSIGKeyInfoList::createKeyInfo(void);

    DSIGKeyInfoValue * appendDSAKeyValue(const XMLCh * P, 
                           const XMLCh * Q, 
                           const XMLCh * G, 
                           const XMLCh * Y);

    DSIGKeyInfoValue * appendRSAKeyValue(const XMLCh * modulus, 
                           const XMLCh * exponent);

    DSIGKeyInfoX509 * appendX509Data(void);

    DSIGKeyInfoName * appendKeyName(const XMLCh * name, bool isDName = false);

    DSIGKeyInfoPGPData * appendPGPData(const XMLCh * id, const XMLCh * packet);

    DSIGKeyInfoSPKIData * appendSPKIData(const XMLCh * sexp);

    DSIGKeyInfoMgmtData * appendMgmtData(const XMLCh * data);


private:

    DSIGKeyInfoList();

    KeyInfoListVectorType                   m_keyInfoList;
    const XSECEnv                           * mp_env;
    XERCES_CPP_NAMESPACE_QUALIFIER DOMNode  * mp_keyInfoNode;
    // KeyInfoListVectorType::iterator          m_iterator;
};


#endif /* DSIGKEYINFOLIST_INCLUDE */

---