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 message and response. 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. |
| attribute_count | The number of records in the Attribute arrays. |
| attribute_friendly_name | Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e. |
| attribute_name | Specifies the name of the attribute. |
| attribute_name_format | Indicates the format used to reference the attribute. |
| attribute_statement_index | Contains the index of the statement the attribute corresponds to. |
| attribute_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_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_flags | Adjusts secondary serialization properties. |
| 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_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_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. |
| 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_binding_type | Specifies the type of SAML binding to use. |
| binding_body | Contains the POST binding form body. |
| binding_encoding | Specifies the message encoding. |
| binding_force_sign | Enforces a signature over all outgoing messages. |
| binding_form_template | Contains the XHTML form template returned by the service provider. |
| binding_post_mode | Specifies whether binding is applied on the server, or on the client side. |
| binding_relay_state | Contains the RelayState parameter of the binding. |
| binding_signature_algorithm | Contains the signature algorithm. |
| binding_signature_validation_result | The outcome of the cryptographic signature validation. |
| binding_signed | Specifies whether to sign the binding. |
| binding_url | Contains the URL of the request query. |
| binding_verify_signatures | Instructs the class whether to verify incoming signatures. |
| binding_key_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| binding_key_key | The byte array representation of the key. |
| cert_count | The number of records in the Cert arrays. |
| cert_bytes | Returns the raw certificate data in DER format. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| condition_count | The number of records in the Condition arrays. |
| condition_condition | The condition set in accordance with the ConditionType . |
| condition_condition_type | Specifies a type of the condition object. |
| 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. |
| fips_mode | Reserved. |
| 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. |
| message_consent | Contains the Consent parameter of the SAML message. |
| message_content_type | Returns the SAML type of the current message. |
| message_content_type_string | Returns the type of the processed message, as an original string. |
| message_destination | Contains the Destination parameter of the SAML message. |
| message_id | The ID of the request. |
| message_in_response_to | Contains the InResponseTo property of the SAML request. |
| message_issue_instant | Contains request issuance timestamp. |
| message_issuer | Sets the issuer of the message. |
| message_signature_validation_result | The outcome of the cryptographic signature validation. |
| message_signed | Specifies whether the SAML message is or should be signed. |
| message_subject | Gets or sets the subject of the message. |
| message_version | Specifies the protocol version to use for the SAML message. |
| message_xml_header | Controls the inclusion of an XML header in the message. |
| 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. |
| pinned_assertion_assertion_type | Specifies the type of the assertion. |
| pinned_assertion_encrypted_content | Represents the encrypted assertion content. |
| pinned_assertion_id | Represents the ID of the assertion. |
| pinned_assertion_id_ref | Represents an ID reference value. |
| pinned_assertion_issue_instant | Contains the assertion issuance time stamp. |
| pinned_assertion_issuer | Specifies the assertion issuer. |
| pinned_assertion_parent_assertion | Contains the index of the parent assertion in the assertion list. |
| pinned_assertion_signature_validation_result | The outcome of the cryptographic signature validation. |
| pinned_assertion_signed | Specifies whether the assertion is signed. |
| pinned_assertion_subject | Specifies the assertion subject. |
| pinned_assertion_uri_ref | Represents an URI reference value. |
| pinned_assertion_version | Specifies the SAML protocol version used. |
| 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_username | Specifies the username credential for proxy authentication. |
| references | Contains the References entry of the SAML AssertionIDRequest message. |
| 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 | Gets or sets the status 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). |
| scoping_idp_count | The number of records in the ScopingIDP arrays. |
| scoping_idp_loc | Contains the value of the Loc attribute. |
| scoping_idp_name | Contains the name of the IdP provider. |
| scoping_idp_provider_id | Contains the provider ID. |
| security_canonicalization_method | The canonicalization method to use in the signature. |
| security_digest_method | The digest method to use. |
| security_encryption_method | The encryption method used to encrypt the assertion. |
| security_flags | Provides access to secondary security parameters and tweaks. |
| security_sig_method | The signature method to use. |
| security_signature_policy | Specifies the signature validation policy. |
| signing_cert_bytes | Returns the raw certificate data in DER format. |
| signing_cert_ca | Indicates whether the certificate has a CA capability. |
| signing_cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| signing_cert_crl_distribution_points | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| signing_cert_curve | Specifies the elliptic curve associated with the certificate's 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 | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| signing_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| signing_cert_issuer_rdn | A list of Property=Value pairs that uniquely identify 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 in bits. |
| signing_cert_key_fingerprint | Returns a SHA1 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 services that can be used to check this certificate's validity in real time, 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 of the certificate's cryptographic key. |
| signing_cert_subject_rdn | A list of Property=Value pairs that uniquely identify 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. |
| statement_count | The number of records in the Statement arrays. |
| statement_authn_context_authenticating_authorities | Contains the list of authenticating authorities. |
| statement_authn_context_choice | Specifies the authentication context choice variant. |
| statement_authn_context_class_ref | Indicates the authentication contexts class reference. |
| statement_authn_context_decl | Specifies the authentication contexts declaration. |
| statement_authn_context_decl_ref | Specifies the authentication contexts declaration reference. |
| statement_authn_instant | Specifies the authentication event timestamp. |
| statement_authn_session_index | Contains the authentication session index. |
| statement_authn_session_not_on_or_after | Maps to the SessionNotOnOrAfter parameter of the authentication statement. |
| statement_authn_subject_locality_address | Specifies the authentication subjects address. |
| statement_authn_subject_locality_dns_name | Maps to the authentication subjects DNS name parameter. |
| statement_authz_actions | Provides access to the list of actions of the authorization statement. |
| statement_authz_decision | Specifies the authorization decision. |
| statement_authz_decision_evidence | Manages the authorization decision statement evidence parameter. |
| statement_authz_decision_resource | Specifies the authorization decision statement resource parameter. |
| statement_statement_type | Specifies the assertion statement type. |
| subject_confirmation_count | The number of records in the SubjectConfirmation arrays. |
| subject_confirmation_address | Contains the address enabled for presenting assertions. |
| subject_confirmation_data | The uninterpreted value of data entry in the subject confirmation. |
| 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_in_response_to | The ID of the SAML message in response to which the assertion is issued. |
| subject_confirmation_method | Specifies the mechanism to be used to confirm the subject. |
| subject_confirmation_not_before | Time moment before which the subject cannot be confirmed. |
| subject_confirmation_not_on_or_after | Limits the time until which the subject can be confirmed. |
| subject_confirmation_recipient | The URI of the entity or the location of the resource to which the assertion should be presented. |
| 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_client_auth | Enables or disables certificate-based client authentication. |
| 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. |
| use_binding | Enables or disables automated binding processing. |
| validate_signatures | Enables or disables automated signature validation. |
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_assertion | Pins assertion by propagating it in PinnedAssertionXXX properties. |
| reset | Resets the class settings. |
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_encrypted | Notifies the application that the assertion is encrypted and provides recipient certificate 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.
| Body | TBD. |
| EncryptionCert | TBD. |
| EncryptionSubjectRDN | TBD. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| 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. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| 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. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| 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. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| 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. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
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
0
Remarks
An accessor to the EndpointIndex entry of the artifact.
The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer.
This property is read-only.
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
0
Remarks
The TypeCode field of the artifact.
The type code artifact parameter uniquely identifies the artifact format. Currently (as per SAML 2.0) the only type code of 4 is defined. This format assumes the presence of artifact_remaining_artifact, artifact_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 to access the content of the ArtifactResolve query, if the input type is set to cstyArtifactResolve.
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
0
Remarks
Check this property to retrieve the number of assertions contained in the SAML message.
This property is read-only.
attribute_count Property
The number of records in the Attribute arrays.
Syntax
def get_attribute_count() -> int: ...
attribute_count = property(get_attribute_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at attribute_count - 1.This property is read-only.
attribute_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_attribute_friendly_name(attribute_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 attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the attribute_count property.
This property is read-only.
attribute_name Property
Specifies the name of the attribute.
Syntax
def get_attribute_name(attribute_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 attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the attribute_count property.
This property is read-only.
attribute_name_format Property
Indicates the format used to reference the attribute.
Syntax
def get_attribute_name_format(attribute_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 attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the attribute_count property.
This property is read-only.
attribute_statement_index Property
Contains the index of the statement the attribute corresponds to.
Syntax
def get_attribute_statement_index(attribute_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 attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the attribute_count property.
This property is read-only.
attribute_values Property
Contains a list of attribute values.
Syntax
def get_attribute_values(attribute_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 attribute_index parameter specifies the index of the item in the array. The size of the array is controlled by the attribute_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
0
Remarks
Specifies the authentication context comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
This property is read-only.
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
0
Remarks
Specifies the context reference type.
Use this property to access or set the authentication contexts reference type (class or declaration).
This property is read-only.
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
0
Remarks
Specifies the assertion consumer service index.
Use this property to access or set the location index to which the response has to be returned.
This property is read-only.
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
0
Remarks
Specifies the attribute consuming service index.
Use this property to read or set the attribute consuming service index.
This property is read-only.
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
0
Remarks
Specifies the AuthnContext comparison method.
Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).
This property is read-only.
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
0
Remarks
Specifies the context reference type.
Use this property to get or set the context reference type (Class or Declaration).
This property is read-only.
authn_request_flags Property
Adjusts secondary serialization properties.
Syntax
def get_authn_request_flags() -> int: ...
authn_request_flags = property(get_authn_request_flags, None)
Default Value
0
Remarks
Adjusts secondary serialization properties.
Use this bit mask property to adjust how certain properties will be saved. The following flags are supported:
| arfAllowCreate | 1 | Enforces inclusion of NameIDPolicyAllowCreate element in the NameIDPolicy record |
| arfForceAuthn | 2 | Enforces inclusion of the ForceAuthn element |
| arfIsPassive | 4 | Enforces saving of IsPassive element |
This property is read-only.
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_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_get_complete Property
Matches the GetComplete element of the IDPList entry of the Scoping object.
Syntax
def get_authn_request_scoping_get_complete() -> str: ...
authn_request_scoping_get_complete = property(get_authn_request_scoping_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
0
Remarks
The maximum number of proxies on the way between the requestor and the provider.
Use this property to get or set the maximum number of intermediaries allowed between the requestor and the provider.
This property is read-only.
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.
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_binding_type Property
Specifies the type of SAML binding to use.
Syntax
def get_binding_binding_type() -> int: ...
binding_binding_type = property(get_binding_binding_type, None)
Default Value
0
Remarks
Specifies the type of SAML binding to use.
Use this property to specify the binding type to use with the request.
This property is read-only.
binding_body Property
Contains the POST binding form body.
Syntax
def get_binding_body() -> str: ...
binding_body = property(get_binding_body, None)
Default Value
""
Remarks
Contains the POST binding form body.
Use this property to read or set the body of the form returned by the service provider.
This property is read-only.
binding_encoding Property
Specifies the message encoding.
Syntax
def get_binding_encoding() -> str: ...
binding_encoding = property(get_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.
binding_force_sign Property
Enforces a signature over all outgoing messages.
Syntax
def get_binding_force_sign() -> bool: ...
binding_force_sign = property(get_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 binding_sign.
This property is read-only.
binding_form_template Property
Contains the XHTML form template returned by the service provider.
Syntax
def get_binding_form_template() -> str: ...
binding_form_template = property(get_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 (POST binding only).
This property is read-only.
binding_post_mode Property
Specifies whether binding is applied on the server, or on the client side.
Syntax
def get_binding_post_mode() -> int: ...
binding_post_mode = property(get_binding_post_mode, None)
Default Value
0
Remarks
Specifies whether binding is applied on the server, or on the client side.
Use this property to specify whether POST binding is used on the server or client side of the communication. The default value is cspmClient.
This property is read-only.
binding_relay_state Property
Contains the RelayState parameter of the binding.
Syntax
def get_binding_relay_state() -> str: ...
binding_relay_state = property(get_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.
binding_signature_algorithm Property
Contains the signature algorithm.
Syntax
def get_binding_signature_algorithm() -> str: ...
binding_signature_algorithm = property(get_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.
binding_signature_validation_result Property
The outcome of the cryptographic signature validation.
Syntax
def get_binding_signature_validation_result() -> int: ...
binding_signature_validation_result = property(get_binding_signature_validation_result, None)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
binding_signed Property
Specifies whether to sign the binding.
Syntax
def get_binding_signed() -> bool: ...
binding_signed = property(get_binding_signed, None)
Default Value
FALSE
Remarks
Specifies whether to sign the binding.
Use this property to enable or disable signing of generated binding entities. The SAML specification instructs that the binding should only be signed if the original XML was. This property therefore is only taken into account if the original XML was signed. With that in mind, certain service providers demand the binding to be signed at all times. Use binding_force_sign property to enforce signatures on all binding entities.
This property is read-only.
binding_url Property
Contains the URL of the request query.
Syntax
def get_binding_url() -> str: ...
binding_url = property(get_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 or POST target.
This property is read-only.
binding_verify_signatures Property
Instructs the class whether to verify incoming signatures.
Syntax
def get_binding_verify_signatures() -> bool: ...
binding_verify_signatures = property(get_binding_verify_signatures, None)
Default Value
TRUE
Remarks
Instructs the component whether to verify incoming signatures.
Use this property to activate or deactivate verification of signatures in incoming requests.
This property is read-only.
binding_key_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_binding_key_handle() -> int: ... def set_binding_key_handle(value: int) -> None: ...
binding_key_handle = property(get_binding_key_handle, set_binding_key_handle)
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
binding_key_key Property
The byte array representation of the key.
Syntax
def get_binding_key_key() -> bytes: ...
binding_key_key = property(get_binding_key_key, None)
Remarks
The byte array representation of the key. This may not be available for non-binding_key_exportable keys.
This property is read-only.
cert_count Property
The number of records in the Cert arrays.
Syntax
def get_cert_count() -> int: ... def set_cert_count(value: int) -> None: ...
cert_count = property(get_cert_count, set_cert_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at cert_count - 1.cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_cert_bytes(cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
This property is read-only.
cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_cert_handle(cert_index: int) -> int: ... def set_cert_handle(cert_index: int, value: int) -> None: ...
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the cert_count property.
condition_count Property
The number of records in the Condition arrays.
Syntax
def get_condition_count() -> int: ...
condition_count = property(get_condition_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at condition_count - 1.This property is read-only.
condition_condition Property
The condition set in accordance with the ConditionType .
Syntax
def get_condition_condition(condition_index: int) -> str: ...
Default Value
""
Remarks
The condition set in accordance with the condition_type.
For csctAudienceRestriction conditions, read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.
For csctProxyRestriction conditions, check or set the value of the proxy count restriction.
For csctNotBefore and csctNotOnOrAfter, check or set the respective date/time values.
The condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the condition_count property.
This property is read-only.
condition_condition_type Property
Specifies a type of the condition object.
Syntax
def get_condition_condition_type(condition_index: int) -> int: ...
Default Value
0
Remarks
Specifies a type of the condition object.
Use this property to check or specify the type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.
The condition_index parameter specifies the index of the item in the array. The size of the array is controlled by the condition_count property.
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
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
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.
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.
message_consent Property
Contains the Consent parameter of the SAML message.
Syntax
def get_message_consent() -> str: ...
message_consent = property(get_message_consent, None)
Default Value
""
Remarks
Contains the Consent parameter of the SAML message.
Use this property to specify the Consent parameter of the SAML entity.
This property is read-only.
message_content_type Property
Returns the SAML type of the current message.
Syntax
def get_message_content_type() -> int: ...
message_content_type = property(get_message_content_type, None)
Default Value
0
Remarks
Returns the SAML type of the current message.
Use this property to check the type of SAML message being created. This is the same value that was passed to create_new call.
Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if the content type is cstyAuthnQuery, use authn_query property to adjust context class references or comparison settings.
This property is read-only.
message_content_type_string Property
Returns the type of the processed message, as an original string.
Syntax
def get_message_content_type_string() -> str: ...
message_content_type_string = property(get_message_content_type_string, None)
Default Value
""
Remarks
Returns the type of the processed message, as an original string.
Check this property to find out the content type of the data stored in the processed message. This returns a string originally included in the SAML message, which may be helpful when processing non-standard types.
Known SAML content types are:
- AssertionIDRequest
- SubjectQuery
- AuthnQuery
- AttributeQuery
- AuthzDecisionQuery
- AuthnRequest
- ManageNameIDRequest
- NameIDMappingRequest
- LogoutRequest
- ArtifactResolve
- Response
- LogoutResponse
- ArtifactResponse
- NameIDMappingResponse
This property is read-only.
message_destination Property
Contains the Destination parameter of the SAML message.
Syntax
def get_message_destination() -> str: ...
message_destination = property(get_message_destination, None)
Default Value
""
Remarks
Contains the Destination parameter of the SAML message.
Use this property to set the Destination parameter of the created SAML object.
This property is read-only.
message_id Property
The ID of the request.
Syntax
def get_message_id() -> str: ...
message_id = property(get_message_id, None)
Default Value
""
Remarks
The ID of the request.
Use this property to specify the ID of the SAML request or response.
This property is read-only.
message_in_response_to Property
Contains the InResponseTo property of the SAML request.
Syntax
def get_message_in_response_to() -> str: ...
message_in_response_to = property(get_message_in_response_to, None)
Default Value
""
Remarks
Contains the InResponseTo property of the SAML request.
Use this property to specify the ID of the message in response to which the current entity is provided.
This property is read-only.
message_issue_instant Property
Contains request issuance timestamp.
Syntax
def get_message_issue_instant() -> str: ...
message_issue_instant = property(get_message_issue_instant, None)
Default Value
""
Remarks
Contains request issuance timestamp.
Set this property to specify the time moment of the request formation. Leave it empty to use the current system time.
This property is read-only.
message_issuer Property
Sets the issuer of the message.
Syntax
def get_message_issuer() -> str: ...
message_issuer = property(get_message_issuer, None)
Default Value
""
Remarks
Sets the issuer of the message.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Message.Issuer = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
This property is read-only.
message_signature_validation_result Property
The outcome of the cryptographic signature validation.
Syntax
def get_message_signature_validation_result() -> int: ...
message_signature_validation_result = property(get_message_signature_validation_result, None)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
message_signed Property
Specifies whether the SAML message is or should be signed.
Syntax
def get_message_signed() -> bool: ...
message_signed = property(get_message_signed, None)
Default Value
FALSE
Remarks
Specifies whether the SAML message is or should be signed.
Check this property to find out whether the processed message was signed by the sender, or set this property to true to indicate that the created message should be signed.
This property is read-only.
message_subject Property
Gets or sets the subject of the message.
Syntax
def get_message_subject() -> str: ...
message_subject = property(get_message_subject, None)
Default Value
""
Remarks
Gets or sets the subject of the message.
Check this property to obtain the SAML ID of the message subject.
Set this property to include the SAML ID of the issuer of the SAML message. A typical SAML ID is a string of semicolon-separated elements of one or more of the following elements:
- Format
- NameQualifier
- Value
- IDType
- SPNameQualifier
- SPProvidedID
writer.Message.Subject = "Value=https://saml.entity.org/resource;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";
This property is read-only.
message_version Property
Specifies the protocol version to use for the SAML message.
Syntax
def get_message_version() -> str: ...
message_version = property(get_message_version, None)
Default Value
"2.0"
Remarks
Specifies the protocol version to use for the SAML message.
Use this property to change the SAML version that the message complies to. This is set to 2.0 by default, and rarely needs to change.
This property is read-only.
message_xml_header Property
Controls the inclusion of an XML header in the message.
Syntax
def get_message_xml_header() -> bool: ...
message_xml_header = property(get_message_xml_header, None)
Default Value
FALSE
Remarks
Controls the inclusion of an XML header in the message.
Use this property to enable or disable inclusion of the XML header in the SAML message.
This property is read-only.
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.
pinned_assertion_assertion_type Property
Specifies the type of the assertion.
Syntax
def get_pinned_assertion_assertion_type() -> int: ...
pinned_assertion_assertion_type = property(get_pinned_assertion_assertion_type, None)
Default Value
2
Remarks
Specifies the type of the assertion.
Use this property to check or set the type of the assertion.
This property is read-only.
pinned_assertion_encrypted_content Property
Represents the encrypted assertion content.
Syntax
def get_pinned_assertion_encrypted_content() -> str: ...
pinned_assertion_encrypted_content = property(get_pinned_assertion_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_id Property
Represents the ID of the assertion.
Syntax
def get_pinned_assertion_id() -> str: ...
pinned_assertion_id = property(get_pinned_assertion_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_id_ref Property
Represents an ID reference value.
Syntax
def get_pinned_assertion_id_ref() -> str: ...
pinned_assertion_id_ref = property(get_pinned_assertion_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_issue_instant Property
Contains the assertion issuance time stamp.
Syntax
def get_pinned_assertion_issue_instant() -> str: ...
pinned_assertion_issue_instant = property(get_pinned_assertion_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_issuer Property
Specifies the assertion issuer.
Syntax
def get_pinned_assertion_issuer() -> str: ...
pinned_assertion_issuer = property(get_pinned_assertion_issuer, None)
Default Value
""
Remarks
Specifies the assertion issuer.
Use this property to provide the assertion issuer ID.
This property is read-only.
pinned_assertion_parent_assertion Property
Contains the index of the parent assertion in the assertion list.
Syntax
def get_pinned_assertion_parent_assertion() -> int: ...
pinned_assertion_parent_assertion = property(get_pinned_assertion_parent_assertion, None)
Default Value
-1
Remarks
Contains the index of the parent assertion in the assertion list.
This property is set to -1 for normal assertions. ParentAssertion set to a non-negative value indicates that the assertion is an advice assertion incorporated into a top-level assertion. Advice assertions are typically used by service providers to provide additional information about the SAML assertion issuing authority.
This property is read-only.
pinned_assertion_signature_validation_result Property
The outcome of the cryptographic signature validation.
Syntax
def get_pinned_assertion_signature_validation_result() -> int: ...
pinned_assertion_signature_validation_result = property(get_pinned_assertion_signature_validation_result, None)
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only.
pinned_assertion_signed Property
Specifies whether the assertion is signed.
Syntax
def get_pinned_assertion_signed() -> bool: ...
pinned_assertion_signed = property(get_pinned_assertion_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_subject Property
Specifies the assertion subject.
Syntax
def get_pinned_assertion_subject() -> str: ...
pinned_assertion_subject = property(get_pinned_assertion_subject, None)
Default Value
""
Remarks
Specifies the assertion subject.
Use this property to provide the assertion's subject SAML ID.
This property is read-only.
pinned_assertion_uri_ref Property
Represents an URI reference value.
Syntax
def get_pinned_assertion_uri_ref() -> str: ...
pinned_assertion_uri_ref = property(get_pinned_assertion_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_version Property
Specifies the SAML protocol version used.
Syntax
def get_pinned_assertion_version() -> str: ...
pinned_assertion_version = property(get_pinned_assertion_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.
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
0
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
0
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
0
Remarks
The type of the proxy server.
| 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_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.
references Property
Contains the References entry of the SAML AssertionIDRequest message.
Syntax
def get_references() -> str: ...
references = property(get_references, None)
Default Value
""
Remarks
Use this property to read the value of the References entry of the AssertionIDRequest message.
This property is read-only.
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
0
Remarks
Contains the type of the response.
Use this property to get or set the type of the SAML response.
This property is read-only.
response_status Property
Gets or sets the status of the response.
Syntax
def get_response_status() -> int: ...
response_status = property(get_response_status, None)
Default Value
0
Remarks
Gets or sets the status of the response.
This property specifies the status code to include in the response. This property adjusts the values of the response_status_code_value and other status properties.
This property is a bitwise combination of the status facility and an error code. The facility mask can be one of the following:
- 0x00000000 - Success (urn:oasis:names:tc:SAML:2.0:status:Success)
- 0x00010000 - Requester Error (urn:oasis:names:tc:SAML:2.0:status:Requester)
- 0x00020000 - Responder Error (urn:oasis:names:tc:SAML:2.0:status:Responder)
- 0x00030000 - Version Mismatch (urn:oasis:names:tc:SAML:2.0:status:VersionMismatch)
- 0x00FF0000 - Undefined or Unknown
The code assigned to the setting is saved in the response as the status given in the brackets.
The error code can take one of the following values:
- 0x00000001 - Authentication Failed (urn:oasis:names:tc:SAML:2.0:status:AuthnFailed)
- 0x00000002 - Unsupported content received within the received Attribute structure (urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue)
- 0x00000003 - The requested Name Identifier policy is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy)
- 0x00000004 - The requested Authentication Context requirements cannot be satisfied by the provider (urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext)
- 0x00000005 - None of the elements in the IDP list can be resolved (urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP)
- 0x00000006 - The provider cannot authenticate the requestor passively (urn:oasis:names:tc:SAML:2.0:status:NoPassive)
- 0x00000007 - None of the requested providers in the IDP list are supported (urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP)
- 0x00000008 - The Logout request could not be passed on to other session participants (urn:oasis:names:tc:SAML:2.0:status:PartialLogout)
- 0x00000009 - Proxy count exceeded (urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded)
- 0x0000000A - Request denied for internal reasons (urn:oasis:names:tc:SAML:2.0:status:RequestDenied)
- 0x0000000B - The request or its type is not supported by the provider (urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported)
- 0x0000000C - The version of the request has been deprecated (urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated)
- 0x0000000D - The version of the request is too high (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh)
- 0x0000000E - The version of the request is too low (urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow)
- 0x0000000F - The resource included in the request has not been recognised (urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized)
- 0x00000010 - The number of responses to be returned is too high for the provider to satisfy (urn:oasis:names:tc:SAML:2.0:status:TooManyResponses)
- 0x00000011 - The attribute profile is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile)
- 0x00000012 - The principal mentioned in the request is unknown to the provider (urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal)
- 0x00000013 - Unsupported binding type (urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding)
To return a custom error code not available via the above flags, use response_status_code_value and response_status_code_sub_value properties.
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.
scoping_idp_count Property
The number of records in the ScopingIDP arrays.
Syntax
def get_scoping_idp_count() -> int: ...
scoping_idp_count = property(get_scoping_idp_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at scoping_idp_count - 1.This property is read-only.
scoping_idp_loc Property
Contains the value of the Loc attribute.
Syntax
def get_scoping_idp_loc(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 scoping_idp_index parameter specifies the index of the item in the array. The size of the array is controlled by the scoping_idp_count property.
This property is read-only.
scoping_idp_name Property
Contains the name of the IdP provider.
Syntax
def get_scoping_idp_name(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 scoping_idp_index parameter specifies the index of the item in the array. The size of the array is controlled by the scoping_idp_count property.
This property is read-only.
scoping_idp_provider_id Property
Contains the provider ID.
Syntax
def get_scoping_idp_provider_id(scoping_idp_index: int) -> str: ...
Default Value
""
Remarks
Contains the provider ID.
Use this property to read or set the identity provider ID.
The scoping_idp_index parameter specifies the index of the item in the array. The size of the array is controlled by the scoping_idp_count property.
This property is read-only.
security_canonicalization_method Property
The canonicalization method to use in the signature.
Syntax
def get_security_canonicalization_method() -> str: ...
security_canonicalization_method = property(get_security_canonicalization_method, None)
Default Value
""
Remarks
The canonicalization method to use in the signature.
The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)
This property is read-only.
security_digest_method Property
The digest method to use.
Syntax
def get_security_digest_method() -> str: ...
security_digest_method = property(get_security_digest_method, None)
Default Value
""
Remarks
The digest method to use.
The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.
This property is read-only.
security_encryption_method Property
The encryption method used to encrypt the assertion.
Syntax
def get_security_encryption_method() -> str: ...
security_encryption_method = property(get_security_encryption_method, None)
Default Value
"AES256"
Remarks
The encryption method used to encrypt the assertion.
This property contains the encryption algorithm used to encrypt the XML assertion.
Supported values:
| SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
| SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
| SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
| SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
| SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
| SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
| SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
This property is read-only.
security_flags Property
Provides access to secondary security parameters and tweaks.
Syntax
def get_security_flags() -> int: ...
security_flags = property(get_security_flags, None)
Default Value
1
Remarks
Provides access to secondary security parameters and tweaks.
This property is a bitwise combination of zero or more flags. The following flags are currently supported: The following flags can be used with any SAML component (although they may not apply in all modes of use):
| ssfSignatureAfterIssuer | 1 | Place the Signature tag after the issuer tag in the XML document |
| ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata |
| ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element |
| ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element |
| ssfKeyDataSubjectName | 16 | Include the SubjectName key data element |
| ssfKeyDataCertificate | 32 | Include the Certificate key data element |
| ssfKeyDataCRL | 64 | Include the CRL key data element |
| ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) |
| ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests |
| ssfSignLogoutRequests | 262144 | Sign logout requests |
| ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) |
| ssfSignResponses | 1048576 | Sign all responses (IdP only) |
| ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) |
This property is read-only.
security_sig_method Property
The signature method to use.
Syntax
def get_security_sig_method() -> str: ...
security_sig_method = property(get_security_sig_method, None)
Default Value
""
Remarks
The signature method to use.
The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.
This property is read-only.
security_signature_policy Property
Specifies the signature validation policy.
Syntax
def get_security_signature_policy() -> int: ...
security_signature_policy = property(get_security_signature_policy, None)
Default Value
0
Remarks
Specifies the signature validation policy.
Use this property to specify the signature validation policy for the component.
This property is read-only.
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.
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. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
This property is read-only.
signing_cert_ca_key_id Property
A unique identifier (fingerprint) of the CA certificate's cryptographic 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 cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the signing_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
This property is read-only.
signing_cert_crl_distribution_points Property
Contains a list of locations of CRL 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
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
This property is read-only.
signing_cert_curve Property
Specifies the elliptic curve associated with the certificate's 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 associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
This property is read-only.
signing_cert_fingerprint Property
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
def get_signing_cert_fingerprint() -> str: ...
signing_cert_fingerprint = property(get_signing_cert_fingerprint, None)
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
This property is read-only.
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. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
This property is read-only.
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
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only.
signing_cert_hash_algorithm Property
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
Syntax
def get_signing_cert_hash_algorithm() -> str: ...
signing_cert_hash_algorithm = property(get_signing_cert_hash_algorithm, None)
Default Value
""
Remarks
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use signing_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only.
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 is part of a larger set of credentials available via signing_cert_issuer_rdn.
This property is read-only.
signing_cert_issuer_rdn Property
A list of Property=Value pairs that uniquely identify 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 list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
This property is read-only.
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 |
Use the signing_cert_key_bits, signing_cert_curve, and signing_cert_public_key_bytes properties to get more details about the key the certificate contains.
This property is read-only.
signing_cert_key_bits Property
Returns the length of the public key in bits.
Syntax
def get_signing_cert_key_bits() -> int: ...
signing_cert_key_bits = property(get_signing_cert_key_bits, None)
Default Value
0
Remarks
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the signing_cert_public_key_bytes or signing_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
This property is read-only.
signing_cert_key_fingerprint Property
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
def get_signing_cert_key_fingerprint() -> str: ...
signing_cert_key_fingerprint = property(get_signing_cert_key_fingerprint, None)
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the signing_cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
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
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
This property is read-only.
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 services that can be used to check this certificate's validity in real time, 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 services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
This property is read-only.
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.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
This property is read-only.
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 typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
This property is read-only.
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.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
This property is read-only.
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.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
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 is part of a larger set of credentials available via signing_cert_subject_rdn.
This property is read-only.
signing_cert_subject_key_id Property
Contains a unique identifier of the certificate's cryptographic 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 of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The signing_cert_subject_key_id and signing_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
This property is read-only.
signing_cert_subject_rdn Property
A list of Property=Value pairs that uniquely identify 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 list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
This property is read-only.
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
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
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
0
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
0
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
0
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
0
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
0
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
0
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.
statement_count Property
The number of records in the Statement arrays.
Syntax
def get_statement_count() -> int: ...
statement_count = property(get_statement_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
- statement_authn_context_authenticating_authorities
- statement_authn_context_choice
- statement_authn_context_class_ref
- statement_authn_context_decl
- statement_authn_context_decl_ref
- statement_authn_instant
- statement_authn_session_index
- statement_authn_session_not_on_or_after
- statement_authn_subject_locality_address
- statement_authn_subject_locality_dns_name
- statement_authz_actions
- statement_authz_decision
- statement_authz_decision_evidence
- statement_authz_decision_resource
- statement_statement_type
This property is read-only.
statement_authn_context_authenticating_authorities Property
Contains the list of authenticating authorities.
Syntax
def get_statement_authn_context_authenticating_authorities(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_context_choice Property
Specifies the authentication context choice variant.
Syntax
def get_statement_authn_context_choice(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_context_class_ref Property
Indicates the authentication contexts class reference.
Syntax
def get_statement_authn_context_class_ref(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_context_decl Property
Specifies the authentication contexts declaration.
Syntax
def get_statement_authn_context_decl(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_context_decl_ref Property
Specifies the authentication contexts declaration reference.
Syntax
def get_statement_authn_context_decl_ref(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_instant Property
Specifies the authentication event timestamp.
Syntax
def get_statement_authn_instant(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_session_index Property
Contains the authentication session index.
Syntax
def get_statement_authn_session_index(statement_index: int) -> str: ...
Default Value
""
Remarks
Contains the authentication session index.
Use this property to access or set the authentication session index.
The statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_session_not_on_or_after Property
Maps to the SessionNotOnOrAfter parameter of the authentication statement.
Syntax
def get_statement_authn_session_not_on_or_after(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_subject_locality_address Property
Specifies the authentication subjects address.
Syntax
def get_statement_authn_subject_locality_address(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authn_subject_locality_dns_name Property
Maps to the authentication subjects DNS name parameter.
Syntax
def get_statement_authn_subject_locality_dns_name(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authz_actions Property
Provides access to the list of actions of the authorization statement.
Syntax
def get_statement_authz_actions(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authz_decision Property
Specifies the authorization decision.
Syntax
def get_statement_authz_decision(statement_index: int) -> int: ...
Default Value
0
Remarks
Specifies the authorization decision.
Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.
The statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authz_decision_evidence Property
Manages the authorization decision statement evidence parameter.
Syntax
def get_statement_authz_decision_evidence(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_authz_decision_resource Property
Specifies the authorization decision statement resource parameter.
Syntax
def get_statement_authz_decision_resource(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 statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
statement_statement_type Property
Specifies the assertion statement type.
Syntax
def get_statement_statement_type(statement_index: int) -> int: ...
Default Value
0
Remarks
Specifies the assertion statement type.
This property specifies the assertion statement type. A statement can carry an authentication assertion, an attribute assertion, or an authorization decision assertion.
The statement_index parameter specifies the index of the item in the array. The size of the array is controlled by the statement_count property.
This property is read-only.
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
0
Remarks
This property controls the size of the following arrays:
- subject_confirmation_address
- subject_confirmation_data
- subject_confirmation_data_type
- subject_confirmation_id
- subject_confirmation_in_response_to
- subject_confirmation_method
- subject_confirmation_not_before
- subject_confirmation_not_on_or_after
- subject_confirmation_recipient
This property is read-only.
subject_confirmation_address Property
Contains the address enabled for presenting assertions.
Syntax
def get_subject_confirmation_address(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 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 Property
The uninterpreted value of data entry in the subject confirmation.
Syntax
def get_subject_confirmation_data(subject_confirmation_index: int) -> str: ...
Default Value
""
Remarks
The uninterpreted value of data entry in the subject confirmation.
Use this property to read or specify the uninterpreted value of the Data entry in the subject confirmation blob.
The 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_in_response_to Property
The ID of the SAML message in response to which the assertion is issued.
Syntax
def get_subject_confirmation_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_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_confirmation_not_before Property
Time moment before which the subject cannot be confirmed.
Syntax
def get_subject_confirmation_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_not_on_or_after Property
Limits the time until which the subject can be confirmed.
Syntax
def get_subject_confirmation_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_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_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.
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
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
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_client_auth Property
Enables or disables certificate-based client authentication.
Syntax
def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ...
tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
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
2
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
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
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
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
16
Remarks
Various SSL (TLS) protocol options, set of
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
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
0
Remarks
Specifies the TLS mode to use.
| smDefault | 0 | |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
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
16
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 |
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 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.
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;....
Common ActionIDs:
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |
get_id_prop Method
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_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.
Check assertion_count to obtain the number of assertions in the message.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
on_encrypted Event
Notifies the application that the assertion is encrypted and provides recipient certificate details.
Syntax
class SAMLReaderEncryptedEventParams(object): @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def need_credential() -> bool: ... @property def skip_this() -> bool: ... @skip_this.setter def skip_this(value) -> None: ... # In class SAMLReader: @property def on_encrypted() -> Callable[[SAMLReaderEncryptedEventParams], None]: ... @on_encrypted.setter def on_encrypted(event_hook: Callable[[SAMLReaderEncryptedEventParams], None]) -> None: ...
Remarks
The class fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the decryption_certificate property (depending on encryption method used), or sets SkipThis to true.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.
The NeedCredential parameter specifies whether the correct credential is already available to the class or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the decryption_certificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
on_error Event
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 scope() -> int: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def cert_found() -> bool: ... @property def validate() -> bool: ... @validate.setter def validate(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 message.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the 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 KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the signing_certificate property and the associated certificates from the certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
on_signature_validated Event
Reports the signature validation result.
Syntax
class SAMLReaderSignatureValidatedEventParams(object): @property def scope() -> int: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def validation_result() -> int: ... @validation_result.setter def validation_result(value) -> None: ... # 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.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
| sssUnknown | 0 | The scope of signature is unknown |
| sssMessage | 1 | The signature covers the entire SAML message |
| sssAssertion | 2 | The signature covers an assertion |
| sssBinding | 3 | The signature covers the binding |
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
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
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
| 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) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");