XmlDSig Tcl Reference Documentation

XmlDSig

Current Version: 9.5.0.73

An API for validating XML Digital Signatures. Use the XmlDSigGen class for creating XML Digital Signatures.

Object Creation

set myXmlDSig [new CkXmlDSig]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkXmlDSig_get_DebugLogFilePath $myXmlDSig $ckStr
set strVal [CkXmlDSig_get_debugLogFilePath $myXmlDSig]
CkXmlDSig_put_DebugLogFilePath $myXmlDSig $strVal

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
LastErrorHtml
string
# ckStr is a CkString
CkXmlDSig_get_LastErrorHtml $myXmlDSig $ckStr
set strVal [CkXmlDSig_get_lastErrorHtml $myXmlDSig]

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
string
# ckStr is a CkString
CkXmlDSig_get_LastErrorText $myXmlDSig $ckStr
set strVal [CkXmlDSig_get_lastErrorText $myXmlDSig]

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
string
# ckStr is a CkString
CkXmlDSig_get_LastErrorXml $myXmlDSig $ckStr
set strVal [CkXmlDSig_get_lastErrorXml $myXmlDSig]

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
boolean 1/0
set boolVal [CkXmlDSig_get_LastMethodSuccess $myXmlDSig]
CkXmlDSig_put_LastMethodSuccess $myXmlDSig $boolVal
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
NumReferences
integer
set intVal [CkXmlDSig_get_NumReferences $myXmlDSig]
Introduced in version 9.5.0.69

The number of data objects referenced in the XML digital signature. A data object may be self-contained within the loaded XML signature, or it may be an external URI reference. An application can check each reference to see if it's external by calling IsReferenceExternal, and can get each reference URI by calling ReferenceUri.

top
NumSignatures
integer
set intVal [CkXmlDSig_get_NumSignatures $myXmlDSig]
Introduced in version 9.5.0.69

The number of digital signatures found within the loaded XML. Each digital signature is composed of XML having the following structure:

  <Signature ID?> 
     <SignedInfo>
       <CanonicalizationMethod/>
       <SignatureMethod/>
       (<Reference URI? >
         (<Transforms>)?
         <DigestMethod>
         <DigestValue>
       </Reference>)+
     </SignedInfo>
     <SignatureValue> 
    (<KeyInfo>)?
    (<Object ID?>)*
 </Signature>
Note: The "Signature" and other XML tags may be namespace prefixed.

The Selector property is used to select which XML signature is in effect when validating or calling other methods or properties.

More Information and Examples
top
Selector
integer
set intVal [CkXmlDSig_get_Selector $myXmlDSig]
CkXmlDSig_put_Selector $myXmlDSig $intVal
Introduced in version 9.5.0.69

If the loaded XML contains multiple signatures, this property can be set to specify which signature is in effect when calling other methods or properties. In most cases, the loaded XML contains a single signature and this property will remain at the default value of 0.

More Information and Examples
top
Utf8
boolean 1/0
set boolVal [CkXmlDSig_get_Utf8 $myXmlDSig]
CkXmlDSig_put_Utf8 $myXmlDSig $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkXmlDSig_get_VerboseLogging $myXmlDSig]
CkXmlDSig_put_VerboseLogging $myXmlDSig $boolVal

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
string
# ckStr is a CkString
CkXmlDSig_get_Version $myXmlDSig $ckStr
set strVal [CkXmlDSig_get_version $myXmlDSig]

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

top
WithComments
boolean 1/0
set boolVal [CkXmlDSig_get_WithComments $myXmlDSig]
CkXmlDSig_put_WithComments $myXmlDSig $boolVal
This property is deprecated. It will be removed in a future version.

Note: This property is not actually used because the "with/without comments" behavior is passed as an argument to the CanonicalizeXml and CanonicalizeFragment methods.

Determines whether XML is canonicalized with or without comments. The default value is 0. (Set to 1 to canonicalize with XML comments.)

top

Methods

CanonicalizeFragment
# xml is a string
# fragmentId is a string
# version is a string
# prefixList is a string
# withComments is a boolean
# outStr is a CkString (output)
set status [CkXmlDSig_CanonicalizeFragment $xml $fragmentId $version $prefixList $withComments $outStr]
set retStr [CkXmlDSig_canonicalizeFragment $myXmlDSig $xml $fragmentId $version $prefixList $withComments]

Applies XML canonicalization to a fragment of the passed-in XML, and returns the canonicalized XML string. The fragmentId identifies the XML element where output begins. It is the XML element having an "id" attribute equal to fragmentId. The version may be one of the following:

  • "C14N" -- for Inclusive Canonical XML
  • "EXCL_C14N" -- for Exclusive Canonical XML

The prefixList only applies when the version is set to "EXCL_C14N". The prefixList may be an empty string, or a SPACE separated list of namespace prefixes. It is the InclusiveNamespaces PrefixList, which is the list of namespaces that are propagated from ancestor elements for canonicalization purposes.

If withComments is 1, then XML comments are included in the output. If withComments is 0, then XML comments are excluded from the output.

Returns 1 for success, 0 for failure.

More Information and Examples
top
CanonicalizeXml
# xml is a string
# version is a string
# withComments is a boolean
# outStr is a CkString (output)
set status [CkXmlDSig_CanonicalizeXml $xml $version $withComments $outStr]
set retStr [CkXmlDSig_canonicalizeXml $myXmlDSig $xml $version $withComments]

Applies XML canonicalization to the passed-in XML, and returns the canonicalized XML string. The version may be one of the following:

  • "C14N" -- for Inclusive Canonical XML
  • "EXCL_C14N" -- for Exclusive Canonical XML

If withComments is 1, then XML comments are included in the output. If withComments is 0, then XML comments are excluded from the output.

Returns 1 for success, 0 for failure.

top
GetKeyInfo
# returns a CkXml
set ret_xml [CkXmlDSig_GetKeyInfo]
Introduced in version 9.5.0.69

Returns the KeyInfo XML for the signature indicated by the Selector property. Returns NULL if no KeyInfo exists.

Returns NULL on failure

More Information and Examples
top
GetPublicKey
# returns a CkPublicKey
set ret_publicKey [CkXmlDSig_GetPublicKey]
Introduced in version 9.5.0.69

Returns the public key from the KeyInfo XML for the signature indicated by the Selector property. Returns NULL if no KeyInfo exists, or if no public key is actually contained in the KeyInfo.

Returns NULL on failure

top
IsReferenceExternal
# index is an integer
set retBool [CkXmlDSig_IsReferenceExternal $index]
Introduced in version 9.5.0.69

Returns 1 if the reference at index is external. Each external reference would first need to be provided by the application prior to validating the signature.

top
LoadSignature
# xmlSig is a string
set status [CkXmlDSig_LoadSignature $xmlSig]
Introduced in version 9.5.0.69

Loads an XML document containing 1 or more XML digital signatures. An application would first load XML containing digital signature(s), then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.

Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.

Returns 1 for success, 0 for failure.

top
LoadSignatureBd
# binData is a CkBinData
set status [CkXmlDSig_LoadSignatureBd $binData]
Introduced in version 9.5.0.69

Loads an XML document containing one or more XML digital signatures from the contents of a BinData object. An application would first load the XML, then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.

Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.

Returns 1 for success, 0 for failure.

top
LoadSignatureSb
# sbXmlSig is a CkStringBuilder
set status [CkXmlDSig_LoadSignatureSb $sbXmlSig]
Introduced in version 9.5.0.69

Loads an XML document containing one or more XML digital signatures from the contents of a StringBuilder object. An application would first load the XML, then validate. After loading, it is also possible to use various methods and properties to get information about the signature, such as the key info, references, etc. If external data is referenced by the signature, it may be necessary to provide the referenced data prior to validating.

Note: When loading an XML document, the Selector property is automatically reset to 0, and the NumSignatures property is set to the number of XML digital signatures found.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ReferenceUri
# index is an integer
# outStr is a CkString (output)
set status [CkXmlDSig_ReferenceUri $index $outStr]
set retStr [CkXmlDSig_referenceUri $myXmlDSig $index]
Introduced in version 9.5.0.69

Returns the URI of the Nth reference specified by index. (The 1st reference is at index 0.) URI's beginning with a pound sign ('#') are internal references.

Returns 1 for success, 0 for failure.

top
SaveLastError
# path is a string
set status [CkXmlDSig_SaveLastError $path]

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
SetHmacKey
# key is a string
# encoding is a string
set status [CkXmlDSig_SetHmacKey $key $encoding]
Introduced in version 9.5.0.69

Sets the HMAC key to be used if the Signature used 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
SetPublicKey
# pubKey is a CkPublicKey
set status [CkXmlDSig_SetPublicKey $pubKey]
Introduced in version 9.5.0.69

Sets the public key to be used for verifying the signature indicated by the Selector property. A public key only needs to be explicitly provided by the application for those XML signatures where the public key is not already available within the KeyInfo of the Signature. In some cases, the KeyInfo within the Signature contains information about what public key was used for signing. The application can use this information to retrieve the matching public key and provide it via this method.

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetRefDataBd
# index is an integer
# binData is a CkBinData
set retBool [CkXmlDSig_SetRefDataBd $index $binData]
Introduced in version 9.5.0.69

Provides the binary data for the external reference at index.

top
SetRefDataFile
# index is an integer
# path is a string
set retBool [CkXmlDSig_SetRefDataFile $index $path]
Introduced in version 9.5.0.69

Provides the data for the external reference at index. When validating the signature, the data contained in path will be streamed to compute the digest for validation.

top
SetRefDataSb
# index is an integer
# sb is a CkStringBuilder
# charset is a string
set retBool [CkXmlDSig_SetRefDataSb $index $sb $charset]
Introduced in version 9.5.0.69

Provides the text data for the external reference at index. The charset specifies the byte representation of the text, such as "utf-8", "utf-16", "windows-1252", etc. (If in doubt, try utf-8 first.)

top
UseCertVault
# certVault is a CkXmlCertVault
set status [CkXmlDSig_UseCertVault $certVault]
Introduced in version 9.5.0.69

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates having public keys when verifying an XML signature. A single XML certificate vault may be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.

Returns 1 for success, 0 for failure.

top
VerifyReferenceDigest
# index is an integer
set retBool [CkXmlDSig_VerifyReferenceDigest $index]
Introduced in version 9.5.0.69

This method allows for an application to verify the digest for each reference separately. This can be helpful if the full XMLDSIG validation fails, then one can test each referenced data's digest to see which, if any, fail to match.

top
VerifySignature
# verifyReferenceDigests is a boolean
set status [CkXmlDSig_VerifySignature $verifyReferenceDigests]
Introduced in version 9.5.0.69

Verifies the signature indicated by the Selector property. If verifyReferenceDigests is 1, then the digest of each Reference within the signature's SignedInfo is also validated.

Returns 1 for success, 0 for failure.

top