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  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "<WebSig>" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 2001, Institute for
00053  * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
00054  * The development of this software was partly funded by the European 
00055  * Commission in the <WebSig> project in the ISIS Programme. 
00056  * For more information on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * XSEC
00062  *
00063  * DSIGSignature := Class for checking and setting up signature nodes in a DSIG signature
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $Id: DSIGSignature.hpp,v 1.7 2003/04/30 11:41:14 blautenb Exp $
00068  *
00069  */
00070 
00071 #ifndef DSIGSIGNATURE_INCLUDE
00072 #define DSIGSIGNATURE_INCLUDE
00073 
00074 // XSEC Includes
00075 #include <xsec/utils/XSECSafeBufferFormatter.hpp>
00076 #include <xsec/dsig/DSIGTransform.hpp>
00077 #include <xsec/dsig/DSIGKeyInfoList.hpp>
00078 #include <xsec/dsig/DSIGConstants.hpp>
00079 #include <xsec/dsig/DSIGSignedInfo.hpp>
00080 
00081 // Xerces Includes
00082 
00083 #include <xercesc/dom/DOM.hpp>
00084 
00085 class XSECBinTXFMInputStream;
00086 class XSECURIResolver;
00087 class XSECKeyInfoResolver;
00088 class DSIGKeyInfoValue;
00089 class DSIGKeyInfoX509;
00090 class DSIGKeyInfoName;
00091 
00095 /*\@{*/
00096 
00106 class DSIG_EXPORT DSIGSignature {
00107 
00108 protected:
00109 
00112     
00129     DSIGSignature(DOMDocument *doc, DOMNode *sigNode);
00130     ~DSIGSignature();
00132     
00133 public:
00134 
00137 
00147     void load(void);
00148 
00162     void setSigningKey(XSECCryptoKey *k);
00163 
00165 
00168 
00193     bool verify(void);
00194 
00205     bool verifySignatureOnly(void);
00206 
00232     void sign(void);
00234 
00237     
00258     void setDSIGNSPrefix(const XMLCh * prefix);
00259 
00276     void setECNSPrefix(const XMLCh * prefix);
00277 
00301     DOMElement *createBlankSignature(DOMDocument *doc,
00302         canonicalizationMethod cm = CANON_C14N_NOC,
00303         signatureMethod sm = SIGNATURE_DSA,
00304         hashMethod hm = HASH_SHA1);
00305 
00326     DSIGReference * createReference(const XMLCh * URI,
00327         hashMethod hm = HASH_SHA1, char * type = NULL);
00328 
00330 
00333 
00347     unsigned int calculateSignedInfoHash(unsigned char * hashBuf, 
00348                                         unsigned int hashBufLen);
00349 
00359     DSIGReferenceList * getReferenceList(void);
00360 
00374     XSECBinTXFMInputStream * makeBinInputStream(void) const;
00375 
00376 
00390     const XMLCh * getErrMsgs(void);
00391 
00400     const XMLCh * getDSIGNSPrefix() {return mp_prefixNS;}
00401 
00409     const XMLCh * getECNSPrefix() {return mp_ecPrefixNS;}
00410 
00421     DOMDocument * getParentDocument() {return mp_doc;}
00422 
00432     canonicalizationMethod getCanonicalizationMethod(void) 
00433     {return (mp_signedInfo != NULL ? 
00434              mp_signedInfo->getCanonicalizationMethod() : CANON_NONE);}
00435 
00436 
00446     hashMethod getHashMethod(void)
00447     {return (mp_signedInfo != NULL ? 
00448              mp_signedInfo->getHashMethod() : HASH_NONE);}
00449 
00459     signatureMethod getSignatureMethod(void)
00460     {return (mp_signedInfo != NULL ? 
00461              mp_signedInfo->getSignatureMethod() : SIGNATURE_NONE);}
00462          
00470     XSECSafeBufferFormatter * getSBFormatter(void) {return mp_formatter;}
00471 
00473 
00476 
00485     void setURIResolver(XSECURIResolver * resolver);
00486 
00493     XSECURIResolver * getURIResolver(void);
00494 
00503     void setKeyInfoResolver(XSECKeyInfoResolver * resolver);
00504 
00511     XSECKeyInfoResolver * getKeyInfoResolver(void);
00512 
00514 
00518 
00534     DSIGKeyInfoList * getKeyInfoList() {return &m_keyInfoList;}
00535 
00544     void clearKeyInfo(void);
00545 
00558     DSIGKeyInfoValue * appendDSAKeyValue(const XMLCh * P, 
00559                            const XMLCh * Q, 
00560                            const XMLCh * G, 
00561                            const XMLCh * Y);
00562 
00573     DSIGKeyInfoValue * appendRSAKeyValue(const XMLCh * modulus, 
00574                            const XMLCh * exponent);
00575 
00587     DSIGKeyInfoX509 * appendX509Data(void);
00588 
00598     DSIGKeyInfoName * appendKeyName(const XMLCh * name);
00599 
00601 
00602     friend class XSECProvider;
00603 
00604 private:
00605 
00606     // Internal functions
00607     void createKeyInfoElement(void);
00608     bool verifySignatureOnlyInternal(void);
00609 
00610     XSECSafeBufferFormatter     * mp_formatter;
00611     bool                        m_loaded;               // Have we already loaded?
00612     DOMDocument                 * mp_doc;
00613     DOMNode                     * mp_sigNode;
00614     DSIGSignedInfo              * mp_signedInfo;
00615     DOMNode                     * mp_signatureValueNode;
00616     safeBuffer                  m_signatureValueSB;
00617     DSIGKeyInfoList             m_keyInfoList;
00618     DOMNode                     * mp_KeyInfoNode;
00619     safeBuffer                  m_errStr;
00620 
00621     // For creating functions
00622     XMLCh                       * mp_prefixNS;
00623     XMLCh                       * mp_ecPrefixNS;
00624 
00625     // The signing/verifying key
00626     XSECCryptoKey               * mp_signingKey;
00627 
00628     // Resolvers
00629     XSECURIResolver             * mp_URIResolver;
00630     XSECKeyInfoResolver         * mp_KeyInfoResolver;
00631 
00632     // Not implemented constructors
00633 
00634     DSIGSignature();
00635 
00636     /*\@}*/
00637 };
00638 
00639 #endif /* DSIGSIGNATURE_INCLUDE */

Generated on Wed May 7 21:43:50 2003 for XML-Security-C by doxygen1.2.18