# Struct secureblackbox::SAMLWriter
The SAMLWriter struct offers SAML message generation functions.
## Syntax
```text
secureblackbox::SAMLWriter
```
## 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
https://issuer-url.com
+xhhgXtwYN0/r9h7WAwg=
jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
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
```
Note that you need to set the signing certificate before calling [create_new](#create_new-method-samlwriter-struct).
### Object Lifetime
The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the SAMLWriter struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SAMLWriter when you have finished using the instance.
## Property List
*The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [artifact_endpoint_index](#artifact_endpoint_index-property-samlwriter-struct) | An accessor to the EndpointIndex entry of the artifact. |
| [artifact_message_handle](#artifact_message_handle-property-samlwriter-struct) | An accessor to the MessageHandle property of the artifact. |
| [artifact_remaining_artifact](#artifact_remaining_artifact-property-samlwriter-struct) | Returns the contents of the artifact. |
| [artifact_source_id](#artifact_source_id-property-samlwriter-struct) | An accessor to the SourceID property of the artifact. |
| [artifact_type_code](#artifact_type_code-property-samlwriter-struct) | The TypeCode property of the artifact. |
| [artifact_uri](#artifact_uri-property-samlwriter-struct) | An accessor to the URI property of the artifact. |
| [artifact_resolve_query](#artifact_resolve_query-property-samlwriter-struct) | Contains the artifact resolve query. |
| [assertion_type](#assertion_type-property-samlwriter-struct) | Specifies the type of the assertion. |
| [assertion_encrypted_content](#assertion_encrypted_content-property-samlwriter-struct) | Represents the encrypted assertion content. |
| [assertion_id](#assertion_id-property-samlwriter-struct) | Represents the ID of the assertion. |
| [assertion_id_ref](#assertion_id_ref-property-samlwriter-struct) | Represents an ID reference value. |
| [assertion_issue_instant](#assertion_issue_instant-property-samlwriter-struct) | Contains the assertion issuance time stamp. |
| [assertion_issuer](#assertion_issuer-property-samlwriter-struct) | Specifies the assertion issuer. |
| [assertion_parent_assertion](#assertion_parent_assertion-property-samlwriter-struct) | Contains the index of the parent assertion in the assertion list. |
| [assertion_signature_validation_result](#assertion_signature_validation_result-property-samlwriter-struct) | The outcome of the cryptographic signature validation. |
| [assertion_signed](#assertion_signed-property-samlwriter-struct) | Specifies whether the assertion is signed. |
| [assertion_subject](#assertion_subject-property-samlwriter-struct) | Specifies the assertion subject. |
| [assertion_uri_ref](#assertion_uri_ref-property-samlwriter-struct) | Represents an URI reference value. |
| [assertion_version](#assertion_version-property-samlwriter-struct) | Specifies the SAML protocol version used. |
| [assertion_count](#assertion_count-property-samlwriter-struct) | Returns the number of assertions in the message. |
| [attribute_count](#attribute_count-property-samlwriter-struct) | The number of records in the Attribute arrays. |
| [attribute_friendly_name](#attribute_friendly_name-property-samlwriter-struct) | Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e. |
| [attribute_name](#attribute_name-property-samlwriter-struct) | Specifies the name of the attribute. |
| [attribute_name_format](#attribute_name_format-property-samlwriter-struct) | Indicates the format used to reference the attribute. |
| [attribute_statement_index](#attribute_statement_index-property-samlwriter-struct) | Contains the index of the statement the attribute corresponds to. |
| [attribute_values](#attribute_values-property-samlwriter-struct) | Contains a list of attribute values. |
| [authn_query_comparison](#authn_query_comparison-property-samlwriter-struct) | Specifies the authentication context comparison method. |
| [authn_query_context_class_refs](#authn_query_context_class_refs-property-samlwriter-struct) | Specifies the context class reference. |
| [authn_query_ref_type](#authn_query_ref_type-property-samlwriter-struct) | Specifies the context reference type. |
| [authn_query_session_index](#authn_query_session_index-property-samlwriter-struct) | Specifies the index of the session to the authentication entity. |
| [authn_request_assertion_consumer_service_index](#authn_request_assertion_consumer_service_index-property-samlwriter-struct) | Specifies the assertion consumer service index. |
| [authn_request_assertion_consumer_service_url](#authn_request_assertion_consumer_service_url-property-samlwriter-struct) | Specifies the assertion consumer service URL. |
| [authn_request_attribute_consuming_service_index](#authn_request_attribute_consuming_service_index-property-samlwriter-struct) | Specifies the attribute consuming service index. |
| [authn_request_context_class_refs](#authn_request_context_class_refs-property-samlwriter-struct) | Provides access to the authentication context class references. |
| [authn_request_context_comparison](#authn_request_context_comparison-property-samlwriter-struct) | Specifies the AuthnContext comparison method. |
| [authn_request_context_ref_type](#authn_request_context_ref_type-property-samlwriter-struct) | Specifies the context reference type. |
| [authn_request_flags](#authn_request_flags-property-samlwriter-struct) | Adjusts secondary serialization properties. |
| [authn_request_force_authn](#authn_request_force_authn-property-samlwriter-struct) | Corresponds to the ForceAuthn parameter of the request. |
| [authn_request_is_passive](#authn_request_is_passive-property-samlwriter-struct) | Maps to the IsPassive parameter of the request. |
| [authn_request_name_id_policy_allow_create](#authn_request_name_id_policy_allow_create-property-samlwriter-struct) | Matches the AllowCreate attribute of NameIDPolicy element of the request. |
| [authn_request_name_id_policy_format](#authn_request_name_id_policy_format-property-samlwriter-struct) | Matches to the Format attribute of the NameIDPolicy element of the request. |
| [authn_request_name_id_policy_sp_name_qualifier](#authn_request_name_id_policy_sp_name_qualifier-property-samlwriter-struct) | Matches to the SP name qualifier attribute of the request. |
| [authn_request_protocol_binding](#authn_request_protocol_binding-property-samlwriter-struct) | Specifies the protocol binding to be requested in the authentication request. |
| [authn_request_provider_name](#authn_request_provider_name-property-samlwriter-struct) | Specifies the name of the requestor. |
| [authn_request_scoping_get_complete](#authn_request_scoping_get_complete-property-samlwriter-struct) | Matches the GetComplete element of the IDPList entry of the Scoping object. |
| [authn_request_scoping_proxy_count](#authn_request_scoping_proxy_count-property-samlwriter-struct) | The maximum number of proxies on the way between the requestor and the provider. |
| [authn_request_scoping_requester_i_ds](#authn_request_scoping_requester_i_ds-property-samlwriter-struct) | A collection of requestor IDs on whose behalf the request is being sent. |
| [authz_decision_query_actions](#authz_decision_query_actions-property-samlwriter-struct) | Specifies the list of actions included in the query. |
| [authz_decision_query_resource](#authz_decision_query_resource-property-samlwriter-struct) | Matches the Resource element of the query. |
| [binding_type](#binding_type-property-samlwriter-struct) | Specifies the type of SAML binding to use. |
| [binding_body](#binding_body-property-samlwriter-struct) | Contains the POST binding form body. |
| [binding_encoding](#binding_encoding-property-samlwriter-struct) | Specifies the message encoding. |
| [binding_force_sign](#binding_force_sign-property-samlwriter-struct) | Enforces a signature over all outgoing messages. |
| [binding_form_template](#binding_form_template-property-samlwriter-struct) | Contains the XHTML form template returned by the service provider. |
| [binding_post_mode](#binding_post_mode-property-samlwriter-struct) | Specifies whether binding is applied on the server, or on the client side. |
| [binding_relay_state](#binding_relay_state-property-samlwriter-struct) | Contains the RelayState parameter of the binding. |
| [binding_signature_algorithm](#binding_signature_algorithm-property-samlwriter-struct) | Contains the signature algorithm. |
| [binding_signature_validation_result](#binding_signature_validation_result-property-samlwriter-struct) | The outcome of the cryptographic signature validation. |
| [binding_signed](#binding_signed-property-samlwriter-struct) | Specifies whether to sign the binding. |
| [binding_url](#binding_url-property-samlwriter-struct) | Contains the URL of the request query. |
| [binding_verify_signatures](#binding_verify_signatures-property-samlwriter-struct) | Instructs the struct whether to verify incoming signatures. |
| [binding_key_handle](#binding_key_handle-property-samlwriter-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [condition_count](#condition_count-property-samlwriter-struct) | The number of records in the Condition arrays. |
| [condition](#condition-property-samlwriter-struct) | The condition set in accordance with the ConditionType . |
| [condition_type](#condition_type-property-samlwriter-struct) | Specifies a type of the condition object. |
| [encryption_cert_bytes](#encryption_cert_bytes-property-samlwriter-struct) | Returns the raw certificate data in DER format. |
| [encryption_cert_handle](#encryption_cert_handle-property-samlwriter-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [fips_mode](#fips_mode-property-samlwriter-struct) | Reserved. |
| [logout_request_name_id](#logout_request_name_id-property-samlwriter-struct) | Contains the value of the NameID parameter. |
| [logout_request_not_on_or_after](#logout_request_not_on_or_after-property-samlwriter-struct) | Contains the value of the NotOnOrAfter parameter. |
| [logout_request_reason](#logout_request_reason-property-samlwriter-struct) | Contains the value of the Reason parameter. |
| [logout_request_session_indexes](#logout_request_session_indexes-property-samlwriter-struct) | Contains the list of session indices. |
| [manage_name_id_request_name_id](#manage_name_id_request_name_id-property-samlwriter-struct) | Contains the value of the NameID parameter of the request. |
| [manage_name_id_request_new_encrypted_id](#manage_name_id_request_new_encrypted_id-property-samlwriter-struct) | Contains the value of the NewEncryptedID parameter of the request. |
| [manage_name_id_request_new_id](#manage_name_id_request_new_id-property-samlwriter-struct) | Contains the value of the NewID parameter. |
| [manage_name_id_request_terminate](#manage_name_id_request_terminate-property-samlwriter-struct) | Contains the value of the Terminate parameter of the request. |
| [message_consent](#message_consent-property-samlwriter-struct) | Contains the Consent parameter of the SAML message. |
| [message_content_type](#message_content_type-property-samlwriter-struct) | Returns the SAML type of the current message. |
| [message_content_type_string](#message_content_type_string-property-samlwriter-struct) | Returns the type of the processed message, as an original string. |
| [message_destination](#message_destination-property-samlwriter-struct) | Contains the Destination parameter of the SAML message. |
| [message_id](#message_id-property-samlwriter-struct) | The ID of the request. |
| [message_in_response_to](#message_in_response_to-property-samlwriter-struct) | Contains the InResponseTo property of the SAML request. |
| [message_issue_instant](#message_issue_instant-property-samlwriter-struct) | Contains request issuance timestamp. |
| [message_issuer](#message_issuer-property-samlwriter-struct) | Sets the issuer of the message. |
| [message_signature_validation_result](#message_signature_validation_result-property-samlwriter-struct) | The outcome of the cryptographic signature validation. |
| [message_signed](#message_signed-property-samlwriter-struct) | Specifies whether the SAML message is or should be signed. |
| [message_subject](#message_subject-property-samlwriter-struct) | Gets or sets the subject of the message. |
| [message_version](#message_version-property-samlwriter-struct) | Specifies the protocol version to use for the SAML message. |
| [message_xml_header](#message_xml_header-property-samlwriter-struct) | Controls the inclusion of an XML header in the message. |
| [name_id_mapping_request_name_id](#name_id_mapping_request_name_id-property-samlwriter-struct) | An accessor to the NameID parameter of the request. |
| [name_id_mapping_request_name_id_policy_allow_create](#name_id_mapping_request_name_id_policy_allow_create-property-samlwriter-struct) | Contains the value of AllowCreate parameter of the NameIDPolicy object. |
| [name_id_mapping_request_name_id_policy_format](#name_id_mapping_request_name_id_policy_format-property-samlwriter-struct) | Specifies the format of the NameIDPolicy element. |
| [name_id_mapping_request_name_id_policy_sp_name_qualifier](#name_id_mapping_request_name_id_policy_sp_name_qualifier-property-samlwriter-struct) | Contains the SPNameQualifier parameter of the NameIDPolicy element. |
| [name_id_mapping_request_name_id_policy_use_allow_create](#name_id_mapping_request_name_id_policy_use_allow_create-property-samlwriter-struct) | Controls inclusion of UseAllow modifier in the NameIDPolicy object. |
| [profile](#profile-property-samlwriter-struct) | Specifies a pre-defined profile to apply when creating the signature. |
| [references](#references-property-samlwriter-struct) | Contains the References entry of the SAML AssertionIDRequest message. |
| [response_name_id](#response_name_id-property-samlwriter-struct) | Contains the NameID parameter of a NameIDMapping response. |
| [response_optional_element](#response_optional_element-property-samlwriter-struct) | An optional message element to be returned with the response. |
| [response_type](#response_type-property-samlwriter-struct) | Contains the type of the response. |
| [response_status](#response_status-property-samlwriter-struct) | Gets or sets the status of the response. |
| [response_status_code_sub_value](#response_status_code_sub_value-property-samlwriter-struct) | The value of the nested StatusCode. |
| [response_status_code_value](#response_status_code_value-property-samlwriter-struct) | Contains the status code value. |
| [response_status_detail](#response_status_detail-property-samlwriter-struct) | Contains additional information on the status of the request. |
| [response_status_message](#response_status_message-property-samlwriter-struct) | Contains a status message (optional). |
| [scoping_idp_count](#scoping_idp_count-property-samlwriter-struct) | The number of records in the ScopingIDP arrays. |
| [scoping_idp_loc](#scoping_idp_loc-property-samlwriter-struct) | Contains the value of the Loc attribute. |
| [scoping_idp_name](#scoping_idp_name-property-samlwriter-struct) | Contains the name of the IdP provider. |
| [scoping_idp_provider_id](#scoping_idp_provider_id-property-samlwriter-struct) | Contains the provider ID. |
| [security_canonicalization_method](#security_canonicalization_method-property-samlwriter-struct) | The canonicalization method to use in the signature. |
| [security_digest_method](#security_digest_method-property-samlwriter-struct) | The digest method to use. |
| [security_encryption_method](#security_encryption_method-property-samlwriter-struct) | The encryption method used to encrypt the assertion. |
| [security_flags](#security_flags-property-samlwriter-struct) | Provides access to secondary security parameters and tweaks. |
| [security_sig_method](#security_sig_method-property-samlwriter-struct) | The signature method to use. |
| [security_signature_policy](#security_signature_policy-property-samlwriter-struct) | Specifies the signature validation policy. |
| [signing_cert_bytes](#signing_cert_bytes-property-samlwriter-struct) | Returns the raw certificate data in DER format. |
| [signing_cert_handle](#signing_cert_handle-property-samlwriter-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [signing_chain_count](#signing_chain_count-property-samlwriter-struct) | The number of records in the SigningChain arrays. |
| [signing_chain_bytes](#signing_chain_bytes-property-samlwriter-struct) | Returns the raw certificate data in DER format. |
| [signing_chain_handle](#signing_chain_handle-property-samlwriter-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [statement_count](#statement_count-property-samlwriter-struct) | The number of records in the Statement arrays. |
| [statement_authn_context_authenticating_authorities](#statement_authn_context_authenticating_authorities-property-samlwriter-struct) | Contains the list of authenticating authorities. |
| [statement_authn_context_choice](#statement_authn_context_choice-property-samlwriter-struct) | Specifies the authentication context choice variant. |
| [statement_authn_context_class_ref](#statement_authn_context_class_ref-property-samlwriter-struct) | Indicates the authentication contexts class reference. |
| [statement_authn_context_decl](#statement_authn_context_decl-property-samlwriter-struct) | Specifies the authentication contexts declaration. |
| [statement_authn_context_decl_ref](#statement_authn_context_decl_ref-property-samlwriter-struct) | Specifies the authentication contexts declaration reference. |
| [statement_authn_instant](#statement_authn_instant-property-samlwriter-struct) | Specifies the authentication event timestamp. |
| [statement_authn_session_index](#statement_authn_session_index-property-samlwriter-struct) | Contains the authentication session index. |
| [statement_authn_session_not_on_or_after](#statement_authn_session_not_on_or_after-property-samlwriter-struct) | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
| [statement_authn_subject_locality_address](#statement_authn_subject_locality_address-property-samlwriter-struct) | Specifies the authentication subjects address. |
| [statement_authn_subject_locality_dns_name](#statement_authn_subject_locality_dns_name-property-samlwriter-struct) | Maps to the authentication subjects DNS name parameter. |
| [statement_authz_actions](#statement_authz_actions-property-samlwriter-struct) | Provides access to the list of actions of the authorization statement. |
| [statement_authz_decision](#statement_authz_decision-property-samlwriter-struct) | Specifies the authorization decision. |
| [statement_authz_decision_evidence](#statement_authz_decision_evidence-property-samlwriter-struct) | Manages the authorization decision statement evidence parameter. |
| [statement_authz_decision_resource](#statement_authz_decision_resource-property-samlwriter-struct) | Specifies the authorization decision statement resource parameter. |
| [statement_type](#statement_type-property-samlwriter-struct) | Specifies the assertion statement type. |
| [subject_confirmation_count](#subject_confirmation_count-property-samlwriter-struct) | The number of records in the SubjectConfirmation arrays. |
| [subject_confirmation_address](#subject_confirmation_address-property-samlwriter-struct) | Contains the address enabled for presenting assertions. |
| [subject_confirmation_data](#subject_confirmation_data-property-samlwriter-struct) | The uninterpreted value of data entry in the subject confirmation. |
| [subject_confirmation_data_type](#subject_confirmation_data_type-property-samlwriter-struct) | The type of data contained in the confirmation. |
| [subject_confirmation_id](#subject_confirmation_id-property-samlwriter-struct) | The identifier of the entity which can satisfy the subject confirmation requirements. |
| [subject_confirmation_in_response_to](#subject_confirmation_in_response_to-property-samlwriter-struct) | The ID of the SAML message in response to which the assertion is issued. |
| [subject_confirmation_method](#subject_confirmation_method-property-samlwriter-struct) | Specifies the mechanism to be used to confirm the subject. |
| [subject_confirmation_not_before](#subject_confirmation_not_before-property-samlwriter-struct) | Time moment before which the subject cannot be confirmed. |
| [subject_confirmation_not_on_or_after](#subject_confirmation_not_on_or_after-property-samlwriter-struct) | Limits the time until which the subject can be confirmed. |
| [subject_confirmation_recipient](#subject_confirmation_recipient-property-samlwriter-struct) | 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 struct with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [add_attribute](#add_attribute-method-samlwriter-struct) | Adds an attribute to an existing attribute statement. |
| [add_attribute_statement](#add_attribute_statement-method-samlwriter-struct) | Adds an attribute statement to the assertion. |
| [add_authn_statement](#add_authn_statement-method-samlwriter-struct) | Adds an authentication statement to the assertion. |
| [add_authz_decision_statement](#add_authz_decision_statement-method-samlwriter-struct) | Adds an authorization decision statement to the assertion. |
| [add_condition](#add_condition-method-samlwriter-struct) | Adds a condition to the object (assertion or authn request) being edited. |
| [add_scoping_idp](#add_scoping_idp-method-samlwriter-struct) | Adds a scoping IDP to the object being currently edited. |
| [add_subject_confirmation](#add_subject_confirmation-method-samlwriter-struct) | Adds a subject confirmation to the object being edited. |
| [begin_assertion](#begin_assertion-method-samlwriter-struct) | Initiates the process of creating a new assertion. |
| [complete_assertion](#complete_assertion-method-samlwriter-struct) | Adds a completed assertion to a SAML message. |
| [config](#config-method-samlwriter-struct) | Sets or retrieves a configuration setting. |
| [create_new](#create_new-method-samlwriter-struct) | Creates a new SAML message with the given type. |
| [do_action](#do_action-method-samlwriter-struct) | Performs an additional action. |
| [format_id](#format_id-method-samlwriter-struct) | Formats a SAML ID in the form in which it can be assigned to the Issuer or Subject fields. |
| [reset](#reset-method-samlwriter-struct) | Resets the struct settings. |
| [save](#save-method-samlwriter-struct) | Saves the configured message to a string. |
| [save_bytes](#save_bytes-method-samlwriter-struct) | Saves the configured message to a byte array. |
| [save_file](#save_file-method-samlwriter-struct) | Saves the configured message to a file. |
## Event List
*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [on_error](#on_error-event-samlwriter-struct) | Fires to report an error condition. |
| [on_notification](#on_notification-event-samlwriter-struct) | This event notifies the application about an underlying control flow event. |
## Config Settings
*The following is a list of config settings for the struct 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 struct. |
| [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 structs. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. |
| [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 structs 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 structs 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. |
# artifact_endpoint_index property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An accessor to the EndpointIndex entry of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_endpoint_index(&self ) -> Result fn set_artifact_endpoint_index(&self, value : i32) -> Option
```
## 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.
## Data Type
i32
# artifact_message_handle property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An accessor to the MessageHandle property of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_message_handle(&self ) -> Result, SecureBlackboxError> fn set_artifact_message_handle(&self, value : Vec) -> Option
fn set_artifact_message_handle_ref(&self, value : &[u8]) -> Option
```
## 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.
## Data Type
Vec
# artifact_remaining_artifact property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Returns the contents of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_remaining_artifact(&self ) -> Result, SecureBlackboxError>
```
## 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.
## Data Type
Vec
# artifact_source_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An accessor to the SourceID property of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_source_id(&self ) -> Result, SecureBlackboxError> fn set_artifact_source_id(&self, value : Vec) -> Option
fn set_artifact_source_id_ref(&self, value : &[u8]) -> Option
```
## Remarks
An accessor to the SourceID property of the artifact.
SourceID uniquely identifies the issuer of the artifact.
## Data Type
Vec
# artifact_type_code property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The TypeCode property of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_type_code(&self ) -> Result fn set_artifact_type_code(&self, value : i32) -> Option
```
## 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 [artifact_remaining_artifact](#artifact_remaining_artifact-property-samlwriter-struct), [artifact_source_id](#artifact_source_id-property-samlwriter-struct), and [artifact_message_handle](#artifact_message_handle-property-samlwriter-struct) parameters.
## Data Type
i32
# artifact_uri property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An accessor to the URI property of the artifact.
## Syntax
*Rust Syntax*
```text
fn artifact_uri(&self ) -> Result fn set_artifact_uri(&self, value : &str) -> Option
fn set_artifact_uri_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
An accessor to the URI property of the artifact.
The URI property contains the origin of the artifact.
## Data Type
String
# artifact_resolve_query property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the artifact resolve query.
## Syntax
*Rust Syntax*
```text
fn artifact_resolve_query(&self ) -> Result fn set_artifact_resolve_query(&self, value : &str) -> Option
fn set_artifact_resolve_query_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Use this property to read or set the artifact resolve query.
## Data Type
String
# assertion_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the type of the assertion.
## Syntax
*Rust Syntax*
```text
fn assertion_type(&self ) -> Result fn set_assertion_type(&self, value : i32) -> Option
```
## Possible Values
```text
0 // AssertionIDRef1 // AssertionURIRef2 // Assertion3 // EncryptedAssertion
```
## Default Value
2
## Remarks
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
## Data Type
i32
# assertion_encrypted_content property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Represents the encrypted assertion content.
## Syntax
*Rust Syntax*
```text
fn assertion_encrypted_content(&self ) -> Result fn set_assertion_encrypted_content(&self, value : &str) -> Option
fn set_assertion_encrypted_content_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Represents the encrypted assertion content.
Use this property to get or set the encrypted assertion content.
## Data Type
String
# assertion_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Represents the ID of the assertion.
## Syntax
*Rust Syntax*
```text
fn assertion_id(&self ) -> Result fn set_assertion_id(&self, value : &str) -> Option
fn set_assertion_id_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Represents the ID of the assertion.
Use this property to read or set the unique ID of the assertion.
## Data Type
String
# assertion_id_ref property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Represents an ID reference value.
## Syntax
*Rust Syntax*
```text
fn assertion_id_ref(&self ) -> Result fn set_assertion_id_ref(&self, value : &str) -> Option
fn set_assertion_id_ref_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Represents an ID reference value.
Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.
## Data Type
String
# assertion_issue_instant property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the assertion issuance time stamp.
## Syntax
*Rust Syntax*
```text
fn assertion_issue_instant(&self ) -> Result fn set_assertion_issue_instant(&self, value : &str) -> Option
fn set_assertion_issue_instant_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the assertion issuance time stamp.
Use this property to check or set the assertion issuance time.
## Data Type
String
# assertion_issuer property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the assertion issuer.
## Syntax
*Rust Syntax*
```text
fn assertion_issuer(&self ) -> Result fn set_assertion_issuer(&self, value : &str) -> Option
fn set_assertion_issuer_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the assertion issuer.
Use this property to provide the assertion issuer ID.
## Data Type
String
# assertion_parent_assertion property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the index of the parent assertion in the assertion list.
## Syntax
*Rust Syntax*
```text
fn assertion_parent_assertion(&self ) -> Result fn set_assertion_parent_assertion(&self, value : i32) -> Option
```
## 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.
## Data Type
i32
# assertion_signature_validation_result property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The outcome of the cryptographic signature validation.
## Syntax
*Rust Syntax*
```text
fn assertion_signature_validation_result(&self ) -> Result
```
## Possible Values
```text
0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted
```
## Default Value
0
## 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.
## Data Type
i32
# assertion_signed property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies whether the assertion is signed.
## Syntax
*Rust Syntax*
```text
fn assertion_signed(&self ) -> Result fn set_assertion_signed(&self, value : bool) -> Option
```
## Default Value
false
## Remarks
Specifies whether the assertion is signed.
Use this property to establish whether the assertion is signed.
## Data Type
bool
# assertion_subject property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the assertion subject.
## Syntax
*Rust Syntax*
```text
fn assertion_subject(&self ) -> Result fn set_assertion_subject(&self, value : &str) -> Option
fn set_assertion_subject_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the assertion subject.
Use this property to provide the assertion's subject SAML ID.
## Data Type
String
# assertion_uri_ref property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Represents an URI reference value.
## Syntax
*Rust Syntax*
```text
fn assertion_uri_ref(&self ) -> Result fn set_assertion_uri_ref(&self, value : &str) -> Option
fn set_assertion_uri_ref_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Represents an URI reference value.
Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.
## Data Type
String
# assertion_version property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the SAML protocol version used.
## Syntax
*Rust Syntax*
```text
fn assertion_version(&self ) -> Result fn set_assertion_version(&self, value : &str) -> Option
fn set_assertion_version_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the SAML protocol version used.
This property specifies the SAML protocol version. The default value is *2.0*.
## Data Type
String
# assertion_count property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Returns the number of assertions in the message.
## Syntax
*Rust Syntax*
```text
fn assertion_count(&self ) -> Result
```
## Default Value
0
## Remarks
This property returns the total number of assertions currently defined in the SAML message.
This property is read-only.
## Data Type
i32
# attribute_count property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The number of records in the Attribute arrays.
## Syntax
*Rust Syntax*
```text
fn attribute_count(&self ) -> Result fn set_attribute_count(&self, value : i32) -> Option
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [attribute_friendly_name](#attribute_friendly_name-property-samlwriter-struct)
- [attribute_name](#attribute_name-property-samlwriter-struct)
- [attribute_name_format](#attribute_name_format-property-samlwriter-struct)
- [attribute_statement_index](#attribute_statement_index-property-samlwriter-struct)
- [attribute_values](#attribute_values-property-samlwriter-struct)
The array indices start at *0* and end at *attribute_count - 1*.
## Data Type
i32
# attribute_friendly_name property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
## Syntax
*Rust Syntax*
```text
fn attribute_friendly_name(&self , AttributeIndex : i32) -> Result fn set_attribute_friendly_name(&self, AttributeIndex : i32, value : &str) -> Option
fn set_attribute_friendly_name_ref(&self, AttributeIndex : i32, value : &String) -> Option
```
## 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](#attribute_count-property-samlwriter-struct) property.
## Data Type
String
# attribute_name property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the name of the attribute.
## Syntax
*Rust Syntax*
```text
fn attribute_name(&self , AttributeIndex : i32) -> Result fn set_attribute_name(&self, AttributeIndex : i32, value : &str) -> Option
fn set_attribute_name_ref(&self, AttributeIndex : i32, value : &String) -> Option
```
## 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](#attribute_count-property-samlwriter-struct) property.
## Data Type
String
# attribute_name_format property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Indicates the format used to reference the attribute.
## Syntax
*Rust Syntax*
```text
fn attribute_name_format(&self , AttributeIndex : i32) -> Result fn set_attribute_name_format(&self, AttributeIndex : i32, value : &str) -> Option
fn set_attribute_name_format_ref(&self, AttributeIndex : i32, value : &String) -> Option
```
## 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](#attribute_count-property-samlwriter-struct) property.
## Data Type
String
# attribute_statement_index property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the index of the statement the attribute corresponds to.
## Syntax
*Rust Syntax*
```text
fn attribute_statement_index(&self , AttributeIndex : i32) -> Result fn set_attribute_statement_index(&self, AttributeIndex : i32, value : i32) -> Option
```
## 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](#attribute_count-property-samlwriter-struct) property.
## Data Type
i32
# attribute_values property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains a list of attribute values.
## Syntax
*Rust Syntax*
```text
fn attribute_values(&self , AttributeIndex : i32) -> Result fn set_attribute_values(&self, AttributeIndex : i32, value : &str) -> Option
fn set_attribute_values_ref(&self, AttributeIndex : i32, value : &String) -> Option
```
## 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](#attribute_count-property-samlwriter-struct) property.
## Data Type
String
# authn_query_comparison property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the authentication context comparison method.
## Syntax
*Rust Syntax*
```text
fn authn_query_comparison(&self ) -> Result fn set_authn_query_comparison(&self, value : i32) -> Option
```
## Possible Values
```text
0 // None1 // Exact2 // Minimum3 // Maximum4 // Better
```
## Default Value
0
## 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).
## Data Type
i32
# authn_query_context_class_refs property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the context class reference.
## Syntax
*Rust Syntax*
```text
fn authn_query_context_class_refs(&self ) -> Result fn set_authn_query_context_class_refs(&self, value : &str) -> Option
fn set_authn_query_context_class_refs_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the context class reference.
Use this property to access or set the authentication context class reference.
## Data Type
String
# authn_query_ref_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the context reference type.
## Syntax
*Rust Syntax*
```text
fn authn_query_ref_type(&self ) -> Result fn set_authn_query_ref_type(&self, value : i32) -> Option
```
## Possible Values
```text
0 // Unknown1 // Class2 // Decl
```
## Default Value
0
## Remarks
Specifies the context reference type.
Use this property to access or set the authentication contexts reference type (class or declaration).
## Data Type
i32
# authn_query_session_index property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the index of the session to the authentication entity.
## Syntax
*Rust Syntax*
```text
fn authn_query_session_index(&self ) -> Result fn set_authn_query_session_index(&self, value : &str) -> Option
fn set_authn_query_session_index_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_assertion_consumer_service_index property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the assertion consumer service index.
## Syntax
*Rust Syntax*
```text
fn authn_request_assertion_consumer_service_index(&self ) -> Result fn set_authn_request_assertion_consumer_service_index(&self, value : i32) -> Option
```
## 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.
## Data Type
i32
# authn_request_assertion_consumer_service_url property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the assertion consumer service URL.
## Syntax
*Rust Syntax*
```text
fn authn_request_assertion_consumer_service_url(&self ) -> Result fn set_authn_request_assertion_consumer_service_url(&self, value : &str) -> Option
fn set_authn_request_assertion_consumer_service_url_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_attribute_consuming_service_index property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the attribute consuming service index.
## Syntax
*Rust Syntax*
```text
fn authn_request_attribute_consuming_service_index(&self ) -> Result fn set_authn_request_attribute_consuming_service_index(&self, value : i32) -> Option
```
## Default Value
0
## Remarks
Specifies the attribute consuming service index.
Use this property to read or set the attribute consuming service index.
## Data Type
i32
# authn_request_context_class_refs property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Provides access to the authentication context class references.
## Syntax
*Rust Syntax*
```text
fn authn_request_context_class_refs(&self ) -> Result fn set_authn_request_context_class_refs(&self, value : &str) -> Option
fn set_authn_request_context_class_refs_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_context_comparison property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the AuthnContext comparison method.
## Syntax
*Rust Syntax*
```text
fn authn_request_context_comparison(&self ) -> Result fn set_authn_request_context_comparison(&self, value : i32) -> Option
```
## Possible Values
```text
0 // None1 // Exact2 // Minimum3 // Maximum4 // Better
```
## Default Value
0
## Remarks
Specifies the AuthnContext comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
## Data Type
i32
# authn_request_context_ref_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the context reference type.
## Syntax
*Rust Syntax*
```text
fn authn_request_context_ref_type(&self ) -> Result fn set_authn_request_context_ref_type(&self, value : i32) -> Option
```
## Possible Values
```text
0 // Unknown1 // Class2 // Decl
```
## Default Value
0
## Remarks
Specifies the context reference type.
Use this property to get or set the context reference type (Class or Declaration).
## Data Type
i32
# authn_request_flags property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Adjusts secondary serialization properties.
## Syntax
*Rust Syntax*
```text
fn authn_request_flags(&self ) -> Result fn set_authn_request_flags(&self, value : i32) -> Option
```
## 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 |
## Data Type
i32
# authn_request_force_authn property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Corresponds to the ForceAuthn parameter of the request.
## Syntax
*Rust Syntax*
```text
fn authn_request_force_authn(&self ) -> Result fn set_authn_request_force_authn(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# authn_request_is_passive property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Maps to the IsPassive parameter of the request.
## Syntax
*Rust Syntax*
```text
fn authn_request_is_passive(&self ) -> Result fn set_authn_request_is_passive(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# authn_request_name_id_policy_allow_create property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Matches the AllowCreate attribute of NameIDPolicy element of the request.
## Syntax
*Rust Syntax*
```text
fn authn_request_name_id_policy_allow_create(&self ) -> Result fn set_authn_request_name_id_policy_allow_create(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# authn_request_name_id_policy_format property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Matches to the Format attribute of the NameIDPolicy element of the request.
## Syntax
*Rust Syntax*
```text
fn authn_request_name_id_policy_format(&self ) -> Result fn set_authn_request_name_id_policy_format(&self, value : &str) -> Option
fn set_authn_request_name_id_policy_format_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_name_id_policy_sp_name_qualifier property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Matches to the SP name qualifier attribute of the request.
## Syntax
*Rust Syntax*
```text
fn authn_request_name_id_policy_sp_name_qualifier(&self ) -> Result fn set_authn_request_name_id_policy_sp_name_qualifier(&self, value : &str) -> Option
fn set_authn_request_name_id_policy_sp_name_qualifier_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_protocol_binding property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the protocol binding to be requested in the authentication request.
## Syntax
*Rust Syntax*
```text
fn authn_request_protocol_binding(&self ) -> Result fn set_authn_request_protocol_binding(&self, value : &str) -> Option
fn set_authn_request_protocol_binding_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_provider_name property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the name of the requestor.
## Syntax
*Rust Syntax*
```text
fn authn_request_provider_name(&self ) -> Result fn set_authn_request_provider_name(&self, value : &str) -> Option
fn set_authn_request_provider_name_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the name of the requestor.
Use this property to read or set the name of the requestor.
## Data Type
String
# authn_request_scoping_get_complete property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Matches the GetComplete element of the IDPList entry of the Scoping object.
## Syntax
*Rust Syntax*
```text
fn authn_request_scoping_get_complete(&self ) -> Result fn set_authn_request_scoping_get_complete(&self, value : &str) -> Option
fn set_authn_request_scoping_get_complete_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authn_request_scoping_proxy_count property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The maximum number of proxies on the way between the requestor and the provider.
## Syntax
*Rust Syntax*
```text
fn authn_request_scoping_proxy_count(&self ) -> Result fn set_authn_request_scoping_proxy_count(&self, value : i32) -> Option
```
## 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.
## Data Type
i32
# authn_request_scoping_requester_i_ds property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
A collection of requestor IDs on whose behalf the request is being sent.
## Syntax
*Rust Syntax*
```text
fn authn_request_scoping_requester_i_ds(&self ) -> Result fn set_authn_request_scoping_requester_i_ds(&self, value : &str) -> Option
fn set_authn_request_scoping_requester_i_ds_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authz_decision_query_actions property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the list of actions included in the query.
## Syntax
*Rust Syntax*
```text
fn authz_decision_query_actions(&self ) -> Result fn set_authz_decision_query_actions(&self, value : &str) -> Option
fn set_authz_decision_query_actions_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# authz_decision_query_resource property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Matches the Resource element of the query.
## Syntax
*Rust Syntax*
```text
fn authz_decision_query_resource(&self ) -> Result fn set_authz_decision_query_resource(&self, value : &str) -> Option
fn set_authz_decision_query_resource_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# binding_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the type of SAML binding to use.
## Syntax
*Rust Syntax*
```text
fn binding_type(&self ) -> Result fn set_binding_type(&self, value : i32) -> Option
```
## Possible Values
```text
0 // None1 // SOAP2 // PAOS3 // Redirect4 // POST5 // Artifact
```
## Default Value
0
## Remarks
Specifies the type of SAML binding to use.
Use this property to specify the binding type to use with the request.
## Data Type
i32
# binding_body property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the POST binding form body.
## Syntax
*Rust Syntax*
```text
fn binding_body(&self ) -> Result fn set_binding_body(&self, value : &str) -> Option
fn set_binding_body_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# binding_encoding property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the message encoding.
## Syntax
*Rust Syntax*
```text
fn binding_encoding(&self ) -> Result fn set_binding_encoding(&self, value : &str) -> Option
fn set_binding_encoding_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Specifies the message encoding.
Use this property to access or set the message encoding.
## Data Type
String
# binding_force_sign property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Enforces a signature over all outgoing messages.
## Syntax
*Rust Syntax*
```text
fn binding_force_sign(&self ) -> Result fn set_binding_force_sign(&self, value : bool) -> Option
```
## 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 [binding_sign](#SAMLWriter_p_BindingSign).
## Data Type
bool
# binding_form_template property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the XHTML form template returned by the service provider.
## Syntax
*Rust Syntax*
```text
fn binding_form_template(&self ) -> Result fn set_binding_form_template(&self, value : &str) -> Option
fn set_binding_form_template_ref(&self, value : &String) -> Option
```
## 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).
## Data Type
String
# binding_post_mode property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies whether binding is applied on the server, or on the client side.
## Syntax
*Rust Syntax*
```text
fn binding_post_mode(&self ) -> Result fn set_binding_post_mode(&self, value : i32) -> Option
```
## Possible Values
```text
0 // Client1 // Server
```
## Default Value
0
## 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.
## Data Type
i32
# binding_relay_state property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the RelayState parameter of the binding.
## Syntax
*Rust Syntax*
```text
fn binding_relay_state(&self ) -> Result fn set_binding_relay_state(&self, value : &str) -> Option
fn set_binding_relay_state_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# binding_signature_algorithm property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the signature algorithm.
## Syntax
*Rust Syntax*
```text
fn binding_signature_algorithm(&self ) -> Result fn set_binding_signature_algorithm(&self, value : &str) -> Option
fn set_binding_signature_algorithm_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# binding_signature_validation_result property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The outcome of the cryptographic signature validation.
## Syntax
*Rust Syntax*
```text
fn binding_signature_validation_result(&self ) -> Result
```
## Possible Values
```text
0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted
```
## Default Value
0
## 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.
## Data Type
i32
# binding_signed property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies whether to sign the binding.
## Syntax
*Rust Syntax*
```text
fn binding_signed(&self ) -> Result fn set_binding_signed(&self, value : bool) -> Option
```
## 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 [binding_force_sign](#binding_force_sign-property-samlwriter-struct) property to enforce signatures on all binding entities.
## Data Type
bool
# binding_url property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the URL of the request query.
## Syntax
*Rust Syntax*
```text
fn binding_url(&self ) -> Result fn set_binding_url(&self, value : &str) -> Option
fn set_binding_url_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# binding_verify_signatures property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Instructs the struct whether to verify incoming signatures.
## Syntax
*Rust Syntax*
```text
fn binding_verify_signatures(&self ) -> Result fn set_binding_verify_signatures(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# binding_key_handle property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
## Syntax
*Rust Syntax*
```text
fn binding_key_handle(&self ) -> Result fn set_binding_key_handle(&self, value : i64) -> Option
```
## 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());
```
## Data Type
i64
# condition_count property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The number of records in the Condition arrays.
## Syntax
*Rust Syntax*
```text
fn condition_count(&self ) -> Result fn set_condition_count(&self, value : i32) -> Option
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [condition](#condition-property-samlwriter-struct)
- [condition_type](#condition_type-property-samlwriter-struct)
The array indices start at *0* and end at *condition_count - 1*.
## Data Type
i32
# condition property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The condition set in accordance with the ConditionType .
## Syntax
*Rust Syntax*
```text
fn condition(&self , ConditionIndex : i32) -> Result fn set_condition(&self, ConditionIndex : i32, value : &str) -> Option
fn set_condition_ref(&self, ConditionIndex : i32, value : &String) -> Option
```
## Default Value
""
## Remarks
The condition set in accordance with the [condition_condition_type](#SAMLWriter_p_ConditionConditionType).
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](#condition_count-property-samlwriter-struct) property.
## Data Type
String
# condition_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies a type of the condition object.
## Syntax
*Rust Syntax*
```text
fn condition_type(&self , ConditionIndex : i32) -> Result fn set_condition_type(&self, ConditionIndex : i32, value : i32) -> Option
```
## Possible Values
```text
0 // AudienceRestriction1 // OneTimeUse2 // ProxyRestriction3 // NotBefore4 // NotOnOrAfter
```
## Default Value
0
## 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](#condition_count-property-samlwriter-struct) property.
## Data Type
i32
# encryption_cert_bytes property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Returns the raw certificate data in DER format.
## Syntax
*Rust Syntax*
```text
fn encryption_cert_bytes(&self ) -> Result, SecureBlackboxError>
```
## Remarks
Returns the raw certificate data in DER format.
This property is read-only.
## Data Type
Vec
# encryption_cert_handle property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
## Syntax
*Rust Syntax*
```text
fn encryption_cert_handle(&self ) -> Result fn set_encryption_cert_handle(&self, value : i64) -> Option
```
## 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());
```
## Data Type
i64
# fips_mode property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Reserved.
## Syntax
*Rust Syntax*
```text
fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option
```
## Default Value
false
## Remarks
This property is reserved for future use.
## Data Type
bool
# logout_request_name_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the NameID parameter.
## Syntax
*Rust Syntax*
```text
fn logout_request_name_id(&self ) -> Result fn set_logout_request_name_id(&self, value : &str) -> Option
fn set_logout_request_name_id_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# logout_request_not_on_or_after property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the NotOnOrAfter parameter.
## Syntax
*Rust Syntax*
```text
fn logout_request_not_on_or_after(&self ) -> Result fn set_logout_request_not_on_or_after(&self, value : &str) -> Option
fn set_logout_request_not_on_or_after_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the value of the NotOnOrAfter parameter.
Use this property to access or set the value of the NotOnOrAfter parameter.
## Data Type
String
# logout_request_reason property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the Reason parameter.
## Syntax
*Rust Syntax*
```text
fn logout_request_reason(&self ) -> Result fn set_logout_request_reason(&self, value : &str) -> Option
fn set_logout_request_reason_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the value of the Reason parameter.
Use this property to read or set the value of the Reason parameter.
## Data Type
String
# logout_request_session_indexes property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the list of session indices.
## Syntax
*Rust Syntax*
```text
fn logout_request_session_indexes(&self ) -> Result fn set_logout_request_session_indexes(&self, value : &str) -> Option
fn set_logout_request_session_indexes_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# manage_name_id_request_name_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the NameID parameter of the request.
## Syntax
*Rust Syntax*
```text
fn manage_name_id_request_name_id(&self ) -> Result fn set_manage_name_id_request_name_id(&self, value : &str) -> Option
fn set_manage_name_id_request_name_id_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# manage_name_id_request_new_encrypted_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the NewEncryptedID parameter of the request.
## Syntax
*Rust Syntax*
```text
fn manage_name_id_request_new_encrypted_id(&self ) -> Result fn set_manage_name_id_request_new_encrypted_id(&self, value : &str) -> Option
fn set_manage_name_id_request_new_encrypted_id_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# manage_name_id_request_new_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the NewID parameter.
## Syntax
*Rust Syntax*
```text
fn manage_name_id_request_new_id(&self ) -> Result fn set_manage_name_id_request_new_id(&self, value : &str) -> Option
fn set_manage_name_id_request_new_id_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the value of the NewID parameter.
Use this property to access or set the NewID parameter of the request.
## Data Type
String
# manage_name_id_request_terminate property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of the Terminate parameter of the request.
## Syntax
*Rust Syntax*
```text
fn manage_name_id_request_terminate(&self ) -> Result fn set_manage_name_id_request_terminate(&self, value : &str) -> Option
fn set_manage_name_id_request_terminate_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# message_consent property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the Consent parameter of the SAML message.
## Syntax
*Rust Syntax*
```text
fn message_consent(&self ) -> Result fn set_message_consent(&self, value : &str) -> Option
fn set_message_consent_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the Consent parameter of the SAML message.
Use this property to specify the Consent parameter of the SAML entity.
## Data Type
String
# message_content_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Returns the SAML type of the current message.
## Syntax
*Rust Syntax*
```text
fn message_content_type(&self ) -> Result
```
## Possible Values
```text
0 // None1 // AssertionIDRequest2 // SubjectQuery3 // AuthnQuery4 // AttributeQuery5 // AuthzDecisionQuery6 // AuthnRequest7 // ManageNameIDRequest8 // LogoutRequest9 // NameIDMappingRequest10 // ArtifactResolve11 // Response12 // Assertion
```
## Default Value
0
## 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 create_new call.
Depending on the assigned type, use properties of struct to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use authn_query property to adjust context class references or comparison settings.
This property is read-only.
## Data Type
i32
# message_content_type_string property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Returns the type of the processed message, as an original string.
## Syntax
*Rust Syntax*
```text
fn message_content_type_string(&self ) -> Result
```
## 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.
## Data Type
String
# message_destination property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the Destination parameter of the SAML message.
## Syntax
*Rust Syntax*
```text
fn message_destination(&self ) -> Result fn set_message_destination(&self, value : &str) -> Option
fn set_message_destination_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Contains the Destination parameter of the SAML message.
Use this property to set the Destination parameter of the created SAML object.
## Data Type
String
# message_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The ID of the request.
## Syntax
*Rust Syntax*
```text
fn message_id(&self ) -> Result fn set_message_id(&self, value : &str) -> Option
fn set_message_id_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
The ID of the request.
Use this property to specify the ID of the SAML request or response.
## Data Type
String
# message_in_response_to property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the InResponseTo property of the SAML request.
## Syntax
*Rust Syntax*
```text
fn message_in_response_to(&self ) -> Result fn set_message_in_response_to(&self, value : &str) -> Option
fn set_message_in_response_to_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# message_issue_instant property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains request issuance timestamp.
## Syntax
*Rust Syntax*
```text
fn message_issue_instant(&self ) -> Result fn set_message_issue_instant(&self, value : &str) -> Option
fn set_message_issue_instant_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# message_issuer property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Sets the issuer of the message.
## Syntax
*Rust Syntax*
```text
fn message_issuer(&self ) -> Result fn set_message_issuer(&self, value : &str) -> Option
fn set_message_issuer_ref(&self, value : &String) -> Option
```
## 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";
```
## Data Type
String
# message_signature_validation_result property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The outcome of the cryptographic signature validation.
## Syntax
*Rust Syntax*
```text
fn message_signature_validation_result(&self ) -> Result
```
## Possible Values
```text
0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted
```
## Default Value
0
## 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.
## Data Type
i32
# message_signed property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies whether the SAML message is or should be signed.
## Syntax
*Rust Syntax*
```text
fn message_signed(&self ) -> Result fn set_message_signed(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# message_subject property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Gets or sets the subject of the message.
## Syntax
*Rust Syntax*
```text
fn message_subject(&self ) -> Result fn set_message_subject(&self, value : &str) -> Option
fn set_message_subject_ref(&self, value : &String) -> Option
```
## 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";
```
## Data Type
String
# message_version property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the protocol version to use for the SAML message.
## Syntax
*Rust Syntax*
```text
fn message_version(&self ) -> Result fn set_message_version(&self, value : &str) -> Option
fn set_message_version_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# message_xml_header property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Controls the inclusion of an XML header in the message.
## Syntax
*Rust Syntax*
```text
fn message_xml_header(&self ) -> Result fn set_message_xml_header(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# name_id_mapping_request_name_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An accessor to the NameID parameter of the request.
## Syntax
*Rust Syntax*
```text
fn name_id_mapping_request_name_id(&self ) -> Result fn set_name_id_mapping_request_name_id(&self, value : &str) -> Option
fn set_name_id_mapping_request_name_id_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# name_id_mapping_request_name_id_policy_allow_create property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the value of AllowCreate parameter of the NameIDPolicy object.
## Syntax
*Rust Syntax*
```text
fn name_id_mapping_request_name_id_policy_allow_create(&self ) -> Result fn set_name_id_mapping_request_name_id_policy_allow_create(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# name_id_mapping_request_name_id_policy_format property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies the format of the NameIDPolicy element.
## Syntax
*Rust Syntax*
```text
fn name_id_mapping_request_name_id_policy_format(&self ) -> Result fn set_name_id_mapping_request_name_id_policy_format(&self, value : &str) -> Option
fn set_name_id_mapping_request_name_id_policy_format_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# name_id_mapping_request_name_id_policy_sp_name_qualifier property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the SPNameQualifier parameter of the NameIDPolicy element.
## Syntax
*Rust Syntax*
```text
fn name_id_mapping_request_name_id_policy_sp_name_qualifier(&self ) -> Result fn set_name_id_mapping_request_name_id_policy_sp_name_qualifier(&self, value : &str) -> Option
fn set_name_id_mapping_request_name_id_policy_sp_name_qualifier_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# name_id_mapping_request_name_id_policy_use_allow_create property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Controls inclusion of UseAllow modifier in the NameIDPolicy object.
## Syntax
*Rust Syntax*
```text
fn name_id_mapping_request_name_id_policy_use_allow_create(&self ) -> Result fn set_name_id_mapping_request_name_id_policy_use_allow_create(&self, value : bool) -> Option
```
## 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.
## Data Type
bool
# profile property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Specifies a pre-defined profile to apply when creating the signature.
## Syntax
*Rust Syntax*
```text
fn profile(&self ) -> Result fn set_profile(&self, value : &str) -> Option
fn set_profile_ref(&self, value : &String) -> Option
```
## 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](#struct-secureblackboxsamlwriter) Struct)
Contains the References entry of the SAML AssertionIDRequest message.
## Syntax
*Rust Syntax*
```text
fn references(&self ) -> Result fn set_references(&self, value : &str) -> Option
fn set_references_ref(&self, value : &String) -> Option
```
## Default Value
""
## Remarks
Use this property to read or specify the value of the References entry of the AssertionIDRequest message.
## Data Type
String
# response_name_id property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the NameID parameter of a NameIDMapping response.
## Syntax
*Rust Syntax*
```text
fn response_name_id(&self ) -> Result fn set_response_name_id(&self, value : &str) -> Option
fn set_response_name_id_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# response_optional_element property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
An optional message element to be returned with the response.
## Syntax
*Rust Syntax*
```text
fn response_optional_element(&self ) -> Result fn set_response_optional_element(&self, value : &str) -> Option
fn set_response_optional_element_ref(&self, value : &String) -> Option
```
## 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.
## Data Type
String
# response_type property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Contains the type of the response.
## Syntax
*Rust Syntax*
```text
fn response_type(&self ) -> Result fn set_response_type(&self, value : i32) -> Option
```
## Possible Values
```text
0 // Response1 // ArtifactResponse2 // NameIDMappingResponse3 // LogoutResponse
```
## Default Value
0
## Remarks
Contains the type of the response.
Use this property to get or set the type of the SAML response.
## Data Type
i32
# response_status property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
Gets or sets the status of the response.
## Syntax
*Rust Syntax*
```text
fn response_status(&self ) -> Result fn set_response_status(&self, value : i32) -> Option
```
## 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 [response_status_code_value](#response_status_code_value-property-samlwriter-struct) 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 [response_status_code_value](#response_status_code_value-property-samlwriter-struct) and [response_status_code_sub_value](#response_status_code_sub_value-property-samlwriter-struct) properties.
## Data Type
i32
# response_status_code_sub_value property ([SAMLWriter](#struct-secureblackboxsamlwriter) Struct)
The value of the nested StatusCode.
## Syntax
*Rust Syntax*
```text
fn response_status_code_sub_value(&self ) -> Result fn set_response_status_code_sub_value(&self, value : &str) -> Option