2 * Copyright 2001-2006 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
20 * XMLObject representing XML Digital Signature, version 20020212, Signature element.
\r
23 #if !defined(__xmltooling_sig_h__) && !defined(XMLTOOLING_NO_XMLSEC)
\r
24 #define __xmltooling_sig_h__
\r
26 #include <xmltooling/exceptions.h>
\r
27 #include <xmltooling/XMLObjectBuilder.h>
\r
28 #include <xmltooling/signature/SigningContext.h>
\r
29 #include <xmltooling/signature/VerifyingContext.h>
\r
30 #include <xmltooling/util/XMLConstants.h>
\r
33 * @namespace xmlsignature
\r
34 * Public namespace of XML Signature classes
\r
36 namespace xmlsignature {
\r
39 * XMLObject representing XML Digital Signature, version 20020212, Signature element.
\r
40 * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,
\r
41 * and RSA-SHA1 signing.
\r
43 class XMLTOOL_API Signature : public virtual xmltooling::XMLObject
\r
46 virtual ~Signature() {}
\r
48 /** Element local name */
\r
49 static const XMLCh LOCAL_NAME[];
\r
52 * Sets the canonicalization method for the ds:SignedInfo element
\r
54 * @param c14n the canonicalization method
\r
56 virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;
\r
59 * Sets the signing algorithm for the signature.
\r
61 * @param sm the signature algorithm
\r
63 virtual void setSignatureAlgorithm(const XMLCh* sm)=0;
\r
66 * Applies an XML signature based on the supplied context.
\r
68 * @param ctx the signing context that determines the signature's content
\r
69 * @throws SignatureException thrown if the signing operation fails
\r
71 virtual void sign(const SigningContext& ctx)=0;
\r
74 * Verifies an XML signature based on the supplied context.
\r
76 * @param ctx the verifying context that validates the signature's content
\r
77 * @throws SignatureException thrown if the verifying operation fails
\r
79 virtual void verify(const VerifyingContext& ctx) const=0;
\r
86 * Builder for Signature objects.
\r
88 class XMLTOOL_API SignatureBuilder : public xmltooling::XMLObjectBuilder
\r
91 virtual Signature* buildObject(
\r
92 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL
\r
98 * @return empty Signature object
\r
100 virtual Signature* buildObject() const;
\r
102 static Signature* newSignature() {
\r
103 const SignatureBuilder* b = dynamic_cast<const SignatureBuilder*>(
\r
104 xmltooling::XMLObjectBuilder::getBuilder(
\r
105 xmltooling::QName(xmltooling::XMLConstants::XMLSIG_NS,Signature::LOCAL_NAME)
\r
109 return b->buildObject();
\r
110 throw xmltooling::XMLObjectException("Unable to obtain typed builder for Signature.");
\r
114 DECL_XMLTOOLING_EXCEPTION(SignatureException,xmlsignature,xmltooling::XMLToolingException,Exceptions in signature processing);
\r
118 #endif /* __xmltooling_sig_h__ */
\r