SAMLReader Class

Properties Methods Events Config Settings Errors

The SAMLReader class offers SAML message processing functionality.

Syntax

class 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 (or open_stream) method. Upon processing, class will populate the elements of the message in the properties, such as input_type or issuer. More complex elements, such as assertions, require pinning with pin_assertion 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 example (or by any compatible SAML endpoint). The input SAML message has the following look: <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: 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()); }

Property List

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


artifact_endpoint_index	An accessor to the EndpointIndex entry of the artifact.
artifact_message_handle	An accessor to the MessageHandle property of the artifact.
artifact_remaining_artifact	Returns the contents of the artifact.
artifact_source_id	An accessor to the SourceID property of the artifact.
artifact_type_code	The TypeCode property of the artifact.
artifact_uri	An accessor to the URI property of the artifact.
artifact_resolve_query	Returns the content of the ArtifactResolve query.
assertion_count	Returns the number of assertions in the SAML message.
assertion_id_request_references	Contains the References entry of the SAML assertion ID request.
attr_query_attr_count	The number of records in the AttrQueryAttr arrays.
attr_query_attr_friendly_name	Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
attr_query_attr_name	Specifies the name of the attribute.
attr_query_attr_name_format	Indicates the format used to reference the attribute.
attr_query_attr_statement_index	Contains the index of the statement the attribute corresponds to.
attr_query_attr_values	Contains a list of attribute values.
authn_query_comparison	Specifies the authentication context comparison method.
authn_query_context_class_refs	Specifies the context class reference.
authn_query_ref_type	Specifies the context reference type.
authn_query_session_index	Specifies the index of the session to the authentication entity.
authn_request_assertion_consumer_service_index	Specifies the assertion consumer service index.
authn_request_assertion_consumer_service_url	Specifies the assertion consumer service URL.
authn_request_attribute_consuming_service_index	Specifies the attribute consuming service index.
authn_request_conditions_not_before	Specifies the NotBefore condition of the request.
authn_request_conditions_not_on_or_after	Provides access to the NotOnOrAfter condition of the request.
authn_request_context_class_refs	Provides access to the authentication context class references.
authn_request_context_comparison	Specifies the AuthnContext comparison method.
authn_request_context_ref_type	Specifies the context reference type.
authn_request_force_authn	Corresponds to the ForceAuthn parameter of the request.
authn_request_is_passive	Maps to the IsPassive parameter of the request.
authn_request_name_id_policy_allow_create	Matches the AllowCreate attribute of NameIDPolicy element of the request.
authn_request_name_id_policy_format	Matches to the Format attribute of the NameIDPolicy element of the request.
authn_request_name_id_policy_sp_name_qualifier	Matches to the SP name qualifier attribute of the request.
authn_request_name_id_policy_use_allow_create	Controls inclusion of AllowCreate attribute in the request.
authn_request_protocol_binding	Specifies the protocol binding to be requested in the authentication request.
authn_request_provider_name	Specifies the name of the requestor.
authn_request_scoping_idp_list_get_complete	Matches the GetComplete element of the IDPList entry of the Scoping object.
authn_request_scoping_proxy_count	The maximum number of proxies on the way between the requestor and the provider.
authn_request_scoping_requester_i_ds	A collection of requestor IDs on whose behalf the request is being sent.
authn_request_use_force_authn	Controls inclusion of ForceAuthn attribute in the request.
authn_request_use_is_passive	Controls inclusion of IsPassive attribute in the request.
authn_request_condition_count	The number of records in the AuthnRequestCondition arrays.
authn_request_condition_audience_list	An accessor to the Audience list parameter of an audience restriction condition.
authn_request_condition_condition_type	Specifies a type of the condition object.
authn_request_condition_proxy_restriction_count	An accessor to the proxy restriction count element of the condition.
authn_request_scoping_idp_count	The number of records in the AuthnRequestScopingIDP arrays.
authn_request_scoping_idp_loc	Contains the value of the Loc attribute.
authn_request_scoping_idp_name	Contains the name of the IdP provider.
authn_request_scoping_idp_provider_id	Contains the provider ID.
authz_decision_query_actions	Specifies the list of actions included in the query.
authz_decision_query_resource	Matches the Resource element of the query.
binding	Returns the SAML message binding type.
blocked_cert_count	The number of records in the BlockedCert arrays.
blocked_cert_bytes	Returns the raw certificate data in DER format.
blocked_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
chain_validation_details	The details of a certificate chain validation outcome.
chain_validation_result	The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
consent	Returns the Consent parameter of the SAML message.
decryption_certificate_bytes	Returns the raw certificate data in DER format.
decryption_certificate_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
destination	Returns the Destination parameter of the SAML message.
fips_mode	Reserved.
id	Returns the ID of the processed message.
ignore_chain_validation_errors	Makes the class tolerant to chain validation errors.
input_type	Returns the type of the processed message.
input_type_string	Returns the type of the processed message, as an original string.
in_response_to	Returns the in-response-to parameter of the message.
issue_instant	Returns the issue time of the message.
issuer	Returns the issuer of the message.
known_cert_count	The number of records in the KnownCert arrays.
known_cert_bytes	Returns the raw certificate data in DER format.
known_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_crl_count	The number of records in the KnownCRL arrays.
known_crl_bytes	Returns the raw CRL data in DER format.
known_crl_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
known_ocsp_count	The number of records in the KnownOCSP arrays.
known_ocsp_bytes	A buffer containing the raw OCSP response data.
known_ocsp_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
logout_request_name_id	Contains the value of the NameID parameter.
logout_request_not_on_or_after	Contains the value of the NotOnOrAfter parameter.
logout_request_reason	Contains the value of the Reason parameter.
logout_request_session_indexes	Contains the list of session indices.
manage_name_id_request_name_id	Contains the value of the NameID parameter of the request.
manage_name_id_request_new_encrypted_id	Contains the value of the NewEncryptedID parameter of the request.
manage_name_id_request_new_id	Contains the value of the NewID parameter.
manage_name_id_request_terminate	Contains the value of the Terminate parameter of the request.
name_id_mapping_request_name_id	An accessor to the NameID parameter of the request.
name_id_mapping_request_name_id_policy_allow_create	Contains the value of AllowCreate parameter of the NameIDPolicy object.
name_id_mapping_request_name_id_policy_format	Specifies the format of the NameIDPolicy element.
name_id_mapping_request_name_id_policy_sp_name_qualifier	Contains the SPNameQualifier parameter of the NameIDPolicy element.
name_id_mapping_request_name_id_policy_use_allow_create	Controls inclusion of UseAllow modifier in the NameIDPolicy object.
offline_mode	Switches the class to offline mode.
pinned_assertion_attr_count	The number of records in the PinnedAssertionAttr arrays.
pinned_assertion_attr_friendly_name	Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.
pinned_assertion_attr_name	Specifies the name of the attribute.
pinned_assertion_attr_name_format	Indicates the format used to reference the attribute.
pinned_assertion_attr_statement_index	Contains the index of the statement the attribute corresponds to.
pinned_assertion_attr_values	Contains a list of attribute values.
pinned_assertion_condition_count	The number of records in the PinnedAssertionCondition arrays.
pinned_assertion_condition_audience_list	An accessor to the Audience list parameter of an audience restriction condition.
pinned_assertion_condition_condition_type	Specifies a type of the condition object.
pinned_assertion_condition_proxy_restriction_count	An accessor to the proxy restriction count element of the condition.
pinned_assertion_info_advice_assertion_count	Contains the number of advice assertions.
pinned_assertion_info_assertion_type	Specifies the type of the assertion.
pinned_assertion_info_chain_validation_details	The details of a certificate chain validation outcome.
pinned_assertion_info_chain_validation_result	The outcome of a certificate chain validation routine.
pinned_assertion_info_conditions_not_before	Represents the Conditions.
pinned_assertion_info_conditions_not_on_or_after	Represents the Conditions.
pinned_assertion_info_encrypted_content	Represents the encrypted assertion content.
pinned_assertion_info_id	Represents the ID of the assertion.
pinned_assertion_info_id_ref	Represents an ID reference value.
pinned_assertion_info_issue_instant	Contains the assertion issuance time stamp.
pinned_assertion_info_signature_validation_result	The outcome of the cryptographic signature validation.
pinned_assertion_info_signed	Specifies whether the assertion is signed.
pinned_assertion_info_uri_ref	Represents an URI reference value.
pinned_assertion_info_validation_log	Contains the signing certificate's chain validation log.
pinned_assertion_info_version	Specifies the SAML protocol version used.
pinned_assertion_issuer	Returns the pinned assertion issuer.
pinned_assertion_statement_count	The number of records in the PinnedAssertionStatement arrays.
pinned_assertion_statement_attributes	Contains a list of statement attribute names.
pinned_assertion_statement_authn_context_authenticating_authorities	Contains the list of authenticating authorities.
pinned_assertion_statement_authn_context_choice	Specifies the authentication context choice variant.
pinned_assertion_statement_authn_context_class_ref	Indicates the authentication contexts class reference.
pinned_assertion_statement_authn_context_decl	Specifies the authentication contexts declaration.
pinned_assertion_statement_authn_context_decl_ref	Specifies the authentication contexts declaration reference.
pinned_assertion_statement_authn_instant	Specifies the authentication event timestamp.
pinned_assertion_statement_authn_session_index	Contains the authentication session index.
pinned_assertion_statement_authn_session_not_on_or_after	Maps to the SessionNotOnOrAfter parameter of the authentication statement.
pinned_assertion_statement_authn_subject_locality_address	Specifies the authentication subjects address.
pinned_assertion_statement_authn_subject_locality_dns_name	Maps to the authentication subjects DNS name parameter.
pinned_assertion_statement_authz_actions	Provides access to the list of actions of the authorization statement.
pinned_assertion_statement_authz_decision	Specifies the authorization decision.
pinned_assertion_statement_authz_decision_evidence	Manages the authorization decision statement evidence parameter.
pinned_assertion_statement_authz_decision_resource	Specifies the authorization decision statement resource parameter.
pinned_assertion_statement_statement_type	Specifies the assertion statement type.
pinned_assertion_subject_confirmation_count	The number of records in the PinnedAssertionSubjectConfirmation arrays.
pinned_assertion_subject_confirmation_data_address	Contains the address enabled for presenting assertions.
pinned_assertion_subject_confirmation_data_in_response_to	The ID of the SAML message in response to which the assertion is issued.
pinned_assertion_subject_confirmation_data_not_before	Time moment before which the subject cannot be confirmed.
pinned_assertion_subject_confirmation_data_not_on_or_after	Limits the time until which the subject can be confirmed.
pinned_assertion_subject_confirmation_data_recipient	The URI of the entity or the location of the resource to which the assertion should be presented.
pinned_assertion_subject_confirmation_data_type	The type of data contained in the confirmation.
pinned_assertion_subject_confirmation_id	The identifier of the entity which can satisfy the subject confirmation requirements.
pinned_assertion_subject_confirmation_method	Specifies the mechanism to be used to confirm the subject.
pinned_assertion_subject_id	Returns the pinned assertion subject.
post_binding_body	Contains the form body.
post_binding_form_template	Contains the XHTML form template returned by the service provider.
post_binding_mode	Specifies whether binding is applied on a server, or on a client side.
post_binding_relay_state	Contains the value of the RelayState parameter of POST binding mechanism.
post_binding_url	Contains the URL of POST binding mechanism.
profile	Specifies a pre-defined profile to apply when creating the signature.
proxy_address	The IP address of the proxy server.
proxy_authentication	The authentication type used by the proxy server.
proxy_password	The password to authenticate to the proxy server.
proxy_port	The port on the proxy server to connect to.
proxy_proxy_type	The type of the proxy server.
proxy_request_headers	Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6	Specifies whether IPv6 should be used when connecting through the proxy.
proxy_use_proxy	Enables or disables proxy-driven connection.
proxy_username	Specifies the username credential for proxy authentication.
redirect_binding_encoding	Specifies the message encoding.
redirect_binding_force_sign	Enforces a signature over all outgoing messages.
redirect_binding_relay_state	Contains the RelayState parameter of the binding.
redirect_binding_sign	Specifies whether to sign generated messages.
redirect_binding_signature_algorithm	Contains the signature algorithm.
redirect_binding_url	Contains the URL of the request query.
redirect_binding_verify_signatures	Instructs the class whether to verify incoming signatures.
redirect_binding_cert_bytes	Returns the raw certificate data in DER format.
redirect_binding_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
response_name_id	Contains the NameID parameter of a NameIDMapping response.
response_optional_element	An optional message element to be returned with the response.
response_response_type	Contains the type of the response.
response_status_code_sub_value	The value of the nested StatusCode.
response_status_code_value	Contains the status code value.
response_status_detail	Contains additional information on the status of the request.
response_status_message	Contains a status message (optional).
signature_validation_result	Contains the signature validation result.
signed	Returns true it the message is signed.
signing_cert_bytes	Returns the raw certificate data in DER format.
signing_cert_ca	Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
signing_cert_ca_key_id	A unique identifier (fingerprint) of the CA certificate's private key.
signing_cert_crl_distribution_points	Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
signing_cert_curve	Specifies the elliptic curve of the EC public key.
signing_cert_fingerprint	Contains the fingerprint (a hash imprint) of this certificate.
signing_cert_friendly_name	Contains an associated alias (friendly name) of the certificate.
signing_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
signing_cert_hash_algorithm	Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
signing_cert_issuer	The common name of the certificate issuer (CA), typically a company name.
signing_cert_issuer_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
signing_cert_key_algorithm	Specifies the public key algorithm of this certificate.
signing_cert_key_bits	Returns the length of the public key.
signing_cert_key_fingerprint	Returns a fingerprint of the public key contained in the certificate.
signing_cert_key_usage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
signing_cert_key_valid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
signing_cert_ocsp_locations	Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
signing_cert_policy_i_ds	Contains identifiers (OIDs) of the applicable certificate policies.
signing_cert_public_key_bytes	Contains the certificate's public key in DER format.
signing_cert_self_signed	Indicates whether the certificate is self-signed (root) or signed by an external CA.
signing_cert_serial_number	Returns the certificate's serial number.
signing_cert_sig_algorithm	Indicates the algorithm that was used by the CA to sign this certificate.
signing_cert_subject	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	Contains a unique identifier (fingerprint) of the certificate's private key.
signing_cert_subject_rdn	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
signing_cert_valid_from	The time point at which the certificate becomes valid, in UTC.
signing_cert_valid_to	The time point at which the certificate expires, in UTC.
socket_dns_mode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
socket_dns_port	Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout	The timeout (in milliseconds) for each DNS query.
socket_dns_servers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout	The timeout (in milliseconds) for the whole resolution process.
socket_incoming_speed_limit	The maximum number of bytes to read from the socket, per second.
socket_local_address	The local network interface to bind the socket to.
socket_local_port	The local port number to bind the socket to.
socket_outgoing_speed_limit	The maximum number of bytes to write to the socket, per second.
socket_timeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6	Enables or disables IP protocol version 6.
subject_confirmation_count	The number of records in the SubjectConfirmation arrays.
subject_confirmation_data_address	Contains the address enabled for presenting assertions.
subject_confirmation_data_in_response_to	The ID of the SAML message in response to which the assertion is issued.
subject_confirmation_data_not_before	Time moment before which the subject cannot be confirmed.
subject_confirmation_data_not_on_or_after	Limits the time until which the subject can be confirmed.
subject_confirmation_data_recipient	The URI of the entity or the location of the resource to which the assertion should be presented.
subject_confirmation_data_type	The type of data contained in the confirmation.
subject_confirmation_id	The identifier of the entity which can satisfy the subject confirmation requirements.
subject_confirmation_method	Specifies the mechanism to be used to confirm the subject.
subject_id	Returns the subject of the message.
tls_auto_validate_certificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration	Selects the base configuration for the TLS settings.
tls_ciphersuites	A list of ciphersuites separated with commas or semicolons.
tls_ec_curves	Defines the elliptic curves to enable.
tls_extensions	Provides access to TLS extensions.
tls_force_resume_if_destination_changes	Whether to force TLS session resumption when the destination address changes.
tls_pre_shared_identity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode	Selects the renegotiation attack prevention mechanism.
tls_revocation_check	Specifies the kind(s) of revocation check to perform.
tls_ssl_options	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_tls_mode	Specifies the TLS mode to use.
tls_use_extended_master_secret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption	Enables or disables the TLS session resumption capability.
tls_versions	The SSL/TLS versions to enable by default.
trusted_cert_count	The number of records in the TrustedCert arrays.
trusted_cert_bytes	Returns the raw certificate data in DER format.
trusted_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
use_binding	Enables or disables automated binding processing.
validate_signatures	Enables or disables automated signature validation.
validation_log	Contains the complete log of the certificate validation routine.
validation_moment	The time point at which chain validity is to be established.
version	Returns SAML content version string.

Method List

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


compare_i_ds	Compares two SAML IDs.
config	Sets or retrieves a configuration setting.
do_action	Performs an additional action.
get_id_prop	Extracts a specific property from a SAML ID.
open	Opens a SAML entity.
open_bytes	Opens a SAML entity.
open_file	Opens a SAML entity.
pin_advice_assertion	Pins advice assertion by propagating it in PinnedAssertionXXX properties.
pin_assertion	Pins assertion by propagating it in PinnedAssertionXXX properties.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_error	Fires to report an error condition.
on_notification	This event notifies the application about an underlying control flow event.
on_signature_found	Signifies the start of signature validation.
on_signature_validated	Reports the signature validation result.

Config Settings

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


IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

artifact_endpoint_index Property

An accessor to the EndpointIndex entry of the artifact.

Syntax

def get_artifact_endpoint_index() -> int: ...

artifact_endpoint_index = property(get_artifact_endpoint_index, None)

Default Value

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.

artifact_message_handle Property

An accessor to the MessageHandle property of the artifact.

Syntax

def get_artifact_message_handle() -> bytes: ...

artifact_message_handle = property(get_artifact_message_handle, None)

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.

artifact_remaining_artifact Property

Returns the contents of the artifact.

Syntax

def get_artifact_remaining_artifact() -> bytes: ...

artifact_remaining_artifact = property(get_artifact_remaining_artifact, None)

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.

artifact_source_id Property

An accessor to the SourceID property of the artifact.

Syntax

def get_artifact_source_id() -> bytes: ...

artifact_source_id = property(get_artifact_source_id, None)

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is read-only.

artifact_type_code Property

The TypeCode property of the artifact.

Syntax

def get_artifact_type_code() -> int: ...

artifact_type_code = property(get_artifact_type_code, None)

Default Value

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_source_id, and artifact_message_handle parameters.

This property is read-only.

artifact_uri Property

An accessor to the URI property of the artifact.

Syntax

def get_artifact_uri() -> str: ...

artifact_uri = property(get_artifact_uri, None)

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.

artifact_resolve_query Property

Returns the content of the ArtifactResolve query.

Syntax

def get_artifact_resolve_query() -> str: ...

artifact_resolve_query = property(get_artifact_resolve_query, None)

Default Value

Remarks

Check this property if input_type is set to cstyArtifactResolve to access the content of the ArtifactResolve query.

This property is read-only.

assertion_count Property

Returns the number of assertions in the SAML message.

Syntax

def get_assertion_count() -> int: ...

assertion_count = property(get_assertion_count, None)

Default Value

Remarks

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

This property is read-only.

assertion_id_request_references Property

Contains the References entry of the SAML assertion ID request.

Syntax

def get_assertion_id_request_references() -> str: ...

assertion_id_request_references = property(get_assertion_id_request_references, None)

Default Value

Remarks

Contains the References entry of the SAML assertion ID request.

Use this property to read or specify the value of the References entry of the Assertion ID Request.

This property is read-only.

attr_query_attr_count Property

The number of records in the AttrQueryAttr arrays.

Syntax

def get_attr_query_attr_count() -> int: ...

attr_query_attr_count = property(get_attr_query_attr_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

attr_query_attr_friendly_name
attr_query_attr_name
attr_query_attr_name_format
attr_query_attr_statement_index
attr_query_attr_values

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

This property is read-only.

attr_query_attr_friendly_name Property

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

Syntax

def get_attr_query_attr_friendly_name(attr_query_attr_index: int) -> str: ...

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

This property is read-only.

attr_query_attr_name Property

Specifies the name of the attribute.

Syntax

def get_attr_query_attr_name(attr_query_attr_index: int) -> str: ...

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

This property is read-only.

attr_query_attr_name_format Property

Indicates the format used to reference the attribute.

Syntax

def get_attr_query_attr_name_format(attr_query_attr_index: int) -> str: ...

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

This property is read-only.

attr_query_attr_statement_index Property

Contains the index of the statement the attribute corresponds to.

Syntax

def get_attr_query_attr_statement_index(attr_query_attr_index: int) -> int: ...

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

This property is read-only.

attr_query_attr_values Property

Contains a list of attribute values.

Syntax

def get_attr_query_attr_values(attr_query_attr_index: int) -> str: ...

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

This property is read-only.

authn_query_comparison Property

Specifies the authentication context comparison method.

Syntax

def get_authn_query_comparison() -> int: ...

authn_query_comparison = property(get_authn_query_comparison, None)

Default Value

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.

authn_query_context_class_refs Property

Specifies the context class reference.

Syntax

def get_authn_query_context_class_refs() -> str: ...

authn_query_context_class_refs = property(get_authn_query_context_class_refs, None)

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.

authn_query_ref_type Property

Specifies the context reference type.

Syntax

def get_authn_query_ref_type() -> int: ...

authn_query_ref_type = property(get_authn_query_ref_type, None)

Default Value

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.

authn_query_session_index Property

Specifies the index of the session to the authentication entity.

Syntax

def get_authn_query_session_index() -> str: ...

authn_query_session_index = property(get_authn_query_session_index, None)

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.

authn_request_assertion_consumer_service_index Property

Specifies the assertion consumer service index.

Syntax

def get_authn_request_assertion_consumer_service_index() -> int: ...

authn_request_assertion_consumer_service_index = property(get_authn_request_assertion_consumer_service_index, None)

Default Value

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.

authn_request_assertion_consumer_service_url Property

Specifies the assertion consumer service URL.

Syntax

def get_authn_request_assertion_consumer_service_url() -> str: ...

authn_request_assertion_consumer_service_url = property(get_authn_request_assertion_consumer_service_url, None)

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.

authn_request_attribute_consuming_service_index Property

Specifies the attribute consuming service index.

Syntax

def get_authn_request_attribute_consuming_service_index() -> int: ...

authn_request_attribute_consuming_service_index = property(get_authn_request_attribute_consuming_service_index, None)

Default Value

Remarks

Specifies the attribute consuming service index.

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

This property is read-only.

authn_request_conditions_not_before Property

Specifies the NotBefore condition of the request.

Syntax

def get_authn_request_conditions_not_before() -> str: ...

authn_request_conditions_not_before = property(get_authn_request_conditions_not_before, None)

Default Value

Remarks

Specifies the NotBefore condition of the request.

Use this property to access or set the NotBefore condition of the request.

This property is read-only.

authn_request_conditions_not_on_or_after Property

Provides access to the NotOnOrAfter condition of the request.

Syntax

def get_authn_request_conditions_not_on_or_after() -> str: ...

authn_request_conditions_not_on_or_after = property(get_authn_request_conditions_not_on_or_after, None)

Default Value

Remarks

Provides access to the NotOnOrAfter condition of the request.

Use this property to access or set the NotOnOrAfter condition of the request.

This property is read-only.

authn_request_context_class_refs Property

Provides access to the authentication context class references.

Syntax

def get_authn_request_context_class_refs() -> str: ...

authn_request_context_class_refs = property(get_authn_request_context_class_refs, None)

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.

authn_request_context_comparison Property

Specifies the AuthnContext comparison method.

Syntax

def get_authn_request_context_comparison() -> int: ...

authn_request_context_comparison = property(get_authn_request_context_comparison, None)

Default Value

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.

authn_request_context_ref_type Property

Specifies the context reference type.

Syntax

def get_authn_request_context_ref_type() -> int: ...

authn_request_context_ref_type = property(get_authn_request_context_ref_type, None)

Default Value

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.

authn_request_force_authn Property

Corresponds to the ForceAuthn parameter of the request.

Syntax

def get_authn_request_force_authn() -> bool: ...

authn_request_force_authn = property(get_authn_request_force_authn, None)

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.

authn_request_is_passive Property

Maps to the IsPassive parameter of the request.

Syntax

def get_authn_request_is_passive() -> bool: ...

authn_request_is_passive = property(get_authn_request_is_passive, None)

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.

authn_request_name_id_policy_allow_create Property

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

def get_authn_request_name_id_policy_allow_create() -> bool: ...

authn_request_name_id_policy_allow_create = property(get_authn_request_name_id_policy_allow_create, None)

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.

authn_request_name_id_policy_format Property

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

Syntax

def get_authn_request_name_id_policy_format() -> str: ...

authn_request_name_id_policy_format = property(get_authn_request_name_id_policy_format, None)

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.

authn_request_name_id_policy_sp_name_qualifier Property

Matches to the SP name qualifier attribute of the request.

Syntax

def get_authn_request_name_id_policy_sp_name_qualifier() -> str: ...

authn_request_name_id_policy_sp_name_qualifier = property(get_authn_request_name_id_policy_sp_name_qualifier, None)

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.

authn_request_name_id_policy_use_allow_create Property

Controls inclusion of AllowCreate attribute in the request.

Syntax

def get_authn_request_name_id_policy_use_allow_create() -> bool: ...

authn_request_name_id_policy_use_allow_create = property(get_authn_request_name_id_policy_use_allow_create, None)

Default Value

FALSE

Remarks

Controls inclusion of AllowCreate attribute in the request.

Use this property to check or specify whether the AllowCreate attribute is included in the authentication request.

This property is read-only.

authn_request_protocol_binding Property

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

Syntax

def get_authn_request_protocol_binding() -> str: ...

authn_request_protocol_binding = property(get_authn_request_protocol_binding, None)

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.

authn_request_provider_name Property

Specifies the name of the requestor.

Syntax

def get_authn_request_provider_name() -> str: ...

authn_request_provider_name = property(get_authn_request_provider_name, None)

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.

authn_request_scoping_idp_list_get_complete Property

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

Syntax

def get_authn_request_scoping_idp_list_get_complete() -> str: ...

authn_request_scoping_idp_list_get_complete = property(get_authn_request_scoping_idp_list_get_complete, None)

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.

authn_request_scoping_proxy_count Property

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

Syntax

def get_authn_request_scoping_proxy_count() -> int: ...

authn_request_scoping_proxy_count = property(get_authn_request_scoping_proxy_count, None)

Default Value

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.

authn_request_scoping_requester_i_ds Property

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

Syntax

def get_authn_request_scoping_requester_i_ds() -> str: ...

authn_request_scoping_requester_i_ds = property(get_authn_request_scoping_requester_i_ds, None)

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.

authn_request_use_force_authn Property

Controls inclusion of ForceAuthn attribute in the request.

Syntax

def get_authn_request_use_force_authn() -> bool: ...

authn_request_use_force_authn = property(get_authn_request_use_force_authn, None)

Default Value

FALSE

Remarks

Controls inclusion of ForceAuthn attribute in the request.

Use this property to check or enable presence of the ForceAuthn attribute in the authentication request. Set this property to false to suppress inclusion of the attribute.

This property is read-only.

authn_request_use_is_passive Property

Controls inclusion of IsPassive attribute in the request.

Syntax

def get_authn_request_use_is_passive() -> bool: ...

authn_request_use_is_passive = property(get_authn_request_use_is_passive, None)

Default Value

FALSE

Remarks

Controls inclusion of IsPassive attribute in the request.

Use this property to check or enable presence of the IsPassive attribute in the authentication request. Set this property to false to suppress inclusion of the attribute.

This property is read-only.

authn_request_condition_count Property

The number of records in the AuthnRequestCondition arrays.

Syntax

def get_authn_request_condition_count() -> int: ...

authn_request_condition_count = property(get_authn_request_condition_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

authn_request_condition_audience_list
authn_request_condition_condition_type
authn_request_condition_proxy_restriction_count
authn_request_conditions_not_before
authn_request_conditions_not_on_or_after

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

This property is read-only.

authn_request_condition_audience_list Property

An accessor to the Audience list parameter of an audience restriction condition.

Syntax

def get_authn_request_condition_audience_list(authn_request_condition_index: int) -> str: ...

Default Value

Remarks

An accessor to the Audience list parameter of an audience restriction condition.

Use this property to 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.

The authn_request_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the authn_request_condition_count property.

This property is read-only.

authn_request_condition_condition_type Property

Specifies a type of the condition object.

Syntax

def get_authn_request_condition_condition_type(authn_request_condition_index: int) -> int: ...

Default Value

Remarks

Specifies a type of the condition object.

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

The authn_request_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the authn_request_condition_count property.

This property is read-only.

authn_request_condition_proxy_restriction_count Property

An accessor to the proxy restriction count element of the condition.

Syntax

def get_authn_request_condition_proxy_restriction_count(authn_request_condition_index: int) -> int: ...

Default Value

Remarks

An accessor to the proxy restriction count element of the condition.

Use this setting to access or set the value of the proxy restriction count condition.

The authn_request_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the authn_request_condition_count property.

This property is read-only.

authn_request_scoping_idp_count Property

The number of records in the AuthnRequestScopingIDP arrays.

Syntax

def get_authn_request_scoping_idp_count() -> int: ...

authn_request_scoping_idp_count = property(get_authn_request_scoping_idp_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

authn_request_scoping_idp_list_get_complete
authn_request_scoping_idp_loc
authn_request_scoping_idp_name
authn_request_scoping_idp_provider_id

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

This property is read-only.

authn_request_scoping_idp_loc Property

Contains the value of the Loc attribute.

Syntax

def get_authn_request_scoping_idp_loc(authn_request_scoping_idp_index: int) -> str: ...

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

This property is read-only.

authn_request_scoping_idp_name Property

Contains the name of the IdP provider.

Syntax

def get_authn_request_scoping_idp_name(authn_request_scoping_idp_index: int) -> str: ...

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

This property is read-only.

authn_request_scoping_idp_provider_id Property

Contains the provider ID.

Syntax

def get_authn_request_scoping_idp_provider_id(authn_request_scoping_idp_index: int) -> str: ...

Default Value

Remarks

Contains the provider ID.

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

The authn_request_scoping_idp_index parameter specifies the index of the item in the array. The size of the array is controlled by the authn_request_scoping_idp_count property.

This property is read-only.

authz_decision_query_actions Property

Specifies the list of actions included in the query.

Syntax

def get_authz_decision_query_actions() -> str: ...

authz_decision_query_actions = property(get_authz_decision_query_actions, None)

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.

authz_decision_query_resource Property

Matches the Resource element of the query.

Syntax

def get_authz_decision_query_resource() -> str: ...

authz_decision_query_resource = property(get_authz_decision_query_resource, None)

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.

binding Property

Returns the SAML message binding type.

Syntax

def get_binding() -> int: ...

binding = property(get_binding, None)

Default Value

Remarks

Check this property to obtain the message binding type.

This property is read-only.

blocked_cert_count Property

The number of records in the BlockedCert arrays.

Syntax

def get_blocked_cert_count() -> int: ...
def set_blocked_cert_count(value: int) -> None: ...

blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

blocked_cert_bytes
blocked_cert_handle

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

blocked_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.

This property is read-only.

blocked_cert_handle Property

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

Syntax

def get_blocked_cert_handle(blocked_cert_index: int) -> int: ...
def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ...

Default Value

Remarks

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

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

The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.

chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_chain_validation_details() -> int: ...

chain_validation_details = property(get_chain_validation_details, None)

Default Value

Remarks

Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

This property is read-only.

chain_validation_result Property

The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.

Syntax

def get_chain_validation_result() -> int: ...

chain_validation_result = property(get_chain_validation_result, None)

Default Value

Remarks

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

consent Property

Returns the Consent parameter of the SAML message.

Syntax

def get_consent() -> str: ...

consent = property(get_consent, None)

Default Value

Remarks

Check this property to access the value of the Consent parameter of the processed SAML message.

This property is read-only.

decryption_certificate_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_decryption_certificate_bytes() -> bytes: ...

decryption_certificate_bytes = property(get_decryption_certificate_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

decryption_certificate_handle Property

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

Syntax

def get_decryption_certificate_handle() -> int: ...
def set_decryption_certificate_handle(value: int) -> None: ...

decryption_certificate_handle = property(get_decryption_certificate_handle, set_decryption_certificate_handle)

Default Value

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.

destination Property

Returns the Destination parameter of the SAML message.

Syntax

def get_destination() -> str: ...

destination = property(get_destination, None)

Default Value

Remarks

Check this property to access the Destination parameter of the SAML message.

This property is read-only.

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

id Property

Returns the ID of the processed message.

Syntax

def get_id() -> str: ...

id = property(get_id, None)

Default Value

Remarks

Use this property to get the SAML ID value of the message.

This property is read-only.

ignore_chain_validation_errors Property

Makes the class tolerant to chain validation errors.

Syntax

def get_ignore_chain_validation_errors() -> bool: ...
def set_ignore_chain_validation_errors(value: bool) -> None: ...

ignore_chain_validation_errors = property(get_ignore_chain_validation_errors, set_ignore_chain_validation_errors)

Default Value

FALSE

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

input_type Property

Returns the type of the processed message.

Syntax

def get_input_type() -> int: ...

input_type = property(get_input_type, None)

Default Value

Remarks

Check this property on the early stage of message processing to find out the type of the data contained in the SAML message.

This property is read-only.

input_type_string Property

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

Syntax

def get_input_type_string() -> str: ...

input_type_string = property(get_input_type_string, None)

Default Value

Remarks

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.

in_response_to Property

Returns the in-response-to parameter of the message.

Syntax

def get_in_response_to() -> str: ...

in_response_to = property(get_in_response_to, None)

Default Value

Remarks

Check this property to obtain the In-Response-To parameter of the SAML message.

This property is read-only.

issue_instant Property

Returns the issue time of the message.

Syntax

def get_issue_instant() -> str: ...

issue_instant = property(get_issue_instant, None)

Default Value

Remarks

Check this property to obtain the issuing time of the SAML message.

This property is read-only.

issuer Property

Returns the issuer of the message.

Syntax

def get_issuer() -> str: ...

issuer = property(get_issuer, None)

Default Value

Remarks

Check this property to obtain the SAML ID of the issuer of the processed message.

This property is read-only.

known_cert_count Property

The number of records in the KnownCert arrays.

Syntax

def get_known_cert_count() -> int: ...
def set_known_cert_count(value: int) -> None: ...

known_cert_count = property(get_known_cert_count, set_known_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_cert_bytes
known_cert_handle

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

known_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_known_cert_bytes(known_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.

This property is read-only.

known_cert_handle Property

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

Syntax

def get_known_cert_handle(known_cert_index: int) -> int: ...
def set_known_cert_handle(known_cert_index: int, value: int) -> None: ...

Default Value

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.

The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.

known_crl_count Property

The number of records in the KnownCRL arrays.

Syntax

def get_known_crl_count() -> int: ...
def set_known_crl_count(value: int) -> None: ...

known_crl_count = property(get_known_crl_count, set_known_crl_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_crl_bytes
known_crl_handle

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

known_crl_bytes Property

Returns the raw CRL data in DER format.

Syntax

def get_known_crl_bytes(known_crl_index: int) -> bytes: ...

Remarks

Returns the raw CRL data in DER format.

The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.

This property is read-only.

known_crl_handle Property

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

Syntax

def get_known_crl_handle(known_crl_index: int) -> int: ...
def set_known_crl_handle(known_crl_index: int, value: int) -> None: ...

Default Value

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.

The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.

known_ocsp_count Property

The number of records in the KnownOCSP arrays.

Syntax

def get_known_ocsp_count() -> int: ...
def set_known_ocsp_count(value: int) -> None: ...

known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count)

Default Value

Remarks

This property controls the size of the following arrays:

known_ocsp_bytes
known_ocsp_handle

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

known_ocsp_bytes Property

A buffer containing the raw OCSP response data.

Syntax

def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ...

Remarks

A buffer containing the raw OCSP response data.

The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.

This property is read-only.

known_ocsp_handle Property

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

Syntax

def get_known_ocsp_handle(known_ocsp_index: int) -> int: ...
def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ...

Default Value

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.

The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.

logout_request_name_id Property

Contains the value of the NameID parameter.

Syntax

def get_logout_request_name_id() -> str: ...

logout_request_name_id = property(get_logout_request_name_id, None)

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.

logout_request_not_on_or_after Property

Contains the value of the NotOnOrAfter parameter.

Syntax

def get_logout_request_not_on_or_after() -> str: ...

logout_request_not_on_or_after = property(get_logout_request_not_on_or_after, None)

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.

logout_request_reason Property

Contains the value of the Reason parameter.

Syntax

def get_logout_request_reason() -> str: ...

logout_request_reason = property(get_logout_request_reason, None)

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.

logout_request_session_indexes Property

Contains the list of session indices.

Syntax

def get_logout_request_session_indexes() -> str: ...

logout_request_session_indexes = property(get_logout_request_session_indexes, None)

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.

manage_name_id_request_name_id Property

Contains the value of the NameID parameter of the request.

Syntax

def get_manage_name_id_request_name_id() -> str: ...

manage_name_id_request_name_id = property(get_manage_name_id_request_name_id, None)

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.

manage_name_id_request_new_encrypted_id Property

Contains the value of the NewEncryptedID parameter of the request.

Syntax

def get_manage_name_id_request_new_encrypted_id() -> str: ...

manage_name_id_request_new_encrypted_id = property(get_manage_name_id_request_new_encrypted_id, None)

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.

manage_name_id_request_new_id Property

Contains the value of the NewID parameter.

Syntax

def get_manage_name_id_request_new_id() -> str: ...

manage_name_id_request_new_id = property(get_manage_name_id_request_new_id, None)

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.

manage_name_id_request_terminate Property

Contains the value of the Terminate parameter of the request.

Syntax

def get_manage_name_id_request_terminate() -> str: ...

manage_name_id_request_terminate = property(get_manage_name_id_request_terminate, None)

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.

name_id_mapping_request_name_id Property

An accessor to the NameID parameter of the request.

Syntax

def get_name_id_mapping_request_name_id() -> str: ...

name_id_mapping_request_name_id = property(get_name_id_mapping_request_name_id, None)

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.

name_id_mapping_request_name_id_policy_allow_create Property

Contains the value of AllowCreate parameter of the NameIDPolicy object.

Syntax

def get_name_id_mapping_request_name_id_policy_allow_create() -> bool: ...

name_id_mapping_request_name_id_policy_allow_create = property(get_name_id_mapping_request_name_id_policy_allow_create, None)

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.

name_id_mapping_request_name_id_policy_format Property

Specifies the format of the NameIDPolicy element.

Syntax

def get_name_id_mapping_request_name_id_policy_format() -> str: ...

name_id_mapping_request_name_id_policy_format = property(get_name_id_mapping_request_name_id_policy_format, None)

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.

name_id_mapping_request_name_id_policy_sp_name_qualifier Property

Contains the SPNameQualifier parameter of the NameIDPolicy element.

Syntax

def get_name_id_mapping_request_name_id_policy_sp_name_qualifier() -> str: ...

name_id_mapping_request_name_id_policy_sp_name_qualifier = property(get_name_id_mapping_request_name_id_policy_sp_name_qualifier, None)

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.

name_id_mapping_request_name_id_policy_use_allow_create Property

Controls inclusion of UseAllow modifier in the NameIDPolicy object.

Syntax

def get_name_id_mapping_request_name_id_policy_use_allow_create() -> bool: ...

name_id_mapping_request_name_id_policy_use_allow_create = property(get_name_id_mapping_request_name_id_policy_use_allow_create, None)

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.

offline_mode Property

Switches the class to offline mode.

Syntax

def get_offline_mode() -> bool: ...
def set_offline_mode(value: bool) -> None: ...

offline_mode = property(get_offline_mode, set_offline_mode)

Default Value

FALSE

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.

pinned_assertion_attr_count Property

The number of records in the PinnedAssertionAttr arrays.

Syntax

def get_pinned_assertion_attr_count() -> int: ...

pinned_assertion_attr_count = property(get_pinned_assertion_attr_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

pinned_assertion_attr_friendly_name
pinned_assertion_attr_name
pinned_assertion_attr_name_format
pinned_assertion_attr_statement_index
pinned_assertion_attr_values

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

This property is read-only.

pinned_assertion_attr_friendly_name Property

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

Syntax

def get_pinned_assertion_attr_friendly_name(pinned_assertion_attr_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_attr_name Property

Specifies the name of the attribute.

Syntax

def get_pinned_assertion_attr_name(pinned_assertion_attr_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_attr_name_format Property

Indicates the format used to reference the attribute.

Syntax

def get_pinned_assertion_attr_name_format(pinned_assertion_attr_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_attr_statement_index Property

Contains the index of the statement the attribute corresponds to.

Syntax

def get_pinned_assertion_attr_statement_index(pinned_assertion_attr_index: int) -> int: ...

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

This property is read-only.

pinned_assertion_attr_values Property

Contains a list of attribute values.

Syntax

def get_pinned_assertion_attr_values(pinned_assertion_attr_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_condition_count Property

The number of records in the PinnedAssertionCondition arrays.

Syntax

def get_pinned_assertion_condition_count() -> int: ...

pinned_assertion_condition_count = property(get_pinned_assertion_condition_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

pinned_assertion_condition_audience_list
pinned_assertion_condition_condition_type
pinned_assertion_condition_proxy_restriction_count

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

This property is read-only.

pinned_assertion_condition_audience_list Property

An accessor to the Audience list parameter of an audience restriction condition.

Syntax

def get_pinned_assertion_condition_audience_list(pinned_assertion_condition_index: int) -> str: ...

Default Value

Remarks

An accessor to the Audience list parameter of an audience restriction condition.

Use this property to 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.

The pinned_assertion_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_condition_count property.

This property is read-only.

pinned_assertion_condition_condition_type Property

Specifies a type of the condition object.

Syntax

def get_pinned_assertion_condition_condition_type(pinned_assertion_condition_index: int) -> int: ...

Default Value

Remarks

Specifies a type of the condition object.

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

The pinned_assertion_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_condition_count property.

This property is read-only.

pinned_assertion_condition_proxy_restriction_count Property

An accessor to the proxy restriction count element of the condition.

Syntax

def get_pinned_assertion_condition_proxy_restriction_count(pinned_assertion_condition_index: int) -> int: ...

Default Value

Remarks

An accessor to the proxy restriction count element of the condition.

Use this setting to access or set the value of the proxy restriction count condition.

The pinned_assertion_condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_condition_count property.

This property is read-only.

pinned_assertion_info_advice_assertion_count Property

Contains the number of advice assertions.

Syntax

def get_pinned_assertion_info_advice_assertion_count() -> int: ...

pinned_assertion_info_advice_assertion_count = property(get_pinned_assertion_info_advice_assertion_count, None)

Default Value

Remarks

Contains the number of advice assertions.

Use this property to access the number of advice assertions.

This property is read-only.

pinned_assertion_info_assertion_type Property

Specifies the type of the assertion.

Syntax

def get_pinned_assertion_info_assertion_type() -> int: ...

pinned_assertion_info_assertion_type = property(get_pinned_assertion_info_assertion_type, None)

Default Value

Remarks

Specifies the type of the assertion.

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

This property is read-only.

pinned_assertion_info_chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_pinned_assertion_info_chain_validation_details() -> int: ...

pinned_assertion_info_chain_validation_details = property(get_pinned_assertion_info_chain_validation_details, None)

Default Value

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

This property is read-only.

pinned_assertion_info_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_pinned_assertion_info_chain_validation_result() -> int: ...

pinned_assertion_info_chain_validation_result = property(get_pinned_assertion_info_chain_validation_result, None)

Default Value

Remarks

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

pinned_assertion_info_conditions_not_before Property

Represents the Conditions.

Syntax

def get_pinned_assertion_info_conditions_not_before() -> str: ...

pinned_assertion_info_conditions_not_before = property(get_pinned_assertion_info_conditions_not_before, None)

Default Value

Remarks

Represents the Conditions.NotBefore assertion property.

Use this property to get or set the Conditions.NotBefore property of the assertion.

This property is read-only.

pinned_assertion_info_conditions_not_on_or_after Property

Represents the Conditions.

Syntax

def get_pinned_assertion_info_conditions_not_on_or_after() -> str: ...

pinned_assertion_info_conditions_not_on_or_after = property(get_pinned_assertion_info_conditions_not_on_or_after, None)

Default Value

Remarks

Represents the Conditions.NotOnOrAfter assertion property.

Use this property to get or set the Conditions.NotOnOrAfter property of the assertion.

This property is read-only.

pinned_assertion_info_encrypted_content Property

Represents the encrypted assertion content.

Syntax

def get_pinned_assertion_info_encrypted_content() -> str: ...

pinned_assertion_info_encrypted_content = property(get_pinned_assertion_info_encrypted_content, None)

Default Value

Remarks

Represents the encrypted assertion content.

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

This property is read-only.

pinned_assertion_info_id Property

Represents the ID of the assertion.

Syntax

def get_pinned_assertion_info_id() -> str: ...

pinned_assertion_info_id = property(get_pinned_assertion_info_id, None)

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.

pinned_assertion_info_id_ref Property

Represents an ID reference value.

Syntax

def get_pinned_assertion_info_id_ref() -> str: ...

pinned_assertion_info_id_ref = property(get_pinned_assertion_info_id_ref, None)

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.

pinned_assertion_info_issue_instant Property

Contains the assertion issuance time stamp.

Syntax

def get_pinned_assertion_info_issue_instant() -> str: ...

pinned_assertion_info_issue_instant = property(get_pinned_assertion_info_issue_instant, None)

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.

pinned_assertion_info_signature_validation_result Property

The outcome of the cryptographic signature validation.

Syntax

def get_pinned_assertion_info_signature_validation_result() -> int: ...

pinned_assertion_info_signature_validation_result = property(get_pinned_assertion_info_signature_validation_result, None)

Default Value

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

This property is read-only.

pinned_assertion_info_signed Property

Specifies whether the assertion is signed.

Syntax

def get_pinned_assertion_info_signed() -> bool: ...

pinned_assertion_info_signed = property(get_pinned_assertion_info_signed, None)

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.

pinned_assertion_info_uri_ref Property

Represents an URI reference value.

Syntax

def get_pinned_assertion_info_uri_ref() -> str: ...

pinned_assertion_info_uri_ref = property(get_pinned_assertion_info_uri_ref, None)

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.

pinned_assertion_info_validation_log Property

Contains the signing certificate's chain validation log.

Syntax

def get_pinned_assertion_info_validation_log() -> str: ...

pinned_assertion_info_validation_log = property(get_pinned_assertion_info_validation_log, None)

Default Value

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

pinned_assertion_info_version Property

Specifies the SAML protocol version used.

Syntax

def get_pinned_assertion_info_version() -> str: ...

pinned_assertion_info_version = property(get_pinned_assertion_info_version, None)

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.

pinned_assertion_issuer Property

Returns the pinned assertion issuer.

Syntax

def get_pinned_assertion_issuer() -> str: ...

pinned_assertion_issuer = property(get_pinned_assertion_issuer, None)

Default Value

Remarks

Check this property to access the SAML ID of the issuer of the assertion previously pinned with pin_assertion or pin_advice_assertion method.

This property is read-only.

pinned_assertion_statement_count Property

The number of records in the PinnedAssertionStatement arrays.

Syntax

def get_pinned_assertion_statement_count() -> int: ...

pinned_assertion_statement_count = property(get_pinned_assertion_statement_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

pinned_assertion_statement_attributes
pinned_assertion_statement_authn_context_authenticating_authorities
pinned_assertion_statement_authn_context_choice
pinned_assertion_statement_authn_context_class_ref
pinned_assertion_statement_authn_context_decl
pinned_assertion_statement_authn_context_decl_ref
pinned_assertion_statement_authn_instant
pinned_assertion_statement_authn_session_index
pinned_assertion_statement_authn_session_not_on_or_after
pinned_assertion_statement_authn_subject_locality_address
pinned_assertion_statement_authn_subject_locality_dns_name
pinned_assertion_statement_authz_actions
pinned_assertion_statement_authz_decision
pinned_assertion_statement_authz_decision_evidence
pinned_assertion_statement_authz_decision_resource
pinned_assertion_statement_statement_type

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

This property is read-only.

pinned_assertion_statement_attributes Property

Contains a list of statement attribute names.

Syntax

def get_pinned_assertion_statement_attributes(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Contains a list of statement attribute names.

Use this property to access the set of names of assertion attributes, separated by CRLF.

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_context_authenticating_authorities Property

Contains the list of authenticating authorities.

Syntax

def get_pinned_assertion_statement_authn_context_authenticating_authorities(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authn_context_choice Property

Specifies the authentication context choice variant.

Syntax

def get_pinned_assertion_statement_authn_context_choice(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authn_context_class_ref Property

Indicates the authentication contexts class reference.

Syntax

def get_pinned_assertion_statement_authn_context_class_ref(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Indicates the authentication contexts class reference.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_context_decl Property

Specifies the authentication contexts declaration.

Syntax

def get_pinned_assertion_statement_authn_context_decl(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Specifies the authentication contexts declaration.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_context_decl_ref Property

Specifies the authentication contexts declaration reference.

Syntax

def get_pinned_assertion_statement_authn_context_decl_ref(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Specifies the authentication contexts declaration reference.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_instant Property

Specifies the authentication event timestamp.

Syntax

def get_pinned_assertion_statement_authn_instant(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authn_session_index Property

Contains the authentication session index.

Syntax

def get_pinned_assertion_statement_authn_session_index(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Contains the authentication session index.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_session_not_on_or_after Property

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

def get_pinned_assertion_statement_authn_session_not_on_or_after(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authn_subject_locality_address Property

Specifies the authentication subjects address.

Syntax

def get_pinned_assertion_statement_authn_subject_locality_address(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Specifies the authentication subjects address.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authn_subject_locality_dns_name Property

Maps to the authentication subjects DNS name parameter.

Syntax

def get_pinned_assertion_statement_authn_subject_locality_dns_name(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authz_actions Property

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

Syntax

def get_pinned_assertion_statement_authz_actions(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_authz_decision Property

Specifies the authorization decision.

Syntax

def get_pinned_assertion_statement_authz_decision(pinned_assertion_statement_index: int) -> int: ...

Default Value

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

This property is read-only.

pinned_assertion_statement_authz_decision_evidence Property

Manages the authorization decision statement evidence parameter.

Syntax

def get_pinned_assertion_statement_authz_decision_evidence(pinned_assertion_statement_index: int) -> str: ...

Default Value

Remarks

Manages the authorization decision statement evidence parameter.

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

The pinned_assertion_statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_assertion_statement_count property.

This property is read-only.

pinned_assertion_statement_authz_decision_resource Property

Specifies the authorization decision statement resource parameter.

Syntax

def get_pinned_assertion_statement_authz_decision_resource(pinned_assertion_statement_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_statement_statement_type Property

Specifies the assertion statement type.

Syntax

def get_pinned_assertion_statement_statement_type(pinned_assertion_statement_index: int) -> int: ...

Default Value

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

This property is read-only.

pinned_assertion_subject_confirmation_count Property

The number of records in the PinnedAssertionSubjectConfirmation arrays.

Syntax

def get_pinned_assertion_subject_confirmation_count() -> int: ...

pinned_assertion_subject_confirmation_count = property(get_pinned_assertion_subject_confirmation_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

pinned_assertion_subject_confirmation_data_address
pinned_assertion_subject_confirmation_data_in_response_to
pinned_assertion_subject_confirmation_data_not_before
pinned_assertion_subject_confirmation_data_not_on_or_after
pinned_assertion_subject_confirmation_data_recipient
pinned_assertion_subject_confirmation_data_type
pinned_assertion_subject_confirmation_id
pinned_assertion_subject_confirmation_method

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

This property is read-only.

pinned_assertion_subject_confirmation_data_address Property

Contains the address enabled for presenting assertions.

Syntax

def get_pinned_assertion_subject_confirmation_data_address(pinned_assertion_subject_confirmation_index: int) -> str: ...

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

This property is read-only.

pinned_assertion_subject_confirmation_data_in_response_to Property

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

Syntax

def get_pinned_assertion_subject_confirmation_data_in_response_to(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_confirmation_data_not_before Property

Time moment before which the subject cannot be confirmed.

Syntax

def get_pinned_assertion_subject_confirmation_data_not_before(pinned_assertion_subject_confirmation_index: int) -> str: ...

Default Value

Remarks

Time moment before which the subject cannot be confirmed.

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

This property is read-only.

pinned_assertion_subject_confirmation_data_not_on_or_after Property

Limits the time until which the subject can be confirmed.

Syntax

def get_pinned_assertion_subject_confirmation_data_not_on_or_after(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_confirmation_data_recipient Property

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

Syntax

def get_pinned_assertion_subject_confirmation_data_recipient(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_confirmation_data_type Property

The type of data contained in the confirmation.

Syntax

def get_pinned_assertion_subject_confirmation_data_type(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_confirmation_id Property

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

Syntax

def get_pinned_assertion_subject_confirmation_id(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_confirmation_method Property

Specifies the mechanism to be used to confirm the subject.

Syntax

def get_pinned_assertion_subject_confirmation_method(pinned_assertion_subject_confirmation_index: int) -> str: ...

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.

This property is read-only.

pinned_assertion_subject_id Property

Returns the pinned assertion subject.

Syntax

def get_pinned_assertion_subject_id() -> str: ...

pinned_assertion_subject_id = property(get_pinned_assertion_subject_id, None)

Default Value

Remarks

Check this property to access the SAML ID of the subject of the assertion previously pinned with pin_assertion or pin_advice_assertion method.

This property is read-only.

post_binding_body Property

Contains the form body.

Syntax

def get_post_binding_body() -> str: ...

post_binding_body = property(get_post_binding_body, None)

Default Value

Remarks

Contains the form body.

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

This property is read-only.

post_binding_form_template Property

Contains the XHTML form template returned by the service provider.

Syntax

def get_post_binding_form_template() -> str: ...

post_binding_form_template = property(get_post_binding_form_template, None)

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.

This property is read-only.

post_binding_mode Property

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

Syntax

def get_post_binding_mode() -> int: ...

post_binding_mode = property(get_post_binding_mode, None)

Default Value

Remarks

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

Use this property to specify whether binding is used on the server or client side of the communication. The default value is cspmClient.

This property is read-only.

post_binding_relay_state Property

Contains the value of the RelayState parameter of POST binding mechanism.

Syntax

def get_post_binding_relay_state() -> str: ...

post_binding_relay_state = property(get_post_binding_relay_state, None)

Default Value

Remarks

Contains the value of the RelayState parameter of POST binding mechanism.

Use this property to read or set the value of the RelayState parameter of the POST binding. RelayState contains an uninterpreted service-provider-originating state object, which should be passed back to it with any further requests.

This property is read-only.

post_binding_url Property

Contains the URL of POST binding mechanism.

Syntax

def get_post_binding_url() -> str: ...

post_binding_url = property(get_post_binding_url, None)

Default Value

Remarks

Contains the URL of POST binding mechanism.

Use this property to check or set the URL of POST binding mechanism.

This property is read-only.

profile Property

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

Syntax

def get_profile() -> str: ...
def set_profile(value: str) -> None: ...

profile = property(get_profile, set_profile)

Default Value

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

proxy_address Property

The IP address of the proxy server.

Syntax

def get_proxy_address() -> str: ...
def set_proxy_address(value: str) -> None: ...

proxy_address = property(get_proxy_address, set_proxy_address)

Default Value

Remarks

The IP address of the proxy server.

proxy_authentication Property

The authentication type used by the proxy server.

Syntax

def get_proxy_authentication() -> int: ...
def set_proxy_authentication(value: int) -> None: ...

proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

proxy_password Property

The password to authenticate to the proxy server.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

Remarks

The password to authenticate to the proxy server.

proxy_port Property

The port on the proxy server to connect to.

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

Remarks

The port on the proxy server to connect to.

proxy_proxy_type Property

The type of the proxy server.

Syntax

def get_proxy_proxy_type() -> int: ...
def set_proxy_proxy_type(value: int) -> None: ...

proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)

Default Value

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

proxy_request_headers Property

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

def get_proxy_request_headers() -> str: ...
def set_proxy_request_headers(value: str) -> None: ...

proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers)

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

proxy_response_body Property

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

Syntax

def get_proxy_response_body() -> str: ...
def set_proxy_response_body(value: str) -> None: ...

proxy_response_body = property(get_proxy_response_body, set_proxy_response_body)

Default Value

Remarks

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

proxy_response_headers Property

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

Syntax

def get_proxy_response_headers() -> str: ...
def set_proxy_response_headers(value: str) -> None: ...

proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers)

Default Value

Remarks

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

proxy_use_ipv6 Property

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

Syntax

def get_proxy_use_ipv6() -> bool: ...
def set_proxy_use_ipv6(value: bool) -> None: ...

proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6)

Default Value

FALSE

Remarks

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

proxy_use_proxy Property

Enables or disables proxy-driven connection.

Syntax

def get_proxy_use_proxy() -> bool: ...
def set_proxy_use_proxy(value: bool) -> None: ...

proxy_use_proxy = property(get_proxy_use_proxy, set_proxy_use_proxy)

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

proxy_username Property

Specifies the username credential for proxy authentication.

Syntax

def get_proxy_username() -> str: ...
def set_proxy_username(value: str) -> None: ...

proxy_username = property(get_proxy_username, set_proxy_username)

Default Value

Remarks

Specifies the username credential for proxy authentication.

redirect_binding_encoding Property

Specifies the message encoding.

Syntax

def get_redirect_binding_encoding() -> str: ...

redirect_binding_encoding = property(get_redirect_binding_encoding, None)

Default Value

Remarks

Specifies the message encoding.

Use this property to access or set the message encoding.

This property is read-only.

redirect_binding_force_sign Property

Enforces a signature over all outgoing messages.

Syntax

def get_redirect_binding_force_sign() -> bool: ...

redirect_binding_force_sign = property(get_redirect_binding_force_sign, None)

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

This property is read-only.

redirect_binding_relay_state Property

Contains the RelayState parameter of the binding.

Syntax

def get_redirect_binding_relay_state() -> str: ...

redirect_binding_relay_state = property(get_redirect_binding_relay_state, None)

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.

redirect_binding_sign Property

Specifies whether to sign generated messages.

Syntax

def get_redirect_binding_sign() -> bool: ...

redirect_binding_sign = property(get_redirect_binding_sign, None)

Default Value

FALSE

Remarks

Specifies whether to sign generated messages.

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 redirect_binding_force_sign property to enforce signatures on all binding entities.

This property is read-only.

redirect_binding_signature_algorithm Property

Contains the signature algorithm.

Syntax

def get_redirect_binding_signature_algorithm() -> str: ...

redirect_binding_signature_algorithm = property(get_redirect_binding_signature_algorithm, None)

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.

redirect_binding_url Property

Contains the URL of the request query.

Syntax

def get_redirect_binding_url() -> str: ...

redirect_binding_url = property(get_redirect_binding_url, None)

Default Value

Remarks

Contains the URL of the request query.

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

This property is read-only.

redirect_binding_verify_signatures Property

Instructs the class whether to verify incoming signatures.

Syntax

def get_redirect_binding_verify_signatures() -> bool: ...

redirect_binding_verify_signatures = property(get_redirect_binding_verify_signatures, None)

Default Value

FALSE

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.

redirect_binding_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_redirect_binding_cert_bytes() -> bytes: ...

redirect_binding_cert_bytes = property(get_redirect_binding_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

redirect_binding_cert_handle Property

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

Syntax

def get_redirect_binding_cert_handle() -> int: ...
def set_redirect_binding_cert_handle(value: int) -> None: ...

redirect_binding_cert_handle = property(get_redirect_binding_cert_handle, set_redirect_binding_cert_handle)

Default Value

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.

response_name_id Property

Contains the NameID parameter of a NameIDMapping response.

Syntax

def get_response_name_id() -> str: ...

response_name_id = property(get_response_name_id, None)

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.

response_optional_element Property

An optional message element to be returned with the response.

Syntax

def get_response_optional_element() -> str: ...

response_optional_element = property(get_response_optional_element, None)

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.

response_response_type Property

Contains the type of the response.

Syntax

def get_response_response_type() -> int: ...

response_response_type = property(get_response_response_type, None)

Default Value

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.

response_status_code_sub_value Property

The value of the nested StatusCode.

Syntax

def get_response_status_code_sub_value() -> str: ...

response_status_code_sub_value = property(get_response_status_code_sub_value, None)

Default Value

Remarks

The value of the nested StatusCode.

This property contains the value of the nested StatusCode element.

This property is read-only.

response_status_code_value Property

Contains the status code value.

Syntax

def get_response_status_code_value() -> str: ...

response_status_code_value = property(get_response_status_code_value, None)

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.

response_status_detail Property

Contains additional information on the status of the request.

Syntax

def get_response_status_detail() -> str: ...

response_status_detail = property(get_response_status_detail, None)

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.

response_status_message Property

Contains a status message (optional).

Syntax

def get_response_status_message() -> str: ...

response_status_message = property(get_response_status_message, None)

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.

signature_validation_result Property

Contains the signature validation result.

Syntax

def get_signature_validation_result() -> int: ...

signature_validation_result = property(get_signature_validation_result, None)

Default Value

Remarks

Use this property to check the result of the most recent XML signature validation.


xsvValid	`0`
xsvUnknown	`1`
xsvCorrupted	`2`
xsvSignerNotFound	`3`
xsvFailure	`4`
xsvReferenceCorrupted	`5`

This property is read-only.

signed Property

Returns true it the message is signed.

Syntax

def get_signed() -> bool: ...

signed = property(get_signed, None)

Default Value

FALSE

Remarks

Check this property to find out whether the SAML entity is signed.

This property is read-only.

signing_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_cert_bytes() -> bytes: ...

signing_cert_bytes = property(get_signing_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

signing_cert_ca Property

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

def get_signing_cert_ca() -> bool: ...

signing_cert_ca = property(get_signing_cert_ca, None)

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

This property is read-only.

signing_cert_ca_key_id Property

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

Syntax

def get_signing_cert_ca_key_id() -> bytes: ...

signing_cert_ca_key_id = property(get_signing_cert_ca_key_id, None)

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

This property is read-only.

signing_cert_crl_distribution_points Property

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

def get_signing_cert_crl_distribution_points() -> str: ...

signing_cert_crl_distribution_points = property(get_signing_cert_crl_distribution_points, None)

Default Value

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only.

signing_cert_curve Property

Specifies the elliptic curve of the EC public key.

Syntax

def get_signing_cert_curve() -> str: ...

signing_cert_curve = property(get_signing_cert_curve, None)

Default Value

Remarks

Specifies the elliptic curve of the EC public key.


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.

signing_cert_fingerprint Property

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

Syntax

def get_signing_cert_fingerprint() -> bytes: ...

signing_cert_fingerprint = property(get_signing_cert_fingerprint, None)

Remarks

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

This property is read-only.

signing_cert_friendly_name Property

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

Syntax

def get_signing_cert_friendly_name() -> str: ...

signing_cert_friendly_name = property(get_signing_cert_friendly_name, None)

Default Value

Remarks

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

This property is read-only.

signing_cert_handle Property

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

Syntax

def get_signing_cert_handle() -> int: ...

signing_cert_handle = property(get_signing_cert_handle, None)

Default Value

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.

This property is read-only.

signing_cert_hash_algorithm Property

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

def get_signing_cert_hash_algorithm() -> str: ...

signing_cert_hash_algorithm = property(get_signing_cert_hash_algorithm, None)

Default Value

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


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.

signing_cert_issuer Property

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

Syntax

def get_signing_cert_issuer() -> str: ...

signing_cert_issuer = property(get_signing_cert_issuer, None)

Default Value

Remarks

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

This property is read-only.

signing_cert_issuer_rdn Property

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

def get_signing_cert_issuer_rdn() -> str: ...

signing_cert_issuer_rdn = property(get_signing_cert_issuer_rdn, None)

Default Value

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is read-only.

signing_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_signing_cert_key_algorithm() -> str: ...

signing_cert_key_algorithm = property(get_signing_cert_key_algorithm, None)

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`

This property is read-only.

signing_cert_key_bits Property

Returns the length of the public key.

Syntax

def get_signing_cert_key_bits() -> int: ...

signing_cert_key_bits = property(get_signing_cert_key_bits, None)

Default Value

Remarks

Returns the length of the public key.

This property is read-only.

signing_cert_key_fingerprint Property

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

Syntax

def get_signing_cert_key_fingerprint() -> bytes: ...

signing_cert_key_fingerprint = property(get_signing_cert_key_fingerprint, None)

Remarks

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

This property is read-only.

signing_cert_key_usage Property

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

Syntax

def get_signing_cert_key_usage() -> int: ...

signing_cert_key_usage = property(get_signing_cert_key_usage, None)

Default Value

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

This property is read-only.

signing_cert_key_valid Property

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

Syntax

def get_signing_cert_key_valid() -> bool: ...

signing_cert_key_valid = property(get_signing_cert_key_valid, None)

Default Value

FALSE

Remarks

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

This property is read-only.

signing_cert_ocsp_locations Property

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

def get_signing_cert_ocsp_locations() -> str: ...

signing_cert_ocsp_locations = property(get_signing_cert_ocsp_locations, None)

Default Value

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only.

signing_cert_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

def get_signing_cert_policy_i_ds() -> str: ...

signing_cert_policy_i_ds = property(get_signing_cert_policy_i_ds, None)

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.

This property is read-only.

signing_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_signing_cert_public_key_bytes() -> bytes: ...

signing_cert_public_key_bytes = property(get_signing_cert_public_key_bytes, None)

Remarks

Contains the certificate's public key in DER format.

This property is read-only.

signing_cert_self_signed Property

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

Syntax

def get_signing_cert_self_signed() -> bool: ...

signing_cert_self_signed = property(get_signing_cert_self_signed, None)

Default Value

FALSE

Remarks

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

This property is read-only.

signing_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_signing_cert_serial_number() -> bytes: ...

signing_cert_serial_number = property(get_signing_cert_serial_number, None)

Remarks

Returns the certificate's serial number.

This property is read-only.

signing_cert_sig_algorithm Property

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

Syntax

def get_signing_cert_sig_algorithm() -> str: ...

signing_cert_sig_algorithm = property(get_signing_cert_sig_algorithm, None)

Default Value

Remarks

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

This property is read-only.

signing_cert_subject Property

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

Syntax

def get_signing_cert_subject() -> str: ...

signing_cert_subject = property(get_signing_cert_subject, None)

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 property is read-only.

signing_cert_subject_key_id Property

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

def get_signing_cert_subject_key_id() -> bytes: ...

signing_cert_subject_key_id = property(get_signing_cert_subject_key_id, None)

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

This property is read-only.

signing_cert_subject_rdn Property

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

def get_signing_cert_subject_rdn() -> str: ...

signing_cert_subject_rdn = property(get_signing_cert_subject_rdn, None)

Default Value

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only.

signing_cert_valid_from Property

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

Syntax

def get_signing_cert_valid_from() -> str: ...

signing_cert_valid_from = property(get_signing_cert_valid_from, None)

Default Value

Remarks

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

This property is read-only.

signing_cert_valid_to Property

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

Syntax

def get_signing_cert_valid_to() -> str: ...

signing_cert_valid_to = property(get_signing_cert_valid_to, None)

Default Value

Remarks

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

This property is read-only.

socket_dns_mode Property

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

Syntax

def get_socket_dns_mode() -> int: ...
def set_socket_dns_mode(value: int) -> None: ...

socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode)

Default Value

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`

socket_dns_port Property

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

Syntax

def get_socket_dns_port() -> int: ...
def set_socket_dns_port(value: int) -> None: ...

socket_dns_port = property(get_socket_dns_port, set_socket_dns_port)

Default Value

Remarks

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

socket_dns_query_timeout Property

The timeout (in milliseconds) for each DNS query.

Syntax

def get_socket_dns_query_timeout() -> int: ...
def set_socket_dns_query_timeout(value: int) -> None: ...

socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout)

Default Value

Remarks

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

socket_dns_servers Property

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

Syntax

def get_socket_dns_servers() -> str: ...
def set_socket_dns_servers(value: str) -> None: ...

socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers)

Default Value

Remarks

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

socket_dns_total_timeout Property

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

Syntax

def get_socket_dns_total_timeout() -> int: ...
def set_socket_dns_total_timeout(value: int) -> None: ...

socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout)

Default Value

Remarks

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

socket_incoming_speed_limit Property

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

Syntax

def get_socket_incoming_speed_limit() -> int: ...
def set_socket_incoming_speed_limit(value: int) -> None: ...

socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)

Default Value

Remarks

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

socket_local_address Property

The local network interface to bind the socket to.

Syntax

def get_socket_local_address() -> str: ...
def set_socket_local_address(value: str) -> None: ...

socket_local_address = property(get_socket_local_address, set_socket_local_address)

Default Value

Remarks

The local network interface to bind the socket to.

socket_local_port Property

The local port number to bind the socket to.

Syntax

def get_socket_local_port() -> int: ...
def set_socket_local_port(value: int) -> None: ...

socket_local_port = property(get_socket_local_port, set_socket_local_port)

Default Value

Remarks

The local port number to bind the socket to.

socket_outgoing_speed_limit Property

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

Syntax

def get_socket_outgoing_speed_limit() -> int: ...
def set_socket_outgoing_speed_limit(value: int) -> None: ...

socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)

Default Value

Remarks

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

socket_timeout Property

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

Syntax

def get_socket_timeout() -> int: ...
def set_socket_timeout(value: int) -> None: ...

socket_timeout = property(get_socket_timeout, set_socket_timeout)

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

socket_use_ipv6 Property

Enables or disables IP protocol version 6.

Syntax

def get_socket_use_ipv6() -> bool: ...
def set_socket_use_ipv6(value: bool) -> None: ...

socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

subject_confirmation_count Property

The number of records in the SubjectConfirmation arrays.

Syntax

def get_subject_confirmation_count() -> int: ...

subject_confirmation_count = property(get_subject_confirmation_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

subject_confirmation_data_address
subject_confirmation_data_in_response_to
subject_confirmation_data_not_before
subject_confirmation_data_not_on_or_after
subject_confirmation_data_recipient
subject_confirmation_data_type
subject_confirmation_id
subject_confirmation_method

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

This property is read-only.

subject_confirmation_data_address Property

Contains the address enabled for presenting assertions.

Syntax

def get_subject_confirmation_data_address(subject_confirmation_index: int) -> str: ...

Default Value

Remarks

Contains the address enabled for presenting assertions.

The subject_confirmation_index parameter specifies the index of the item in the array. The size of the array is controlled by the subject_confirmation_count property.

This property is read-only.

subject_confirmation_data_in_response_to Property

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

Syntax

def get_subject_confirmation_data_in_response_to(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_data_not_before Property

Time moment before which the subject cannot be confirmed.

Syntax

def get_subject_confirmation_data_not_before(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_data_not_on_or_after Property

Limits the time until which the subject can be confirmed.

Syntax

def get_subject_confirmation_data_not_on_or_after(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_data_recipient Property

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

Syntax

def get_subject_confirmation_data_recipient(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_data_type Property

The type of data contained in the confirmation.

Syntax

def get_subject_confirmation_data_type(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_id Property

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

Syntax

def get_subject_confirmation_id(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_confirmation_method Property

Specifies the mechanism to be used to confirm the subject.

Syntax

def get_subject_confirmation_method(subject_confirmation_index: int) -> str: ...

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

This property is read-only.

subject_id Property

Returns the subject of the message.

Syntax

def get_subject_id() -> str: ...

subject_id = property(get_subject_id, None)

Default Value

Remarks

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

This property is read-only.

tls_auto_validate_certificates Property

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

Syntax

def get_tls_auto_validate_certificates() -> bool: ...
def set_tls_auto_validate_certificates(value: bool) -> None: ...

tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)

Default Value

TRUE

Remarks

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

tls_base_configuration Property

Selects the base configuration for the TLS settings.

Syntax

def get_tls_base_configuration() -> int: ...
def set_tls_base_configuration(value: int) -> None: ...

tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)

Default Value

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`

tls_ciphersuites Property

A list of ciphersuites separated with commas or semicolons.

Syntax

def get_tls_ciphersuites() -> str: ...
def set_tls_ciphersuites(value: str) -> None: ...

tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)

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

tls_ec_curves Property

Defines the elliptic curves to enable.

Syntax

def get_tls_ec_curves() -> str: ...
def set_tls_ec_curves(value: str) -> None: ...

tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)

Default Value

Remarks

Defines the elliptic curves to enable.

tls_extensions Property

Provides access to TLS extensions.

Syntax

def get_tls_extensions() -> str: ...
def set_tls_extensions(value: str) -> None: ...

tls_extensions = property(get_tls_extensions, set_tls_extensions)

Default Value

Remarks

Provides access to TLS extensions.

tls_force_resume_if_destination_changes Property

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

Syntax

def get_tls_force_resume_if_destination_changes() -> bool: ...
def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...

tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)

Default Value

FALSE

Remarks

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

tls_pre_shared_identity Property

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

Syntax

def get_tls_pre_shared_identity() -> str: ...
def set_tls_pre_shared_identity(value: str) -> None: ...

tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)

Default Value

Remarks

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

tls_pre_shared_key Property

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

Syntax

def get_tls_pre_shared_key() -> str: ...
def set_tls_pre_shared_key(value: str) -> None: ...

tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)

Default Value

Remarks

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

tls_pre_shared_key_ciphersuite Property

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

Syntax

def get_tls_pre_shared_key_ciphersuite() -> str: ...
def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...

tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)

Default Value

Remarks

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

tls_renegotiation_attack_prevention_mode Property

Selects the renegotiation attack prevention mechanism.

Syntax

def get_tls_renegotiation_attack_prevention_mode() -> int: ...
def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...

tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)

Default Value

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.

tls_revocation_check Property

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

Syntax

def get_tls_revocation_check() -> int: ...
def set_tls_revocation_check(value: int) -> None: ...

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

Default Value

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.

tls_ssl_options Property

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

def get_tls_ssl_options() -> int: ...
def set_tls_ssl_options(value: int) -> None: ...

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

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

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

def get_tls_tls_mode() -> int: ...
def set_tls_tls_mode(value: int) -> None: ...

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

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.

tls_use_extended_master_secret Property

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

Syntax

def get_tls_use_extended_master_secret() -> bool: ...
def set_tls_use_extended_master_secret(value: bool) -> None: ...

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

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

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

def get_tls_use_session_resumption() -> bool: ...
def set_tls_use_session_resumption(value: bool) -> None: ...

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

def get_tls_versions() -> int: ...
def set_tls_versions(value: int) -> None: ...

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

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

trusted_cert_count Property

The number of records in the TrustedCert arrays.

Syntax

def get_trusted_cert_count() -> int: ...
def set_trusted_cert_count(value: int) -> None: ...

trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count)

Default Value

Remarks

This property controls the size of the following arrays:

trusted_cert_bytes
trusted_cert_handle

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

trusted_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

This property is read-only.

trusted_cert_handle Property

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

Syntax

def get_trusted_cert_handle(trusted_cert_index: int) -> int: ...
def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ...

Default Value

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.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

use_binding Property

Enables or disables automated binding processing.

Syntax

def get_use_binding() -> bool: ...
def set_use_binding(value: bool) -> None: ...

use_binding = property(get_use_binding, set_use_binding)

Default Value

FALSE

Remarks

This property controls whether class 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 post_binding and redirect_binding to access the properties of specific binding types.

validate_signatures Property

Enables or disables automated signature validation.

Syntax

def get_validate_signatures() -> bool: ...
def set_validate_signatures(value: bool) -> None: ...

validate_signatures = property(get_validate_signatures, set_validate_signatures)

Default Value

TRUE

Remarks

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

validation_log Property

Contains the complete log of the certificate validation routine.

Syntax

def get_validation_log() -> str: ...

validation_log = property(get_validation_log, None)

Default Value

Remarks

Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.

This property is read-only.

validation_moment Property

The time point at which chain validity is to be established.

Syntax

def get_validation_moment() -> str: ...
def set_validation_moment(value: str) -> None: ...

validation_moment = property(get_validation_moment, set_validation_moment)

Default Value

Remarks

Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.

The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.

version Property

Returns SAML content version string.

Syntax

def get_version() -> str: ...

version = property(get_version, None)

Default Value

Remarks

Check this property to read the SAML content version string, such as "2.0".

This property is read-only.

compare_i_ds Method

Compares two SAML IDs.

Syntax

def compare_i_ds(id1: str, id2: str) -> bool: ...

Remarks

Use this utility function to easily compare two SAML IDs.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

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

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

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_action Method

Performs an additional action.

Syntax

def do_action(action_id: str, action_params: str) -> str: ...

Remarks

do_action is a generic method available in every class. 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;....

get_id_prop Method

Extracts a specific property from a SAML ID.

Syntax

def get_id_prop(id: str, prop_name: str) -> str: ...

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

Opens a SAML entity.

Syntax

def open(input: str) -> None: ...

Remarks

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

open_bytes Method

Opens a SAML entity.

Syntax

def open_bytes(input_bytes: bytes) -> None: ...

Remarks

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

open_file Method

Opens a SAML entity.

Syntax

def open_file(input_file: str) -> None: ...

Remarks

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

pin_advice_assertion Method

Pins advice assertion by propagating it in PinnedAssertionXXX properties.

Syntax

def pin_advice_assertion(assertion_index: int, advice_assertion_index: int) -> None: ...

Remarks

Call this method to pin the advice assertion specified by AssertionIndex by publishing it in the selection of PinnedAssertionXXX properties, such as pinned_assertion_info. Use AdviceAssertionIndex to specify the advice assertion index.

pin_assertion Method

Pins assertion by propagating it in PinnedAssertionXXX properties.

Syntax

def pin_assertion(assertion_index: int) -> None: ...

Remarks

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

Check assertion_count to obtain the number of assertions in the message.

on_error Event

Fires to report an error condition.

Syntax

class SAMLReaderErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class SAMLReader:
@property
def on_error() -> Callable[[SAMLReaderErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SAMLReaderErrorEventParams], None]) -> None: ...

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

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

Syntax

class SAMLReaderNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class SAMLReader:
@property
def on_notification() -> Callable[[SAMLReaderNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[SAMLReaderNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

on_signature_found Event

Signifies the start of signature validation.

Syntax

class SAMLReaderSignatureFoundEventParams(object):
  @property
  def issuer_rdn() -> str: ...

  @property
  def serial_number() -> bytes: ...

  @property
  def subject_key_id() -> bytes: ...

  @property
  def cert_found() -> bool: ...

  @property
  def validate_signature() -> bool: ...
  @validate_signature.setter
  def validate_signature(value) -> None: ...

  @property
  def validate_chain() -> bool: ...
  @validate_chain.setter
  def validate_chain(value) -> None: ...

# In class SAMLReader:
@property
def on_signature_found() -> Callable[[SAMLReaderSignatureFoundEventParams], None]: ...
@on_signature_found.setter
def on_signature_found(event_hook: Callable[[SAMLReaderSignatureFoundEventParams], None]) -> None: ...

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 document or message.

The CertFound parameter is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

on_signature_validated Event

Reports the signature validation result.

Syntax

class SAMLReaderSignatureValidatedEventParams(object):
  @property
  def issuer_rdn() -> str: ...

  @property
  def serial_number() -> bytes: ...

  @property
  def subject_key_id() -> bytes: ...

  @property
  def validation_result() -> int: ...

# In class SAMLReader:
@property
def on_signature_validated() -> Callable[[SAMLReaderSignatureValidatedEventParams], None]: ...
@on_signature_validated.setter
def on_signature_validated(event_hook: Callable[[SAMLReaderSignatureValidatedEventParams], None]) -> None: ...

Remarks

This event is fired when the complete XML signature validation process is finished. 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:


xsvValid	`0`
xsvUnknown	`1`
xsvCorrupted	`2`
xsvSignerNotFound	`3`
xsvFailure	`4`
xsvReferenceCorrupted	`5`

SAMLReader Config Settings

The class 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 class, access to these internal properties is provided through the config method.

SAMLReader Config Settings

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

UseMicrosoftCTL: Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Base Config Settings

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

Supported values are:


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

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class 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.

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.

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 classes that have its CookieCaching property set to "global".

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

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.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. 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 class) 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 devided 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 class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class 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 chached 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 classes.

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

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.

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.