TlsCertificate#

Added in version 2.28.

class TlsCertificate(**properties: Any)#

Superclasses: Object

A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a client from a server), or the combination of a certificate and a private key (which is needed when acting as a TlsServerConnection).

Constructors#

class TlsCertificate
classmethod new_from_file(file: str) → TlsCertificate#

Creates a TlsCertificate from the data in file.

As of 2.72, if the filename ends in .p12 or .pfx the data is loaded by new_from_pkcs12() otherwise it is loaded by new_from_pem(). See those functions for exact details.

If file cannot be read or parsed, the function will return None and set error.

Added in version 2.28.

Parameters:

file – file containing a certificate to import

classmethod new_from_file_with_password(file: str, password: str) → TlsCertificate#

Creates a TlsCertificate from the data in file.

If file cannot be read or parsed, the function will return None and set error.

Any unknown file types will error with NOT_SUPPORTED. Currently only .p12 and .pfx files are supported. See new_from_pkcs12() for more details.

Added in version 2.72.

Parameters:

  • file – file containing a certificate to import

  • password – password for PKCS 12 files

classmethod new_from_files(cert_file: str, key_file: str) → TlsCertificate#

Creates a TlsCertificate from the PEM-encoded data in cert_file and key_file. The returned certificate will be the first certificate found in cert_file. As of GLib 2.44, if cert_file contains more certificates it will try to load a certificate chain. All certificates will be verified in the order found (top-level certificate should be the last one in the file) and the TlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned.

If either file cannot be read or parsed, the function will return None and set error. Otherwise, this behaves like new_from_pem().

Added in version 2.28.

Parameters:

  • cert_file – file containing one or more PEM-encoded certificates to import

  • key_file – file containing a PEM-encoded private key to import

classmethod new_from_pem(data: str, length: int) → TlsCertificate#

Creates a TlsCertificate from the PEM-encoded data in data. If data includes both a certificate and a private key, then the returned certificate will include the private key data as well. (See the TlsCertificate:private-key-pem property for information about supported formats.)

The returned certificate will be the first certificate found in data. As of GLib 2.44, if data contains more certificates it will try to load a certificate chain. All certificates will be verified in the order found (top-level certificate should be the last one in the file) and the TlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned.

Added in version 2.28.

Parameters:

  • data – PEM-encoded certificate data

  • length – the length of data, or -1 if it’s 0-terminated.

classmethod new_from_pkcs11_uris(pkcs11_uri: str, private_key_pkcs11_uri: str | None = None) → TlsCertificate#

Creates a TlsCertificate from a PKCS #11 URI.

An example pkcs11_uri would be pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01

Where the token’s layout is:

Object 0:
  URL: pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01;object=private%20key;type=private
  Type: Private key (RSA-2048)
  ID: 01

Object 1:
  URL: pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01;object=Certificate%20for%20Authentication;type=cert
  Type: X.509 Certificate (RSA-2048)
  ID: 01

In this case the certificate and private key would both be detected and used as expected. pkcs_uri may also just reference an X.509 certificate object and then optionally private_key_pkcs11_uri allows using a private key exposed under a different URI.

Note that the private key is not accessed until usage and may fail or require a PIN later.

Added in version 2.68.

Parameters:

  • pkcs11_uri – A PKCS #11 URI

  • private_key_pkcs11_uri – A PKCS #11 URI

classmethod new_from_pkcs12(data: list[int], password: str | None = None) → TlsCertificate#

Creates a TlsCertificate from the data in data. It must contain a certificate and matching private key.

If extra certificates are included they will be verified as a chain and the TlsCertificate:issuer property will be set. All other data will be ignored.

You can pass as single password for all of the data which will be used both for the PKCS 12 container as well as encrypted private keys. If decryption fails it will error with BAD_CERTIFICATE_PASSWORD.

This constructor requires support in the current TlsBackend. If support is missing it will error with NOT_SUPPORTED.

Other parsing failures will error with BAD_CERTIFICATE.

Added in version 2.72.

Parameters:

  • data – DER-encoded PKCS 12 format certificate data

  • password – optional password for encrypted certificate data

Methods#

class TlsCertificate
do_verify(self, identity: SocketConnectable | None = None, trusted_ca: TlsCertificate | None = None) → TlsCertificateFlags#
Parameters:

  • identity

  • trusted_ca

get_dns_names() → list[Bytes] | None#

Gets the value of TlsCertificate:dns-names.

Added in version 2.70.

get_ip_addresses() → list[InetAddress] | None#

Gets the value of TlsCertificate:ip-addresses.

Added in version 2.70.

get_issuer() → TlsCertificate | None#

Gets the TlsCertificate representing cert's issuer, if known

Added in version 2.28.

get_issuer_name() → str | None#

Returns the issuer name from the certificate.

Added in version 2.70.

get_not_valid_after() → DateTime | None#

Returns the time at which the certificate became or will become invalid.

Added in version 2.70.

get_not_valid_before() → DateTime | None#

Returns the time at which the certificate became or will become valid.

Added in version 2.70.

get_subject_name() → str | None#

Returns the subject name from the certificate.

Added in version 2.70.

is_same(cert_two: TlsCertificate) → bool#

Check if two TlsCertificate objects represent the same certificate. The raw DER byte data of the two certificates are checked for equality. This has the effect that two certificates may compare equal even if their TlsCertificate:issuer, TlsCertificate:private-key, or TlsCertificate:private-key-pem properties differ.

Added in version 2.34.

Parameters:

cert_two – second certificate to compare

classmethod list_new_from_file() → list[TlsCertificate]#

Creates one or more TlsCertificate from the PEM-encoded data in file. If file cannot be read or parsed, the function will return None and set error. If file does not contain any PEM-encoded certificates, this will return an empty list and not set error.

Added in version 2.28.

verify(identity: SocketConnectable | None = None, trusted_ca: TlsCertificate | None = None) → TlsCertificateFlags#

This verifies cert and returns a set of TlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system CA database.

If cert is valid, NO_FLAGS is returned.

If identity is not None, cert's name(s) will be compared against it, and BAD_IDENTITY will be set in the return value if it does not match. If identity is None, that bit will never be set in the return value.

If trusted_ca is not None, then cert (or one of the certificates in its chain) must be signed by it, or else UNKNOWN_CA will be set in the return value. If trusted_ca is None, that bit will never be set in the return value.

GLib guarantees that if certificate verification fails, at least one error will be set in the return value, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate.

Because TLS session context is not used, TlsCertificate may not perform as many checks on the certificates as TlsConnection would. For example, certificate constraints may not be honored, and revocation checks may not be performed. The best way to verify TLS certificates used by a TLS connection is to let TlsConnection handle the verification.

Added in version 2.28.

Parameters:

  • identity – the expected peer identity

  • trusted_ca – the certificate of a trusted authority

Properties#

class TlsCertificate
props.certificate: list[int]#

The type of the None singleton.

Added in version 2.28.

props.certificate_pem: str#

The type of the None singleton.

Added in version 2.28.

props.dns_names: list[Any]#

The type of the None singleton.

Added in version 2.70.

props.ip_addresses: list[Any]#

The type of the None singleton.

Added in version 2.70.

props.issuer: TlsCertificate#

The type of the None singleton.

Added in version 2.28.

props.issuer_name: str#

The type of the None singleton.

Added in version 2.70.

props.not_valid_after: DateTime#

The type of the None singleton.

Added in version 2.70.

props.not_valid_before: DateTime#

The type of the None singleton.

Added in version 2.70.

props.password: str#

The type of the None singleton.

Added in version 2.72.

props.pkcs11_uri: str#

The type of the None singleton.

Added in version 2.68.

props.pkcs12_data: list[int]#

The type of the None singleton.

Added in version 2.72.

props.private_key: list[int]#

The type of the None singleton.

Added in version 2.28.

props.private_key_pem: str#

The type of the None singleton.

Added in version 2.28.

props.private_key_pkcs11_uri: str#

The type of the None singleton.

Added in version 2.68.

props.subject_name: str#

The type of the None singleton.

Added in version 2.70.

Virtual Methods#

class TlsCertificate
do_verify(identity: SocketConnectable | None = None, trusted_ca: TlsCertificate | None = None) → TlsCertificateFlags#

This verifies cert and returns a set of TlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system CA database.

If cert is valid, NO_FLAGS is returned.

If identity is not None, cert's name(s) will be compared against it, and BAD_IDENTITY will be set in the return value if it does not match. If identity is None, that bit will never be set in the return value.

If trusted_ca is not None, then cert (or one of the certificates in its chain) must be signed by it, or else UNKNOWN_CA will be set in the return value. If trusted_ca is None, that bit will never be set in the return value.

GLib guarantees that if certificate verification fails, at least one error will be set in the return value, but it does not guarantee that all possible errors will be set. Accordingly, you may not safely decide to ignore any particular type of error. For example, it would be incorrect to mask EXPIRED if you want to allow expired certificates, because this could potentially be the only error flag set even if other problems exist with the certificate.

Because TLS session context is not used, TlsCertificate may not perform as many checks on the certificates as TlsConnection would. For example, certificate constraints may not be honored, and revocation checks may not be performed. The best way to verify TLS certificates used by a TLS connection is to let TlsConnection handle the verification.

Added in version 2.28.

Parameters:

  • identity – the expected peer identity

  • trusted_ca – the certificate of a trusted authority

Fields#

class TlsCertificate
parent_instance#
priv#