XMLSigReference Type

This type defines information about the reference.

Remarks

This type defines information about the reference including the location within the document (XMLElement), TransformAlgorithms, HashAlgorithm, and URI.

Fields

HashAlgorithm
String

This field defines the hash algorithm to apply to the element specified by XMLElement. Possible values are:

"SHA1" (default)
"SHA256"
"SHA512"

HashValue
String

This field holds the calculated hash value for the specified XMLElement.

TransformAlgorithms
String

This field specifies a comma separated list of canonicalization algorithms to be applied to XMLElement. The XML data specified by XMLElement will be transformed using the specified algorithm(s) before the HashAlgorithm is applied. The default value is "C14N". Possible values are:


"C14N"	Canonical XML version 1.0
"C14N_COMMENTS"	Canonical XML version 1.0 with comments
"C14N11"	Canonical XML version 1.1
"C14N11_COMMENTS"	Canonical XML version 1.1 with comments
"EXC_C14N"	Exclusive XML canonicalization version 1.0
"EXC_C14N_COMMENTS"	Exclusive XML canonicalization version 1.0 with comments

URI
String

This field is the URI of the reference. The value specified here identifies the data within the document.

When signing, this value may be set to a URI reference which identifies XMLElement. XMLElement must be set separately.

When verifying, this value may be checked within the SignatureInfo event to identify the location of XMLElement. XMLElement must be set separately.

XMLElement
String

This field specifies XML element to sign or verify using XPath notation. When signing, this must be set before calling Sign. When verifying, this must be set from within the SignatureInfo event. The URI field may be used to help identify the correct XML element.


/root/myElement	XPath syntax
/root/[1]	XPath syntax using an index
/root/ns:myElement	XPath syntax where the element has a namespace
myElement	Just the element name
@id=myid	Attribute selector: This will select an element with an attribute "id" whose value is "myid".
/root/myElement[1]/ns:name2[@attr=attrValue]	XPath syntax using an index and attribute selector

Constructors

[VB.NET]
Public XMLSigReference()

[C#]
public XMLSigReference();

[VB.NET]
Public XMLSigReference(ByVal XMLElement As String, ByVal URI As String, ByVal HashAlgorithm As String, ByVal TransformAlgorithms As String, ByVal HashValue As String)

[C#]
public XMLSigReference(string XMLElement, string URI, string hashAlgorithm, string transformAlgorithms, string hashValue);