SAMLReader Component

Properties   Methods   Events   Config Settings   Errors  

The SAMLReader component offers SAML message processing functionality.

Syntax

TsbxSAMLReader

Remarks

SAMLReader provides means for processing of SAML protocol messages and extraction of their elements. Together with SAMLWriter it provides fine-grained access to the contents of SAML messages. You may consider using these classes if functionality offered by SAMLIdPServer and SAMLSPServer is too high a level for your usage scenario.

SAMLReader and SAMLWriter are independent of SAML server controls, and focus on scenarios that require lower-level access to SAML messaging.

SAMLReader can process the following types of SAML messages:

• AssertionIDRequest
• SubjectQuery
• AuthnQuery
• AttributeQuery
• AuthzDecisionQuery
• AuthnRequest
• ManageNameIDRequest
• LogoutRequest
• NameIDMappingRequest
• ArtifactResolve
• Response

Pass your SAML message to Open (or OpenStream) method. Upon processing, component will populate the elements of the message in the properties, such as Message and Response. More complex elements, such as assertions, require pinning with PinAssertion method to be populated in the object properties.

The snippet below shows how to use SAMLReader to process a message of the AuthnRequest type created by the matching SAMLReader example (or by any compatible SAML endpoint). The input SAML message has the following look: <samlp:AuthnRequest xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0" IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false" ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"> <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer> <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <ds:SignedInfo> <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/> <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/> <ds:Reference URI="#53GhrzQ5f89fu214ANAR"> <ds:Transforms> <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/> <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/> </ds:Transforms> <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue> </ds:Reference> </ds:SignedInfo> <ds:SignatureValue> jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5 Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA== </ds:SignatureValue> <ds:KeyInfo> <ds:X509Data><ds:X509Certificate> MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2 FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ 0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW 8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6 InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f 6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U </ds:X509Certificate></ds:X509Data> </ds:KeyInfo> </ds:Signature> <samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/> <saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions> </samlp:AuthnRequest> You can process this message and access its properties with the following code: Samlreader reader = new Samlreader(); reader.ValidateSignatures = true; reader.Open(req); Log("SAML document loaded. The message is of the " + reader.InputTypeString + " type, and was issued by " + reader.Issuer + " at " + reader.IssueInstant + "."); if (reader.InputType == SamlreaderInputTypes.cstyAuthnRequest) { Log("AuthnRequest.ConsumerServiceURL: " + reader.AuthnRequest.AssertionConsumerServiceURL); Log("AuthnRequest.ProtocolBinding: " + reader.AuthnRequest.ProtocolBinding); Log("AuthnRequest.Conditions.NotBefore: " + reader.AuthnRequest.ConditionsNotBefore); Log("AuthnRequest.Conditions.NotAfter: " + reader.AuthnRequest.ConditionsNotOnOrAfter); } if (reader.Signed) { Log("The message was signed by " + reader.SigningCertificate.SubjectRDN); Log("Signature validity: " + reader.SignatureValidationResult.ToString()); }

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ArtifactEndpointIndex Property (SAMLReader Component)

An accessor to the EndpointIndex entry of the artifact.

Syntax

__property int ArtifactEndpointIndex = { read=FArtifactEndpointIndex };

Default Value

0

Remarks

An accessor to the EndpointIndex entry of the artifact.

The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer.

This property is read-only and not available at design time.

Data Type

Integer

ArtifactMessageHandle Property (SAMLReader Component)

An accessor to the MessageHandle property of the artifact.

Syntax

__property DynamicArray ArtifactMessageHandle = { read=FArtifactMessageHandle };

Remarks

An accessor to the MessageHandle property of the artifact.

A message handle is a unique reference to a SAML message that can be produced by the artifact issuer upon request.

This property is read-only and not available at design time.

Data Type

Byte Array

ArtifactRemainingArtifact Property (SAMLReader Component)

Returns the contents of the artifact.

Syntax

__property DynamicArray ArtifactRemainingArtifact = { read=FArtifactRemainingArtifact };

Remarks

Returns the contents of the artifact.

Check this property to access the encoded contents of the artifact. This property is updated internally from the parameters of the artifact.

This property is read-only and not available at design time.

Data Type

Byte Array

ArtifactSourceID Property (SAMLReader Component)

An accessor to the SourceID property of the artifact.

Syntax

__property DynamicArray ArtifactSourceID = { read=FArtifactSourceID };

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is read-only and not available at design time.

Data Type

Byte Array

ArtifactTypeCode Property (SAMLReader Component)

The TypeCode property of the artifact.

Syntax

__property int ArtifactTypeCode = { read=FArtifactTypeCode };

Default Value

0

Remarks

The TypeCode field of the artifact.

The type code artifact parameter uniquely identifies the artifact format. Currently (as per SAML 2.0) the only type code of 4 is defined. This format assumes the presence of ArtifactRemainingArtifact, ArtifactSourceID, and ArtifactMessageHandle parameters.

This property is read-only and not available at design time.

Data Type

Integer

ArtifactURI Property (SAMLReader Component)

An accessor to the URI property of the artifact.

Syntax

__property String ArtifactURI = { read=FArtifactURI };

Default Value

""

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is read-only and not available at design time.

Data Type

String

ArtifactResolveQuery Property (SAMLReader Component)

Returns the content of the ArtifactResolve query.

Syntax

__property String ArtifactResolveQuery = { read=FArtifactResolveQuery };

Default Value

""

Remarks

Check this property to access the content of the ArtifactResolve query, if the input type is set to cstyArtifactResolve.

This property is read-only and not available at design time.

Data Type

String

AssertionCount Property (SAMLReader Component)

Returns the number of assertions in the SAML message.

Syntax

__property int AssertionCount = { read=FAssertionCount };

Default Value

0

Remarks

Check this property to retrieve the number of assertions contained in the SAML message.

This property is read-only and not available at design time.

Data Type

Integer

AttributeCount Property (SAMLReader Component)

The number of records in the Attribute arrays.

Syntax

__property int AttributeCount = { read=FAttributeCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttributeFriendlyName
• AttributeName
• AttributeNameFormat
• AttributeStatementIndex
• AttributeValues

The array indices start at 0 and end at AttributeCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

AttributeFriendlyName Property (SAMLReader Component)

Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.

Syntax

__property String AttributeFriendlyName[int AttributeIndex] = { read=FAttributeFriendlyName };

Default Value

""

Remarks

Specifies the friendly name of the attribute

Use this property to access or set the friendly name of a SAML attribute (e.g. givenName).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

This property is read-only and not available at design time.

Data Type

String

AttributeName Property (SAMLReader Component)

Specifies the name of the attribute.

Syntax

__property String AttributeName[int AttributeIndex] = { read=FAttributeName };

Default Value

""

Remarks

Specifies the name of the attribute.

Use this property to read or set the formal name of the attribute (e.g. urn:oid:2.5.4.42).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

This property is read-only and not available at design time.

Data Type

String

AttributeNameFormat Property (SAMLReader Component)

Indicates the format used to reference the attribute.

Syntax

__property String AttributeNameFormat[int AttributeIndex] = { read=FAttributeNameFormat };

Default Value

""

Remarks

Indicates the format used to reference the attribute.

This property specifies the format that is used to reference the attribute (e.g. urn:oasis:names:tc:SAML:2.0:attrname-format:uri).

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

This property is read-only and not available at design time.

Data Type

String

AttributeStatementIndex Property (SAMLReader Component)

Contains the index of the statement the attribute corresponds to.

Syntax

__property int AttributeStatementIndex[int AttributeIndex] = { read=FAttributeStatementIndex };

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

Use this property to read or set the index of the statement in the statement list that this attribute corresponds to.

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

This property is read-only and not available at design time.

Data Type

Integer

AttributeValues Property (SAMLReader Component)

Contains a list of attribute values.

Syntax

__property String AttributeValues[int AttributeIndex] = { read=FAttributeValues };

Default Value

""

Remarks

Contains a list of attribute values.

Use this property to access or set the value(s) included with the attribute. The value contains a list of strings of ContentType=contentType;Value=value format, separated with CRLF.

The AttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributeCount property.

This property is read-only and not available at design time.

Data Type

String

AuthnQueryComparison Property (SAMLReader Component)

Specifies the authentication context comparison method.

Syntax

__property TsbxSAMLReaderAuthnQueryComparisons AuthnQueryComparison = { read=FAuthnQueryComparison };

enum TsbxSAMLReaderAuthnQueryComparisons {
  cacctNone=0,
  cacctExact=1,
  cacctMinimum=2,
  cacctMaximum=3,
  cacctBetter=4
};

Default Value

cacctNone

Remarks

Specifies the authentication context comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

This property is read-only and not available at design time.

Data Type

Integer

AuthnQueryContextClassRefs Property (SAMLReader Component)

Specifies the context class reference.

Syntax

__property String AuthnQueryContextClassRefs = { read=FAuthnQueryContextClassRefs };

Default Value

""

Remarks

Specifies the context class reference.

Use this property to access or set the authentication context class reference.

This property is read-only and not available at design time.

Data Type

String

AuthnQueryRefType Property (SAMLReader Component)

Specifies the context reference type.

Syntax

__property TsbxSAMLReaderAuthnQueryRefTypes AuthnQueryRefType = { read=FAuthnQueryRefType };

enum TsbxSAMLReaderAuthnQueryRefTypes {
  cacrtUnknown=0,
  cacrtClass=1,
  cacrtDecl=2
};

Default Value

cacrtUnknown

Remarks

Specifies the context reference type.

Use this property to access or set the authentication contexts reference type (class or declaration).

This property is read-only and not available at design time.

Data Type

Integer

AuthnQuerySessionIndex Property (SAMLReader Component)

Specifies the index of the session to the authentication entity.

Syntax

__property String AuthnQuerySessionIndex = { read=FAuthnQuerySessionIndex };

Default Value

""

Remarks

Specifies the index of the session to the authentication entity.

Use this property to access or set the index of the session to the authentication entity.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SAMLReader Component)

Specifies the assertion consumer service index.

Syntax

__property int AuthnRequestAssertionConsumerServiceIndex = { read=FAuthnRequestAssertionConsumerServiceIndex };

Default Value

0

Remarks

Specifies the assertion consumer service index.

Use this property to access or set the location index to which the response has to be returned.

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SAMLReader Component)

Specifies the assertion consumer service URL.

Syntax

__property String AuthnRequestAssertionConsumerServiceURL = { read=FAuthnRequestAssertionConsumerServiceURL };

Default Value

""

Remarks

Specifies the assertion consumer service URL.

Use this property to access or set the URL of the location to which the response has to be returned.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SAMLReader Component)

Specifies the attribute consuming service index.

Syntax

__property int AuthnRequestAttributeConsumingServiceIndex = { read=FAuthnRequestAttributeConsumingServiceIndex };

Default Value

0

Remarks

Specifies the attribute consuming service index.

Use this property to read or set the attribute consuming service index.

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestContextClassRefs Property (SAMLReader Component)

Provides access to the authentication context class references.

Syntax

__property String AuthnRequestContextClassRefs = { read=FAuthnRequestContextClassRefs };

Default Value

""

Remarks

Provides access to the authentication context class references.

Use this property to access or set the class references of the authentication context. This property may contain a list of CRLF-separated strings.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestContextComparison Property (SAMLReader Component)

Specifies the AuthnContext comparison method.

Syntax

__property TsbxSAMLReaderAuthnRequestContextComparisons AuthnRequestContextComparison = { read=FAuthnRequestContextComparison };

enum TsbxSAMLReaderAuthnRequestContextComparisons {
  cacctNone=0,
  cacctExact=1,
  cacctMinimum=2,
  cacctMaximum=3,
  cacctBetter=4
};

Default Value

cacctNone

Remarks

Specifies the AuthnContext comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestContextRefType Property (SAMLReader Component)

Specifies the context reference type.

Syntax

__property TsbxSAMLReaderAuthnRequestContextRefTypes AuthnRequestContextRefType = { read=FAuthnRequestContextRefType };

enum TsbxSAMLReaderAuthnRequestContextRefTypes {
  cacrtUnknown=0,
  cacrtClass=1,
  cacrtDecl=2
};

Default Value

cacrtUnknown

Remarks

Specifies the context reference type.

Use this property to get or set the context reference type (Class or Declaration).

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestFlags Property (SAMLReader Component)

Adjusts secondary serialization properties.

Syntax

__property int AuthnRequestFlags = { read=FAuthnRequestFlags };

Default Value

0

Remarks

Adjusts secondary serialization properties.

Use this bit mask property to adjust how certain properties will be saved. The following flags are supported:

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestForceAuthn Property (SAMLReader Component)

Corresponds to the ForceAuthn parameter of the request.

Syntax

__property bool AuthnRequestForceAuthn = { read=FAuthnRequestForceAuthn };

Default Value

false

Remarks

Corresponds to the ForceAuthn parameter of the request.

Use this property to check or set the ForceAuthn parameter of the request, which enforces the identity provider to re-authenticate the presenter.

This property is read-only and not available at design time.

Data Type

Boolean

AuthnRequestIsPassive Property (SAMLReader Component)

Maps to the IsPassive parameter of the request.

Syntax

__property bool AuthnRequestIsPassive = { read=FAuthnRequestIsPassive };

Default Value

false

Remarks

Maps to the IsPassive parameter of the request.

Use this property to access or set the IsPassive parameter of the authentication request. IsPassive sets out the control the identity provider and user agent have over the authenticating users UI.

This property is read-only and not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SAMLReader Component)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

__property bool AuthnRequestNameIDPolicyAllowCreate = { read=FAuthnRequestNameIDPolicyAllowCreate };

Default Value

false

Remarks

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Use this property to access or set the AllowCreate attribute of NameIDPolicy, which allows or disallows the identity provider to create a new identifier when processing the authentication request.

This property is read-only and not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SAMLReader Component)

Matches to the Format attribute of the NameIDPolicy element of the request.

Syntax

__property String AuthnRequestNameIDPolicyFormat = { read=FAuthnRequestNameIDPolicyFormat };

Default Value

""

Remarks

Matches to the Format attribute of the NameIDPolicy element of the request.

Use this property to access or set the Format attribute of NameIDPolicy.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestNameIDPolicySPNameQualifier Property (SAMLReader Component)

Matches to the SP name qualifier attribute of the request.

Syntax

__property String AuthnRequestNameIDPolicySPNameQualifier = { read=FAuthnRequestNameIDPolicySPNameQualifier };

Default Value

""

Remarks

Matches to the SP name qualifier attribute of the request.

Use this property to access or set the SP name qualifier attribute of the authentication request.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestProtocolBinding Property (SAMLReader Component)

Specifies the protocol binding to be requested in the authentication request.

Syntax

__property String AuthnRequestProtocolBinding = { read=FAuthnRequestProtocolBinding };

Default Value

""

Remarks

Specifies the protocol binding to be requested in the authentication request.

Use this property to check or set the protocol binding to be used when responding to this request.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestProviderName Property (SAMLReader Component)

Specifies the name of the requestor.

Syntax

__property String AuthnRequestProviderName = { read=FAuthnRequestProviderName };

Default Value

""

Remarks

Specifies the name of the requestor.

Use this property to read or set the name of the requestor.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestScopingGetComplete Property (SAMLReader Component)

Matches the GetComplete element of the IDPList entry of the Scoping object.

Syntax

__property String AuthnRequestScopingGetComplete = { read=FAuthnRequestScopingGetComplete };

Default Value

""

Remarks

Matches the GetComplete element of the IDPList entry of the Scoping object.

Use this property to access or set the GetComplete element of the IDPList entry of the Scoping object of the authentication request. This property typically contains an URI that allows to retrieve a complete list of identity providers.

This property is read-only and not available at design time.

Data Type

String

AuthnRequestScopingProxyCount Property (SAMLReader Component)

The maximum number of proxies on the way between the requestor and the provider.

Syntax

__property int AuthnRequestScopingProxyCount = { read=FAuthnRequestScopingProxyCount };

Default Value

0

Remarks

The maximum number of proxies on the way between the requestor and the provider.

Use this property to get or set the maximum number of intermediaries allowed between the requestor and the provider.

This property is read-only and not available at design time.

Data Type

Integer

AuthnRequestScopingRequesterIDs Property (SAMLReader Component)

A collection of requestor IDs on whose behalf the request is being sent.

Syntax

__property String AuthnRequestScopingRequesterIDs = { read=FAuthnRequestScopingRequesterIDs };

Default Value

""

Remarks

A collection of requestor IDs on whose behalf the request is being sent.

Use this property to specify or read the requestor IDs, in the form of CRLF-separated strings, on whose behalf the request is being sent.

This property is read-only and not available at design time.

Data Type

String

AuthzDecisionQueryActions Property (SAMLReader Component)

Specifies the list of actions included in the query.

Syntax

__property String AuthzDecisionQueryActions = { read=FAuthzDecisionQueryActions };

Default Value

""

Remarks

Specifies the list of actions included in the query.

Read or set this property to access the list of actions (as CRLF-separated strings) included in the query.

This property is read-only and not available at design time.

Data Type

String

AuthzDecisionQueryResource Property (SAMLReader Component)

Matches the Resource element of the query.

Syntax

__property String AuthzDecisionQueryResource = { read=FAuthzDecisionQueryResource };

Default Value

""

Remarks

Matches the Resource element of the query.

Use this property to read or set the Resource element of the authorization decision query.

This property is read-only and not available at design time.

Data Type

String

BindingBindingType Property (SAMLReader Component)

Specifies the type of SAML binding to use.

Syntax

__property TsbxSAMLReaderBindingBindingTypes BindingBindingType = { read=FBindingBindingType };

enum TsbxSAMLReaderBindingBindingTypes {
  csbtNone=0,
  csbtSOAP=1,
  csbtPAOS=2,
  csbtRedirect=3,
  csbtPOST=4,
  csbtArtifact=5
};

Default Value

csbtNone

Remarks

Specifies the type of SAML binding to use.

Use this property to specify the binding type to use with the request.

This property is read-only and not available at design time.

Data Type

Integer

BindingBody Property (SAMLReader Component)

Contains the POST binding form body.

Syntax

__property String BindingBody = { read=FBindingBody };

Default Value

""

Remarks

Contains the POST binding form body.

Use this property to read or set the body of the form returned by the service provider.

This property is read-only and not available at design time.

Data Type

String

BindingEncoding Property (SAMLReader Component)

Specifies the message encoding.

Syntax

__property String BindingEncoding = { read=FBindingEncoding };

Default Value

""

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is read-only and not available at design time.

Data Type

String

BindingForceSign Property (SAMLReader Component)

Enforces a signature over all outgoing messages.

Syntax

__property bool BindingForceSign = { read=FBindingForceSign };

Default Value

false

Remarks

Enforces a signature over all outgoing messages.

Use this property to enforce signing of all outgoing messages, independently of whether the original message was signed or not. See also BindingSign.

This property is read-only and not available at design time.

Data Type

Boolean

BindingFormTemplate Property (SAMLReader Component)

Contains the XHTML form template returned by the service provider.

Syntax

__property String BindingFormTemplate = { read=FBindingFormTemplate };

Default Value

""

Remarks

Contains the XHTML form template returned by the service provider.

Use this property to access or set the template of a POST form provided by the service provider (POST binding only).

This property is read-only and not available at design time.

Data Type

String

BindingPOSTMode Property (SAMLReader Component)

Specifies whether binding is applied on the server, or on the client side.

Syntax

__property TsbxSAMLReaderBindingPOSTModes BindingPOSTMode = { read=FBindingPOSTMode };

enum TsbxSAMLReaderBindingPOSTModes {
  cspmClient=0,
  cspmServer=1
};

Default Value

cspmClient

Remarks

Specifies whether binding is applied on the server, or on the client side.

Use this property to specify whether POST binding is used on the server or client side of the communication. The default value is cspmClient.

This property is read-only and not available at design time.

Data Type

Integer

BindingRelayState Property (SAMLReader Component)

Contains the RelayState parameter of the binding.

Syntax

__property String BindingRelayState = { read=FBindingRelayState };

Default Value

""

Remarks

Contains the RelayState parameter of the binding.

Use this property to access or set the RelayState parameter of the binding. This is an uninterpreted state string that should be passed back to the service provider with subsequent requests.

This property is read-only and not available at design time.

Data Type

String

BindingSignatureAlgorithm Property (SAMLReader Component)

Contains the signature algorithm.

Syntax

__property String BindingSignatureAlgorithm = { read=FBindingSignatureAlgorithm };

Default Value

""

Remarks

Contains the signature algorithm.

Use this property to get or set the signature algorithm. This corresponds to the SigAlg query string parameter, and contains the URI of the signature algorithm.

This property is read-only and not available at design time.

Data Type

String

BindingSignatureValidationResult Property (SAMLReader Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLReaderBindingSignatureValidationResults BindingSignatureValidationResult = { read=FBindingSignatureValidationResult };

enum TsbxSAMLReaderBindingSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

BindingSigned Property (SAMLReader Component)

Specifies whether to sign the binding.

Syntax

__property bool BindingSigned = { read=FBindingSigned };

Default Value

false

Remarks

Specifies whether to sign the binding.

Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use BindingForceSign property to enforce signatures on all binding entities.

This property is read-only and not available at design time.

Data Type

Boolean

BindingURL Property (SAMLReader Component)

Contains the URL of the request query.

Syntax

__property String BindingURL = { read=FBindingURL };

Default Value

""

Remarks

Contains the URL of the request query.

Use this property to read or set the URL of the request query or POST target.

This property is read-only and not available at design time.

Data Type

String

BindingVerifySignatures Property (SAMLReader Component)

Instructs the component whether to verify incoming signatures.

Syntax

__property bool BindingVerifySignatures = { read=FBindingVerifySignatures };

Default Value

true

Remarks

Instructs the component whether to verify incoming signatures.

Use this property to activate or deactivate verification of signatures in incoming requests.

This property is read-only and not available at design time.

Data Type

Boolean

BindingKeyHandle Property (SAMLReader Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 BindingKeyHandle = { read=FBindingKeyHandle, write=FSetBindingKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

BindingKeyKey Property (SAMLReader Component)

The byte array representation of the key.

Syntax

__property DynamicArray BindingKeyKey = { read=FBindingKeyKey };

Remarks

The byte array representation of the key. This may not be available for non-BindingKeyExportable keys.

This property is read-only and not available at design time.

Data Type

Byte Array

CertCount Property (SAMLReader Component)

The number of records in the Cert arrays.

Syntax

__property int CertCount = { read=FCertCount, write=FSetCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CertBytes
• CertHandle

The array indices start at 0 and end at CertCount - 1.

This property is not available at design time.

Data Type

Integer

CertBytes Property (SAMLReader Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray CertBytes[int CertIndex] = { read=FCertBytes };

Remarks

Returns the raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

CertHandle Property (SAMLReader Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 CertHandle[int CertIndex] = { read=FCertHandle, write=FSetCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is not available at design time.

Data Type

Long64

ConditionCount Property (SAMLReader Component)

The number of records in the Condition arrays.

Syntax

__property int ConditionCount = { read=FConditionCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ConditionCondition
• ConditionConditionType

The array indices start at 0 and end at ConditionCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ConditionCondition Property (SAMLReader Component)

The condition set in accordance with the ConditionType .

Syntax

__property String ConditionCondition[int ConditionIndex] = { read=FConditionCondition };

Default Value

""

Remarks

The condition set in accordance with the ConditionType.

For csctAudienceRestriction conditions, read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.

For csctProxyRestriction conditions, check or set the value of the proxy count restriction.

For csctNotBefore and csctNotOnOrAfter, check or set the respective date/time values.

The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.

This property is read-only and not available at design time.

Data Type

String

ConditionConditionType Property (SAMLReader Component)

Specifies a type of the condition object.

Syntax

__property TsbxSAMLReaderConditionConditionTypes ConditionConditionType[int ConditionIndex] = { read=FConditionConditionType };

enum TsbxSAMLReaderConditionConditionTypes {
  csctAudienceRestriction=0,
  csctOneTimeUse=1,
  csctProxyRestriction=2,
  csctNotBefore=3,
  csctNotOnOrAfter=4
};

Default Value

csctAudienceRestriction

Remarks

Specifies a type of the condition object.

Use this property to check or specify the type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.

The ConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ConditionCount property.

This property is read-only and not available at design time.

Data Type

Integer

DecryptionCertificateBytes Property (SAMLReader Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray DecryptionCertificateBytes = { read=FDecryptionCertificateBytes };

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertificateHandle Property (SAMLReader Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 DecryptionCertificateHandle = { read=FDecryptionCertificateHandle, write=FSetDecryptionCertificateHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

FIPSMode Property (SAMLReader Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

LogoutRequestNameID Property (SAMLReader Component)

Contains the value of the NameID parameter.

Syntax

__property String LogoutRequestNameID = { read=FLogoutRequestNameID };

Default Value

""

Remarks

Contains the value of the NameID parameter.

Use this property to access or set the value of the NameID parameter of the request.

This property is read-only and not available at design time.

Data Type

String

LogoutRequestNotOnOrAfter Property (SAMLReader Component)

Contains the value of the NotOnOrAfter parameter.

Syntax

__property String LogoutRequestNotOnOrAfter = { read=FLogoutRequestNotOnOrAfter };

Default Value

""

Remarks

Contains the value of the NotOnOrAfter parameter.

Use this property to access or set the value of the NotOnOrAfter parameter.

This property is read-only and not available at design time.

Data Type

String

LogoutRequestReason Property (SAMLReader Component)

Contains the value of the Reason parameter.

Syntax

__property String LogoutRequestReason = { read=FLogoutRequestReason };

Default Value

""

Remarks

Contains the value of the Reason parameter.

Use this property to read or set the value of the Reason parameter.

This property is read-only and not available at design time.

Data Type

String

LogoutRequestSessionIndexes Property (SAMLReader Component)

Contains the list of session indices.

Syntax

__property String LogoutRequestSessionIndexes = { read=FLogoutRequestSessionIndexes };

Default Value

""

Remarks

Contains the list of session indices.

Use this property to access or set the list of session indices, as a CRLF-separated list of strings.

This property is read-only and not available at design time.

Data Type

String

ManageNameIDRequestNameID Property (SAMLReader Component)

Contains the value of the NameID parameter of the request.

Syntax

__property String ManageNameIDRequestNameID = { read=FManageNameIDRequestNameID };

Default Value

""

Remarks

Contains the value of the NameID parameter of the request.

Use this property to read or set the value of the NameID parameter of the request.

This property is read-only and not available at design time.

Data Type

String

ManageNameIDRequestNewEncryptedID Property (SAMLReader Component)

Contains the value of the NewEncryptedID parameter of the request.

Syntax

__property String ManageNameIDRequestNewEncryptedID = { read=FManageNameIDRequestNewEncryptedID };

Default Value

""

Remarks

Contains the value of the NewEncryptedID parameter of the request.

Use this property to check or set the value of the NewEncryptedID parameter of the request.

This property is read-only and not available at design time.

Data Type

String

ManageNameIDRequestNewID Property (SAMLReader Component)

Contains the value of the NewID parameter.

Syntax

__property String ManageNameIDRequestNewID = { read=FManageNameIDRequestNewID };

Default Value

""

Remarks

Contains the value of the NewID parameter.

Use this property to access or set the NewID parameter of the request.

This property is read-only and not available at design time.

Data Type

String

ManageNameIDRequestTerminate Property (SAMLReader Component)

Contains the value of the Terminate parameter of the request.

Syntax

__property String ManageNameIDRequestTerminate = { read=FManageNameIDRequestTerminate };

Default Value

""

Remarks

Contains the value of the Terminate parameter of the request.

Use this property to read or set the value of the Terminate parameter of the request.

This property is read-only and not available at design time.

Data Type

String

MessageConsent Property (SAMLReader Component)

Contains the Consent parameter of the SAML message.

Syntax

__property String MessageConsent = { read=FMessageConsent };

Default Value

""

Remarks

Contains the Consent parameter of the SAML message.

Use this property to specify the Consent parameter of the SAML entity.

This property is read-only and not available at design time.

Data Type

String

MessageContentType Property (SAMLReader Component)

Returns the SAML type of the current message.

Syntax

__property TsbxSAMLReaderMessageContentTypes MessageContentType = { read=FMessageContentType };

enum TsbxSAMLReaderMessageContentTypes {
  cstyNone=0,
  cstyAssertionIDRequest=1,
  cstySubjectQuery=2,
  cstyAuthnQuery=3,
  cstyAttributeQuery=4,
  cstyAuthzDecisionQuery=5,
  cstyAuthnRequest=6,
  cstyManageNameIDRequest=7,
  cstyLogoutRequest=8,
  cstyNameIDMappingRequest=9,
  cstyArtifactResolve=10,
  cstyResponse=11,
  cstyAssertion=12
};

Default Value

cstyNone

Remarks

Returns the SAML type of the current message.

Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.

Depending on the assigned type, use properties of component to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.

This property is read-only and not available at design time.

Data Type

Integer

MessageContentTypeString Property (SAMLReader Component)

Returns the type of the processed message, as an original string.

Syntax

__property String MessageContentTypeString = { read=FMessageContentTypeString };

Default Value

""

Remarks

Returns the type of the processed message, as an original string.

Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.

Known SAML content types are:

• AssertionIDRequest
• SubjectQuery
• AuthnQuery
• AttributeQuery
• AuthzDecisionQuery
• AuthnRequest
• ManageNameIDRequest
• NameIDMappingRequest
• LogoutRequest
• ArtifactResolve
• Response
• LogoutResponse
• ArtifactResponse
• NameIDMappingResponse

This property is read-only and not available at design time.

Data Type

String

MessageDestination Property (SAMLReader Component)

Contains the Destination parameter of the SAML message.

Syntax

__property String MessageDestination = { read=FMessageDestination };

Default Value

""

Remarks

Contains the Destination parameter of the SAML message.

Use this property to set the Destination parameter of the created SAML object.

This property is read-only and not available at design time.

Data Type

String

MessageID Property (SAMLReader Component)

The ID of the request.

Syntax

__property String MessageID = { read=FMessageID };

Default Value

""

Remarks

The ID of the request.

Use this property to specify the ID of the SAML request or response.

This property is read-only and not available at design time.

Data Type

String

MessageInResponseTo Property (SAMLReader Component)

Contains the InResponseTo property of the SAML request.

Syntax

__property String MessageInResponseTo = { read=FMessageInResponseTo };

Default Value

""

Remarks

Contains the InResponseTo property of the SAML request.

Use this property to specify the ID of the message in response to which the current entity is provided.

This property is read-only and not available at design time.

Data Type

String

MessageIssueInstant Property (SAMLReader Component)

Contains request issuance timestamp.

Syntax

__property String MessageIssueInstant = { read=FMessageIssueInstant };

Default Value

""

Remarks

Contains request issuance timestamp.

Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.

This property is read-only and not available at design time.

Data Type

String

MessageIssuer Property (SAMLReader Component)

Sets the issuer of the message.

Syntax

__property String MessageIssuer = { read=FMessageIssuer };

Default Value

""

Remarks

Sets the issuer of the message.

Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:

• Format
• NameQualifier
• Value
• IDType
• SPNameQualifier
• SPProvidedID

For example, writer.Message.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

This property is read-only and not available at design time.

Data Type

String

MessageSignatureValidationResult Property (SAMLReader Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLReaderMessageSignatureValidationResults MessageSignatureValidationResult = { read=FMessageSignatureValidationResult };

enum TsbxSAMLReaderMessageSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

MessageSigned Property (SAMLReader Component)

Specifies whether the SAML message is or should be signed.

Syntax

__property bool MessageSigned = { read=FMessageSigned };

Default Value

false

Remarks

Specifies whether the SAML message is or should be signed.

Check this property to find out whether the processed message was signed by the sender, or set this property to true to indicate that the created message should be signed.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSubject Property (SAMLReader Component)

Gets or sets the subject of the message.

Syntax

__property String MessageSubject = { read=FMessageSubject };

Default Value

""

Remarks

Gets or sets the subject of the message.

Check this property to obtain the SAML ID of the message subject.

Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:

• Format
• NameQualifier
• Value
• IDType
• SPNameQualifier
• SPProvidedID

For example, writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

This property is read-only and not available at design time.

Data Type

String

MessageVersion Property (SAMLReader Component)

Specifies the protocol version to use for the SAML message.

Syntax

__property String MessageVersion = { read=FMessageVersion };

Default Value

"2.0"

Remarks

Specifies the protocol version to use for the SAML message.

Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.

This property is read-only and not available at design time.

Data Type

String

MessageXMLHeader Property (SAMLReader Component)

Controls the inclusion of an XML header in the message.

Syntax

__property bool MessageXMLHeader = { read=FMessageXMLHeader };

Default Value

false

Remarks

Controls the inclusion of an XML header in the message.

Use this property to enable or disable inclusion of the XML header in the SAML message.

This property is read-only and not available at design time.

Data Type

Boolean

NameIDMappingRequestNameID Property (SAMLReader Component)

An accessor to the NameID parameter of the request.

Syntax

__property String NameIDMappingRequestNameID = { read=FNameIDMappingRequestNameID };

Default Value

""

Remarks

An accessor to the NameID parameter of the request.

Use this property to read or set the value of the NameID parameter of the request object.

This property is read-only and not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyAllowCreate Property (SAMLReader Component)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

__property bool NameIDMappingRequestNameIDPolicyAllowCreate = { read=FNameIDMappingRequestNameIDPolicyAllowCreate };

Default Value

false

Remarks

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Use this property to read or set the value of the AllowCreate parameter of the NameIDPolicy object. AllowCreate regulates whether the identity provider is given permission to create new subject identifiers.

This property is read-only and not available at design time.

Data Type

Boolean

NameIDMappingRequestNameIDPolicyFormat Property (SAMLReader Component)

Specifies the format of the NameIDPolicy element.

Syntax

__property String NameIDMappingRequestNameIDPolicyFormat = { read=FNameIDMappingRequestNameIDPolicyFormat };

Default Value

""

Remarks

Specifies the format of the NameIDPolicy element.

Use this property to set or read the value of the Format parameter of the NameIDPolicy object.

This property is read-only and not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicySPNameQualifier Property (SAMLReader Component)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

__property String NameIDMappingRequestNameIDPolicySPNameQualifier = { read=FNameIDMappingRequestNameIDPolicySPNameQualifier };

Default Value

""

Remarks

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Use this property to specify or read the value of the SPNameQualifier parameter of the NameIDPolicy element of the request.

This property is read-only and not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SAMLReader Component)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

__property bool NameIDMappingRequestNameIDPolicyUseAllowCreate = { read=FNameIDMappingRequestNameIDPolicyUseAllowCreate };

Default Value

false

Remarks

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Use this property to include or exclude the UseAllow parameter from the NameIDPolicy object.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedAssertionAssertionType Property (SAMLReader Component)

Specifies the type of the assertion.

Syntax

__property TsbxSAMLReaderPinnedAssertionAssertionTypes PinnedAssertionAssertionType = { read=FPinnedAssertionAssertionType };

enum TsbxSAMLReaderPinnedAssertionAssertionTypes {
  csatAssertionIDRef=0,
  csatAssertionURIRef=1,
  csatAssertion=2,
  csatEncryptedAssertion=3
};

Default Value

csatAssertion

Remarks

Specifies the type of the assertion.

Use this property to check or set the type of the assertion.

This property is read-only and not available at design time.

Data Type

Integer

PinnedAssertionEncryptedContent Property (SAMLReader Component)

Represents the encrypted assertion content.

Syntax

__property String PinnedAssertionEncryptedContent = { read=FPinnedAssertionEncryptedContent };

Default Value

""

Remarks

Represents the encrypted assertion content.

Use this property to get or set the encrypted assertion content.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionID Property (SAMLReader Component)

Represents the ID of the assertion.

Syntax

__property String PinnedAssertionID = { read=FPinnedAssertionID };

Default Value

""

Remarks

Represents the ID of the assertion.

Use this property to read or set the unique ID of the assertion.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionIDRef Property (SAMLReader Component)

Represents an ID reference value.

Syntax

__property String PinnedAssertionIDRef = { read=FPinnedAssertionIDRef };

Default Value

""

Remarks

Represents an ID reference value.

Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionIssueInstant Property (SAMLReader Component)

Contains the assertion issuance time stamp.

Syntax

__property String PinnedAssertionIssueInstant = { read=FPinnedAssertionIssueInstant };

Default Value

""

Remarks

Contains the assertion issuance time stamp.

Use this property to check or set the assertion issuance time.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionIssuer Property (SAMLReader Component)

Specifies the assertion issuer.

Syntax

__property String PinnedAssertionIssuer = { read=FPinnedAssertionIssuer };

Default Value

""

Remarks

Specifies the assertion issuer.

Use this property to provide the assertion issuer ID.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionParentAssertion Property (SAMLReader Component)

Contains the index of the parent assertion in the assertion list.

Syntax

__property int PinnedAssertionParentAssertion = { read=FPinnedAssertionParentAssertion };

Default Value

-1

Remarks

Contains the index of the parent assertion in the assertion list.

This property is set to -1 for normal assertions. ParentAssertion set to a non-negative value indicates that the assertion is an advice assertion incorporated into a top-level assertion. Advice assertions are typically used by service providers to provide additional information about the SAML assertion issuing authority.

This property is read-only and not available at design time.

Data Type

Integer

PinnedAssertionSignatureValidationResult Property (SAMLReader Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLReaderPinnedAssertionSignatureValidationResults PinnedAssertionSignatureValidationResult = { read=FPinnedAssertionSignatureValidationResult };

enum TsbxSAMLReaderPinnedAssertionSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only and not available at design time.

Data Type

Integer

PinnedAssertionSigned Property (SAMLReader Component)

Specifies whether the assertion is signed.

Syntax

__property bool PinnedAssertionSigned = { read=FPinnedAssertionSigned };

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is read-only and not available at design time.

Data Type

Boolean

PinnedAssertionSubject Property (SAMLReader Component)

Specifies the assertion subject.

Syntax

__property String PinnedAssertionSubject = { read=FPinnedAssertionSubject };

Default Value

""

Remarks

Specifies the assertion subject.

Use this property to provide the assertion's subject SAML ID.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionURIRef Property (SAMLReader Component)

Represents an URI reference value.

Syntax

__property String PinnedAssertionURIRef = { read=FPinnedAssertionURIRef };

Default Value

""

Remarks

Represents an URI reference value.

Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.

This property is read-only and not available at design time.

Data Type

String

PinnedAssertionVersion Property (SAMLReader Component)

Specifies the SAML protocol version used.

Syntax

__property String PinnedAssertionVersion = { read=FPinnedAssertionVersion };

Default Value

""

Remarks

Specifies the SAML protocol version used.

This property specifies the SAML protocol version. The default value is 2.0.

This property is read-only and not available at design time.

Data Type

String

Profile Property (SAMLReader Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

__property String Profile = { read=FProfile, write=FSetProfile };

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ProxyAddress Property (SAMLReader Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SAMLReader Component)

The authentication type used by the proxy server.

Syntax

__property TsbxSAMLReaderProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

enum TsbxSAMLReaderProxyAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SAMLReader Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SAMLReader Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SAMLReader Component)

The type of the proxy server.

Syntax

__property TsbxSAMLReaderProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

enum TsbxSAMLReaderProxyProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SAMLReader Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SAMLReader Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SAMLReader Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SAMLReader Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUsername Property (SAMLReader Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

References Property (SAMLReader Component)

Contains the References entry of the SAML AssertionIDRequest message.

Syntax

__property String References = { read=FReferences };

Default Value

""

Remarks

Use this property to read the value of the References entry of the AssertionIDRequest message.

This property is read-only and not available at design time.

Data Type

String

ResponseNameID Property (SAMLReader Component)

Contains the NameID parameter of a NameIDMapping response.

Syntax

__property String ResponseNameID = { read=FResponseNameID };

Default Value

""

Remarks

Contains the NameID parameter of a NameIDMapping response.

Use this property to read or set the NameID parameter of the NameIDMapping response.

This property is read-only and not available at design time.

Data Type

String

ResponseOptionalElement Property (SAMLReader Component)

An optional message element to be returned with the response.

Syntax

__property String ResponseOptionalElement = { read=FResponseOptionalElement };

Default Value

""

Remarks

An optional message element to be returned with the response.

Use this property to access or set the optional XML element returned with the response.

This property is read-only and not available at design time.

Data Type

String

ResponseResponseType Property (SAMLReader Component)

Contains the type of the response.

Syntax

__property TsbxSAMLReaderResponseResponseTypes ResponseResponseType = { read=FResponseResponseType };

enum TsbxSAMLReaderResponseResponseTypes {
  csrtResponse=0,
  csrtArtifactResponse=1,
  csrtNameIDMappingResponse=2
};

Default Value

csrtResponse

Remarks

Contains the type of the response.

Use this property to get or set the type of the SAML response.

This property is read-only and not available at design time.

Data Type

Integer

ResponseStatus Property (SAMLReader Component)

Gets or sets the status of the response.

Syntax

__property int ResponseStatus = { read=FResponseStatus };

Default Value

0

Remarks

Gets or sets the status of the response.

This property specifies the status code to include in the response. This property adjusts the values of the ResponseStatusCodeValue and other status properties.

This property is a bitwise combination of the status facility and an error code. The facility mask can be one of the following:

• 0x00000000 - Success (urn:oasis:names:tc:SAML:2.0:status:Success)
• 0x00010000 - Requester Error (urn:oasis:names:tc:SAML:2.0:status:Requester)
• 0x00020000 - Responder Error (urn:oasis:names:tc:SAML:2.0:status:Responder)
• 0x00030000 - Version Mismatch (urn:oasis:names:tc:SAML:2.0:status:VersionMismatch)
• 0x00FF0000 - Undefined or Unknown

The code assigned to the setting is saved in the response as the status given in the brackets.

The error code can take one of the following values:

• 0x00000001 - Authentication Failed (urn:oasis:names:tc:SAML:2.0:status:AuthnFailed)
• 0x00000002 - Unsupported content received within the received Attribute structure (urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue)
• 0x00000003 - The requested Name Identifier policy is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy)
• 0x00000004 - The requested Authentication Context requirements cannot be satisfied by the provider (urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext)
• 0x00000005 - None of the elements in the IDP list can be resolved (urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP)
• 0x00000006 - The provider cannot authenticate the requestor passively (urn:oasis:names:tc:SAML:2.0:status:NoPassive)
• 0x00000007 - None of the requested providers in the IDP list are supported (urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP)
• 0x00000008 - The Logout request could not be passed on to other session participants (urn:oasis:names:tc:SAML:2.0:status:PartialLogout)
• 0x00000009 - Proxy count exceeded (urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded)
• 0x0000000A - Request denied for internal reasons (urn:oasis:names:tc:SAML:2.0:status:RequestDenied)
• 0x0000000B - The request or its type is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported)
• 0x0000000C - The version of the request has been deprecated (urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated)
• 0x0000000D - The version of the request is too high (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh)
• 0x0000000E - The version of the request is too low (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow)
• 0x0000000F - The resource included in the request has not been recognised (urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized)
• 0x00000010 - The number of responses to be returned is too high for the provider to satisfy (urn:oasis:names:tc:SAML:2.0:status:TooManyResponses)
• 0x00000011 - The attribute profile is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile)
• 0x00000012 - The principal mentioned in the request is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal)
• 0x00000013 - Unsupported binding type (urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding)

To return a custom error code not available via the above flags, use ResponseStatusCodeValue and ResponseStatusCodeSubValue properties.

This property is read-only and not available at design time.

Data Type

Integer

ResponseStatusCodeSubValue Property (SAMLReader Component)

The value of the nested StatusCode.

Syntax

__property String ResponseStatusCodeSubValue = { read=FResponseStatusCodeSubValue };

Default Value

""

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is read-only and not available at design time.

Data Type

String

ResponseStatusCodeValue Property (SAMLReader Component)

Contains the status code value.

Syntax

__property String ResponseStatusCodeValue = { read=FResponseStatusCodeValue };

Default Value

""

Remarks

Contains the status code value.

Use this property to read or set one of the status codes defined by SAML specification, such as 'urn:oasis:names:tc:SAML:2.0:status:Success' or 'urn:oasis:names:tc:SAML:2.0:status:Requester'.

This property is read-only and not available at design time.

Data Type

String

ResponseStatusDetail Property (SAMLReader Component)

Contains additional information on the status of the request.

Syntax

__property String ResponseStatusDetail = { read=FResponseStatusDetail };

Default Value

""

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

This property is read-only and not available at design time.

Data Type

String

ResponseStatusMessage Property (SAMLReader Component)

Contains a status message (optional).

Syntax

__property String ResponseStatusMessage = { read=FResponseStatusMessage };

Default Value

""

Remarks

Contains a status message (optional).

This property specifies the status message which may, optionally, be returned to an operator.

This property is read-only and not available at design time.

Data Type

String

ScopingIDPCount Property (SAMLReader Component)

The number of records in the ScopingIDP arrays.

Syntax

__property int ScopingIDPCount = { read=FScopingIDPCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ScopingIDPLoc
• ScopingIDPName
• ScopingIDPProviderID

The array indices start at 0 and end at ScopingIDPCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ScopingIDPLoc Property (SAMLReader Component)

Contains the value of the Loc attribute.

Syntax

__property String ScopingIDPLoc[int ScopingIDPIndex] = { read=FScopingIDPLoc };

Default Value

""

Remarks

Contains the value of the Loc attribute.

Use this property to access or set the value of the Loc (location) attribute.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

This property is read-only and not available at design time.

Data Type

String

ScopingIDPName Property (SAMLReader Component)

Contains the name of the IdP provider.

Syntax

__property String ScopingIDPName[int ScopingIDPIndex] = { read=FScopingIDPName };

Default Value

""

Remarks

Contains the name of the IdP provider.

Use this property to retrieve or set the Name attribute of the IdP provider.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

This property is read-only and not available at design time.

Data Type

String

ScopingIDPProviderID Property (SAMLReader Component)

Contains the provider ID.

Syntax

__property String ScopingIDPProviderID[int ScopingIDPIndex] = { read=FScopingIDPProviderID };

Default Value

""

Remarks

Contains the provider ID.

Use this property to read or set the identity provider ID.

The ScopingIDPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ScopingIDPCount property.

This property is read-only and not available at design time.

Data Type

String

SecurityCanonicalizationMethod Property (SAMLReader Component)

The canonicalization method to use in the signature.

Syntax

__property String SecurityCanonicalizationMethod = { read=FSecurityCanonicalizationMethod };

Default Value

""

Remarks

The canonicalization method to use in the signature.

The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)

This property is read-only and not available at design time.

Data Type

String

SecurityDigestMethod Property (SAMLReader Component)

The digest method to use.

Syntax

__property String SecurityDigestMethod = { read=FSecurityDigestMethod };

Default Value

""

Remarks

The digest method to use.

The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.

This property is read-only and not available at design time.

Data Type

String

SecurityEncryptionMethod Property (SAMLReader Component)

The encryption method used to encrypt the assertion.

Syntax

__property String SecurityEncryptionMethod = { read=FSecurityEncryptionMethod };

Default Value

"AES256"

Remarks

The encryption method used to encrypt the assertion.

This property contains the encryption algorithm used to encrypt the XML assertion.

Supported values:

This property is read-only and not available at design time.

Data Type

String

SecurityFlags Property (SAMLReader Component)

Provides access to secondary security parameters and tweaks.

Syntax

__property int SecurityFlags = { read=FSecurityFlags };

Default Value

1

Remarks

Provides access to secondary security parameters and tweaks.

This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):

This property is read-only and not available at design time.

Data Type

Integer

SecuritySigMethod Property (SAMLReader Component)

The signature method to use.

Syntax

__property String SecuritySigMethod = { read=FSecuritySigMethod };

Default Value

""

Remarks

The signature method to use.

The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

This property is read-only and not available at design time.

Data Type

String

SecuritySignaturePolicy Property (SAMLReader Component)

Specifies the signature validation policy.

Syntax

__property TsbxSAMLReaderSecuritySignaturePolicies SecuritySignaturePolicy = { read=FSecuritySignaturePolicy };

enum TsbxSAMLReaderSecuritySignaturePolicies {
  sspAuto=0,
  sspValidate=1,
  sspRequire=2,
  sspIgnore=3
};

Default Value

sspAuto

Remarks

Specifies the signature validation policy.

Use this property to specify the signature validation policy for the component.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertBytes Property (SAMLReader Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCA Property (SAMLReader Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool SigningCertCA = { read=FSigningCertCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertCAKeyID Property (SAMLReader Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

__property DynamicArray SigningCertCAKeyID = { read=FSigningCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SigningCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (SAMLReader Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String SigningCertCRLDistributionPoints = { read=FSigningCertCRLDistributionPoints };

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only and not available at design time.

Data Type

String

SigningCertCurve Property (SAMLReader Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String SigningCertCurve = { read=FSigningCertCurve };

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

This property is read-only and not available at design time.

Data Type

String

SigningCertFingerprint Property (SAMLReader Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String SigningCertFingerprint = { read=FSigningCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only and not available at design time.

Data Type

String

SigningCertFriendlyName Property (SAMLReader Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String SigningCertFriendlyName = { read=FSigningCertFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only and not available at design time.

Data Type

String

SigningCertHandle Property (SAMLReader Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (SAMLReader Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String SigningCertHashAlgorithm = { read=FSigningCertHashAlgorithm };

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigningCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuer Property (SAMLReader Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String SigningCertIssuer = { read=FSigningCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via SigningCertIssuerRDN.

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuerRDN Property (SAMLReader Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String SigningCertIssuerRDN = { read=FSigningCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyAlgorithm Property (SAMLReader Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String SigningCertKeyAlgorithm = { read=FSigningCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyBits Property (SAMLReader Component)

Returns the length of the public key in bits.

Syntax

__property int SigningCertKeyBits = { read=FSigningCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the SigningCertPublicKeyBytes or SigningCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyFingerprint Property (SAMLReader Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

__property String SigningCertKeyFingerprint = { read=FSigningCertKeyFingerprint };

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the SigningCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyUsage Property (SAMLReader Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int SigningCertKeyUsage = { read=FSigningCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyValid Property (SAMLReader Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool SigningCertKeyValid = { read=FSigningCertKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertOCSPLocations Property (SAMLReader Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

__property String SigningCertOCSPLocations = { read=FSigningCertOCSPLocations };

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only and not available at design time.

Data Type

String

SigningCertPolicyIDs Property (SAMLReader Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String SigningCertPolicyIDs = { read=FSigningCertPolicyIDs };

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is read-only and not available at design time.

Data Type

String

SigningCertPublicKeyBytes Property (SAMLReader Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray SigningCertPublicKeyBytes = { read=FSigningCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSelfSigned Property (SAMLReader Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool SigningCertSelfSigned = { read=FSigningCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertSerialNumber Property (SAMLReader Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray SigningCertSerialNumber = { read=FSigningCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSigAlgorithm Property (SAMLReader Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String SigningCertSigAlgorithm = { read=FSigningCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubject Property (SAMLReader Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SigningCertSubjectRDN.

This property is read-only and not available at design time.

Data Type

String

SigningCertSubjectKeyID Property (SAMLReader Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray SigningCertSubjectKeyID = { read=FSigningCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SigningCertSubjectKeyID and SigningCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSubjectRDN Property (SAMLReader Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String SigningCertSubjectRDN = { read=FSigningCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is read-only and not available at design time.

Data Type

String

SigningCertValidFrom Property (SAMLReader Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String SigningCertValidFrom = { read=FSigningCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only and not available at design time.

Data Type

String

SigningCertValidTo Property (SAMLReader Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String SigningCertValidTo = { read=FSigningCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only and not available at design time.

Data Type

String

SocketDNSMode Property (SAMLReader Component)

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Syntax

__property TsbxSAMLReaderSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxSAMLReaderSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (SAMLReader Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SAMLReader Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (SAMLReader Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SAMLReader Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SAMLReader Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SAMLReader Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SAMLReader Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SAMLReader Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SAMLReader Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SAMLReader Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

StatementCount Property (SAMLReader Component)

The number of records in the Statement arrays.

Syntax

__property int StatementCount = { read=FStatementCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• StatementAuthnContextAuthenticatingAuthorities
• StatementAuthnContextChoice
• StatementAuthnContextClassRef
• StatementAuthnContextDecl
• StatementAuthnContextDeclRef
• StatementAuthnInstant
• StatementAuthnSessionIndex
• StatementAuthnSessionNotOnOrAfter
• StatementAuthnSubjectLocalityAddress
• StatementAuthnSubjectLocalityDNSName
• StatementAuthzActions
• StatementAuthzDecision
• StatementAuthzDecisionEvidence
• StatementAuthzDecisionResource
• StatementStatementType

The array indices start at 0 and end at StatementCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

StatementAuthnContextAuthenticatingAuthorities Property (SAMLReader Component)

Contains the list of authenticating authorities.

Syntax

__property String StatementAuthnContextAuthenticatingAuthorities[int StatementIndex] = { read=FStatementAuthnContextAuthenticatingAuthorities };

Default Value

""

Remarks

Contains the list of authenticating authorities.

Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnContextChoice Property (SAMLReader Component)

Specifies the authentication context choice variant.

Syntax

__property String StatementAuthnContextChoice[int StatementIndex] = { read=FStatementAuthnContextChoice };

Default Value

""

Remarks

Specifies the authentication context choice variant.

Use this property to set the authentication context choice variant. The currently supported values are v1 and v2. If this setting is left empty, the v1 variant is assumed.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnContextClassRef Property (SAMLReader Component)

Indicates the authentication contexts class reference.

Syntax

__property String StatementAuthnContextClassRef[int StatementIndex] = { read=FStatementAuthnContextClassRef };

Default Value

""

Remarks

Indicates the authentication contexts class reference.

Use this property to get or set the authentication contexts class reference attribute.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnContextDecl Property (SAMLReader Component)

Specifies the authentication contexts declaration.

Syntax

__property String StatementAuthnContextDecl[int StatementIndex] = { read=FStatementAuthnContextDecl };

Default Value

""

Remarks

Specifies the authentication contexts declaration.

Use this property to access or set the declaration element of the authentication context.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnContextDeclRef Property (SAMLReader Component)

Specifies the authentication contexts declaration reference.

Syntax

__property String StatementAuthnContextDeclRef[int StatementIndex] = { read=FStatementAuthnContextDeclRef };

Default Value

""

Remarks

Specifies the authentication contexts declaration reference.

Use this property to get or set the declaration reference of the authentication context.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnInstant Property (SAMLReader Component)

Specifies the authentication event timestamp.

Syntax

__property String StatementAuthnInstant[int StatementIndex] = { read=FStatementAuthnInstant };

Default Value

""

Remarks

Specifies the authentication event timestamp.

Use this property to read or set the moment in time the authentication event took place.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnSessionIndex Property (SAMLReader Component)

Contains the authentication session index.

Syntax

__property String StatementAuthnSessionIndex[int StatementIndex] = { read=FStatementAuthnSessionIndex };

Default Value

""

Remarks

Contains the authentication session index.

Use this property to access or set the authentication session index.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnSessionNotOnOrAfter Property (SAMLReader Component)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

__property String StatementAuthnSessionNotOnOrAfter[int StatementIndex] = { read=FStatementAuthnSessionNotOnOrAfter };

Default Value

""

Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnSubjectLocalityAddress Property (SAMLReader Component)

Specifies the authentication subjects address.

Syntax

__property String StatementAuthnSubjectLocalityAddress[int StatementIndex] = { read=FStatementAuthnSubjectLocalityAddress };

Default Value

""

Remarks

Specifies the authentication subjects address.

Use this property to specify the address parameter of the authentication subjects locality.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthnSubjectLocalityDNSName Property (SAMLReader Component)

Maps to the authentication subjects DNS name parameter.

Syntax

__property String StatementAuthnSubjectLocalityDNSName[int StatementIndex] = { read=FStatementAuthnSubjectLocalityDNSName };

Default Value

""

Remarks

Maps to the authentication subjects DNS name parameter.

Use this property to access or set the authentication subjects DNS name locality parameter.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthzActions Property (SAMLReader Component)

Provides access to the list of actions of the authorization statement.

Syntax

__property String StatementAuthzActions[int StatementIndex] = { read=FStatementAuthzActions };

Default Value

""

Remarks

Provides access to the list of actions of the authorization statement.

Use this property to read or set the actions of the authorization statement. Actions are represented as a list of Namespace=namespace;Value=Value strings, separated with CRLFs.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthzDecision Property (SAMLReader Component)

Specifies the authorization decision.

Syntax

__property TsbxSAMLReaderStatementAuthzDecisions StatementAuthzDecision[int StatementIndex] = { read=FStatementAuthzDecision };

enum TsbxSAMLReaderStatementAuthzDecisions {
  csadnPermit=0,
  csadnDeny=1,
  csadnIndeterminate=2
};

Default Value

csadnPermit

Remarks

Specifies the authorization decision.

Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

Integer

StatementAuthzDecisionEvidence Property (SAMLReader Component)

Manages the authorization decision statement evidence parameter.

Syntax

__property String StatementAuthzDecisionEvidence[int StatementIndex] = { read=FStatementAuthzDecisionEvidence };

Default Value

""

Remarks

Manages the authorization decision statement evidence parameter.

Use this property to read or set the authorization decision statement evidence parameter.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementAuthzDecisionResource Property (SAMLReader Component)

Specifies the authorization decision statement resource parameter.

Syntax

__property String StatementAuthzDecisionResource[int StatementIndex] = { read=FStatementAuthzDecisionResource };

Default Value

""

Remarks

Specifies the authorization decision statement resource parameter.

Use this property to access or set the resource parameter of the authorization statement.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

String

StatementStatementType Property (SAMLReader Component)

Specifies the assertion statement type.

Syntax

__property TsbxSAMLReaderStatementStatementTypes StatementStatementType[int StatementIndex] = { read=FStatementStatementType };

enum TsbxSAMLReaderStatementStatementTypes {
  csastAuthn=0,
  csastAttribute=1,
  csastAuthzDecision=2
};

Default Value

csastAuthn

Remarks

Specifies the assertion statement type.

This property specifies the assertion statement type. A statement can carry an authentication assertion, an attribute assertion, or an authorization decision assertion.

The StatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the StatementCount property.

This property is read-only and not available at design time.

Data Type

Integer

SubjectConfirmationCount Property (SAMLReader Component)

The number of records in the SubjectConfirmation arrays.

Syntax

__property int SubjectConfirmationCount = { read=FSubjectConfirmationCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SubjectConfirmationAddress
• SubjectConfirmationData
• SubjectConfirmationDataType
• SubjectConfirmationID
• SubjectConfirmationInResponseTo
• SubjectConfirmationMethod
• SubjectConfirmationNotBefore
• SubjectConfirmationNotOnOrAfter
• SubjectConfirmationRecipient

The array indices start at 0 and end at SubjectConfirmationCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SubjectConfirmationAddress Property (SAMLReader Component)

Contains the address enabled for presenting assertions.

Syntax

__property String SubjectConfirmationAddress[int SubjectConfirmationIndex] = { read=FSubjectConfirmationAddress };

Default Value

""

Remarks

Contains the address enabled for presenting assertions.

Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationData Property (SAMLReader Component)

The uninterpreted value of data entry in the subject confirmation.

Syntax

__property String SubjectConfirmationData[int SubjectConfirmationIndex] = { read=FSubjectConfirmationData };

Default Value

""

Remarks

The uninterpreted value of data entry in the subject confirmation.

Use this property to read or specify the uninterpreted value of the Data entry in the subject confirmation blob.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationDataType Property (SAMLReader Component)

The type of data contained in the confirmation.

Syntax

__property String SubjectConfirmationDataType[int SubjectConfirmationIndex] = { read=FSubjectConfirmationDataType };

Default Value

""

Remarks

The type of data contained in the confirmation.

Use this property to read or specify the type of confirmation data included in the object.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationID Property (SAMLReader Component)

The identifier of the entity which can satisfy the subject confirmation requirements.

Syntax

__property String SubjectConfirmationID[int SubjectConfirmationIndex] = { read=FSubjectConfirmationID };

Default Value

""

Remarks

The identifier of the entity which can satisfy the subject confirmation requirements.

This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationInResponseTo Property (SAMLReader Component)

The ID of the SAML message in response to which the assertion is issued.

Syntax

__property String SubjectConfirmationInResponseTo[int SubjectConfirmationIndex] = { read=FSubjectConfirmationInResponseTo };

Default Value

""

Remarks

The ID of the SAML message in response to which the assertion is issued.

This property specifies the ID of the SAML message in response to which the assertion is issued.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationMethod Property (SAMLReader Component)

Specifies the mechanism to be used to confirm the subject.

Syntax

__property String SubjectConfirmationMethod[int SubjectConfirmationIndex] = { read=FSubjectConfirmationMethod };

Default Value

""

Remarks

Specifies the mechanism to be used to confirm the subject.

This property contains a URI reference that identifies the mechanism to be used to confirm the subject.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationNotBefore Property (SAMLReader Component)

Time moment before which the subject cannot be confirmed.

Syntax

__property String SubjectConfirmationNotBefore[int SubjectConfirmationIndex] = { read=FSubjectConfirmationNotBefore };

Default Value

""

Remarks

Time moment before which the subject cannot be confirmed.

This property specifies the time before which the subject cannot be confirmed.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationNotOnOrAfter Property (SAMLReader Component)

Limits the time until which the subject can be confirmed.

Syntax

__property String SubjectConfirmationNotOnOrAfter[int SubjectConfirmationIndex] = { read=FSubjectConfirmationNotOnOrAfter };

Default Value

""

Remarks

Limits the time until which the subject can be confirmed.

This property specifies the time on (or after) which the subject cannot be confirmed.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

SubjectConfirmationRecipient Property (SAMLReader Component)

The URI of the entity or the location of the resource to which the assertion should be presented.

Syntax

__property String SubjectConfirmationRecipient[int SubjectConfirmationIndex] = { read=FSubjectConfirmationRecipient };

Default Value

""

Remarks

The URI of the entity or the location of the resource to which the assertion should be presented.

This property specifies The URI of the entity or the location of the resource to which the assertion should be presented.

The SubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubjectConfirmationCount property.

This property is read-only and not available at design time.

Data Type

String

TLSAutoValidateCertificates Property (SAMLReader Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SAMLReader Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxSAMLReaderTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxSAMLReaderTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (SAMLReader Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (SAMLReader Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxSAMLReaderTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxSAMLReaderTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (SAMLReader Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SAMLReader Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SAMLReader Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SAMLReader Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SAMLReader Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SAMLReader Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SAMLReader Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxSAMLReaderTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxSAMLReaderTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SAMLReader Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxSAMLReaderTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxSAMLReaderTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SAMLReader Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SAMLReader Component)

Specifies the TLS mode to use.

Syntax

__property TsbxSAMLReaderTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxSAMLReaderTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SAMLReader Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SAMLReader Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SAMLReader Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

UseBinding Property (SAMLReader Component)

Enables or disables automated binding processing.

Syntax

__property bool UseBinding = { read=FUseBinding, write=FSetUseBinding };

Default Value

false

Remarks

This property controls whether component should process any known bindings it encounters in the message automatically. If using this property, check Binding property to establish the type of the binding processed, and Binding to access the properties of specific binding types.

This property is not available at design time.

Data Type

Boolean

ValidateSignatures Property (SAMLReader Component)

Enables or disables automated signature validation.

Syntax

__property bool ValidateSignatures = { read=FValidateSignatures, write=FSetValidateSignatures };

Default Value

true

Remarks

Use this property to enable or disable automated signature validation by the component.

This property is not available at design time.

Data Type

Boolean

CompareIDs Method (SAMLReader Component)

Compares two SAML IDs.

Syntax

bool __fastcall CompareIDs(String ID1, String ID2);

Remarks

Use this utility function to easily compare two SAML IDs.

Config Method (SAMLReader Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SAMLReader Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetIDProp Method (SAMLReader Component)

Extracts a specific property from a SAML ID.

Syntax

String __fastcall GetIDProp(String ID, String PropName);

Remarks

Use this method to recover a single ID property from a SAML ID.

PropName supports the following properties:

• Format
• NameQualifier
• IDType
• SPNameQualifier
• SPProvidedID
• Value

Open Method (SAMLReader Component)

Opens a SAML entity.

Syntax

void __fastcall Open(String Input);

Remarks

Use this method to process a SAML entity contained in a string.

OpenBytes Method (SAMLReader Component)

Opens a SAML entity.

Syntax

void __fastcall OpenBytes(DynamicArray<Byte> InputBytes);

Remarks

Use this method to process a SAML entity stored as a byte array.

OpenFile Method (SAMLReader Component)

Opens a SAML entity.

Syntax

void __fastcall OpenFile(String InputFile);

Remarks

Use this method to process a SAML entity contained in a file.

PinAssertion Method (SAMLReader Component)

Pins assertion by propagating it in PinnedAssertionXXX properties.

Syntax

void __fastcall PinAssertion(int AssertionIndex);

Remarks

Use this method to pin a SAML assertion specified by its AssertionIndex in the selection of PinnedAssertionXXX properties, such as PinnedAssertion.

Check AssertionCount to obtain the number of assertions in the message.

Reset Method (SAMLReader Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Encrypted Event (SAMLReader Component)

Notifies the application that the assertion is encrypted and provides recipient certificate details.

Syntax

typedef struct {
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  bool NeedCredential;
  bool SkipThis;
} TsbxSAMLReaderEncryptedEventParams;
typedef void __fastcall (__closure *TsbxSAMLReaderEncryptedEvent)(System::TObject* Sender, TsbxSAMLReaderEncryptedEventParams *e);
__property TsbxSAMLReaderEncryptedEvent OnEncrypted = { read=FOnEncrypted, write=FOnEncrypted };

Remarks

The component fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.

The NeedCredential parameter specifies whether the correct credential is already available to the component or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (SAMLReader Component)

Fires to report an error condition.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxSAMLReaderErrorEventParams;
typedef void __fastcall (__closure *TsbxSAMLReaderErrorEvent)(System::TObject* Sender, TsbxSAMLReaderErrorEventParams *e);
__property TsbxSAMLReaderErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

Subscribe to this event to be notified about any error conditions occurring during the component's work. ErrorCode and Description provide the details of the error.

Notification Event (SAMLReader Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSAMLReaderNotificationEventParams;
typedef void __fastcall (__closure *TsbxSAMLReaderNotificationEvent)(System::TObject* Sender, TsbxSAMLReaderNotificationEventParams *e);
__property TsbxSAMLReaderNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

SignatureFound Event (SAMLReader Component)

Signifies the start of signature validation.

Syntax

typedef struct {
  int Scope;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  bool CertFound;
  bool Validate;
} TsbxSAMLReaderSignatureFoundEventParams;
typedef void __fastcall (__closure *TsbxSAMLReaderSignatureFoundEvent)(System::TObject* Sender, TsbxSAMLReaderSignatureFoundEventParams *e);
__property TsbxSAMLReaderSignatureFoundEvent OnSignatureFound = { read=FOnSignatureFound, write=FOnSignatureFound };

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.

The CertFound is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature.

SignatureValidated Event (SAMLReader Component)

Reports the signature validation result.

Syntax

typedef struct {
  int Scope;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  int ValidationResult;
} TsbxSAMLReaderSignatureValidatedEventParams;
typedef void __fastcall (__closure *TsbxSAMLReaderSignatureValidatedEvent)(System::TObject* Sender, TsbxSAMLReaderSignatureValidatedEventParams *e);
__property TsbxSAMLReaderSignatureValidatedEvent OnSignatureValidated = { read=FOnSignatureValidated, write=FOnSignatureValidated };

Remarks

This event is fired when the complete XML signature validation process is finished.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:

Config Settings (SAMLReader Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

SAMLReader Config Settings

Base Config Settings

Trappable Errors (SAMLReader Component)