Main Page | Modules | Class Hierarchy | Compound List | File List | Compound Members | File Members | Related Pages

DSIGSignature.hpp

Go to the documentation of this file.
00001 /*
00002  * Copyright 2002-2004 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * imitations under the License.
00015  */
00016 
00017 /*
00018  * XSEC
00019  *
00020  * DSIGSignature := Class for checking and setting up signature nodes in a DSIG signature
00021  *
00022  * Author(s): Berin Lautenbach
00023  *
00024  * $Id: DSIGSignature.hpp,v 1.20 2004/02/29 06:39:44 blautenb Exp $
00025  *
00026  */
00027 
00028 #ifndef DSIGSIGNATURE_INCLUDE
00029 #define DSIGSIGNATURE_INCLUDE
00030 
00031 // XSEC Includes
00032 #include <xsec/utils/XSECSafeBufferFormatter.hpp>
00033 #include <xsec/dsig/DSIGTransform.hpp>
00034 #include <xsec/dsig/DSIGKeyInfoList.hpp>
00035 #include <xsec/dsig/DSIGConstants.hpp>
00036 #include <xsec/dsig/DSIGSignedInfo.hpp>
00037 
00038 // Xerces Includes
00039 
00040 #include <xercesc/dom/DOM.hpp>
00041 
00042 class XSECEnv;
00043 class XSECBinTXFMInputStream;
00044 class XSECURIResolver;
00045 class XSECKeyInfoResolver;
00046 class DSIGKeyInfoValue;
00047 class DSIGKeyInfoX509;
00048 class DSIGKeyInfoName;
00049 class DSIGKeyInfoPGPData;
00050 class DSIGKeyInfoSPKIData;
00051 class DSIGKeyInfoMgmtData;
00052 class DSIGObject;
00053 
00057 /*\@{*/
00058 
00068 class DSIG_EXPORT DSIGSignature {
00069 
00070 protected:
00071 
00074     
00091     DSIGSignature(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, 
00092                   XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *sigNode);
00093 
00094     ~DSIGSignature();
00096     
00097 public:
00098 
00101 
00111     void load(void);
00112 
00126     void setSigningKey(XSECCryptoKey *k);
00127 
00129 
00132 
00157     bool verify(void);
00158 
00169     bool verifySignatureOnly(void);
00170 
00196     void sign(void);
00198 
00201     
00222     void setDSIGNSPrefix(const XMLCh * prefix);
00223 
00240     void setECNSPrefix(const XMLCh * prefix);
00241 
00258     void setXPFNSPrefix(const XMLCh * prefix);
00259 
00271     void setPrettyPrint(bool flag);
00272 
00279     bool getPrettyPrint(void);
00280 
00304     XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *createBlankSignature(
00305         XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc,
00306         canonicalizationMethod cm = CANON_C14N_NOC,
00307         signatureMethod sm = SIGNATURE_DSA,
00308         hashMethod hm = HASH_SHA1
00309     );
00310 
00331     DSIGReference * createReference(
00332         const XMLCh * URI,
00333         hashMethod hm = HASH_SHA1, 
00334         char * type = NULL
00335     );
00336 
00338 
00341 
00355     unsigned int calculateSignedInfoHash(unsigned char * hashBuf, 
00356                                         unsigned int hashBufLen);
00357 
00367     DSIGReferenceList * getReferenceList(void);
00368 
00382     XSECBinTXFMInputStream * makeBinInputStream(void) const;
00383 
00384 
00398     const XMLCh * getErrMsgs(void);
00399 
00408     const XMLCh * getDSIGNSPrefix();
00409 
00417     const XMLCh * getECNSPrefix();
00418 
00426     const XMLCh * getXPFNSPrefix();
00427 
00438     XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * getParentDocument() 
00439         {return mp_doc;}
00440 
00450     canonicalizationMethod getCanonicalizationMethod(void) 
00451     {return (mp_signedInfo != NULL ? 
00452              mp_signedInfo->getCanonicalizationMethod() : CANON_NONE);}
00453 
00454 
00464     hashMethod getHashMethod(void)
00465     {return (mp_signedInfo != NULL ? 
00466              mp_signedInfo->getHashMethod() : HASH_NONE);}
00467 
00477     signatureMethod getSignatureMethod(void)
00478     {return (mp_signedInfo != NULL ? 
00479              mp_signedInfo->getSignatureMethod() : SIGNATURE_NONE);}
00480          
00488     XSECSafeBufferFormatter * getSBFormatter(void) {return mp_formatter;}
00489 
00491 
00494 
00503     void setURIResolver(XSECURIResolver * resolver);
00504 
00511     XSECURIResolver * getURIResolver(void);
00512 
00521     void setKeyInfoResolver(XSECKeyInfoResolver * resolver);
00522 
00529     XSECKeyInfoResolver * getKeyInfoResolver(void);
00530 
00532 
00536 
00552     DSIGKeyInfoList * getKeyInfoList() {return &m_keyInfoList;}
00553 
00562     void clearKeyInfo(void);
00563 
00576     DSIGKeyInfoValue * appendDSAKeyValue(const XMLCh * P, 
00577                            const XMLCh * Q, 
00578                            const XMLCh * G, 
00579                            const XMLCh * Y);
00580 
00591     DSIGKeyInfoValue * appendRSAKeyValue(const XMLCh * modulus, 
00592                            const XMLCh * exponent);
00593 
00605     DSIGKeyInfoX509 * appendX509Data(void);
00606 
00617     DSIGKeyInfoName * appendKeyName(const XMLCh * name, bool isDName = false);
00618 
00630     DSIGKeyInfoPGPData * appendPGPData(const XMLCh * id, const XMLCh * packet);
00631 
00641     DSIGKeyInfoSPKIData * appendSPKIData(const XMLCh * sexp);
00642 
00652     DSIGKeyInfoMgmtData * appendMgmtData(const XMLCh * data);
00653 
00655 
00658 
00669     DSIGObject * appendObject(void);
00670 
00677     int getObjectLength(void);
00678 
00686     DSIGObject * getObjectItem(int i);
00687 
00689 
00693 
00718     void setIdByAttributeName(bool flag);
00719 
00729     bool getIdByAttributeName(void);
00730 
00743     void registerIdAttributeName(const XMLCh * name);
00744 
00755     bool deregisterIdAttributeName(const XMLCh * name);
00756 
00758 
00759     friend class XSECProvider;
00760 
00761 private:
00762 
00763     // For holding DSIGObject nodes
00764 #if defined(XSEC_NO_NAMESPACES)
00765     typedef vector<DSIGObject *>            ObjectVectorType;
00766 #else
00767     typedef std::vector<DSIGObject *>       ObjectVectorType;
00768 #endif
00769 
00770 
00771     // Internal functions
00772     void createKeyInfoElement(void);
00773     bool verifySignatureOnlyInternal(void);
00774 
00775     XSECSafeBufferFormatter     * mp_formatter;
00776     bool                        m_loaded;               // Have we already loaded?
00777     XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument                  
00778                                 * mp_doc;
00779     XERCES_CPP_NAMESPACE_QUALIFIER DOMNode                      
00780                                 * mp_sigNode;
00781     DSIGSignedInfo              * mp_signedInfo;
00782     XERCES_CPP_NAMESPACE_QUALIFIER DOMNode                      
00783                                 * mp_signatureValueNode;
00784     safeBuffer                  m_signatureValueSB;
00785     DSIGKeyInfoList             m_keyInfoList;
00786     XERCES_CPP_NAMESPACE_QUALIFIER DOMNode                      
00787                                 * mp_KeyInfoNode;
00788     safeBuffer                  m_errStr;
00789 
00790     // Environment
00791     XSECEnv                     * mp_env;
00792     
00793     // The signing/verifying key
00794     XSECCryptoKey               * mp_signingKey;
00795 
00796     // Resolvers
00797     XSECKeyInfoResolver         * mp_KeyInfoResolver;
00798 
00799     // Objects
00800 
00801     ObjectVectorType            m_objects;
00802 
00803     // Not implemented constructors
00804 
00805     DSIGSignature();
00806 
00807     /*\@}*/
00808 };
00809 
00810 #endif /* DSIGSIGNATURE_INCLUDE */

Generated on Sun Mar 14 20:20:34 2004 for XML-Security-C by doxygen 1.3.2