# SAMLSPServer Class The SAMLSPServer class represents a SAML service provider. ## Syntax ```text class secureblackbox.SAMLSPServer ``` ## Remarks The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users. SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines. Please find below a step-by-step guide on setting up your own SAML SP endpoint. - Register the IdP metadata using the [import_settings](#import_settings-method) method. Most IDPs let you download their metadata in XML format. The metadata file contains general parameters of the IdP endpoint, such as its web address and algorithm requirements. ```text server.ImportSettings(metadataBytes, false); // contains ""; ``` - Configure the main server capabilities: ```text // public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate; ``` - Personalize the server: ```text server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true"); ``` - Optionally, save metadata to an XML file. This will let you send/upload it to the IdP, so they could set your SP up. Some IdPs can download the metadata right from your SP using the [metadata_url](#metadata_url-property) that you've provided above, in which case saving it to a file is not necessary. ```text server.SaveMetadata("my_metadata.xml"); ``` You are now ready to start the server: ```text server.Start(); ``` The server should now be running on the local system, listening to incoming connections on the port that you have specified above (80). Use your browser to check if the server is responding by navigating to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right, you should see something like this: Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the [base_dir](#base_dir-property) property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg. This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning. *Note*: you can configure which resources to restrict access to using the [protected_resources](#protected_resources-property) property. If [protected_resources](#protected_resources-property) is empty, the server considers all the files in [base_dir](#base_dir-property) and its subfolders to be protected. It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an *assertion*, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your *unique pass* to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser. *Note* that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion. If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a *session* for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [active](#active-property) | Tells whether the server is active and ready to process requests. | | [base_dir](#base_dir-property) | Base directory on the server. | | [binding_key_handle](#binding_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [decryption_cert_bytes](#decryption_cert_bytes-property) | Returns the raw certificate data in DER format. | | [decryption_cert_handle](#decryption_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property) | Reserved. | | [handshake_timeout](#handshake_timeout-property) | Specifies the handshake timeout in milliseconds. | | [host](#host-property) | Specifies the host address of the SP server. | | [id_p_contact_person](#id_p_contact_person-property) | The contact person or persons for the entity. | | [id_p_encryption_key](#id_p_encryption_key-property) | Contains the entity's encryption key. | | [id_p_encryption_methods](#id_p_encryption_methods-property) | Specifies the list of encryption methods supported by the entity. | | [id_p_entity_id](#id_p_entity_id-property) | Represents the SAML entity ID. | | [id_p_flags](#id_p_flags-property) | Adjusts secondary entity properties. | | [id_psso_link](#id_psso_link-property) | Contains a local server page link that triggers SAML authentication to the SP. | | [id_p_name_id_formats](#id_p_name_id_formats-property) | The list of NameID formats supported by this entity. | | [id_p_organization_display_name](#id_p_organization_display_name-property) | The friendly name of the organization that maintains the entity. | | [id_p_organization_lang](#id_p_organization_lang-property) | The language preferred by the organization. | | [id_p_organization_name](#id_p_organization_name-property) | The name of the organization that maintains the entity. | | [id_p_organization_url](#id_p_organization_url-property) | The web URL of the organization that maintains the entity. | | [id_p_signature_validation_result](#id_p_signature_validation_result-property) | The outcome of the cryptographic signature validation. | | [id_p_signed](#id_p_signed-property) | Specifies whether the SAML entity information is or should be signed. | | [id_p_signed_with](#id_p_signed_with-property) | Contains the certificate or key that was used to sign the settings (metadata) document. | | [id_p_signing_key](#id_p_signing_key-property) | Contains the entity's signing key. | | [id_p_valid_until](#id_p_valid_until-property) | Specifies the expiration time of the SAML entity information. | | [id_p_service_count](#id_p_service_count-property) | The number of records in the IdPService arrays. | | [id_p_service_binding_type](#id_p_service_binding_type-property) | Specifies the type of SAML binding that this endpoint accepts. | | [id_p_service_entity_id](#id_p_service_entity_id-property) | Represents the SAML entity ID. | | [id_p_service_location](#id_p_service_location-property) | The location (URL) of the endpoint. | | [id_p_service_priority](#id_p_service_priority-property) | The priority of the endpoint in relation to other endpoints with the same Location . | | [id_p_service_service](#id_p_service_service-property) | The kind of the service being provided at this endpoint. | | [id_p_service_service_index](#id_p_service_service_index-property) | The index of this endpoint. | | [issuer](#issuer-property) | Name identifier of the issuer of the SP's requests. | | [known_cert_count](#known_cert_count-property) | The number of records in the KnownCert arrays. | | [known_cert_bytes](#known_cert_bytes-property) | Returns the raw certificate data in DER format. | | [known_cert_handle](#known_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [known_key_count](#known_key_count-property) | The number of records in the KnownKey arrays. | | [known_key_handle](#known_key_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [logout_page](#logout_page-property) | Specifies the location of the logout page. | | [metadata_url](#metadata_url-property) | The SP's metadata location. | | [meta_signing_cert_bytes](#meta_signing_cert_bytes-property) | Returns the raw certificate data in DER format. | | [meta_signing_cert_handle](#meta_signing_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [offline_mode](#offline_mode-property) | Enables the Offline mode. | | [pinned_client_aead_cipher](#pinned_client_aead_cipher-property) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [pinned_client_chain_validation_details](#pinned_client_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [pinned_client_chain_validation_result](#pinned_client_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [pinned_client_ciphersuite](#pinned_client_ciphersuite-property) | The cipher suite employed by this connection. | | [pinned_client_client_authenticated](#pinned_client_client_authenticated-property) | Specifies whether client authentication was performed during this connection. | | [pinned_client_client_auth_requested](#pinned_client_client_auth_requested-property) | Specifies whether client authentication was requested during this connection. | | [pinned_client_connection_established](#pinned_client_connection_established-property) | Indicates whether the connection has been established fully. | | [pinned_client_connection_id](#pinned_client_connection_id-property) | The unique identifier assigned to this connection. | | [pinned_client_digest_algorithm](#pinned_client_digest_algorithm-property) | The digest algorithm used in a TLS-enabled connection. | | [pinned_client_encryption_algorithm](#pinned_client_encryption_algorithm-property) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [pinned_client_exportable](#pinned_client_exportable-property) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [pinned_client_group](#pinned_client_group-property) | The elliptic curve used in this connection. | | [pinned_client_id](#pinned_client_id-property) | The client connection's unique identifier. | | [pinned_client_key_exchange_algorithm](#pinned_client_key_exchange_algorithm-property) | The key exchange algorithm used in a TLS-enabled connection. | | [pinned_client_key_exchange_key_bits](#pinned_client_key_exchange_key_bits-property) | The length of the key exchange key of a TLS-enabled connection. | | [pinned_client_pfs_cipher](#pinned_client_pfs_cipher-property) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [pinned_client_pre_shared_identity](#pinned_client_pre_shared_identity-property) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [pinned_client_pre_shared_identity_hint](#pinned_client_pre_shared_identity_hint-property) | A hint professed by the server to help the client select the PSK identity to use. | | [pinned_client_public_key_bits](#pinned_client_public_key_bits-property) | The length of the public key. | | [pinned_client_remote_address](#pinned_client_remote_address-property) | The client's IP address. | | [pinned_client_remote_port](#pinned_client_remote_port-property) | The remote port of the client connection. | | [pinned_client_resumed_session](#pinned_client_resumed_session-property) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [pinned_client_secure_connection](#pinned_client_secure_connection-property) | Indicates whether TLS or SSL is enabled for this connection. | | [pinned_client_server_authenticated](#pinned_client_server_authenticated-property) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [pinned_client_signature_algorithm](#pinned_client_signature_algorithm-property) | The signature algorithm used in a TLS handshake. | | [pinned_client_symmetric_block_size](#pinned_client_symmetric_block_size-property) | The block size of the symmetric algorithm used. | | [pinned_client_symmetric_key_bits](#pinned_client_symmetric_key_bits-property) | The key length of the symmetric algorithm used. | | [pinned_client_total_bytes_received](#pinned_client_total_bytes_received-property) | The total number of bytes received over this connection. | | [pinned_client_total_bytes_sent](#pinned_client_total_bytes_sent-property) | The total number of bytes sent over this connection. | | [pinned_client_validation_log](#pinned_client_validation_log-property) | Contains the server certificate's chain validation log. | | [pinned_client_version](#pinned_client_version-property) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [pinned_client_cert_count](#pinned_client_cert_count-property) | The number of records in the PinnedClientCert arrays. | | [pinned_client_cert_bytes](#pinned_client_cert_bytes-property) | Returns the raw certificate data in DER format. | | [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [pinned_client_cert_handle](#pinned_client_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [pinned_client_cert_issuer](#pinned_client_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property) | Returns the length of the public key in bits. | | [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property) | Returns the certificate's serial number. | | [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [pinned_client_cert_subject](#pinned_client_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. | | [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [port](#port-property) | Specifies the listening port number. | | [protected_resources](#protected_resources-property) | Specifies the list of protected resources. | | [redirect_on_logout_page](#redirect_on_logout_page-property) | Specifies the location to redirect the user on logout. | | [security_canonicalization_method](#security_canonicalization_method-property) | The canonicalization method to use in the signature. | | [security_digest_method](#security_digest_method-property) | The digest method to use. | | [security_encryption_method](#security_encryption_method-property) | The encryption method used to encrypt the assertion. | | [security_flags](#security_flags-property) | Provides access to secondary security parameters and tweaks. | | [security_sig_method](#security_sig_method-property) | The signature method to use. | | [security_signature_policy](#security_signature_policy-property) | Specifies the signature validation policy. | | [sender_cert_count](#sender_cert_count-property) | The number of records in the SenderChain arrays. | | [sender_chain_bytes](#sender_chain_bytes-property) | Returns the raw certificate data in DER format. | | [sender_chain_handle](#sender_chain_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_cert_bytes](#signing_cert_bytes-property) | Returns the raw certificate data in DER format. | | [signing_cert_handle](#signing_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_chain_count](#signing_chain_count-property) | The number of records in the SigningChain arrays. | | [signing_chain_bytes](#signing_chain_bytes-property) | Returns the raw certificate data in DER format. | | [signing_chain_handle](#signing_chain_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [sp_contact_person](#sp_contact_person-property) | The contact person or persons for the entity. | | [sp_encryption_key](#sp_encryption_key-property) | Contains the entity's encryption key. | | [sp_encryption_methods](#sp_encryption_methods-property) | Specifies the list of encryption methods supported by the entity. | | [sp_entity_id](#sp_entity_id-property) | Represents the SAML entity ID. | | [sp_flags](#sp_flags-property) | Adjusts secondary entity properties. | | [sp_id_psso_link](#sp_id_psso_link-property) | Contains a local server page link that triggers SAML authentication to the SP. | | [sp_name_id_formats](#sp_name_id_formats-property) | The list of NameID formats supported by this entity. | | [sp_organization_display_name](#sp_organization_display_name-property) | The friendly name of the organization that maintains the entity. | | [sp_organization_lang](#sp_organization_lang-property) | The language preferred by the organization. | | [sp_organization_name](#sp_organization_name-property) | The name of the organization that maintains the entity. | | [sp_organization_url](#sp_organization_url-property) | The web URL of the organization that maintains the entity. | | [sp_signature_validation_result](#sp_signature_validation_result-property) | The outcome of the cryptographic signature validation. | | [sp_signed](#sp_signed-property) | Specifies whether the SAML entity information is or should be signed. | | [sp_signed_with](#sp_signed_with-property) | Contains the certificate or key that was used to sign the settings (metadata) document. | | [sp_signing_key](#sp_signing_key-property) | Contains the entity's signing key. | | [sp_valid_until](#sp_valid_until-property) | Specifies the expiration time of the SAML entity information. | | [sp_service_count](#sp_service_count-property) | The number of records in the SPService arrays. | | [sp_service_binding_type](#sp_service_binding_type-property) | Specifies the type of SAML binding that this endpoint accepts. | | [sp_service_entity_id](#sp_service_entity_id-property) | Represents the SAML entity ID. | | [sp_service_location](#sp_service_location-property) | The location (URL) of the endpoint. | | [sp_service_priority](#sp_service_priority-property) | The priority of the endpoint in relation to other endpoints with the same Location . | | [sp_service_service](#sp_service_service-property) | The kind of the service being provided at this endpoint. | | [sp_service_service_index](#sp_service_service_index-property) | The index of this endpoint. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#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. | | [tls_mode](#tls_mode-property) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property) | The SSL/TLS versions to enable by default. | | [tls_server_cert_count](#tls_server_cert_count-property) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_server_cert_handle](#tls_server_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [url](#url-property) | Specifies the base URL of this SP server. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_id_p_service](#add_id_p_service-method) | Registers an IdP service in the IdPServices list. | | [add_sp_service](#add_sp_service-method) | Registers an SP service in the SPServices list. | | [cleanup](#cleanup-method) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method) | Performs an additional action. | | [drop_client](#drop_client-method) | Terminates a client connection. | | [export_settings](#export_settings-method) | Saves the SP or IdP configuration to an XML metadata file. | | [get_client_buffer](#get_client_buffer-method) | Acquires a piece of operation data. | | [get_provider_property](#get_provider_property-method) | Returns the value of a custom provider property. | | [get_request_bytes](#get_request_bytes-method) | Returns the contents of the connected client's HTTP request. | | [get_request_header](#get_request_header-method) | Returns a request header value. | | [get_response_header](#get_response_header-method) | Returns a response header value. | | [get_session_property](#get_session_property-method) | Returns the value of a custom session property. | | [import_settings](#import_settings-method) | Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. | | [initiate_artifact_resolve](#initiate_artifact_resolve-method) | Initiates the artifact resolution protocol. | | [initiate_attribute_query](#initiate_attribute_query-method) | Initiates the attribute query. | | [initiate_auth](#initiate_auth-method) | Starts SP-initiated SAML authentication flow. | | [initiate_logout](#initiate_logout-method) | Starts SP-initiated SAML logout flow. | | [list_clients](#list_clients-method) | Enumerates the connected clients. | | [pin_client](#pin_client-method) | Takes a snapshot of the connection's properties. | | [process_artifact](#process_artifact-method) | Processes an artifact request received from the IdP service at one of artifact receiver endpoints. | | [process_artifact_resolve_request](#process_artifact_resolve_request-method) | Processes an artifact request received from the SP service at one of the ARS endpoints. | | [process_assertion](#process_assertion-method) | Processes assertion received from the IdP service at one of the ACS endpoints. | | [process_generic_request](#process_generic_request-method) | Processes a generic HTTP SAML request. | | [process_logout_request](#process_logout_request-method) | Processes logout request received from the IdP service at one of the SLS endpoints. | | [reset](#reset-method) | Resets the class settings. | | [set_client_buffer](#set_client_buffer-method) | Commits a data buffer to the connection. | | [set_provider_property](#set_provider_property-method) | Sets the value of a custom provider property. | | [set_response_header](#set_response_header-method) | Sets a response header. | | [set_session_property](#set_session_property-method) | Sets the value of a custom provider session property. | | [start](#start-method) | Starts the SP server. | | [stop](#stop-method) | Stops the IdP server. | ## 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_accept](#on_accept-event) | Reports an incoming connection. | | [on_artifact_received](#on_artifact_received-event) | The server fires this event upon receiving an Artifact message from the other side. | | [on_artifact_resolve_request_prepared](#on_artifact_resolve_request_prepared-event) | This event is fired when a new artifact resolution request message has been prepared by the class. | | [on_artifact_resolve_request_received](#on_artifact_resolve_request_received-event) | Reports receipt of ArtifactResolveRequest message. | | [on_assertion_received](#on_assertion_received-event) | This event is fired when an assertion is received from the IdP. | | [on_attribute_query_prepared](#on_attribute_query_prepared-event) | Notifies the application of the preparation of an AttributeQuery. | | [on_authn_request_prepared](#on_authn_request_prepared-event) | This event is fired when a new authentication request message has been prepared. | | [on_connect](#on_connect-event) | Reports an accepted connection. | | [on_disconnect](#on_disconnect-event) | Fires to report a disconnected client. | | [on_encrypted](#on_encrypted-event) | Notifies the application that the assertion is encrypted and provides recipient certificate details. | | [on_error](#on_error-event) | Information about errors during data delivery. | | [on_external_sign](#on_external_sign-event) | Handles remote or external signing initiated by the server protocol. | | [on_logout_request_prepared](#on_logout_request_prepared-event) | This event is fired when a new logout request has been prepared. | | [on_logout_request_received](#on_logout_request_received-event) | The class uses this event to notify the application about an incoming SAML Logout Request message. | | [on_logout_response_prepared](#on_logout_response_prepared-event) | The class uses this event to notify the application about the Logout Response message being ready to be sent. | | [on_logout_response_received](#on_logout_response_received-event) | The class uses this event to notify the application about an incoming SAML LogoutResponse message. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_processing_completed](#on_processing_completed-event) | This event notifies the application of the completion of request or response processing. | | [on_read_artifact](#on_read_artifact-event) | Requests content identified by an artifact from the application. | | [on_resource_close](#on_resource_close-event) | Tells the application that it can close the opened resource. | | [on_resource_open](#on_resource_open-event) | Requests the application to open the requested resource. | | [on_resource_read](#on_resource_read-event) | Requests the application to read from an opened resource. | | [on_resource_request](#on_resource_request-event) | Notifies the application that a server resource is requested. | | [on_resource_write](#on_resource_write-event) | Requests the application to write to an opened resource. | | [on_saml_message_prepared](#on_saml_message_prepared-event) | This event is fired when a SAML message has been prepared and is ready to be dispatched. | | [on_saml_message_received](#on_saml_message_received-event) | The server fires this event for every SAML message it receives. | | [on_session_created](#on_session_created-event) | This event is fired when a new session has been established. | | [on_session_destroyed](#on_session_destroyed-event) | This event is fired when the SP server has closed a session. | | [on_session_event](#on_session_event-event) | Notifies the application about SAML session events. | | [on_session_info_needed](#on_session_info_needed-event) | This event is fired in OfflineMode to request the session ID for the current flow. | | [on_session_state_retrieve](#on_session_state_retrieve-event) | This event fires to retrieve session state information from the application. | | [on_session_state_save](#on_session_state_save-event) | This event passes a session state object to the application for safekeeping. | | [on_signature_found](#on_signature_found-event) | Signifies the start of signature validation. | | [on_signature_validated](#on_signature_validated-event) | Reports the signature validation result. | | [on_tls_cert_validate](#on_tls_cert_validate-event) | Fires when a client certificate needs to be validated. | | [on_tls_established](#on_tls_established-event) | Reports the setup of a TLS session. | | [on_tls_handshake](#on_tls_handshake-event) | Fires when a newly established client connection initiates a TLS handshake. | | [on_tls_psk](#on_tls_psk-event) | Requests a pre-shared key for TLS-PSK. | | [on_tls_shutdown](#on_tls_shutdown-event) | Reports closure of a TLS session. | | [on_user_auth_completed](#on_user_auth_completed-event) | Notifies the application about the success of user authentication flow. | | [on_user_auth_failed](#on_user_auth_failed-event) | Notifies the application about failure of user authentication flow. | | [on_user_auth_start](#on_user_auth_start-event) | Notifies the application about the start of user authentication flow. | | [on_user_logout_completed](#on_user_logout_completed-event) | Notifies the application about the completion of user logout flow. | | [on_user_logout_start](#on_user_logout_start-event) | Notifies the application about the start of user logout flow. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowOptionsResponseWithoutAuth](#AllowOptionsResponseWithoutAuth) | Enables unauthenticated responses to OPTIONS requests. | | [AttributeConsumingService](#AttributeConsumingService) | TBD. | | [AuthDigestExpire](#AuthDigestExpire) | Specifies digest expiration time for digest authentication. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [ContactPerson](#ContactPerson) | The ContactPerson entry of the provider metadata. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [HomePage](#HomePage) | Specifies the home page resource name. | | [IDPAQS](#IDPAQS) | TBD. | | [IDPARS](#IDPARS) | TBD. | | [IDPSLS](#IDPSLS) | TBD. | | [IDPSSO](#IDPSSO) | TBD. | | [MaxIssueInstantTimeDiff](#MaxIssueInstantTimeDiff) | The maximum issue-instant time delta. | | [OAuthAllowAccessByDefault](#OAuthAllowAccessByDefault) | Specifies whether access to a resource is allowed by default. | | [OAuthAutoValidateTokens](#OAuthAutoValidateTokens) | Allows to validate OAuth 2.0 access tokens automatically. | | [OAuthIntrospectionClientID](#OAuthIntrospectionClientID) | Specifies a client ID on the authentication service. | | [OAuthIntrospectionClientSecret](#OAuthIntrospectionClientSecret) | Specifies a client secret on the authentication service. | | [OAuthIntrospectionURL](#OAuthIntrospectionURL) | Specifies the URL to be used to introspect access tokens. | | [OAuthTokenValidationKeys](#OAuthTokenValidationKeys) | Specifies JW keys in JSON format for validating access token signatures. | | [OrganizationDisplayName](#OrganizationDisplayName) | The OrganizationDisplayName entry of the provider metadata. | | [OrganizationLang](#OrganizationLang) | The OrganizationLang key of the provider metadata. | | [OrganizationName](#OrganizationName) | The OrganizationName element of the provider metadata. | | [OrganizationURL](#OrganizationURL) | The OrganizationURL element of the provider metadata. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [RequestFilter](#RequestFilter) | The request string modifier. | | [SAMLAction](#SAMLAction) | TBD. | | [SAMLBuffer](#SAMLBuffer) | TBD. | | [SAMLResourceProtected](#SAMLResourceProtected) | TBD. | | [SAMLResourceSpecial](#SAMLResourceSpecial) | TBD. | | [SAMLString](#SAMLString) | TBD. | | [SendBufferSize](#SendBufferSize) | The network send buffer size. | | [ServerName](#ServerName) | Specifies the server name for the created responses. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SessionTTL](#SessionTTL) | The SAML session time-to-live value. | | [SignatureAlgorithm](#SignatureAlgorithm) | TBD. | | [TempPath](#TempPath) | Path for storing temporary files. | | [UseZeroIndexForDefaultServices](#UseZeroIndexForDefaultServices) | TBD. | | [WantAssertionsSigned](#WantAssertionsSigned) | TBD. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # active property Tells whether the server is active and ready to process requests. ## Syntax ```text def get_active() -> bool: ... active = property(get_active, None) ``` ## Default Value FALSE ## Remarks This property indicates whether the IdP server is in an active state. This property is read-only. # base_dir property Base directory on the server. ## Syntax ```text def get_base_dir() -> str: ... def set_base_dir(value: str) -> None: ... base_dir = property(get_base_dir, set_base_dir) ``` ## Default Value "" ## Remarks Use this property to specify the base directory for the SP server. # binding_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # decryption_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_decryption_cert_bytes() -> bytes: ... decryption_cert_bytes = property(get_decryption_cert_bytes, None) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. # decryption_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_decryption_cert_handle() -> int: ... def set_decryption_cert_handle(value: int) -> None: ... decryption_cert_handle = property(get_decryption_cert_handle, set_decryption_cert_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # external_crypto_async_document_id property Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax ```text def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ... external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id) ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. # external_crypto_custom_params property Custom parameters to be passed to the signing service (uninterpreted). ## Syntax ```text def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ... external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params) ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). # external_crypto_data property Additional data to be included in the async state and mirrored back by the requestor. ## Syntax ```text def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ... external_crypto_data = property(get_external_crypto_data, set_external_crypto_data) ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. # external_crypto_external_hash_calculation property Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax ```text def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ... external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation) ``` ## Default Value FALSE ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. # external_crypto_hash_algorithm property Specifies the request's signature hash algorithm. ## Syntax ```text def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ... external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | 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 | | # external_crypto_key_id property The ID of the pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ... external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id) ``` ## Default Value "" ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` # external_crypto_key_secret property The pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ... external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret) ``` ## Default Value "" ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic. # external_crypto_method property Specifies the asynchronous signing method. ## Syntax ```text def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ... external_crypto_method = property(get_external_crypto_method, set_external_crypto_method) ``` ## Possible Values ```text 0 # PKCS11 # PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | # external_crypto_mode property Specifies the external cryptography mode. ## Syntax ```text def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ... external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode) ``` ## Possible Values ```text 0 # Default1 # Disabled2 # Generic3 # DCAuth4 # DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | # external_crypto_public_key_algorithm property Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax ```text def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ... external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm) ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | # fips_mode property Reserved. ## Syntax ```text 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. # handshake_timeout property Specifies the handshake timeout in milliseconds. ## Syntax ```text def get_handshake_timeout() -> int: ... def set_handshake_timeout(value: int) -> None: ... handshake_timeout = property(get_handshake_timeout, set_handshake_timeout) ``` ## Default Value 20000 ## Remarks Use this property to set the TLS handshake timeout. # host property Specifies the host address of the SP server. ## Syntax ```text def get_host() -> str: ... def set_host(value: str) -> None: ... host = property(get_host, set_host) ``` ## Default Value "" ## Remarks Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use [port](#port-property). # id_p_contact_person property The contact person or persons for the entity. ## Syntax ```text def get_id_p_contact_person() -> str: ... def set_id_p_contact_person(value: str) -> None: ... id_p_contact_person = property(get_id_p_contact_person, set_id_p_contact_person) ``` ## Default Value "" ## Remarks The contact person or persons for the entity. SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record. Each record contains a semicolon-separated list of contact person parameters, for example: ```text Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678 ``` You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property. # id_p_encryption_key property Contains the entity's encryption key. ## Syntax ```text def get_id_p_encryption_key() -> str: ... def set_id_p_encryption_key(value: str) -> None: ... id_p_encryption_key = property(get_id_p_encryption_key, set_id_p_encryption_key) ``` ## Default Value "" ## Remarks Contains the entity's encryption key. This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings). Requests sent to the endpoint can be encrypted with the provided key or certificate. # id_p_encryption_methods property Specifies the list of encryption methods supported by the entity. ## Syntax ```text def get_id_p_encryption_methods() -> str: ... def set_id_p_encryption_methods(value: str) -> None: ... id_p_encryption_methods = property(get_id_p_encryption_methods, set_id_p_encryption_methods) ``` ## Default Value "" ## Remarks Specifies the list of encryption methods supported by the entity. This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity. Examples of algorithms supported by this property: - http://www.w3.org/2009/xmlenc11#aes128-gcm - http://www.w3.org/2001/04/xmlenc#aes256-cbc # id_p_entity_id property Represents the SAML entity ID. ## Syntax ```text def get_id_p_entity_id() -> str: ... def set_id_p_entity_id(value: str) -> None: ... id_p_entity_id = property(get_id_p_entity_id, set_id_p_entity_id) ``` ## Default Value "" ## Remarks Represents the SAML entity ID. Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com). # id_p_flags property Adjusts secondary entity properties. ## Syntax ```text def get_id_p_flags() -> int: ... def set_id_p_flags(value: int) -> None: ... id_p_flags = property(get_id_p_flags, set_id_p_flags) ``` ## Default Value 0 ## Remarks Adjusts secondary entity properties. Use this bit mask property to adjust certain secondary settings. The following flags are supported: - 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in. # id_psso_link property Contains a local server page link that triggers SAML authentication to the SP. ## Syntax ```text def get_id_psso_link() -> str: ... def set_id_psso_link(value: str) -> None: ... id_psso_link = property(get_id_psso_link, set_id_psso_link) ``` ## Default Value "" ## Remarks Contains a local server page link that triggers SAML authentication to the SP. This property specifies the web link that initiates the transfer of SAML authentication fact to the SP. One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider. # id_p_name_id_formats property The list of NameID formats supported by this entity. ## Syntax ```text def get_id_p_name_id_formats() -> str: ... def set_id_p_name_id_formats(value: str) -> None: ... id_p_name_id_formats = property(get_id_p_name_id_formats, set_id_p_name_id_formats) ``` ## Default Value "" ## Remarks The list of NameID formats supported by this entity. Use this setting to get or set the list of NameID formats supported by the entity. Use SAML notation for the formats: - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress # id_p_organization_display_name property The friendly name of the organization that maintains the entity. ## Syntax ```text def get_id_p_organization_display_name() -> str: ... def set_id_p_organization_display_name(value: str) -> None: ... id_p_organization_display_name = property(get_id_p_organization_display_name, set_id_p_organization_display_name) ``` ## Default Value "" ## Remarks The friendly name of the organization that maintains the entity. Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity. # id_p_organization_lang property The language preferred by the organization. ## Syntax ```text def get_id_p_organization_lang() -> str: ... def set_id_p_organization_lang(value: str) -> None: ... id_p_organization_lang = property(get_id_p_organization_lang, set_id_p_organization_lang) ``` ## Default Value "" ## Remarks The language preferred by the organization. This optional setting can be used to adjust the preferred language of the owning organization. # id_p_organization_name property The name of the organization that maintains the entity. ## Syntax ```text def get_id_p_organization_name() -> str: ... def set_id_p_organization_name(value: str) -> None: ... id_p_organization_name = property(get_id_p_organization_name, set_id_p_organization_name) ``` ## Default Value "" ## Remarks The name of the organization that maintains the entity. Use this setting to get or set the name of the organization that maintains the SAML entity. # id_p_organization_url property The web URL of the organization that maintains the entity. ## Syntax ```text def get_id_p_organization_url() -> str: ... def set_id_p_organization_url(value: str) -> None: ... id_p_organization_url = property(get_id_p_organization_url, set_id_p_organization_url) ``` ## Default Value "" ## Remarks The web URL of the organization that maintains the entity. Use this setting to get or set the web address of the organization responsible for this SAML entity. # id_p_signature_validation_result property The outcome of the cryptographic signature validation. ## Syntax ```text def get_id_p_signature_validation_result() -> int: ... id_p_signature_validation_result = property(get_id_p_signature_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only. # id_p_signed property Specifies whether the SAML entity information is or should be signed. ## Syntax ```text def get_id_p_signed() -> bool: ... id_p_signed = property(get_id_p_signed, None) ``` ## Default Value FALSE ## Remarks Specifies whether the SAML entity information is or should be signed. Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed. This property is read-only. # id_p_signed_with property Contains the certificate or key that was used to sign the settings (metadata) document. ## Syntax ```text def get_id_p_signed_with() -> str: ... id_p_signed_with = property(get_id_p_signed_with, None) ``` ## Default Value "" ## Remarks Contains the certificate or key that was used to sign the settings (metadata) document. This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate. The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the [id_p_signature_validation_result](#id_p_signature_validation_result-property) setting. This property is read-only. # id_p_signing_key property Contains the entity's signing key. ## Syntax ```text def get_id_p_signing_key() -> str: ... def set_id_p_signing_key(value: str) -> None: ... id_p_signing_key = property(get_id_p_signing_key, set_id_p_signing_key) ``` ## Default Value "" ## Remarks Contains the entity's signing key. This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key. The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates. # id_p_valid_until property Specifies the expiration time of the SAML entity information. ## Syntax ```text def get_id_p_valid_until() -> str: ... def set_id_p_valid_until(value: str) -> None: ... id_p_valid_until = property(get_id_p_valid_until, set_id_p_valid_until) ``` ## Default Value "" ## Remarks Specifies the expiration time of the SAML entity information. This setting only makes sense when the information was loaded or is going to be saved to a metadata XML. # id_p_service_count property The number of records in the IdPService arrays. ## Syntax ```text def get_id_p_service_count() -> int: ... id_p_service_count = property(get_id_p_service_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [id_p_service_binding_type](#id_p_service_binding_type-property) - [id_p_service_entity_id](#id_p_service_entity_id-property) - [id_p_service_location](#id_p_service_location-property) - [id_p_service_priority](#id_p_service_priority-property) - [id_p_service_service](#id_p_service_service-property) - [id_p_service_service_index](#id_p_service_service_index-property) The array indices start at *0* and end at *id_p_service_count - 1*. This property is read-only. # id_p_service_binding_type property Specifies the type of SAML binding that this endpoint accepts. ## Syntax ```text def get_id_p_service_binding_type(id_p_service_index: int) -> int: ... ``` ## Possible Values ```text 0 # None1 # SOAP2 # PAOS3 # Redirect4 # POST5 # Artifact ``` ## Default Value 0 ## Remarks Specifies the type of SAML binding that this endpoint accepts. Use this property to specify the binding type to use with this endpoint. The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # id_p_service_entity_id property Represents the SAML entity ID. ## Syntax ```text def get_id_p_service_entity_id(id_p_service_index: int) -> str: ... ``` ## Default Value "" ## Remarks Represents the SAML entity ID. Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com). The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # id_p_service_location property The location (URL) of the endpoint. ## Syntax ```text def get_id_p_service_location(id_p_service_index: int) -> str: ... ``` ## Default Value "" ## Remarks The location (URL) of the endpoint. The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # id_p_service_priority property The priority of the endpoint in relation to other endpoints with the same Location . ## Syntax ```text def get_id_p_service_priority(id_p_service_index: int) -> int: ... ``` ## Default Value -1 ## Remarks The priority of the endpoint in relation to other endpoints with the same [id_p_location](#SAMLSPServer_p_IdPLocation). Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute. Leave all priorities at -1 to omit generation of the Default attribute. The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # id_p_service_service property The kind of the service being provided at this endpoint. ## Syntax ```text def get_id_p_service_service(id_p_service_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The kind of the service being provided at this endpoint. The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService. The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # id_p_service_service_index property The index of this endpoint. ## Syntax ```text def get_id_p_service_service_index(id_p_service_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The index of this endpoint. For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers. The *id_p_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [id_p_service_count](#id_p_service_count-property) property. This property is read-only. # issuer property Name identifier of the issuer of the SP's requests. ## Syntax ```text def get_issuer() -> str: ... def set_issuer(value: str) -> None: ... issuer = property(get_issuer, set_issuer) ``` ## Default Value "" ## Remarks Use this property to set the name identifier of this Service Provider (SP) to be used in its requests. # known_cert_count property The number of records in the KnownCert arrays. ## Syntax ```text def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ... known_cert_count = property(get_known_cert_count, set_known_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_cert_bytes](#known_cert_bytes-property) - [known_cert_handle](#known_cert_handle-property) The array indices start at *0* and end at *known_cert_count - 1*. # known_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_known_cert_bytes(known_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. This property is read-only. # known_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_cert_handle(known_cert_index: int) -> int: ... def set_known_cert_handle(known_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_cert_count](#known_cert_count-property) property. # known_key_count property The number of records in the KnownKey arrays. ## Syntax ```text def get_known_key_count() -> int: ... def set_known_key_count(value: int) -> None: ... known_key_count = property(get_known_key_count, set_known_key_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [known_key_handle](#known_key_handle-property) The array indices start at *0* and end at *known_key_count - 1*. # known_key_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_known_key_handle(known_key_index: int) -> int: ... def set_known_key_handle(known_key_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *known_key_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [known_key_count](#known_key_count-property) property. # logout_page property Specifies the location of the logout page. ## Syntax ```text def get_logout_page() -> str: ... def set_logout_page(value: str) -> None: ... logout_page = property(get_logout_page, set_logout_page) ``` ## Default Value "/sp/logout" ## Remarks Use this property to specify the relative URL of the logout page. # metadata_url property The SP's metadata location. ## Syntax ```text def get_metadata_url() -> str: ... def set_metadata_url(value: str) -> None: ... metadata_url = property(get_metadata_url, set_metadata_url) ``` ## Default Value "/sp/metadata" ## Remarks This property specifies the metadata URL of this Service Provider (SP). # meta_signing_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_meta_signing_cert_bytes() -> bytes: ... meta_signing_cert_bytes = property(get_meta_signing_cert_bytes, None) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. # meta_signing_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_meta_signing_cert_handle() -> int: ... def set_meta_signing_cert_handle(value: int) -> None: ... meta_signing_cert_handle = property(get_meta_signing_cert_handle, set_meta_signing_cert_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # offline_mode property Enables the Offline mode. ## Syntax ```text def get_offline_mode() -> bool: ... def set_offline_mode(value: bool) -> None: ... offline_mode = property(get_offline_mode, set_offline_mode) ``` ## Default Value TRUE ## Remarks In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to [process_assertion](#process_assertion-method), [process_logout_request](#process_logout_request-method) [process_artifact_resolve_request](#process_artifact_resolve_request-method), and other similar methods. The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic. # pinned_client_aead_cipher property Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax ```text def get_pinned_client_aead_cipher() -> bool: ... pinned_client_aead_cipher = property(get_pinned_client_aead_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the encryption algorithm used is an AEAD cipher. This property is read-only. # pinned_client_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_pinned_client_chain_validation_details() -> int: ... pinned_client_chain_validation_details = property(get_pinned_client_chain_validation_details, None) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only. # pinned_client_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_pinned_client_chain_validation_result() -> int: ... pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only. # pinned_client_ciphersuite property The cipher suite employed by this connection. ## Syntax ```text def get_pinned_client_ciphersuite() -> str: ... pinned_client_ciphersuite = property(get_pinned_client_ciphersuite, None) ``` ## Default Value "" ## Remarks The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. This property is read-only. # pinned_client_client_authenticated property Specifies whether client authentication was performed during this connection. ## Syntax ```text def get_pinned_client_client_authenticated() -> bool: ... pinned_client_client_authenticated = property(get_pinned_client_client_authenticated, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was performed during this connection. This property is read-only. # pinned_client_client_auth_requested property Specifies whether client authentication was requested during this connection. ## Syntax ```text def get_pinned_client_client_auth_requested() -> bool: ... pinned_client_client_auth_requested = property(get_pinned_client_client_auth_requested, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was requested during this connection. This property is read-only. # pinned_client_connection_established property Indicates whether the connection has been established fully. ## Syntax ```text def get_pinned_client_connection_established() -> bool: ... pinned_client_connection_established = property(get_pinned_client_connection_established, None) ``` ## Default Value FALSE ## Remarks Indicates whether the connection has been established fully. This property is read-only. # pinned_client_connection_id property The unique identifier assigned to this connection. ## Syntax ```text def get_pinned_client_connection_id() -> bytes: ... pinned_client_connection_id = property(get_pinned_client_connection_id, None) ``` ## Remarks The unique identifier assigned to this connection. This property is read-only. # pinned_client_digest_algorithm property The digest algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_digest_algorithm() -> str: ... pinned_client_digest_algorithm = property(get_pinned_client_digest_algorithm, None) ``` ## Default Value "" ## Remarks The digest algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_encryption_algorithm property The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_encryption_algorithm() -> str: ... pinned_client_encryption_algorithm = property(get_pinned_client_encryption_algorithm, None) ``` ## Default Value "" ## Remarks The symmetric encryption algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_exportable property Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax ```text def get_pinned_client_exportable() -> bool: ... pinned_client_exportable = property(get_pinned_client_exportable, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS connection uses a reduced-strength exportable cipher. This property is read-only. # pinned_client_group property The elliptic curve used in this connection. ## Syntax ```text def get_pinned_client_group() -> str: ... pinned_client_group = property(get_pinned_client_group, None) ``` ## Default Value "" ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only. # pinned_client_id property The client connection's unique identifier. ## Syntax ```text def get_pinned_client_id() -> int: ... pinned_client_id = property(get_pinned_client_id, None) ``` ## Default Value -1 ## Remarks The client connection's unique identifier. This value is used throughout to refer to a particular client connection. This property is read-only. # pinned_client_key_exchange_algorithm property The key exchange algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_key_exchange_algorithm() -> str: ... pinned_client_key_exchange_algorithm = property(get_pinned_client_key_exchange_algorithm, None) ``` ## Default Value "" ## Remarks The key exchange algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_key_exchange_key_bits property The length of the key exchange key of a TLS-enabled connection. ## Syntax ```text def get_pinned_client_key_exchange_key_bits() -> int: ... pinned_client_key_exchange_key_bits = property(get_pinned_client_key_exchange_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the key exchange key of a TLS-enabled connection. This property is read-only. # pinned_client_pfs_cipher property Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax ```text def get_pinned_client_pfs_cipher() -> bool: ... pinned_client_pfs_cipher = property(get_pinned_client_pfs_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). This property is read-only. # pinned_client_pre_shared_identity property Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_pinned_client_pre_shared_identity() -> str: ... pinned_client_pre_shared_identity = property(get_pinned_client_pre_shared_identity, None) ``` ## Default Value "" ## Remarks Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. This property is read-only. # pinned_client_pre_shared_identity_hint property A hint professed by the server to help the client select the PSK identity to use. ## Syntax ```text def get_pinned_client_pre_shared_identity_hint() -> str: ... pinned_client_pre_shared_identity_hint = property(get_pinned_client_pre_shared_identity_hint, None) ``` ## Default Value "" ## Remarks A hint professed by the server to help the client select the PSK identity to use. This property is read-only. # pinned_client_public_key_bits property The length of the public key. ## Syntax ```text def get_pinned_client_public_key_bits() -> int: ... pinned_client_public_key_bits = property(get_pinned_client_public_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only. # pinned_client_remote_address property The client's IP address. ## Syntax ```text def get_pinned_client_remote_address() -> str: ... pinned_client_remote_address = property(get_pinned_client_remote_address, None) ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only. # pinned_client_remote_port property The remote port of the client connection. ## Syntax ```text def get_pinned_client_remote_port() -> int: ... pinned_client_remote_port = property(get_pinned_client_remote_port, None) ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only. # pinned_client_resumed_session property Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax ```text def get_pinned_client_resumed_session() -> bool: ... pinned_client_resumed_session = property(get_pinned_client_resumed_session, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS-enabled connection was spawned from another TLS connection This property is read-only. # pinned_client_secure_connection property Indicates whether TLS or SSL is enabled for this connection. ## Syntax ```text def get_pinned_client_secure_connection() -> bool: ... pinned_client_secure_connection = property(get_pinned_client_secure_connection, None) ``` ## Default Value FALSE ## Remarks Indicates whether TLS or SSL is enabled for this connection. This property is read-only. # pinned_client_server_authenticated property Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax ```text def get_pinned_client_server_authenticated() -> bool: ... pinned_client_server_authenticated = property(get_pinned_client_server_authenticated, None) ``` ## Default Value FALSE ## Remarks Indicates whether server authentication was performed during a TLS-enabled connection. This property is read-only. # pinned_client_signature_algorithm property The signature algorithm used in a TLS handshake. ## Syntax ```text def get_pinned_client_signature_algorithm() -> str: ... pinned_client_signature_algorithm = property(get_pinned_client_signature_algorithm, None) ``` ## Default Value "" ## Remarks The signature algorithm used in a TLS handshake. This property is read-only. # pinned_client_symmetric_block_size property The block size of the symmetric algorithm used. ## Syntax ```text def get_pinned_client_symmetric_block_size() -> int: ... pinned_client_symmetric_block_size = property(get_pinned_client_symmetric_block_size, None) ``` ## Default Value 0 ## Remarks The block size of the symmetric algorithm used. This property is read-only. # pinned_client_symmetric_key_bits property The key length of the symmetric algorithm used. ## Syntax ```text def get_pinned_client_symmetric_key_bits() -> int: ... pinned_client_symmetric_key_bits = property(get_pinned_client_symmetric_key_bits, None) ``` ## Default Value 0 ## Remarks The key length of the symmetric algorithm used. This property is read-only. # pinned_client_total_bytes_received property The total number of bytes received over this connection. ## Syntax ```text def get_pinned_client_total_bytes_received() -> int: ... pinned_client_total_bytes_received = property(get_pinned_client_total_bytes_received, None) ``` ## Default Value 0 ## Remarks The total number of bytes received over this connection. This property is read-only. # pinned_client_total_bytes_sent property The total number of bytes sent over this connection. ## Syntax ```text def get_pinned_client_total_bytes_sent() -> int: ... pinned_client_total_bytes_sent = property(get_pinned_client_total_bytes_sent, None) ``` ## Default Value 0 ## Remarks The total number of bytes sent over this connection. This property is read-only. # pinned_client_validation_log property Contains the server certificate's chain validation log. ## Syntax ```text def get_pinned_client_validation_log() -> str: ... pinned_client_validation_log = property(get_pinned_client_validation_log, None) ``` ## Default Value "" ## Remarks Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. This property is read-only. # pinned_client_version property Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax ```text def get_pinned_client_version() -> str: ... pinned_client_version = property(get_pinned_client_version, None) ``` ## Default Value "" ## Remarks Indicates the version of SSL/TLS protocol negotiated during this connection. This property is read-only. # pinned_client_cert_count property The number of records in the PinnedClientCert arrays. ## Syntax ```text def get_pinned_client_cert_count() -> int: ... pinned_client_cert_count = property(get_pinned_client_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pinned_client_cert_bytes](#pinned_client_cert_bytes-property) - [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) - [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) - [pinned_client_cert_handle](#pinned_client_cert_handle-property) - [pinned_client_cert_issuer](#pinned_client_cert_issuer-property) - [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property) - [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property) - [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property) - [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property) - [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property) - [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) - [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property) - [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property) - [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property) - [pinned_client_cert_subject](#pinned_client_cert_subject-property) - [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) - [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property) - [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property) - [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property) The array indices start at *0* and end at *pinned_client_cert_count - 1*. This property is read-only. # pinned_client_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_pinned_client_cert_bytes(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_pinned_client_cert_ca_key_id(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_pinned_client_cert_fingerprint(pinned_client_cert_index: int) -> str: ... ``` ## 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. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_pinned_client_cert_handle(pinned_client_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_pinned_client_cert_issuer(pinned_client_cert_index: int) -> str: ... ``` ## 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 [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property). The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_pinned_client_cert_issuer_rdn(pinned_client_cert_index: int) -> str: ... ``` ## 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* The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_pinned_client_cert_key_algorithm(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "0" ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property), [pinned_client_cert_curve](#SAMLSPServer_p_PinnedClientCertCurve), and [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) properties to get more details about the key the certificate contains. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_pinned_client_cert_key_bits(pinned_client_cert_index: int) -> int: ... ``` ## 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 [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) or [pinned_client_cert_private_key_bytes](#SAMLSPServer_p_PinnedClientCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_pinned_client_cert_key_fingerprint(pinned_client_cert_index: int) -> str: ... ``` ## 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 [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_pinned_client_cert_key_usage(pinned_client_cert_index: int) -> int: ... ``` ## 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. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_pinned_client_cert_public_key_bytes(pinned_client_cert_index: int) -> bytes: ... ``` ## 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. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_pinned_client_cert_self_signed(pinned_client_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_pinned_client_cert_serial_number(pinned_client_cert_index: int) -> bytes: ... ``` ## 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. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_pinned_client_cert_sig_algorithm(pinned_client_cert_index: int) -> str: ... ``` ## 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*. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_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 ```text def get_pinned_client_cert_subject(pinned_client_cert_index: int) -> str: ... ``` ## 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 [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property). The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_pinned_client_cert_subject_key_id(pinned_client_cert_index: int) -> bytes: ... ``` ## 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 [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) and [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_pinned_client_cert_subject_rdn(pinned_client_cert_index: int) -> str: ... ``` ## 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*. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_pinned_client_cert_valid_from(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_pinned_client_cert_valid_to(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # port property Specifies the listening port number. ## Syntax ```text def get_port() -> int: ... def set_port(value: int) -> None: ... port = property(get_port, set_port) ``` ## Default Value 80 ## Remarks Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use [host](#host-property). # protected_resources property Specifies the list of protected resources. ## Syntax ```text def get_protected_resources() -> str: ... def set_protected_resources(value: str) -> None: ... protected_resources = property(get_protected_resources, set_protected_resources) ``` ## Default Value "" ## Remarks This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP). # redirect_on_logout_page property Specifies the location to redirect the user on logout. ## Syntax ```text def get_redirect_on_logout_page() -> str: ... def set_redirect_on_logout_page(value: str) -> None: ... redirect_on_logout_page = property(get_redirect_on_logout_page, set_redirect_on_logout_page) ``` ## Default Value "https://nsoftware.com" ## Remarks Use this property to specify the page where to redirect the user on logout. # security_canonicalization_method property The canonicalization method to use in the signature. ## Syntax ```text def get_security_canonicalization_method() -> str: ... def set_security_canonicalization_method(value: str) -> None: ... security_canonicalization_method = property(get_security_canonicalization_method, set_security_canonicalization_method) ``` ## 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/) # security_digest_method property The digest method to use. ## Syntax ```text def get_security_digest_method() -> str: ... def set_security_digest_method(value: str) -> None: ... security_digest_method = property(get_security_digest_method, set_security_digest_method) ``` ## 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. # security_encryption_method property The encryption method used to encrypt the assertion. ## Syntax ```text def get_security_encryption_method() -> str: ... def set_security_encryption_method(value: str) -> None: ... security_encryption_method = property(get_security_encryption_method, set_security_encryption_method) ``` ## 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 | | # security_flags property Provides access to secondary security parameters and tweaks. ## Syntax ```text def get_security_flags() -> int: ... def set_security_flags(value: int) -> None: ... security_flags = property(get_security_flags, set_security_flags) ``` ## 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) | # security_sig_method property The signature method to use. ## Syntax ```text def get_security_sig_method() -> str: ... def set_security_sig_method(value: str) -> None: ... security_sig_method = property(get_security_sig_method, set_security_sig_method) ``` ## 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. # security_signature_policy property Specifies the signature validation policy. ## Syntax ```text def get_security_signature_policy() -> int: ... def set_security_signature_policy(value: int) -> None: ... security_signature_policy = property(get_security_signature_policy, set_security_signature_policy) ``` ## Possible Values ```text 0 # Auto1 # Validate2 # Require3 # Ignore ``` ## Default Value 0 ## Remarks Specifies the signature validation policy. Use this property to specify the signature validation policy for the component. # sender_cert_count property The number of records in the SenderChain arrays. ## Syntax ```text def get_sender_cert_count() -> int: ... sender_cert_count = property(get_sender_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [sender_chain_bytes](#sender_chain_bytes-property) - [sender_chain_handle](#sender_chain_handle-property) The array indices start at *0* and end at *sender_cert_count - 1*. This property is read-only. # sender_chain_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_sender_chain_bytes(sender_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *sender_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sender_cert_count](#sender_cert_count-property) property. This property is read-only. # sender_chain_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_sender_chain_handle(sender_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *sender_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sender_cert_count](#sender_cert_count-property) property. This property is read-only. # signing_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text 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_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signing_cert_handle() -> int: ... def set_signing_cert_handle(value: int) -> None: ... signing_cert_handle = property(get_signing_cert_handle, set_signing_cert_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` # signing_chain_count property The number of records in the SigningChain arrays. ## Syntax ```text def get_signing_chain_count() -> int: ... def set_signing_chain_count(value: int) -> None: ... signing_chain_count = property(get_signing_chain_count, set_signing_chain_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signing_chain_bytes](#signing_chain_bytes-property) - [signing_chain_handle](#signing_chain_handle-property) The array indices start at *0* and end at *signing_chain_count - 1*. # signing_chain_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_signing_chain_bytes(signing_chain_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *signing_chain_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signing_chain_count](#signing_chain_count-property) property. This property is read-only. # signing_chain_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_signing_chain_handle(signing_chain_index: int) -> int: ... def set_signing_chain_handle(signing_chain_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *signing_chain_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [signing_chain_count](#signing_chain_count-property) property. # socket_incoming_speed_limit property The maximum number of bytes to read from the socket, per second. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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. # sp_contact_person property The contact person or persons for the entity. ## Syntax ```text def get_sp_contact_person() -> str: ... def set_sp_contact_person(value: str) -> None: ... sp_contact_person = property(get_sp_contact_person, set_sp_contact_person) ``` ## Default Value "" ## Remarks The contact person or persons for the entity. SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record. Each record contains a semicolon-separated list of contact person parameters, for example: ```text Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678 ``` You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property. # sp_encryption_key property Contains the entity's encryption key. ## Syntax ```text def get_sp_encryption_key() -> str: ... def set_sp_encryption_key(value: str) -> None: ... sp_encryption_key = property(get_sp_encryption_key, set_sp_encryption_key) ``` ## Default Value "" ## Remarks Contains the entity's encryption key. This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings). Requests sent to the endpoint can be encrypted with the provided key or certificate. # sp_encryption_methods property Specifies the list of encryption methods supported by the entity. ## Syntax ```text def get_sp_encryption_methods() -> str: ... def set_sp_encryption_methods(value: str) -> None: ... sp_encryption_methods = property(get_sp_encryption_methods, set_sp_encryption_methods) ``` ## Default Value "" ## Remarks Specifies the list of encryption methods supported by the entity. This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity. Examples of algorithms supported by this property: - http://www.w3.org/2009/xmlenc11#aes128-gcm - http://www.w3.org/2001/04/xmlenc#aes256-cbc # sp_entity_id property Represents the SAML entity ID. ## Syntax ```text def get_sp_entity_id() -> str: ... def set_sp_entity_id(value: str) -> None: ... sp_entity_id = property(get_sp_entity_id, set_sp_entity_id) ``` ## Default Value "" ## Remarks Represents the SAML entity ID. Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com). # sp_flags property Adjusts secondary entity properties. ## Syntax ```text def get_sp_flags() -> int: ... def set_sp_flags(value: int) -> None: ... sp_flags = property(get_sp_flags, set_sp_flags) ``` ## Default Value 0 ## Remarks Adjusts secondary entity properties. Use this bit mask property to adjust certain secondary settings. The following flags are supported: - 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in. # sp_id_psso_link property Contains a local server page link that triggers SAML authentication to the SP. ## Syntax ```text def get_sp_id_psso_link() -> str: ... def set_sp_id_psso_link(value: str) -> None: ... sp_id_psso_link = property(get_sp_id_psso_link, set_sp_id_psso_link) ``` ## Default Value "" ## Remarks Contains a local server page link that triggers SAML authentication to the SP. This property specifies the web link that initiates the transfer of SAML authentication fact to the SP. One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider. # sp_name_id_formats property The list of NameID formats supported by this entity. ## Syntax ```text def get_sp_name_id_formats() -> str: ... def set_sp_name_id_formats(value: str) -> None: ... sp_name_id_formats = property(get_sp_name_id_formats, set_sp_name_id_formats) ``` ## Default Value "" ## Remarks The list of NameID formats supported by this entity. Use this setting to get or set the list of NameID formats supported by the entity. Use SAML notation for the formats: - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress # sp_organization_display_name property The friendly name of the organization that maintains the entity. ## Syntax ```text def get_sp_organization_display_name() -> str: ... def set_sp_organization_display_name(value: str) -> None: ... sp_organization_display_name = property(get_sp_organization_display_name, set_sp_organization_display_name) ``` ## Default Value "" ## Remarks The friendly name of the organization that maintains the entity. Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity. # sp_organization_lang property The language preferred by the organization. ## Syntax ```text def get_sp_organization_lang() -> str: ... def set_sp_organization_lang(value: str) -> None: ... sp_organization_lang = property(get_sp_organization_lang, set_sp_organization_lang) ``` ## Default Value "" ## Remarks The language preferred by the organization. This optional setting can be used to adjust the preferred language of the owning organization. # sp_organization_name property The name of the organization that maintains the entity. ## Syntax ```text def get_sp_organization_name() -> str: ... def set_sp_organization_name(value: str) -> None: ... sp_organization_name = property(get_sp_organization_name, set_sp_organization_name) ``` ## Default Value "" ## Remarks The name of the organization that maintains the entity. Use this setting to get or set the name of the organization that maintains the SAML entity. # sp_organization_url property The web URL of the organization that maintains the entity. ## Syntax ```text def get_sp_organization_url() -> str: ... def set_sp_organization_url(value: str) -> None: ... sp_organization_url = property(get_sp_organization_url, set_sp_organization_url) ``` ## Default Value "" ## Remarks The web URL of the organization that maintains the entity. Use this setting to get or set the web address of the organization responsible for this SAML entity. # sp_signature_validation_result property The outcome of the cryptographic signature validation. ## Syntax ```text def get_sp_signature_validation_result() -> int: ... sp_signature_validation_result = property(get_sp_signature_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # Unknown2 # Corrupted3 # SignerNotFound4 # Failure5 # ReferenceCorrupted ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only. # sp_signed property Specifies whether the SAML entity information is or should be signed. ## Syntax ```text def get_sp_signed() -> bool: ... sp_signed = property(get_sp_signed, None) ``` ## Default Value FALSE ## Remarks Specifies whether the SAML entity information is or should be signed. Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed. This property is read-only. # sp_signed_with property Contains the certificate or key that was used to sign the settings (metadata) document. ## Syntax ```text def get_sp_signed_with() -> str: ... sp_signed_with = property(get_sp_signed_with, None) ``` ## Default Value "" ## Remarks Contains the certificate or key that was used to sign the settings (metadata) document. This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate. The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the [sp_signature_validation_result](#sp_signature_validation_result-property) setting. This property is read-only. # sp_signing_key property Contains the entity's signing key. ## Syntax ```text def get_sp_signing_key() -> str: ... def set_sp_signing_key(value: str) -> None: ... sp_signing_key = property(get_sp_signing_key, set_sp_signing_key) ``` ## Default Value "" ## Remarks Contains the entity's signing key. This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key. The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates. # sp_valid_until property Specifies the expiration time of the SAML entity information. ## Syntax ```text def get_sp_valid_until() -> str: ... def set_sp_valid_until(value: str) -> None: ... sp_valid_until = property(get_sp_valid_until, set_sp_valid_until) ``` ## Default Value "" ## Remarks Specifies the expiration time of the SAML entity information. This setting only makes sense when the information was loaded or is going to be saved to a metadata XML. # sp_service_count property The number of records in the SPService arrays. ## Syntax ```text def get_sp_service_count() -> int: ... sp_service_count = property(get_sp_service_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [sp_service_binding_type](#sp_service_binding_type-property) - [sp_service_entity_id](#sp_service_entity_id-property) - [sp_service_location](#sp_service_location-property) - [sp_service_priority](#sp_service_priority-property) - [sp_service_service](#sp_service_service-property) - [sp_service_service_index](#sp_service_service_index-property) The array indices start at *0* and end at *sp_service_count - 1*. This property is read-only. # sp_service_binding_type property Specifies the type of SAML binding that this endpoint accepts. ## Syntax ```text def get_sp_service_binding_type(sp_service_index: int) -> int: ... ``` ## Possible Values ```text 0 # None1 # SOAP2 # PAOS3 # Redirect4 # POST5 # Artifact ``` ## Default Value 0 ## Remarks Specifies the type of SAML binding that this endpoint accepts. Use this property to specify the binding type to use with this endpoint. The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) property. This property is read-only. # sp_service_entity_id property Represents the SAML entity ID. ## Syntax ```text def get_sp_service_entity_id(sp_service_index: int) -> str: ... ``` ## Default Value "" ## Remarks Represents the SAML entity ID. Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com). The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) property. This property is read-only. # sp_service_location property The location (URL) of the endpoint. ## Syntax ```text def get_sp_service_location(sp_service_index: int) -> str: ... ``` ## Default Value "" ## Remarks The location (URL) of the endpoint. The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) property. This property is read-only. # sp_service_priority property The priority of the endpoint in relation to other endpoints with the same Location . ## Syntax ```text def get_sp_service_priority(sp_service_index: int) -> int: ... ``` ## Default Value -1 ## Remarks The priority of the endpoint in relation to other endpoints with the same [sp_location](#SAMLSPServer_p_SPLocation). Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute. Leave all priorities at -1 to omit generation of the Default attribute. The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) property. This property is read-only. # sp_service_service property The kind of the service being provided at this endpoint. ## Syntax ```text def get_sp_service_service(sp_service_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The kind of the service being provided at this endpoint. The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService. The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) property. This property is read-only. # sp_service_service_index property The index of this endpoint. ## Syntax ```text def get_sp_service_service_index(sp_service_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The index of this endpoint. For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers. The *sp_service_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [sp_service_count](#sp_service_count-property) 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 ```text 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 ```text 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) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | # tls_ciphersuites property A list of ciphersuites separated with commas or semicolons. ## Syntax ```text 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](#tls_base_configuration-property). 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 ```text 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) ``` ## Possible Values ```text 0 # NoAuth1 # RequestCert2 # RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | # tls_extensions property Provides access to TLS extensions. ## Syntax ```text 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 ```text 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_groups property Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax ```text def get_tls_groups() -> str: ... def set_tls_groups(value: str) -> None: ... tls_groups = property(get_tls_groups, set_tls_groups) ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. # tls_pre_shared_identity property Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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) ``` ## Possible Values ```text 0 # Compatible1 # Strict2 # Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | # tls_revocation_check property Specifies the kind(s) of revocation check to perform. ## Syntax ```text 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) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # 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 ```text 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_mode property Specifies the TLS mode to use. ## Syntax ```text def get_tls_mode() -> int: ... def set_tls_mode(value: int) -> None: ... tls_mode = property(get_tls_mode, set_tls_mode) ``` ## Possible Values ```text 0 # Default1 # NoTLS2 # ExplicitTLS3 # ImplicitTLS4 # MixedTLS ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | # tls_use_extended_master_secret property Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax ```text 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 TRUE ## 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 ```text 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 ```text def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ... tls_versions = property(get_tls_versions, set_tls_versions) ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | # tls_server_cert_count property The number of records in the TLSServerCert arrays. ## Syntax ```text def get_tls_server_cert_count() -> int: ... def set_tls_server_cert_count(value: int) -> None: ... tls_server_cert_count = property(get_tls_server_cert_count, set_tls_server_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property) - [tls_server_cert_handle](#tls_server_cert_handle-property) The array indices start at *0* and end at *tls_server_cert_count - 1*. # tls_server_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ... def set_tls_server_cert_handle(tls_server_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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. # url property Specifies the base URL of this SP server. ## Syntax ```text def get_url() -> str: ... def set_url(value: str) -> None: ... url = property(get_url, set_url) ``` ## Default Value "" ## Remarks Use this property to set the base URL for this Service Provider (SP) server. Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end. # add_id_p_service method Registers an IdP service in the IdPServices list. ## Syntax ```text def add_id_p_service(service: int, binding_type: int, location: str, priority: int, index: int) -> None: ... ``` ## Remarks Use this method to add an entry to the list of known external SAML services and their locations. The service provider needs to be knowledgeable of the external IdP services that it needs to use. That information can either be provided in the form of a metadata file (see [import_settings](#import_settings-method)), or registered manually using this method. When using this method, make sure to register all the services you expect to work with. Note that if the same IdP service is available through several different transports (*bindings*), you will need to register each (service, transport) pair individually: ```text sp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); sp.AddIdPService(spsSingleSignOnService, csbtRedirect, "https://idp.identityserver/saml/sso", -1, -1); ``` Use the *Service* parameter to specify the service to register: | | | | | --- | --- | --- | | spsUnknown | 0 | The service is of unknown or unsupported type | | spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) | | spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) | | spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) | | spsAttributeQueryService | 4 | The attribute query service (IdP side only) | | spsSingleSignOnService | 5 | The single sign-on service (IdP side only) | The *BindingType* specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLS services to use POST or Redirect bindings. This information is typically provided by the identity provider. | | | | | --- | --- | --- | | csbtNone | 0 | TBD | | csbtSOAP | 1 | TBD | | csbtPAOS | 2 | TBD | | csbtRedirect | 3 | TBD | | csbtPOST | 4 | TBD | | csbtArtifact | 5 | TBD | The *Location* parameter specifies the absolute URL of the respective SAML web endpoint. The *Priority* parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use. The *Index* parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly. Note that this method registers a *known* service - something that the service provider should be aware of. This is different to the purpose of the [add_sp_service](#add_sp_service-method) method, which registers the service provider's *own* service. # add_sp_service method Registers an SP service in the SPServices list. ## Syntax ```text def add_sp_service(service: int, binding_type: int, location: str, priority: int, index: int) -> None: ... ``` ## Remarks Use this method to add an entry to the list of SAML services and their locations provided by the SP. A service provider can provide a variety of SAML services through a selection of endpoints, each supporting one or more transports (or *bindings*). Typical examples are an assertion consumer service or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both). Each add_sp_service call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint: ```text sp.AddSPService(spsAssertionConsumerService, csbtPOST, '/saml/acs', -1, 1); sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); ``` Use the *Service* parameter to specify the service to register: | | | | | --- | --- | --- | | spsUnknown | 0 | The service is of unknown or unsupported type | | spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) | | spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) | | spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) | | spsAttributeQueryService | 4 | The attribute query service (IdP side only) | | spsSingleSignOnService | 5 | The single sign-on service (IdP side only) | The *BindingType* specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect. | | | | | --- | --- | --- | | csbtNone | 0 | TBD | | csbtSOAP | 1 | TBD | | csbtPAOS | 2 | TBD | | csbtRedirect | 3 | TBD | | csbtPOST | 4 | TBD | | csbtArtifact | 5 | TBD | The *Location* parameter specifies an absolute or relative path to the service within the SAML web service: ```text sp.AddSPService(spsAssertionConsumerService, csbtPOST, 'https://app.com/saml/acs', -1, 1); // absolute path sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); // relative path ``` The *Priority* parameter is nominal as it only specifies the relative priority of the transport in the SP metadata. The actual transport used, among those supported, depends on the choice of the external identity provider. Pass -1 to stick with the default priority. The *Index* parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly. Note that this method registers the service provider's *own* service - something that the service provider provides. This is different to [add_id_p_service](#add_id_p_service-method) method, which registers a foreign identity provider's service - something that the service provider should *be aware of*. # cleanup method Cleans up the server environment by purging expired sessions and cleaning caches. ## Syntax ```text def cleanup() -> None: ... ``` ## Remarks Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches. # config method Sets or retrieves a configuration setting. ## Syntax ```text 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](#samlspserver-config-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](#samlspserver-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method Performs an additional action. ## Syntax ```text 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. | # drop_client method Terminates a client connection. ## Syntax ```text def drop_client(connection_id: int, forced: bool) -> None: ... ``` ## Remarks Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner. # export_settings method Saves the SP or IdP configuration to an XML metadata file. ## Syntax ```text def export_settings(sp: bool) -> str: ... ``` ## Remarks Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration. Adjust the provider configuration as required in sp_settings or id_p_settings object before calling this method. Assign meta_signing_certificate to enforce signing of the metadata XML. # get_client_buffer method Acquires a piece of operation data. ## Syntax ```text def get_client_buffer(connection_id: int, handle: str) -> bytes: ... ``` ## Remarks Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way. A typical place to call this method is inside the [on_resource_write](#on_resource_write-event) event handler, when implementing customized file transfers. # get_provider_property method Returns the value of a custom provider property. ## Syntax ```text def get_provider_property(name: str) -> str: ... ``` ## Remarks This method, together with [set_provider_property](#set_provider_property-method), provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended. The following properties are currently supported: - ContactPerson - OrganizationName - OrganizationDisplayName - OrganizationURL - OrganizationLang # get_request_bytes method Returns the contents of the connected client's HTTP request. ## Syntax ```text def get_request_bytes(connection_id: int, request_filter: str) -> bytes: ... ``` ## Remarks Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content. # get_request_header method Returns a request header value. ## Syntax ```text def get_request_header(connection_id: int, header_name: str) -> str: ... ``` ## Remarks Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as on_get_request or on_post_request. # get_response_header method Returns a response header value. ## Syntax ```text def get_response_header(connection_id: int, header_name: str) -> str: ... ``` ## Remarks Use this method to get the value of a response header. A good place to call this method is on_headers_prepared event. Call the method with empty *HeaderName* to get the whole response header. # get_session_property method Returns the value of a custom session property. ## Syntax ```text def get_session_property(session_id: str, name: str) -> str: ... ``` ## Remarks This method, together with [set_session_property](#set_session_property-method), provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use [on_session_created](#on_session_created-event) and [on_session_destroyed](#on_session_destroyed-event) events to get notifications about session creation and disposal. The following properties are supported for SP sessions and can be passed to the *Name* parameter of this method: - Authenticated: whether the session has been authenticated with the IdP service. - AuthnRequestID: the AuthnRequest ID. - Expires: the web session expiration time. - LogoutRequestID: the LogoutRequest ID. - NameID: the NameID of the user. - NameIDFormat: the format of the NameID of the user. - FormattedNameID: the formatted version of the NameID. - RelayState: the current (last) relay state entry. - Session: the session ID (the same as you pass as parameter). - SAMLSession: the browser cookie that corresponds to the session. - SessionIndex: a list of cross-network session indexes assigned to this session. - URL: the current request's URL. - UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts. - Stage: the current session stage (or epoch). # import_settings method Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. ## Syntax ```text def import_settings(metadata: str, sp: bool) -> None: ... ``` ## Remarks The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP. The *Metadata* parameter contains metadata in the form of byte array. Set *SP* parameter to true to indicate that it is the Service Provider's own settings that are being loaded. The loaded metadata is populated in the sp_settings or id_p_settings object (depending on the value of the *SP* parameter). # initiate_artifact_resolve method Initiates the artifact resolution protocol. ## Syntax ```text def initiate_artifact_resolve(connection_id: int, session_id: str, id_p_service_index: int, artifact: str, tag: str) -> int: ... ``` ## Remarks Use this event to initiate the artifact resolution protocol for *Artifact*. Specify the desired SP service endpoint via the *IdPServiceIndex* parameter. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). Note: this method is currently in development and will be available in later SecureBlackbox updates. # initiate_attribute_query method Initiates the attribute query. ## Syntax ```text def initiate_attribute_query(connection_id: int, session_id: str, id_p_service_index: int, name_id: str, name_id_format: str, attributes: str, attr_name_formats: str, attr_friendly_names: str, tag: str) -> int: ... ``` ## Remarks Use this event to initiate the attribute query for user *NameID*. Specify the desired *Attributes* as a list of CRLF-separated attribute names. *AttrNameFormats* and *AttrFriendlyNames* can also be provided in the same way. Specify the IdP AQS endpoint via the *IdPServiceIndex* parameter. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). Note: this method is currently in development and will be available in later SecureBlackbox updates. # initiate_auth method Starts SP-initiated SAML authentication flow. ## Syntax ```text def initiate_auth(connection_id: int, session_id: str, id_p_service_index: int, name_id_format: str, relay_state: str, tag: str) -> int: ... ``` ## Remarks Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the *IdPServiceIndex* parameter. Leave it empty to let the component pick up the best one automatically. Use *RelayState* to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response. This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the [on_processing_completed](#on_processing_completed-event) event. This event fires independently of the processing outcome (success or failure), and contains the same *ConnectionID* that is passed to this call. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). # initiate_logout method Starts SP-initiated SAML logout flow. ## Syntax ```text def initiate_logout(connection_id: int, session_id: str, id_p_service_index: int, name_id: str, session_index: str, relay_state: str, tag: str) -> int: ... ``` ## Remarks Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the *IdPServiceIndex* parameter. Use *IdPServiceIndex* to specify the identity provider's service that you want to use for signing out. Provide the existing SAML session details in one of the following ways: - as an HTTP *SessionID*: in this case the component will try to pick the matching SAML session from its session cache. - as a known *NameID*. - as a known SAML *SessionIndex*. You can use a combination of the above. This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the [on_processing_completed](#on_processing_completed-event) event. This event fires independently of the processing outcome (success or failure), and contains the same *ConnectionID* that is passed to this call. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | Use *RelayState* to pass a value to the IdP that you want to be mirrored back in the IdP's response. The *Tag* value will be similarly mirrored, but in the component's events, such as [on_processing_completed](#on_processing_completed-event). You can use this method with or without the [offline_mode](#offline_mode-property). # list_clients method Enumerates the connected clients. ## Syntax ```text def list_clients() -> str: ... ``` ## Remarks This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection. # pin_client method Takes a snapshot of the connection's properties. ## Syntax ```text def pin_client(connection_id: int) -> None: ... ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties. # process_artifact method Processes an artifact request received from the IdP service at one of artifact receiver endpoints. ## Syntax ```text def process_artifact(connection_id: int, session_id: str, request: str, tag: str) -> int: ... ``` ## Remarks Use this method to pass a SAML artifact received at one of the artifact endpoints. Artifact messages are typically very simple: ```text https://idp.server.com/sso/artifact?SAMLart=artifact ``` In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the [on_artifact_resolve_request_prepared](#on_artifact_resolve_request_prepared-event) event, and, later on, of an event matching the type of the actual message received - such as [on_assertion_received](#on_assertion_received-event). | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). Note: this method is currently in development and will be available in later SecureBlackbox updates. # process_artifact_resolve_request method Processes an artifact request received from the SP service at one of the ARS endpoints. ## Syntax ```text def process_artifact_resolve_request(connection_id: int, session_id: str, request: str, tag: str) -> int: ... ``` ## Remarks Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints. This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the [on_processing_completed](#on_processing_completed-event) event. This event fires independently of the processing outcome (success or failure), and contains the same *ConnectionID* that is passed to this call. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). Note: this method is currently in development and will be available in later SecureBlackbox updates. # process_assertion method Processes assertion received from the IdP service at one of the ACS endpoints. ## Syntax ```text def process_assertion(connection_id: int, session_id: str, request: str, tag: str) -> int: ... ``` ## Remarks Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints. This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the [on_processing_completed](#on_processing_completed-event) event. This event fires independently of the processing outcome (success or failure), and contains the same *ConnectionID* that is passed to this call. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). # process_generic_request method Processes a generic HTTP SAML request. ## Syntax ```text def process_generic_request(connection_id: int, request: bytes) -> bytes: ... ``` ## Remarks Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine. The *Request* parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers). You can use this method with or without the [offline_mode](#offline_mode-property). # process_logout_request method Processes logout request received from the IdP service at one of the SLS endpoints. ## Syntax ```text def process_logout_request(connection_id: int, session_id: str, request: str, tag: str) -> int: ... ``` ## Remarks Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints. An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If *Request* contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If *Request* contains a LogoutResponse, the generated content is empty. This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the [on_processing_completed](#on_processing_completed-event) event. This event fires independently of the processing outcome (success or failure), and contains the same *ConnectionID* that is passed to this call. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [offline_mode](#offline_mode-property). # reset method Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # set_client_buffer method Commits a data buffer to the connection. ## Syntax ```text def set_client_buffer(connection_id: int, handle: str, value: bytes) -> None: ... ``` ## Remarks Use this method from your on_read_file event handler to commit a chunk of file data to the server component. # set_provider_property method Sets the value of a custom provider property. ## Syntax ```text def set_provider_property(name: str, value: str) -> None: ... ``` ## Remarks This method, together with [get_provider_property](#get_provider_property-method), provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended. The following properties are currently supported: - ContactPerson - OrganizationName - OrganizationDisplayName - OrganizationURL - OrganizationLang # set_response_header method Sets a response header. ## Syntax ```text def set_response_header(connection_id: int, header_name: str, value: str) -> None: ... ``` ## Remarks Use this method to set a response header. A good place to call this method is a request-marking event, such as on_get_request or on_post_request. # set_session_property method Sets the value of a custom provider session property. ## Syntax ```text def set_session_property(session_id: str, name: str, value: str) -> None: ... ``` ## Remarks This method, together with [get_session_property](#get_session_property-method), provides an extensible way of managing the Service Provider's session settings that are not available through the primary properties and events of the component. The following properties can be adjusted for each individual session: - AuthnRequestID: the AuthnRequest ID. - LogoutRequestID: the LogoutRequest ID. - NameID: the NameID of the user. - RelayState: the current (last) relay state entry. - Session: the session ID (the same as you pass as parameter). - SAMLSession: the browser cookie that corresponds to the session. - SessionIndex: a collection of cross-network session indexes assigned to this session. - URL: the current request's URL. - UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts. - Expires: the web session expiration time. Set it to a moment in the past to enforce immediate session expiration. Note: setting a session property invokes a call to [on_session_state_save](#on_session_state_save-event). The component does that to update the session state kept externally. Note: changing session properties mindlessly may break the protocol flow. For example, changing *AuthnRequestID* to a different value may cause the Service Provider to reject the subsequent assertion message, as the incoming assertion will contain a now-unmatching In-Response-To entry. # start method Starts the SP server. ## Syntax ```text def start() -> None: ... ``` ## Remarks Use this method to start listening for incoming connections. # stop method Stops the IdP server. ## Syntax ```text def stop() -> None: ... ``` ## Remarks Call this method to stop listening for incoming connections. # on_accept event Reports an incoming connection. ## Syntax ```text class SAMLSPServerAcceptEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class SAMLSPServer: @property def on_accept() -> Callable[[SAMLSPServerAcceptEventParams], None]: ... @on_accept.setter def on_accept(event_hook: Callable[[SAMLSPServerAcceptEventParams], None]) -> None: ... ``` ## Remarks This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it. Subscribe to [on_connect](#on_connect-event) event to be notified of every connection that has been set up. # on_artifact_received event The server fires this event upon receiving an Artifact message from the other side. ## Syntax ```text class SAMLSPServerArtifactReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def artifact() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_artifact_received() -> Callable[[SAMLSPServerArtifactReceivedEventParams], None]: ... @on_artifact_received.setter def on_artifact_received(event_hook: Callable[[SAMLSPServerArtifactReceivedEventParams], None]) -> None: ... ``` ## Remarks The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the *Action* parameter, the further flow may go as following: - fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact. - fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via [process_generic_request](#process_generic_request-method) method. - fraReject: the server will discard the artifact. Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as [on_artifact_resolve_request_prepared](#on_artifact_resolve_request_prepared-event). In [offline_mode](#offline_mode-property) this event would typically be fired from [process_artifact](#process_artifact-method) call. # on_artifact_resolve_request_prepared event This event is fired when a new artifact resolution request message has been prepared by the class. ## Syntax ```text class SAMLSPServerArtifactResolveRequestPreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def destination() -> str: ... @property def artifact() -> str: ... # In class SAMLSPServer: @property def on_artifact_resolve_request_prepared() -> Callable[[SAMLSPServerArtifactResolveRequestPreparedEventParams], None]: ... @on_artifact_resolve_request_prepared.setter def on_artifact_resolve_request_prepared(event_hook: Callable[[SAMLSPServerArtifactResolveRequestPreparedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the identity provider. # on_artifact_resolve_request_received event Reports receipt of ArtifactResolveRequest message. ## Syntax ```text class SAMLSPServerArtifactResolveRequestReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def is_encrypted() -> bool: ... @property def is_signed() -> bool: ... @property def artifact() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_artifact_resolve_request_received() -> Callable[[SAMLSPServerArtifactResolveRequestReceivedEventParams], None]: ... @on_artifact_resolve_request_received.setter def on_artifact_resolve_request_received(event_hook: Callable[[SAMLSPServerArtifactResolveRequestReceivedEventParams], None]) -> None: ... ``` ## Remarks The component fires this event to report receipt of incoming artifact resolution request. The *Artifact* parameter contains the artifact identifier received. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | # on_assertion_received event This event is fired when an assertion is received from the IdP. ## Syntax ```text class SAMLSPServerAssertionReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def body() -> str: ... @property def is_encrypted() -> bool: ... @property def is_signed() -> bool: ... @property def auth() -> str: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... @property def attributes() -> str: ... @property def valid_from() -> str: ... @property def valid_to() -> str: ... @property def relay_state() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_assertion_received() -> Callable[[SAMLSPServerAssertionReceivedEventParams], None]: ... @on_assertion_received.setter def on_assertion_received(event_hook: Callable[[SAMLSPServerAssertionReceivedEventParams], None]) -> None: ... ``` ## Remarks The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In [offline_mode](#offline_mode-property) this event may fire in response to a [process_assertion](#process_assertion-method) call. In online mode it can fire at any time while the server is active. The *ConnectionID* and *SessionID* specify the IDs of the current client connection and HTTP session. The *RequestID* contains the ID of the original AuthnRequest message, if it was sent by the service provider. The *IsEncrypted* and *IsSigned* parameters indicate the security properties of the assertion. The *NameID* parameter contains the unique name identifier of the authenticated principal, and the *SessionIndex* contains the SAML session identifier. In rare cases *SessionIndex* may contain multiple indices, if the SP has more than one session at the IdP. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If the assertion is returned in response to this SP's AuthnRequest message, the *RelayState* parameter will contain the original relay state passed to the earlier [initiate_auth](#initiate_auth-method) call. # on_attribute_query_prepared event Notifies the application of the preparation of an AttributeQuery. ## Syntax ```text class SAMLSPServerAttributeQueryPreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def destination() -> str: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def attributes() -> str: ... # In class SAMLSPServer: @property def on_attribute_query_prepared() -> Callable[[SAMLSPServerAttributeQueryPreparedEventParams], None]: ... @on_attribute_query_prepared.setter def on_attribute_query_prepared(event_hook: Callable[[SAMLSPServerAttributeQueryPreparedEventParams], None]) -> None: ... ``` ## Remarks The component uses this event to notify the application of the completion of the preparation of the AttributeQuery message. The *NameID* and *NameIDFormat* parameters indicate the attribute subject, and the *Attributes* parameter contains a list of attributes being requested. This event may be fired in response to a [initiate_attribute_query](#initiate_attribute_query-method) call (in offline mode), or intermittently in online mode. # on_authn_request_prepared event This event is fired when a new authentication request message has been prepared. ## Syntax ```text class SAMLSPServerAuthnRequestPreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def destination() -> str: ... @property def name_id_format() -> str: ... @property def force_authn() -> bool: ... @property def non_interactive() -> bool: ... @property def relay_state() -> str: ... @relay_state.setter def relay_state(value) -> None: ... # In class SAMLSPServer: @property def on_authn_request_prepared() -> Callable[[SAMLSPServerAuthnRequestPreparedEventParams], None]: ... @on_authn_request_prepared.setter def on_authn_request_prepared(event_hook: Callable[[SAMLSPServerAuthnRequestPreparedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to get notified about assertion requests prepared by the service provider. This event may fire from [initiate_auth](#initiate_auth-method) method when working in [offline_mode](#offline_mode-property), or at any time when working as a standalone live web server. You can adjust the *RelayState* as required in the event handler to pass on a state to the IdP. The IdP will return this state back to you together with its authentication assertion. # on_connect event Reports an accepted connection. ## Syntax ```text class SAMLSPServerConnectEventParams(object): @property def connection_id() -> int: ... @property def remote_address() -> str: ... @property def remote_port() -> int: ... # In class SAMLSPServer: @property def on_connect() -> Callable[[SAMLSPServerConnectEventParams], None]: ... @on_connect.setter def on_connect(event_hook: Callable[[SAMLSPServerConnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as on_session_closed or on_session_established. # on_disconnect event Fires to report a disconnected client. ## Syntax ```text class SAMLSPServerDisconnectEventParams(object): @property def connection_id() -> int: ... # In class SAMLSPServer: @property def on_disconnect() -> Callable[[SAMLSPServerDisconnectEventParams], None]: ... @on_disconnect.setter def on_disconnect(event_hook: Callable[[SAMLSPServerDisconnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when a connected client disconnects. # on_encrypted event Notifies the application that the assertion is encrypted and provides recipient certificate details. ## Syntax ```text class SAMLSPServerEncryptedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @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 SAMLSPServer: @property def on_encrypted() -> Callable[[SAMLSPServerEncryptedEventParams], None]: ... @on_encrypted.setter def on_encrypted(event_hook: Callable[[SAMLSPServerEncryptedEventParams], 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 Information about errors during data delivery. ## Syntax ```text class SAMLSPServerErrorEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def error_code() -> int: ... @property def fatal() -> bool: ... @property def remote() -> bool: ... @property def description() -> str: ... # In class SAMLSPServer: @property def on_error() -> Callable[[SAMLSPServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[SAMLSPServerErrorEventParams], None]) -> None: ... ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section. # on_external_sign event Handles remote or external signing initiated by the server protocol. ## Syntax ```text class SAMLSPServerExternalSignEventParams(object): @property def connection_id() -> int: ... @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class SAMLSPServer: @property def on_external_sign() -> Callable[[SAMLSPServerExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[SAMLSPServerExternalSignEventParams], None]) -> None: ... ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # on_logout_request_prepared event This event is fired when a new logout request has been prepared. ## Syntax ```text class SAMLSPServerLogoutRequestPreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def destination() -> str: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... @property def relay_state() -> str: ... @relay_state.setter def relay_state(value) -> None: ... # In class SAMLSPServer: @property def on_logout_request_prepared() -> Callable[[SAMLSPServerLogoutRequestPreparedEventParams], None]: ... @on_logout_request_prepared.setter def on_logout_request_prepared(event_hook: Callable[[SAMLSPServerLogoutRequestPreparedEventParams], None]) -> None: ... ``` ## Remarks The component uses this event to report completion of the LogoutRequest preparation. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the subject that is being logged out. The *SP* parameter references the service provider involved. The *RelayState* contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it). # on_logout_request_received event The class uses this event to notify the application about an incoming SAML Logout Request message. ## Syntax ```text class SAMLSPServerLogoutRequestReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def is_encrypted() -> bool: ... @property def is_signed() -> bool: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_logout_request_received() -> Callable[[SAMLSPServerLogoutRequestReceivedEventParams], None]: ... @on_logout_request_received.setter def on_logout_request_received(event_hook: Callable[[SAMLSPServerLogoutRequestReceivedEventParams], None]) -> None: ... ``` ## Remarks The SAML SP server fires this event when a SAML logout request is received at a single logout service endpoint. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the principal that is signing out. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | # on_logout_response_prepared event The class uses this event to notify the application about the Logout Response message being ready to be sent. ## Syntax ```text class SAMLSPServerLogoutResponsePreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def destination() -> str: ... @property def body() -> str: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... # In class SAMLSPServer: @property def on_logout_response_prepared() -> Callable[[SAMLSPServerLogoutResponsePreparedEventParams], None]: ... @on_logout_response_prepared.setter def on_logout_response_prepared(event_hook: Callable[[SAMLSPServerLogoutResponsePreparedEventParams], None]) -> None: ... ``` ## Remarks The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP. # on_logout_response_received event The class uses this event to notify the application about an incoming SAML LogoutResponse message. ## Syntax ```text class SAMLSPServerLogoutResponseReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def is_encrypted() -> bool: ... @property def is_signed() -> bool: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... @property def relay_state() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_logout_response_received() -> Callable[[SAMLSPServerLogoutResponseReceivedEventParams], None]: ... @on_logout_response_received.setter def on_logout_response_received(event_hook: Callable[[SAMLSPServerLogoutResponseReceivedEventParams], None]) -> None: ... ``` ## Remarks The SAML SP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The *RelayState* is a mirrored back value included in the request. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the principal that is signing out. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class SAMLSPServerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class SAMLSPServer: @property def on_notification() -> Callable[[SAMLSPServerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[SAMLSPServerNotificationEventParams], 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. This class can fire this event with the following *EventID* values: | | | | --- | --- | | SAMLResponderError | TBD | | SAMLSessionLogout | TBD | | ListeningStarted | Notifies the application that the server has started listening for incoming connections. | | ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. | # on_processing_completed event This event notifies the application of the completion of request or response processing. ## Syntax ```text class SAMLSPServerProcessingCompletedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def tag() -> str: ... @property def processing_result() -> int: ... @property def response() -> str: ... @property def redirect() -> bool: ... # In class SAMLSPServer: @property def on_processing_completed() -> Callable[[SAMLSPServerProcessingCompletedEventParams], None]: ... @on_processing_completed.setter def on_processing_completed(event_hook: Callable[[SAMLSPServerProcessingCompletedEventParams], None]) -> None: ... ``` ## Remarks The component fires on_processing_completed to notify the application about completion of an earlier initiated processing operation. It is only fired in [offline_mode](#offline_mode-property) in response to calls such as [process_assertion](#process_assertion-method), [process_logout_request](#process_logout_request-method), or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser. This event is fired strictly once for each Process* call, with the *ConnectionID* matching the value passed to the Process* method. The *SessionID* parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the [on_session_info_needed](#on_session_info_needed-event) event. The *ProcessingResult* indicates the type of deliverable that was created during the processing (see below for possible values). The *Response* parameter contains the body of the deliverable. This can take one of the forms: - a self-submitting form containing a SAML message. - a redirect URL. - a SOAP XML response. - an empty string if ProcessingResult is set to sprSuccess. The *Redirect* parameter indicates whether the value of *Response* should be passed to the browser within the 302 Location header, or as a document body. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | # on_read_artifact event Requests content identified by an artifact from the application. ## Syntax ```text class SAMLSPServerReadArtifactEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def request_id() -> str: ... @property def issuer() -> str: ... @property def artifact() -> str: ... @property def value() -> str: ... @value.setter def value(value) -> None: ... @property def skip() -> bool: ... @skip.setter def skip(value) -> None: ... # In class SAMLSPServer: @property def on_read_artifact() -> Callable[[SAMLSPServerReadArtifactEventParams], None]: ... @on_read_artifact.setter def on_read_artifact(event_hook: Callable[[SAMLSPServerReadArtifactEventParams], None]) -> None: ... ``` ## Remarks The component fires this event to request the content matching *Artifact* from the application. This is normally happens within the artifact resolution protocol between the SP and the IdP server. The application must provide the requested artifact content via the *Value* parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting *Skip* to true. # on_resource_close event Tells the application that it can close the opened resource. ## Syntax ```text class SAMLSPServerResourceCloseEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def handle() -> str: ... # In class SAMLSPServer: @property def on_resource_close() -> Callable[[SAMLSPServerResourceCloseEventParams], None]: ... @on_resource_close.setter def on_resource_close(event_hook: Callable[[SAMLSPServerResourceCloseEventParams], None]) -> None: ... ``` ## Remarks The class uses this event to notify the application that it can now close the resource opened earlier in its [on_resource_open](#on_resource_open-event) handler. # on_resource_open event Requests the application to open the requested resource. ## Syntax ```text class SAMLSPServerResourceOpenEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def url() -> str: ... @property def http_method() -> str: ... @property def operation_status() -> int: ... @operation_status.setter def operation_status(value) -> None: ... @property def handle() -> str: ... @handle.setter def handle(value) -> None: ... # In class SAMLSPServer: @property def on_resource_open() -> Callable[[SAMLSPServerResourceOpenEventParams], None]: ... @on_resource_open.setter def on_resource_open(event_hook: Callable[[SAMLSPServerResourceOpenEventParams], None]) -> None: ... ``` ## Remarks The class fires this event in virtualized mode if the application had returned the *fraCustom* modifier from the earlier [on_resource_request](#on_resource_request-event) event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent [on_resource_read](#on_resource_read-event) event calls. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_resource_read event Requests the application to read from an opened resource. ## Syntax ```text class SAMLSPServerResourceReadEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def handle() -> str: ... @property def size() -> int: ... @property def operation_status() -> int: ... @operation_status.setter def operation_status(value) -> None: ... # In class SAMLSPServer: @property def on_resource_read() -> Callable[[SAMLSPServerResourceReadEventParams], None]: ... @on_resource_read.setter def on_resource_read(event_hook: Callable[[SAMLSPServerResourceReadEventParams], None]) -> None: ... ``` ## Remarks The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to *Size* bytes from the object, and pass them to the component with a [set_client_buffer](#set_client_buffer-method) call. Use the *OperationStatus* parameter to return the operation result back to the server. When the file has been read up to its end, set *OperationStatus* to ostEOF to tell the components that no more on_resource_read calls are needed. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_resource_request event Notifies the application that a server resource is requested. ## Syntax ```text class SAMLSPServerResourceRequestEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def url() -> str: ... @property def http_method() -> str: ... @property def res_protected() -> bool: ... @res_protected.setter def res_protected(value) -> None: ... @property def res_special() -> bool: ... @res_special.setter def res_special(value) -> None: ... @property def allow_writing() -> bool: ... @allow_writing.setter def allow_writing(value) -> None: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_resource_request() -> Callable[[SAMLSPServerResourceRequestEventParams], None]: ... @on_resource_request.setter def on_resource_request(event_hook: Callable[[SAMLSPServerResourceRequestEventParams], None]) -> None: ... ``` ## Remarks The class uses this event to notify the application that the connection has requested a server resource. The *URL* parameter specifies the resource requested. *ResProtected* is set to true if the resource is protected by SAML. *ResSpecial* is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request). Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | # on_resource_write event Requests the application to write to an opened resource. ## Syntax ```text class SAMLSPServerResourceWriteEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def handle() -> str: ... @property def operation_status() -> int: ... @operation_status.setter def operation_status(value) -> None: ... # In class SAMLSPServer: @property def on_resource_write() -> Callable[[SAMLSPServerResourceWriteEventParams], None]: ... @on_resource_write.setter def on_resource_write(event_hook: Callable[[SAMLSPServerResourceWriteEventParams], None]) -> None: ... ``` ## Remarks The class fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the [get_client_buffer](#get_client_buffer-method) method and write them to the opened file descriptor. Use the *OperationStatus* parameter to return the operation result back to the server: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # on_saml_message_prepared event This event is fired when a SAML message has been prepared and is ready to be dispatched. ## Syntax ```text class SAMLSPServerSAMLMessagePreparedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def message_id() -> str: ... @property def destination() -> str: ... @property def issue_instant() -> str: ... @property def in_response_to() -> str: ... @property def request_body() -> str: ... @property def message_type() -> str: ... @property def message_body() -> str: ... @message_body.setter def message_body(value) -> None: ... @property def relay_state() -> str: ... @relay_state.setter def relay_state(value) -> None: ... @property def success() -> bool: ... @success.setter def success(value) -> None: ... # In class SAMLSPServer: @property def on_saml_message_prepared() -> Callable[[SAMLSPServerSAMLMessagePreparedEventParams], None]: ... @on_saml_message_prepared.setter def on_saml_message_prepared(event_hook: Callable[[SAMLSPServerSAMLMessagePreparedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The *InResponseTo* contains the ID of the message in response to which the current message is sent (if applicable). The *RequestBody* parameter contains the body of such request. The *MessageType* parameter indicates the type of the message that has been prepared, such as SAMLResponse. The *MessageBody* contains the XML body of the message. The *Success* parameter indicates whether the message contains a positive statement or an error. Both the *MessageBody* and *Success* parameters are adjustable. # on_saml_message_received event The server fires this event for every SAML message it receives. ## Syntax ```text class SAMLSPServerSAMLMessageReceivedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def message_id() -> str: ... @property def issuer() -> str: ... @property def issue_instant() -> str: ... @property def in_response_to() -> str: ... @property def request_body() -> str: ... @property def message_type() -> str: ... @property def message_body() -> str: ... @property def is_signed() -> bool: ... @property def relay_state() -> str: ... @property def action() -> int: ... @action.setter def action(value) -> None: ... # In class SAMLSPServer: @property def on_saml_message_received() -> Callable[[SAMLSPServerSAMLMessageReceivedEventParams], None]: ... @on_saml_message_received.setter def on_saml_message_received(event_hook: Callable[[SAMLSPServerSAMLMessageReceivedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about incoming SAML messages. The *MessageType*, *MessageID*, *Issuer*, and *MessageBody* parameters provide the details of the message received. The *RequestBody* and *InResponseTo* contain a reference to the request that this message is a response to (if any). Set Action property as required to let the component know how to proceed. | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | # on_session_created event This event is fired when a new session has been established. ## Syntax ```text class SAMLSPServerSessionCreatedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... # In class SAMLSPServer: @property def on_session_created() -> Callable[[SAMLSPServerSessionCreatedEventParams], None]: ... @on_session_created.setter def on_session_created(event_hook: Callable[[SAMLSPServerSessionCreatedEventParams], None]) -> None: ... ``` ## Remarks *ConnectionID* contains the identifier of the new session, *SessionID* specifies the ID of the new session. # on_session_destroyed event This event is fired when the SP server has closed a session. ## Syntax ```text class SAMLSPServerSessionDestroyedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... # In class SAMLSPServer: @property def on_session_destroyed() -> Callable[[SAMLSPServerSessionDestroyedEventParams], None]: ... @on_session_destroyed.setter def on_session_destroyed(event_hook: Callable[[SAMLSPServerSessionDestroyedEventParams], None]) -> None: ... ``` ## Remarks *ConnectionID* contains the identifier of the closed session. # on_session_event event Notifies the application about SAML session events. ## Syntax ```text class SAMLSPServerSessionEventEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def event_text() -> str: ... # In class SAMLSPServer: @property def on_session_event() -> Callable[[SAMLSPServerSessionEventEventParams], None]: ... @on_session_event.setter def on_session_event(event_hook: Callable[[SAMLSPServerSessionEventEventParams], None]) -> None: ... ``` ## Remarks class uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes. The *SessionID* parameter specifies the session ID, and the *EventText* parameter describes the event that happened. Below are a few typical examples of what *EventText* you can expect to get: - Start - AuthnRequestPrepared - ResponseReceived - ResourceSupplied - LogoutRequestPrepared - LogoutResponseReceived - LogoutRequestReceived - LogoutResponsePrepared - ArtifactResolveRequestReceived - ArtifactResponsePrepared - Finish # on_session_info_needed event This event is fired in OfflineMode to request the session ID for the current flow. ## Syntax ```text class SAMLSPServerSessionInfoNeededEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @session_id.setter def session_id(value) -> None: ... # In class SAMLSPServer: @property def on_session_info_needed() -> Callable[[SAMLSPServerSessionInfoNeededEventParams], None]: ... @on_session_info_needed.setter def on_session_info_needed(event_hook: Callable[[SAMLSPServerSessionInfoNeededEventParams], None]) -> None: ... ``` ## Remarks SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them. The components use a collection of Session* events to exchange session information with the application: - [on_session_created](#on_session_created-event) is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie. - [on_session_state_save](#on_session_state_save-event) : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire [on_session_state_save](#on_session_state_save-event) multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data. - [on_session_state_retrieve](#on_session_state_retrieve-event) : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again. - on_session_info_needed (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls [process_logout_request](#process_logout_request-method) but passes an empty SessionID as a parameter. - [on_session_destroyed](#on_session_destroyed-event) is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event. # on_session_state_retrieve event This event fires to retrieve session state information from the application. ## Syntax ```text class SAMLSPServerSessionStateRetrieveEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def session_state() -> str: ... @session_state.setter def session_state(value) -> None: ... # In class SAMLSPServer: @property def on_session_state_retrieve() -> Callable[[SAMLSPServerSessionStateRetrieveEventParams], None]: ... @on_session_state_retrieve.setter def on_session_state_retrieve(event_hook: Callable[[SAMLSPServerSessionStateRetrieveEventParams], None]) -> None: ... ``` ## Remarks The component fires this event to request a session state that was previously provided to the application via the [on_session_state_save](#on_session_state_save-event) call. See the [on_session_info_needed](#on_session_info_needed-event) topic for more details about session management in offline mode. # on_session_state_save event This event passes a session state object to the application for safekeeping. ## Syntax ```text class SAMLSPServerSessionStateSaveEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def session_state() -> str: ... # In class SAMLSPServer: @property def on_session_state_save() -> Callable[[SAMLSPServerSessionStateSaveEventParams], None]: ... @on_session_state_save.setter def on_session_state_save(event_hook: Callable[[SAMLSPServerSessionStateSaveEventParams], None]) -> None: ... ``` ## Remarks The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a [on_session_state_retrieve](#on_session_state_retrieve-event) call. See the [on_session_info_needed](#on_session_info_needed-event) topic for more details about session management in offline mode. # on_signature_found event Signifies the start of signature validation. ## Syntax ```text class SAMLSPServerSignatureFoundEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def scope() -> int: ... @property def signer() -> str: ... @property def target_id() -> str: ... @property def target_type() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def sig_method() -> str: ... @property def digest_method() -> str: ... @property def cert_found() -> bool: ... @property def validate() -> bool: ... @validate.setter def validate(value) -> None: ... # In class SAMLSPServer: @property def on_signature_found() -> Callable[[SAMLSPServerSignatureFoundEventParams], None]: ... @on_signature_found.setter def on_signature_found(event_hook: Callable[[SAMLSPServerSignatureFoundEventParams], 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](CertificateValidator.md#CertificateValidator) component to validate its chain. Use the *Validate* parameter to tell the reader whether it should validate the signature. # on_signature_validated event Reports the signature validation result. ## Syntax ```text class SAMLSPServerSignatureValidatedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def scope() -> int: ... @property def signer() -> str: ... @property def target_id() -> str: ... @property def target_type() -> str: ... @property def issuer_rdn() -> str: ... @property def serial_number() -> bytes: ... @property def subject_key_id() -> bytes: ... @property def sig_method() -> str: ... @property def digest_method() -> str: ... @property def validation_result() -> int: ... @validation_result.setter def validation_result(value) -> None: ... # In class SAMLSPServer: @property def on_signature_validated() -> Callable[[SAMLSPServerSignatureValidatedEventParams], None]: ... @on_signature_validated.setter def on_signature_validated(event_hook: Callable[[SAMLSPServerSignatureValidatedEventParams], 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 | *IssuerRDN* returns the name of the signature issuer, *SerialNumber* identifies the signing certificate, *SubjectKeyID* contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, *ValidationResult* specifies whether signature is valid or not: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | # on_tls_cert_validate event Fires when a client certificate needs to be validated. ## Syntax ```text class SAMLSPServerTLSCertValidateEventParams(object): @property def connection_id() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class SAMLSPServer: @property def on_tls_cert_validate() -> Callable[[SAMLSPServerTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[SAMLSPServerTLSCertValidateEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter. # on_tls_established event Reports the setup of a TLS session. ## Syntax ```text class SAMLSPServerTLSEstablishedEventParams(object): @property def connection_id() -> int: ... # In class SAMLSPServer: @property def on_tls_established() -> Callable[[SAMLSPServerTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[SAMLSPServerTLSEstablishedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # on_tls_handshake event Fires when a newly established client connection initiates a TLS handshake. ## Syntax ```text class SAMLSPServerTLSHandshakeEventParams(object): @property def connection_id() -> int: ... @property def server_name() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class SAMLSPServer: @property def on_tls_handshake() -> Callable[[SAMLSPServerTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[SAMLSPServerTLSHandshakeEventParams], None]) -> None: ... ``` ## Remarks Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message. # on_tls_psk event Requests a pre-shared key for TLS-PSK. ## Syntax ```text class SAMLSPServerTLSPSKEventParams(object): @property def connection_id() -> int: ... @property def identity() -> str: ... @property def psk() -> str: ... @psk.setter def psk(value) -> None: ... @property def ciphersuite() -> str: ... @ciphersuite.setter def ciphersuite(value) -> None: ... # In class SAMLSPServer: @property def on_tls_psk() -> Callable[[SAMLSPServerTLSPSKEventParams], None]: ... @on_tls_psk.setter def on_tls_psk(event_hook: Callable[[SAMLSPServerTLSPSKEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake. Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key. # on_tls_shutdown event Reports closure of a TLS session. ## Syntax ```text class SAMLSPServerTLSShutdownEventParams(object): @property def connection_id() -> int: ... # In class SAMLSPServer: @property def on_tls_shutdown() -> Callable[[SAMLSPServerTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[SAMLSPServerTLSShutdownEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [on_disconnect](#on_disconnect-event), which marks the closure of the underlying TCP session. # on_user_auth_completed event Notifies the application about the success of user authentication flow. ## Syntax ```text class SAMLSPServerUserAuthCompletedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def assertion_body() -> str: ... @property def auth() -> str: ... @property def name_id() -> str: ... @property def name_id_format() -> str: ... @property def session_index() -> str: ... @property def valid_from() -> str: ... @property def valid_to() -> str: ... @property def relay_state() -> str: ... # In class SAMLSPServer: @property def on_user_auth_completed() -> Callable[[SAMLSPServerUserAuthCompletedEventParams], None]: ... @on_user_auth_completed.setter def on_user_auth_completed(event_hook: Callable[[SAMLSPServerUserAuthCompletedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to get notified about completion of user authentication flow. The *NameID*, *NameIDFormat*, *SessionIndex*, *ValidFrom*, and *ValidTo* parameters contain the session parameters as stated in the assertion, which is provided via the *AssertionBody* parameter. The *Auth* parameter contain the authentication mechanism used. The *RelayState* matches the original relay state that was used on the initiation stage of the authentication. # on_user_auth_failed event Notifies the application about failure of user authentication flow. ## Syntax ```text class SAMLSPServerUserAuthFailedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def relay_state() -> str: ... # In class SAMLSPServer: @property def on_user_auth_failed() -> Callable[[SAMLSPServerUserAuthFailedEventParams], None]: ... @on_user_auth_failed.setter def on_user_auth_failed(event_hook: Callable[[SAMLSPServerUserAuthFailedEventParams], None]) -> None: ... ``` ## Remarks The component fires this event to notify the application about failed user authentication flow. The *RelayState* parameter matches the one included with the AuthnRequest message. # on_user_auth_start event Notifies the application about the start of user authentication flow. ## Syntax ```text class SAMLSPServerUserAuthStartEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def id_p_service_index() -> int: ... @property def relay_state() -> str: ... @relay_state.setter def relay_state(value) -> None: ... # In class SAMLSPServer: @property def on_user_auth_start() -> Callable[[SAMLSPServerUserAuthStartEventParams], None]: ... @on_user_auth_start.setter def on_user_auth_start(event_hook: Callable[[SAMLSPServerUserAuthStartEventParams], None]) -> None: ... ``` ## Remarks The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message. The *RelayState* is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow. # on_user_logout_completed event Notifies the application about the completion of user logout flow. ## Syntax ```text class SAMLSPServerUserLogoutCompletedEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def name_id() -> str: ... @property def session_index() -> str: ... @property def relay_state() -> str: ... # In class SAMLSPServer: @property def on_user_logout_completed() -> Callable[[SAMLSPServerUserLogoutCompletedEventParams], None]: ... @on_user_logout_completed.setter def on_user_logout_completed(event_hook: Callable[[SAMLSPServerUserLogoutCompletedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about the completion of the logout flow. # on_user_logout_start event Notifies the application about the start of user logout flow. ## Syntax ```text class SAMLSPServerUserLogoutStartEventParams(object): @property def connection_id() -> int: ... @property def session_id() -> str: ... @property def id_p_service_index() -> int: ... @property def name_id() -> str: ... @property def session_index() -> str: ... @property def secondary() -> bool: ... @property def relay_state() -> str: ... @relay_state.setter def relay_state(value) -> None: ... # In class SAMLSPServer: @property def on_user_logout_start() -> Callable[[SAMLSPServerUserLogoutStartEventParams], None]: ... @on_user_logout_start.setter def on_user_logout_start(event_hook: Callable[[SAMLSPServerUserLogoutStartEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to get notified about the start of the user logout flow. The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the [initiate_logout](#initiate_logout-method) method, [process_logout_request](#process_logout_request-method) method, or upon receiving a logout request at the SLS endpoint. Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the [on_user_logout_completed](#on_user_logout_completed-event) event. Note that the [on_user_logout_completed](#on_user_logout_completed-event) event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires. The *IdPServiceIndex* parameter contains the index of the IdP service in the id_p_services collection. *NameID* indicates the name identifier of the user that is being logged out, and *SessionIndex* contain the unique SAML session identifier. The *Secondary* flag indicates whether the the SP is responding to IdP-initiated logout request. The *RelayState* parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process. # SAMLSPServer 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](#config-method) method. ### SAMLSPServer Config Settings **AllowOptionsResponseWithoutAuth**: Enables unauthenticated responses to OPTIONS requests.Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client. **AttributeConsumingService**: TBD.TBD **AuthDigestExpire**: Specifies digest expiration time for digest authentication.Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **ContactPerson**: The ContactPerson entry of the provider metadata.Use this configuration setting to set or get the ContactPerson element of the provider metadata record. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. **HomePage**: Specifies the home page resource name.Use this property to specify the home page (/) resource name. **IDPAQS**: TBD.TBD **IDPARS**: TBD.TBD **IDPSLS**: TBD.TBD **IDPSSO**: TBD.TBD **MaxIssueInstantTimeDiff**: The maximum issue-instant time delta.This property specifies the maximum time delta for serving issue-instant requests, in milliseconds. The default value is 30000. **OAuthAllowAccessByDefault**: Specifies whether access to a resource is allowed by default.Use this property to enable or disable access to a resource in case if no scopes defined or the resource doesn't match any of the user's scopes. **OAuthAutoValidateTokens**: Allows to validate OAuth 2.0 access tokens automatically.Use this property to enable or disable pre-validation of access tokens. **OAuthIntrospectionClientID**: Specifies a client ID on the authentication service.Use this property to provide a client ID for access token introspection. **OAuthIntrospectionClientSecret**: Specifies a client secret on the authentication service.Use this property to provide a client secret for access token introspection. **OAuthIntrospectionURL**: Specifies the URL to be used to introspect access tokens.Use this property to provide the URL for introspection. **OAuthTokenValidationKeys**: Specifies JW keys in JSON format for validating access token signatures. **OrganizationDisplayName**: The OrganizationDisplayName entry of the provider metadata.Use this property to provide or get the OrganizationDisplayName element of the provider metadata. **OrganizationLang**: The OrganizationLang key of the provider metadata.Use this property to get or set the OrganizationLog element of the provider metadata. **OrganizationName**: The OrganizationName element of the provider metadata.This configuration property allows you to set or get the OrganizationName element of the provider metadata. **OrganizationURL**: The OrganizationURL element of the provider metadata.Use this configuration setting to set or get the OrganizationURL parameter of the provider metadata. **PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. **PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. **RequestFilter**: The request string modifier.Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request. **SAMLAction**: TBD.TBD **SAMLBuffer**: TBD.TBD **SAMLResourceProtected**: TBD.TBD **SAMLResourceSpecial**: TBD.TBD **SAMLString**: TBD.TBD **SendBufferSize**: The network send buffer size.Specifies the size of the output buffer. **ServerName**: Specifies the server name for the created responses.Use this property to specify the server name to be included in the generated responses. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SessionTTL**: The SAML session time-to-live value.The SAML session time-to-live value, in milliseconds. The default value is 600000 (10 minutes). **SignatureAlgorithm**: TBD.TBD **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **UseZeroIndexForDefaultServices**: TBD.TBD **WantAssertionsSigned**: TBD.TBD ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # SAMLSPServer Errors ### SAMLSPServer Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 30408705 | Invalid binding name ([SB_ERROR_SAML_INVALID_BINDING_NAME](constants.md#const_SBERRORSAMLINVALIDBINDINGNAME)) | | 30408706 | Invalid SAML binding type ([SB_ERROR_SAML_INVALID_BINDING_TYPE](constants.md#const_SBERRORSAMLINVALIDBINDINGTYPE)) | | 30408707 | Base directory not set ([SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET](constants.md#const_SBERRORSAMLSPBASEDIRECTORYNOTSET)) | | 30408708 | Invalid parameter ([SB_ERROR_SAML_INVALID_PARAM](constants.md#const_SBERRORSAMLINVALIDPARAM)) | | 30408709 | Invalid input data ([SB_ERROR_SAML_INVALID_DATA](constants.md#const_SBERRORSAMLINVALIDDATA)) | | 30408710 | Data is not loaded ([SB_ERROR_SAML_NOT_LOADED](constants.md#const_SBERRORSAMLNOTLOADED)) | | 30408711 | New document is not created ([SB_ERROR_SAML_NOT_CREATED](constants.md#const_SBERRORSAMLNOTCREATED)) | | 30408716 | Endpoint of unsupported type encountered or cannot find appropriate IdP service ([SB_ERROR_SAML_INVALID_SERVICE](constants.md#const_SBERRORSAMLINVALIDSERVICE)) | | 30408717 | Multiple endpoints of the same kind are not supported ([SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED](constants.md#const_SBERRORSAMLMULTIPLEENDPOINTSNOTSUPPORTED)) | | 30408718 | Failed to process the request ([SB_ERROR_SAML_PROCESSING_FAILED](constants.md#const_SBERRORSAMLPROCESSINGFAILED)) | | 30408719 | Session not found ([SB_ERROR_SAML_SESSION_NOT_FOUND](constants.md#const_SBERRORSAMLSESSIONNOTFOUND)) |