Fixed some doxygen warnings.

[shibboleth/cpp-xmltooling.git] / xmltooling / signature / Signature.h

diff --git a/xmltooling/signature/Signature.h b/xmltooling/signature/Signature.h
index 33fc083..23121b8 100644 (file)
--- a/xmltooling/signature/Signature.h
+++ b/xmltooling/signature/Signature.h
@@ -132,6 +132,51 @@ namespace xmlsignature {
          */
         virtual Signature* cloneSignature() const=0;
 
+        /**
+         * Sign the input data and return a base64-encoded signature. The signature value
+         * <strong>MUST NOT</strong> contain any embedded linefeeds.
+         * 
+         * <p>Allows specialized applications to create raw signatures over any input using
+         * the same cryptography layer as XML Signatures use. 
+         * 
+         * @param key               key to sign with, will <strong>NOT</strong> be freed
+         * @param sigAlgorithm      XML signature algorithm identifier
+         * @param in                input data
+         * @param in_len            size of input data in bytes
+         * @param out               output buffer
+         * @param out_len           size of output buffer in bytes
+         * @return  size in bytes of base64-encoded signature
+         */
+        static unsigned int createRawSignature(
+            XSECCryptoKey* key,
+            const XMLCh* sigAlgorithm,
+            const char* in,
+            unsigned int in_len,
+            char* out,
+            unsigned int out_len
+            );
+         
+        /**
+         * Verifies a base-64 encoded signature over the input data.
+         * 
+         * <p>Allows specialized applications to verify raw signatures over any input using
+         * the same cryptography layer as XML Signatures use. 
+         * 
+         * @param key               key to verify with, will <strong>NOT</strong> be freed
+         * @param sigAlgorithm      XML signature algorithm identifier
+         * @param signature         base64-encoded signature value
+         * @param in                input data
+         * @param in_len            size of input data in bytes
+         * @return  true iff signature verifies
+         */
+        static bool verifyRawSignature(
+            XSECCryptoKey* key,
+            const XMLCh* sigAlgorithm,
+            const char* signature,
+            const char* in,
+            unsigned int in_len
+            );
+
     protected:
         Signature() {}
     };
@@ -151,16 +196,25 @@ namespace xmlsignature {
          * 
          * @return empty Signature object
          */
+#ifdef HAVE_COVARIANT_RETURNS
         virtual Signature* buildObject() const;
-
+#else
+        virtual xmltooling::XMLObject* buildObject() const;
+#endif
+        /** Singleton builder. */
         static Signature* buildSignature() {
             const SignatureBuilder* b = dynamic_cast<const SignatureBuilder*>(
                 xmltooling::XMLObjectBuilder::getBuilder(
                     xmltooling::QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME)
                     )
                 );
-            if (b)
+            if (b) {
+#ifdef HAVE_COVARIANT_RETURNS
                 return b->buildObject();
+#else
+                return dynamic_cast<Signature*>(b->buildObject());
+#endif
+            }
             throw xmltooling::XMLObjectException("Unable to obtain typed builder for Signature.");
         }
     };