X509 objects¶

X509 objects have the following methods:

X509.get_issuer()¶

Return an X509Name object representing the issuer of the certificate.

X509.get_pubkey()¶

Return a PKey object representing the public key of the certificate.

X509.get_serial_number()¶

Return the certificate serial number.

X509.get_signature_algorithm()¶

Return the signature algorithm used in the certificate. If the algorithm is undefined, raise ValueError.

..versionadded:: 0.13

X509.get_subject()¶

Return an X509Name object representing the subject of the certificate.

X509.get_version()¶

Return the certificate version.

X509.get_notBefore()¶

Return a string giving the time before which the certificate is not valid. The string is formatted as an ASN1 GENERALIZEDTIME:

YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm

If no value exists for this field, None is returned.

X509.get_notAfter()¶

Return a string giving the time after which the certificate is not valid. The string is formatted as an ASN1 GENERALIZEDTIME:

YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm

If no value exists for this field, None is returned.

X509.set_notBefore(when)¶

Change the time before which the certificate is not valid. when is a string formatted as an ASN1 GENERALIZEDTIME:

YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm

X509.set_notAfter(when)¶

Change the time after which the certificate is not valid. when is a string formatted as an ASN1 GENERALIZEDTIME:

YYYYMMDDhhmmssZ
YYYYMMDDhhmmss+hhmm
YYYYMMDDhhmmss-hhmm

X509.gmtime_adj_notBefore(time)¶

Adjust the timestamp (in GMT) when the certificate starts being valid.

X509.gmtime_adj_notAfter(time)¶

Adjust the timestamp (in GMT) when the certificate stops being valid.

X509.has_expired()¶

Checks the certificate’s time stamp against current time. Returns true if the certificate has expired and false otherwise.

X509.set_issuer(issuer)¶

Set the issuer of the certificate to issuer.

X509.set_pubkey(pkey)¶

Set the public key of the certificate to pkey.

X509.set_serial_number(serialno)¶

Set the serial number of the certificate to serialno.

X509.set_subject(subject)¶

Set the subject of the certificate to subject.

X509.set_version(version)¶

Set the certificate version to version.

X509.sign(pkey, digest)¶

Sign the certificate, using the key pkey and the message digest algorithm identified by the string digest.

X509.subject_name_hash()¶

Return the hash of the certificate subject.

X509.digest(digest_name)¶

Return a digest of the certificate, using the digest_name method. digest_name must be a string describing a digest algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically). For example, "md5" or "sha1".

X509.add_extensions(extensions)¶

Add the extensions in the sequence extensions to the certificate.

X509.get_extension_count()¶

Return the number of extensions on this certificate.

New in version 0.12.

X509.get_extension(index)¶

Retrieve the extension on this certificate at the given index.

Extensions on a certificate are kept in order. The index parameter selects which extension will be returned. The returned object will be an X509Extension instance.

New in version 0.12.

X509Name objects¶

X509Name objects have the following methods:

X509Name.hash()¶

Return an integer giving the first four bytes of the MD5 digest of the DER representation of the name.

X509Name.der()¶

Return a string giving the DER representation of the name.

X509Name.get_components()¶

Return a list of two-tuples of strings giving the components of the name.

X509Name objects have the following members:

X509Name.countryName¶

The country of the entity. C may be used as an alias for countryName.

X509Name.stateOrProvinceName¶

The state or province of the entity. ST may be used as an alias for stateOrProvinceName.

X509Name.localityName¶

The locality of the entity. L may be used as an alias for localityName.

X509Name.organizationName¶

The organization name of the entity. O may be used as an alias for organizationName.

X509Name.organizationalUnitName¶

The organizational unit of the entity. OU may be used as an alias for organizationalUnitName.

X509Name.commonName¶

The common name of the entity. CN may be used as an alias for commonName.

X509Name.emailAddress¶

The e-mail address of the entity.

X509Req objects¶

X509Req objects have the following methods:

X509Req.get_pubkey()¶

Return a PKey object representing the public key of the certificate request.

X509Req.get_subject()¶

Return an X509Name object representing the subject of the certificate.

X509Req.set_pubkey(pkey)¶

Set the public key of the certificate request to pkey.

X509Req.sign(pkey, digest)¶

Sign the certificate request, using the key pkey and the message digest algorithm identified by the string digest.

X509Req.verify(pkey)¶

Verify a certificate request using the public key pkey.

X509Req.set_version(version)¶

Set the version (RFC 2459, 4.1.2.1) of the certificate request to version.

X509Req.get_version()¶

Get the version (RFC 2459, 4.1.2.1) of the certificate request.

X509Store objects¶

The X509Store object has currently just one method:

X509Store.add_cert(cert)¶

Add the certificate cert to the certificate store.

PKey objects¶

The PKey object has the following methods:

PKey.bits()¶

Return the number of bits of the key.

PKey.generate_key(type, bits)¶

Generate a public/private key pair of the type type (one of TYPE_RSA and TYPE_DSA) with the size bits.

PKey.type()¶

Return the type of the key.

PKey.check()¶

Check the consistency of this key, returning True if it is consistent and raising an exception otherwise. This is only valid for RSA keys. See the OpenSSL RSA_check_key man page for further limitations.

PKCS7 objects¶

PKCS7 objects have the following methods:

PKCS7.type_is_signed()¶

FIXME

PKCS7.type_is_enveloped()¶

FIXME

PKCS7.type_is_signedAndEnveloped()¶

FIXME

PKCS7.type_is_data()¶

FIXME

PKCS7.get_type_name()¶

Get the type name of the PKCS7.

PKCS12 objects¶

PKCS12 objects have the following methods:

PKCS12.export([passphrase=None][, iter=2048][, maciter=1])¶

Returns a PKCS12 object as a string.

The optional passphrase must be a string not a callback.

See also the man page for the C function PKCS12_create().

PKCS12.get_ca_certificates()¶

Return CA certificates within the PKCS12 object as a tuple. Returns None if no CA certificates are present.

PKCS12.get_certificate()¶

Return certificate portion of the PKCS12 structure.

PKCS12.get_friendlyname()¶

Return friendlyName portion of the PKCS12 structure.

PKCS12.get_privatekey()¶

Return private key portion of the PKCS12 structure

PKCS12.set_ca_certificates(cacerts)¶

Replace or set the CA certificates within the PKCS12 object with the sequence cacerts.

Set cacerts to None to remove all CA certificates.

PKCS12.set_certificate(cert)¶

Replace or set the certificate portion of the PKCS12 structure.

PKCS12.set_friendlyname(name)¶

Replace or set the friendlyName portion of the PKCS12 structure.

PKCS12.set_privatekey(pkey)¶

Replace or set private key portion of the PKCS12 structure

X509Extension objects¶

X509Extension objects have several methods:

X509Extension.get_critical()¶

Return the critical field of the extension object.

X509Extension.get_short_name()¶

Retrieve the short descriptive name for this extension.

The result is a byte string like basicConstraints.

New in version 0.12.

X509Extension.get_data()¶

Retrieve the data for this extension.

The result is the ASN.1 encoded form of the extension data as a byte string.

New in version 0.12.

NetscapeSPKI objects¶

NetscapeSPKI objects have the following methods:

NetscapeSPKI.b64_encode()¶

Return a base64-encoded string representation of the object.

NetscapeSPKI.get_pubkey()¶

Return the public key of object.

NetscapeSPKI.set_pubkey(key)¶

Set the public key of the object to key.

NetscapeSPKI.sign(key, digest_name)¶

Sign the NetscapeSPKI object using the given key and digest_name. digest_name must be a string describing a digest algorithm supported by OpenSSL (by EVP_get_digestbyname, specifically). For example, "md5" or "sha1".

NetscapeSPKI.verify(key)¶

Verify the NetscapeSPKI object using the given key.

CRL objects¶

CRL objects have the following methods:

CRL.add_revoked(revoked)¶

Add a Revoked object to the CRL, by value not reference.

CRL.export(cert, key[, type=FILETYPE_PEM][, days=100])¶

Use cert and key to sign the CRL and return the CRL as a string. days is the number of days before the next CRL is due.

CRL.get_revoked()¶

Return a tuple of Revoked objects, by value not reference.

Revoked objects¶

Revoked objects have the following methods:

Revoked.all_reasons()¶

Return a list of all supported reasons.

Revoked.get_reason()¶

Return the revocation reason as a str. Can be None, which differs from “Unspecified”.

Revoked.get_rev_date()¶

Return the revocation date as a str. The string is formatted as an ASN1 GENERALIZEDTIME.

Revoked.get_serial()¶

Return a str containing a hex number of the serial of the revoked certificate.

Revoked.set_reason(reason)¶

Set the revocation reason. reason must be None or a string, but the values are limited. Spaces and case are ignored. See all_reasons().

Revoked.set_rev_date(date)¶

Set the revocation date. The string is formatted as an ASN1 GENERALIZEDTIME.

Revoked.set_serial(serial)¶

serial is a string containing a hex number of the serial of the revoked certificate.

Context objects¶

Context objects have the following methods:

Context.check_privatekey()¶

Check if the private key (loaded with use_privatekey()) matches the certificate (loaded with use_certificate()). Returns None if they match, raises Error otherwise.

Context.get_app_data()¶

Retrieve application data as set by set_app_data().

Context.get_cert_store()¶

Retrieve the certificate store (a X509Store object) that the context uses. This can be used to add “trusted” certificates without using the. load_verify_locations() method.

Context.get_timeout()¶

Retrieve session timeout, as set by set_timeout(). The default is 300 seconds.

Context.get_verify_depth()¶

Retrieve the Context object’s verify depth, as set by set_verify_depth().

Context.get_verify_mode()¶

Retrieve the Context object’s verify mode, as set by set_verify().

Context.load_client_ca(pemfile)¶

Read a file with PEM-formatted certificates that will be sent to the client when requesting a client certificate.

Context.set_client_ca_list(certificate_authorities)¶

Replace the current list of preferred certificate signers that would be sent to the client when requesting a client certificate with the certificate_authorities sequence of OpenSSL.crypto.X509Name‘s.

New in version 0.10.

Context.add_client_ca(certificate_authority)¶

Extract a OpenSSL.crypto.X509Name from the certificate_authority OpenSSL.crypto.X509 certificate and add it to the list of preferred certificate signers sent to the client when requesting a client certificate.

New in version 0.10.

Context.load_verify_locations(pemfile, capath)¶

Specify where CA certificates for verification purposes are located. These are trusted certificates. Note that the certificates have to be in PEM format. If capath is passed, it must be a directory prepared using the c_rehash tool included with OpenSSL. Either, but not both, of pemfile or capath may be None.

Context.set_default_verify_paths()¶

Specify that the platform provided CA certificates are to be used for verification purposes. This method may not work properly on OS X.

Context.load_tmp_dh(dhfile)¶

Load parameters for Ephemeral Diffie-Hellman from dhfile.

Context.set_app_data(data)¶

Associate data with this Context object. data can be retrieved later using the get_app_data() method.

Context.set_cipher_list(ciphers)¶

Set the list of ciphers to be used in this context. See the OpenSSL manual for more information (e.g. ciphers(1))

Context.set_info_callback(callback)¶

Set the information callback to callback. This function will be called from time to time during SSL handshakes.

callback should take three arguments: a Connection object and two integers. The first integer specifies where in the SSL handshake the function was called, and the other the return code from a (possibly failed) internal function call.

Context.set_options(options)¶

Add SSL options. Options you have set before are not cleared! This method should be used with the OP_* constants.

Context.set_mode(mode)¶

Add SSL mode. Modes you have set before are not cleared! This method should be used with the MODE_* constants.

Context.set_passwd_cb(callback[, userdata])¶

Set the passphrase callback to callback. This function will be called when a private key with a passphrase is loaded. callback must accept three positional arguments. First, an integer giving the maximum length of the passphrase it may return. If the returned passphrase is longer than this, it will be truncated. Second, a boolean value which will be true if the user should be prompted for the passphrase twice and the callback should verify that the two values supplied are equal. Third, the value given as the userdata parameter to set_passwd_cb(). If an error occurs, callback should return a false value (e.g. an empty string).

Context.set_session_cache_mode(mode)¶

Set the behavior of the session cache used by all connections using this Context. The previously set mode is returned. See SESS_CACHE_* for details about particular modes.

New in version 0.14.

Context.get_session_cache_mode()¶

Get the current session cache mode.

New in version 0.14.

Context.set_session_id(name)¶

Set the context name within which a session can be reused for this Context object. This is needed when doing session resumption, because there is no way for a stored session to know which Context object it is associated with. name may be any binary data.

Context.set_timeout(timeout)¶

Set the timeout for newly created sessions for this Context object to timeout. timeout must be given in (whole) seconds. The default value is 300 seconds. See the OpenSSL manual for more information (e.g. SSL_CTX_set_timeout(3)).

Context.set_verify(mode, callback)¶

Set the verification flags for this Context object to mode and specify that callback should be used for verification callbacks. mode should be one of VERIFY_NONE and VERIFY_PEER. If VERIFY_PEER is used, mode can be OR:ed with VERIFY_FAIL_IF_NO_PEER_CERT and VERIFY_CLIENT_ONCE to further control the behaviour.

callback should take five arguments: A Connection object, an X509 object, and three integer variables, which are in turn potential error number, error depth and return code. callback should return true if verification passes and false otherwise.

Context.set_verify_depth(depth)¶

Set the maximum depth for the certificate chain verification that shall be allowed for this Context object.

Context.use_certificate(cert)¶

Use the certificate cert which has to be a X509 object.

Context.add_extra_chain_cert(cert)¶

Adds the certificate cert, which has to be a X509 object, to the certificate chain presented together with the certificate.

Context.use_certificate_chain_file(file)¶

Load a certificate chain from file which must be PEM encoded.

Context.use_privatekey(pkey)¶

Use the private key pkey which has to be a PKey object.

Context.use_certificate_file(file[, format])¶

Load the first certificate found in file. The certificate must be in the format specified by format, which is either FILETYPE_PEM or FILETYPE_ASN1. The default is FILETYPE_PEM.

Context.use_privatekey_file(file[, format])¶

Load the first private key found in file. The private key must be in the format specified by format, which is either FILETYPE_PEM or FILETYPE_ASN1. The default is FILETYPE_PEM.

Context.set_tlsext_servername_callback(callback)¶

Specify a one-argument callable to use as the TLS extension server name callback. When a connection using the server name extension is made using this context, the callback will be invoked with the Connection instance.

New in version 0.13.

Session objects¶

Session objects have no methods.

Connection objects¶

Connection objects have the following methods:

Connection.accept()¶

Call the accept() method of the underlying socket and set up SSL on the returned socket, using the Context object supplied to this Connection object at creation. Returns a pair (conn, address). where conn is the new Connection object created, and address is as returned by the socket’s accept().

Connection.bind(address)¶

Call the bind() method of the underlying socket.

Connection.close()¶

Call the close() method of the underlying socket. Note: If you want correct SSL closure, you need to call the shutdown() method first.

Connection.connect(address)¶

Call the connect() method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at creation.

Connection.connect_ex(address)¶

Call the connect_ex() method of the underlying socket and set up SSL on the socket, using the Context object supplied to this Connection object at creation. Note that if the connect_ex() method of the socket doesn’t return 0, SSL won’t be initialized.

Connection.do_handshake()¶

Perform an SSL handshake (usually called after renegotiate() or one of set_accept_state() or set_accept_state()). This can raise the same exceptions as send() and recv().

Connection.fileno()¶

Retrieve the file descriptor number for the underlying socket.

Connection.listen(backlog)¶

Call the listen() method of the underlying socket.

Connection.get_app_data()¶

Retrieve application data as set by set_app_data().

Connection.get_cipher_list()¶

Retrieve the list of ciphers used by the Connection object. WARNING: This API has changed. It used to take an optional parameter and just return a string, but not it returns the entire list in one go.

Connection.get_client_ca_list()¶

Retrieve the list of preferred client certificate issuers sent by the server as OpenSSL.crypto.X509Name objects.

If this is a client Connection, the list will be empty until the connection with the server is established.

If this is a server Connection, return the list of certificate authorities that will be sent or has been sent to the client, as controlled by this Connection‘s Context.

New in version 0.10.

Connection.get_context()¶

Retrieve the Context object associated with this Connection.

Connection.set_context(context)¶

Specify a replacement Context object for this Connection.

Connection.get_peer_certificate()¶

Retrieve the other side’s certificate (if any)

Connection.get_peer_cert_chain()¶

Retrieve the tuple of the other side’s certificate chain (if any)

Connection.getpeername()¶

Call the getpeername() method of the underlying socket.

Connection.getsockname()¶

Call the getsockname() method of the underlying socket.

Connection.getsockopt(level, optname[, buflen])¶

Call the getsockopt() method of the underlying socket.

Connection.pending()¶

Retrieve the number of bytes that can be safely read from the SSL buffer (not the underlying transport buffer).

Connection.recv(bufsize)¶

Receive data from the Connection. The return value is a string representing the data received. The maximum amount of data to be received at once, is specified by bufsize.

Connection.bio_write(bytes)¶

If the Connection was created with a memory BIO, this method can be used to add bytes to the read end of that memory BIO. The Connection can then read the bytes (for example, in response to a call to recv()).

Connection.renegotiate()¶

Renegotiate the SSL session. Call this if you wish to change cipher suites or anything like that.

Connection.send(string)¶

Send the string data to the Connection.

Connection.bio_read(bufsize)¶

If the Connection was created with a memory BIO, this method can be used to read bytes from the write end of that memory BIO. Many Connection methods will add bytes which must be read in this manner or the buffer will eventually fill up and the Connection will be able to take no further actions.

Connection.sendall(string)¶

Send all of the string data to the Connection. This calls send() repeatedly until all data is sent. If an error occurs, it’s impossible to tell how much data has been sent.

Connection.set_accept_state()¶

Set the connection to work in server mode. The handshake will be handled automatically by read/write.

Connection.set_app_data(data)¶

Associate data with this Connection object. data can be retrieved later using the get_app_data() method.

Connection.set_connect_state()¶

Set the connection to work in client mode. The handshake will be handled automatically by read/write.

Connection.setblocking(flag)¶

Call the setblocking() method of the underlying socket.

Connection.setsockopt(level, optname, value)¶

Call the setsockopt() method of the underlying socket.

Connection.shutdown()¶

Send the shutdown message to the Connection. Returns true if the shutdown message exchange is completed and false otherwise (in which case you call recv() or send() when the connection becomes readable/writeable.

Connection.get_shutdown()¶

Get the shutdown state of the Connection. Returns a bitvector of either or both of SENT_SHUTDOWN and RECEIVED_SHUTDOWN.

Connection.set_shutdown(state)¶

Set the shutdown state of the Connection. state is a bitvector of either or both of SENT_SHUTDOWN and RECEIVED_SHUTDOWN.

Connection.sock_shutdown(how)¶

Call the shutdown() method of the underlying socket.

Connection.bio_shutdown()¶

If the Connection was created with a memory BIO, this method can be used to indicate that end of file has been reached on the read end of that memory BIO.

Connection.state_string()¶

Retrieve a verbose string detailing the state of the Connection.

Connection.client_random()¶

Retrieve the random value used with the client hello message.

Connection.server_random()¶

Retrieve the random value used with the server hello message.

Connection.master_key()¶

Retrieve the value of the master key for this session.

Connection.want_read()¶

Checks if more data has to be read from the transport layer to complete an operation.

Connection.want_write()¶

Checks if there is data to write to the transport layer to complete an operation.

Connection.set_tlsext_host_name(name)¶

Specify the byte string to send as the server name in the client hello message.

New in version 0.13.

Connection.get_servername()¶

Get the value of the server name received in the client hello message.

New in version 0.13.

Connection.get_session()¶

Get a Session instance representing the SSL session in use by the connection, or None if there is no session.

New in version 0.14.

Connection.set_session(session)¶

Set a new SSL session (using a Session instance) to be used by the connection.

New in version 0.14.

Footnotes