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/XMLObject.h>
\r
27 #include <xmltooling/signature/SigningContext.h>
\r
29 namespace xmltooling {
\r
32 * XMLObject representing XML Digital Signature, version 20020212, Signature element.
\r
33 * The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,
\r
34 * and RSA-SHA1 signing.
\r
36 class XMLTOOL_API Signature : public virtual XMLObject
\r
39 virtual ~Signature() {}
\r
41 /** Element prefix */
\r
42 static const XMLCh PREFIX[];
\r
44 /** Element local name */
\r
45 static const XMLCh LOCAL_NAME[];
\r
48 * Gets the canonicalization method for the ds:SignedInfo element.
\r
50 * @return the canonicalization method
\r
52 virtual const XMLCh* getCanonicalizationMethod() const=0;
\r
55 * Gets the signing algorithm for the signature.
\r
57 * @return the signature algorithm
\r
59 virtual const XMLCh* getSignatureAlgorithm() const=0;
\r
62 * Returns the ds:KeyInfo information attached to the signature.
\r
63 * The Signature object must be marshalled before this will return anything.
\r
65 * @return the ds:KeyInfo information
\r
67 virtual const DSIGKeyInfoList* getKeyInfo() const=0;
\r
70 * Sets the canonicalization method for the ds:SignedInfo element
\r
72 * @param c14n the canonicalization method
\r
74 virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;
\r
77 * Sets the signing algorithm for the signature.
\r
79 * @param sm the signature algorithm
\r
81 virtual void setSignatureAlgorithm(const XMLCh* sm)=0;
\r
84 * Applies an XML signature based on the supplied context.
\r
86 * @param ctx the signing context that determines the signature's content
\r
87 * @throws SignatureException thrown if the signing operation fails
\r
89 virtual void sign(const SigningContext* ctx)=0;
\r
97 #endif /* __xmltooling_sig_h__ */
\r