# SAMLWriter Component

The SAMLWriter component offers SAML message generation functions.

## Syntax

```text
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:

```text
  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:

```text
  <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](#createnew-method-samlwriter-component).

## Property List

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

|  |  |
| --- | --- |
| [ArtifactEndpointIndex](#artifactendpointindex-property-samlwriter-component) | An accessor to the EndpointIndex entry of the artifact. |
| [ArtifactMessageHandle](#artifactmessagehandle-property-samlwriter-component) | An accessor to the MessageHandle property of the artifact. |
| [ArtifactRemainingArtifact](#artifactremainingartifact-property-samlwriter-component) | Returns the contents of the artifact. |
| [ArtifactSourceID](#artifactsourceid-property-samlwriter-component) | An accessor to the SourceID property of the artifact. |
| [ArtifactTypeCode](#artifacttypecode-property-samlwriter-component) | The TypeCode property of the artifact. |
| [ArtifactURI](#artifacturi-property-samlwriter-component) | An accessor to the URI property of the artifact. |
| [ArtifactResolveQuery](#artifactresolvequery-property-samlwriter-component) | Contains the artifact resolve query. |
| [AssertionType](#assertiontype-property-samlwriter-component) | Specifies the type of the assertion. |
| [AssertionEncryptedContent](#assertionencryptedcontent-property-samlwriter-component) | Represents the encrypted assertion content. |
| [AssertionID](#assertionid-property-samlwriter-component) | Represents the ID of the assertion. |
| [AssertionIDRef](#assertionidref-property-samlwriter-component) | Represents an ID reference value. |
| [AssertionIssueInstant](#assertionissueinstant-property-samlwriter-component) | Contains the assertion issuance time stamp. |
| [AssertionIssuer](#assertionissuer-property-samlwriter-component) | Specifies the assertion issuer. |
| [AssertionParentAssertion](#assertionparentassertion-property-samlwriter-component) | Contains the index of the parent assertion in the assertion list. |
| [AssertionSignatureValidationResult](#assertionsignaturevalidationresult-property-samlwriter-component) | The outcome of the cryptographic signature validation. |
| [AssertionSigned](#assertionsigned-property-samlwriter-component) | Specifies whether the assertion is signed. |
| [AssertionSubject](#assertionsubject-property-samlwriter-component) | Specifies the assertion subject. |
| [AssertionURIRef](#assertionuriref-property-samlwriter-component) | Represents an URI reference value. |
| [AssertionVersion](#assertionversion-property-samlwriter-component) | Specifies the SAML protocol version used. |
| [AssertionCount](#assertioncount-property-samlwriter-component) | Returns the number of assertions in the message. |
| [AttributeCount](#attributecount-property-samlwriter-component) | The number of records in the Attribute arrays. |
| [AttributeFriendlyName](#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. |
| [AttributeName](#attributename-property-samlwriter-component) | Specifies the name of the attribute. |
| [AttributeNameFormat](#attributenameformat-property-samlwriter-component) | Indicates the format used to reference the attribute. |
| [AttributeStatementIndex](#attributestatementindex-property-samlwriter-component) | Contains the index of the statement the attribute corresponds to. |
| [AttributeValues](#attributevalues-property-samlwriter-component) | Contains a list of attribute values. |
| [AuthnQueryComparison](#authnquerycomparison-property-samlwriter-component) | Specifies the authentication context comparison method. |
| [AuthnQueryContextClassRefs](#authnquerycontextclassrefs-property-samlwriter-component) | Specifies the context class reference. |
| [AuthnQueryRefType](#authnqueryreftype-property-samlwriter-component) | Specifies the context reference type. |
| [AuthnQuerySessionIndex](#authnquerysessionindex-property-samlwriter-component) | Specifies the index of the session to the authentication entity. |
| [AuthnRequestAssertionConsumerServiceIndex](#authnrequestassertionconsumerserviceindex-property-samlwriter-component) | Specifies the assertion consumer service index. |
| [AuthnRequestAssertionConsumerServiceURL](#authnrequestassertionconsumerserviceurl-property-samlwriter-component) | Specifies the assertion consumer service URL. |
| [AuthnRequestAttributeConsumingServiceIndex](#authnrequestattributeconsumingserviceindex-property-samlwriter-component) | Specifies the attribute consuming service index. |
| [AuthnRequestContextClassRefs](#authnrequestcontextclassrefs-property-samlwriter-component) | Provides access to the authentication context class references. |
| [AuthnRequestContextComparison](#authnrequestcontextcomparison-property-samlwriter-component) | Specifies the AuthnContext comparison method. |
| [AuthnRequestContextRefType](#authnrequestcontextreftype-property-samlwriter-component) | Specifies the context reference type. |
| [AuthnRequestFlags](#authnrequestflags-property-samlwriter-component) | Adjusts secondary serialization properties. |
| [AuthnRequestForceAuthn](#authnrequestforceauthn-property-samlwriter-component) | Corresponds to the ForceAuthn parameter of the request. |
| [AuthnRequestIsPassive](#authnrequestispassive-property-samlwriter-component) | Maps to the IsPassive parameter of the request. |
| [AuthnRequestNameIDPolicyAllowCreate](#authnrequestnameidpolicyallowcreate-property-samlwriter-component) | Matches the AllowCreate attribute of NameIDPolicy element of the request. |
| [AuthnRequestNameIDPolicyFormat](#authnrequestnameidpolicyformat-property-samlwriter-component) | Matches to the Format attribute of the NameIDPolicy element of the request. |
| [AuthnRequestNameIDPolicySPNameQualifier](#authnrequestnameidpolicyspnamequalifier-property-samlwriter-component) | Matches to the SP name qualifier attribute of the request. |
| [AuthnRequestProtocolBinding](#authnrequestprotocolbinding-property-samlwriter-component) | Specifies the protocol binding to be requested in the authentication request. |
| [AuthnRequestProviderName](#authnrequestprovidername-property-samlwriter-component) | Specifies the name of the requestor. |
| [AuthnRequestScopingGetComplete](#authnrequestscopinggetcomplete-property-samlwriter-component) | Matches the GetComplete element of the IDPList entry of the Scoping object. |
| [AuthnRequestScopingProxyCount](#authnrequestscopingproxycount-property-samlwriter-component) | The maximum number of proxies on the way between the requestor and the provider. |
| [AuthnRequestScopingRequesterIDs](#authnrequestscopingrequesterids-property-samlwriter-component) | A collection of requestor IDs on whose behalf the request is being sent. |
| [AuthzDecisionQueryActions](#authzdecisionqueryactions-property-samlwriter-component) | Specifies the list of actions included in the query. |
| [AuthzDecisionQueryResource](#authzdecisionqueryresource-property-samlwriter-component) | Matches the Resource element of the query. |
| [BindingType](#bindingtype-property-samlwriter-component) | Specifies the type of SAML binding to use. |
| [BindingBody](#bindingbody-property-samlwriter-component) | Contains the POST binding form body. |
| [BindingEncoding](#bindingencoding-property-samlwriter-component) | Specifies the message encoding. |
| [BindingForceSign](#bindingforcesign-property-samlwriter-component) | Enforces a signature over all outgoing messages. |
| [BindingFormTemplate](#bindingformtemplate-property-samlwriter-component) | Contains the XHTML form template returned by the service provider. |
| [BindingPOSTMode](#bindingpostmode-property-samlwriter-component) | Specifies whether binding is applied on the server, or on the client side. |
| [BindingRelayState](#bindingrelaystate-property-samlwriter-component) | Contains the RelayState parameter of the binding. |
| [BindingSignatureAlgorithm](#bindingsignaturealgorithm-property-samlwriter-component) | Contains the signature algorithm. |
| [BindingSignatureValidationResult](#bindingsignaturevalidationresult-property-samlwriter-component) | The outcome of the cryptographic signature validation. |
| [BindingSigned](#bindingsigned-property-samlwriter-component) | Specifies whether to sign the binding. |
| [BindingURL](#bindingurl-property-samlwriter-component) | Contains the URL of the request query. |
| [BindingVerifySignatures](#bindingverifysignatures-property-samlwriter-component) | Instructs the component whether to verify incoming signatures. |
| [BindingKeyHandle](#bindingkeyhandle-property-samlwriter-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [ConditionCount](#conditioncount-property-samlwriter-component) | The number of records in the Condition arrays. |
| [Condition](#condition-property-samlwriter-component) | The condition set in accordance with the ConditionType . |
| [ConditionType](#conditiontype-property-samlwriter-component) | Specifies a type of the condition object. |
| [EncryptionCertBytes](#encryptioncertbytes-property-samlwriter-component) | Returns the raw certificate data in DER format. |
| [EncryptionCertHandle](#encryptioncerthandle-property-samlwriter-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [FIPSMode](#fipsmode-property-samlwriter-component) | Reserved. |
| [LogoutRequestNameID](#logoutrequestnameid-property-samlwriter-component) | Contains the value of the NameID parameter. |
| [LogoutRequestNotOnOrAfter](#logoutrequestnotonorafter-property-samlwriter-component) | Contains the value of the NotOnOrAfter parameter. |
| [LogoutRequestReason](#logoutrequestreason-property-samlwriter-component) | Contains the value of the Reason parameter. |
| [LogoutRequestSessionIndexes](#logoutrequestsessionindexes-property-samlwriter-component) | Contains the list of session indices. |
| [ManageNameIDRequestNameID](#managenameidrequestnameid-property-samlwriter-component) | Contains the value of the NameID parameter of the request. |
| [ManageNameIDRequestNewEncryptedID](#managenameidrequestnewencryptedid-property-samlwriter-component) | Contains the value of the NewEncryptedID parameter of the request. |
| [ManageNameIDRequestNewID](#managenameidrequestnewid-property-samlwriter-component) | Contains the value of the NewID parameter. |
| [ManageNameIDRequestTerminate](#managenameidrequestterminate-property-samlwriter-component) | Contains the value of the Terminate parameter of the request. |
| [MessageConsent](#messageconsent-property-samlwriter-component) | Contains the Consent parameter of the SAML message. |
| [MessageContentType](#messagecontenttype-property-samlwriter-component) | Returns the SAML type of the current message. |
| [MessageContentTypeString](#messagecontenttypestring-property-samlwriter-component) | Returns the type of the processed message, as an original string. |
| [MessageDestination](#messagedestination-property-samlwriter-component) | Contains the Destination parameter of the SAML message. |
| [MessageID](#messageid-property-samlwriter-component) | The ID of the request. |
| [MessageInResponseTo](#messageinresponseto-property-samlwriter-component) | Contains the InResponseTo property of the SAML request. |
| [MessageIssueInstant](#messageissueinstant-property-samlwriter-component) | Contains request issuance timestamp. |
| [MessageIssuer](#messageissuer-property-samlwriter-component) | Sets the issuer of the message. |
| [MessageSignatureValidationResult](#messagesignaturevalidationresult-property-samlwriter-component) | The outcome of the cryptographic signature validation. |
| [MessageSigned](#messagesigned-property-samlwriter-component) | Specifies whether the SAML message is or should be signed. |
| [MessageSubject](#messagesubject-property-samlwriter-component) | Gets or sets the subject of the message. |
| [MessageVersion](#messageversion-property-samlwriter-component) | Specifies the protocol version to use for the SAML message. |
| [MessageXMLHeader](#messagexmlheader-property-samlwriter-component) | Controls the inclusion of an XML header in the message. |
| [NameIDMappingRequestNameID](#nameidmappingrequestnameid-property-samlwriter-component) | An accessor to the NameID parameter of the request. |
| [NameIDMappingRequestNameIDPolicyAllowCreate](#nameidmappingrequestnameidpolicyallowcreate-property-samlwriter-component) | Contains the value of AllowCreate parameter of the NameIDPolicy object. |
| [NameIDMappingRequestNameIDPolicyFormat](#nameidmappingrequestnameidpolicyformat-property-samlwriter-component) | Specifies the format of the NameIDPolicy element. |
| [NameIDMappingRequestNameIDPolicySPNameQualifier](#nameidmappingrequestnameidpolicyspnamequalifier-property-samlwriter-component) | Contains the SPNameQualifier parameter of the NameIDPolicy element. |
| [NameIDMappingRequestNameIDPolicyUseAllowCreate](#nameidmappingrequestnameidpolicyuseallowcreate-property-samlwriter-component) | Controls inclusion of UseAllow modifier in the NameIDPolicy object. |
| [Profile](#profile-property-samlwriter-component) | Specifies a pre-defined profile to apply when creating the signature. |
| [References](#references-property-samlwriter-component) | Contains the References entry of the SAML AssertionIDRequest message. |
| [ResponseNameID](#responsenameid-property-samlwriter-component) | Contains the NameID parameter of a NameIDMapping response. |
| [ResponseOptionalElement](#responseoptionalelement-property-samlwriter-component) | An optional message element to be returned with the response. |
| [ResponseType](#responsetype-property-samlwriter-component) | Contains the type of the response. |
| [ResponseStatus](#responsestatus-property-samlwriter-component) | Gets or sets the status of the response. |
| [ResponseStatusCodeSubValue](#responsestatuscodesubvalue-property-samlwriter-component) | The value of the nested StatusCode. |
| [ResponseStatusCodeValue](#responsestatuscodevalue-property-samlwriter-component) | Contains the status code value. |
| [ResponseStatusDetail](#responsestatusdetail-property-samlwriter-component) | Contains additional information on the status of the request. |
| [ResponseStatusMessage](#responsestatusmessage-property-samlwriter-component) | Contains a status message (optional). |
| [ScopingIDPCount](#scopingidpcount-property-samlwriter-component) | The number of records in the ScopingIDP arrays. |
| [ScopingIDPLoc](#scopingidploc-property-samlwriter-component) | Contains the value of the Loc attribute. |
| [ScopingIDPName](#scopingidpname-property-samlwriter-component) | Contains the name of the IdP provider. |
| [ScopingIDPProviderID](#scopingidpproviderid-property-samlwriter-component) | Contains the provider ID. |
| [SecurityCanonicalizationMethod](#securitycanonicalizationmethod-property-samlwriter-component) | The canonicalization method to use in the signature. |
| [SecurityDigestMethod](#securitydigestmethod-property-samlwriter-component) | The digest method to use. |
| [SecurityEncryptionMethod](#securityencryptionmethod-property-samlwriter-component) | The encryption method used to encrypt the assertion. |
| [SecurityFlags](#securityflags-property-samlwriter-component) | Provides access to secondary security parameters and tweaks. |
| [SecuritySigMethod](#securitysigmethod-property-samlwriter-component) | The signature method to use. |
| [SecuritySignaturePolicy](#securitysignaturepolicy-property-samlwriter-component) | Specifies the signature validation policy. |
| [SigningCertBytes](#signingcertbytes-property-samlwriter-component) | Returns the raw certificate data in DER format. |
| [SigningCertHandle](#signingcerthandle-property-samlwriter-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SigningChainCount](#signingchaincount-property-samlwriter-component) | The number of records in the SigningChain arrays. |
| [SigningChainBytes](#signingchainbytes-property-samlwriter-component) | Returns the raw certificate data in DER format. |
| [SigningChainHandle](#signingchainhandle-property-samlwriter-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [StatementCount](#statementcount-property-samlwriter-component) | The number of records in the Statement arrays. |
| [StatementAuthnContextAuthenticatingAuthorities](#statementauthncontextauthenticatingauthorities-property-samlwriter-component) | Contains the list of authenticating authorities. |
| [StatementAuthnContextChoice](#statementauthncontextchoice-property-samlwriter-component) | Specifies the authentication context choice variant. |
| [StatementAuthnContextClassRef](#statementauthncontextclassref-property-samlwriter-component) | Indicates the authentication contexts class reference. |
| [StatementAuthnContextDecl](#statementauthncontextdecl-property-samlwriter-component) | Specifies the authentication contexts declaration. |
| [StatementAuthnContextDeclRef](#statementauthncontextdeclref-property-samlwriter-component) | Specifies the authentication contexts declaration reference. |
| [StatementAuthnInstant](#statementauthninstant-property-samlwriter-component) | Specifies the authentication event timestamp. |
| [StatementAuthnSessionIndex](#statementauthnsessionindex-property-samlwriter-component) | Contains the authentication session index. |
| [StatementAuthnSessionNotOnOrAfter](#statementauthnsessionnotonorafter-property-samlwriter-component) | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
| [StatementAuthnSubjectLocalityAddress](#statementauthnsubjectlocalityaddress-property-samlwriter-component) | Specifies the authentication subjects address. |
| [StatementAuthnSubjectLocalityDNSName](#statementauthnsubjectlocalitydnsname-property-samlwriter-component) | Maps to the authentication subjects DNS name parameter. |
| [StatementAuthzActions](#statementauthzactions-property-samlwriter-component) | Provides access to the list of actions of the authorization statement. |
| [StatementAuthzDecision](#statementauthzdecision-property-samlwriter-component) | Specifies the authorization decision. |
| [StatementAuthzDecisionEvidence](#statementauthzdecisionevidence-property-samlwriter-component) | Manages the authorization decision statement evidence parameter. |
| [StatementAuthzDecisionResource](#statementauthzdecisionresource-property-samlwriter-component) | Specifies the authorization decision statement resource parameter. |
| [StatementType](#statementtype-property-samlwriter-component) | Specifies the assertion statement type. |
| [SubjectConfirmationCount](#subjectconfirmationcount-property-samlwriter-component) | The number of records in the SubjectConfirmation arrays. |
| [SubjectConfirmationAddress](#subjectconfirmationaddress-property-samlwriter-component) | Contains the address enabled for presenting assertions. |
| [SubjectConfirmationData](#subjectconfirmationdata-property-samlwriter-component) | The uninterpreted value of data entry in the subject confirmation. |
| [SubjectConfirmationDataType](#subjectconfirmationdatatype-property-samlwriter-component) | The type of data contained in the confirmation. |
| [SubjectConfirmationID](#subjectconfirmationid-property-samlwriter-component) | The identifier of the entity which can satisfy the subject confirmation requirements. |
| [SubjectConfirmationInResponseTo](#subjectconfirmationinresponseto-property-samlwriter-component) | The ID of the SAML message in response to which the assertion is issued. |
| [SubjectConfirmationMethod](#subjectconfirmationmethod-property-samlwriter-component) | Specifies the mechanism to be used to confirm the subject. |
| [SubjectConfirmationNotBefore](#subjectconfirmationnotbefore-property-samlwriter-component) | Time moment before which the subject cannot be confirmed. |
| [SubjectConfirmationNotOnOrAfter](#subjectconfirmationnotonorafter-property-samlwriter-component) | Limits the time until which the subject can be confirmed. |
| [SubjectConfirmationRecipient](#subjectconfirmationrecipient-property-samlwriter-component) | The URI of the entity or the location of the resource to which the assertion should be presented. |

## Method List

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

|  |  |
| --- | --- |
| [AddAttribute](#addattribute-method-samlwriter-component) | Adds an attribute to an existing attribute statement. |
| [AddAttributeStatement](#addattributestatement-method-samlwriter-component) | Adds an attribute statement to the assertion. |
| [AddAuthnStatement](#addauthnstatement-method-samlwriter-component) | Adds an authentication statement to the assertion. |
| [AddAuthzDecisionStatement](#addauthzdecisionstatement-method-samlwriter-component) | Adds an authorization decision statement to the assertion. |
| [AddCondition](#addcondition-method-samlwriter-component) | Adds a condition to the object (assertion or authn request) being edited. |
| [AddScopingIDP](#addscopingidp-method-samlwriter-component) | Adds a scoping IDP to the object being currently edited. |
| [AddSubjectConfirmation](#addsubjectconfirmation-method-samlwriter-component) | Adds a subject confirmation to the object being edited. |
| [BeginAssertion](#beginassertion-method-samlwriter-component) | Initiates the process of creating a new assertion. |
| [CompleteAssertion](#completeassertion-method-samlwriter-component) | Adds a completed assertion to a SAML message. |
| [Config](#config-method-samlwriter-component) | Sets or retrieves a configuration setting. |
| [CreateNew](#createnew-method-samlwriter-component) | Creates a new SAML message with the given type. |
| [DoAction](#doaction-method-samlwriter-component) | Performs an additional action. |
| [FormatID](#formatid-method-samlwriter-component) | Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields. |
| [Reset](#reset-method-samlwriter-component) | Resets the component settings. |
| [Save](#save-method-samlwriter-component) | Saves the configured message to a string. |
| [SaveBytes](#savebytes-method-samlwriter-component) | Saves the configured message to a byte array. |
| [SaveFile](#savefile-method-samlwriter-component) | Saves the configured message to a file. |

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

|  |  |
| --- | --- |
| [Error](#error-event-samlwriter-component) | Fires to report an error condition. |
| [Notification](#notification-event-samlwriter-component) | This event notifies the application about an underlying control flow event. |

## Config Settings

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

|  |  |
| --- | --- |
| [BodyOnly](#BodyOnly) | TBD. |
| [DateTimeFormat](#DateTimeFormat) | TBD. |
| [KeyDataElements](#KeyDataElements) | TBD. |
| [SAMLPrefix](#SAMLPrefix) | TBD. |
| [SAMLProtocolPrefix](#SAMLProtocolPrefix) | TBD. |
| [SigAfterIssuer](#SigAfterIssuer) | Specifies whether to insert the signature after the issuer tag in the SAML document. |
| [SigCanonicalizationMethod](#SigCanonicalizationMethod) | TBD. |
| [SigDigestMethod](#SigDigestMethod) | TBD. |
| [SigMethod](#SigMethod) | TBD. |
| [TimeZoneOffset](#TimeZoneOffset) | TBD. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the component. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client components created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client components should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# ArtifactEndpointIndex Property ([SAMLWriter](#samlwriter-component) Component)

An accessor to the EndpointIndex entry of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

An accessor to the MessageHandle property of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Returns the contents of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

An accessor to the SourceID property of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The TypeCode property of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#artifactremainingartifact-property-samlwriter-component), [ArtifactSourceID](#artifactsourceid-property-samlwriter-component), and [ArtifactMessageHandle](#artifactmessagehandle-property-samlwriter-component) parameters.

This property is not available at design time.

## Data Type

Integer

# ArtifactURI Property ([SAMLWriter](#samlwriter-component) Component)

An accessor to the URI property of the artifact.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the artifact resolve query.

## Syntax

*C++ Builder Syntax*

```text
__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

# AssertionType Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the type of the assertion.

## Syntax

*C++ Builder Syntax*

```text
__property TsbxSAMLWriterAssertionTypes AssertionType = { read=FAssertionType, write=FSetAssertionType };
enum TsbxSAMLWriterAssertionTypes {
  csatAssertionIDRef=0,
  csatAssertionURIRef=1,
  csatAssertion=2,
  csatEncryptedAssertion=3
};
```

## Default Value

csatAssertion

## Remarks

Specifies the type of the assertion.

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

This property is not available at design time.

## Data Type

Integer

# AssertionEncryptedContent Property ([SAMLWriter](#samlwriter-component) Component)

Represents the encrypted assertion content.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Represents the ID of the assertion.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Represents an ID reference value.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the assertion issuance time stamp.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the assertion issuer.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The outcome of the cryptographic signature validation.

## Syntax

*C++ Builder Syntax*

```text
__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:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

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

## Data Type

Integer

# AssertionSigned Property ([SAMLWriter](#samlwriter-component) Component)

Specifies whether the assertion is signed.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the assertion subject.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Represents an URI reference value.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the SAML protocol version used.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Returns the number of assertions in the message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The number of records in the Attribute arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [AttributeFriendlyName](#attributefriendlyname-property-samlwriter-component)
- [AttributeName](#attributename-property-samlwriter-component)
- [AttributeNameFormat](#attributenameformat-property-samlwriter-component)
- [AttributeStatementIndex](#attributestatementindex-property-samlwriter-component)
- [AttributeValues](#attributevalues-property-samlwriter-component)

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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#attributecount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# AttributeName Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the name of the attribute.

## Syntax

*C++ Builder Syntax*

```text
__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](#attributecount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# AttributeNameFormat Property ([SAMLWriter](#samlwriter-component) Component)

Indicates the format used to reference the attribute.

## Syntax

*C++ Builder Syntax*

```text
__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](#attributecount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# AttributeStatementIndex Property ([SAMLWriter](#samlwriter-component) Component)

Contains the index of the statement the attribute corresponds to.

## Syntax

*C++ Builder Syntax*

```text
__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](#attributecount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

Integer

# AttributeValues Property ([SAMLWriter](#samlwriter-component) Component)

Contains a list of attribute values.

## Syntax

*C++ Builder Syntax*

```text
__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](#attributecount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# AuthnQueryComparison Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication context comparison method.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the context class reference.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the context reference type.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the index of the session to the authentication entity.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the assertion consumer service index.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the assertion consumer service URL.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the attribute consuming service index.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Provides access to the authentication context class references.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the AuthnContext comparison method.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the context reference type.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Adjusts secondary serialization properties.

## Syntax

*C++ Builder Syntax*

```text
__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:

|  |  |  |
| --- | --- | --- |
| arfAllowCreate | 1 | Enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record |
| arfForceAuthn | 2 | Enforces inclusion of the ForceAuthn element |
| arfIsPassive | 4 | Enforces saving of IsPassive element |

This property is not available at design time.

## Data Type

Integer

# AuthnRequestForceAuthn Property ([SAMLWriter](#samlwriter-component) Component)

Corresponds to the ForceAuthn parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Maps to the IsPassive parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Matches to the SP name qualifier attribute of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the name of the requestor.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the list of actions included in the query.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Matches the Resource element of the query.

## Syntax

*C++ Builder Syntax*

```text
__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

# BindingType Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the type of SAML binding to use.

## Syntax

*C++ Builder Syntax*

```text
__property TsbxSAMLWriterBindingTypes BindingType = { read=FBindingType, write=FSetBindingType };
enum TsbxSAMLWriterBindingTypes {
  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](#samlwriter-component) Component)

Contains the POST binding form body.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the message encoding.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Enforces a signature over all outgoing messages.

## Syntax

*C++ Builder Syntax*

```text
__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](#SAMLWriter_p_BindingSign).

This property is not available at design time.

## Data Type

Boolean

# BindingFormTemplate Property ([SAMLWriter](#samlwriter-component) Component)

Contains the XHTML form template returned by the service provider.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the RelayState parameter of the binding.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the signature algorithm.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The outcome of the cryptographic signature validation.

## Syntax

*C++ Builder Syntax*

```text
__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:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

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

## Data Type

Integer

# BindingSigned Property ([SAMLWriter](#samlwriter-component) Component)

Specifies whether to sign the binding.

## Syntax

*C++ Builder Syntax*

```text
__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](#bindingforcesign-property-samlwriter-component) property to enforce signatures on all binding entities.

This property is not available at design time.

## Data Type

Boolean

# BindingURL Property ([SAMLWriter](#samlwriter-component) Component)

Contains the URL of the request query.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Instructs the component whether to verify incoming signatures.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is not available at design time.

## Data Type

Long64

# ConditionCount Property ([SAMLWriter](#samlwriter-component) Component)

The number of records in the Condition arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [Condition](#condition-property-samlwriter-component)
- [ConditionType](#conditiontype-property-samlwriter-component)

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

This property is not available at design time.

## Data Type

Integer

# Condition Property ([SAMLWriter](#samlwriter-component) Component)

The condition set in accordance with the ConditionType .

## Syntax

*C++ Builder Syntax*

```text
__property String Condition[int ConditionIndex] = { read=FCondition, write=FSetCondition };
```

## Default Value

""

## Remarks

The condition set in accordance with the [ConditionType](#conditiontype-property-samlwriter-component).

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](#conditioncount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# ConditionType Property ([SAMLWriter](#samlwriter-component) Component)

Specifies a type of the condition object.

## Syntax

*C++ Builder Syntax*

```text
__property TsbxSAMLWriterConditionTypes ConditionType[int ConditionIndex] = { read=FConditionType, write=FSetConditionType };
enum TsbxSAMLWriterConditionTypes {
  csctAudienceRestriction=0,
  csctOneTimeUse=1,
  csctProxyRestriction=2,
  csctNotBefore=3,
  csctNotOnOrAfter=4
};
```

## Default Value

csctAudienceRestriction

## Remarks

Specifies a type of the condition object.

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

The *ConditionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConditionCount](#conditioncount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

Integer

# EncryptionCertBytes Property ([SAMLWriter](#samlwriter-component) Component)

Returns the raw certificate data in DER format.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is not available at design time.

## Data Type

Long64

# FIPSMode Property ([SAMLWriter](#samlwriter-component) Component)

Reserved.

## Syntax

*C++ Builder Syntax*

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

## Default Value

false

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# LogoutRequestNameID Property ([SAMLWriter](#samlwriter-component) Component)

Contains the value of the NameID parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the NotOnOrAfter parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the Reason parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the list of session indices.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the NameID parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the NewEncryptedID parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the NewID parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of the Terminate parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the Consent parameter of the SAML message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Returns the SAML type of the current message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the Destination parameter of the SAML message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The ID of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the InResponseTo property of the SAML request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains request issuance timestamp.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Sets the issuer of the message.

## Syntax

*C++ Builder Syntax*

```text
__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,

```text
  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](#samlwriter-component) Component)

The outcome of the cryptographic signature validation.

## Syntax

*C++ Builder Syntax*

```text
__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:

|  |  |  |
| --- | --- | --- |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |

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

## Data Type

Integer

# MessageSigned Property ([SAMLWriter](#samlwriter-component) Component)

Specifies whether the SAML message is or should be signed.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Gets or sets the subject of the message.

## Syntax

*C++ Builder Syntax*

```text
__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,

```text
  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](#samlwriter-component) Component)

Specifies the protocol version to use for the SAML message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Controls the inclusion of an XML header in the message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

An accessor to the NameID parameter of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the value of AllowCreate parameter of the NameIDPolicy object.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the format of the NameIDPolicy element.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the SPNameQualifier parameter of the NameIDPolicy element.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the References entry of the SAML AssertionIDRequest message.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the NameID parameter of a NameIDMapping response.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

An optional message element to be returned with the response.

## Syntax

*C++ Builder Syntax*

```text
__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

# ResponseType Property ([SAMLWriter](#samlwriter-component) Component)

Contains the type of the response.

## Syntax

*C++ Builder Syntax*

```text
__property TsbxSAMLWriterResponseTypes ResponseType = { read=FResponseType, write=FSetResponseType };
enum TsbxSAMLWriterResponseTypes {
  csrtResponse=0,
  csrtArtifactResponse=1,
  csrtNameIDMappingResponse=2,
  csrtLogoutResponse=3
};
```

## 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](#samlwriter-component) Component)

Gets or sets the status of the response.

## Syntax

*C++ Builder Syntax*

```text
__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](#responsestatuscodevalue-property-samlwriter-component) 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](#responsestatuscodevalue-property-samlwriter-component) and [ResponseStatusCodeSubValue](#responsestatuscodesubvalue-property-samlwriter-component) properties.

This property is not available at design time.

## Data Type

Integer

# ResponseStatusCodeSubValue Property ([SAMLWriter](#samlwriter-component) Component)

The value of the nested StatusCode.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains the status code value.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains additional information on the status of the request.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Contains a status message (optional).

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The number of records in the ScopingIDP arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [ScopingIDPLoc](#scopingidploc-property-samlwriter-component)
- [ScopingIDPName](#scopingidpname-property-samlwriter-component)
- [ScopingIDPProviderID](#scopingidpproviderid-property-samlwriter-component)

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](#samlwriter-component) Component)

Contains the value of the Loc attribute.

## Syntax

*C++ Builder Syntax*

```text
__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](#scopingidpcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# ScopingIDPName Property ([SAMLWriter](#samlwriter-component) Component)

Contains the name of the IdP provider.

## Syntax

*C++ Builder Syntax*

```text
__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](#scopingidpcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# ScopingIDPProviderID Property ([SAMLWriter](#samlwriter-component) Component)

Contains the provider ID.

## Syntax

*C++ Builder Syntax*

```text
__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](#scopingidpcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SecurityCanonicalizationMethod Property ([SAMLWriter](#samlwriter-component) Component)

The canonicalization method to use in the signature.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The digest method to use.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

The encryption method used to encrypt the assertion.

## Syntax

*C++ Builder Syntax*

```text
__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:

|  |  |  |
| --- | --- | --- |
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 |  |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES |  |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 |  |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 |  |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |  |

This property is not available at design time.

## Data Type

String

# SecurityFlags Property ([SAMLWriter](#samlwriter-component) Component)

Provides access to secondary security parameters and tweaks.

## Syntax

*C++ Builder Syntax*

```text
__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 | 1 | Place the Signature tag after the issuer tag in the XML document |
| ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata |
| ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element |
| ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element |
| ssfKeyDataSubjectName | 16 | Include the SubjectName key data element |
| ssfKeyDataCertificate | 32 | Include the Certificate key data element |
| ssfKeyDataCRL | 64 | Include the CRL key data element |
| ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) |
| ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests |
| ssfSignLogoutRequests | 262144 | Sign logout requests |
| ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) |
| ssfSignResponses | 1048576 | Sign all responses (IdP only) |
| ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) |

This property is not available at design time.

## Data Type

Integer

# SecuritySigMethod Property ([SAMLWriter](#samlwriter-component) Component)

The signature method to use.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Specifies the signature validation policy.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

Returns the raw certificate data in DER format.

## Syntax

*C++ Builder Syntax*

```text
__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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is not available at design time.

## Data Type

Long64

# SigningChainCount Property ([SAMLWriter](#samlwriter-component) Component)

The number of records in the SigningChain arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SigningChainBytes](#signingchainbytes-property-samlwriter-component)
- [SigningChainHandle](#signingchainhandle-property-samlwriter-component)

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](#samlwriter-component) Component)

Returns the raw certificate data in DER format.

## Syntax

*C++ Builder Syntax*

```text
__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](#signingchaincount-property-samlwriter-component) property.

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

## Data Type

Byte Array

# SigningChainHandle Property ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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.

```text
  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](#signingchaincount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

Long64

# StatementCount Property ([SAMLWriter](#samlwriter-component) Component)

The number of records in the Statement arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [StatementAuthnContextAuthenticatingAuthorities](#statementauthncontextauthenticatingauthorities-property-samlwriter-component)
- [StatementAuthnContextChoice](#statementauthncontextchoice-property-samlwriter-component)
- [StatementAuthnContextClassRef](#statementauthncontextclassref-property-samlwriter-component)
- [StatementAuthnContextDecl](#statementauthncontextdecl-property-samlwriter-component)
- [StatementAuthnContextDeclRef](#statementauthncontextdeclref-property-samlwriter-component)
- [StatementAuthnInstant](#statementauthninstant-property-samlwriter-component)
- [StatementAuthnSessionIndex](#statementauthnsessionindex-property-samlwriter-component)
- [StatementAuthnSessionNotOnOrAfter](#statementauthnsessionnotonorafter-property-samlwriter-component)
- [StatementAuthnSubjectLocalityAddress](#statementauthnsubjectlocalityaddress-property-samlwriter-component)
- [StatementAuthnSubjectLocalityDNSName](#statementauthnsubjectlocalitydnsname-property-samlwriter-component)
- [StatementAuthzActions](#statementauthzactions-property-samlwriter-component)
- [StatementAuthzDecision](#statementauthzdecision-property-samlwriter-component)
- [StatementAuthzDecisionEvidence](#statementauthzdecisionevidence-property-samlwriter-component)
- [StatementAuthzDecisionResource](#statementauthzdecisionresource-property-samlwriter-component)
- [StatementType](#statementtype-property-samlwriter-component)

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](#samlwriter-component) Component)

Contains the list of authenticating authorities.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnContextChoice Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication context choice variant.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnContextClassRef Property ([SAMLWriter](#samlwriter-component) Component)

Indicates the authentication contexts class reference.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnContextDecl Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication contexts declaration.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnContextDeclRef Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication contexts declaration reference.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnInstant Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication event timestamp.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnSessionIndex Property ([SAMLWriter](#samlwriter-component) Component)

Contains the authentication session index.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnSessionNotOnOrAfter Property ([SAMLWriter](#samlwriter-component) Component)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnSubjectLocalityAddress Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authentication subjects address.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthnSubjectLocalityDNSName Property ([SAMLWriter](#samlwriter-component) Component)

Maps to the authentication subjects DNS name parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthzActions Property ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthzDecision Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authorization decision.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

Integer

# StatementAuthzDecisionEvidence Property ([SAMLWriter](#samlwriter-component) Component)

Manages the authorization decision statement evidence parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementAuthzDecisionResource Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the authorization decision statement resource parameter.

## Syntax

*C++ Builder Syntax*

```text
__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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# StatementType Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the assertion statement type.

## Syntax

*C++ Builder Syntax*

```text
__property TsbxSAMLWriterStatementTypes StatementType[int StatementIndex] = { read=FStatementType, write=FSetStatementType };
enum TsbxSAMLWriterStatementTypes {
  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](#statementcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

Integer

# SubjectConfirmationCount Property ([SAMLWriter](#samlwriter-component) Component)

The number of records in the SubjectConfirmation arrays.

## Syntax

*C++ Builder Syntax*

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

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SubjectConfirmationAddress](#subjectconfirmationaddress-property-samlwriter-component)
- [SubjectConfirmationData](#subjectconfirmationdata-property-samlwriter-component)
- [SubjectConfirmationDataType](#subjectconfirmationdatatype-property-samlwriter-component)
- [SubjectConfirmationID](#subjectconfirmationid-property-samlwriter-component)
- [SubjectConfirmationInResponseTo](#subjectconfirmationinresponseto-property-samlwriter-component)
- [SubjectConfirmationMethod](#subjectconfirmationmethod-property-samlwriter-component)
- [SubjectConfirmationNotBefore](#subjectconfirmationnotbefore-property-samlwriter-component)
- [SubjectConfirmationNotOnOrAfter](#subjectconfirmationnotonorafter-property-samlwriter-component)
- [SubjectConfirmationRecipient](#subjectconfirmationrecipient-property-samlwriter-component)

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](#samlwriter-component) Component)

Contains the address enabled for presenting assertions.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationData Property ([SAMLWriter](#samlwriter-component) Component)

The uninterpreted value of data entry in the subject confirmation.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationDataType Property ([SAMLWriter](#samlwriter-component) Component)

The type of data contained in the confirmation.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationID Property ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationInResponseTo Property ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationMethod Property ([SAMLWriter](#samlwriter-component) Component)

Specifies the mechanism to be used to confirm the subject.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationNotBefore Property ([SAMLWriter](#samlwriter-component) Component)

Time moment before which the subject cannot be confirmed.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationNotOnOrAfter Property ([SAMLWriter](#samlwriter-component) Component)

Limits the time until which the subject can be confirmed.

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# SubjectConfirmationRecipient Property ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
__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](#subjectconfirmationcount-property-samlwriter-component) property.

This property is not available at design time.

## Data Type

String

# AddAttribute Method ([SAMLWriter](#samlwriter-component) Component)

Adds an attribute to an existing attribute statement.

## Syntax

*C++ Builder Syntax*

```text
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:

```text
  <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](#samlwriter-component) Component)

Adds an attribute statement to the assertion.

## Syntax

*C++ Builder Syntax*

```text
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](#addattribute-method-samlwriter-component) adds a new attribute statement behind the scenes if no attribute statements have been added by that time.

# AddAuthnStatement Method ([SAMLWriter](#samlwriter-component) Component)

Adds an authentication statement to the assertion.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

Adds an authorization decision statement to the assertion.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

Adds a scoping IDP to the object being currently edited.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

Adds a subject confirmation to the object being edited.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

Initiates the process of creating a new assertion.

## Syntax

*C++ Builder Syntax*

```text
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](#completeassertion-method-samlwriter-component) to commit the provided details to the message.

# CompleteAssertion Method ([SAMLWriter](#samlwriter-component) Component)

Adds a completed assertion to a SAML message.

## Syntax

*C++ Builder Syntax*

```text
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](#beginassertion-method-samlwriter-component) 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](#samlwriter-component) Component)

Sets or retrieves a configuration setting.

## Syntax

*C++ Builder Syntax*

```text
String __fastcall Config(String ConfigurationString);
```

## Remarks

Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-samlwriter-component) 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](#config-settings-samlwriter-component), you must call *Config("PROPERTY")*. The value will be returned as a string.

# CreateNew Method ([SAMLWriter](#samlwriter-component) Component)

Creates a new SAML message with the given type.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

Performs an additional action.

## Syntax

*C++ Builder Syntax*

```text
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;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# FormatID Method ([SAMLWriter](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
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:

```text
  // 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](#samlwriter-component) Component)

Resets the component settings.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall Reset();
```

## Remarks

Reset is a generic method available in every component.

# Save Method ([SAMLWriter](#samlwriter-component) Component)

Saves the configured message to a string.

## Syntax

*C++ Builder Syntax*

```text
String __fastcall Save();
```

## Remarks

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

# SaveBytes Method ([SAMLWriter](#samlwriter-component) Component)

Saves the configured message to a byte array.

## Syntax

*C++ Builder Syntax*

```text
DynamicArray<Byte> __fastcall SaveBytes();
```

## Remarks

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

# SaveFile Method ([SAMLWriter](#samlwriter-component) Component)

Saves the configured message to a file.

## Syntax

*C++ Builder Syntax*

```text
void __fastcall SaveFile(String FileName);
```

## Remarks

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

# Error Event ([SAMLWriter](#samlwriter-component) Component)

Fires to report an error condition.

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) Component)

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

## Syntax

*C++ Builder Syntax*

```text
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](#samlwriter-component) 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](#config-method-samlwriter-component) method.

### SAMLWriter Config Settings

**BodyOnly**: TBD.TBD

**DateTimeFormat**: TBD.TBD

**KeyDataElements**: TBD.TBD

**SAMLPrefix**: TBD.TBD

**SAMLProtocolPrefix**: TBD.TBD

**SigAfterIssuer**: Specifies whether to insert the signature after the issuer tag in the SAML document.Use this setting to tune up the location of the signature tag in the resulting document. The default value is true.

**SigCanonicalizationMethod**: TBD.TBD

**SigDigestMethod**: TBD.TBD

**SigMethod**: TBD.TBD

**TimeZoneOffset**: TBD.TBD

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([SAMLWriter](#samlwriter-component) Component)