/usr/include/xmltooling/signature/Signature.h is in libxmltooling-dev 1.6.4-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | /**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file xmltooling/signature/Signature.h
*
* XMLObject representing XML Digital Signature, version 20020212, Signature element.
*/
#if !defined(__xmltooling_sig_h__) && !defined(XMLTOOLING_NO_XMLSEC)
#define __xmltooling_sig_h__
#include <xmltooling/exceptions.h>
#include <xmltooling/ConcreteXMLObjectBuilder.h>
class DSIGSignature;
class XSECCryptoKey;
/**
* @namespace xmlsignature
* Public namespace of XML Signature classes
*/
namespace xmlsignature {
class XMLTOOL_API ContentReference;
class XMLTOOL_API KeyInfo;
/**
* XMLObject representing XML Digital Signature, version 20020212, Signature element.
* The default signature settings include Exclusive c14n w/o comments, SHA-1 digests,
* and RSA-SHA1 signing.
*/
class XMLTOOL_API Signature : public virtual xmltooling::XMLObject
{
public:
virtual ~Signature();
/** Element local name */
static const XMLCh LOCAL_NAME[];
/**
* Gets the canonicalization method for the ds:SignedInfo element.
*
* @return the canonicalization method
*/
virtual const XMLCh* getCanonicalizationMethod() const=0;
/**
* Gets the signing algorithm for the signature.
*
* @return the signature algorithm, or nullptr if indeterminate
*/
virtual const XMLCh* getSignatureAlgorithm() const=0;
/**
* Sets the canonicalization method for the ds:SignedInfo element.
*
* @param c14n the canonicalization method
*/
virtual void setCanonicalizationMethod(const XMLCh* c14n)=0;
/**
* Sets the signing algorithm for the signature.
*
* @param sm the signature algorithm
*/
virtual void setSignatureAlgorithm(const XMLCh* sm)=0;
/**
* Sets the signing key used to create the signature.
*
* @param signingKey the secret/private key used to create the signature
*/
virtual void setSigningKey(XSECCryptoKey* signingKey)=0;
/**
* Sets a KeyInfo object to embed in the Signature.
*
* @param keyInfo pointer to a KeyInfo object, or nullptr
*/
virtual void setKeyInfo(KeyInfo* keyInfo)=0;
/**
* Gets the KeyInfo object associated with the Signature.
* This is <strong>NOT</strong> provided for access to the
* data associated with an unmarshalled signature. It is
* used only in the creation of signatures. Access to data
* for validation purposes is provided through the native
* DSIGSignature object.
*
* @return pointer to a KeyInfo object, or nullptr
*/
virtual KeyInfo* getKeyInfo() const=0;
/**
* Sets the ContentReference object to the Signature to be applied
* when the signature is created.
*
* @param reference the reference to attach, or nullptr
*/
virtual void setContentReference(ContentReference* reference)=0;
/**
* Gets the ContentReference object associated with the Signature.
* This is <strong>NOT</strong> provided for access to the
* data associated with an unmarshalled signature. It is
* used only in the creation of signatures. Access to data
* for validation purposes is provided through the native
* DSIGSignature object.
*
* @return pointer to a ContentReference object, or nullptr
*/
virtual ContentReference* getContentReference() const=0;
/**
* Gets the native Apache signature object, if present.
*
* @return the native Apache signature interface
*/
virtual DSIGSignature* getXMLSignature() const=0;
/**
* Compute and append the signature based on the assigned
* ContentReference, KeyInfo, and signing key.
*
* @param credential optional source of signing key and KeyInfo
*/
virtual void sign(const xmltooling::Credential* credential=nullptr)=0;
/**
* Type-safe clone operation.
*
* @return copy of object
*/
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:
/** Default constructor. */
Signature();
};
/**
* Builder for Signature objects.
*/
class XMLTOOL_API SignatureBuilder : public xmltooling::ConcreteXMLObjectBuilder
{
public:
#ifdef HAVE_COVARIANT_RETURNS
virtual Signature* buildObject(
#else
virtual xmltooling::XMLObject* buildObject(
#endif
const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix=nullptr, const xmltooling::QName* schemaType=nullptr
) const;
/**
* Default builder
*
* @return empty Signature object
*/
#ifdef HAVE_COVARIANT_RETURNS
virtual Signature* buildObject() const;
#else
virtual xmltooling::XMLObject* buildObject() const;
#endif
/** Singleton builder. */
static Signature* buildSignature();
};
DECL_XMLTOOLING_EXCEPTION(SignatureException,XMLTOOL_EXCEPTIONAPI(XMLTOOL_API),xmlsignature,xmltooling::XMLSecurityException,Exceptions in signature processing);
};
#endif /* __xmltooling_sig_h__ */
|