SAMLSPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer class represents a SAML service provider.

Syntax

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

  server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";

• Configure the main server capabilities:

  // 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:

  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 that you've provided above, in which case saving it to a file is not necessary. server.SaveMetadata("my_metadata.xml");

You are now ready to start the server: 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 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 property. If protected_resources is empty, the server considers all the files in base_dir 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.

Method List

---

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

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.

Config Settings

---

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

active Property

Tells whether the server is active and ready to process requests.

Syntax

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

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

def get_binding_key_handle() -> int: ...
def set_binding_key_handle(value: int) -> None: ...

binding_key_handle = property(get_binding_key_handle, set_binding_key_handle)

Default Value

0

Remarks

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

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

binding_key_key Property

The byte array representation of the key.

Syntax

def get_binding_key_key() -> bytes: ...

binding_key_key = property(get_binding_key_key, None)

Remarks

The byte array representation of the key. This may not be available for non-binding_key_exportable keys.

This property is read-only.

decryption_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

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

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

external_crypto_async_document_id Property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

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

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

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

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

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.

external_crypto_key_id Property

The ID of the pre-shared key used for DC request authentication.

Syntax

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 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

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

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

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)

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

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)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

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.

fips_mode Property

Reserved.

Syntax

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

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

handshake_timeout Property

Specifies the handshake timeout in milliseconds.

Syntax

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

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.

id_p_service_count Property

The number of records in the IdPService arrays.

Syntax

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_entity_id
• id_p_service_location
• id_p_service_priority
• id_p_service_service
• id_p_service_service_index

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

def get_id_p_service_binding_type(id_p_service_index: int) -> int: ...

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

This property is read-only.

id_p_service_entity_id Property

Represents the SAML entity ID.

Syntax

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

This property is read-only.

id_p_service_location Property

The location (URL) of the endpoint.

Syntax

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

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.

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

This property is read-only.

id_p_service_service Property

The kind of the service being provided at this endpoint.

Syntax

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

This property is read-only.

id_p_service_service_index Property

The index of this endpoint.

Syntax

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

This property is read-only.

id_p_contact_person Property

The contact person or persons for the entity.

Syntax

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:

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

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

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

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

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_p_id_psso_link Property

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

def get_id_p_id_psso_link() -> str: ...
def set_id_p_id_psso_link(value: str) -> None: ...

id_p_id_psso_link = property(get_id_p_id_psso_link, set_id_p_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

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

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

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

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

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

def get_id_p_signature_validation_result() -> int: ...

id_p_signature_validation_result = property(get_id_p_signature_validation_result, None)

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only.

id_p_signed Property

Specifies whether the SAML entity information is or should be signed.

Syntax

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

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

This property is read-only.

id_p_signing_key Property

Contains the entity's signing key.

Syntax

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

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.

issuer Property

Name identifier of the issuer of the SP's requests.

Syntax

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

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_handle

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

known_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

known_cert_handle Property

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

Syntax

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

Default Value

0

Remarks

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

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

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

known_key_count Property

The number of records in the KnownKey arrays.

Syntax

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

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

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

logout_page Property

Specifies the location of the logout page.

Syntax

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

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

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

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

offline_mode Property

Enables the Offline mode.

Syntax

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

offline_mode = property(get_offline_mode, set_offline_mode)

Default Value

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_logout_request process_artifact_resolve_request, 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

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

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:

This property is read-only.

pinned_client_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_pinned_client_chain_validation_result() -> int: ...

pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None)

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

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

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

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

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

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

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

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

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

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_id Property

The client connection's unique identifier.

Syntax

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

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

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_named_ec_curve Property

The elliptic curve used in this connection.

Syntax

def get_pinned_client_named_ec_curve() -> str: ...

pinned_client_named_ec_curve = property(get_pinned_client_named_ec_curve, None)

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

pinned_client_pfs_cipher Property

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

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

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

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

This property is read-only.

pinned_client_cert_fingerprint Property

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

Syntax

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

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

This property is read-only.

pinned_client_cert_issuer Property

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

Syntax

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.

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

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

This property is read-only.

pinned_client_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

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.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes 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 property.

This property is read-only.

pinned_client_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

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 or pinned_client_cert_private_key_bytes 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 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

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 property. The key fingeprint 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 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

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:

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

This property is read-only.

pinned_client_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

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

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

This property is read-only.

pinned_client_cert_serial_number Property

Returns the certificate's serial number.

Syntax

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

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

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.

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

This property is read-only.

pinned_client_cert_subject_key_id Property

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

Syntax

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 and pinned_client_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

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

This property is read-only.

pinned_client_cert_valid_from Property

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

Syntax

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

This property is read-only.

pinned_client_cert_valid_to Property

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

Syntax

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

This property is read-only.

port Property

Specifies the listening port number.

Syntax

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.

protected_resources Property

Specifies the list of protected resources.

Syntax

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

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

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

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

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:

security_flags Property

Provides access to secondary security parameters and tweaks.

Syntax

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

security_sig_method Property

The signature method to use.

Syntax

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

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)

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

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_handle

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

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

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

This property is read-only.

signing_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_cert_bytes() -> bytes: ...

signing_cert_bytes = property(get_signing_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

signing_cert_handle Property

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

Syntax

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

signing_chain_count Property

The number of records in the SigningChain arrays.

Syntax

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_handle

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

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

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

socket_incoming_speed_limit Property

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

Syntax

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

socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)

Default Value

0

Remarks

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

socket_local_address Property

The local network interface to bind the socket to.

Syntax

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

socket_local_address = property(get_socket_local_address, set_socket_local_address)

Default Value

""

Remarks

The local network interface to bind the socket to.

socket_local_port Property

The local port number to bind the socket to.

Syntax

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

socket_local_port = property(get_socket_local_port, set_socket_local_port)

Default Value

0

Remarks

The local port number to bind the socket to.

socket_outgoing_speed_limit Property

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

Syntax

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

socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)

Default Value

0

Remarks

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

socket_timeout Property

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

Syntax

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

socket_timeout = property(get_socket_timeout, set_socket_timeout)

Default Value

60000

Remarks

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

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

socket_use_ipv6 Property

Enables or disables IP protocol version 6.

Syntax

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

socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

sp_service_count Property

The number of records in the SPService arrays.

Syntax

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_entity_id
• sp_service_location
• sp_service_priority
• sp_service_service
• sp_service_service_index

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

def get_sp_service_binding_type(sp_service_index: int) -> int: ...

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

This property is read-only.

sp_service_entity_id Property

Represents the SAML entity ID.

Syntax

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

This property is read-only.

sp_service_location Property

The location (URL) of the endpoint.

Syntax

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

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.

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

This property is read-only.

sp_service_service Property

The kind of the service being provided at this endpoint.

Syntax

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

This property is read-only.

sp_service_service_index Property

The index of this endpoint.

Syntax

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

This property is read-only.

sp_contact_person Property

The contact person or persons for the entity.

Syntax

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:

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

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

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

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

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

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

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

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

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

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

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

def get_sp_signature_validation_result() -> int: ...

sp_signature_validation_result = property(get_sp_signature_validation_result, None)

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only.

sp_signed Property

Specifies whether the SAML entity information is or should be signed.

Syntax

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

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

This property is read-only.

sp_signing_key Property

Contains the entity's signing key.

Syntax

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

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.

tls_server_cert_count Property

The number of records in the TLSServerCert arrays.

Syntax

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_handle

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

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

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

tls_auto_validate_certificates Property

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

Syntax

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

tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)

Default Value

TRUE

Remarks

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

tls_base_configuration Property

Selects the base configuration for the TLS settings.

Syntax

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

tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)

Default Value

0

Remarks

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

tls_ciphersuites Property

A list of ciphersuites separated with commas or semicolons.

Syntax

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

tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)

Default Value

""

Remarks

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

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

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

tls_client_auth Property

Enables or disables certificate-based client authentication.

Syntax

def get_tls_client_auth() -> int: ...
def set_tls_client_auth(value: int) -> None: ...

tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

tls_ec_curves Property

Defines the elliptic curves to enable.

Syntax

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

tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)

Default Value

""

Remarks

Defines the elliptic curves to enable.

tls_extensions Property

Provides access to TLS extensions.

Syntax

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

tls_extensions = property(get_tls_extensions, set_tls_extensions)

Default Value

""

Remarks

Provides access to TLS extensions.

tls_force_resume_if_destination_changes Property

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

Syntax

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

tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)

Default Value

FALSE

Remarks

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

tls_pre_shared_identity Property

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

Syntax

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

tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)

Default Value

""

Remarks

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

tls_pre_shared_key Property

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

Syntax

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

tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)

Default Value

""

Remarks

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

tls_pre_shared_key_ciphersuite Property

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

Syntax

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

tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)

Default Value

""

Remarks

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

tls_renegotiation_attack_prevention_mode Property

Selects the renegotiation attack prevention mechanism.

Syntax

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

tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

tls_revocation_check Property

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

Syntax

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

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

Default Value

1

Remarks

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

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

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

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

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

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

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

tls_ssl_options Property

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

Syntax

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

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

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

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

0

Remarks

Specifies the TLS mode to use.

tls_use_extended_master_secret Property

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

Syntax

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

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

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

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

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

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

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

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

url Property

Specifies the base URL of this SP server.

Syntax

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

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), 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:

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:

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.

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 method, which registers the service provider's own service.

add_sp_service Method

Registers an SP service in the SPServices list.

Syntax

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:

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:

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.

The Location parameter specifies an absolute or relative path to the service within the SAML web service:

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

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

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

Remarks

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

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

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

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

do_action Method

Performs an additional action.

Syntax

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

Remarks

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

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

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

Common ActionIDs:

drop_client Method

Terminates a client connection.

Syntax

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

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

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 event handler, when implementing customized file transfers.

get_provider_property Method

Returns the value of a custom provider property.

Syntax

def get_provider_property(name: str) -> str: ...

Remarks

This method, together with set_provider_property, 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

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

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

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

def get_session_property(session_id: str, name: str) -> str: ...

Remarks

This method, together with set_session_property, 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 and on_session_destroyed 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

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

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.

You can use this method with or without the offline_mode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

initiate_attribute_query Method

Initiates the attribute query.

Syntax

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.

You can use this method with or without the offline_mode.

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

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 event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

initiate_logout Method

Starts SP-initiated SAML logout flow.

Syntax

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 event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

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.

You can use this method with or without the offline_mode.

list_clients Method

Enumerates the connected clients.

Syntax

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

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

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:

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 event, and, later on, of an event matching the type of the actual message received - such as on_assertion_received.

You can use this method with or without the offline_mode.

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

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 event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

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

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 event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

process_generic_request Method

Processes a generic HTTP SAML request.

Syntax

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.

process_logout_request Method

Processes logout request received from the IdP service at one of the SLS endpoints.

Syntax

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 event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the offline_mode.

reset Method

Resets the class settings.

Syntax

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

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

def set_provider_property(name: str, value: str) -> None: ...

Remarks

This method, together with get_provider_property, 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

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

def set_session_property(session_id: str, name: str, value: str) -> None: ...

Remarks

This method, together with get_session_property, 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. 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

def start() -> None: ...

Remarks

Use this method to start listening for incoming connections.

stop Method

Stops the IdP server.

Syntax

def stop() -> None: ...

Remarks

Call this method to stop listening for incoming connections.

on_accept Event

Reports an incoming connection.

Syntax

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

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

In offline_mode this event would typically be fired from process_artifact 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

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

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:

on_assertion_received Event

This event is fired when an assertion is received from the IdP.

Syntax

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 this event may fire in response to a process_assertion 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:

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

on_attribute_query_prepared Event

Notifies the application of the preparation of an AttributeQuery.

Syntax

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

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 method when working in offline_mode, 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

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

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

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

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

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

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

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:

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

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

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:

on_notification Event

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

Syntax

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:

on_processing_completed Event

This event notifies the application of the completion of request or response processing.

Syntax

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 in response to calls such as process_assertion, process_logout_request, 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 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.

on_read_artifact Event

Requests content identified by an artifact from the application.

Syntax

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

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

on_resource_open Event

Requests the application to open the requested resource.

Syntax

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 event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent on_resource_read event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_resource_read Event

Requests the application to read from an opened resource.

Syntax

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

on_resource_request Event

Notifies the application that a server resource is requested.

Syntax

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

on_resource_write Event

Requests the application to write to an opened resource.

Syntax

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 method and write them to the opened file descriptor.

Use the OperationStatus parameter to return the operation result back to the server:

on_saml_message_prepared Event

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Syntax

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

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.

on_session_created Event

This event is fired when a new session has been established.

Syntax

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

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

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

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 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 : 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 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 : 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 but passes an empty SessionID as a parameter.
• on_session_destroyed 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

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

See the on_session_info_needed 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

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

See the on_session_info_needed topic for more details about session management in offline mode.

on_signature_found Event

Signifies the start of signature validation.

Syntax

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.

The details of the reported signature are populated in the security object. For assertion signatures, you can update the details by pinning the assertion.

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

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the signing_certificate property and the associated certificates from the certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature.

on_signature_validated Event

Reports the signature validation result.

Syntax

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

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:

on_tls_cert_validate Event

Fires when a client certificate needs to be validated.

Syntax

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

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

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

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

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

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

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

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

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

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 method, process_logout_request 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 event. Note that the on_user_logout_completed 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 method.

SAMLSPServer Config Settings

Base Config Settings

SAMLSPServer Errors

SAMLSPServer Errors