#if !defined(__xmltooling_sig_h__) && !defined(XMLTOOLING_NO_XMLSEC)\r
#define __xmltooling_sig_h__\r
\r
+#include <xmltooling/exceptions.h>\r
#include <xmltooling/XMLObjectBuilder.h>\r
-#include <xmltooling/signature/SigningContext.h>\r
-#include <xmltooling/signature/VerifyingContext.h>\r
+#include <xmltooling/signature/KeyInfo.h>\r
+#include <xmltooling/signature/ContentReference.h>\r
+#include <xmltooling/util/XMLConstants.h>\r
\r
-namespace xmltooling {\r
+#include <xsec/dsig/DSIGSignature.hpp>\r
+\r
+/**\r
+ * @namespace xmlsignature\r
+ * Public namespace of XML Signature classes\r
+ */\r
+namespace xmlsignature {\r
\r
/**\r
* XMLObject representing XML Digital Signature, version 20020212, Signature element.\r
* The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,\r
* and RSA-SHA1 signing. \r
*/\r
- class XMLTOOL_API Signature : public virtual XMLObject\r
+ class XMLTOOL_API Signature : public virtual xmltooling::XMLObject\r
{\r
public:\r
virtual ~Signature() {}\r
\r
- /** Element prefix */\r
- static const XMLCh PREFIX[];\r
-\r
/** Element local name */\r
static const XMLCh LOCAL_NAME[];\r
\r
* @param sm the signature algorithm\r
*/\r
virtual void setSignatureAlgorithm(const XMLCh* sm)=0;\r
- \r
+\r
+ /**\r
+ * Sets the signing key used to create the signature.\r
+ * \r
+ * @param signingKey the secret/private key used to create the signature\r
+ */\r
+ virtual void setSigningKey(XSECCryptoKey* signingKey)=0;\r
+\r
/**\r
- * Applies an XML signature based on the supplied context.\r
+ * Sets a KeyInfo object to embed in the Signature.\r
* \r
- * @param ctx the signing context that determines the signature's content\r
- * @throws SignatureException thrown if the signing operation fails\r
+ * @param keyInfo pointer to a KeyInfo object, or NULL\r
*/\r
- virtual void sign(const SigningContext& ctx)=0;\r
+ virtual void setKeyInfo(KeyInfo* keyInfo)=0;\r
+\r
+ /**\r
+ * Gets the KeyInfo object associated with the Signature.\r
+ * This is <strong>NOT</strong> provided for access to the\r
+ * data associated with an unmarshalled signature. It is\r
+ * used only in the creation of signatures. Access to data\r
+ * for validation purposes is provided through the native\r
+ * DSIGSignature object.\r
+ * \r
+ * @return pointer to a KeyInfo object, or NULL\r
+ */\r
+ virtual KeyInfo* getKeyInfo() const=0;\r
+\r
+ /**\r
+ * Sets the ContentReference object to the Signature to be applied\r
+ * when the signature is created.\r
+ * \r
+ * @param reference the reference to attach, or NULL \r
+ */\r
+ virtual void setContentReference(ContentReference* reference)=0;\r
+\r
+ /**\r
+ * Gets the ContentReference object associated with the Signature.\r
+ * This is <strong>NOT</strong> provided for access to the\r
+ * data associated with an unmarshalled signature. It is\r
+ * used only in the creation of signatures. Access to data\r
+ * for validation purposes is provided through the native\r
+ * DSIGSignature object.\r
+ * \r
+ * @return pointer to a ContentReference object, or NULL\r
+ */\r
+ virtual ContentReference* getContentReference() const=0;\r
+\r
\r
/**\r
- * Verifies an XML signature based on the supplied context.\r
+ * Gets the native Apache signature object, if present.\r
+ * \r
+ * @return the native Apache signature interface\r
+ */\r
+ virtual DSIGSignature* getXMLSignature() const=0;\r
+\r
+ /**\r
+ * Compute and append the signature based on the assigned\r
+ * ContentReference, KeyInfo, and signing key.\r
+ */\r
+ virtual void sign()=0;\r
+\r
+ /**\r
+ * Type-safe clone operation.\r
* \r
- * @param ctx the verifying context that validates the signature's content\r
- * @throws SignatureException thrown if the verifying operation fails\r
+ * @return copy of object\r
*/\r
- virtual void verify(const VerifyingContext& ctx) const=0;\r
+ virtual Signature* cloneSignature() const=0;\r
\r
protected:\r
Signature() {}\r
};\r
\r
-#ifdef XMLTOOLING_DEFINE_CONSTANTS\r
- const XMLCh Signature::LOCAL_NAME[] = {\r
- chLatin_S, chLatin_i, chLatin_g, chLatin_n, chLatin_a, chLatin_t, chLatin_u, chLatin_r, chLatin_e, chNull\r
- }; \r
- const XMLCh Signature::PREFIX[] = {\r
- chLatin_d, chLatin_s, chNull\r
- };\r
-#endif\r
-\r
/**\r
* Builder for Signature objects.\r
*/\r
- class XMLTOOL_API SignatureBuilder : public XMLObjectBuilder\r
+ class XMLTOOL_API SignatureBuilder : public xmltooling::XMLObjectBuilder\r
{\r
public:\r
- virtual ~SignatureBuilder() {}\r
-\r
+ virtual Signature* buildObject(\r
+ const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=NULL, const xmltooling::QName* schemaType=NULL\r
+ ) const;\r
+ \r
/**\r
- * Default builder.\r
+ * Default builder\r
+ * \r
+ * @return empty Signature object\r
*/\r
- virtual Signature* buildObject() const=0;\r
+ virtual Signature* buildObject() const;\r
+\r
+ static Signature* buildSignature() {\r
+ const SignatureBuilder* b = dynamic_cast<const SignatureBuilder*>(\r
+ xmltooling::XMLObjectBuilder::getBuilder(\r
+ xmltooling::QName(xmltooling::XMLConstants::XMLSIG_NS,Signature::LOCAL_NAME)\r
+ )\r
+ );\r
+ if (b)\r
+ return b->buildObject();\r
+ throw xmltooling::XMLObjectException("Unable to obtain typed builder for Signature.");\r
+ }\r
};\r
+\r
+ DECL_XMLTOOLING_EXCEPTION(SignatureException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlsignature,xmltooling::XMLSecurityException,Exceptions in signature processing);\r
+\r
};\r
\r
#endif /* __xmltooling_sig_h__ */\r
projects / shibboleth / cpp-xmltooling.git / blobdiff