XmlDSigGen ActiveX Reference Documentation

XmlDSigGen

Current Version: 9.5.0.75

An API for generating/creating XML Digital Signatures. Use the XmlDSig class for verifying XML Digital Signatures.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatXmlDSigGen

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.XmlDSigGen")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.XmlDSigGen")

(Delphi)
obj := TChilkatXmlDSigGen.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.XmlDSigGen')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.XmlDSigGen")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.XmlDSigGen', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.XmlDSigGen");

Properties

Behaviors
Behaviors As String
Introduced in version 9.5.0.70

A comma-separated list of keywords to specify special behaviors to work around potential oddities or special requirements needed for providing signatures to particular systems. This is an open-ended property where new behaviors can be implemented depending on the needs encountered by Chilkat customers. The possible behaviors are listed below.

  • ForceAddEnvelopedSignatureTransform The "<Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /> " is normally only added when the Signature is contained within the XML fragment that is signed. The meaning of this tranformation is to tell the verifier to remove the Signature from the data prior to canonicalizing. If the Signature is not contained within the XML fragment that was signed, then the signature was not enveloped. There would be no need to remove the Signature because the Signature is not contained in the XML fragment being verified. However.. some brain-dead verifiying systems require this Transform to be present regardless of whether it makes sense. This behavior will cause Chilkat to add the Transform regardless.
  • ebXmlTransform (introduced in v9.5.0.73) Causes the following tranform to be added for ebXml messages:
    <Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
        <XPath xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">not(ancestor-or-self::node()[@SOAP-ENV:actor="urn:oasis:names:tc:ebxml-msg:actor:nextMSH"]
             | ancestor-or-self::node()[@SOAP-ENV:actor="http://schemas.xmlsoap.org/soap/actor/next"])</XPath>
    </Transform>
    
  • TransformSignatureXPath (introduced in v9.5.0.75) Causes the following tranform to be added:
    <ds:Transform Algorithm="http://www.w3.org/TR/1999/REC-xpath-19991116">
       <ds:XPath>not(ancestor-or-self::ds:Signature)</ds:XPath>
    </ds:Transform>
    
  • CompactSignedXml (introduced in v9.5.0.73) The passed-in XML to be signed is first reformatted to a compact representation by removing all CR's, LF's, and unnecessary whitespace so that the XML to be signed is on a single line. The resulting XML (with signature) is also entirely contained on a single line. (If an XML declarator is present, then it will remain on it's own line.)
  • IndentedSignature (introduced in v9.5.0.73) Causes the XML Signature to be produced on multiple lines with indentation for easier human readability. The CompactSignedXml behavior takes precedence over this behavior.

top
CustomKeyInfoXml
CustomKeyInfoXml As String
Introduced in version 9.5.0.69

Specifies custom XML to be inserted in the KeyInfo element of the Signature. A common use is to provide a wsse:SecurityTokenReference fragment of XML.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
IncNamespacePrefix
IncNamespacePrefix As String
Introduced in version 9.5.0.70

The namespace prefix to use for InclusiveNamespaces elements. The default value is "ec". Set this property to the empty string to omit an InclusiveNamespaces prefix. For example, given the default values of IncNamespaceUri and IncNamespacePrefix, generated InclusiveNamespaces elements will appear like this:

<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#"> ... </ec:InclusiveNamespaces>

top
IncNamespaceUri
IncNamespaceUri As String
Introduced in version 9.5.0.70

The namespace URI for any InclusiveNamespaces elements that are created. The default value is "http://www.w3.org/2001/10/xml-exc-c14n#". For example, if the IncNamespacePrefix equals "ec" and this property remains at the default value, then the generated Signature element will be:

<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#"> ... </ec:InclusiveNamespaces>

top
KeyInfoId
KeyInfoId As String
Introduced in version 9.5.0.75

If set, causes the generated KeyInfo element to include an Id attribute with this value. For example:

...
   <ds:KeyInfo Id="KeyInfo">
      <ds:X509Data>
         <ds:X509SubjectName>CERTIFICADO DE ABC</ds:X509SubjectName>
         <ds:X509Certificate>MIIITTCC....fIsIZeZOeQ=</ds:X509Certificate>
      </ds:X509Data>
   </ds:KeyInfo>
...

top
KeyInfoKeyName
KeyInfoKeyName As String
Introduced in version 9.5.0.69

Specifies the KeyName to be inserted in the KeyInfo element of the Signature if the KeyInfoType equals "KeyName".

top
KeyInfoType
KeyInfoType As String
Introduced in version 9.5.0.69

Specifies the type of information that will be included in the optional KeyInfo element of the Signature. Possible values are:

  • None
  • KeyName
  • KeyValue
  • X509Data
  • X509Data+KeyValue
  • Custom

The default value is "KeyValue". The "X509Data+KeyValue" option was added in Chilkat v9.5.0.73.

If None, then no KeyInfo element is added to the Signature when generated.

If KeyValue, then the KeyInfo will contain the public key (RSA, DSA, or ECDSA).

If X509Data, then the KeyInfo will contain information about an X.509 certificate as specified by the X509Type property.

If Custom, then the KeyInfo will contain the custom XML contained in the CustomKeyInfoXml property.

More Information and Examples
(Classic ASP) Create XML Digital Signature having KeyName(Visual FoxPro) Create XML Digital Signature having KeyName(PowerBuilder) Create XML Digital Signature having KeyName(SQL Server) Create XML Digital Signature having KeyName(Visual Basic 6.0) Create XML Digital Signature having KeyName(VBScript) Create XML Digital Signature having KeyName(Classic ASP) Sign SOAP XML using a wsse:SecurityTokenReference(Visual FoxPro) Sign SOAP XML using a wsse:SecurityTokenReference(PowerBuilder) Sign SOAP XML using a wsse:SecurityTokenReference(SQL Server) Sign SOAP XML using a wsse:SecurityTokenReference(Visual Basic 6.0) Sign SOAP XML using a wsse:SecurityTokenReference(VBScript) Sign SOAP XML using a wsse:SecurityTokenReference(Classic ASP) Create XML Signature with KeyInfo / X509Data / X509Certificate(Visual FoxPro) Create XML Signature with KeyInfo / X509Data / X509Certificate(PowerBuilder) Create XML Signature with KeyInfo / X509Data / X509Certificate(SQL Server) Create XML Signature with KeyInfo / X509Data / X509Certificate(Visual Basic 6.0) Create XML Signature with KeyInfo / X509Data / X509Certificate(VBScript) Create XML Signature with KeyInfo / X509Data / X509Certificate(Classic ASP) Create XML Signature with KeyInfo / X509Data / X509SKI(Visual FoxPro) Create XML Signature with KeyInfo / X509Data / X509SKI(PowerBuilder) Create XML Signature with KeyInfo / X509Data / X509SKI(SQL Server) Create XML Signature with KeyInfo / X509Data / X509SKI(Visual Basic 6.0) Create XML Signature with KeyInfo / X509Data / X509SKI(VBScript) Create XML Signature with KeyInfo / X509Data / X509SKI
top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
SigId
SigId As String
Introduced in version 9.5.0.69

An option Id attribute value for the Signature element. The default value is the empty string, which generates a Signature element with no Id attribute. For example:

<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
If this property is set to "abc123", then the Signature element would be generated like this:
<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Id="abc123">

top
SigLocation
SigLocation As String
Introduced in version 9.5.0.69

Indicates where the Signature is to be located within the XML that is signed. This is a path to the position in the XML where the Signature will be inserted, using Chilkat path syntax (using vertical bar characters to delimit tag names. If the Signature element is to be the root of XML document, then set this property equal to the empty string.

For example, if we have the following SOAP XML and wish to insert the Signature at the indicated location, then the SigLocation property should be set to "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security".

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header>
	<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1">
		** The XML Signature is to be inserted here **
	</wsse:Security>
    </SOAP-ENV:Header>
...
</SOAP-ENV:Envelope>

top
SigNamespacePrefix
SigNamespacePrefix As String
Introduced in version 9.5.0.69

The namespace prefix of the Signature that is to be created. The default value is "ds". Set this property to the empty string to omit a Signature namespace URI and prefix. For example, given the default values of SigNamespaceUri and SigNamespacePrefix, the generated Signature element will be:

<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> ... </ds:Signature>

top
SigNamespaceUri
SigNamespaceUri As String
Introduced in version 9.5.0.69

The namespace URI of the Signature that is to be created. The default value is "http://www.w3.org/2000/09/xmldsig#". For example, if the SigNamespacePrefix equals "ds" and this property remains at the default value, then the generated Signature element will be:

<ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> ... </ds:Signature>

top
SignedInfoCanonAlg
SignedInfoCanonAlg As String
Introduced in version 9.5.0.69

The canonicalization method to be used for the SignedInfo when creating the XML signature.

  • "C14N" -- for Inclusive Canonical XML (without comments)
  • "C14N_11" -- for Inclusive Canonical XML 1.1 (without comments)
  • "EXCL_C14N" -- for Exclusive Canonical XML (without comments)
  • "C14N_WithComments" -- for Inclusive Canonical XML (with comments)
  • "C14N_11_WithComments" -- for Inclusive Canonical XML 1.1 (with comments)
  • "EXCL_C14N_WithComments" -- for Exclusive Canonical XML (with comments)
  • Note: The WithComments options are available in Chilkat v9.5.0.71 and later.

The default value is "EXCL_C14N".

top
SignedInfoDigestMethod
SignedInfoDigestMethod As String
Introduced in version 9.5.0.69

The digest method to be used for signing the SignedInfo part of the Signature. Possible values are "sha1", "sha256", "sha384", and "sha512". The default is "sha256".

top
SignedInfoId
SignedInfoId As String
Introduced in version 9.5.0.75

Optional Id attribute to be added to the SignedInfo element. The default value is the empty string, meaning that the SignedInfo is generated without an Id attribute.

top
SignedInfoPrefixList
SignedInfoPrefixList As String
Introduced in version 9.5.0.69

The inclusive namespace prefix list to be added, if any, when the SignedInfoCanonAlg is equal to "EXCL_C14N". The defautl value is the empty string. If namespaces are listed, they are separated by space characters.

If, for example, this property is set to "wsse SOAP-ENV", then the CanonicalizationMethod part of the SignedInfo that is generated would look like this:

<ds:SignedInfo>
    <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
      <InclusiveNamespaces xmlns="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="wsse SOAP-ENV" />
    </ds:CanonicalizationMethod>
...
</ds:SignedInfo>

top
SigningAlg
SigningAlg As String
Introduced in version 9.5.0.69

Selects the signature algorithm to be used when using an RSA key to sign. The default value is "PKCS1-v1_5". This can be set to "RSASSA-PSS" (or simply "pss") to use the RSASSA-PSS signature scheme.

Note: This property only applies when signing with an RSA private key. It does not apply for ECC or DSA private keys.

top
SigValueId
SigValueId As String
Introduced in version 9.5.0.75

An option Id attribute value for the SignatureValue element. The default value is the empty string, which generates a SignatureValue element with no Id attribute. For example:

<ds:SignatureValue>
If this property is set to "value-id-7d4a", then the Signature element would be generated like this:
<ds:SignatureValue  Id="value-id-7d4a">

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

top
X509Type
X509Type As String
Introduced in version 9.5.0.69

Specifies the kind of X.509 certificate information is provided in the KeyInfo element when the KeyInfoType equals "X509Data". Possible values are:

  • Certificate
  • CertChain
  • IssuerSerial
  • SubjectName
  • SKI

The default value is "Certificate".

Note: This property can be set to a comma-separated list of the keywords above. For example, If set to "SubjectName,Certificate", then both the X509SubjectName and X509Certificate parts will be added to the KeyInfo.

If Certificate, then the KeyInfo will contain the base64 encoded X.509v3 certificate.

If CertChain, then the KeyInfo will contain the base64 encoded X.509v3 certificate as well as any certificates available in the chain of authentication to the root cert.

If IssuerSerial, then the KeyInfo will contain the X.509 issuer's distinguished name and the signing certificate's serial number.

If SubjectName, then the KeyInfo will contain the X.509 subject distinguished name.

If SKI, then the KeyInfo will contain the base64 encoded value of the cert's X.509 SubjectKeyIdentifier extension.

top

Methods

AddEnvelopedRef
AddEnvelopedRef(id As String, content As ChilkatStringBuilder, digestMethod As String, canonMethod As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies an enveloped Reference to be added to the Signature when generated. An enveloped Reference is for data contained within the Signature. (The Signature is to be an enveloping signature, and the data is enveloped by the Signature.)

The id is the value of the Id attribute of the Object element that is to be contained within the generated Signature. The content is the text content to be contained in the Object. Binary data can be signed by passing the bytes in content in an encoded format (such as base64 or hex).

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The canonMethod is the canonicalization method, and can be one of the following.

  • "C14N" -- for Inclusive Canonical XML (without comments)
  • "C14N_11" -- for Inclusive Canonical XML 1.1 (without comments)
  • "EXCL_C14N" -- for Exclusive Canonical XML (without comments)
  • "C14N_WithComments" -- for Inclusive Canonical XML (with comments)
  • "C14N_11_WithComments" -- for Inclusive Canonical XML 1.1 (with comments)
  • "EXCL_C14N_WithComments" -- for Exclusive Canonical XML (with comments)
  • Note: The WithComments options are available in Chilkat v9.5.0.71 and later.

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddExternalBinaryRef
AddExternalBinaryRef(uri As String, content As ChilkatBinData, digestMethod As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies an external non-XML binary data Reference to be added to the Signature when generated.

The uri is the value of the URI attribute of the Reference.

The content contains the binary data to be digested according to the digestMethod.

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddExternalFileRef
AddExternalFileRef(uri As String, localFilePath As String, digestMethod As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies an external file Reference to be added to the Signature when generated.

The uri is the value of the URI attribute of the Reference. It can (and likely will) be different than the localFilePath which is the path to the local file to be added. (The local file is not read until the XML digital signature is actually created.)

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddExternalTextRef
AddExternalTextRef(uri As String, content As ChilkatStringBuilder, charset As String, ByVal includeBom As Long, digestMethod As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies an external non-XML text data Reference to be added to the Signature when generated.

The uri is the value of the URI attribute of the Reference.

The content contains the non-XML data to be digested according to the charset. The charset specifies the charset (such as "utf-8", "windows-1252", etc.) for the byte reprsentation of the text to be digested. The includeBom indicates whether the BOM (Byte Order Mark, also known as the preamble) is included in the byte representation that is digested.

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddExternalXmlRef
AddExternalXmlRef(uri As String, content As ChilkatStringBuilder, digestMethod As String, canonMethod As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies an external XML Reference to be added to the Signature when generated.

The uri is the value of the URI attribute of the Reference.

The content contains the XML document to be referenced.

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The canonMethod is the canonicalization method, and can be one of the following.

  • "C14N" -- for Inclusive Canonical XML (without comments)
  • "C14N_11" -- for Inclusive Canonical XML 1.1 (without comments)
  • "EXCL_C14N" -- for Exclusive Canonical XML (without comments)
  • "C14N_WithComments" -- for Inclusive Canonical XML (with comments)
  • "C14N_11_WithComments" -- for Inclusive Canonical XML 1.1 (with comments)
  • "EXCL_C14N_WithComments" -- for Exclusive Canonical XML (with comments)
  • "" -- An empty string indicates that no transformation should be included / applied for this reference.
  • Note: The WithComments options are available in Chilkat v9.5.0.71 and later.
  • Note: The empty-string canonMethod is available in Chilkat v9.5.0.75 and later.

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddObject
AddObject(id As String, content As String, mimeType As String, encoding As String) As Long
Introduced in version 9.5.0.75

Specifies an Object to be added to the Signature.

  1. The id is the value of the Object element's Id attribute.
  2. The content contains the content of the Object element, which may be XML or plain text.
  3. The mimeType is the value of the Object element's MimeType attribute
  4. The encoding is the value of the Object element's Encoding attribute
In most cases, the mimeType and encoding are empty strings which cause the MimeType and Encoding attributes to be omitted.

Returns 1 for success, 0 for failure.

top
AddObjectRef
AddObjectRef(id As String, digestMethod As String, canonMethod As String, prefixList As String, refType As String) As Long
Introduced in version 9.5.0.75

This is the same as the AddSameDocRef method, except the reference is to content within an Object previously added via the AddObject method. The id must be an Id equal to the Id attribute of an Object, or the Id attribute of an element within the Object.

Note: The canonMethod can be set to "Base64" to use the http://www.w3.org/2000/09/xmldsig#base64 transform.

Returns 1 for success, 0 for failure.

top
AddSameDocRef
AddSameDocRef(id As String, digestMethod As String, canonMethod As String, prefixList As String, refType As String) As Long
Introduced in version 9.5.0.69

Specifies a same document Reference to be added to the Signature when generated. A same document Reference can be the entire XML document, or a fragment of the XML document.

The id can be the empty string to sign the entire XML document, or it can be the fragment identifier to sign a portion of the XML document.

The digestMethod is the digest method and can be one of the following: "sha1", "sha256", "sha384", "sha512", "ripemd160", or "md5".

The canonMethod is the canonicalization method, and can be one of the following:

  • "C14N" -- for Inclusive Canonical XML (without comments)
  • "C14N_11" -- for Inclusive Canonical XML 1.1 (without comments)
  • "EXCL_C14N" -- for Exclusive Canonical XML (without comments)
  • "C14N_WithComments" -- for Inclusive Canonical XML (with comments)
  • "C14N_11_WithComments" -- for Inclusive Canonical XML 1.1 (with comments)
  • "EXCL_C14N_WithComments" -- for Exclusive Canonical XML (with comments)
  • "" -- An empty string indicates that no transformation should be included / applied for this reference.
  • Note: The WithComments options are available in Chilkat v9.5.0.71 and later.
  • Note: The empty-string canonMethod is available in Chilkat v9.5.0.75 and later.

If exclusive canonicalization is selected, then the prefixList can contain a space separated list of inclusive namespace prefixes. For inclusive canonicalization, this argument is ignored. In general, pass an empty string for this argument unless you have specific knowledge of namespace prefixes that need to be treated as inclusive when EXCL_C14N is used.

Starting in Chilkat v9.5.0.70, the prefixList can be set to the keyword "_EMPTY_" to force the generation of an empty PrefixList under the Transform. For example:

  <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#">
	<ec:InclusiveNamespaces xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList=""/>
  </ds:Transform>

The refType is optional and is usually not needed. Set this to the empty string unless it is desired to add a Type attribute to the Reference that is advisory only.

Returns 1 for success, 0 for failure.

top
AddSignatureNamespace
AddSignatureNamespace(nsPrefix As String, nsUri As String) As Long
Introduced in version 9.5.0.75

Can be called one or more times to add additional namespaces to the Signature element.

Returns 1 for success, 0 for failure.

top
ConstructSignedInfo
ConstructSignedInfo(sbXml As ChilkatStringBuilder) As String
Introduced in version 9.5.0.74

This method will construct and return the canonicalized SignedInfo XML. The digests of each Reference are computed and included in the SignedInfo. This method is provided for certain special circumstances where one wants to get the exact canonicalized SignedInfo that would be signed using the private key.

Note: Properties such as SigLocation, SigningAlg, etc. and references must be set exactly as if an XML signature was to be actually generated because they determine the content of the SignedInfo.

Note, the sbXml is not signed by this method. It is not modified.

Returns Nothing on failure

top
CreateXmlDSig
CreateXmlDSig(inXml As String) As String
Introduced in version 9.5.0.69

Creates an XML Digital Signature. The application passes in the XML to be signed, and the signed XML is returned. If creating an enveloping signature where the Signature element is the root, then the inXml may be the empty string.

Returns Nothing on failure

top
CreateXmlDSigSb
CreateXmlDSigSb(sbXml As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.69

Creates an XML Digital Signature. The application passes the XML to be signed in sbXml, and it is replaced with the signed XML if successful. (Thus, sbXml is both an input and output argument.) Note: If creating an enveloping signature where the Signature element is to be the root element, then the passed-in sbXml may be empty.

Returns 1 for success, 0 for failure.

top
SetHmacKey
SetHmacKey(key As String, encoding As String) As Long
Introduced in version 9.5.0.69

Sets the HMAC key to be used if the Signature is to use an HMAC signing algorithm. The encoding specifies the encoding of key, and can be "hex", "base64", "ascii", or any of the binary encodings supported by Chilkat in the link below.

Returns 1 for success, 0 for failure.

top
SetPrivateKey
SetPrivateKey(privKey As PrivateKey) As Long
Introduced in version 9.5.0.69

Sets the private key to be used for creating the XML signature. The private key may be an RSA key, a DSA key, or an ECDSA key.

Returns 1 for success, 0 for failure.

top
SetRefIdAttr
SetRefIdAttr(uri_or_id As String, value As String) As Long
Introduced in version 9.5.0.75

Sets the "Id" attribute for a Reference.

Returns 1 for success, 0 for failure.

top
SetX509Cert
SetX509Cert(cert As ChilkatCert, ByVal usePrivateKey As Long) As Long
Introduced in version 9.5.0.69

Specifies the X.509 certificate to be used for the KeyInfo element when the KeyInfoType equals "X509Data". If usePrivateKey is 1, then the private key will also be set using the certificate's private key. Thus, the SetPrivateKey method does not need to be called. If usePrivateKey is 1, and the certificate does not have an associated private key available, then this method will return 0.

Note: A certificate's private key is not stored within a certificate itself. If the certificate (cert) was obtained from a PFX, Java KeyStore, or other such source, which are containers for both certs and private keys, then Chilkat would have associated the cert with the private key when loading the PFX or JKS, and all is good. The same holds true if, on a Windows system, the certificate was obtained from a Windows-based registry certificate store where the private key was installed with the permission to export.

If, however, the certificate was loaded from a .cer file, or another type of file that contains only the certificate and not the private key, then the associated private key needs to be obtained by the application and provided by calling SetPrivateKey.

Returns 1 for success, 0 for failure.

top