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/XMLObjectBuilder.h>
\r
27 #include <xmltooling/signature/SigningContext.h>
\r
28 #include <xmltooling/signature/VerifyingContext.h>
\r
30 namespace xmltooling {
\r
33 * XMLObject representing XML Digital Signature, version 20020212, Signature element.
\r
34 * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,
\r
35 * and RSA-SHA1 signing.
\r
37 class XMLTOOL_API Signature : public virtual XMLObject
\r
40 virtual ~Signature() {}
\r
42 /** Element prefix */
\r
43 static const XMLCh PREFIX[];
\r
45 /** Element local name */
\r
46 static const XMLCh LOCAL_NAME[];
\r
49 * Sets the canonicalization method for the ds:SignedInfo element
\r
51 * @param c14n the canonicalization method
\r
53 virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;
\r
56 * Sets the signing algorithm for the signature.
\r
58 * @param sm the signature algorithm
\r
60 virtual void setSignatureAlgorithm(const XMLCh* sm)=0;
\r
63 * Applies an XML signature based on the supplied context.
\r
65 * @param ctx the signing context that determines the signature's content
\r
66 * @throws SignatureException thrown if the signing operation fails
\r
68 virtual void sign(const SigningContext& ctx)=0;
\r
71 * Verifies an XML signature based on the supplied context.
\r
73 * @param ctx the verifying context that validates the signature's content
\r
74 * @throws SignatureException thrown if the verifying operation fails
\r
76 virtual void verify(const VerifyingContext& ctx) const=0;
\r
82 #ifdef XMLTOOLING_DEFINE_CONSTANTS
\r
83 const XMLCh Signature::LOCAL_NAME[] = {
\r
84 chLatin_S, chLatin_i, chLatin_g, chLatin_n, chLatin_a, chLatin_t, chLatin_u, chLatin_r, chLatin_e, chNull
\r
86 const XMLCh Signature::PREFIX[] = {
\r
87 chLatin_d, chLatin_s, chNull
\r
92 * Builder for Signature objects.
\r
94 class XMLTOOL_API SignatureBuilder : public XMLObjectBuilder
\r
97 virtual ~SignatureBuilder() {}
\r
102 virtual Signature* buildObject() const=0;
\r
106 #endif /* __xmltooling_sig_h__ */
\r