Module ssl

You must call ssl.clear_session_cache() after you use one of the SSL
Export Policy Functions to change cipher suite policy settings or use
ssl.set_default_cipher_pref() to enable or disable any cipher
suite. Otherwise, the old settings remain in the session cache and
will be used instead of the new settings. This function clears only
the client cache. The client cache is not configurable. It is located
in RAM (not on disk).

:Parameters:
    max_cache_entries : integer
        The maximum number of entries in the cache. If ZERO the server
        default value is used (10,000).
    
    ssl2_timeout : integer
        The lifetime in seconds of an SSL2 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (100 seconds).
    
    ssl3_timeout : integer
        The lifetime in seconds of an SSL3 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (24 hours).
    
    directory : string
        A string specifying the pathname of the directory that will
        contain the session cache. If None the server default value is
        used (/tmp (Unix) or \temp (NT)).

This function sets up a Server Session ID (SID) cache that is safe for
access by multiple processes on the same system.

Like `ssl.config_server_session_id_cache()`, with one important
difference.  If the application will run multiple processes (as
opposed to, or in addition to multiple threads), then it must call
this function, instead of calling
`ssl.config_server_session_id_cache()`.  This has nothing to do with
the number of processors, only processes.

:Parameters:
    max_cache_entries : integer
        The maximum number of entries in the cache. If ZERO the server
        default value is used (10,000).
    
    ssl2_timeout : integer
        The lifetime in seconds of an SSL2 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (100 seconds).
    
    ssl3_timeout : integer
        The lifetime in seconds of an SSL3 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (24 hours).
    
    directory : string
        A string specifying the pathname of the directory that will
        contain the session cache. If None the server default value is
        used (/tmp (Unix) or \temp (NT)).

If you are writing an application which will use SSL sockets to
handshake as a server, you must call config_server_session_id_cache()
to configure the session caches for server sessions.

If your server application uses multiple processes (instead of or in
addition to multiple threads), use `ssl.config_mp_server_sid_cache()`
instead.  You must use one of these functions to create a server
cache.

This function creates two caches: the server session ID cache (also
called the server session cache, or server cache), and the client-auth
certificate cache (also called the client cert cache, or client auth
cache). Both caches are used only for sessions where the program will
handshakes as a server. The client-auth certificate cache is used to
remember the certificates previously presented by clients for client
certificate authentication.

A zero value or a value that is out of range for any of the parameters
causes the server default value to be used in the server cache. Note,
this function only affects the server cache, not the client cache.

:Parameters:
    max_cache_entries : integer
        The maximum number of entries in the cache. If ZERO the server
        default value is used (10,000).
    
    max_cert_cache_entries : integer
        The maximum number of entries in the cert cache. If ZERO the server
        default value is used (10,000).
    
    max_server_name_cache_entries : integer
        The maximum number of entries in the server name cache. If ZERO the server
        default value is used (10,000).
    
    ssl2_timeout : integer
        The lifetime in seconds of an SSL2 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (100 seconds).
    
    ssl3_timeout : integer
        The lifetime in seconds of an SSL3 session. The minimum timeout
        value is 5 seconds and the maximum is 24 hours. Values outside
        this range are replaced by the server default value (24 hours).
    
    directory : string
        A string specifying the pathname of the directory that will
        contain the session cache. If None the server default value is
        used (/tmp (Unix) or \temp (NT)).
    
    enable_mp_cache : bool
        If True enable the multi-process cache.

Configure a secure server's session-id cache. Depends on value of
enable_mp_cache, configures multi-proc or single proc cache.

A zero value or a value that is out of range for any of the parameters
causes the server default value to be used in the server cache. Note,
this function only affects the server cache, not the client cache.

:Parameters:
    cipher : integer
        The cipher suite enumeration (e.g. SSL_RSA_WITH_NULL_MD5, etc.)

Returns the cipher policy.

Returns:

policy

:Parameters:
    cipher : integer
        The cipher suite enumeration (e.g. SSL_RSA_WITH_NULL_MD5, etc.)

Returns the application default preference for the specified SSL2,
SSL3, or TLS cipher.

Returns:

enabled

Get the configured maximum number of mutexes used for the server's
store of SSL sessions.  This value is used by the server session ID
cache initialization functions.

Returns:

int

Gets the default value of a specified SSL option for all
subsequently opened sockets as long as the current application program
is running. Refer to the documentation for SSLSocket.set_ssl_option()
for an explanation of the possible values.

WARNING: nss_init() has been moved to the nss module, use nss.nss_init() instead of ssl.nss_init()

:Parameters:
    cert_dir : string
        Pathname of the directory where the certificate, key, and
        security module databases reside.

Sets up configuration files and performs other tasks required to run
Network Security Services.

WARNING: nss_shutdown() has been moved to the nss module, use nss.nss_shutdown() instead of ssl.nss_shutdown()

Closes the key and certificate databases that were opened by nss_init().

Note that if any reference to an NSS object is leaked (for example, if an SSL
client application doesn't call clear_session_cache() first) then nss_shutdown fails
with the error code SEC_ERROR_BUSY.

WARNING: nssinit() has been moved to the nss module, use nss.nss_init() instead of ssl.nssinit()

:Parameters:
    cert_dir : string
        Pathname of the directory where the certificate, key, and
        security module databases reside.

Sets up configuration files and performs other tasks required to run
Network Security Services.

:Parameters:
    cipher : integer
        The cipher suite enumeration (e.g. SSL_RSA_WITH_NULL_MD5, etc.)
    enabled : bool
        Boolean value

Tells the SSL library that the specified cipher suite is allowed by
the application's export license, or is not allowed by the
application's export license, or is allowed to be used only with a
Step-Up certificate. It overrides the factory default policy for that
cipher suite. The default policy for all cipher suites is
SSL_NOT_ALLOWED, meaning that the application's export license does
not approve the use of this cipher suite. A U.S.domestic version of a
product typically sets all cipher suites to SSL_ALLOWED. This setting
is used to separate export and domestic versions of a product, and is
not intended to express user cipher preferences.

:Parameters:
    cipher : integer
        The cipher suite enumeration (e.g. SSL_RSA_WITH_NULL_MD5, etc.)
    enabled : bool
        Boolean value

Sets the application default preference for the specified SSL2, SSL3,
or TLS cipher. A cipher suite is used only if the policy allows it and
the preference for it is set to True.

This function must be called once for each cipher you want to enable
or disable by default.

Note, which cipher suites are permitted or disallowed are modified by
previous calls to one or more of the SSL Export Policy Functions.

Configures cipher suites to conform with current U.S. export
regulations related to domestic software products with encryption
features.

Configures the SSL cipher suites to conform with current U.S. export
regulations related to international software products with encryption
features.

:Parameters:
    max_locks : int
        Maximum number of locks

Set the configured maximum number of mutexes used for the server's
store of SSL sessions.  This value is used by the server session ID
cache initialization functions.  Note that on some platforms, these
mutexes are actually implemented with POSIX semaphores, or with
unnamed pipes.  The default value varies by platform.  An attempt to
set a too-low maximum will return an error and the configured value
will not be changed.

Changes the default value of a specified SSL option for all
subsequently opened sockets as long as the current application program
is running. Refer to the documentation for SSLSocket.set_ssl_option()
for an explanation of the possible values.

ssl_implemented_ciphers

Value:

(49162, 49172, 136, 135, 57, 56, 49167, 49157, ...