SecureBlackbox 2022 Python Edition
Version 22.0 [Build 8521]
SecureBlackbox 2022 Python Edition
Introduction
Sample Projects
Licensing Instructions
Upgrade Guide
Frequently Asked Questions
Supported Platforms
Supported Algorithms
Common Errors
Delphi Edition Variants
Supported CAs
Supported HSMs
Tips and Tricks
Validating TLS certificates
Configuring TSA authentication
Signing with external keys
SAML: Using Okta, OneLogin, and other identity providers
Constants
Class Reference
ArchiveReader Class
Introduction
Properties
archive_type
decryption_cert_count
decryption_cert_bytes
decryption_cert_handle
decryption_password
file_data
file_count
file_action
file_compressed_size
file_data_source
file_directory
file_encryption_algorithm
file_encryption_key_length
file_encryption_type
file_file_name
file_folder
file_local_path
file_m_time
file_new_file
file_path
file_signature_count
file_signed
file_size
fips_mode
hash_algorithm
known_cert_count
known_cert_bytes
known_cert_handle
opened
signature_validation_result
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_policy_i_ds
signing_cert_public_key_bytes
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
Methods
close
config
do_action
extract
extract_all
open
open_bytes
Events
on_after_extract_file
on_before_extract_file
on_decryption_password_needed
on_error
on_notification
on_progress
on_recipient_found
on_signature_found
Config Settings
Error Codes
ArchiveWriter Class
Introduction
Properties
archive_type
compression_algorithm
compression_level
decryption_cert_count
decryption_cert_bytes
decryption_cert_handle
decryption_password
encryption_algorithm
encryption_cert_bytes
encryption_cert_handle
encryption_key_length
encryption_password
encryption_type
file_data
file_count
file_action
file_compressed_size
file_data_source
file_directory
file_encryption_algorithm
file_encryption_key_length
file_encryption_type
file_file_name
file_folder
file_local_path
file_m_time
file_new_file
file_path
file_signature_count
file_signed
file_size
fips_mode
new_archive
opened
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
Methods
add_empty_dir
add_file
add_files
add_virtual
close
config
create_new
do_action
open
open_bytes
remove
save
save_bytes
update_file
update_files
update_virtual
Events
on_after_compress_file
on_before_compress_file
on_decryption_password_needed
on_error
on_notification
on_prepare_file
on_progress
on_recipient_found
Config Settings
Error Codes
ASiCSigner Class
Introduction
Properties
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
extended
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
file_count
file_action
file_compressed_size
file_data_source
file_directory
file_encryption_algorithm
file_encryption_key_length
file_encryption_type
file_file_name
file_folder
file_local_path
file_m_time
file_new_file
file_path
file_signature_count
file_signed
file_size
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
new_sig_certificate_index
new_sig_chain_validation_details
new_sig_chain_validation_result
new_sig_claimed_signing_time
new_sig_content_type
new_sig_file_name
new_sig_handle
new_sig_hash_algorithm
new_sig_issuer_rdn
new_sig_level
new_sig_policy_hash
new_sig_policy_hash_algorithm
new_sig_policy_id
new_sig_policy_uri
new_sig_serial_number
new_sig_signature_bytes
new_sig_signature_type
new_sig_signature_validation_result
new_sig_signed_files
new_sig_subject_key_id
new_sig_subject_rdn
new_sig_timestamped
new_sig_validated_signing_time
new_sig_validation_log
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
output_path
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_content_type
signature_file_name
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_level
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_type
signature_signature_validation_result
signature_signed_files
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
source_bytes
source_files
source_name
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
add_file
add_timestamp_validation_data
add_validation_data_refs
add_validation_data_values
close
config
create_new
do_action
extract_async_data
extract_file
extract_files
open
revalidate
sign
sign_async_begin
sign_async_end
sign_external
timestamp
upgrade
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_container_loaded
on_error
on_external_sign
on_file_extraction_start
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_request
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
ASiCVerifier Class
Introduction
Properties
all_signatures_valid
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
extraction_mode
file_count
file_action
file_compressed_size
file_data_source
file_directory
file_encryption_algorithm
file_encryption_key_length
file_encryption_type
file_file_name
file_folder
file_local_path
file_m_time
file_new_file
file_path
file_signature_count
file_signed
file_size
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
output_path
profile
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_content_type
signature_file_name
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_level
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_type
signature_signature_validation_result
signature_signed_files
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
close
config
do_action
extract_file
extract_files
open
revalidate
unsign
verify
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_container_loaded
on_error
on_file_extraction_start
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
Authenticator Class
Introduction
Properties
auth_info_auth_log
auth_info_auth_method
auth_info_auth_method_pars
auth_info_completed_methods
auth_info_last_auth_message
auth_info_last_auth_result
auth_info_remaining_methods
auth_info_state
auth_info_user_id
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
chain_validation_details
chain_validation_result
default_auth_methods
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
ignore_chain_validation_errors
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
offline_mode
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signing_cert_bytes
signing_cert_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_otp_algorithm
user_otp_value
user_outgoing_speed_limit
user_password
user_password_len
user_shared_secret
user_ssh_key
user_username
validation_log
validation_moment
Methods
config
continue_auth
do_action
start_auth
Events
on_auth_attempt_result
on_auth_attempt_start
on_auth_start
on_auth_verify
on_custom_auth_start
on_error
on_notification
Config Settings
Error Codes
AuthenticodeSigner Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
claimed_signing_time
custom_signed_attr_count
custom_signed_attr_category
custom_signed_attr_format
custom_signed_attr_name
custom_signed_attr_value
custom_unsigned_attr_count
custom_unsigned_attr_category
custom_unsigned_attr_format
custom_unsigned_attr_name
custom_unsigned_attr_value
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
hash_algorithm
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
offline_mode
output_bytes
output_file
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
remove_existing_signatures
revocation_check
signature_description
signature_index
signature_url
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
statement_type
timestamp_server
timestamp_type
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_log
Methods
config
do_action
extract_async_data
sign
sign_async_begin
sign_async_end
sign_external
timestamp
update
Events
on_chain_element_download
on_chain_element_needed
on_chain_validation_progress
on_error
on_external_sign
on_notification
on_start
on_timestamp_request
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
AuthenticodeVerifier Class
Introduction
Properties
actual_checksum
all_signatures_valid
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
chain_validation_details
chain_validation_result
claimed_signing_time
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
sig_chain_validation_details
sig_chain_validation_result
sig_claimed_signing_time
sig_description
sig_error_code
sig_error_message
sig_file_hash_algorithm
sig_handle
sig_hash_algorithm
sig_signature_bytes
sig_signature_validation_result
sig_statement_type
sig_url
sig_validated_signing_time
sig_validation_log
signature_count
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_description
signature_error_code
signature_error_message
signature_file_hash_algorithm
signature_handle
signature_hash_algorithm
signature_signature_bytes
signature_signature_validation_result
signature_statement_type
signature_url
signature_validated_signing_time
signature_validation_log
signature_validation_result
signed
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_policy_i_ds
signing_cert_public_key_bytes
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
specified_checksum
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamped
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
tsa_cert_bytes
tsa_cert_ca
tsa_cert_ca_key_id
tsa_cert_crl_distribution_points
tsa_cert_curve
tsa_cert_fingerprint
tsa_cert_friendly_name
tsa_cert_handle
tsa_cert_hash_algorithm
tsa_cert_issuer
tsa_cert_issuer_rdn
tsa_cert_key_algorithm
tsa_cert_key_bits
tsa_cert_key_fingerprint
tsa_cert_key_usage
tsa_cert_key_valid
tsa_cert_ocsp_locations
tsa_cert_policy_i_ds
tsa_cert_public_key_bytes
tsa_cert_self_signed
tsa_cert_serial_number
tsa_cert_sig_algorithm
tsa_cert_subject
tsa_cert_subject_key_id
tsa_cert_subject_rdn
tsa_cert_valid_from
tsa_cert_valid_to
validated_signing_time
validation_log
validation_moment
Methods
config
do_action
verify
Events
on_chain_element_download
on_chain_element_needed
on_chain_validated
on_chain_validation_progress
on_error
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
CAdESSigner Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
chain_validation_details
chain_validation_result
claimed_signing_time
data_bytes
data_file
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
hash_algorithm
ignore_chain_validation_errors
input_bytes
input_file
input_is_hash
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
offline_mode
output_bytes
output_file
policy_hash
policy_hash_algorithm
policy_id
policy_uri
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_index
signed_attribute_count
signed_attribute_oid
signed_attribute_value
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
validation_log
Methods
archive
config
countersign
countersign_async_begin
countersign_async_end
countersign_external
do_action
extract_async_data
sign
sign_async_begin
sign_async_end
sign_external
timestamp
upgrade
Events
on_chain_element_download
on_chain_element_needed
on_chain_validation_progress
on_error
on_external_sign
on_notification
on_timestamp_request
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
CAdESVerifier Class
Introduction
Properties
all_signatures_valid
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
data_bytes
data_file
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
input_is_hash
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_compatibility_errors
signature_content_type
signature_countersigned
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_last_archival_time
signature_level
signature_message_digest
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_public_key_algorithm
signature_scope
signature_serial_number
signature_signature_bytes
signature_signature_validation_result
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signed_attribute_count
signed_attribute_oid
signed_attribute_value
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_ocsp_no_check
signing_cert_origin
signing_cert_policy_i_ds
signing_cert_private_key_bytes
signing_cert_private_key_exists
signing_cert_private_key_extractable
signing_cert_public_key_bytes
signing_cert_qualified_statements
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_alternative_name
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
tsa_cert_bytes
tsa_cert_ca
tsa_cert_ca_key_id
tsa_cert_crl_distribution_points
tsa_cert_curve
tsa_cert_fingerprint
tsa_cert_friendly_name
tsa_cert_handle
tsa_cert_hash_algorithm
tsa_cert_issuer
tsa_cert_issuer_rdn
tsa_cert_key_algorithm
tsa_cert_key_bits
tsa_cert_key_fingerprint
tsa_cert_key_usage
tsa_cert_key_valid
tsa_cert_ocsp_locations
tsa_cert_policy_i_ds
tsa_cert_public_key_bytes
tsa_cert_self_signed
tsa_cert_serial_number
tsa_cert_sig_algorithm
tsa_cert_subject
tsa_cert_subject_key_id
tsa_cert_subject_rdn
tsa_cert_valid_from
tsa_cert_valid_to
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
validation_moment
Methods
config
do_action
verify
verify_detached
Events
on_chain_element_download
on_chain_element_needed
on_chain_validated
on_chain_validation_progress
on_error
on_notification
on_signature_found
on_signature_processed
on_signature_validated
on_timestamp_found
on_timestamp_processed
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
CertificateManager Class
Introduction
Properties
ca_cert_bytes
ca_cert_handle
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_ocsp_no_check
cert_origin
cert_policy_i_ds
cert_private_key_bytes
cert_private_key_exists
cert_private_key_extractable
cert_public_key_bytes
cert_qualified_statements
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_alternative_name
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
cert_request_bytes
cert_request_curve
cert_request_handle
cert_request_hash_algorithm
cert_request_key_algorithm
cert_request_key_bits
cert_request_key_usage
cert_request_key_valid
cert_request_private_key_bytes
cert_request_public_key_bytes
cert_request_sig_algorithm
cert_request_subject
cert_request_subject_rdn
cert_request_valid
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
Methods
config
do_action
download
export_cert
export_csr
export_key
export_key_to_file
export_to_file
generate
generate_async_begin
generate_async_end
generate_csr
generate_external
get_extension_data
get_extension_state
get_sample_cert
import_cert
import_from_file
import_from_object
import_key
import_key_from_file
list_extensions
set_extension_data
set_extension_state
update
validate
Events
on_error
on_external_sign
on_notification
on_password_needed
Config Settings
Error Codes
CertificateStorage Class
Introduction
Properties
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_ocsp_no_check
cert_origin
cert_policy_i_ds
cert_private_key_bytes
cert_private_key_exists
cert_private_key_extractable
cert_public_key_bytes
cert_qualified_statements
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_alternative_name
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
fips_mode
opened
pinned_cert_bytes
pinned_cert_handle
selected_cert_count
selected_cert_bytes
selected_cert_ca
selected_cert_ca_key_id
selected_cert_crl_distribution_points
selected_cert_curve
selected_cert_fingerprint
selected_cert_friendly_name
selected_cert_handle
selected_cert_hash_algorithm
selected_cert_issuer
selected_cert_issuer_rdn
selected_cert_key_algorithm
selected_cert_key_bits
selected_cert_key_fingerprint
selected_cert_key_usage
selected_cert_key_valid
selected_cert_ocsp_locations
selected_cert_ocsp_no_check
selected_cert_origin
selected_cert_policy_i_ds
selected_cert_private_key_bytes
selected_cert_private_key_exists
selected_cert_private_key_extractable
selected_cert_public_key_bytes
selected_cert_qualified_statements
selected_cert_self_signed
selected_cert_serial_number
selected_cert_sig_algorithm
selected_cert_subject
selected_cert_subject_alternative_name
selected_cert_subject_key_id
selected_cert_subject_rdn
selected_cert_valid_from
selected_cert_valid_to
storage_id
storage_location
Methods
add
add_from_file
add_pinned
clear
close
config
create_new
do_action
export_bytes
export_to_file
get_storage_property
import_bytes
import_from_file
list_stores
login
logout
open
refresh
remove
select
select_chain
set_storage_property
Events
on_error
on_notification
on_password_needed
Config Settings
Error Codes
CertificateValidator Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cache_validation_results
cert_bytes
cert_handle
chain_validation_details
chain_validation_result
current_ca_cert_bytes
current_ca_cert_ca
current_ca_cert_ca_key_id
current_ca_cert_crl_distribution_points
current_ca_cert_curve
current_ca_cert_fingerprint
current_ca_cert_friendly_name
current_ca_cert_handle
current_ca_cert_hash_algorithm
current_ca_cert_issuer
current_ca_cert_issuer_rdn
current_ca_cert_key_algorithm
current_ca_cert_key_bits
current_ca_cert_key_fingerprint
current_ca_cert_key_usage
current_ca_cert_key_valid
current_ca_cert_ocsp_locations
current_ca_cert_ocsp_no_check
current_ca_cert_origin
current_ca_cert_policy_i_ds
current_ca_cert_private_key_bytes
current_ca_cert_private_key_exists
current_ca_cert_private_key_extractable
current_ca_cert_public_key_bytes
current_ca_cert_qualified_statements
current_ca_cert_self_signed
current_ca_cert_serial_number
current_ca_cert_sig_algorithm
current_ca_cert_subject
current_ca_cert_subject_alternative_name
current_ca_cert_subject_key_id
current_ca_cert_subject_rdn
current_ca_cert_valid_from
current_ca_cert_valid_to
current_cert_bytes
current_cert_ca
current_cert_ca_key_id
current_cert_crl_distribution_points
current_cert_curve
current_cert_fingerprint
current_cert_friendly_name
current_cert_handle
current_cert_hash_algorithm
current_cert_issuer
current_cert_issuer_rdn
current_cert_key_algorithm
current_cert_key_bits
current_cert_key_fingerprint
current_cert_key_usage
current_cert_key_valid
current_cert_ocsp_locations
current_cert_ocsp_no_check
current_cert_origin
current_cert_policy_i_ds
current_cert_private_key_bytes
current_cert_private_key_exists
current_cert_private_key_extractable
current_cert_public_key_bytes
current_cert_qualified_statements
current_cert_self_signed
current_cert_serial_number
current_cert_sig_algorithm
current_cert_subject
current_cert_subject_alternative_name
current_cert_subject_key_id
current_cert_subject_rdn
current_cert_valid_from
current_cert_valid_to
fips_mode
grace_period
interim_validation_details
interim_validation_result
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
max_validation_time
offline_mode
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
qualified_info_address
qualified_info_custom_tsls
qualified_info_download_log
qualified_info_information_uri
qualified_info_languages
qualified_info_next_update
qualified_info_provider
qualified_info_qualified
qualified_info_qualifiers
qualified_info_service_name
qualified_info_service_type_id
qualified_info_source
qualified_info_status
qualified_info_trade_name
qualified_info_use_default_tsls
qualified_info_validation_log
qualified_info_xml
revocation_check
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
used_cert_count
used_cert_bytes
used_cert_ca
used_cert_ca_key_id
used_cert_crl_distribution_points
used_cert_curve
used_cert_fingerprint
used_cert_friendly_name
used_cert_handle
used_cert_hash_algorithm
used_cert_issuer
used_cert_issuer_rdn
used_cert_key_algorithm
used_cert_key_bits
used_cert_key_fingerprint
used_cert_key_usage
used_cert_key_valid
used_cert_ocsp_locations
used_cert_ocsp_no_check
used_cert_origin
used_cert_policy_i_ds
used_cert_private_key_bytes
used_cert_private_key_exists
used_cert_private_key_extractable
used_cert_public_key_bytes
used_cert_qualified_statements
used_cert_self_signed
used_cert_serial_number
used_cert_sig_algorithm
used_cert_subject
used_cert_subject_alternative_name
used_cert_subject_key_id
used_cert_subject_rdn
used_cert_valid_from
used_cert_valid_to
used_crl_count
used_crl_bytes
used_crl_handle
used_crl_issuer
used_crl_issuer_rdn
used_crl_location
used_crl_next_update
used_crl_this_update
use_default_tsls
used_ocsp_count
used_ocsp_bytes
used_ocsp_handle
used_ocsp_issuer
used_ocsp_issuer_rdn
used_ocsp_location
used_ocsp_produced_at
use_system_certificates
validation_log
validation_moment
Methods
config
do_action
get_qualified_status
get_tsl_property
refresh_cache
reset_cache
terminate
validate
validate_for_smime
validate_for_ssl
Events
on_after_certificate_processing
on_after_certificate_validation
on_before_ca_certificate_download
on_before_certificate_processing
on_before_certificate_validation
on_before_crl_download
on_before_ocsp_download
on_ca_certificate_downloaded
on_ca_certificate_needed
on_crl_downloaded
on_crl_needed
on_error
on_notification
on_ocsp_downloaded
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
CRLManager Class
Introduction
Properties
ca_cert_bytes
ca_cert_handle
crl_bytes
crlca_key_id
crl_entry_count
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_sig_algorithm
crltbs
crl_this_update
entry_count
crl_entry_info_cert_status
crl_entry_info_handle
crl_entry_info_revocation_date
crl_entry_info_revocation_reason
crl_entry_info_serial_number
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
Methods
add
clear
config
do_action
download
get_cert_entry_index
get_extension_data
get_extension_state
list_extensions
load
load_from_file
remove
save
save_to_file
select_entry
set_extension_data
set_extension_state
validate
Events
on_error
on_external_sign
on_notification
Config Settings
Error Codes
CryptoKeyManager Class
Introduction
Properties
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_ocsp_no_check
cert_origin
cert_policy_i_ds
cert_private_key_bytes
cert_private_key_exists
cert_private_key_extractable
cert_public_key_bytes
cert_qualified_statements
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_alternative_name
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
derivation_algorithm
derive_iterations
fips_mode
hmac_algorithm
key_algorithm
key_bits
key_curve
key_exportable
key_handle
key_id
key_iv
key_key
key_nonce
key_private
key_public
key_subject
key_symmetric
key_valid
Methods
config
derive_key
do_action
export_bytes
export_to_cert
export_to_file
generate
get_key_param
get_key_param_str
import_bytes
import_from_cert
import_from_file
set_key_param
set_key_param_str
Events
on_error
on_notification
on_password_needed
Config Settings
Error Codes
CryptoKeyStorage Class
Introduction
Properties
fips_mode
key_count
key_algorithm
key_bits
key_curve
key_exportable
key_handle
key_id
key_iv
key_key
key_nonce
key_private
key_public
key_subject
key_symmetric
key_valid
opened
pinned_key_handle
selected_key_count
selected_key_algorithm
selected_key_bits
selected_key_curve
selected_key_exportable
selected_key_handle
selected_key_id
selected_key_iv
selected_key_key
selected_key_nonce
selected_key_private
selected_key_public
selected_key_subject
selected_key_symmetric
selected_key_valid
storage_id
storage_location
Methods
add_pinned
clear
close
config
create_new
do_action
get_storage_property
import_bytes
import_from_file
list_stores
login
logout
open
refresh
remove
select
set_storage_property
Events
on_error
on_notification
on_password_needed
Config Settings
Error Codes
DCAuth Class
Introduction
Properties
claimed_signing_time
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
input
input_encoding
key_id
key_secret
output
output_encoding
policies
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
storage_id
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
Methods
config
do_action
process_request
Events
on_custom_parameters_received
on_error
on_external_sign
on_key_secret_needed
on_notification
on_parameter_received
on_sign_request
on_sign_request_completed
on_timestamp_request
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
DCAuthWebServer Class
Introduction
Properties
active
allow_origin
auth_basic
auth_digest
auth_digest_expire
auth_realm
bound_port
client_auth
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
handshake_timeout
host
key_id
key_secret
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
policies
port
port_range_from
port_range_to
server_cert_count
server_cert_bytes
server_cert_handle
session_timeout
sign_endpoint
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
storage_id
timestamp_server
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_outgoing_speed_limit
user_password
user_shared_secret
user_username
website_name
Methods
config
do_action
drop_client
list_clients
pin_client
start
stop
Events
on_accept
on_auth_attempt
on_connect
on_custom_parameters_received
on_disconnect
on_error
on_external_sign
on_key_secret_needed
on_log
on_notification
on_parameter_received
on_password_needed
on_read_option
on_select_cert
on_sign_request
on_sign_request_completed
on_timestamp_request
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
on_write_option
Config Settings
Error Codes
DTLSClient Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
connected
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
output_bytes
output_string
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
Methods
config
connect
disconnect
do_action
export_key_material
process_plain_data
receive_all_data
receive_data
receive_plain_data
send_data
send_keep_alive
send_plain_data
send_text
start_tls
stop_tls
Events
on_error
on_external_sign
on_notification
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
DTLSServer Class
Introduction
Properties
active
bound_port
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
host
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
port
port_range_from
port_range_to
server_cert_count
server_cert_bytes
server_cert_handle
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
website_name
Methods
broadcast_data
broadcast_text
config
do_action
drop_client
export_key_material
list_clients
pin_client
process_plain_data
send_data
send_keep_alive
send_plain_data
send_text
start
stop
Events
on_accept
on_data
on_error
on_external_sign
on_notification
on_plain_data
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
FTPClient Class
Introduction
Properties
account_info
adjust_pasv_address
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
connected
control_channel_log
ctl_conn_info_aead_cipher
ctl_conn_info_chain_validation_details
ctl_conn_info_chain_validation_result
ctl_conn_info_ciphersuite
ctl_conn_info_client_authenticated
ctl_conn_info_client_auth_requested
ctl_conn_info_connection_established
ctl_conn_info_connection_id
ctl_conn_info_digest_algorithm
ctl_conn_info_encryption_algorithm
ctl_conn_info_exportable
ctl_conn_info_key_exchange_algorithm
ctl_conn_info_key_exchange_key_bits
ctl_conn_info_named_ec_curve
ctl_conn_info_pfs_cipher
ctl_conn_info_pre_shared_identity_hint
ctl_conn_info_public_key_bits
ctl_conn_info_resumed_session
ctl_conn_info_secure_connection
ctl_conn_info_server_authenticated
ctl_conn_info_signature_algorithm
ctl_conn_info_symmetric_block_size
ctl_conn_info_symmetric_key_bits
ctl_conn_info_total_bytes_received
ctl_conn_info_total_bytes_sent
ctl_conn_info_validation_log
ctl_conn_info_version
curr_list_entry_entry_format
curr_list_entry_file_date
curr_list_entry_file_type
curr_list_entry_handle
curr_list_entry_name
curr_list_entry_path
curr_list_entry_raw_data
curr_list_entry_size
data_conn_info_aead_cipher
data_conn_info_chain_validation_details
data_conn_info_chain_validation_result
data_conn_info_ciphersuite
data_conn_info_client_authenticated
data_conn_info_client_auth_requested
data_conn_info_connection_established
data_conn_info_connection_id
data_conn_info_digest_algorithm
data_conn_info_encryption_algorithm
data_conn_info_exportable
data_conn_info_key_exchange_algorithm
data_conn_info_key_exchange_key_bits
data_conn_info_named_ec_curve
data_conn_info_pfs_cipher
data_conn_info_pre_shared_identity_hint
data_conn_info_public_key_bits
data_conn_info_resumed_session
data_conn_info_secure_connection
data_conn_info_server_authenticated
data_conn_info_signature_algorithm
data_conn_info_symmetric_block_size
data_conn_info_symmetric_key_bits
data_conn_info_total_bytes_received
data_conn_info_total_bytes_sent
data_conn_info_validation_log
data_conn_info_version
encrypt_data_channel
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
modez
passive_mode
password
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
restart_at
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
transfer_type
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
username
Methods
abort
acct
append_bytes
append_file
change_dir
clear_command_channel
config
connect
delete_dir
delete_file
dir_exists
disconnect
do_action
download_bytes
download_file
download_files
file_exists
get_current_dir
get_file_size
list_dir
make_dir
noop
rename
send_command
upload_bytes
upload_file
upload_files
Events
on_control_receive
on_control_send
on_error
on_external_sign
on_file_operation
on_file_operation_result
on_list_entry
on_notification
on_progress
on_text_data_line
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
FTPServer Class
Introduction
Properties
active
allow_anonymous
client_file_entry_entry_format
client_file_entry_file_date
client_file_entry_file_type
client_file_entry_handle
client_file_entry_name
client_file_entry_path
client_file_entry_raw_data
client_file_entry_size
data_host
data_port_range_from
data_port_range_to
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
handshake_timeout
host
implicit_ssl
passive_mode_host
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
port
read_only
root_directory
security_options
server_cert_count
server_cert_bytes
server_cert_handle
session_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_outgoing_speed_limit
user_password
user_shared_secret
user_username
use_utf8
Methods
config
do_action
drop_client
get_client_buffer
list_clients
pin_client
set_client_buffer
set_client_file_entry
start
stop
Events
on_accept
on_after_change_directory
on_after_create_directory
on_after_remove_directory
on_after_remove_file
on_after_rename_file
on_after_request_attributes
on_auth_attempt
on_before_change_directory
on_before_create_directory
on_before_download_file
on_before_find
on_before_remove_directory
on_before_remove_file
on_before_rename_file
on_before_request_attributes
on_before_send_reply
on_before_upload_file
on_change_directory
on_command_processed
on_command_received
on_connect
on_create_directory
on_disconnect
on_download_begin
on_download_end
on_download_file
on_download_progress
on_error
on_external_sign
on_find_close
on_find_init
on_find_next
on_notification
on_read_file
on_remove_directory
on_remove_file
on_rename_file
on_request_attributes
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
on_transfer_completed
on_upload_begin
on_upload_end
on_upload_file
on_upload_progress
on_write_file
Config Settings
Error Codes
HashFunction Class
Introduction
Properties
algorithm
fips_mode
json_key_header_params
json_protected_header
json_unprotected_header
json_unprotected_header_params
key_algorithm
key_bits
key_curve
key_exportable
key_handle
key_id
key_iv
key_key
key_nonce
key_private
key_public
key_subject
key_symmetric
key_valid
output_encoding
Methods
config
do_action
finish
hash
hash_file
hash_stream
reset
update
update_file
update_stream
Events
on_error
on_notification
Config Settings
Error Codes
HTTPClient Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
custom_request
dynamic_data
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
keep_alive_policy
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
output_bytes
output_string
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
reason_phrase
req_header_count
req_header_category
req_header_format
req_header_name
req_header_value
req_params_accept
req_params_accept_charset
req_params_accept_language
req_params_accept_range_end
req_params_accept_range_start
req_params_authorization
req_params_connection
req_params_content_length
req_params_content_range_end
req_params_content_range_full_size
req_params_content_range_start
req_params_content_type
req_params_cookie
req_params_custom_headers
req_params_date
req_params_from
req_params_host
req_params_http_version
req_params_if_match
req_params_if_modified_since
req_params_if_none_match
req_params_if_unmodified_since
req_params_password
req_params_referer
req_params_user_agent
req_params_username
resp_header_count
resp_header_category
resp_header_format
resp_header_name
resp_header_value
resp_params_content_length
resp_params_date
resp_params_reason_phrase
resp_params_status_code
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
status_code
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
use_digest_auth
use_kerberos_auth
use_ntlm_auth
Methods
config
delete
do_action
get
get_bytes
get_file
head
options
post
post_bytes
post_file
post_web_form
put
put_bytes
put_file
trace
Events
on_cookie
on_document_begin
on_document_end
on_dynamic_data_needed
on_error
on_external_sign
on_headers_prepared
on_headers_received
on_notification
on_progress
on_redirection
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
HTTPServer Class
Introduction
Properties
active
allow_keep_alive
auth_basic
auth_digest
auth_digest_expire
auth_realm
bound_port
client_auth
compression_level
document_root
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
handshake_timeout
host
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
port
port_range_from
port_range_to
server_cert_count
server_cert_bytes
server_cert_handle
session_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
use_chunked_transfer
use_compression
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_outgoing_speed_limit
user_password
user_shared_secret
user_username
website_name
Methods
config
do_action
drop_client
get_request_bytes
get_request_header
get_request_string
get_request_username
get_response_header
list_clients
pin_client
process_generic_request
set_response_bytes
set_response_file
set_response_header
set_response_status
set_response_string
start
stop
Events
on_accept
on_auth_attempt
on_connect
on_custom_request
on_data
on_delete_request
on_disconnect
on_error
on_external_sign
on_file_error
on_get_request
on_headers_prepared
on_head_request
on_notification
on_options_request
on_patch_request
on_post_request
on_put_request
on_resource_access
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
on_trace_request
Config Settings
Error Codes
IMAPClient Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
curr_mailbox_message_flags
curr_mailbox_name
curr_mailbox_next_uid
curr_mailbox_permanent_flags
curr_mailbox_read_only
curr_mailbox_recent_messages
curr_mailbox_total_messages
curr_mailbox_uid_validity
curr_mailbox_unseen_messages
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
mailbox_info_count
mailbox_info_delimiter
mailbox_info_has_children
mailbox_info_has_no_children
mailbox_info_marked
mailbox_info_name
mailbox_info_no_inferiors
mailbox_info_no_select
mailbox_info_unmarked
msg_attachment_count
msg_bcc
msg_cc
msg_comments
msg_date
msg_delivery_receipt
msg_from
msg_handle
msg_html_text
msg_id
msg_in_reply_to
msg_keywords
msg_mailer
msg_plain_text
msg_priority
msg_read_receipt
msg_references
msg_reply_to
msg_return_path
msg_sender
msg_send_to
msg_subject
msg_info_count
msg_info_date
msg_info_flags
msg_info_from
msg_info_internal_date
msg_info_priority
msg_info_sent_to
msg_info_size
msg_info_subject
msg_info_uid
password
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
server_info_capabilities
server_info_idle_supported
server_info_login_disabled
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
username
Methods
close_mailbox
config
connect
copy_message
create_mailbox
delete_mailbox
disconnect
do_action
examine_mailbox
get_mailbox_status
list_all_messages
list_deleted_messages
list_mailboxes
list_new_messages
list_recent_messages
list_unseen_messages
mark_message_deleted
mark_message_seen
ping
post_bytes
post_file
post_message
purge_messages
receive_bytes
receive_file
receive_message
refresh_mailbox
rename_mailbox
select_mailbox
update_message
Events
on_before_auth
on_command
on_command_data
on_command_reply
on_command_reply_data
on_error
on_mailbox_status
on_notification
on_progress
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
JAdESSigner Class
Introduction
Properties
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
compact_form
content_type
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
data_bytes
data_file
data_string
detached
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
extract_payload
fips_mode
flattened_signature
ignore_chain_validation_errors
input_bytes
input_file
input_string
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
new_sig_certificate_index
new_sig_chain_validation_details
new_sig_chain_validation_result
new_sig_claimed_signing_time
new_sig_content_type
new_sig_countersigned
new_sig_handle
new_sig_hash_algorithm
new_sig_issuer_rdn
new_sig_jades_version
new_sig_last_archival_time
new_sig_level
new_sig_object_type
new_sig_parent_signature_index
new_sig_policy_hash
new_sig_policy_hash_algorithm
new_sig_policy_id
new_sig_policy_uri
new_sig_serial_number
new_sig_signature_bytes
new_sig_signature_validation_result
new_sig_signed_data
new_sig_signed_data_type
new_sig_subject_key_id
new_sig_subject_rdn
new_sig_timestamped
new_sig_validated_signing_time
new_sig_validation_log
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
output_string
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_content_type
signature_countersigned
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_jades_version
signature_last_archival_time
signature_level
signature_object_type
signature_parent_signature_index
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_validation_result
signature_signed_data
signature_signed_data_type
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
add_signed_http_header_field
add_signed_object
add_signed_object_hash
add_timestamp_validation_data
add_validation_data_refs
add_validation_data_values
close
config
create_new
do_action
extract_async_data
open
revalidate
sign
sign_async_begin
sign_async_end
sign_external
timestamp
upgrade
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_error
on_external_sign
on_http_header_field_needed
on_loaded
on_notification
on_object_needed
on_object_validate
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_request
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
JAdESVerifier Class
Introduction
Properties
all_signatures_valid
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
compact_form
content_type
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
data_bytes
data_file
data_string
detached
extract_payload
fips_mode
flattened_signature
ignore_chain_validation_errors
input_bytes
input_file
input_string
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
output_string
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_content_type
signature_countersigned
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_jades_version
signature_last_archival_time
signature_level
signature_object_type
signature_parent_signature_index
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_validation_result
signature_signed_data
signature_signed_data_type
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
close
config
do_action
open
revalidate
unsign
verify
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_error
on_http_header_field_needed
on_loaded
on_notification
on_object_needed
on_object_validate
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
KMIPClient Class
Introduction
Properties
data_file
encoder_type
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
host
input_file
object_count
object_id
object_key_algorithm
object_key_length
object_object_type
object_sig_algorithm
object_unique_identifier
output_file
password
pinned_cert_bytes
pinned_cert_handle
pinned_cert_request_bytes
pinned_cert_request_handle
port
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
signature_validation_result
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
username
Methods
add_certificate
add_key
add_pinned
config
decrypt
do_action
encrypt
generate_cert
generate_cert_from_pinned
generate_cert_from_request
generate_key
get_list
remove
sign
verify
Events
on_error
on_external_sign
on_notification
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
KMIPServer Class
Introduction
Properties
active
ca_cert_bytes
ca_cert_handle
cert_request_bytes
cert_request_curve
cert_request_handle
cert_request_hash_algorithm
cert_request_key_algorithm
cert_request_key_bits
cert_request_key_usage
cert_request_key_valid
cert_request_private_key_bytes
cert_request_public_key_bytes
cert_request_sig_algorithm
cert_request_subject
cert_request_subject_rdn
cert_request_valid
cert_storage_count
cert_storage_bytes
cert_storage_handle
encoder_type
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
generated_cert_bytes
generated_cert_handle
port
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
storage_file_name
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_otp_algorithm
user_otp_value
user_outgoing_speed_limit
user_password
user_password_len
user_shared_secret
user_ssh_key
user_username
Methods
config
do_action
get_client_cert
get_client_cert_request
set_client_cert
start
stop
Events
on_after_generate_cert
on_after_generate_key
on_auth_attempt
on_before_generate_cert
on_before_generate_key
on_destroy_action
on_error
on_external_sign
on_notification
on_request
Config Settings
Error Codes
MailReader Class
Introduction
Properties
attach_count
attach_content_subtype
attach_content_type
attach_creation_date
attach_data
attach_description
attach_filename
attach_handle
attach_id
attach_modification_date
attach_read_date
attach_size
bcc_addr_count
bcc_addr_address
bcc_addr_display_name
bcc_addr_group_name
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cc_addr_count
cc_addr_address
cc_addr_display_name
cc_addr_group_name
decryption_cert_bytes
decryption_cert_ca
decryption_cert_ca_key_id
decryption_cert_crl_distribution_points
decryption_cert_curve
decryption_cert_fingerprint
decryption_cert_friendly_name
decryption_cert_handle
decryption_cert_hash_algorithm
decryption_cert_issuer
decryption_cert_issuer_rdn
decryption_cert_key_algorithm
decryption_cert_key_bits
decryption_cert_key_fingerprint
decryption_cert_key_usage
decryption_cert_key_valid
decryption_cert_ocsp_locations
decryption_cert_ocsp_no_check
decryption_cert_origin
decryption_cert_policy_i_ds
decryption_cert_private_key_bytes
decryption_cert_private_key_exists
decryption_cert_private_key_extractable
decryption_cert_public_key_bytes
decryption_cert_qualified_statements
decryption_cert_self_signed
decryption_cert_serial_number
decryption_cert_sig_algorithm
decryption_cert_subject
decryption_cert_subject_alternative_name
decryption_cert_subject_key_id
decryption_cert_subject_rdn
decryption_cert_valid_from
decryption_cert_valid_to
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
from_addr_count
from_addr_address
from_addr_display_name
from_addr_group_name
ignore_chain_validation_errors
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
msg_attachment_count
msg_bcc
msg_cc
msg_comments
msg_date
msg_delivery_receipt
msg_from
msg_handle
msg_html_text
msg_id
msg_in_reply_to
msg_keywords
msg_mailer
msg_plain_text
msg_priority
msg_read_receipt
msg_references
msg_reply_to
msg_return_path
msg_sender
msg_send_to
msg_subject
offline_mode
header_field_count
header_field_category
header_field_format
header_field_name
header_field_value
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
reply_to_addr_count
reply_to_addr_address
reply_to_addr_display_name
reply_to_addr_group_name
revocation_check
sec_info_chain_validation_details
sec_info_chain_validation_result
sec_info_claimed_signing_time
sec_info_encrypted
sec_info_encryption_algorithm
sec_info_hash_algorithm
sec_info_signature_validation_result
sec_info_signed
sec_info_validation_log
sender_addr_address
sender_addr_display_name
sender_addr_group_name
send_to_addr_count
send_to_addr_address
send_to_addr_display_name
send_to_addr_group_name
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_policy_i_ds
signing_cert_public_key_bytes
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
used_cert_count
used_cert_bytes
used_cert_ca
used_cert_ca_key_id
used_cert_crl_distribution_points
used_cert_curve
used_cert_fingerprint
used_cert_friendly_name
used_cert_handle
used_cert_hash_algorithm
used_cert_issuer
used_cert_issuer_rdn
used_cert_key_algorithm
used_cert_key_bits
used_cert_key_fingerprint
used_cert_key_usage
used_cert_key_valid
used_cert_ocsp_locations
used_cert_ocsp_no_check
used_cert_origin
used_cert_policy_i_ds
used_cert_private_key_bytes
used_cert_private_key_exists
used_cert_private_key_extractable
used_cert_public_key_bytes
used_cert_qualified_statements
used_cert_self_signed
used_cert_serial_number
used_cert_sig_algorithm
used_cert_subject
used_cert_subject_alternative_name
used_cert_subject_key_id
used_cert_subject_rdn
used_cert_valid_from
used_cert_valid_to
validation_moment
Methods
config
do_action
find_attachment
load_from_bytes
load_from_file
Events
on_chain_validated
on_decryption_info_needed
on_error
on_external_decrypt
on_notification
on_signature_found
on_signature_validated
Config Settings
Error Codes
MailWriter Class
Introduction
Properties
attach_encoding
attach_count
attach_content_subtype
attach_content_type
attach_creation_date
attach_data
attach_description
attach_filename
attach_handle
attach_id
attach_modification_date
attach_read_date
attach_size
bcc_addr_count
bcc_addr_address
bcc_addr_display_name
bcc_addr_group_name
cc_addr_count
cc_addr_address
cc_addr_display_name
cc_addr_group_name
charset
encryption_cert_count
encryption_cert_bytes
encryption_cert_handle
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
from_addr_count
from_addr_address
from_addr_display_name
from_addr_group_name
header_encoding
mailer
msg_attachment_count
msg_bcc
msg_cc
msg_comments
msg_date
msg_delivery_receipt
msg_from
msg_handle
msg_html_text
msg_id
msg_in_reply_to
msg_keywords
msg_mailer
msg_plain_text
msg_priority
msg_read_receipt
msg_references
msg_reply_to
msg_return_path
msg_sender
msg_send_to
msg_subject
header_field_count
header_field_category
header_field_format
header_field_name
header_field_value
profile
reply_to_addr_count
reply_to_addr_address
reply_to_addr_display_name
reply_to_addr_group_name
sec_settings_claimed_signing_time
sec_settings_encrypt
sec_settings_encryption_algorithm
sec_settings_hash_algorithm
sec_settings_sign
sec_settings_signature_format
sec_settings_sign_before_encrypt
sec_settings_sign_message_header
sender_addr_address
sender_addr_display_name
sender_addr_group_name
send_to_addr_count
send_to_addr_address
send_to_addr_display_name
send_to_addr_group_name
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
text_encoding
Methods
attach_bytes
attach_file
attach_image
config
do_action
save_to_bytes
save_to_file
Events
on_error
on_external_sign
on_notification
Config Settings
Error Codes
MessageCompressor Class
Introduction
Properties
compression_level
fips_mode
input_bytes
input_file
output_bytes
output_file
Methods
compress
config
do_action
Events
on_error
on_notification
Config Settings
Error Codes
MessageDecompressor Class
Introduction
Properties
fips_mode
input_bytes
input_file
output_bytes
output_file
Methods
config
decompress
do_action
Events
on_error
on_notification
Config Settings
Error Codes
MessageDecryptor Class
Introduction
Properties
certificate_bytes
certificate_handle
certificate_issuer
certificate_issuer_rdn
certificate_serial_number
certificate_subject
certificate_subject_rdn
cert_count
cert_bytes
cert_handle
encryption_algorithm
encryption_type
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
input_bytes
input_file
key
output_bytes
output_file
signed_attribute_count
signed_attribute_oid
signed_attribute_value
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
Methods
check_encryption_type
config
decrypt
do_action
Events
on_error
on_external_decrypt
on_notification
on_recipient_found
Config Settings
Error Codes
MessageEncryptor Class
Introduction
Properties
bits_in_key
encryption_algorithm
encryption_cert_bytes
encryption_cert_handle
encryption_type
fips_mode
input_bytes
input_file
key
output_bytes
output_file
signed_attribute_count
signed_attribute_oid
signed_attribute_value
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
Methods
config
do_action
encrypt
Events
on_error
on_notification
Config Settings
Error Codes
MessageSigner Class
Introduction
Properties
claimed_signing_time
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
hash_algorithm
input_bytes
input_file
input_is_hash
mac_algorithm
output_bytes
output_file
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
recipient_cert_bytes
recipient_cert_handle
signature_type
signed_attribute_count
signed_attribute_oid
signed_attribute_value
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
Methods
config
countersign
do_action
extract_async_data
sign
sign_async_begin
sign_async_end
timestamp
Events
on_error
on_external_sign
on_notification
on_timestamp_request
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
MessageTimestamper Class
Introduction
Properties
data_file_name
data_uri
detached
fips_mode
hash_algorithm
input_bytes
input_file
input_is_hash
output_bytes
output_file
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_format
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
Methods
config
do_action
timestamp
Events
on_error
on_notification
on_timestamp_request
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
MessageTimestampVerifier Class
Introduction
Properties
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
data_bytes
data_file
data_file_name
data_uri
fips_mode
input_bytes
input_file
output_bytes
output_file
signature_validation_result
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_ocsp_no_check
signing_cert_origin
signing_cert_policy_i_ds
signing_cert_private_key_bytes
signing_cert_private_key_exists
signing_cert_private_key_extractable
signing_cert_public_key_bytes
signing_cert_qualified_statements
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_alternative_name
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
timestamp_format
validated_signing_time
Methods
config
do_action
verify
verify_detached
Events
on_error
on_notification
Config Settings
Error Codes
MessageVerifier Class
Introduction
Properties
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
claimed_signing_time
content_type
data_bytes
data_file
fips_mode
hash_algorithm
input_bytes
input_file
input_is_hash
known_cert_count
known_cert_bytes
known_cert_handle
mac_algorithm
output_bytes
output_file
signature_type
signature_validation_result
signed_attribute_count
signed_attribute_oid
signed_attribute_value
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_ocsp_no_check
signing_cert_origin
signing_cert_policy_i_ds
signing_cert_private_key_bytes
signing_cert_private_key_exists
signing_cert_private_key_extractable
signing_cert_public_key_bytes
signing_cert_qualified_statements
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_alternative_name
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamped
tsa_cert_bytes
tsa_cert_ca
tsa_cert_ca_key_id
tsa_cert_crl_distribution_points
tsa_cert_curve
tsa_cert_fingerprint
tsa_cert_friendly_name
tsa_cert_handle
tsa_cert_hash_algorithm
tsa_cert_issuer
tsa_cert_issuer_rdn
tsa_cert_key_algorithm
tsa_cert_key_bits
tsa_cert_key_fingerprint
tsa_cert_key_usage
tsa_cert_key_valid
tsa_cert_ocsp_locations
tsa_cert_policy_i_ds
tsa_cert_public_key_bytes
tsa_cert_self_signed
tsa_cert_serial_number
tsa_cert_sig_algorithm
tsa_cert_subject
tsa_cert_subject_key_id
tsa_cert_subject_rdn
tsa_cert_valid_from
tsa_cert_valid_to
unsigned_attribute_count
unsigned_attribute_oid
unsigned_attribute_value
validated_signing_time
Methods
check_signature_type
config
do_action
verify
verify_detached
Events
on_error
on_notification
on_recipient_found
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
Config Settings
Error Codes
OAuthClient Class
Introduction
Properties
access_token
auth_url
auto_refresh
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
client_id
client_secret
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
custom_param_count
custom_params_category
custom_params_format
custom_params_name
custom_params_value
expires_at
expires_in
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
failure_response
fips_mode
grant_type
id_token
keep_alive_policy
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
password
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
redirect_url
refresh_token
scope
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
state
success_response
timeout
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
token_type
token_url
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
username
Methods
authorize
config
do_action
Events
on_error
on_external_sign
on_launch_browser
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
on_wait
Config Settings
Error Codes
OCSPManager Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
ca_cert_bytes
ca_cert_handle
cert_bytes
cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
entry_count
entry_handle
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_response_bytes
ocsp_response_entry_count
ocsp_response_handle
ocsp_response_issuer
ocsp_response_issuer_rdn
ocsp_response_location
ocsp_response_produced_at
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
Methods
config
do_action
get_cert_entry_index
load_from_bytes
request
save_to_bytes
save_to_file
validate
Events
on_error
on_notification
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
OCSPServer Class
Introduction
Properties
active
auth_basic
auth_digest
auth_digest_expire
auth_realm
bad_entry_count
bad_entry_handle
bound_port
ca_cert_bytes
ca_cert_handle
client_auth
endpoint
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
good_entry_count
good_entry_handle
host
pinned_cert_count
pinned_cert_bytes
pinned_cert_handle
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
port
port_range_from
port_range_to
server_cert_count
server_cert_bytes
server_cert_handle
signing_cert_bytes
signing_cert_handle
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
update_period
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_outgoing_speed_limit
user_password
user_shared_secret
user_username
website_name
Methods
config
do_action
drop_client
get_request_bytes
get_request_header
get_request_string
get_request_username
import_bad_certificates
import_good_certificates
list_clients
pin_client
process_generic_request
start
stop
Events
on_accept
on_auth_attempt
on_connect
on_disconnect
on_error
on_external_sign
on_notification
on_status_request
on_tls_cert_validate
on_tls_established
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
OfficeDecryptor Class
Introduction
Properties
document_format
document_type
encryption_algorithm
encryption_type
fips_mode
input_bytes
input_file
output_bytes
output_file
password
Methods
config
decrypt
do_action
Events
on_decryption_password_needed
on_error
on_notification
Config Settings
Error Codes
OfficeEncryptor Class
Introduction
Properties
document_format
document_type
encryption_algorithm
encryption_type
fips_mode
input_bytes
input_file
output_bytes
output_file
password
Methods
config
do_action
encrypt
Events
on_error
on_notification
Config Settings
Error Codes
OfficeQuickSigner Class
Introduction
Properties
document_format
document_type
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
hash_algorithm
input_bytes
input_file
output_bytes
output_file
signature_type
sign_core_properties
sign_document
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
sign_signature_origin
Methods
config
do_action
extract_async_data
sign
sign_async_begin
sign_async_end
sign_external
Events
on_error
on_external_sign
on_notification
Config Settings
Error Codes
OfficeSigner Class
Introduction
Properties
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
document_format
document_type
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
new_sig_certificate_index
new_sig_chain_validation_details
new_sig_chain_validation_result
new_sig_claimed_signing_time
new_sig_core_properties_signed
new_sig_document_signed
new_sig_expire_time
new_sig_handle
new_sig_hash_algorithm
new_sig_issuer_rdn
new_sig_last_archival_time
new_sig_policy_hash
new_sig_policy_hash_algorithm
new_sig_policy_id
new_sig_policy_uri
new_sig_serial_number
new_sig_signature_bytes
new_sig_signature_info_comments
new_sig_signature_info_text
new_sig_signature_origin_signed
new_sig_signature_type
new_sig_signature_validation_result
new_sig_subject_key_id
new_sig_subject_rdn
new_sig_timestamped
new_sig_validated_signing_time
new_sig_validation_log
new_sig_xades
new_sig_xades_form
new_sig_xades_version
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_core_properties_signed
signature_document_signed
signature_expire_time
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_last_archival_time
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_info_comments
signature_signature_info_text
signature_signature_origin_signed
signature_signature_type
signature_signature_validation_result
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signature_xades
signature_xades_form
signature_xades_version
signed_part_count
signed_part_content_type
signed_part_hash_algorithm
signed_part_is_relationship_part
signed_part_path
signed_part_signature_index
signed_part_validation_result
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
add_timestamp_validation_data
add_validation_data_refs
add_validation_data_values
close
config
do_action
extract_async_data
open
revalidate
sign
sign_async_begin
sign_async_end
sign_external
timestamp
upgrade
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_document_loaded
on_error
on_external_sign
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_request
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
OfficeVerifier Class
Introduction
Properties
all_signatures_valid
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
document_format
document_type
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_core_properties_signed
signature_document_signed
signature_expire_time
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_last_archival_time
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_info_comments
signature_signature_info_text
signature_signature_origin_signed
signature_signature_type
signature_signature_validation_result
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signature_xades
signature_xades_form
signature_xades_version
signed_part_count
signed_part_content_type
signed_part_hash_algorithm
signed_part_is_relationship_part
signed_part_path
signed_part_signature_index
signed_part_validation_result
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
close
config
do_action
open
revalidate
unsign
verify
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_document_loaded
on_error
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
OTPClient Class
Introduction
Properties
fips_mode
key_secret
password_length
Methods
config
do_action
generate_hotp_password
generate_totp_password
Events
on_error
on_notification
Config Settings
Error Codes
OTPServer Class
Introduction
Properties
fips_mode
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_otp_algorithm
user_otp_value
user_outgoing_speed_limit
user_password
user_password_len
user_shared_secret
user_ssh_key
user_username
Methods
config
do_action
is_hotp_password_valid
is_password_valid
is_totp_password_valid
Events
on_error
on_notification
Config Settings
Error Codes
PasswordVault Class
Introduction
Properties
description
entry_key
entry_password
fips_mode
key
password
platform_protection
title
Methods
add_entry
change_entry_key
change_entry_password
close
config
do_action
get_entry_value
get_entry_value_str
list_entries
list_fields
open_bytes
open_file
remove_all_entries
remove_entry
remove_field
save_bytes
save_file
set_entry_value
set_entry_value_str
Events
on_entry_key_needed
on_error
on_key_needed
on_notification
Config Settings
Error Codes
PDFDecryptor Class
Introduction
Properties
decryption_certificate_bytes
decryption_certificate_handle
document_info_encryption_algorithm
document_info_encryption_type
document_info_metadata_encrypted
document_info_permissions
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
input_bytes
input_file
output_bytes
output_file
password
Methods
config
decrypt
do_action
Events
on_document_loaded
on_encrypted
on_error
on_external_decrypt
on_notification
Config Settings
Error Codes
PDFEncryptor Class
Introduction
Properties
document_info_encryption_algorithm
document_info_encryption_type
document_info_metadata_encrypted
document_info_permissions
encryption_algorithm
encryption_certificate_bytes
encryption_certificate_ca
encryption_certificate_ca_key_id
encryption_certificate_crl_distribution_points
encryption_certificate_curve
encryption_certificate_fingerprint
encryption_certificate_friendly_name
encryption_certificate_handle
encryption_certificate_hash_algorithm
encryption_certificate_issuer
encryption_certificate_issuer_rdn
encryption_certificate_key_algorithm
encryption_certificate_key_bits
encryption_certificate_key_fingerprint
encryption_certificate_key_usage
encryption_certificate_key_valid
encryption_certificate_ocsp_locations
encryption_certificate_ocsp_no_check
encryption_certificate_origin
encryption_certificate_policy_i_ds
encryption_certificate_private_key_bytes
encryption_certificate_private_key_exists
encryption_certificate_private_key_extractable
encryption_certificate_public_key_bytes
encryption_certificate_qualified_statements
encryption_certificate_self_signed
encryption_certificate_serial_number
encryption_certificate_sig_algorithm
encryption_certificate_subject
encryption_certificate_subject_alternative_name
encryption_certificate_subject_key_id
encryption_certificate_subject_rdn
encryption_certificate_valid_from
encryption_certificate_valid_to
encrypt_metadata
fips_mode
input_bytes
input_file
output_bytes
output_file
owner_password
permissions
user_password
Methods
config
do_action
encrypt
Events
on_document_loaded
on_error
on_notification
Config Settings
Error Codes
PDFSigner Class
Introduction
Properties
attached_file_count
attached_files_content_subtype
attached_files_content_type
attached_files_creation_date
attached_files_data
attached_files_description
attached_files_filename
attached_files_handle
attached_files_id
attached_files_modification_date
attached_files_read_date
attached_files_size
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
decryption_certificate_bytes
decryption_certificate_handle
document_info_encryption_algorithm
document_info_encryption_type
document_info_metadata_encrypted
document_info_permissions
empty_field_index
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
new_sig_allowed_changes
new_sig_author_name
new_sig_certificate_index
new_sig_certification
new_sig_chain_validation_details
new_sig_chain_validation_result
new_sig_claimed_signing_time
new_sig_contact_info
new_sig_coverage_ends_at
new_sig_custom_data
new_sig_empty_field
new_sig_filter_name
new_sig_full_signature_name
new_sig_handle
new_sig_hash_algorithm
new_sig_height
new_sig_level
new_sig_location
new_sig_offsetx
new_sig_offsety
new_sig_page
new_sig_policy_hash
new_sig_policy_hash_algorithm
new_sig_policy_id
new_sig_reason
new_sig_signature_bytes
new_sig_signature_name
new_sig_signature_validation_result
new_sig_subject_rdn
new_sig_timestamped
new_sig_validated_signing_time
new_sig_validation_log
new_sig_width
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
page_count
page_crop_llx
page_crop_lly
page_crop_urx
page_crop_ury
page_height
page_media_llx
page_media_lly
page_media_urx
page_media_ury
page_rotate
page_width
password
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_allowed_changes
signature_author_name
signature_certificate_index
signature_certification
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_contact_info
signature_coverage_ends_at
signature_custom_data
signature_empty_field
signature_filter_name
signature_full_signature_name
signature_handle
signature_hash_algorithm
signature_height
signature_level
signature_location
signature_offsetx
signature_offsety
signature_page
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_reason
signature_signature_bytes
signature_signature_name
signature_signature_validation_result
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signature_width
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
widget_algorithm_caption
widget_algorithm_info
widget_background_data
widget_background_height
widget_background_image_height
widget_background_image_type
widget_background_image_width
widget_background_mask
widget_background_position
widget_background_style
widget_background_width
widget_compress_widget_data
widget_custom_appearance
widget_custom_background_content_stream
widget_custom_visual_status_matrix
widget_date_format
widget_font_name
widget_handle
widget_header
widget_hide_default_text
widget_ignore_existing_appearance
widget_invert_mask
widget_invisible
widget_pages_to_place_on
widget_position_anchor
widget_render_options
widget_rotate
widget_show_date
widget_show_visual_status
widget_signer_caption
widget_signer_info
Methods
add_widget_custom_data
add_widget_text
add_widget_text_ex
attach_bytes
attach_file
close
config
do_action
extract_async_data
get_attached_bytes
get_attached_file
open
revalidate
sign
sign_async_begin
sign_async_end
sign_external
update
Events
on_chain_element_download
on_chain_element_needed
on_chain_validated
on_chain_validation_progress
on_document_loaded
on_encrypted
on_error
on_external_decrypt
on_external_sign
on_notification
on_pre_render_widget
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_request
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
PDFVerifier Class
Introduction
Properties
all_signatures_valid
attached_file_count
attached_files_content_subtype
attached_files_content_type
attached_files_creation_date
attached_files_data
attached_files_description
attached_files_filename
attached_files_handle
attached_files_id
attached_files_modification_date
attached_files_read_date
attached_files_size
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
decryption_certificate_bytes
decryption_certificate_handle
document_info_encryption_algorithm
document_info_encryption_type
document_info_metadata_encrypted
document_info_permissions
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
page_count
page_crop_llx
page_crop_lly
page_crop_urx
page_crop_ury
page_height
page_media_llx
page_media_lly
page_media_urx
page_media_ury
page_rotate
page_width
password
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
revocation_check
signature_count
signature_allowed_changes
signature_author_name
signature_certificate_index
signature_certification
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_contact_info
signature_coverage_ends_at
signature_custom_data
signature_empty_field
signature_filter_name
signature_full_signature_name
signature_handle
signature_hash_algorithm
signature_height
signature_level
signature_location
signature_offsetx
signature_offsety
signature_page
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_reason
signature_signature_bytes
signature_signature_name
signature_signature_validation_result
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signature_width
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
Methods
close
config
do_action
get_attached_bytes
get_attached_file
get_signed_version
open
revalidate
unsign
verify
Events
on_chain_element_download
on_chain_element_needed
on_chain_validated
on_chain_validation_progress
on_document_loaded
on_encrypted
on_error
on_notification
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_shutdown
Config Settings
Error Codes
PGPKeyManager Class
Introduction
Properties
fips_mode
key_bits_in_key
key_curve
key_encryption_algorithm
key_expires
key_handle
key_hash_algorithm
key_old_packet_format
key_passphrase
key_protection
key_public_key_algorithm
key_q_bits
key_username
Methods
add_subkey
bind_user
change_passphrase
change_protection
check_passphrase
config
do_action
export_key
export_public_key
export_public_to_file
export_to_file
generate
generate_legacy
generate_pair
import_from_file
import_key
remove_subkey
remove_user
revoke_key
revoke_subkey
revoke_subkeyby_id
revoke_user
revoke_user_by_name
validate
Events
on_error
on_notification
Config Settings
Error Codes
PGPKeyring Class
Introduction
Properties
fips_mode
opened
pinned_key_handle
public_key_count
public_key_bits_in_key
public_key_can_encrypt
public_key_can_sign
public_key_curve
public_key_enabled
public_key_encryption_algorithm
public_key_expires
public_key_handle
public_key_hash_algorithm
public_key_is_public
public_key_is_secret
public_key_is_subkey
public_key_key_fp
public_key_key_hash_algorithm
public_key_key_id
public_key_old_packet_format
public_key_passphrase
public_key_passphrase_valid
public_key_primary_key_id
public_key_protection
public_key_public_key_algorithm
public_key_q_bits
public_key_revoked
public_key_subkey_fp
public_key_subkey_id
public_key_timestamp
public_key_username
public_key_valid
public_key_valid_to
public_key_version
secret_key_count
secret_key_bits_in_key
secret_key_can_encrypt
secret_key_can_sign
secret_key_curve
secret_key_enabled
secret_key_encryption_algorithm
secret_key_expires
secret_key_handle
secret_key_hash_algorithm
secret_key_is_public
secret_key_is_secret
secret_key_is_subkey
secret_key_key_fp
secret_key_key_hash_algorithm
secret_key_key_id
secret_key_old_packet_format
secret_key_passphrase
secret_key_passphrase_valid
secret_key_primary_key_id
secret_key_protection
secret_key_public_key_algorithm
secret_key_q_bits
secret_key_revoked
secret_key_subkey_fp
secret_key_subkey_id
secret_key_timestamp
secret_key_username
secret_key_valid
secret_key_valid_to
secret_key_version
selected_public_key_count
selected_public_key_bits_in_key
selected_public_key_can_encrypt
selected_public_key_can_sign
selected_public_key_curve
selected_public_key_enabled
selected_public_key_encryption_algorithm
selected_public_key_expires
selected_public_key_handle
selected_public_key_hash_algorithm
selected_public_key_is_public
selected_public_key_is_secret
selected_public_key_is_subkey
selected_public_key_key_fp
selected_public_key_key_hash_algorithm
selected_public_key_key_id
selected_public_key_old_packet_format
selected_public_key_passphrase
selected_public_key_passphrase_valid
selected_public_key_primary_key_id
selected_public_key_protection
selected_public_key_public_key_algorithm
selected_public_key_q_bits
selected_public_key_revoked
selected_public_key_subkey_fp
selected_public_key_subkey_id
selected_public_key_timestamp
selected_public_key_username
selected_public_key_valid
selected_public_key_valid_to
selected_public_key_version
selected_secret_key_count
selected_secret_key_bits_in_key
selected_secret_key_can_encrypt
selected_secret_key_can_sign
selected_secret_key_curve
selected_secret_key_enabled
selected_secret_key_encryption_algorithm
selected_secret_key_expires
selected_secret_key_handle
selected_secret_key_hash_algorithm
selected_secret_key_is_public
selected_secret_key_is_secret
selected_secret_key_is_subkey
selected_secret_key_key_fp
selected_secret_key_key_hash_algorithm
selected_secret_key_key_id
selected_secret_key_old_packet_format
selected_secret_key_passphrase
selected_secret_key_passphrase_valid
selected_secret_key_primary_key_id
selected_secret_key_protection
selected_secret_key_public_key_algorithm
selected_secret_key_q_bits
selected_secret_key_revoked
selected_secret_key_subkey_fp
selected_secret_key_subkey_id
selected_secret_key_timestamp
selected_secret_key_username
selected_secret_key_valid
selected_secret_key_valid_to
selected_secret_key_version
Methods
add_from_bytes
add_from_file
add_from_files
add_pinned
clear
close
config
create_new
do_action
load
load_from_bytes
remove_by_id
remove_public
remove_secret
save
save_to_bytes
select
Events
on_error
on_notification
Config Settings
Error Codes
PGPReader Class
Introduction
Properties
armored
compressed
data_bytes
data_file
decrypting_key_count
decrypting_key_handle
decrypting_key_key_fp
decrypting_key_key_id
decrypting_key_passphrase
decrypting_key_passphrase_valid
decrypting_key_username
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
input_bytes
input_file
key_passphrase
output_bytes
output_file
passphrase
processed_length
profile
signature_count
signature_certification_type
signature_creation_time
signature_expiration_time
signature_exportable
signature_handle
signature_hash_algorithm
signature_key_expiration_time
signature_legacy_format
signature_policy_url
signature_primary_user_id
signature_reason_for_revocation
signature_revocable
signature_revocation
signature_signature_class
signature_signer_key_id
signature_signer_user_id
signature_strictly_valid
signature_text_signature
signature_trust_amount
signature_trust_level
signature_validated
signature_validity
signature_version
verifying_key_count
verifying_key_handle
verifying_key_key_fp
verifying_key_key_id
verifying_key_username
Methods
config
decrypt_and_verify
do_action
verify_detached
Events
on_encryption_info
on_error
on_external_decrypt
on_file_extraction_finish
on_file_extraction_start
on_key_passphrase_needed
on_multiple_files_found
on_notification
on_passphrase_needed
on_progress
on_signed
Config Settings
Error Codes
PGPWriter Class
Introduction
Properties
armor
armor_boundary
armor_headers
compress
compression_algorithm
compression_level
encrypting_key_count
encrypting_key_handle
encrypting_key_key_fp
encrypting_key_key_id
encrypting_key_username
encryption_algorithm
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
filename
fips_mode
hash_algorithm
input_bytes
input_file
input_is_text
output_bytes
output_file
passphrase
profile
protection
signing_key_count
signing_key_handle
signing_key_key_fp
signing_key_key_id
signing_key_passphrase
signing_key_passphrase_valid
signing_key_username
timestamp
Methods
clear_text_sign
config
do_action
encrypt
encrypt_and_sign
sign
Events
on_error
on_external_sign
on_key_passphrase_needed
on_notification
on_progress
Config Settings
Error Codes
POP3Client Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
msg_attachment_count
msg_bcc
msg_cc
msg_comments
msg_date
msg_delivery_receipt
msg_from
msg_handle
msg_html_text
msg_id
msg_in_reply_to
msg_keywords
msg_mailer
msg_plain_text
msg_priority
msg_read_receipt
msg_references
msg_reply_to
msg_return_path
msg_sender
msg_send_to
msg_subject
msg_info_count
msg_info_size
msg_info_uid
password
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
server_info_apop_supported
server_info_available
server_info_expiration_period
server_info_expire_supported
server_info_implementation_supported
server_info_login_delay
server_info_login_delay_supported
server_info_resp_codes_supported
server_info_sasl_supported
server_info_server_details
server_info_top_supported
server_info_uidl_supported
server_info_user_supported
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
username
Methods
config
connect
delete_message
disconnect
do_action
list_messages
ping
receive_bytes
receive_file
receive_message
undelete
Events
on_before_auth
on_command
on_command_reply
on_command_reply_data
on_error
on_external_sign
on_notification
on_progress
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
PublicKeyCrypto Class
Introduction
Properties
can_encrypt
can_sign
fips_mode
hash_algorithm
input_encoding
input_is_hash
json_key_header_params
json_protected_header
json_unprotected_header
json_unprotected_header_params
key_algorithm
key_bits
key_curve
key_exportable
key_handle
key_id
key_iv
key_key
key_nonce
key_private
key_public
key_subject
key_symmetric
key_valid
output_encoding
scheme
scheme_params
signature_validation_result
Methods
config
decrypt
decrypt_file
do_action
encrypt
encrypt_file
sign
sign_file
verify
verify_detached
verify_detached_file
verify_file
Events
on_error
on_notification
Config Settings
Error Codes
RESTClient Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
custom_request
dynamic_data
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
keep_alive_policy
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
output_bytes
output_string
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
reason_phrase
req_header_count
req_header_category
req_header_format
req_header_name
req_header_value
req_params_accept
req_params_accept_charset
req_params_accept_language
req_params_accept_range_end
req_params_accept_range_start
req_params_authorization
req_params_connection
req_params_content_length
req_params_content_range_end
req_params_content_range_full_size
req_params_content_range_start
req_params_content_type
req_params_cookie
req_params_custom_headers
req_params_date
req_params_from
req_params_host
req_params_http_version
req_params_if_match
req_params_if_modified_since
req_params_if_none_match
req_params_if_unmodified_since
req_params_password
req_params_referer
req_params_user_agent
req_params_username
resp_header_count
resp_header_category
resp_header_format
resp_header_name
resp_header_value
resp_params_content_length
resp_params_date
resp_params_reason_phrase
resp_params_status_code
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
status_code
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
use_digest_auth
use_ntlm_auth
Methods
config
delete
do_action
get
get_bytes
get_file
head
options
post
post_bytes
post_file
post_json
post_web_form
post_xml
put
put_bytes
put_file
put_json
put_xml
trace
Events
on_cookie
on_document_begin
on_document_end
on_dynamic_data_needed
on_error
on_external_sign
on_headers_prepared
on_headers_received
on_notification
on_progress
on_redirection
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
RESTServer Class
Introduction
Properties
active
allow_keep_alive
auth_basic
auth_digest
auth_digest_expire
auth_realm
bound_port
client_auth
compression_level
document_root
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
handshake_timeout
host
pinned_client_address
pinned_client_chain_validation_details
pinned_client_chain_validation_result
pinned_client_ciphersuite
pinned_client_client_authenticated
pinned_client_digest_algorithm
pinned_client_encryption_algorithm
pinned_client_id
pinned_client_key_exchange_algorithm
pinned_client_key_exchange_key_bits
pinned_client_named_ec_curve
pinned_client_pfs_cipher
pinned_client_port
pinned_client_pre_shared_identity
pinned_client_public_key_bits
pinned_client_resumed_session
pinned_client_secure_connection
pinned_client_signature_algorithm
pinned_client_symmetric_block_size
pinned_client_symmetric_key_bits
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_validation_log
pinned_client_version
pinned_client_cert_count
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
port
port_range_from
port_range_to
server_cert_count
server_cert_bytes
server_cert_handle
session_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
use_chunked_transfer
use_compression
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_outgoing_speed_limit
user_password
user_shared_secret
user_username
website_name
Methods
config
do_action
drop_client
get_request_bytes
get_request_header
get_request_string
get_request_username
get_response_header
list_clients
pin_client
process_generic_request
set_response_bytes
set_response_file
set_response_header
set_response_json
set_response_status
set_response_string
set_response_xml
start
stop
Events
on_accept
on_auth_attempt
on_connect
on_custom_request
on_data
on_delete_request
on_disconnect
on_error
on_external_sign
on_file_error
on_get_request
on_headers_prepared
on_head_request
on_notification
on_options_request
on_patch_request
on_post_request
on_put_request
on_resource_access
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
on_trace_request
Config Settings
Error Codes
Rnd Class
Introduction
Properties
alphabet
fips_mode
Methods
config
do_action
next_bytes
next_int
next_pass
next_string
randomize
seed_bytes
seed_int
seed_string
seed_time
Events
on_error
on_notification
Config Settings
Error Codes
SAMLIdPServer Class
Introduction
Properties
active
allow_idpsso
artifact_resolution_service
attribute_query_service
auth_form_template
client_auth
encrypt_assertions
encryption_cert_bytes
encryption_cert_handle
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
host
idpsso_page
idpsso_page_content
login_attempts_limit
metadata_url
meta_signing_cert_bytes
meta_signing_cert_handle
offline_mode
port
preferred_single_logout_response_binding
preferred_single_sign_on_response_binding
server_cert_count
server_cert_bytes
server_cert_handle
sig_canonicalization_method
sig_digest_method
sig_method
sign_assertions
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
sign_metadata
sign_response
single_logout_service
single_logout_service_bindings
single_sign_on_service
single_sign_on_service_bindings
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
url
Methods
add_id_psso_link
add_user
add_user_with_email
clear_users
config
do_action
get_provider_property
load_sp_metadata
process_generic_request
remove_id_psso_link
remove_sp
remove_user
save_metadata
set_provider_property
start
stop
Events
on_accept
on_assertion_created
on_assertion_received
on_connect
on_disconnect
on_error
on_external_sign
on_metadata_request
on_notification
on_session_closed
on_session_established
on_verify_credentials
Config Settings
Error Codes
SAMLReader Class
Introduction
Properties
artifact_endpoint_index
artifact_message_handle
artifact_remaining_artifact
artifact_source_id
artifact_type_code
artifact_uri
artifact_resolve_query
assertion_count
assertion_id_request_references
attr_query_attr_count
attr_query_attr_friendly_name
attr_query_attr_name
attr_query_attr_name_format
attr_query_attr_statement_index
attr_query_attr_values
authn_query_comparison
authn_query_context_class_refs
authn_query_ref_type
authn_query_session_index
authn_request_assertion_consumer_service_index
authn_request_assertion_consumer_service_url
authn_request_attribute_consuming_service_index
authn_request_conditions_not_before
authn_request_conditions_not_on_or_after
authn_request_context_class_refs
authn_request_context_comparison
authn_request_context_ref_type
authn_request_force_authn
authn_request_is_passive
authn_request_name_id_policy_allow_create
authn_request_name_id_policy_format
authn_request_name_id_policy_sp_name_qualifier
authn_request_name_id_policy_use_allow_create
authn_request_protocol_binding
authn_request_provider_name
authn_request_scoping_idp_list_get_complete
authn_request_scoping_proxy_count
authn_request_scoping_requester_i_ds
authn_request_use_force_authn
authn_request_use_is_passive
authn_request_condition_count
authn_request_condition_audience_list
authn_request_condition_condition_type
authn_request_condition_proxy_restriction_count
authn_request_scoping_idp_count
authn_request_scoping_idp_loc
authn_request_scoping_idp_name
authn_request_scoping_idp_provider_id
authz_decision_query_actions
authz_decision_query_resource
binding
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
chain_validation_details
chain_validation_result
consent
decryption_certificate_bytes
decryption_certificate_handle
destination
fips_mode
id
ignore_chain_validation_errors
input_type
input_type_string
in_response_to
issue_instant
issuer
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
logout_request_name_id
logout_request_not_on_or_after
logout_request_reason
logout_request_session_indexes
manage_name_id_request_name_id
manage_name_id_request_new_encrypted_id
manage_name_id_request_new_id
manage_name_id_request_terminate
name_id_mapping_request_name_id
name_id_mapping_request_name_id_policy_allow_create
name_id_mapping_request_name_id_policy_format
name_id_mapping_request_name_id_policy_sp_name_qualifier
name_id_mapping_request_name_id_policy_use_allow_create
offline_mode
pinned_assertion_attr_count
pinned_assertion_attr_friendly_name
pinned_assertion_attr_name
pinned_assertion_attr_name_format
pinned_assertion_attr_statement_index
pinned_assertion_attr_values
pinned_assertion_condition_count
pinned_assertion_condition_audience_list
pinned_assertion_condition_condition_type
pinned_assertion_condition_proxy_restriction_count
pinned_assertion_info_advice_assertion_count
pinned_assertion_info_assertion_type
pinned_assertion_info_chain_validation_details
pinned_assertion_info_chain_validation_result
pinned_assertion_info_conditions_not_before
pinned_assertion_info_conditions_not_on_or_after
pinned_assertion_info_encrypted_content
pinned_assertion_info_id
pinned_assertion_info_id_ref
pinned_assertion_info_issue_instant
pinned_assertion_info_signature_validation_result
pinned_assertion_info_signed
pinned_assertion_info_uri_ref
pinned_assertion_info_validation_log
pinned_assertion_info_version
pinned_assertion_issuer
pinned_assertion_statement_count
pinned_assertion_statement_attributes
pinned_assertion_statement_authn_context_authenticating_authorities
pinned_assertion_statement_authn_context_choice
pinned_assertion_statement_authn_context_class_ref
pinned_assertion_statement_authn_context_decl
pinned_assertion_statement_authn_context_decl_ref
pinned_assertion_statement_authn_instant
pinned_assertion_statement_authn_session_index
pinned_assertion_statement_authn_session_not_on_or_after
pinned_assertion_statement_authn_subject_locality_address
pinned_assertion_statement_authn_subject_locality_dns_name
pinned_assertion_statement_authz_actions
pinned_assertion_statement_authz_decision
pinned_assertion_statement_authz_decision_evidence
pinned_assertion_statement_authz_decision_resource
pinned_assertion_statement_statement_type
pinned_assertion_subject_confirmation_count
pinned_assertion_subject_confirmation_data_address
pinned_assertion_subject_confirmation_data_in_response_to
pinned_assertion_subject_confirmation_data_not_before
pinned_assertion_subject_confirmation_data_not_on_or_after
pinned_assertion_subject_confirmation_data_recipient
pinned_assertion_subject_confirmation_data_type
pinned_assertion_subject_confirmation_id
pinned_assertion_subject_confirmation_method
pinned_assertion_subject_id
post_binding_body
post_binding_form_template
post_binding_mode
post_binding_relay_state
post_binding_url
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
redirect_binding_encoding
redirect_binding_force_sign
redirect_binding_relay_state
redirect_binding_sign
redirect_binding_signature_algorithm
redirect_binding_url
redirect_binding_verify_signatures
redirect_binding_cert_bytes
redirect_binding_cert_handle
response_name_id
response_optional_element
response_response_type
response_status_code_sub_value
response_status_code_value
response_status_detail
response_status_message
signature_validation_result
signed
signing_cert_bytes
signing_cert_ca
signing_cert_ca_key_id
signing_cert_crl_distribution_points
signing_cert_curve
signing_cert_fingerprint
signing_cert_friendly_name
signing_cert_handle
signing_cert_hash_algorithm
signing_cert_issuer
signing_cert_issuer_rdn
signing_cert_key_algorithm
signing_cert_key_bits
signing_cert_key_fingerprint
signing_cert_key_usage
signing_cert_key_valid
signing_cert_ocsp_locations
signing_cert_policy_i_ds
signing_cert_public_key_bytes
signing_cert_self_signed
signing_cert_serial_number
signing_cert_sig_algorithm
signing_cert_subject
signing_cert_subject_key_id
signing_cert_subject_rdn
signing_cert_valid_from
signing_cert_valid_to
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
subject_confirmation_count
subject_confirmation_data_address
subject_confirmation_data_in_response_to
subject_confirmation_data_not_before
subject_confirmation_data_not_on_or_after
subject_confirmation_data_recipient
subject_confirmation_data_type
subject_confirmation_id
subject_confirmation_method
subject_id
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
use_binding
validate_signatures
validation_log
validation_moment
version
Methods
compare_i_ds
config
do_action
get_id_prop
open
open_bytes
open_file
pin_advice_assertion
pin_assertion
Events
on_error
on_notification
on_signature_found
on_signature_validated
Config Settings
Error Codes
SAMLSPServer Class
Introduction
Properties
active
artifact_resolution_service
assertion_consumer_service
assertion_consumer_service_bindings
base_dir
client_auth
encryption_cert_bytes
encryption_cert_handle
error_origin
error_severity
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
host
issuer
logout_page
metadata_url
meta_signing_cert_bytes
meta_signing_cert_handle
offline_mode
port
preferred_idp_to_sp_binding
protected_resources
redirect_on_logout_page
server_cert_count
server_cert_bytes
server_cert_handle
sig_canonicalization_method
sig_digest_method
sig_method
sign_artifact_resolve_requests
sign_authn_requests
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
sign_logout_requests
sign_metadata
single_logout_service
single_logout_service_bindings
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
sp_to_idp_binding
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
url
Methods
config
do_action
get_client_buffer
get_provider_property
load_idp_metadata
process_generic_request
save_metadata
set_client_buffer
set_provider_property
start
stop
Events
on_accept
on_assertion_created
on_assertion_received
on_connect
on_disconnect
on_error
on_external_sign
on_metadata_request
on_notification
on_resource_close
on_resource_open
on_resource_read
on_resource_request
on_session_closed
on_session_established
on_session_stage_changed
Config Settings
Error Codes
SAMLWriter Class
Introduction
Properties
add_xml_header
artifact_endpoint_index
artifact_message_handle
artifact_remaining_artifact
artifact_source_id
artifact_type_code
artifact_uri
artifact_resolve_query
assertion_attr_count
assertion_attr_friendly_name
assertion_attr_name
assertion_attr_name_format
assertion_attr_statement_index
assertion_attr_values
assertion_condition_count
assertion_condition_audience_list
assertion_condition_condition_type
assertion_condition_proxy_restriction_count
assertion_count
assertion_id_request_references
assertion_info_advice_assertion_count
assertion_info_assertion_type
assertion_info_chain_validation_details
assertion_info_chain_validation_result
assertion_info_conditions_not_before
assertion_info_conditions_not_on_or_after
assertion_info_encrypted_content
assertion_info_id
assertion_info_id_ref
assertion_info_issue_instant
assertion_info_signature_validation_result
assertion_info_signed
assertion_info_uri_ref
assertion_info_validation_log
assertion_info_version
assertion_issuer
assertion_statement_count
assertion_statement_attributes
assertion_statement_authn_context_authenticating_authorities
assertion_statement_authn_context_choice
assertion_statement_authn_context_class_ref
assertion_statement_authn_context_decl
assertion_statement_authn_context_decl_ref
assertion_statement_authn_instant
assertion_statement_authn_session_index
assertion_statement_authn_session_not_on_or_after
assertion_statement_authn_subject_locality_address
assertion_statement_authn_subject_locality_dns_name
assertion_statement_authz_actions
assertion_statement_authz_decision
assertion_statement_authz_decision_evidence
assertion_statement_authz_decision_resource
assertion_statement_statement_type
assertion_subject_confirmation_count
assertion_subject_confirmation_data_address
assertion_subject_confirmation_data_in_response_to
assertion_subject_confirmation_data_not_before
assertion_subject_confirmation_data_not_on_or_after
assertion_subject_confirmation_data_recipient
assertion_subject_confirmation_data_type
assertion_subject_confirmation_id
assertion_subject_confirmation_method
assertion_subject_id
attr_query_attr_count
attr_query_attr_friendly_name
attr_query_attr_name
attr_query_attr_name_format
attr_query_attr_statement_index
attr_query_attr_values
authn_query_comparison
authn_query_context_class_refs
authn_query_ref_type
authn_query_session_index
authn_request_assertion_consumer_service_index
authn_request_assertion_consumer_service_url
authn_request_attribute_consuming_service_index
authn_request_conditions_not_before
authn_request_conditions_not_on_or_after
authn_request_context_class_refs
authn_request_context_comparison
authn_request_context_ref_type
authn_request_force_authn
authn_request_is_passive
authn_request_name_id_policy_allow_create
authn_request_name_id_policy_format
authn_request_name_id_policy_sp_name_qualifier
authn_request_name_id_policy_use_allow_create
authn_request_protocol_binding
authn_request_provider_name
authn_request_scoping_idp_list_get_complete
authn_request_scoping_proxy_count
authn_request_scoping_requester_i_ds
authn_request_use_force_authn
authn_request_use_is_passive
authn_request_condition_count
authn_request_condition_audience_list
authn_request_condition_condition_type
authn_request_condition_proxy_restriction_count
authn_request_scoping_idp_count
authn_request_scoping_idp_loc
authn_request_scoping_idp_name
authn_request_scoping_idp_provider_id
authz_decision_query_actions
authz_decision_query_resource
binding
consent
destination
encryption_cert_bytes
encryption_cert_handle
fips_mode
id
in_response_to
issue_instant
issuer
logout_request_name_id
logout_request_not_on_or_after
logout_request_reason
logout_request_session_indexes
manage_name_id_request_name_id
manage_name_id_request_new_encrypted_id
manage_name_id_request_new_id
manage_name_id_request_terminate
name_id_mapping_request_name_id
name_id_mapping_request_name_id_policy_allow_create
name_id_mapping_request_name_id_policy_format
name_id_mapping_request_name_id_policy_sp_name_qualifier
name_id_mapping_request_name_id_policy_use_allow_create
output_type
post_binding_body
post_binding_form_template
post_binding_mode
post_binding_relay_state
post_binding_url
profile
redirect_binding_encoding
redirect_binding_force_sign
redirect_binding_relay_state
redirect_binding_sign
redirect_binding_signature_algorithm
redirect_binding_url
redirect_binding_verify_signatures
redirect_binding_cert_bytes
redirect_binding_cert_handle
response_name_id
response_optional_element
response_response_type
response_status_code_sub_value
response_status_code_value
response_status_detail
response_status_message
sig_canonicalization_method
sig_digest_method
sig_method
sign
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
subject_confirmation_count
subject_confirmation_data_address
subject_confirmation_data_in_response_to
subject_confirmation_data_not_before
subject_confirmation_data_not_on_or_after
subject_confirmation_data_recipient
subject_confirmation_data_type
subject_confirmation_id
subject_confirmation_method
subject_id
version
Methods
add_advice_assertion
add_assertion
clear_assertion
compare_i_ds
config
create_new
do_action
get_id_prop
remove_advice
remove_advice_assertion
remove_all_assertions
remove_assertion
save
save_bytes
save_file
Events
on_error
on_notification
Config Settings
Error Codes
SFTPClient Class
Introduction
Properties
auth_attempts
auto_adjust_transfer_block
connected
conn_info_client_key_algorithm
conn_info_client_key_bits
conn_info_client_key_fingerprint
conn_info_close_reason
conn_info_compression_algorithm_inbound
conn_info_compression_algorithm_outbound
conn_info_encryption_algorithm_inbound
conn_info_encryption_algorithm_outbound
conn_info_inbound_encryption_key_bits
conn_info_kex_algorithm
conn_info_kex_bits
conn_info_kex_lines
conn_info_mac_algorithm_inbound
conn_info_mac_algorithm_outbound
conn_info_outbound_encryption_key_bits
conn_info_public_key_algorithm
conn_info_server_key_bits
conn_info_server_key_fingerprint
conn_info_server_software_name
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_version
curr_list_entry_a_time
curr_list_entry_c_time
curr_list_entry_directory
curr_list_entry_file_type
curr_list_entry_group_execute
curr_list_entry_group_read
curr_list_entry_group_write
curr_list_entry_handle
curr_list_entry_long_name
curr_list_entry_m_time
curr_list_entry_name
curr_list_entry_other_execute
curr_list_entry_other_read
curr_list_entry_other_write
curr_list_entry_owner
curr_list_entry_path
curr_list_entry_size
curr_list_entry_user_execute
curr_list_entry_user_read
curr_list_entry_user_write
download_block_size
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
force_compression
key_fingerprint_sha1
key_fingerprint_sha256
key_handle
max_sftp_version
min_sftp_version
password
pipeline_length
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
server_key_algorithm
server_key_bits
server_key_comment
server_key_curve
server_key_dssg
server_key_dssp
server_key_dssq
server_key_dssx
server_key_dssy
server_key_eccd
server_key_eccqx
server_key_eccqy
server_key_ed_private
server_key_ed_public
server_key_fingerprint_md5
server_key_fingerprint_sha1
server_key_fingerprint_sha256
server_key_handle
server_key_is_extractable
server_key_is_private
server_key_is_public
server_key_kdf_rounds
server_key_kdf_salt
server_key_key_format
server_key_key_protection_algorithm
server_key_rsa_exponent
server_key_rsaiqmp
server_key_rsa_modulus
server_key_rsap
server_key_rsa_private_exponent
server_key_rsaq
server_key_subject
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
ssh_settings_auto_adjust_ciphers
ssh_settings_base_configuration
ssh_settings_compression_algorithms
ssh_settings_compression_level
ssh_settings_default_window_size
ssh_settings_encryption_algorithms
ssh_settings_force_compression
ssh_settings_gss_auth_types
ssh_settings_gss_delegate_creds
ssh_settings_gss_hostname
ssh_settings_gss_lib
ssh_settings_gss_mechanisms
ssh_settings_gss_protocols
ssh_settings_handshake_timeout
ssh_settings_kex_algorithms
ssh_settings_mac_algorithms
ssh_settings_max_ssh_packet_size
ssh_settings_min_window_size
ssh_settings_obfuscate_handshake
ssh_settings_obfuscation_password
ssh_settings_public_key_algorithms
ssh_settings_request_password_change
ssh_settings_software_name
ssh_settings_trust_all_keys
ssh_settings_use_auth_agent
ssh_settings_versions
trusted_keys_file
upload_block_size
username
use_utf8
version
Methods
absolute_path
change_dir
config
connect
create_link
delete_dir
delete_file
delete_files
dir_exists
disconnect
do_action
download_bytes
download_file
download_files
execute_ssh_command
extension_cmd
file_exists
get_current_dir
get_file_size
list_dir
make_dir
rename_file
request_attributes
set_attributes
upload_bytes
upload_file
upload_files
Events
on_auth_attempt
on_auth_failed
on_auth_succeeded
on_banner
on_disconnect
on_error
on_external_sign
on_file_operation
on_file_operation_result
on_known_key_received
on_list_entry
on_notification
on_password_change_request
on_private_key_needed
on_progress
on_unknown_key_received
Config Settings
Error Codes
SFTPServer Class
Introduction
Properties
active
auth_types
base_dir
client_file_entry_a_time
client_file_entry_c_time
client_file_entry_directory
client_file_entry_file_type
client_file_entry_group_execute
client_file_entry_group_read
client_file_entry_group_write
client_file_entry_handle
client_file_entry_long_name
client_file_entry_m_time
client_file_entry_name
client_file_entry_other_execute
client_file_entry_other_read
client_file_entry_other_write
client_file_entry_owner
client_file_entry_path
client_file_entry_size
client_file_entry_user_execute
client_file_entry_user_read
client_file_entry_user_write
compression_level
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
force_compression
host
key_fingerprint_sha1
key_fingerprint_sha256
key_handle
max_sftp_version
min_sftp_version
pinned_client_address
pinned_client_client_key_algorithm
pinned_client_client_key_bits
pinned_client_client_key_fingerprint
pinned_client_client_software_name
pinned_client_close_reason
pinned_client_compression_algorithm_inbound
pinned_client_compression_algorithm_outbound
pinned_client_encryption_algorithm_inbound
pinned_client_encryption_algorithm_outbound
pinned_client_id
pinned_client_inbound_encryption_key_bits
pinned_client_kex_algorithm
pinned_client_kex_bits
pinned_client_kex_lines
pinned_client_mac_algorithm_inbound
pinned_client_mac_algorithm_outbound
pinned_client_outbound_encryption_key_bits
pinned_client_port
pinned_client_public_key_algorithm
pinned_client_server_key_bits
pinned_client_server_key_fingerprint
pinned_client_total_bytes_received
pinned_client_total_bytes_sent
pinned_client_version
port
read_only
server_key_count
server_key_algorithm
server_key_bits
server_key_fingerprint_md5
server_key_fingerprint_sha1
server_key_handle
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
ssh_settings_auto_adjust_ciphers
ssh_settings_base_configuration
ssh_settings_compression_algorithms
ssh_settings_compression_level
ssh_settings_default_window_size
ssh_settings_encryption_algorithms
ssh_settings_force_compression
ssh_settings_gss_auth_types
ssh_settings_gss_delegate_creds
ssh_settings_gss_hostname
ssh_settings_gss_lib
ssh_settings_gss_mechanisms
ssh_settings_gss_protocols
ssh_settings_handshake_timeout
ssh_settings_kex_algorithms
ssh_settings_mac_algorithms
ssh_settings_max_ssh_packet_size
ssh_settings_min_window_size
ssh_settings_obfuscate_handshake
ssh_settings_obfuscation_password
ssh_settings_public_key_algorithms
ssh_settings_request_password_change
ssh_settings_software_name
ssh_settings_trust_all_keys
ssh_settings_use_auth_agent
ssh_settings_versions
user_count
user_associated_data
user_base_path
user_cert
user_data
user_handle
user_hash_algorithm
user_incoming_speed_limit
user_otp_algorithm
user_otp_value
user_outgoing_speed_limit
user_password
user_password_len
user_shared_secret
user_ssh_key
user_username
use_utf8
Methods
config
do_action
drop_client
get_client_buffer
get_client_file_entry
list_clients
pin_client
set_client_buffer
set_client_file_entry
start
stop
Events
on_accept
on_after_create_directory
on_after_remove
on_after_rename_file
on_after_request_attributes
on_after_set_attributes
on_auth_attempt
on_auth_failed
on_auth_password
on_auth_public_key
on_auth_succeeded
on_before_create_directory
on_before_download_file
on_before_find
on_before_remove
on_before_rename_file
on_before_request_attributes
on_before_set_attributes
on_before_upload_file
on_close_file
on_connect
on_create_directory
on_disconnect
on_error
on_external_sign
on_find_close
on_find_first
on_find_next
on_notification
on_open_file
on_read_file
on_remove
on_rename_file
on_request_attributes
on_session_closed
on_session_established
on_set_attributes
on_translate_path
on_write_file
Config Settings
Error Codes
SMTPClient Class
Introduction
Properties
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
domain
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
msg_attachment_count
msg_bcc
msg_cc
msg_comments
msg_date
msg_delivery_receipt
msg_from
msg_handle
msg_html_text
msg_id
msg_in_reply_to
msg_keywords
msg_mailer
msg_plain_text
msg_priority
msg_read_receipt
msg_references
msg_reply_to
msg_return_path
msg_sender
msg_send_to
msg_subject
password
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
server_info_auth_login_supported
server_info_auth_plain_supported
server_info_available
server_info_binary_supported
server_info_chunking_supported
server_info_dsn_supported
server_info_max_message_size
server_info_sasl_supported
server_info_size_supported
server_info_status_codes_supported
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
username
Methods
config
connect
disconnect
do_action
send_bytes
send_file
send_message
Events
on_before_auth
on_command
on_command_data
on_command_reply
on_error
on_external_sign
on_notification
on_progress
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
SOAPClient Class
Introduction
Properties
attachment_bytes
attachment_file
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
client_cert_count
client_cert_bytes
client_cert_handle
conn_info_aead_cipher
conn_info_chain_validation_details
conn_info_chain_validation_result
conn_info_ciphersuite
conn_info_client_authenticated
conn_info_client_auth_requested
conn_info_connection_established
conn_info_connection_id
conn_info_digest_algorithm
conn_info_encryption_algorithm
conn_info_exportable
conn_info_key_exchange_algorithm
conn_info_key_exchange_key_bits
conn_info_named_ec_curve
conn_info_pfs_cipher
conn_info_pre_shared_identity_hint
conn_info_public_key_bits
conn_info_resumed_session
conn_info_secure_connection
conn_info_server_authenticated
conn_info_signature_algorithm
conn_info_symmetric_block_size
conn_info_symmetric_key_bits
conn_info_total_bytes_received
conn_info_total_bytes_sent
conn_info_validation_log
conn_info_version
encoding
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fault_actor
fault_code
fault_detail
fault_string
fips_mode
input_bytes
input_file
keep_alive_policy
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
mime_type
operation_name
operation_namespace_uri
operation_response_name
operation_response_namespace_uri
operation_response_text_content
operation_response_xml
output_attachment_bytes
output_attachment_file
output_bytes
output_file
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
reason_phrase
req_header_count
req_header_category
req_header_format
req_header_name
req_header_value
req_params_accept
req_params_accept_charset
req_params_accept_language
req_params_accept_range_end
req_params_accept_range_start
req_params_authorization
req_params_connection
req_params_content_length
req_params_content_range_end
req_params_content_range_full_size
req_params_content_range_start
req_params_content_type
req_params_cookie
req_params_custom_headers
req_params_date
req_params_from
req_params_host
req_params_http_version
req_params_if_match
req_params_if_modified_since
req_params_if_none_match
req_params_if_unmodified_since
req_params_password
req_params_referer
req_params_user_agent
req_params_username
resp_header_count
resp_header_category
resp_header_format
resp_header_name
resp_header_value
resp_params_content_length
resp_params_date
resp_params_reason_phrase
resp_params_status_code
server_cert_count
server_cert_bytes
server_cert_ca_key_id
server_cert_fingerprint
server_cert_handle
server_cert_issuer
server_cert_issuer_rdn
server_cert_key_algorithm
server_cert_key_bits
server_cert_key_fingerprint
server_cert_key_usage
server_cert_public_key_bytes
server_cert_self_signed
server_cert_serial_number
server_cert_sig_algorithm
server_cert_subject
server_cert_subject_key_id
server_cert_subject_rdn
server_cert_valid_from
server_cert_valid_to
soap_action
soap_response_type
soap_version
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
status_code
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
use_digest_auth
use_kerberos_auth
use_ntlm_auth
Methods
config
do_action
send_message
send_message_with_attachments
Events
on_before_receive_attachment
on_before_send_attachment
on_cookie
on_document_begin
on_document_end
on_error
on_external_sign
on_headers_prepared
on_headers_received
on_notification
on_progress
on_redirection
on_tls_cert_needed
on_tls_cert_validate
on_tls_established
on_tls_handshake
on_tls_psk
on_tls_shutdown
Config Settings
Error Codes
SOAPQuickSigner Class
Introduction
Properties
canonicalization_method
embed_certificate_method
encoding
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
hash_algorithm
input_file
output_file
reference_count
reference_auto_generate_element_id
reference_canonicalization_method
reference_custom_element_id
reference_digest_value
reference_handle
reference_hash_algorithm
reference_has_uri
reference_id
reference_inclusive_namespaces_prefix_list
reference_reference_type
reference_signature_index
reference_target_data
reference_target_type
reference_target_xml_element
reference_uri
reference_use_base64_transform
reference_use_enveloped_signature_transform
reference_use_xpath_filter2_transform
reference_use_xpath_transform
reference_xpath_expression
reference_xpath_filter2_expressions
reference_xpath_filter2_filters
reference_xpath_filter2_prefix_list
reference_xpath_prefix_list
security_header_index
signature_type
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
namespace_count
namespace_prefix
namespace_uri
Methods
add_body_reference
add_data_reference
add_reference
config
do_action
extract_async_data
get_inner_xml
get_outer_xml
get_text_content
set_inner_xml
set_text_content
sign
sign_async_begin
sign_async_end
sign_external
Events
on_error
on_external_sign
on_format_element
on_format_text
on_notification
on_resolve_reference
Config Settings
Error Codes
SOAPSigner Class
Introduction
Properties
auto_validate_signatures
blocked_cert_count
blocked_cert_bytes
blocked_cert_handle
cert_count
cert_bytes
cert_ca
cert_ca_key_id
cert_crl_distribution_points
cert_curve
cert_fingerprint
cert_friendly_name
cert_handle
cert_hash_algorithm
cert_issuer
cert_issuer_rdn
cert_key_algorithm
cert_key_bits
cert_key_fingerprint
cert_key_usage
cert_key_valid
cert_ocsp_locations
cert_policy_i_ds
cert_public_key_bytes
cert_self_signed
cert_serial_number
cert_sig_algorithm
cert_subject
cert_subject_key_id
cert_subject_rdn
cert_valid_from
cert_valid_to
crl_count
crl_bytes
crl_handle
crl_issuer
crl_issuer_rdn
crl_location
crl_next_update
crl_this_update
embed_certificate_method
encoding
external_crypto_async_document_id
external_crypto_custom_params
external_crypto_data
external_crypto_external_hash_calculation
external_crypto_hash_algorithm
external_crypto_key_id
external_crypto_key_secret
external_crypto_method
external_crypto_mode
external_crypto_public_key_algorithm
fips_mode
ignore_chain_validation_errors
input_bytes
input_file
known_cert_count
known_cert_bytes
known_cert_handle
known_crl_count
known_crl_bytes
known_crl_handle
known_ocsp_count
known_ocsp_bytes
known_ocsp_handle
new_sig_canonicalization_method
new_sig_certificate_index
new_sig_chain_validation_details
new_sig_chain_validation_result
new_sig_claimed_signing_time
new_sig_handle
new_sig_hash_algorithm
new_sig_issuer_rdn
new_sig_last_archival_time
new_sig_policy_hash
new_sig_policy_hash_algorithm
new_sig_policy_id
new_sig_policy_uri
new_sig_serial_number
new_sig_signature_bytes
new_sig_signature_type
new_sig_signature_validation_result
new_sig_subject_key_id
new_sig_subject_rdn
new_sig_timestamped
new_sig_validated_signing_time
new_sig_validation_log
new_sig_xades
new_sig_xades_form
new_sig_xades_version
new_sig_xml_element
ocsp_count
ocsp_bytes
ocsp_handle
ocsp_issuer
ocsp_issuer_rdn
ocsp_location
ocsp_produced_at
offline_mode
output_bytes
output_file
profile
proxy_address
proxy_authentication
proxy_password
proxy_port
proxy_proxy_type
proxy_request_headers
proxy_response_body
proxy_response_headers
proxy_use_ipv6
proxy_use_proxy
proxy_username
reference_count
reference_auto_generate_element_id
reference_canonicalization_method
reference_custom_element_id
reference_digest_value
reference_handle
reference_hash_algorithm
reference_has_uri
reference_id
reference_inclusive_namespaces_prefix_list
reference_reference_type
reference_signature_index
reference_target_data
reference_target_type
reference_target_xml_element
reference_uri
reference_use_base64_transform
reference_use_enveloped_signature_transform
reference_use_xpath_filter2_transform
reference_use_xpath_transform
reference_xpath_expression
reference_xpath_filter2_expressions
reference_xpath_filter2_filters
reference_xpath_filter2_prefix_list
reference_xpath_prefix_list
revocation_check
security_header_index
signature_count
signature_canonicalization_method
signature_certificate_index
signature_chain_validation_details
signature_chain_validation_result
signature_claimed_signing_time
signature_handle
signature_hash_algorithm
signature_issuer_rdn
signature_last_archival_time
signature_policy_hash
signature_policy_hash_algorithm
signature_policy_id
signature_policy_uri
signature_serial_number
signature_signature_bytes
signature_signature_type
signature_signature_validation_result
signature_subject_key_id
signature_subject_rdn
signature_timestamped
signature_validated_signing_time
signature_validation_log
signature_xades
signature_xades_form
signature_xades_version
signature_xml_element
signing_cert_bytes
signing_cert_handle
signing_chain_count
signing_chain_bytes
signing_chain_handle
socket_dns_mode
socket_dns_port
socket_dns_query_timeout
socket_dns_servers
socket_dns_total_timeout
socket_incoming_speed_limit
socket_local_address
socket_local_port
socket_outgoing_speed_limit
socket_timeout
socket_use_ipv6
timestamp_count
timestamp_accuracy
timestamp_bytes
timestamp_certificate_index
timestamp_chain_validation_details
timestamp_chain_validation_result
timestamp_hash_algorithm
timestamp_serial_number
timestamp_signature_index
timestamp_time
timestamp_timestamp_type
timestamp_tsa_name
timestamp_validation_log
timestamp_validation_result
timestamp_server
tls_client_cert_count
tls_client_cert_bytes
tls_client_cert_handle
tls_server_cert_count
tls_server_cert_bytes
tls_server_cert_handle
tls_auto_validate_certificates
tls_base_configuration
tls_ciphersuites
tls_ec_curves
tls_extensions
tls_force_resume_if_destination_changes
tls_pre_shared_identity
tls_pre_shared_key
tls_pre_shared_key_ciphersuite
tls_renegotiation_attack_prevention_mode
tls_revocation_check
tls_ssl_options
tls_tls_mode
tls_use_extended_master_secret
tls_use_session_resumption
tls_versions
trusted_cert_count
trusted_cert_bytes
trusted_cert_handle
validation_moment
namespace_count
namespace_prefix
namespace_uri
Methods
add_body_reference
add_data_reference
add_reference
add_timestamp_validation_data
add_validation_data_refs
add_validation_data_values
close
config
do_action
extract_async_data
get_inner_xml
get_outer_xml
get_text_content
open
revalidate
set_inner_xml
set_text_content
sign
sign_async_begin
sign_async_end
sign_external
timestamp
upgrade
Events
on_chain_element_download
on_chain_element_needed
on_chain_element_store
on_chain_validated
on_chain_validation_progress
on_error
on_external_sign
on_format_element
on_format_text
on_message_loaded
on_notification
on_reference_validated
on_resolve_reference
on_signature_found
on_signature_validated
on_timestamp_found
on_timestamp_request
on_timestamp_validated
on_tls_cert_needed
on_tls_cert_validate
