# Struct secureblackbox::SAMLReader

The SAMLReader struct offers SAML message processing functionality.

## Syntax

```text
secureblackbox::SAMLReader
```

## Remarks

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

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

SAMLReader can process the following types of SAML messages:

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

Pass your SAML message to [open](#open-method-samlreader-struct) (or open_stream) method. Upon processing, struct will populate the elements of the message in the properties, such as message and response. More complex elements, such as assertions, require pinning with [pin_assertion](#pin_assertion-method-samlreader-struct) method to be populated in the object properties.

The snippet below shows how to use SAMLReader to process a message of the AuthnRequest type created by the matching [SAMLReader](#struct-secureblackboxsamlreader) example (or by any compatible SAML endpoint). The input SAML message has the following look:

```text
  <samlp:AuthnRequest
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0"
    IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false"
    ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
    AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1"
    xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
    <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer>
    <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
      <ds:SignedInfo>
        <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
        <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
        <ds:Reference URI="#53GhrzQ5f89fu214ANAR">
          <ds:Transforms>
            <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
            <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
          </ds:Transforms>
          <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue>
        </ds:Reference>
      </ds:SignedInfo>
      <ds:SignatureValue>
        jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
        Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
        Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
        nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
        o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
      </ds:SignatureValue>
      <ds:KeyInfo>
        <ds:X509Data><ds:X509Certificate>
          MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC
          zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2
          FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ
          0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT
          AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC
          QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW
          8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o
          eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n
          YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN
          JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP
          CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB
          CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww
          gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN
          Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg
          NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY
          BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS
          ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a
          ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6
          InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd
          aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f
          6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U
        </ds:X509Certificate></ds:X509Data>
      </ds:KeyInfo>
    </ds:Signature>
    <samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/>
    <saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions>
  </samlp:AuthnRequest>
```

 You can process this message and access its properties with the following code:

```text
  Samlreader reader = new Samlreader();

  reader.ValidateSignatures = true;
  reader.Open(req);

  Log("SAML document loaded. The message is of the " + reader.InputTypeString + " type, and was issued by " + reader.Issuer + " at " + reader.IssueInstant + ".");

  if (reader.InputType == SamlreaderInputTypes.cstyAuthnRequest)
  {
      Log("AuthnRequest.ConsumerServiceURL: " + reader.AuthnRequest.AssertionConsumerServiceURL);
      Log("AuthnRequest.ProtocolBinding: " + reader.AuthnRequest.ProtocolBinding);
      Log("AuthnRequest.Conditions.NotBefore: " + reader.AuthnRequest.ConditionsNotBefore);
      Log("AuthnRequest.Conditions.NotAfter: " + reader.AuthnRequest.ConditionsNotOnOrAfter);
  }

  if (reader.Signed)
  {
      Log("The message was signed by " + reader.SigningCertificate.SubjectRDN);
      Log("Signature validity: " + reader.SignatureValidationResult.ToString());
  }
```

### 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 SAMLReader struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SAMLReader 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-samlreader-struct) | An accessor to the EndpointIndex entry of the artifact. |
| [artifact_message_handle](#artifact_message_handle-property-samlreader-struct) | An accessor to the MessageHandle property of the artifact. |
| [artifact_remaining_artifact](#artifact_remaining_artifact-property-samlreader-struct) | Returns the contents of the artifact. |
| [artifact_source_id](#artifact_source_id-property-samlreader-struct) | An accessor to the SourceID property of the artifact. |
| [artifact_type_code](#artifact_type_code-property-samlreader-struct) | The TypeCode property of the artifact. |
| [artifact_uri](#artifact_uri-property-samlreader-struct) | An accessor to the URI property of the artifact. |
| [artifact_resolve_query](#artifact_resolve_query-property-samlreader-struct) | Returns the content of the ArtifactResolve query. |
| [assertion_count](#assertion_count-property-samlreader-struct) | Returns the number of assertions in the SAML message. |
| [attribute_count](#attribute_count-property-samlreader-struct) | The number of records in the Attribute arrays. |
| [attribute_friendly_name](#attribute_friendly_name-property-samlreader-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-samlreader-struct) | Specifies the name of the attribute. |
| [attribute_name_format](#attribute_name_format-property-samlreader-struct) | Indicates the format used to reference the attribute. |
| [attribute_statement_index](#attribute_statement_index-property-samlreader-struct) | Contains the index of the statement the attribute corresponds to. |
| [attribute_values](#attribute_values-property-samlreader-struct) | Contains a list of attribute values. |
| [authn_query_comparison](#authn_query_comparison-property-samlreader-struct) | Specifies the authentication context comparison method. |
| [authn_query_context_class_refs](#authn_query_context_class_refs-property-samlreader-struct) | Specifies the context class reference. |
| [authn_query_ref_type](#authn_query_ref_type-property-samlreader-struct) | Specifies the context reference type. |
| [authn_query_session_index](#authn_query_session_index-property-samlreader-struct) | Specifies the index of the session to the authentication entity. |
| [authn_request_assertion_consumer_service_index](#authn_request_assertion_consumer_service_index-property-samlreader-struct) | Specifies the assertion consumer service index. |
| [authn_request_assertion_consumer_service_url](#authn_request_assertion_consumer_service_url-property-samlreader-struct) | Specifies the assertion consumer service URL. |
| [authn_request_attribute_consuming_service_index](#authn_request_attribute_consuming_service_index-property-samlreader-struct) | Specifies the attribute consuming service index. |
| [authn_request_context_class_refs](#authn_request_context_class_refs-property-samlreader-struct) | Provides access to the authentication context class references. |
| [authn_request_context_comparison](#authn_request_context_comparison-property-samlreader-struct) | Specifies the AuthnContext comparison method. |
| [authn_request_context_ref_type](#authn_request_context_ref_type-property-samlreader-struct) | Specifies the context reference type. |
| [authn_request_flags](#authn_request_flags-property-samlreader-struct) | Adjusts secondary serialization properties. |
| [authn_request_force_authn](#authn_request_force_authn-property-samlreader-struct) | Corresponds to the ForceAuthn parameter of the request. |
| [authn_request_is_passive](#authn_request_is_passive-property-samlreader-struct) | Maps to the IsPassive parameter of the request. |
| [authn_request_name_id_policy_allow_create](#authn_request_name_id_policy_allow_create-property-samlreader-struct) | Matches the AllowCreate attribute of NameIDPolicy element of the request. |
| [authn_request_name_id_policy_format](#authn_request_name_id_policy_format-property-samlreader-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-samlreader-struct) | Matches to the SP name qualifier attribute of the request. |
| [authn_request_protocol_binding](#authn_request_protocol_binding-property-samlreader-struct) | Specifies the protocol binding to be requested in the authentication request. |
| [authn_request_provider_name](#authn_request_provider_name-property-samlreader-struct) | Specifies the name of the requestor. |
| [authn_request_scoping_get_complete](#authn_request_scoping_get_complete-property-samlreader-struct) | Matches the GetComplete element of the IDPList entry of the Scoping object. |
| [authn_request_scoping_proxy_count](#authn_request_scoping_proxy_count-property-samlreader-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-samlreader-struct) | A collection of requestor IDs on whose behalf the request is being sent. |
| [authz_decision_query_actions](#authz_decision_query_actions-property-samlreader-struct) | Specifies the list of actions included in the query. |
| [authz_decision_query_resource](#authz_decision_query_resource-property-samlreader-struct) | Matches the Resource element of the query. |
| [binding_type](#binding_type-property-samlreader-struct) | Specifies the type of SAML binding to use. |
| [binding_body](#binding_body-property-samlreader-struct) | Contains the POST binding form body. |
| [binding_encoding](#binding_encoding-property-samlreader-struct) | Specifies the message encoding. |
| [binding_force_sign](#binding_force_sign-property-samlreader-struct) | Enforces a signature over all outgoing messages. |
| [binding_form_template](#binding_form_template-property-samlreader-struct) | Contains the XHTML form template returned by the service provider. |
| [binding_post_mode](#binding_post_mode-property-samlreader-struct) | Specifies whether binding is applied on the server, or on the client side. |
| [binding_relay_state](#binding_relay_state-property-samlreader-struct) | Contains the RelayState parameter of the binding. |
| [binding_signature_algorithm](#binding_signature_algorithm-property-samlreader-struct) | Contains the signature algorithm. |
| [binding_signature_validation_result](#binding_signature_validation_result-property-samlreader-struct) | The outcome of the cryptographic signature validation. |
| [binding_signed](#binding_signed-property-samlreader-struct) | Specifies whether to sign the binding. |
| [binding_url](#binding_url-property-samlreader-struct) | Contains the URL of the request query. |
| [binding_verify_signatures](#binding_verify_signatures-property-samlreader-struct) | Instructs the struct whether to verify incoming signatures. |
| [binding_key_handle](#binding_key_handle-property-samlreader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [cert_count](#cert_count-property-samlreader-struct) | The number of records in the Cert arrays. |
| [cert_bytes](#cert_bytes-property-samlreader-struct) | Returns the raw certificate data in DER format. |
| [cert_handle](#cert_handle-property-samlreader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [condition_count](#condition_count-property-samlreader-struct) | The number of records in the Condition arrays. |
| [condition](#condition-property-samlreader-struct) | The condition set in accordance with the ConditionType . |
| [condition_type](#condition_type-property-samlreader-struct) | Specifies a type of the condition object. |
| [decryption_certificate_bytes](#decryption_certificate_bytes-property-samlreader-struct) | Returns the raw certificate data in DER format. |
| [decryption_certificate_handle](#decryption_certificate_handle-property-samlreader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [fips_mode](#fips_mode-property-samlreader-struct) | Reserved. |
| [logout_request_name_id](#logout_request_name_id-property-samlreader-struct) | Contains the value of the NameID parameter. |
| [logout_request_not_on_or_after](#logout_request_not_on_or_after-property-samlreader-struct) | Contains the value of the NotOnOrAfter parameter. |
| [logout_request_reason](#logout_request_reason-property-samlreader-struct) | Contains the value of the Reason parameter. |
| [logout_request_session_indexes](#logout_request_session_indexes-property-samlreader-struct) | Contains the list of session indices. |
| [manage_name_id_request_name_id](#manage_name_id_request_name_id-property-samlreader-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-samlreader-struct) | Contains the value of the NewEncryptedID parameter of the request. |
| [manage_name_id_request_new_id](#manage_name_id_request_new_id-property-samlreader-struct) | Contains the value of the NewID parameter. |
| [manage_name_id_request_terminate](#manage_name_id_request_terminate-property-samlreader-struct) | Contains the value of the Terminate parameter of the request. |
| [message_consent](#message_consent-property-samlreader-struct) | Contains the Consent parameter of the SAML message. |
| [message_content_type](#message_content_type-property-samlreader-struct) | Returns the SAML type of the current message. |
| [message_content_type_string](#message_content_type_string-property-samlreader-struct) | Returns the type of the processed message, as an original string. |
| [message_destination](#message_destination-property-samlreader-struct) | Contains the Destination parameter of the SAML message. |
| [message_id](#message_id-property-samlreader-struct) | The ID of the request. |
| [message_in_response_to](#message_in_response_to-property-samlreader-struct) | Contains the InResponseTo property of the SAML request. |
| [message_issue_instant](#message_issue_instant-property-samlreader-struct) | Contains request issuance timestamp. |
| [message_issuer](#message_issuer-property-samlreader-struct) | Sets the issuer of the message. |
| [message_signature_validation_result](#message_signature_validation_result-property-samlreader-struct) | The outcome of the cryptographic signature validation. |
| [message_signed](#message_signed-property-samlreader-struct) | Specifies whether the SAML message is or should be signed. |
| [message_subject](#message_subject-property-samlreader-struct) | Gets or sets the subject of the message. |
| [message_version](#message_version-property-samlreader-struct) | Specifies the protocol version to use for the SAML message. |
| [message_xml_header](#message_xml_header-property-samlreader-struct) | Controls the inclusion of an XML header in the message. |
| [name_id_mapping_request_name_id](#name_id_mapping_request_name_id-property-samlreader-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-samlreader-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-samlreader-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-samlreader-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-samlreader-struct) | Controls inclusion of UseAllow modifier in the NameIDPolicy object. |
| [pinned_assertion_assertion_type](#pinned_assertion_assertion_type-property-samlreader-struct) | Specifies the type of the assertion. |
| [pinned_assertion_encrypted_content](#pinned_assertion_encrypted_content-property-samlreader-struct) | Represents the encrypted assertion content. |
| [pinned_assertion_id](#pinned_assertion_id-property-samlreader-struct) | Represents the ID of the assertion. |
| [pinned_assertion_id_ref](#pinned_assertion_id_ref-property-samlreader-struct) | Represents an ID reference value. |
| [pinned_assertion_issue_instant](#pinned_assertion_issue_instant-property-samlreader-struct) | Contains the assertion issuance time stamp. |
| [pinned_assertion_issuer](#pinned_assertion_issuer-property-samlreader-struct) | Specifies the assertion issuer. |
| [pinned_assertion_parent_assertion](#pinned_assertion_parent_assertion-property-samlreader-struct) | Contains the index of the parent assertion in the assertion list. |
| [pinned_assertion_signature_validation_result](#pinned_assertion_signature_validation_result-property-samlreader-struct) | The outcome of the cryptographic signature validation. |
| [pinned_assertion_signed](#pinned_assertion_signed-property-samlreader-struct) | Specifies whether the assertion is signed. |
| [pinned_assertion_subject](#pinned_assertion_subject-property-samlreader-struct) | Specifies the assertion subject. |
| [pinned_assertion_uri_ref](#pinned_assertion_uri_ref-property-samlreader-struct) | Represents an URI reference value. |
| [pinned_assertion_version](#pinned_assertion_version-property-samlreader-struct) | Specifies the SAML protocol version used. |
| [profile](#profile-property-samlreader-struct) | Specifies a pre-defined profile to apply when creating the signature. |
| [proxy_address](#proxy_address-property-samlreader-struct) | The IP address of the proxy server. |
| [proxy_authentication](#proxy_authentication-property-samlreader-struct) | The authentication type used by the proxy server. |
| [proxy_password](#proxy_password-property-samlreader-struct) | The password to authenticate to the proxy server. |
| [proxy_port](#proxy_port-property-samlreader-struct) | The port on the proxy server to connect to. |
| [proxy_type](#proxy_type-property-samlreader-struct) | The type of the proxy server. |
| [proxy_request_headers](#proxy_request_headers-property-samlreader-struct) | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| [proxy_response_body](#proxy_response_body-property-samlreader-struct) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| [proxy_response_headers](#proxy_response_headers-property-samlreader-struct) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| [proxy_use_ipv6](#proxy_use_ipv6-property-samlreader-struct) | Specifies whether IPv6 should be used when connecting through the proxy. |
| [proxy_username](#proxy_username-property-samlreader-struct) | Specifies the username credential for proxy authentication. |
| [references](#references-property-samlreader-struct) | Contains the References entry of the SAML AssertionIDRequest message. |
| [response_name_id](#response_name_id-property-samlreader-struct) | Contains the NameID parameter of a NameIDMapping response. |
| [response_optional_element](#response_optional_element-property-samlreader-struct) | An optional message element to be returned with the response. |
| [response_type](#response_type-property-samlreader-struct) | Contains the type of the response. |
| [response_status](#response_status-property-samlreader-struct) | Gets or sets the status of the response. |
| [response_status_code_sub_value](#response_status_code_sub_value-property-samlreader-struct) | The value of the nested StatusCode. |
| [response_status_code_value](#response_status_code_value-property-samlreader-struct) | Contains the status code value. |
| [response_status_detail](#response_status_detail-property-samlreader-struct) | Contains additional information on the status of the request. |
| [response_status_message](#response_status_message-property-samlreader-struct) | Contains a status message (optional). |
| [scoping_idp_count](#scoping_idp_count-property-samlreader-struct) | The number of records in the ScopingIDP arrays. |
| [scoping_idp_loc](#scoping_idp_loc-property-samlreader-struct) | Contains the value of the Loc attribute. |
| [scoping_idp_name](#scoping_idp_name-property-samlreader-struct) | Contains the name of the IdP provider. |
| [scoping_idp_provider_id](#scoping_idp_provider_id-property-samlreader-struct) | Contains the provider ID. |
| [security_canonicalization_method](#security_canonicalization_method-property-samlreader-struct) | The canonicalization method to use in the signature. |
| [security_digest_method](#security_digest_method-property-samlreader-struct) | The digest method to use. |
| [security_encryption_method](#security_encryption_method-property-samlreader-struct) | The encryption method used to encrypt the assertion. |
| [security_flags](#security_flags-property-samlreader-struct) | Provides access to secondary security parameters and tweaks. |
| [security_sig_method](#security_sig_method-property-samlreader-struct) | The signature method to use. |
| [security_signature_policy](#security_signature_policy-property-samlreader-struct) | Specifies the signature validation policy. |
| [signing_cert_bytes](#signing_cert_bytes-property-samlreader-struct) | Returns the raw certificate data in DER format. |
| [signing_cert_ca](#signing_cert_ca-property-samlreader-struct) | Indicates whether the certificate has a CA capability. |
| [signing_cert_ca_key_id](#signing_cert_ca_key_id-property-samlreader-struct) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [signing_cert_crl_distribution_points](#signing_cert_crl_distribution_points-property-samlreader-struct) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [signing_cert_curve](#signing_cert_curve-property-samlreader-struct) | Specifies the elliptic curve associated with the certificate's public key. |
| [signing_cert_fingerprint](#signing_cert_fingerprint-property-samlreader-struct) | Contains the fingerprint (a hash imprint) of this certificate. |
| [signing_cert_friendly_name](#signing_cert_friendly_name-property-samlreader-struct) | Contains an associated alias (friendly name) of the certificate. |
| [signing_cert_handle](#signing_cert_handle-property-samlreader-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [signing_cert_hash_algorithm](#signing_cert_hash_algorithm-property-samlreader-struct) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| [signing_cert_issuer](#signing_cert_issuer-property-samlreader-struct) | The common name of the certificate issuer (CA), typically a company name. |
| [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property-samlreader-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [signing_cert_key_algorithm](#signing_cert_key_algorithm-property-samlreader-struct) | Specifies the public key algorithm of this certificate. |
| [signing_cert_key_bits](#signing_cert_key_bits-property-samlreader-struct) | Returns the length of the public key in bits. |
| [signing_cert_key_fingerprint](#signing_cert_key_fingerprint-property-samlreader-struct) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [signing_cert_key_usage](#signing_cert_key_usage-property-samlreader-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [signing_cert_key_valid](#signing_cert_key_valid-property-samlreader-struct) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [signing_cert_ocsp_locations](#signing_cert_ocsp_locations-property-samlreader-struct) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| [signing_cert_policy_i_ds](#signing_cert_policy_i_ds-property-samlreader-struct) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-samlreader-struct) | Contains the certificate's public key in DER format. |
| [signing_cert_self_signed](#signing_cert_self_signed-property-samlreader-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [signing_cert_serial_number](#signing_cert_serial_number-property-samlreader-struct) | Returns the certificate's serial number. |
| [signing_cert_sig_algorithm](#signing_cert_sig_algorithm-property-samlreader-struct) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [signing_cert_subject](#signing_cert_subject-property-samlreader-struct) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| [signing_cert_subject_key_id](#signing_cert_subject_key_id-property-samlreader-struct) | Contains a unique identifier of the certificate's cryptographic key. |
| [signing_cert_subject_rdn](#signing_cert_subject_rdn-property-samlreader-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [signing_cert_valid_from](#signing_cert_valid_from-property-samlreader-struct) | The time point at which the certificate becomes valid, in UTC. |
| [signing_cert_valid_to](#signing_cert_valid_to-property-samlreader-struct) | The time point at which the certificate expires, in UTC. |
| [socket_dns_mode](#socket_dns_mode-property-samlreader-struct) | Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system. |
| [socket_dns_port](#socket_dns_port-property-samlreader-struct) | Specifies the port number to be used for sending queries to the DNS server. |
| [socket_dns_query_timeout](#socket_dns_query_timeout-property-samlreader-struct) | The timeout (in milliseconds) for each DNS query. |
| [socket_dns_servers](#socket_dns_servers-property-samlreader-struct) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| [socket_dns_total_timeout](#socket_dns_total_timeout-property-samlreader-struct) | The timeout (in milliseconds) for the whole resolution process. |
| [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-samlreader-struct) | The maximum number of bytes to read from the socket, per second. |
| [socket_local_address](#socket_local_address-property-samlreader-struct) | The local network interface to bind the socket to. |
| [socket_local_port](#socket_local_port-property-samlreader-struct) | The local port number to bind the socket to. |
| [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-samlreader-struct) | The maximum number of bytes to write to the socket, per second. |
| [socket_timeout](#socket_timeout-property-samlreader-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| [socket_use_ipv6](#socket_use_ipv6-property-samlreader-struct) | Enables or disables IP protocol version 6. |
| [statement_count](#statement_count-property-samlreader-struct) | The number of records in the Statement arrays. |
| [statement_authn_context_authenticating_authorities](#statement_authn_context_authenticating_authorities-property-samlreader-struct) | Contains the list of authenticating authorities. |
| [statement_authn_context_choice](#statement_authn_context_choice-property-samlreader-struct) | Specifies the authentication context choice variant. |
| [statement_authn_context_class_ref](#statement_authn_context_class_ref-property-samlreader-struct) | Indicates the authentication contexts class reference. |
| [statement_authn_context_decl](#statement_authn_context_decl-property-samlreader-struct) | Specifies the authentication contexts declaration. |
| [statement_authn_context_decl_ref](#statement_authn_context_decl_ref-property-samlreader-struct) | Specifies the authentication contexts declaration reference. |
| [statement_authn_instant](#statement_authn_instant-property-samlreader-struct) | Specifies the authentication event timestamp. |
| [statement_authn_session_index](#statement_authn_session_index-property-samlreader-struct) | Contains the authentication session index. |
| [statement_authn_session_not_on_or_after](#statement_authn_session_not_on_or_after-property-samlreader-struct) | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
| [statement_authn_subject_locality_address](#statement_authn_subject_locality_address-property-samlreader-struct) | Specifies the authentication subjects address. |
| [statement_authn_subject_locality_dns_name](#statement_authn_subject_locality_dns_name-property-samlreader-struct) | Maps to the authentication subjects DNS name parameter. |
| [statement_authz_actions](#statement_authz_actions-property-samlreader-struct) | Provides access to the list of actions of the authorization statement. |
| [statement_authz_decision](#statement_authz_decision-property-samlreader-struct) | Specifies the authorization decision. |
| [statement_authz_decision_evidence](#statement_authz_decision_evidence-property-samlreader-struct) | Manages the authorization decision statement evidence parameter. |
| [statement_authz_decision_resource](#statement_authz_decision_resource-property-samlreader-struct) | Specifies the authorization decision statement resource parameter. |
| [statement_type](#statement_type-property-samlreader-struct) | Specifies the assertion statement type. |
| [subject_confirmation_count](#subject_confirmation_count-property-samlreader-struct) | The number of records in the SubjectConfirmation arrays. |
| [subject_confirmation_address](#subject_confirmation_address-property-samlreader-struct) | Contains the address enabled for presenting assertions. |
| [subject_confirmation_data](#subject_confirmation_data-property-samlreader-struct) | The uninterpreted value of data entry in the subject confirmation. |
| [subject_confirmation_data_type](#subject_confirmation_data_type-property-samlreader-struct) | The type of data contained in the confirmation. |
| [subject_confirmation_id](#subject_confirmation_id-property-samlreader-struct) | The identifier of the entity which can satisfy the subject confirmation requirements. |
| [subject_confirmation_in_response_to](#subject_confirmation_in_response_to-property-samlreader-struct) | The ID of the SAML message in response to which the assertion is issued. |
| [subject_confirmation_method](#subject_confirmation_method-property-samlreader-struct) | Specifies the mechanism to be used to confirm the subject. |
| [subject_confirmation_not_before](#subject_confirmation_not_before-property-samlreader-struct) | Time moment before which the subject cannot be confirmed. |
| [subject_confirmation_not_on_or_after](#subject_confirmation_not_on_or_after-property-samlreader-struct) | Limits the time until which the subject can be confirmed. |
| [subject_confirmation_recipient](#subject_confirmation_recipient-property-samlreader-struct) | The URI of the entity or the location of the resource to which the assertion should be presented. |
| [tls_auto_validate_certificates](#tls_auto_validate_certificates-property-samlreader-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| [tls_base_configuration](#tls_base_configuration-property-samlreader-struct) | Selects the base configuration for the TLS settings. |
| [tls_ciphersuites](#tls_ciphersuites-property-samlreader-struct) | A list of ciphersuites separated with commas or semicolons. |
| [tls_client_auth](#tls_client_auth-property-samlreader-struct) | Enables or disables certificate-based client authentication. |
| [tls_extensions](#tls_extensions-property-samlreader-struct) | Provides access to TLS extensions. |
| [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-samlreader-struct) | Whether to force TLS session resumption when the destination address changes. |
| [tls_groups](#tls_groups-property-samlreader-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| [tls_pre_shared_identity](#tls_pre_shared_identity-property-samlreader-struct) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| [tls_pre_shared_key](#tls_pre_shared_key-property-samlreader-struct) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property-samlreader-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-samlreader-struct) | Selects the renegotiation attack prevention mechanism. |
| [tls_revocation_check](#tls_revocation_check-property-samlreader-struct) | Specifies the kind(s) of revocation check to perform. |
| [tls_ssl_options](#tls_ssl_options-property-samlreader-struct) | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| [tls_mode](#tls_mode-property-samlreader-struct) | Specifies the TLS mode to use. |
| [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-samlreader-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| [tls_use_session_resumption](#tls_use_session_resumption-property-samlreader-struct) | Enables or disables the TLS session resumption capability. |
| [tls_versions](#tls_versions-property-samlreader-struct) | The SSL/TLS versions to enable by default. |
| [use_binding](#use_binding-property-samlreader-struct) | Enables or disables automated binding processing. |
| [validate_signatures](#validate_signatures-property-samlreader-struct) | Enables or disables automated signature validation. |

## Method List

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

|  |  |
| --- | --- |
| [compare_i_ds](#compare_i_ds-method-samlreader-struct) | Compares two SAML IDs. |
| [config](#config-method-samlreader-struct) | Sets or retrieves a configuration setting. |
| [do_action](#do_action-method-samlreader-struct) | Performs an additional action. |
| [get_id_prop](#get_id_prop-method-samlreader-struct) | Extracts a specific property from a SAML ID. |
| [open](#open-method-samlreader-struct) | Opens a SAML entity. |
| [open_bytes](#open_bytes-method-samlreader-struct) | Opens a SAML entity. |
| [open_file](#open_file-method-samlreader-struct) | Opens a SAML entity. |
| [pin_assertion](#pin_assertion-method-samlreader-struct) | Pins assertion by propagating it in PinnedAssertionXXX properties. |
| [reset](#reset-method-samlreader-struct) | Resets the struct settings. |

## 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_encrypted](#on_encrypted-event-samlreader-struct) | Notifies the application that the assertion is encrypted and provides recipient certificate details. |
| [on_error](#on_error-event-samlreader-struct) | Fires to report an error condition. |
| [on_notification](#on_notification-event-samlreader-struct) | This event notifies the application about an underlying control flow event. |
| [on_signature_found](#on_signature_found-event-samlreader-struct) | Signifies the start of signature validation. |
| [on_signature_validated](#on_signature_validated-event-samlreader-struct) | Reports the signature validation result. |

## Config Settings

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

|  |  |
| --- | --- |
| [Body](#Body) | Returns the XML of the currently processed entity. |
| [EncryptionCert](#EncryptionCert) | Returns the body of the encryption certificate. |
| [EncryptionSubjectRDN](#EncryptionSubjectRDN) | Returns the Subject RDN of the encryption certificate. |
| [OpportunisticCertLookup](#OpportunisticCertLookup) | Enables opportunistic signing certificate lookup. |
| [ValidateSignatureReferences](#ValidateSignatureReferences) | Enables or disables XML signature reference validation. |
| [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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An accessor to the EndpointIndex entry of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_endpoint_index(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

An accessor to the EndpointIndex entry of the artifact.

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

This property is read-only.

## Data Type

i32

# artifact_message_handle property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An accessor to the MessageHandle property of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_message_handle(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

An accessor to the MessageHandle property of the artifact.

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

This property is read-only.

## Data Type

Vec

# artifact_remaining_artifact property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the contents of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_remaining_artifact(&self ) -> Result<Vec<u8>, 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An accessor to the SourceID property of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_source_id(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is read-only.

## Data Type

Vec

# artifact_type_code property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The TypeCode property of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_type_code(&self ) -> Result<i32, SecureBlackboxError>
```

## 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-samlreader-struct), [artifact_source_id](#artifact_source_id-property-samlreader-struct), and [artifact_message_handle](#artifact_message_handle-property-samlreader-struct) parameters.

This property is read-only.

## Data Type

i32

# artifact_uri property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An accessor to the URI property of the artifact.

## Syntax

*Rust Syntax*

```text
fn artifact_uri(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is read-only.

## Data Type

String

# artifact_resolve_query property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the content of the ArtifactResolve query.

## Syntax

*Rust Syntax*

```text
fn artifact_resolve_query(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# assertion_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the number of assertions in the SAML message.

## Syntax

*Rust Syntax*

```text
fn assertion_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

This property is read-only.

## Data Type

i32

# attribute_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the Attribute arrays.

## Syntax

*Rust Syntax*

```text
fn attribute_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [attribute_friendly_name](#attribute_friendly_name-property-samlreader-struct)
- [attribute_name](#attribute_name-property-samlreader-struct)
- [attribute_name_format](#attribute_name_format-property-samlreader-struct)
- [attribute_statement_index](#attribute_statement_index-property-samlreader-struct)
- [attribute_values](#attribute_values-property-samlreader-struct)

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

This property is read-only.

## Data Type

i32

# attribute_friendly_name property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

String

# attribute_name property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the name of the attribute.

## Syntax

*Rust Syntax*

```text
fn attribute_name(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

String

# attribute_name_format property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Indicates the format used to reference the attribute.

## Syntax

*Rust Syntax*

```text
fn attribute_name_format(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

String

# attribute_statement_index property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the index of the statement the attribute corresponds to.

## Syntax

*Rust Syntax*

```text
fn attribute_statement_index(&self , AttributeIndex : i32) -> Result<i32, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

i32

# attribute_values property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains a list of attribute values.

## Syntax

*Rust Syntax*

```text
fn attribute_values(&self , AttributeIndex : i32) -> Result<String, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

String

# authn_query_comparison property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication context comparison method.

## Syntax

*Rust Syntax*

```text
fn authn_query_comparison(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# authn_query_context_class_refs property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the context class reference.

## Syntax

*Rust Syntax*

```text
fn authn_query_context_class_refs(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the context class reference.

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

This property is read-only.

## Data Type

String

# authn_query_ref_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the context reference type.

## Syntax

*Rust Syntax*

```text
fn authn_query_ref_type(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# authn_query_session_index property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the index of the session to the authentication entity.

## Syntax

*Rust Syntax*

```text
fn authn_query_session_index(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the index of the session to the authentication entity.

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

This property is read-only.

## Data Type

String

# authn_request_assertion_consumer_service_index property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the assertion consumer service index.

## Syntax

*Rust Syntax*

```text
fn authn_request_assertion_consumer_service_index(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Specifies the assertion consumer service index.

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

This property is read-only.

## Data Type

i32

# authn_request_assertion_consumer_service_url property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the assertion consumer service URL.

## Syntax

*Rust Syntax*

```text
fn authn_request_assertion_consumer_service_url(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the assertion consumer service URL.

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

This property is read-only.

## Data Type

String

# authn_request_attribute_consuming_service_index property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the attribute consuming service index.

## Syntax

*Rust Syntax*

```text
fn authn_request_attribute_consuming_service_index(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Specifies the attribute consuming service index.

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

This property is read-only.

## Data Type

i32

# authn_request_context_class_refs property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Provides access to the authentication context class references.

## Syntax

*Rust Syntax*

```text
fn authn_request_context_class_refs(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Provides access to the authentication context class references.

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

This property is read-only.

## Data Type

String

# authn_request_context_comparison property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the AuthnContext comparison method.

## Syntax

*Rust Syntax*

```text
fn authn_request_context_comparison(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# authn_request_context_ref_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the context reference type.

## Syntax

*Rust Syntax*

```text
fn authn_request_context_ref_type(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# authn_request_flags property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Adjusts secondary serialization properties.

## Syntax

*Rust Syntax*

```text
fn authn_request_flags(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Adjusts secondary serialization properties.

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

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

This property is read-only.

## Data Type

i32

# authn_request_force_authn property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Corresponds to the ForceAuthn parameter of the request.

## Syntax

*Rust Syntax*

```text
fn authn_request_force_authn(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Corresponds to the ForceAuthn parameter of the request.

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

This property is read-only.

## Data Type

bool

# authn_request_is_passive property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Maps to the IsPassive parameter of the request.

## Syntax

*Rust Syntax*

```text
fn authn_request_is_passive(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Maps to the IsPassive parameter of the request.

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

This property is read-only.

## Data Type

bool

# authn_request_name_id_policy_allow_create property ([SAMLReader](#struct-secureblackboxsamlreader) 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<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Matches the AllowCreate attribute of NameIDPolicy element of the request.

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

This property is read-only.

## Data Type

bool

# authn_request_name_id_policy_format property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# authn_request_name_id_policy_sp_name_qualifier property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Matches to the SP name qualifier attribute of the request.

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

This property is read-only.

## Data Type

String

# authn_request_protocol_binding property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn authn_request_protocol_binding(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# authn_request_provider_name property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the name of the requestor.

## Syntax

*Rust Syntax*

```text
fn authn_request_provider_name(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the name of the requestor.

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

This property is read-only.

## Data Type

String

# authn_request_scoping_get_complete property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# authn_request_scoping_proxy_count property ([SAMLReader](#struct-secureblackboxsamlreader) 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<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

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

This property is read-only.

## Data Type

i32

# authn_request_scoping_requester_i_ds property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# authz_decision_query_actions property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the list of actions included in the query.

## Syntax

*Rust Syntax*

```text
fn authz_decision_query_actions(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the list of actions included in the query.

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

This property is read-only.

## Data Type

String

# authz_decision_query_resource property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Matches the Resource element of the query.

## Syntax

*Rust Syntax*

```text
fn authz_decision_query_resource(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Matches the Resource element of the query.

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

This property is read-only.

## Data Type

String

# binding_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the type of SAML binding to use.

## Syntax

*Rust Syntax*

```text
fn binding_type(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# binding_body property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the POST binding form body.

## Syntax

*Rust Syntax*

```text
fn binding_body(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the POST binding form body.

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

This property is read-only.

## Data Type

String

# binding_encoding property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the message encoding.

## Syntax

*Rust Syntax*

```text
fn binding_encoding(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is read-only.

## Data Type

String

# binding_force_sign property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enforces a signature over all outgoing messages.

## Syntax

*Rust Syntax*

```text
fn binding_force_sign(&self ) -> Result<bool, SecureBlackboxError>
```

## 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](#SAMLReader_p_BindingSign).

This property is read-only.

## Data Type

bool

# binding_form_template property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the XHTML form template returned by the service provider.

## Syntax

*Rust Syntax*

```text
fn binding_form_template(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the XHTML form template returned by the service provider.

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

This property is read-only.

## Data Type

String

# binding_post_mode property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn binding_post_mode(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# binding_relay_state property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the RelayState parameter of the binding.

## Syntax

*Rust Syntax*

```text
fn binding_relay_state(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the RelayState parameter of the binding.

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

This property is read-only.

## Data Type

String

# binding_signature_algorithm property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the signature algorithm.

## Syntax

*Rust Syntax*

```text
fn binding_signature_algorithm(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the signature algorithm.

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

This property is read-only.

## Data Type

String

# binding_signature_validation_result property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The outcome of the cryptographic signature validation.

## Syntax

*Rust Syntax*

```text
fn binding_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError>
```

## 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies whether to sign the binding.

## Syntax

*Rust Syntax*

```text
fn binding_signed(&self ) -> Result<bool, SecureBlackboxError>
```

## 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-samlreader-struct) property to enforce signatures on all binding entities.

This property is read-only.

## Data Type

bool

# binding_url property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the URL of the request query.

## Syntax

*Rust Syntax*

```text
fn binding_url(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the URL of the request query.

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

This property is read-only.

## Data Type

String

# binding_verify_signatures property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Instructs the struct whether to verify incoming signatures.

## Syntax

*Rust Syntax*

```text
fn binding_verify_signatures(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

true

## Remarks

Instructs the component whether to verify incoming signatures.

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

This property is read-only.

## Data Type

bool

# binding_key_handle property ([SAMLReader](#struct-secureblackboxsamlreader) 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<i64, SecureBlackboxError> fn set_binding_key_handle(&self, value : i64) ->  Option<SecureBlackboxError>
```

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

# cert_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the Cert arrays.

## Syntax

*Rust Syntax*

```text
fn cert_count(&self ) -> Result<i32, SecureBlackboxError> fn set_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [cert_bytes](#cert_bytes-property-samlreader-struct)
- [cert_handle](#cert_handle-property-samlreader-struct)

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

## Data Type

i32

# cert_bytes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
fn cert_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw certificate data in DER format.

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

Vec

# cert_handle property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn cert_handle(&self , CertIndex : i32) -> Result<i64, SecureBlackboxError> fn set_cert_handle(&self, CertIndex : i32, value : i64) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

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

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

The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-samlreader-struct) property.

## Data Type

i64

# condition_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the Condition arrays.

## Syntax

*Rust Syntax*

```text
fn condition_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [condition](#condition-property-samlreader-struct)
- [condition_type](#condition_type-property-samlreader-struct)

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

This property is read-only.

## Data Type

i32

# condition property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The condition set in accordance with the ConditionType .

## Syntax

*Rust Syntax*

```text
fn condition(&self , ConditionIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The condition set in accordance with the [condition_condition_type](#SAMLReader_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-samlreader-struct) property.

This property is read-only.

## Data Type

String

# condition_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies a type of the condition object.

## Syntax

*Rust Syntax*

```text
fn condition_type(&self , ConditionIndex : i32) -> Result<i32, SecureBlackboxError>
```

## 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-samlreader-struct) property.

This property is read-only.

## Data Type

i32

# decryption_certificate_bytes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
fn decryption_certificate_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw certificate data in DER format.

This property is read-only.

## Data Type

Vec

# decryption_certificate_handle property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn decryption_certificate_handle(&self ) -> Result<i64, SecureBlackboxError> fn set_decryption_certificate_handle(&self, value : i64) ->  Option<SecureBlackboxError>
```

## 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Reserved.

## Syntax

*Rust Syntax*

```text
fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

This property is reserved for future use.

## Data Type

bool

# logout_request_name_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the NameID parameter.

## Syntax

*Rust Syntax*

```text
fn logout_request_name_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the NameID parameter.

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

This property is read-only.

## Data Type

String

# logout_request_not_on_or_after property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the NotOnOrAfter parameter.

## Syntax

*Rust Syntax*

```text
fn logout_request_not_on_or_after(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the NotOnOrAfter parameter.

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

This property is read-only.

## Data Type

String

# logout_request_reason property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the Reason parameter.

## Syntax

*Rust Syntax*

```text
fn logout_request_reason(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the Reason parameter.

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

This property is read-only.

## Data Type

String

# logout_request_session_indexes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the list of session indices.

## Syntax

*Rust Syntax*

```text
fn logout_request_session_indexes(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the list of session indices.

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

This property is read-only.

## Data Type

String

# manage_name_id_request_name_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the NameID parameter of the request.

## Syntax

*Rust Syntax*

```text
fn manage_name_id_request_name_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the NameID parameter of the request.

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

This property is read-only.

## Data Type

String

# manage_name_id_request_new_encrypted_id property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the NewEncryptedID parameter of the request.

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

This property is read-only.

## Data Type

String

# manage_name_id_request_new_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the NewID parameter.

## Syntax

*Rust Syntax*

```text
fn manage_name_id_request_new_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the NewID parameter.

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

This property is read-only.

## Data Type

String

# manage_name_id_request_terminate property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the Terminate parameter of the request.

## Syntax

*Rust Syntax*

```text
fn manage_name_id_request_terminate(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the Terminate parameter of the request.

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

This property is read-only.

## Data Type

String

# message_consent property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the Consent parameter of the SAML message.

## Syntax

*Rust Syntax*

```text
fn message_consent(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the Consent parameter of the SAML message.

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

This property is read-only.

## Data Type

String

# message_content_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the SAML type of the current message.

## Syntax

*Rust Syntax*

```text
fn message_content_type(&self ) -> Result<i32, SecureBlackboxError>
```

## 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn message_content_type_string(&self ) -> Result<String, SecureBlackboxError>
```

## 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the Destination parameter of the SAML message.

## Syntax

*Rust Syntax*

```text
fn message_destination(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the Destination parameter of the SAML message.

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

This property is read-only.

## Data Type

String

# message_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The ID of the request.

## Syntax

*Rust Syntax*

```text
fn message_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The ID of the request.

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

This property is read-only.

## Data Type

String

# message_in_response_to property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the InResponseTo property of the SAML request.

## Syntax

*Rust Syntax*

```text
fn message_in_response_to(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the InResponseTo property of the SAML request.

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

This property is read-only.

## Data Type

String

# message_issue_instant property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains request issuance timestamp.

## Syntax

*Rust Syntax*

```text
fn message_issue_instant(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains request issuance timestamp.

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

This property is read-only.

## Data Type

String

# message_issuer property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Sets the issuer of the message.

## Syntax

*Rust Syntax*

```text
fn message_issuer(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Sets the issuer of the message.

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

- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID

 For example,

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

This property is read-only.

## Data Type

String

# message_signature_validation_result property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The outcome of the cryptographic signature validation.

## Syntax

*Rust Syntax*

```text
fn message_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError>
```

## 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 ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies whether the SAML message is or should be signed.

## Syntax

*Rust Syntax*

```text
fn message_signed(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Specifies whether the SAML message is or should be signed.

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

This property is read-only.

## Data Type

bool

# message_subject property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Gets or sets the subject of the message.

## Syntax

*Rust Syntax*

```text
fn message_subject(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Gets or sets the subject of the message.

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

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

- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID

 For example,

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

This property is read-only.

## Data Type

String

# message_version property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the protocol version to use for the SAML message.

## Syntax

*Rust Syntax*

```text
fn message_version(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

"2.0"

## Remarks

Specifies the protocol version to use for the SAML message.

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

This property is read-only.

## Data Type

String

# message_xml_header property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Controls the inclusion of an XML header in the message.

## Syntax

*Rust Syntax*

```text
fn message_xml_header(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Controls the inclusion of an XML header in the message.

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

This property is read-only.

## Data Type

bool

# name_id_mapping_request_name_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An accessor to the NameID parameter of the request.

## Syntax

*Rust Syntax*

```text
fn name_id_mapping_request_name_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

An accessor to the NameID parameter of the request.

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

This property is read-only.

## Data Type

String

# name_id_mapping_request_name_id_policy_allow_create property ([SAMLReader](#struct-secureblackboxsamlreader) 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<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Contains the value of AllowCreate parameter of the NameIDPolicy object.

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

This property is read-only.

## Data Type

bool

# name_id_mapping_request_name_id_policy_format property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the format of the NameIDPolicy element.

## Syntax

*Rust Syntax*

```text
fn name_id_mapping_request_name_id_policy_format(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the format of the NameIDPolicy element.

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

This property is read-only.

## Data Type

String

# name_id_mapping_request_name_id_policy_sp_name_qualifier property ([SAMLReader](#struct-secureblackboxsamlreader) 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<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the SPNameQualifier parameter of the NameIDPolicy element.

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

This property is read-only.

## Data Type

String

# name_id_mapping_request_name_id_policy_use_allow_create property ([SAMLReader](#struct-secureblackboxsamlreader) 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<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

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

This property is read-only.

## Data Type

bool

# pinned_assertion_assertion_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the type of the assertion.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_assertion_type(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# pinned_assertion_encrypted_content property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Represents the encrypted assertion content.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_encrypted_content(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Represents the encrypted assertion content.

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

This property is read-only.

## Data Type

String

# pinned_assertion_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Represents the ID of the assertion.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Represents the ID of the assertion.

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

This property is read-only.

## Data Type

String

# pinned_assertion_id_ref property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Represents an ID reference value.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_id_ref(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Represents an ID reference value.

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

This property is read-only.

## Data Type

String

# pinned_assertion_issue_instant property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the assertion issuance time stamp.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_issue_instant(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the assertion issuance time stamp.

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

This property is read-only.

## Data Type

String

# pinned_assertion_issuer property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the assertion issuer.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_issuer(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the assertion issuer.

Use this property to provide the assertion issuer ID.

This property is read-only.

## Data Type

String

# pinned_assertion_parent_assertion property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_parent_assertion(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

-1

## Remarks

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

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

This property is read-only.

## Data Type

i32

# pinned_assertion_signature_validation_result property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The outcome of the cryptographic signature validation.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError>
```

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

# pinned_assertion_signed property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies whether the assertion is signed.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_signed(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is read-only.

## Data Type

bool

# pinned_assertion_subject property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the assertion subject.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_subject(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the assertion subject.

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

This property is read-only.

## Data Type

String

# pinned_assertion_uri_ref property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Represents an URI reference value.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_uri_ref(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Represents an URI reference value.

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

This property is read-only.

## Data Type

String

# pinned_assertion_version property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the SAML protocol version used.

## Syntax

*Rust Syntax*

```text
fn pinned_assertion_version(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the SAML protocol version used.

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

This property is read-only.

## Data Type

String

# profile property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn profile(&self ) -> Result<String, SecureBlackboxError> fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

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

# proxy_address property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The IP address of the proxy server.

## Syntax

*Rust Syntax*

```text
fn proxy_address(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

The IP address of the proxy server.

## Data Type

String

# proxy_authentication property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The authentication type used by the proxy server.

## Syntax

*Rust Syntax*

```text
fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // NoAuthentication1   // Basic2   // Digest3   // NTLM
```

## Default Value

0

## Remarks

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

## Data Type

i32

# proxy_password property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The password to authenticate to the proxy server.

## Syntax

*Rust Syntax*

```text
fn proxy_password(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

The password to authenticate to the proxy server.

## Data Type

String

# proxy_port property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The port on the proxy server to connect to.

## Syntax

*Rust Syntax*

```text
fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

The port on the proxy server to connect to.

## Data Type

i32

# proxy_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The type of the proxy server.

## Syntax

*Rust Syntax*

```text
fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // None1   // Socks42   // Socks53   // WebTunnel4   // HTTP
```

## Default Value

0

## Remarks

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

## Data Type

i32

# proxy_request_headers property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Syntax

*Rust Syntax*

```text
fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Data Type

String

# proxy_response_body property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# proxy_response_headers property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# proxy_use_ipv6 property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# proxy_username property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the username credential for proxy authentication.

## Syntax

*Rust Syntax*

```text
fn proxy_username(&self ) -> Result<String, SecureBlackboxError> fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the username credential for proxy authentication.

## Data Type

String

# references property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the References entry of the SAML AssertionIDRequest message.

## Syntax

*Rust Syntax*

```text
fn references(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# response_name_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the NameID parameter of a NameIDMapping response.

## Syntax

*Rust Syntax*

```text
fn response_name_id(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the NameID parameter of a NameIDMapping response.

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

This property is read-only.

## Data Type

String

# response_optional_element property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

An optional message element to be returned with the response.

## Syntax

*Rust Syntax*

```text
fn response_optional_element(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

An optional message element to be returned with the response.

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

This property is read-only.

## Data Type

String

# response_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the type of the response.

## Syntax

*Rust Syntax*

```text
fn response_type(&self ) -> Result<i32, SecureBlackboxError>
```

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

This property is read-only.

## Data Type

i32

# response_status property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Gets or sets the status of the response.

## Syntax

*Rust Syntax*

```text
fn response_status(&self ) -> Result<i32, SecureBlackboxError>
```

## 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-samlreader-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-samlreader-struct) and [response_status_code_sub_value](#response_status_code_sub_value-property-samlreader-struct) properties.

This property is read-only.

## Data Type

i32

# response_status_code_sub_value property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The value of the nested StatusCode.

## Syntax

*Rust Syntax*

```text
fn response_status_code_sub_value(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is read-only.

## Data Type

String

# response_status_code_value property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the status code value.

## Syntax

*Rust Syntax*

```text
fn response_status_code_value(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the status code value.

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

This property is read-only.

## Data Type

String

# response_status_detail property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains additional information on the status of the request.

## Syntax

*Rust Syntax*

```text
fn response_status_detail(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains additional information on the status of the request.

The StatusDetail element contains additional request status information.

This property is read-only.

## Data Type

String

# response_status_message property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains a status message (optional).

## Syntax

*Rust Syntax*

```text
fn response_status_message(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains a status message (optional).

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

This property is read-only.

## Data Type

String

# scoping_idp_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the ScopingIDP arrays.

## Syntax

*Rust Syntax*

```text
fn scoping_idp_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [scoping_idp_loc](#scoping_idp_loc-property-samlreader-struct)
- [scoping_idp_name](#scoping_idp_name-property-samlreader-struct)
- [scoping_idp_provider_id](#scoping_idp_provider_id-property-samlreader-struct)

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

This property is read-only.

## Data Type

i32

# scoping_idp_loc property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the value of the Loc attribute.

## Syntax

*Rust Syntax*

```text
fn scoping_idp_loc(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the value of the Loc attribute.

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

The *ScopingIDPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ScopingIDPCount](#scoping_idp_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# scoping_idp_name property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the name of the IdP provider.

## Syntax

*Rust Syntax*

```text
fn scoping_idp_name(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the name of the IdP provider.

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

The *ScopingIDPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ScopingIDPCount](#scoping_idp_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# scoping_idp_provider_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the provider ID.

## Syntax

*Rust Syntax*

```text
fn scoping_idp_provider_id(&self , ScopingIDPIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the provider ID.

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

The *ScopingIDPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ScopingIDPCount](#scoping_idp_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# security_canonicalization_method property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The canonicalization method to use in the signature.

## Syntax

*Rust Syntax*

```text
fn security_canonicalization_method(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The canonicalization method to use in the signature.

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

This property is read-only.

## Data Type

String

# security_digest_method property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The digest method to use.

## Syntax

*Rust Syntax*

```text
fn security_digest_method(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The digest method to use.

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

This property is read-only.

## Data Type

String

# security_encryption_method property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The encryption method used to encrypt the assertion.

## Syntax

*Rust Syntax*

```text
fn security_encryption_method(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

"AES256"

## Remarks

The encryption method used to encrypt the assertion.

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

Supported values:

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

This property is read-only.

## Data Type

String

# security_flags property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Provides access to secondary security parameters and tweaks.

## Syntax

*Rust Syntax*

```text
fn security_flags(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

1

## Remarks

Provides access to secondary security parameters and tweaks.

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

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

This property is read-only.

## Data Type

i32

# security_sig_method property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The signature method to use.

## Syntax

*Rust Syntax*

```text
fn security_sig_method(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The signature method to use.

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

This property is read-only.

## Data Type

String

# security_signature_policy property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the signature validation policy.

## Syntax

*Rust Syntax*

```text
fn security_signature_policy(&self ) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Auto1   // Validate2   // Require3   // Ignore
```

## Default Value

0

## Remarks

Specifies the signature validation policy.

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

This property is read-only.

## Data Type

i32

# signing_cert_bytes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the raw certificate data in DER format.

## Syntax

*Rust Syntax*

```text
fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the raw certificate data in DER format.

This property is read-only.

## Data Type

Vec

# signing_cert_ca property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Indicates whether the certificate has a CA capability.

## Syntax

*Rust Syntax*

```text
fn signing_cert_ca(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

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

This property is read-only.

## Data Type

bool

# signing_cert_ca_key_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_ca_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

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

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

This property is read-only.

## Data Type

Vec

# signing_cert_crl_distribution_points property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_crl_distribution_points(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

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

This property is read-only.

## Data Type

String

# signing_cert_curve property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_curve(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

This property is read-only.

## Data Type

String

# signing_cert_fingerprint property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_fingerprint(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# signing_cert_friendly_name property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_friendly_name(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# signing_cert_handle property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

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

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

This property is read-only.

## Data Type

i64

# signing_cert_hash_algorithm property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_hash_algorithm(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

This property is read-only.

## Data Type

String

# signing_cert_issuer property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_issuer(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [signing_cert_issuer_rdn](#signing_cert_issuer_rdn-property-samlreader-struct).

This property is read-only.

## Data Type

String

# signing_cert_issuer_rdn property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_issuer_rdn(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# signing_cert_key_algorithm property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the public key algorithm of this certificate.

## Syntax

*Rust Syntax*

```text
fn signing_cert_key_algorithm(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

"0"

## Remarks

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [signing_cert_key_bits](#signing_cert_key_bits-property-samlreader-struct), [signing_cert_curve](#signing_cert_curve-property-samlreader-struct), and [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-samlreader-struct) properties to get more details about the key the certificate contains.

This property is read-only.

## Data Type

String

# signing_cert_key_bits property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the length of the public key in bits.

## Syntax

*Rust Syntax*

```text
fn signing_cert_key_bits(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [signing_cert_public_key_bytes](#signing_cert_public_key_bytes-property-samlreader-struct) or [signing_cert_private_key_bytes](#SAMLReader_p_SigningCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

## Data Type

i32

# signing_cert_key_fingerprint property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_key_fingerprint(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the [signing_cert_fingerprint](#signing_cert_fingerprint-property-samlreader-struct) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

## Data Type

String

# signing_cert_key_usage property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_key_usage(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

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

This value is a bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

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

This property is read-only.

## Data Type

i32

# signing_cert_key_valid property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_key_valid(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

This property is read-only.

## Data Type

bool

# signing_cert_ocsp_locations property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_ocsp_locations(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

Set this property before calling the certificate manager's [generate](#CertificateManager_m_Generate) method to propagate it to the new certificate.

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

This property is read-only.

## Data Type

String

# signing_cert_policy_i_ds property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

## Syntax

*Rust Syntax*

```text
fn signing_cert_policy_i_ds(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

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

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

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

This property is read-only.

## Data Type

String

# signing_cert_public_key_bytes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the certificate's public key in DER format.

## Syntax

*Rust Syntax*

```text
fn signing_cert_public_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Contains the certificate's public key in DER format.

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

This property is read-only.

## Data Type

Vec

# signing_cert_self_signed property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_self_signed(&self ) -> Result<bool, SecureBlackboxError>
```

## Default Value

false

## Remarks

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

This property is read-only.

## Data Type

bool

# signing_cert_serial_number property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Returns the certificate's serial number.

## Syntax

*Rust Syntax*

```text
fn signing_cert_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

Returns the certificate's serial number.

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

This property is read-only.

## Data Type

Vec

# signing_cert_sig_algorithm property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_sig_algorithm(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

This property is read-only.

## Data Type

String

# signing_cert_subject property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_subject(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [signing_cert_subject_rdn](#signing_cert_subject_rdn-property-samlreader-struct).

This property is read-only.

## Data Type

String

# signing_cert_subject_key_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError>
```

## Remarks

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

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

The [signing_cert_subject_key_id](#signing_cert_subject_key_id-property-samlreader-struct) and [signing_cert_ca_key_id](#signing_cert_ca_key_id-property-samlreader-struct) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

## Data Type

Vec

# signing_cert_subject_rdn property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_subject_rdn(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

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

This property is read-only.

## Data Type

String

# signing_cert_valid_from property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_valid_from(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# signing_cert_valid_to property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn signing_cert_valid_to(&self ) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# socket_dns_mode property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Auto1   // Platform2   // Own3   // OwnSecure
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

## Data Type

i32

# socket_dns_port property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

## Data Type

i32

# socket_dns_query_timeout property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The timeout (in milliseconds) for each DNS query.

## Syntax

*Rust Syntax*

```text
fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

## Data Type

i32

# socket_dns_servers property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# socket_dns_total_timeout property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

## Data Type

i32

# socket_incoming_speed_limit property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

## Data Type

i32

# socket_local_address property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The local network interface to bind the socket to.

## Syntax

*Rust Syntax*

```text
fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

The local network interface to bind the socket to.

## Data Type

String

# socket_local_port property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The local port number to bind the socket to.

## Syntax

*Rust Syntax*

```text
fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

The local port number to bind the socket to.

## Data Type

i32

# socket_outgoing_speed_limit property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

0

## Remarks

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

## Data Type

i32

# socket_timeout property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

60000

## Remarks

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

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

## Data Type

i32

# socket_use_ipv6 property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enables or disables IP protocol version 6.

## Syntax

*Rust Syntax*

```text
fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

Enables or disables IP protocol version 6.

## Data Type

bool

# statement_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the Statement arrays.

## Syntax

*Rust Syntax*

```text
fn statement_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [statement_authn_context_authenticating_authorities](#statement_authn_context_authenticating_authorities-property-samlreader-struct)
- [statement_authn_context_choice](#statement_authn_context_choice-property-samlreader-struct)
- [statement_authn_context_class_ref](#statement_authn_context_class_ref-property-samlreader-struct)
- [statement_authn_context_decl](#statement_authn_context_decl-property-samlreader-struct)
- [statement_authn_context_decl_ref](#statement_authn_context_decl_ref-property-samlreader-struct)
- [statement_authn_instant](#statement_authn_instant-property-samlreader-struct)
- [statement_authn_session_index](#statement_authn_session_index-property-samlreader-struct)
- [statement_authn_session_not_on_or_after](#statement_authn_session_not_on_or_after-property-samlreader-struct)
- [statement_authn_subject_locality_address](#statement_authn_subject_locality_address-property-samlreader-struct)
- [statement_authn_subject_locality_dns_name](#statement_authn_subject_locality_dns_name-property-samlreader-struct)
- [statement_authz_actions](#statement_authz_actions-property-samlreader-struct)
- [statement_authz_decision](#statement_authz_decision-property-samlreader-struct)
- [statement_authz_decision_evidence](#statement_authz_decision_evidence-property-samlreader-struct)
- [statement_authz_decision_resource](#statement_authz_decision_resource-property-samlreader-struct)
- [statement_type](#statement_type-property-samlreader-struct)

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

This property is read-only.

## Data Type

i32

# statement_authn_context_authenticating_authorities property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the list of authenticating authorities.

## Syntax

*Rust Syntax*

```text
fn statement_authn_context_authenticating_authorities(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the list of authenticating authorities.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_context_choice property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication context choice variant.

## Syntax

*Rust Syntax*

```text
fn statement_authn_context_choice(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authentication context choice variant.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_context_class_ref property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Indicates the authentication contexts class reference.

## Syntax

*Rust Syntax*

```text
fn statement_authn_context_class_ref(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Indicates the authentication contexts class reference.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_context_decl property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication contexts declaration.

## Syntax

*Rust Syntax*

```text
fn statement_authn_context_decl(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authentication contexts declaration.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_context_decl_ref property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication contexts declaration reference.

## Syntax

*Rust Syntax*

```text
fn statement_authn_context_decl_ref(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authentication contexts declaration reference.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_instant property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication event timestamp.

## Syntax

*Rust Syntax*

```text
fn statement_authn_instant(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authentication event timestamp.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_session_index property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the authentication session index.

## Syntax

*Rust Syntax*

```text
fn statement_authn_session_index(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the authentication session index.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_session_not_on_or_after property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

## Syntax

*Rust Syntax*

```text
fn statement_authn_session_not_on_or_after(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_subject_locality_address property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authentication subjects address.

## Syntax

*Rust Syntax*

```text
fn statement_authn_subject_locality_address(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authentication subjects address.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authn_subject_locality_dns_name property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Maps to the authentication subjects DNS name parameter.

## Syntax

*Rust Syntax*

```text
fn statement_authn_subject_locality_dns_name(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Maps to the authentication subjects DNS name parameter.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authz_actions property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn statement_authz_actions(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authz_decision property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authorization decision.

## Syntax

*Rust Syntax*

```text
fn statement_authz_decision(&self , StatementIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Permit1   // Deny2   // Indeterminate
```

## Default Value

0

## Remarks

Specifies the authorization decision.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

i32

# statement_authz_decision_evidence property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Manages the authorization decision statement evidence parameter.

## Syntax

*Rust Syntax*

```text
fn statement_authz_decision_evidence(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Manages the authorization decision statement evidence parameter.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_authz_decision_resource property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the authorization decision statement resource parameter.

## Syntax

*Rust Syntax*

```text
fn statement_authz_decision_resource(&self , StatementIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the authorization decision statement resource parameter.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# statement_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the assertion statement type.

## Syntax

*Rust Syntax*

```text
fn statement_type(&self , StatementIndex : i32) -> Result<i32, SecureBlackboxError>
```

## Possible Values

```text
0   // Authn1   // Attribute2   // AuthzDecision
```

## Default Value

0

## Remarks

Specifies the assertion statement type.

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

The *StatementIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [StatementCount](#statement_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

i32

# subject_confirmation_count property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The number of records in the SubjectConfirmation arrays.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_count(&self ) -> Result<i32, SecureBlackboxError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [subject_confirmation_address](#subject_confirmation_address-property-samlreader-struct)
- [subject_confirmation_data](#subject_confirmation_data-property-samlreader-struct)
- [subject_confirmation_data_type](#subject_confirmation_data_type-property-samlreader-struct)
- [subject_confirmation_id](#subject_confirmation_id-property-samlreader-struct)
- [subject_confirmation_in_response_to](#subject_confirmation_in_response_to-property-samlreader-struct)
- [subject_confirmation_method](#subject_confirmation_method-property-samlreader-struct)
- [subject_confirmation_not_before](#subject_confirmation_not_before-property-samlreader-struct)
- [subject_confirmation_not_on_or_after](#subject_confirmation_not_on_or_after-property-samlreader-struct)
- [subject_confirmation_recipient](#subject_confirmation_recipient-property-samlreader-struct)

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

This property is read-only.

## Data Type

i32

# subject_confirmation_address property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Contains the address enabled for presenting assertions.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_address(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Contains the address enabled for presenting assertions.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_data property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The uninterpreted value of data entry in the subject confirmation.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_data(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The uninterpreted value of data entry in the subject confirmation.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_data_type property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The type of data contained in the confirmation.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_data_type(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

The type of data contained in the confirmation.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_id property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_id(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_in_response_to property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_in_response_to(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_method property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the mechanism to be used to confirm the subject.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_method(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies the mechanism to be used to confirm the subject.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_not_before property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Time moment before which the subject cannot be confirmed.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_not_before(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Time moment before which the subject cannot be confirmed.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_not_on_or_after property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Limits the time until which the subject can be confirmed.

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_not_on_or_after(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

Limits the time until which the subject can be confirmed.

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# subject_confirmation_recipient property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn subject_confirmation_recipient(&self , SubjectConfirmationIndex : i32) -> Result<String, SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

The *SubjectConfirmationIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SubjectConfirmationCount](#subject_confirmation_count-property-samlreader-struct) property.

This property is read-only.

## Data Type

String

# tls_auto_validate_certificates property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

true

## Remarks

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

## Data Type

bool

# tls_base_configuration property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Selects the base configuration for the TLS settings.

## Syntax

*Rust Syntax*

```text
fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Default1   // Compatible2   // ComprehensiveInsecure3   // HighlySecure
```

## Default Value

0

## Remarks

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

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

## Data Type

i32

# tls_ciphersuites property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

A list of ciphersuites separated with commas or semicolons.

## Syntax

*Rust Syntax*

```text
fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

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

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

## Data Type

String

# tls_client_auth property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enables or disables certificate-based client authentication.

## Syntax

*Rust Syntax*

```text
fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // NoAuth1   // RequestCert2   // RequireCert
```

## Default Value

0

## Remarks

Enables or disables certificate-based client authentication.

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

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

## Data Type

i32

# tls_extensions property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Provides access to TLS extensions.

## Syntax

*Rust Syntax*

```text
fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Provides access to TLS extensions.

## Data Type

String

# tls_force_resume_if_destination_changes property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# tls_groups property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

## Syntax

*Rust Syntax*

```text
fn tls_groups(&self ) -> Result<String, SecureBlackboxError> fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder:

```text
  // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
  client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";

  // Only enable the hybrid X25519/ML-KEM768 group
  client.TLSSettings.Groups = "-all;+x25519mlkem768";
```

The list of groups supported by the component is provided below. All the names are case-insensitive:

**Elliptic curve-based groups:**

- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024

Note: this property was called *ECCurves* in SecureBlackbox 2024 and older.

## Data Type

String

# tls_pre_shared_identity property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# tls_pre_shared_key property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# tls_pre_shared_key_ciphersuite property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError>
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# tls_renegotiation_attack_prevention_mode property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Selects the renegotiation attack prevention mechanism.

## Syntax

*Rust Syntax*

```text
fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Compatible1   // Strict2   // Auto
```

## Default Value

2

## Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

## Data Type

i32

# tls_revocation_check property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // None1   // Auto2   // AllCRL3   // AllOCSP4   // AllCRLAndOCSP5   // AnyCRL6   // AnyOCSP7   // AnyCRLOrOCSP8   // AnyOCSPOrCRL
```

## Default Value

1

## Remarks

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

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

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

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

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

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

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

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

## Data Type

i32

# tls_ssl_options property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

16

## Remarks

Various SSL (TLS) protocol options, set of

|  |  |  |
| --- | --- | --- |
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

## Data Type

i32

# tls_mode property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Specifies the TLS mode to use.

## Syntax

*Rust Syntax*

```text
fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Possible Values

```text
0   // Default1   // NoTLS2   // ExplicitTLS3   // ImplicitTLS4   // MixedTLS
```

## Default Value

0

## Remarks

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

## Data Type

i32

# tls_use_extended_master_secret property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

true

## Remarks

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

## Data Type

bool

# tls_use_session_resumption property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enables or disables the TLS session resumption capability.

## Syntax

*Rust Syntax*

```text
fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

Enables or disables the TLS session resumption capability.

## Data Type

bool

# tls_versions property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

The SSL/TLS versions to enable by default.

## Syntax

*Rust Syntax*

```text
fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError>
```

## Default Value

48

## Remarks

The SSL/TLS versions to enable by default.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Data Type

i32

# use_binding property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enables or disables automated binding processing.

## Syntax

*Rust Syntax*

```text
fn use_binding(&self ) -> Result<bool, SecureBlackboxError> fn set_use_binding(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# validate_signatures property ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Enables or disables automated signature validation.

## Syntax

*Rust Syntax*

```text
fn validate_signatures(&self ) -> Result<bool, SecureBlackboxError> fn set_validate_signatures(&self, value : bool) ->  Option<SecureBlackboxError>
```

## Default Value

true

## Remarks

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

## Data Type

bool

# compare_i_ds method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Compares two SAML IDs.

## Syntax

*Rust Syntax*

```text
fn compare_i_ds(&self, id1 : &str, id2 : &str) ->  Result<bool, SecureBlackboxError>
```

## Remarks

Use this utility function to easily compare two SAML IDs.

# config method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-samlreader-struct) for the struct.

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

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

To read (query) the value of a [configuration setting](#config-settings-samlreader-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# do_action method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Performs an additional action.

## Syntax

*Rust Syntax*

```text
fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>
```

## Remarks

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

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

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

Common ActionIDs:

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

# get_id_prop method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Extracts a specific property from a SAML ID.

## Syntax

*Rust Syntax*

```text
fn get_id_prop(&self, id : &str, prop_name : &str) ->  Result<String, SecureBlackboxError>
```

## Remarks

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

*PropName* supports the following properties:

- Format
- NameQualifier
- IDType
- SPNameQualifier
- SPProvidedID
- Value

# open method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Opens a SAML entity.

## Syntax

*Rust Syntax*

```text
fn open(&self, input : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

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

# open_bytes method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Opens a SAML entity.

## Syntax

*Rust Syntax*

```text
fn open_bytes(&self, input_bytes : &[u8]) -> Result<(), SecureBlackboxError>
```

## Remarks

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

# open_file method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Opens a SAML entity.

## Syntax

*Rust Syntax*

```text
fn open_file(&self, input_file : &str) -> Result<(), SecureBlackboxError>
```

## Remarks

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

# pin_assertion method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Pins assertion by propagating it in PinnedAssertionXXX properties.

## Syntax

*Rust Syntax*

```text
fn pin_assertion(&self, assertion_index : i32) -> Result<(), SecureBlackboxError>
```

## Remarks

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

Check [assertion_count](#assertion_count-property-samlreader-struct) to obtain the number of assertions in the message.

# reset method ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Resets the struct settings.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), SecureBlackboxError>
```

## Remarks

reset is a generic method available in every struct.

# on_encrypted event ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
// SAMLReaderEncryptedEventArgs carries the SAMLReader Encrypted event's parameters.
pub struct SAMLReaderEncryptedEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn need_credential(&self) -> bool
  fn skip_this(&self) -> bool
  fn set_skip_this(&self, value : bool)
}

// SAMLReaderEncryptedEvent defines the signature of the SAMLReader Encrypted event's handler function.
pub trait SAMLReaderEncryptedEvent {
  fn on_encrypted(&self, sender : SAMLReader, e : &mut SAMLReaderEncryptedEventArgs);
}

impl <'a> SAMLReader<'a> {
  pub fn on_encrypted(&self) -> &'a dyn SAMLReaderEncryptedEvent;
  pub fn set_on_encrypted(&mut self, value : &'a dyn SAMLReaderEncryptedEvent);
  ...
}
```

## Remarks

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

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

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

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

# on_error event ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Fires to report an error condition.

## Syntax

*Rust Syntax*

```text
// SAMLReaderErrorEventArgs carries the SAMLReader Error event's parameters.
pub struct SAMLReaderErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// SAMLReaderErrorEvent defines the signature of the SAMLReader Error event's handler function.
pub trait SAMLReaderErrorEvent {
  fn on_error(&self, sender : SAMLReader, e : &mut SAMLReaderErrorEventArgs);
}

impl <'a> SAMLReader<'a> {
  pub fn on_error(&self) -> &'a dyn SAMLReaderErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn SAMLReaderErrorEvent);
  ...
}
```

## Remarks

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

# on_notification event ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

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

## Syntax

*Rust Syntax*

```text
// SAMLReaderNotificationEventArgs carries the SAMLReader Notification event's parameters.
pub struct SAMLReaderNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// SAMLReaderNotificationEvent defines the signature of the SAMLReader Notification event's handler function.
pub trait SAMLReaderNotificationEvent {
  fn on_notification(&self, sender : SAMLReader, e : &mut SAMLReaderNotificationEventArgs);
}

impl <'a> SAMLReader<'a> {
  pub fn on_notification(&self) -> &'a dyn SAMLReaderNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn SAMLReaderNotificationEvent);
  ...
}
```

## Remarks

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

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

# on_signature_found event ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Signifies the start of signature validation.

## Syntax

*Rust Syntax*

```text
// SAMLReaderSignatureFoundEventArgs carries the SAMLReader SignatureFound event's parameters.
pub struct SAMLReaderSignatureFoundEventArgs {
  fn scope(&self) -> i32
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate(&self) -> bool
  fn set_validate(&self, value : bool)
}

// SAMLReaderSignatureFoundEvent defines the signature of the SAMLReader SignatureFound event's handler function.
pub trait SAMLReaderSignatureFoundEvent {
  fn on_signature_found(&self, sender : SAMLReader, e : &mut SAMLReaderSignatureFoundEventArgs);
}

impl <'a> SAMLReader<'a> {
  pub fn on_signature_found(&self) -> &'a dyn SAMLReaderSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn SAMLReaderSignatureFoundEvent);
  ...
}
```

## Remarks

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

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

|  |  |  |
| --- | --- | --- |
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |

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

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

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the signing_certificate property and the associated certificates from the certificates collection, and pass them to the [CertificateValidator](CertificateValidator.md#CertificateValidator) component to validate its chain.

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

# on_signature_validated event ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

Reports the signature validation result.

## Syntax

*Rust Syntax*

```text
// SAMLReaderSignatureValidatedEventArgs carries the SAMLReader SignatureValidated event's parameters.
pub struct SAMLReaderSignatureValidatedEventArgs {
  fn scope(&self) -> i32
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn validation_result(&self) -> i32
  fn set_validation_result(&self, value : i32)
}

// SAMLReaderSignatureValidatedEvent defines the signature of the SAMLReader SignatureValidated event's handler function.
pub trait SAMLReaderSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : SAMLReader, e : &mut SAMLReaderSignatureValidatedEventArgs);
}

impl <'a> SAMLReader<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn SAMLReaderSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn SAMLReaderSignatureValidatedEvent);
  ...
}
```

## Remarks

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

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

|  |  |  |
| --- | --- | --- |
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |

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

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

# Config Settings ([SAMLReader](#struct-secureblackboxsamlreader) Struct)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-samlreader-struct) method.

### SAMLReader Config Settings

**Body**: Returns the XML of the currently processed entity.Use this read-only configuration property to retrieve the XML body of the currently processed entity.

**EncryptionCert**: Returns the body of the encryption certificate.Use this property to retrieve the body of the certificate that was used to encrypt the assertion.

**EncryptionSubjectRDN**: Returns the Subject RDN of the encryption certificate.Use this property to retrieve the subject RDN fields of the encryption certificate.

**OpportunisticCertLookup**: Enables opportunistic signing certificate lookup.Enable this property to tell SAMLReader to try to validate the signature with every certificate provided in the Certificates collection if the signer did not include its certificate information in the signature. If at least one certificate is found to cryptographically match the signature, the signature is accepted as valid.

**ValidateSignatureReferences**: Enables or disables XML signature reference validation.Set this property to false to disable signature references integrity validation. Use with care: switching off this property disables an important step of signature validation process.

### Base Config Settings

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

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

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

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

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

Supported values are:

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

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

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

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

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

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

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

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

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

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

Supported Values:

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

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

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

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

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

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

Supported values are:

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

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

Supported values are:

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

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

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

Supported filter names are:

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

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

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

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

Supported values are:

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

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

The default value of this setting is 100.

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

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

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

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

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

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

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

Supported Values:

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

Example (default value):

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

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

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

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

Example:

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

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

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

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

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

Supported values are:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Syntax:

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

Where:

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

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

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

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

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

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

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

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

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

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

# Trappable Errors ([SAMLReader](#struct-secureblackboxsamlreader) Struct)