SAMLWriter Component

Properties   Methods   Events   Config Settings   Errors  

The SAMLWriter component offers SAML message generation functions.

Syntax

TsbxSAMLWriter

Remarks

SAMLWriter provides means of serialization of SAML entities into valid SAML protocol messages. Together with SAMLReader, this class provides fine-grained access to the composition of SAML requests, responses, assertions, and statements. You can use it as part of your SAML client or SAML server implementation for creating individual SAML entities.

SAMLReader and SAMLWriter are independent of SAML server controls that are also included in SecureBlackbox, and are aimed at scenarios that require lower-level access to SAML functionality than that provided by the server controls.

SAMLWriter can create the following kinds of SAML messages:

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

Please find below a quick-and-dirty example of the use of SAMLWriter class for creating a signed AuthnRequest message: Samlwriter writer = new Samlwriter(); // configuring general message properties writer.Destination = "http://destination-url.com"; writer.IssueInstant = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); writer.Issuer = "Value=https://issuer-url.com;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer"; // configuring general AuthnRequest properties writer.AuthnRequest.IsPassive = false; writer.AuthnRequest.UseIsPassive = true; writer.AuthnRequest.ForceAuthn = true; writer.AuthnRequest.ProtocolBinding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"; writer.AuthnRequest.AssertionConsumerServiceURL = "https://assertion-consumer-url.com"; writer.AuthnRequest.AttributeConsumingServiceIndex = 1; writer.AuthnRequest.NameIDPolicyAllowCreate = false; writer.AuthnRequest.NameIDPolicyFormat = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"; writer.AuthnRequest.ConditionsNotBefore = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); writer.AuthnRequest.ConditionsNotOnOrAfter = DateTime.UtcNow.AddMinutes(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ"); // adjusting request conditions if required SAMLAssertionCondition cond = new SAMLAssertionCondition(); cond.ConditionType = SAMLConditionTypes.csctOneTimeUse; writer.AuthnRequestConditions.Add(cond); // configuring signing properties Certificate certificate = new Certificate("C:\\Certs\\samlCert.pfx", "password"); writer.Sign = true; writer.SigningCertificate = certificate; // creating the SAML entity of the required type writer.CreateNew((int)SamlwriterOutputTypes.cstyAuthnRequest); // adjusting low-level signature parameters writer.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); writer.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); // signing the request and serializing it to XML string request = writer.Save(); The above code produces the following AuthnRequest: <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>

Note that you need to set the signing certificate before calling CreateNew.

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 (SAMLWriter Component)

An accessor to the EndpointIndex entry of the artifact.

Syntax

__property int ArtifactEndpointIndex = { read=FArtifactEndpointIndex, write=FSetArtifactEndpointIndex };

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 not available at design time.

Data Type

Integer

ArtifactMessageHandle Property (SAMLWriter Component)

An accessor to the MessageHandle property of the artifact.

Syntax

__property DynamicArray ArtifactMessageHandle = { read=FArtifactMessageHandle, write=FSetArtifactMessageHandle };

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 not available at design time.

Data Type

Byte Array

ArtifactRemainingArtifact Property (SAMLWriter 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 (SAMLWriter Component)

An accessor to the SourceID property of the artifact.

Syntax

__property DynamicArray ArtifactSourceID = { read=FArtifactSourceID, write=FSetArtifactSourceID };

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is not available at design time.

Data Type

Byte Array

ArtifactTypeCode Property (SAMLWriter Component)

The TypeCode property of the artifact.

Syntax

__property int ArtifactTypeCode = { read=FArtifactTypeCode, write=FSetArtifactTypeCode };

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 not available at design time.

Data Type

Integer

ArtifactURI Property (SAMLWriter Component)

An accessor to the URI property of the artifact.

Syntax

__property String ArtifactURI = { read=FArtifactURI, write=FSetArtifactURI };

Default Value

""

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is not available at design time.

Data Type

String

ArtifactResolveQuery Property (SAMLWriter Component)

Contains the artifact resolve query.

Syntax

__property String ArtifactResolveQuery = { read=FArtifactResolveQuery, write=FSetArtifactResolveQuery };

Default Value

""

Remarks

Use this property to read or set the artifact resolve query.

This property is not available at design time.

Data Type

String

AssertionAssertionType Property (SAMLWriter Component)

Specifies the type of the assertion.

Syntax

__property TsbxSAMLWriterAssertionAssertionTypes AssertionAssertionType = { read=FAssertionAssertionType, write=FSetAssertionAssertionType };

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

Default Value

csatAssertionIDRef

Remarks

Specifies the type of the assertion.

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

This property is not available at design time.

Data Type

Integer

AssertionEncryptedContent Property (SAMLWriter Component)

Represents the encrypted assertion content.

Syntax

__property String AssertionEncryptedContent = { read=FAssertionEncryptedContent, write=FSetAssertionEncryptedContent };

Default Value

""

Remarks

Represents the encrypted assertion content.

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

This property is not available at design time.

Data Type

String

AssertionID Property (SAMLWriter Component)

Represents the ID of the assertion.

Syntax

__property String AssertionID = { read=FAssertionID, write=FSetAssertionID };

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 not available at design time.

Data Type

String

AssertionIDRef Property (SAMLWriter Component)

Represents an ID reference value.

Syntax

__property String AssertionIDRef = { read=FAssertionIDRef, write=FSetAssertionIDRef };

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 not available at design time.

Data Type

String

AssertionIssueInstant Property (SAMLWriter Component)

Contains the assertion issuance time stamp.

Syntax

__property String AssertionIssueInstant = { read=FAssertionIssueInstant, write=FSetAssertionIssueInstant };

Default Value

""

Remarks

Contains the assertion issuance time stamp.

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

This property is not available at design time.

Data Type

String

AssertionIssuer Property (SAMLWriter Component)

Specifies the assertion issuer.

Syntax

__property String AssertionIssuer = { read=FAssertionIssuer, write=FSetAssertionIssuer };

Default Value

""

Remarks

Specifies the assertion issuer.

Use this property to provide the assertion issuer ID.

This property is not available at design time.

Data Type

String

AssertionParentAssertion Property (SAMLWriter Component)

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

Syntax

__property int AssertionParentAssertion = { read=FAssertionParentAssertion, write=FSetAssertionParentAssertion };

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 not available at design time.

Data Type

Integer

AssertionSignatureValidationResult Property (SAMLWriter Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLWriterAssertionSignatureValidationResults AssertionSignatureValidationResult = { read=FAssertionSignatureValidationResult };

enum TsbxSAMLWriterAssertionSignatureValidationResults {
  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

AssertionSigned Property (SAMLWriter Component)

Specifies whether the assertion is signed.

Syntax

__property bool AssertionSigned = { read=FAssertionSigned, write=FSetAssertionSigned };

Default Value

false

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is not available at design time.

Data Type

Boolean

AssertionSubject Property (SAMLWriter Component)

Specifies the assertion subject.

Syntax

__property String AssertionSubject = { read=FAssertionSubject, write=FSetAssertionSubject };

Default Value

""

Remarks

Specifies the assertion subject.

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

This property is not available at design time.

Data Type

String

AssertionURIRef Property (SAMLWriter Component)

Represents an URI reference value.

Syntax

__property String AssertionURIRef = { read=FAssertionURIRef, write=FSetAssertionURIRef };

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 not available at design time.

Data Type

String

AssertionVersion Property (SAMLWriter Component)

Specifies the SAML protocol version used.

Syntax

__property String AssertionVersion = { read=FAssertionVersion, write=FSetAssertionVersion };

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 not available at design time.

Data Type

String

AssertionCount Property (SAMLWriter Component)

Returns the number of assertions in the message.

Syntax

__property int AssertionCount = { read=FAssertionCount };

Default Value

0

Remarks

This property returns the total number of assertions currently defined in the SAML message.

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

Data Type

Integer

AttributeCount Property (SAMLWriter Component)

The number of records in the Attribute arrays.

Syntax

__property int AttributeCount = { read=FAttributeCount, write=FSetAttributeCount };

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 not available at design time.

Data Type

Integer

AttributeFriendlyName Property (SAMLWriter 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, write=FSetAttributeFriendlyName };

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 not available at design time.

Data Type

String

AttributeName Property (SAMLWriter Component)

Specifies the name of the attribute.

Syntax

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

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 not available at design time.

Data Type

String

AttributeNameFormat Property (SAMLWriter Component)

Indicates the format used to reference the attribute.

Syntax

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

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 not available at design time.

Data Type

String

AttributeStatementIndex Property (SAMLWriter Component)

Contains the index of the statement the attribute corresponds to.

Syntax

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

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 not available at design time.

Data Type

Integer

AttributeValues Property (SAMLWriter Component)

Contains a list of attribute values.

Syntax

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

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 not available at design time.

Data Type

String

AuthnQueryComparison Property (SAMLWriter Component)

Specifies the authentication context comparison method.

Syntax

__property TsbxSAMLWriterAuthnQueryComparisons AuthnQueryComparison = { read=FAuthnQueryComparison, write=FSetAuthnQueryComparison };

enum TsbxSAMLWriterAuthnQueryComparisons {
  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 not available at design time.

Data Type

Integer

AuthnQueryContextClassRefs Property (SAMLWriter Component)

Specifies the context class reference.

Syntax

__property String AuthnQueryContextClassRefs = { read=FAuthnQueryContextClassRefs, write=FSetAuthnQueryContextClassRefs };

Default Value

""

Remarks

Specifies the context class reference.

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

This property is not available at design time.

Data Type

String

AuthnQueryRefType Property (SAMLWriter Component)

Specifies the context reference type.

Syntax

__property TsbxSAMLWriterAuthnQueryRefTypes AuthnQueryRefType = { read=FAuthnQueryRefType, write=FSetAuthnQueryRefType };

enum TsbxSAMLWriterAuthnQueryRefTypes {
  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 not available at design time.

Data Type

Integer

AuthnQuerySessionIndex Property (SAMLWriter Component)

Specifies the index of the session to the authentication entity.

Syntax

__property String AuthnQuerySessionIndex = { read=FAuthnQuerySessionIndex, write=FSetAuthnQuerySessionIndex };

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 not available at design time.

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SAMLWriter Component)

Specifies the assertion consumer service index.

Syntax

__property int AuthnRequestAssertionConsumerServiceIndex = { read=FAuthnRequestAssertionConsumerServiceIndex, write=FSetAuthnRequestAssertionConsumerServiceIndex };

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 not available at design time.

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SAMLWriter Component)

Specifies the assertion consumer service URL.

Syntax

__property String AuthnRequestAssertionConsumerServiceURL = { read=FAuthnRequestAssertionConsumerServiceURL, write=FSetAuthnRequestAssertionConsumerServiceURL };

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 not available at design time.

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SAMLWriter Component)

Specifies the attribute consuming service index.

Syntax

__property int AuthnRequestAttributeConsumingServiceIndex = { read=FAuthnRequestAttributeConsumingServiceIndex, write=FSetAuthnRequestAttributeConsumingServiceIndex };

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 not available at design time.

Data Type

Integer

AuthnRequestContextClassRefs Property (SAMLWriter Component)

Provides access to the authentication context class references.

Syntax

__property String AuthnRequestContextClassRefs = { read=FAuthnRequestContextClassRefs, write=FSetAuthnRequestContextClassRefs };

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 not available at design time.

Data Type

String

AuthnRequestContextComparison Property (SAMLWriter Component)

Specifies the AuthnContext comparison method.

Syntax

__property TsbxSAMLWriterAuthnRequestContextComparisons AuthnRequestContextComparison = { read=FAuthnRequestContextComparison, write=FSetAuthnRequestContextComparison };

enum TsbxSAMLWriterAuthnRequestContextComparisons {
  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 not available at design time.

Data Type

Integer

AuthnRequestContextRefType Property (SAMLWriter Component)

Specifies the context reference type.

Syntax

__property TsbxSAMLWriterAuthnRequestContextRefTypes AuthnRequestContextRefType = { read=FAuthnRequestContextRefType, write=FSetAuthnRequestContextRefType };

enum TsbxSAMLWriterAuthnRequestContextRefTypes {
  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 not available at design time.

Data Type

Integer

AuthnRequestFlags Property (SAMLWriter Component)

Adjusts secondary serialization properties.

Syntax

__property int AuthnRequestFlags = { read=FAuthnRequestFlags, write=FSetAuthnRequestFlags };

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:

• 1 - arfAllowCreate - enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record.
• 2 - arfForceAuthn - enforces inclusion of the ForceAuthn element.
• 4 - arfIsPassive - enforces saving of IsPassive element.

This property is not available at design time.

Data Type

Integer

AuthnRequestForceAuthn Property (SAMLWriter Component)

Corresponds to the ForceAuthn parameter of the request.

Syntax

__property bool AuthnRequestForceAuthn = { read=FAuthnRequestForceAuthn, write=FSetAuthnRequestForceAuthn };

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 not available at design time.

Data Type

Boolean

AuthnRequestIsPassive Property (SAMLWriter Component)

Maps to the IsPassive parameter of the request.

Syntax

__property bool AuthnRequestIsPassive = { read=FAuthnRequestIsPassive, write=FSetAuthnRequestIsPassive };

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 not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SAMLWriter Component)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

__property bool AuthnRequestNameIDPolicyAllowCreate = { read=FAuthnRequestNameIDPolicyAllowCreate, write=FSetAuthnRequestNameIDPolicyAllowCreate };

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 not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SAMLWriter Component)

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

Syntax

__property String AuthnRequestNameIDPolicyFormat = { read=FAuthnRequestNameIDPolicyFormat, write=FSetAuthnRequestNameIDPolicyFormat };

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 not available at design time.

Data Type

String

AuthnRequestNameIDPolicySPNameQualifier Property (SAMLWriter Component)

Matches to the SP name qualifier attribute of the request.

Syntax

__property String AuthnRequestNameIDPolicySPNameQualifier = { read=FAuthnRequestNameIDPolicySPNameQualifier, write=FSetAuthnRequestNameIDPolicySPNameQualifier };

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 not available at design time.

Data Type

String

AuthnRequestProtocolBinding Property (SAMLWriter Component)

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

Syntax

__property String AuthnRequestProtocolBinding = { read=FAuthnRequestProtocolBinding, write=FSetAuthnRequestProtocolBinding };

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 not available at design time.

Data Type

String

AuthnRequestProviderName Property (SAMLWriter Component)

Specifies the name of the requestor.

Syntax

__property String AuthnRequestProviderName = { read=FAuthnRequestProviderName, write=FSetAuthnRequestProviderName };

Default Value

""

Remarks

Specifies the name of the requestor.

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

This property is not available at design time.

Data Type

String

AuthnRequestScopingGetComplete Property (SAMLWriter Component)

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

Syntax

__property String AuthnRequestScopingGetComplete = { read=FAuthnRequestScopingGetComplete, write=FSetAuthnRequestScopingGetComplete };

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 not available at design time.

Data Type

String

AuthnRequestScopingProxyCount Property (SAMLWriter Component)

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

Syntax

__property int AuthnRequestScopingProxyCount = { read=FAuthnRequestScopingProxyCount, write=FSetAuthnRequestScopingProxyCount };

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 not available at design time.

Data Type

Integer

AuthnRequestScopingRequesterIDs Property (SAMLWriter Component)

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

Syntax

__property String AuthnRequestScopingRequesterIDs = { read=FAuthnRequestScopingRequesterIDs, write=FSetAuthnRequestScopingRequesterIDs };

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 not available at design time.

Data Type

String

AuthzDecisionQueryActions Property (SAMLWriter Component)

Specifies the list of actions included in the query.

Syntax

__property String AuthzDecisionQueryActions = { read=FAuthzDecisionQueryActions, write=FSetAuthzDecisionQueryActions };

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 not available at design time.

Data Type

String

AuthzDecisionQueryResource Property (SAMLWriter Component)

Matches the Resource element of the query.

Syntax

__property String AuthzDecisionQueryResource = { read=FAuthzDecisionQueryResource, write=FSetAuthzDecisionQueryResource };

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 not available at design time.

Data Type

String

BindingBindingType Property (SAMLWriter Component)

Specifies the type of SAML binding to use.

Syntax

__property TsbxSAMLWriterBindingBindingTypes BindingBindingType = { read=FBindingBindingType, write=FSetBindingBindingType };

enum TsbxSAMLWriterBindingBindingTypes {
  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 not available at design time.

Data Type

Integer

BindingBody Property (SAMLWriter Component)

Contains the POST binding form body.

Syntax

__property String BindingBody = { read=FBindingBody, write=FSetBindingBody };

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 not available at design time.

Data Type

String

BindingEncoding Property (SAMLWriter Component)

Specifies the message encoding.

Syntax

__property String BindingEncoding = { read=FBindingEncoding, write=FSetBindingEncoding };

Default Value

""

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is not available at design time.

Data Type

String

BindingForceSign Property (SAMLWriter Component)

Enforces a signature over all outgoing messages.

Syntax

__property bool BindingForceSign = { read=FBindingForceSign, write=FSetBindingForceSign };

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 not available at design time.

Data Type

Boolean

BindingFormTemplate Property (SAMLWriter Component)

Contains the XHTML form template returned by the service provider.

Syntax

__property String BindingFormTemplate = { read=FBindingFormTemplate, write=FSetBindingFormTemplate };

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 not available at design time.

Data Type

String

BindingPOSTMode Property (SAMLWriter Component)

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

Syntax

__property TsbxSAMLWriterBindingPOSTModes BindingPOSTMode = { read=FBindingPOSTMode, write=FSetBindingPOSTMode };

enum TsbxSAMLWriterBindingPOSTModes {
  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 not available at design time.

Data Type

Integer

BindingRelayState Property (SAMLWriter Component)

Contains the RelayState parameter of the binding.

Syntax

__property String BindingRelayState = { read=FBindingRelayState, write=FSetBindingRelayState };

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 not available at design time.

Data Type

String

BindingSignatureAlgorithm Property (SAMLWriter Component)

Contains the signature algorithm.

Syntax

__property String BindingSignatureAlgorithm = { read=FBindingSignatureAlgorithm, write=FSetBindingSignatureAlgorithm };

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 not available at design time.

Data Type

String

BindingSignatureValidationResult Property (SAMLWriter Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLWriterBindingSignatureValidationResults BindingSignatureValidationResult = { read=FBindingSignatureValidationResult };

enum TsbxSAMLWriterBindingSignatureValidationResults {
  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 (SAMLWriter Component)

Specifies whether to sign the binding.

Syntax

__property bool BindingSigned = { read=FBindingSigned, write=FSetBindingSigned };

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 not available at design time.

Data Type

Boolean

BindingURL Property (SAMLWriter Component)

Contains the URL of the request query.

Syntax

__property String BindingURL = { read=FBindingURL, write=FSetBindingURL };

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 not available at design time.

Data Type

String

BindingVerifySignatures Property (SAMLWriter Component)

Instructs the component whether to verify incoming signatures.

Syntax

__property bool BindingVerifySignatures = { read=FBindingVerifySignatures, write=FSetBindingVerifySignatures };

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 not available at design time.

Data Type

Boolean

BindingKeyHandle Property (SAMLWriter 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 (SAMLWriter 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

ConditionCount Property (SAMLWriter Component)

The number of records in the Condition arrays.

Syntax

__property int ConditionCount = { read=FConditionCount, write=FSetConditionCount };

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 not available at design time.

Data Type

Integer

ConditionCondition Property (SAMLWriter Component)

The condition set in accordance with the ConditionType .

Syntax

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

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 not available at design time.

Data Type

String

ConditionConditionType Property (SAMLWriter Component)

Specifies a type of the condition object.

Syntax

__property TsbxSAMLWriterConditionConditionTypes ConditionConditionType[int ConditionIndex] = { read=FConditionConditionType, write=FSetConditionConditionType };

enum TsbxSAMLWriterConditionConditionTypes {
  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 a type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction. TBD: add examples for different condition types.

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 not available at design time.

Data Type

Integer

EncryptionCertBytes Property (SAMLWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray EncryptionCertBytes = { read=FEncryptionCertBytes };

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertHandle Property (SAMLWriter Component)

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

Syntax

__property __int64 EncryptionCertHandle = { read=FEncryptionCertHandle, write=FSetEncryptionCertHandle };

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 (SAMLWriter 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 (SAMLWriter Component)

Contains the value of the NameID parameter.

Syntax

__property String LogoutRequestNameID = { read=FLogoutRequestNameID, write=FSetLogoutRequestNameID };

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 not available at design time.

Data Type

String

LogoutRequestNotOnOrAfter Property (SAMLWriter Component)

Contains the value of the NotOnOrAfter parameter.

Syntax

__property String LogoutRequestNotOnOrAfter = { read=FLogoutRequestNotOnOrAfter, write=FSetLogoutRequestNotOnOrAfter };

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 not available at design time.

Data Type

String

LogoutRequestReason Property (SAMLWriter Component)

Contains the value of the Reason parameter.

Syntax

__property String LogoutRequestReason = { read=FLogoutRequestReason, write=FSetLogoutRequestReason };

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 not available at design time.

Data Type

String

LogoutRequestSessionIndexes Property (SAMLWriter Component)

Contains the list of session indices.

Syntax

__property String LogoutRequestSessionIndexes = { read=FLogoutRequestSessionIndexes, write=FSetLogoutRequestSessionIndexes };

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 not available at design time.

Data Type

String

ManageNameIDRequestNameID Property (SAMLWriter Component)

Contains the value of the NameID parameter of the request.

Syntax

__property String ManageNameIDRequestNameID = { read=FManageNameIDRequestNameID, write=FSetManageNameIDRequestNameID };

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 not available at design time.

Data Type

String

ManageNameIDRequestNewEncryptedID Property (SAMLWriter Component)

Contains the value of the NewEncryptedID parameter of the request.

Syntax

__property String ManageNameIDRequestNewEncryptedID = { read=FManageNameIDRequestNewEncryptedID, write=FSetManageNameIDRequestNewEncryptedID };

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 not available at design time.

Data Type

String

ManageNameIDRequestNewID Property (SAMLWriter Component)

Contains the value of the NewID parameter.

Syntax

__property String ManageNameIDRequestNewID = { read=FManageNameIDRequestNewID, write=FSetManageNameIDRequestNewID };

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 not available at design time.

Data Type

String

ManageNameIDRequestTerminate Property (SAMLWriter Component)

Contains the value of the Terminate parameter of the request.

Syntax

__property String ManageNameIDRequestTerminate = { read=FManageNameIDRequestTerminate, write=FSetManageNameIDRequestTerminate };

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 not available at design time.

Data Type

String

MessageConsent Property (SAMLWriter Component)

Contains the Consent parameter of the SAML message.

Syntax

__property String MessageConsent = { read=FMessageConsent, write=FSetMessageConsent };

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 not available at design time.

Data Type

String

MessageContentType Property (SAMLWriter Component)

Returns the SAML type of the current message.

Syntax

__property TsbxSAMLWriterMessageContentTypes MessageContentType = { read=FMessageContentType };

enum TsbxSAMLWriterMessageContentTypes {
  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 (SAMLWriter 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 (SAMLWriter Component)

Contains the Destination parameter of the SAML message.

Syntax

__property String MessageDestination = { read=FMessageDestination, write=FSetMessageDestination };

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 not available at design time.

Data Type

String

MessageID Property (SAMLWriter Component)

The ID of the request.

Syntax

__property String MessageID = { read=FMessageID, write=FSetMessageID };

Default Value

""

Remarks

The ID of the request.

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

This property is not available at design time.

Data Type

String

MessageInResponseTo Property (SAMLWriter Component)

Contains the InResponseTo property of the SAML request.

Syntax

__property String MessageInResponseTo = { read=FMessageInResponseTo, write=FSetMessageInResponseTo };

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 not available at design time.

Data Type

String

MessageIssueInstant Property (SAMLWriter Component)

Contains request issuance timestamp.

Syntax

__property String MessageIssueInstant = { read=FMessageIssueInstant, write=FSetMessageIssueInstant };

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 not available at design time.

Data Type

String

MessageIssuer Property (SAMLWriter Component)

Sets the issuer of the message.

Syntax

__property String MessageIssuer = { read=FMessageIssuer, write=FSetMessageIssuer };

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 not available at design time.

Data Type

String

MessageSignatureValidationResult Property (SAMLWriter Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLWriterMessageSignatureValidationResults MessageSignatureValidationResult = { read=FMessageSignatureValidationResult };

enum TsbxSAMLWriterMessageSignatureValidationResults {
  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 (SAMLWriter Component)

Specifies whether the SAML message is or should be signed.

Syntax

__property bool MessageSigned = { read=FMessageSigned, write=FSetMessageSigned };

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 not available at design time.

Data Type

Boolean

MessageSubject Property (SAMLWriter Component)

Gets or sets the subject of the message.

Syntax

__property String MessageSubject = { read=FMessageSubject, write=FSetMessageSubject };

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 not available at design time.

Data Type

String

MessageVersion Property (SAMLWriter Component)

Specifies the protocol version to use for the SAML message.

Syntax

__property String MessageVersion = { read=FMessageVersion, write=FSetMessageVersion };

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 not available at design time.

Data Type

String

MessageXMLHeader Property (SAMLWriter Component)

Controls the inclusion of an XML header in the message.

Syntax

__property bool MessageXMLHeader = { read=FMessageXMLHeader, write=FSetMessageXMLHeader };

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 not available at design time.

Data Type

Boolean

NameIDMappingRequestNameID Property (SAMLWriter Component)

An accessor to the NameID parameter of the request.

Syntax

__property String NameIDMappingRequestNameID = { read=FNameIDMappingRequestNameID, write=FSetNameIDMappingRequestNameID };

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 not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyAllowCreate Property (SAMLWriter Component)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

__property bool NameIDMappingRequestNameIDPolicyAllowCreate = { read=FNameIDMappingRequestNameIDPolicyAllowCreate, write=FSetNameIDMappingRequestNameIDPolicyAllowCreate };

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 not available at design time.

Data Type

Boolean

NameIDMappingRequestNameIDPolicyFormat Property (SAMLWriter Component)

Specifies the format of the NameIDPolicy element.

Syntax

__property String NameIDMappingRequestNameIDPolicyFormat = { read=FNameIDMappingRequestNameIDPolicyFormat, write=FSetNameIDMappingRequestNameIDPolicyFormat };

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 not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicySPNameQualifier Property (SAMLWriter Component)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

__property String NameIDMappingRequestNameIDPolicySPNameQualifier = { read=FNameIDMappingRequestNameIDPolicySPNameQualifier, write=FSetNameIDMappingRequestNameIDPolicySPNameQualifier };

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 not available at design time.

Data Type

String

NameIDMappingRequestNameIDPolicyUseAllowCreate Property (SAMLWriter Component)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

__property bool NameIDMappingRequestNameIDPolicyUseAllowCreate = { read=FNameIDMappingRequestNameIDPolicyUseAllowCreate, write=FSetNameIDMappingRequestNameIDPolicyUseAllowCreate };

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 not available at design time.

Data Type

Boolean

Profile Property (SAMLWriter 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

References Property (SAMLWriter Component)

Contains the References entry of the SAML AssertionIDRequest message.

Syntax

__property String References = { read=FReferences, write=FSetReferences };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ResponseNameID Property (SAMLWriter Component)

Contains the NameID parameter of a NameIDMapping response.

Syntax

__property String ResponseNameID = { read=FResponseNameID, write=FSetResponseNameID };

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 not available at design time.

Data Type

String

ResponseOptionalElement Property (SAMLWriter Component)

An optional message element to be returned with the response.

Syntax

__property String ResponseOptionalElement = { read=FResponseOptionalElement, write=FSetResponseOptionalElement };

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 not available at design time.

Data Type

String

ResponseResponseType Property (SAMLWriter Component)

Contains the type of the response.

Syntax

__property TsbxSAMLWriterResponseResponseTypes ResponseResponseType = { read=FResponseResponseType, write=FSetResponseResponseType };

enum TsbxSAMLWriterResponseResponseTypes {
  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 not available at design time.

Data Type

Integer

ResponseStatus Property (SAMLWriter Component)

Gets or sets the status of the response.

Syntax

__property int ResponseStatus = { read=FResponseStatus, write=FSetResponseStatus };

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 not available at design time.

Data Type

Integer

ResponseStatusCodeSubValue Property (SAMLWriter Component)

The value of the nested StatusCode.

Syntax

__property String ResponseStatusCodeSubValue = { read=FResponseStatusCodeSubValue, write=FSetResponseStatusCodeSubValue };

Default Value

""

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is not available at design time.

Data Type

String

ResponseStatusCodeValue Property (SAMLWriter Component)

Contains the status code value.

Syntax

__property String ResponseStatusCodeValue = { read=FResponseStatusCodeValue, write=FSetResponseStatusCodeValue };

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 not available at design time.

Data Type

String

ResponseStatusDetail Property (SAMLWriter Component)

Contains additional information on the status of the request.

Syntax

__property String ResponseStatusDetail = { read=FResponseStatusDetail, write=FSetResponseStatusDetail };

Default Value

""

Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

This property is not available at design time.

Data Type

String

ResponseStatusMessage Property (SAMLWriter Component)

Contains a status message (optional).

Syntax

__property String ResponseStatusMessage = { read=FResponseStatusMessage, write=FSetResponseStatusMessage };

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 not available at design time.

Data Type

String

ScopingIDPCount Property (SAMLWriter Component)

The number of records in the ScopingIDP arrays.

Syntax

__property int ScopingIDPCount = { read=FScopingIDPCount, write=FSetScopingIDPCount };

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 not available at design time.

Data Type

Integer

ScopingIDPLoc Property (SAMLWriter Component)

Contains the value of the Loc attribute.

Syntax

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

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 not available at design time.

Data Type

String

ScopingIDPName Property (SAMLWriter Component)

Contains the name of the IdP provider.

Syntax

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

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 not available at design time.

Data Type

String

ScopingIDPProviderID Property (SAMLWriter Component)

Contains the provider ID.

Syntax

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

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 not available at design time.

Data Type

String

SecurityCanonicalizationMethod Property (SAMLWriter Component)

The canonicalization method to use in the signature.

Syntax

__property String SecurityCanonicalizationMethod = { read=FSecurityCanonicalizationMethod, write=FSetSecurityCanonicalizationMethod };

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 not available at design time.

Data Type

String

SecurityDigestMethod Property (SAMLWriter Component)

The digest method to use.

Syntax

__property String SecurityDigestMethod = { read=FSecurityDigestMethod, write=FSetSecurityDigestMethod };

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 not available at design time.

Data Type

String

SecurityEncryptionMethod Property (SAMLWriter Component)

The encryption method used to encrypt the assertion.

Syntax

__property String SecurityEncryptionMethod = { read=FSecurityEncryptionMethod, write=FSetSecurityEncryptionMethod };

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 not available at design time.

Data Type

String

SecurityFlags Property (SAMLWriter Component)

Provides access to secondary security parameters and tweaks.

Syntax

__property int SecurityFlags = { read=FSecurityFlags, write=FSetSecurityFlags };

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):

• ssfSignatureAfterIssuer (0x00000001) - Signature after issuer
• ssfSignatureBeforeDescriptor (0x00000002) - Signature before descriptor
• ssfKeyDataIssuerSerial (0x00000004) - Include the IssuerSerial key data element
• ssfKeyDataSKI (0x00000008) - Include the SubjectKeyIdentifier key data element
• ssfKeyDataSubjectName (0x00000010) - Include the SubjectName key data element
• ssfKeyDataCertificate (0x00000020) - Include the Certificate key data element
• ssfKeyDataCRL (0x00000040) - Include the CRL key data element

The following flags can be used with SAMLSPServer only

• ssfSignAuthnRequests (0x00010000) - Sign authentication requests
• ssfSignArtifactResolveRequests (0x00020000) - Sign artifact resolve requests
• ssfSignLogoutRequests (0x00040000) - Sign logout requests

The following flags can be used with SAMLIdPServer only

• ssfSignAssertions (0x00080000) - Sign outgoing assertions
• ssfSignResponses (0x00100000) - Sign all responses
• ssfEncryptAssertions (0x00200000) - Encrypt generated assertions

TBD define enum

This property is not available at design time.

Data Type

Integer

SecuritySigMethod Property (SAMLWriter Component)

The signature method to use.

Syntax

__property String SecuritySigMethod = { read=FSecuritySigMethod, write=FSetSecuritySigMethod };

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 not available at design time.

Data Type

String

SecuritySignaturePolicy Property (SAMLWriter Component)

Specifies the signature validation policy.

Syntax

__property TsbxSAMLWriterSecuritySignaturePolicies SecuritySignaturePolicy = { read=FSecuritySignaturePolicy, write=FSetSecuritySignaturePolicy };

enum TsbxSAMLWriterSecuritySignaturePolicies {
  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 not available at design time.

Data Type

Integer

SigningCertBytes Property (SAMLWriter 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

SigningCertHandle Property (SAMLWriter Component)

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

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle, write=FSetSigningCertHandle };

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

SigningChainCount Property (SAMLWriter Component)

The number of records in the SigningChain arrays.

Syntax

__property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SAMLWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes };

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SAMLWriter Component)

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

Syntax

__property __int64 SigningChainHandle[int SigningChainIndex] = { read=FSigningChainHandle, write=FSetSigningChainHandle };

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 SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

StatementCount Property (SAMLWriter Component)

The number of records in the Statement arrays.

Syntax

__property int StatementCount = { read=FStatementCount, write=FSetStatementCount };

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 not available at design time.

Data Type

Integer

StatementAuthnContextAuthenticatingAuthorities Property (SAMLWriter Component)

Contains the list of authenticating authorities.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnContextChoice Property (SAMLWriter Component)

Specifies the authentication context choice variant.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnContextClassRef Property (SAMLWriter Component)

Indicates the authentication contexts class reference.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnContextDecl Property (SAMLWriter Component)

Specifies the authentication contexts declaration.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnContextDeclRef Property (SAMLWriter Component)

Specifies the authentication contexts declaration reference.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnInstant Property (SAMLWriter Component)

Specifies the authentication event timestamp.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnSessionIndex Property (SAMLWriter Component)

Contains the authentication session index.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnSessionNotOnOrAfter Property (SAMLWriter Component)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnSubjectLocalityAddress Property (SAMLWriter Component)

Specifies the authentication subjects address.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthnSubjectLocalityDNSName Property (SAMLWriter Component)

Maps to the authentication subjects DNS name parameter.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthzActions Property (SAMLWriter Component)

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

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthzDecision Property (SAMLWriter Component)

Specifies the authorization decision.

Syntax

__property TsbxSAMLWriterStatementAuthzDecisions StatementAuthzDecision[int StatementIndex] = { read=FStatementAuthzDecision, write=FSetStatementAuthzDecision };

enum TsbxSAMLWriterStatementAuthzDecisions {
  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 not available at design time.

Data Type

Integer

StatementAuthzDecisionEvidence Property (SAMLWriter Component)

Manages the authorization decision statement evidence parameter.

Syntax

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

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 not available at design time.

Data Type

String

StatementAuthzDecisionResource Property (SAMLWriter Component)

Specifies the authorization decision statement resource parameter.

Syntax

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

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 not available at design time.

Data Type

String

StatementStatementType Property (SAMLWriter Component)

Specifies the assertion statement type.

Syntax

__property TsbxSAMLWriterStatementStatementTypes StatementStatementType[int StatementIndex] = { read=FStatementStatementType, write=FSetStatementStatementType };

enum TsbxSAMLWriterStatementStatementTypes {
  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 not available at design time.

Data Type

Integer

SubjectConfirmationCount Property (SAMLWriter Component)

The number of records in the SubjectConfirmation arrays.

Syntax

__property int SubjectConfirmationCount = { read=FSubjectConfirmationCount, write=FSetSubjectConfirmationCount };

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 not available at design time.

Data Type

Integer

SubjectConfirmationAddress Property (SAMLWriter Component)

Contains the address enabled for presenting assertions.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationData Property (SAMLWriter Component)

The uninterpreted value of data entry in the subject confirmation.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationDataType Property (SAMLWriter Component)

The type of data contained in the confirmation.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationID Property (SAMLWriter Component)

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

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationInResponseTo Property (SAMLWriter Component)

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

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationMethod Property (SAMLWriter Component)

Specifies the mechanism to be used to confirm the subject.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationNotBefore Property (SAMLWriter Component)

Time moment before which the subject cannot be confirmed.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationNotOnOrAfter Property (SAMLWriter Component)

Limits the time until which the subject can be confirmed.

Syntax

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

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 not available at design time.

Data Type

String

SubjectConfirmationRecipient Property (SAMLWriter 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, write=FSetSubjectConfirmationRecipient };

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 not available at design time.

Data Type

String

AddAttribute Method (SAMLWriter Component)

Adds an attribute to an existing attribute statement.

Syntax

int __fastcall AddAttribute(String AttributeName, String AttributeValue, String NameFormat, String ContentType, int StatementIndex);

Remarks

Use this method to add an attribute to an attribute statement. The method returns the index of the newly added attribute in the statement.

Use the method parameters to provide the parameters of the new attribute:

<saml:Attribute Name="uid" <!-- AttributeName --> NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" <!-- NameFormat --> > <saml:AttributeValue xsi:type="xs:string" <!-- ContentType --> >test <!-- AttributeValue --> </saml:AttributeValue> </saml:Attribute> </code>

Note: if StatementIndex is set to -1, the attribute will be added to the last attribute statement in the collection. If no attribute statements are available in the collection, one will be created automatically.

If StatementIndex exceeds the index of the last statement in the Statements collection, a new attribute statement will be created (even if there are other attribute statements in the list), and the attribute added to it.

If StatementIndex points to an existing statement but that statement is not an attribute statement, an exception will be thrown.

AddAttributeStatement Method (SAMLWriter Component)

Adds an attribute statement to the assertion.

Syntax

int __fastcall AddAttributeStatement();

Remarks

Use this method to add an attribute statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.

Note that a call to AddAttribute adds a new attribute statement behind the scenes if no attribute statements have been added by that time.

AddAuthnStatement Method (SAMLWriter Component)

Adds an authentication statement to the assertion.

Syntax

int __fastcall AddAuthnStatement(String AuthnInstant, String SessionIndex, String NotOnOrAfter, String ClassRef);

Remarks

Use this method to add an authentication statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.

AddAuthzDecisionStatement Method (SAMLWriter Component)

Adds an authorization decision statement to the assertion.

Syntax

int __fastcall AddAuthzDecisionStatement(int Decision, String Evidence, String Resource, String Actions);

Remarks

Use this method to add an authorization decision statement to the currently edited assertion. The method returns the index of the newly added statement in the Statements collection.

AddCondition Method (SAMLWriter Component)

Adds a condition to the object (assertion or authn request) being edited.

Syntax

int __fastcall AddCondition(int ConditionType, String ConditionValue);

Remarks

Use this method to quickly add a condition to the SAML object you are creating.

AddScopingIDP Method (SAMLWriter Component)

Adds a scoping IDP to the object being currently edited.

Syntax

int __fastcall AddScopingIDP(String Name, String ProviderID, String Loc);

Remarks

Use this method to quickly add a scoping IDP to the SAML object you are creating. The method returns the index of the new element in the ScopingIDPs collection.

AddSubjectConfirmation Method (SAMLWriter Component)

Adds a subject confirmation to the object being edited.

Syntax

int __fastcall AddSubjectConfirmation(String Method, String Address, String Recipient, String InResponseTo, String NotBefore, String NotOnOrAfter, String ID, String DataType, String Data);

Remarks

Use this method to quickly add a subject confirmation to the SAML object you are creating. The method returns the index of the new subject confirmation in the list.

BeginAssertion Method (SAMLWriter Component)

Initiates the process of creating a new assertion.

Syntax

void __fastcall BeginAssertion();

Remarks

This method resets the contents of all assertion-related properties and prepares the component for creating a new assertion.

Use the methods and properties of the component, such as Assertion, as well as Statements and Attributes to prepare the new assertion. When ready, call CompleteAssertion to commit the provided details to the message.

CompleteAssertion Method (SAMLWriter Component)

Adds a completed assertion to a SAML message.

Syntax

int __fastcall CompleteAssertion();

Remarks

Use this method to commit an assertion to the SAML message being created. Before calling this method, prepare the assertion by calling BeginAssertion and filling in the details via the Assertion, Attributes, and Statements properties.

The method returns the index of the new assertion in the list.

Config Method (SAMLWriter Component)

This method 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.

CreateNew Method (SAMLWriter Component)

Creates a new SAML message with the given type.

Syntax

void __fastcall CreateNew(int ContentType);

Remarks

Use this method to create a new SAML message with the specified content type. The following values are supported:

• 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)

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

DoAction Method (SAMLWriter 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;....

FormatID Method (SAMLWriter Component)

Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields.

Syntax

String __fastcall FormatID(String Value, String IDType, String Format, String NameQualifier, String SPNameQualifier, String SPProvidedID);

Remarks

This is a utility method that simplifies formatting of SAML IDs. Pass the components of the SAML ID to this method, and assign the resulting string to the required property.

Example: // you can provide some of the values; the optional values will be omitted from the output writer.Issuer = writer.FormatID("https://saml.mysite.com", "Issuer", "urn:oasis:names:tc:SAML:2.0:nameid-format:entity", "", "", ""); // this call will just return the bare value, with no attributes writer.Issuer = writer.FormatID("https://saml.mysite.com", "", "", "", "", "");

Reset Method (SAMLWriter Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Save Method (SAMLWriter Component)

Saves the configured message to a string.

Syntax

String __fastcall Save();

Remarks

Use this method to save the created SAML message to a string.

SaveBytes Method (SAMLWriter Component)

Saves the configured message to a byte array.

Syntax

DynamicArray<Byte> __fastcall SaveBytes();

Remarks

Use this method to save the formed SAML message to a byte array.

SaveFile Method (SAMLWriter Component)

Saves the configured message to a file.

Syntax

void __fastcall SaveFile(String FileName);

Remarks

Use this method to save the created SAML message to a file.

Error Event (SAMLWriter Component)

Fires to report an error condition.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxSAMLWriterErrorEventParams;
typedef void __fastcall (__closure *TsbxSAMLWriterErrorEvent)(System::TObject* Sender, TsbxSAMLWriterErrorEventParams *e);
__property TsbxSAMLWriterErrorEvent 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 (SAMLWriter Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSAMLWriterNotificationEventParams;
typedef void __fastcall (__closure *TsbxSAMLWriterNotificationEvent)(System::TObject* Sender, TsbxSAMLWriterNotificationEventParams *e);
__property TsbxSAMLWriterNotificationEvent 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.

Config Settings (SAMLWriter 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.

SAMLWriter Config Settings

Base Config Settings

Trappable Errors (SAMLWriter Component)