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.

AddXMLHeader Property (SAMLWriter Component)

Controls the inclusion of an XML header in the message.

Syntax

property AddXMLHeader: Boolean read get_AddXMLHeader write set_AddXMLHeader;

Default Value

false

Remarks

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

This property is not available at design time.

Artifact Property (SAMLWriter Component)

Provides access to the Artifact element of the message.

Syntax

property Artifact: TsbxSAMLArtifact read get_Artifact write set_Artifact;

Remarks

Use this property to access and adjust the Artifact element of the created SAML message.

This property is not available at design time.

Please refer to the SAMLArtifact type for a complete list of fields.

ArtifactResolveQuery Property (SAMLWriter Component)

Contains the artifact resolve query.

Syntax

property ArtifactResolveQuery: String read get_ArtifactResolveQuery write set_ArtifactResolveQuery;

Default Value

''

Remarks

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

This property is not available at design time.

AssertionAttributes Property (SAMLWriter Component)

Contains a list of assertion attributes.

Syntax

property AssertionAttributes: TsbxSAMLAttributeList read get_AssertionAttributes write set_AssertionAttributes;

Remarks

Use this property to configure the list of assertion attributes for the new SAML message.

This property is not available at design time.

Please refer to the SAMLAttribute type for a complete list of fields.

AssertionConditions Property (SAMLWriter Component)

Contains a list of assertion conditions.

Syntax

property AssertionConditions: TsbxSAMLAssertionConditionList read get_AssertionConditions write set_AssertionConditions;

Remarks

Use this property to tune-up assertion conditions to be included in the message.

This property is not available at design time.

Please refer to the SAMLAssertionCondition type for a complete list of fields.

AssertionCount Property (SAMLWriter Component)

Returns the number of assertions in the message.

Syntax

property AssertionCount: Integer read get_AssertionCount;

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.

AssertionIDRequest Property (SAMLWriter Component)

Contains the properties of AssertionIDRequest element.

Syntax

property AssertionIDRequest: TsbxSAMLAssertionIDRequest read get_AssertionIDRequest;

Remarks

Use this property to access the properties of AssertionIDRequest element.

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

Please refer to the SAMLAssertionIDRequest type for a complete list of fields.

AssertionInfo Property (SAMLWriter Component)

Contains assertion information.

Syntax

property AssertionInfo: TsbxSAMLAssertionInfo read get_AssertionInfo;

Remarks

Use this property to access and/or modify the SAML assertion information.

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

Please refer to the SAMLAssertionInfo type for a complete list of fields.

AssertionIssuer Property (SAMLWriter Component)

Specifies the assertion issuer.

Syntax

property AssertionIssuer: String read get_AssertionIssuer write set_AssertionIssuer;

Default Value

''

Remarks

Use this property to provide the assertion issuer ID.

This property is not available at design time.

AssertionStatements Property (SAMLWriter Component)

Contains assertion statements.

Syntax

property AssertionStatements: TsbxSAMLAssertionStatementList read get_AssertionStatements write set_AssertionStatements;

Remarks

Use this property to access or set the assertion statements.

This property is not available at design time.

Please refer to the SAMLAssertionStatement type for a complete list of fields.

AssertionSubjectConfirmations Property (SAMLWriter Component)

Provides access to assertion SubjectConfirmations list.

Syntax

property AssertionSubjectConfirmations: TsbxSAMLSubjectConfirmationList read get_AssertionSubjectConfirmations write set_AssertionSubjectConfirmations;

Remarks

Use this property to access the list of assertions SubjectConfirmation elements.

This property is not available at design time.

Please refer to the SAMLSubjectConfirmation type for a complete list of fields.

AssertionSubjectID Property (SAMLWriter Component)

Specifies the assertion subject ID.

Syntax

property AssertionSubjectID: String read get_AssertionSubjectID write set_AssertionSubjectID;

Default Value

''

Remarks

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

This property is not available at design time.

AttrQueryAttributes Property (SAMLWriter Component)

Contains a list of attribute query attributes.

Syntax

property AttrQueryAttributes: TsbxSAMLAttributeList read get_AttrQueryAttributes write set_AttrQueryAttributes;

Remarks

Use this property to set up a list of attribute query attributes.

This property is not available at design time.

Please refer to the SAMLAttribute type for a complete list of fields.

AuthnQuery Property (SAMLWriter Component)

Provides access to the AuthnQuery SAML element.

Syntax

property AuthnQuery: TsbxSAMLAuthnQuery read get_AuthnQuery;

Remarks

Use this property to access the details of the authentication query element.

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

Please refer to the SAMLAuthnQuery type for a complete list of fields.

AuthnRequest Property (SAMLWriter Component)

Publishes the properties of AuthnRequest element.

Syntax

property AuthnRequest: TsbxSAMLAuthnRequest read get_AuthnRequest;

Remarks

Use this property to access the details of the authentication request element.

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

Please refer to the SAMLAuthnRequest type for a complete list of fields.

AuthnRequestConditions Property (SAMLWriter Component)

Contains a list of AuthnRequest conditions.

Syntax

property AuthnRequestConditions: TsbxSAMLAssertionConditionList read get_AuthnRequestConditions write set_AuthnRequestConditions;

Remarks

Use this property to set up the conditions of the AuthnRequest element.

This property is not available at design time.

Please refer to the SAMLAssertionCondition type for a complete list of fields.

AuthnRequestScopingIDPList Property (SAMLWriter Component)

Provides access to the list of scoping IDP eleements.

Syntax

property AuthnRequestScopingIDPList: TsbxSAMLIDPEntryList read get_AuthnRequestScopingIDPList write set_AuthnRequestScopingIDPList;

Remarks

Use this property to set up the collection of scoping IDP entry list for the prepared SAML request.

This property is not available at design time.

Please refer to the SAMLIDPEntry type for a complete list of fields.

AuthzDecisionQuery Property (SAMLWriter Component)

Provides access to AuthzDecisionQuery element.

Syntax

property AuthzDecisionQuery: TsbxSAMLAuthzDecisionQuery read get_AuthzDecisionQuery;

Remarks

Use this property to configure the details of Authorization Decision Query element.

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

Please refer to the SAMLAuthzDecisionQuery type for a complete list of fields.

Binding Property (SAMLWriter Component)

Specifies the type of the binding to use.

Syntax

property Binding: TsbxSAMLBindingTypes read get_Binding write set_Binding;

TsbxSAMLBindingTypes = (
  csbtNone,
  csbtSOAP,
  csbtPAOS,
  csbtRedirect,
  csbtPOST,
  csbtArtifact
);

Default Value

csbtNone

Remarks

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

Consent Property (SAMLWriter Component)

Contains the Consent parameter of the request.

Syntax

property Consent: String read get_Consent write set_Consent;

Default Value

''

Remarks

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

This property is not available at design time.

Destination Property (SAMLWriter Component)

Contains the Destination parameter of the SAML object.

Syntax

property Destination: String read get_Destination write set_Destination;

Default Value

''

Remarks

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

This property is not available at design time.

EncryptionCertificate Property (SAMLWriter Component)

Sets the encryption certificate.

Syntax

property EncryptionCertificate: TsbxCertificate read get_EncryptionCertificate write set_EncryptionCertificate;

Remarks

Use this property to specify the encryption certificate for encrypted requests.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

FIPSMode Property (SAMLWriter Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

ID Property (SAMLWriter Component)

The ID of the request.

Syntax

property ID: String read get_ID write set_ID;

Default Value

''

Remarks

Use this property to specify the ID of the request.

This property is not available at design time.

InResponseTo Property (SAMLWriter Component)

Contains the InResponseTo property of the SAML request.

Syntax

property InResponseTo: String read get_InResponseTo write set_InResponseTo;

Default Value

''

Remarks

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.

IssueInstant Property (SAMLWriter Component)

Contains request issuance timestamp.

Syntax

property IssueInstant: String read get_IssueInstant write set_IssueInstant;

Default Value

''

Remarks

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.

Issuer Property (SAMLWriter Component)

Sets the issuer of the message.

Syntax

property Issuer: String read get_Issuer write set_Issuer;

Default Value

''

Remarks

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

LogoutRequest Property (SAMLWriter Component)

Contains the properties of SAML LogoutRequest element.

Syntax

property LogoutRequest: TsbxSAMLLogoutRequest read get_LogoutRequest;

Remarks

Use this property to access the settings of the LogoutRequest element.

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

Please refer to the SAMLLogoutRequest type for a complete list of fields.

ManageNameIDRequest Property (SAMLWriter Component)

Provides access to ManageNameIDRequest element.

Syntax

property ManageNameIDRequest: TsbxSAMLManageNameIDRequest read get_ManageNameIDRequest;

Remarks

Use this property to access the details of ManageNameIDRequest element.

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

Please refer to the SAMLManageNameIDRequest type for a complete list of fields.

NameIDMappingRequest Property (SAMLWriter Component)

Publishes the properties of NameIDMappingRequest entity.

Syntax

property NameIDMappingRequest: TsbxSAMLNameIDMappingRequest read get_NameIDMappingRequest;

Remarks

Use this property to access the details of SAML NameIDMappingRequest entity.

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

Please refer to the SAMLNameIDMappingRequest type for a complete list of fields.

OutputType Property (SAMLWriter Component)

Returns the SAML type of message being created.

Syntax

property OutputType: TsbxSAMLContentTypes read get_OutputType;

TsbxSAMLContentTypes = (
  cstyNone,
  cstyAssertionIDRequest,
  cstySubjectQuery,
  cstyAuthnQuery,
  cstyAttributeQuery,
  cstyAuthzDecisionQuery,
  cstyAuthnRequest,
  cstyManageNameIDRequest,
  cstyLogoutRequest,
  cstyNameIDMappingRequest,
  cstyArtifactResolve,
  cstyResponse
);

Default Value

cstyNone

Remarks

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 setting OutputType to cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.

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

POSTBinding Property (SAMLWriter Component)

Exposes the POST binding properties.

Syntax

property POSTBinding: TsbxSAMLPOSTBinding read get_POSTBinding;

Remarks

Use this property to access the POST binding settings.

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

Please refer to the SAMLPOSTBinding type for a complete list of fields.

Profile Property (SAMLWriter Component)

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

Syntax

property Profile: String read get_Profile write set_Profile;

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.

RedirectBinding Property (SAMLWriter Component)

Publishes the redirect binding settings.

Syntax

property RedirectBinding: TsbxSAMLRedirectBinding read get_RedirectBinding;

Remarks

Use this property to access the redirect binding settings.

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

Please refer to the SAMLRedirectBinding type for a complete list of fields.

RedirectBindingCertificate Property (SAMLWriter Component)

Contains a certificate to sign the redirect binding.

Syntax

property RedirectBindingCertificate: TsbxCertificate read get_RedirectBindingCertificate write set_RedirectBindingCertificate;

Remarks

Use this property to set the signing certificate for the redirect binding object. This is different to SigningCertificate and is used to sign the content of the redirect binding.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

Response Property (SAMLWriter Component)

Provides access to the SAML response object properties.

Syntax

property Response: TsbxSAMLResponse read get_Response;

Remarks

Use this property to access the parameters of a SAML response object.

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

Please refer to the SAMLResponse type for a complete list of fields.

SigCanonicalizationMethod Property (SAMLWriter Component)

The canonicalization method to use in the signature.

Syntax

property SigCanonicalizationMethod: String read get_SigCanonicalizationMethod write set_SigCanonicalizationMethod;

Default Value

''

Remarks

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

SigDigestMethod Property (SAMLWriter Component)

The digest method to use.

Syntax

property SigDigestMethod: String read get_SigDigestMethod write set_SigDigestMethod;

Default Value

''

Remarks

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

SigMethod Property (SAMLWriter Component)

The signature method to use.

Syntax

property SigMethod: String read get_SigMethod write set_SigMethod;

Default Value

''

Remarks

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

Sign Property (SAMLWriter Component)

Specifies whether the created SAML message should be signed.

Syntax

property Sign: Boolean read get_Sign write set_Sign;

Default Value

false

Remarks

Set this property to true to indicate that you want the created message to be signed.

This property is not available at design time.

SigningCertificate Property (SAMLWriter Component)

The certificate to be used for signing.

Syntax

property SigningCertificate: TsbxCertificate read get_SigningCertificate write set_SigningCertificate;

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SigningChain Property (SAMLWriter Component)

The signing certificate chain.

Syntax

property SigningChain: TsbxCertificateList read get_SigningChain write set_SigningChain;

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

SubjectConfirmations Property (SAMLWriter Component)

Provides access to the list of subject confirmation elements.

Syntax

property SubjectConfirmations: TsbxSAMLSubjectConfirmationList read get_SubjectConfirmations write set_SubjectConfirmations;

Remarks

Use this property to access the list of subject confirmation elements.

This property is not available at design time.

Please refer to the SAMLSubjectConfirmation type for a complete list of fields.

SubjectID Property (SAMLWriter Component)

Sets the subject of the message.

Syntax

property SubjectID: String read get_SubjectID write set_SubjectID;

Default Value

''

Remarks

Use this property to set the SAML ID of the message subject.

This property is not available at design time.

Version Property (SAMLWriter Component)

Specifies the protocol version of the SAML message.

Syntax

property Version: String read get_Version write set_Version;

Default Value

'2.0'

Remarks

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.

AddAdviceAssertion Method (SAMLWriter Component)

Adds an advice assertion to the message.

Syntax

function AddAdviceAssertion(AssertionIndex: Integer): Integer;

Remarks

Use this method to add an advice assertion to a SAML assertion message. Provide the index of the assertion via AssertionIndex parameter.

This method returns the index of the newly added advice assertion in the list.

AddAssertion Method (SAMLWriter Component)

Adds assertion to a SAML message.

Syntax

function AddAssertion(): Integer;

Remarks

Use this method to add an assertion to the SAML message being created. The assertion details to add are taken from the components AssertionXXX properties, such as AssertionInfo AssertionStatements, or AssertionAttributes.

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

ClearAssertion Method (SAMLWriter Component)

Resets the contents of all assertion-related properties.

Syntax

procedure ClearAssertion();

Remarks

Use this method to clear the contents of all assertion-related properties, such as AssertionAttributes, to clean up the assertion settings when preparing the component for adding a new assertion.

CompareIDs Method (SAMLWriter Component)

Compares two SAML IDs.

Syntax

function CompareIDs(ID1: String; ID2: String): Boolean;

Remarks

This utility method compares two SAML identifiers for equality.

Config Method (SAMLWriter Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

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

procedure CreateNew(OutputType: Integer);

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)

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

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

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

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

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

GetIDProp Method (SAMLWriter Component)

Returns an element of the SAML ID.

Syntax

function GetIDProp(ID: String; PropName: String): String;

Remarks

This is a utility method that simplifies retrieval of a specific property within a SAML ID. Pass the name of the ID property to the PropName parameter, and the ID to the ID parameter.

The following ID properties are supported:

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

RemoveAdvice Method (SAMLWriter Component)

Removes an advice from an assertion.

Syntax

procedure RemoveAdvice(AssertionIndex: Integer);

Remarks

Use this method to remove an advice from an assertion. Pass the assertion index via the AssertionIndex parameter.

RemoveAdviceAssertion Method (SAMLWriter Component)

Removes an advice from an assertion.

Syntax

procedure RemoveAdviceAssertion(AssertionIndex: Integer; AdviceAssertionIndex: Integer);

Remarks

Use this method to remove an advice assertion from an assertion.

RemoveAllAssertions Method (SAMLWriter Component)

Removes all assertions currently configured in the message.

Syntax

procedure RemoveAllAssertions();

Remarks

Use this message to remove all assertions currently set up in the SAML message.

RemoveAssertion Method (SAMLWriter Component)

Removes an assertion from the message.

Syntax

procedure RemoveAssertion(AssertionIndex: Integer);

Remarks

Use this message to remove an assertion from a SAML message. Pass the assertion index as a parameter.

Save Method (SAMLWriter Component)

Saves the configured message to a string.

Syntax

function Save(): String;

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

function SaveBytes(): TBytes;

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

procedure SaveFile(FileName: String);

Remarks

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

SaveStream Method (SAMLWriter Component)

Saves the configured message to a stream.

Syntax

procedure SaveStream(OutStream: TStream);

Remarks

Use this method to save the prepared SAML message to a stream.

Error Event (SAMLWriter Component)

Fires to report an error condition.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent 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

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent 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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

SAMLArtifact Type

Represents a SAML Artifact entity.

Remarks

This type is a container for a SAML Artifact entity. A SAML artifact consists of a TypeCode, an EndpointIndex, and a RemainingArtifact, which contains the body of the artifact and varies depending on the TypeCode.

Fields

Constructors

>

constructor Create();

Creates a new SAMLArtifact object.

SAMLAssertionCondition Type

Represents a SAML assertion Condition parameter.

Remarks

This type is a container for a single Condition parameter of a SAML assertion.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAssertionCondition object.

SAMLAssertionIDRequest Type

Represents a SAML AssertionIDRequest object.

Remarks

This type is a container for a SAML AssertionIDRequest element. This element is used to request assertions by their IDs.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAssertionIDRequest object.

SAMLAssertionInfo Type

Contains information about a SAML assertion.

Remarks

Use this type to get general information about a SAML assertion.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAssertionInfo object.

SAMLAssertionStatement Type

Represents an assertion statement.

Remarks

This type is a container for an assertion statement.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAssertionStatement object.

SAMLAttribute Type

A container for the SAML attribute object.

Remarks

This type is a container for the SAML attribute object.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAttribute object.

SAMLAuthnQuery Type

A container for AuthnQuery element.

Remarks

This type is a container for SAML AuthnQuery element, which represents an authentication event query.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAuthnQuery object.

SAMLAuthnRequest Type

Represents a SAML AuthnRequest object.

Remarks

This type represents a SAML AuthnRequest object. An AuthnRequest is sent by a principal to the identity provider when it needs to request an assertion containing an authentication statement.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAuthnRequest object.

SAMLAuthzDecisionQuery Type

Represents SAML AuthzDecisionQuery element.

Remarks

This type is a container for SAML AuthzDecisionQuery type.

Fields

Constructors

>

constructor Create();

Creates a new SAMLAuthzDecisionQuery object.

SAMLIDPEntry Type

Represents a single identity provider information.

Remarks

This type is a container of single identity provider-specific details.

Fields

Constructors

>

constructor Create();

Creates a new SAMLIDPEntry object.

SAMLLogoutRequest Type

Represents SAML LogoutRequest element.

Remarks

This type is a container for SAML LogoutRequest element.

Fields

Constructors

>

constructor Create();

Creates a new SAMLLogoutRequest object.

SAMLManageNameIDRequest Type

Represents a SAML ManageNameIDRequest element.

Remarks

This type is a container for ManageNameIDRequest element.

Fields

Constructors

>

constructor Create();

Creates a new SAMLManageNameIDRequest object.

SAMLNameIDMappingRequest Type

Represents SAML NameIDMappingRequest element.

Remarks

This type is a container for NameIDMappingRequest element.

Fields

Constructors

>

constructor Create();

Creates a new SAMLNameIDMappingRequest object.

SAMLPOSTBinding Type

Contains the details of the POST binding.

Remarks

This type provides access to properties of POST binding.

Fields

Constructors

>

constructor Create();

Creates a new SAMLPOSTBinding object.

SAMLRedirectBinding Type

Contains parameters of SAML Redirect binding.

Remarks

This type is a container for properties of SAML Redirect binding mechanism.

Fields

Constructors

>

constructor Create();

Creates a new SAMLRedirectBinding object.

SAMLResponse Type

Represents a SAML response.

Remarks

This is a container for SAML response parameters.

Fields

Constructors

>

constructor Create();

Creates a new SAMLResponse object.

SAMLSubjectConfirmation Type

Represents SAML SubjectConfirmation element.

Remarks

This type is a container for SAML SubjectConfirmating element.

Fields

Constructors

>

constructor Create();

Creates a new SAMLSubjectConfirmation object.

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)