g_tls_certificate_new_from_pem ()

GTlsCertificate *
g_tls_certificate_new_from_pem (const gchar *data,
                                gssize length,
                                GError **error);

Creates a GTlsCertificate 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 “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 “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.

Since: 2.28

g_tls_certificate_new_from_pkcs12 ()

GTlsCertificate *
g_tls_certificate_new_from_pkcs12 (const guint8 *data,
                                   gsize length,
                                   const gchar *password,
                                   GError **error);

Creates a GTlsCertificate 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 “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 G_TLS_ERROR_BAD_CERTIFICATE_PASSWORD.

This constructor requires support in the current GTlsBackend. If support is missing it will error with G_IO_ERROR_NOT_SUPPORTED.

Other parsing failures will error with G_TLS_ERROR_BAD_CERTIFICATE.

Since: 2.72

g_tls_certificate_new_from_file ()

GTlsCertificate *
g_tls_certificate_new_from_file (const gchar *file,
                                 GError **error);

Creates a GTlsCertificate from the data in file .

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

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

Since: 2.28

g_tls_certificate_new_from_file_with_password ()

GTlsCertificate *
g_tls_certificate_new_from_file_with_password
                               (const gchar *file,
                                const gchar *password,
                                GError **error);

Creates a GTlsCertificate from the data in file .

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

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

Since: 2.72

g_tls_certificate_new_from_files ()

GTlsCertificate *
g_tls_certificate_new_from_files (const gchar *cert_file,
                                  const gchar *key_file,
                                  GError **error);

Creates a GTlsCertificate 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 “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 NULL and set error . Otherwise, this behaves like g_tls_certificate_new_from_pem().

Since: 2.28

g_tls_certificate_new_from_pkcs11_uris ()

GTlsCertificate *
g_tls_certificate_new_from_pkcs11_uris
                               (const gchar *pkcs11_uri,
                                const gchar *private_key_pkcs11_uri,
                                GError **error);

Creates a GTlsCertificate 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:

1
2
3
4
5
6
7
8
9

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.

Since: 2.68

g_tls_certificate_list_new_from_file ()

GList *
g_tls_certificate_list_new_from_file (const gchar *file,
                                      GError **error);

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

Since: 2.28

g_tls_certificate_get_dns_names ()

GPtrArray *
g_tls_certificate_get_dns_names (GTlsCertificate *cert);

Gets the value of “dns-names”.

Since: 2.70

g_tls_certificate_get_ip_addresses ()

GPtrArray *
g_tls_certificate_get_ip_addresses (GTlsCertificate *cert);

Gets the value of “ip-addresses”.

Since: 2.70

g_tls_certificate_get_issuer ()

GTlsCertificate *
g_tls_certificate_get_issuer (GTlsCertificate *cert);

Gets the GTlsCertificate representing cert 's issuer, if known

Since: 2.28

g_tls_certificate_get_issuer_name ()

gchar *
g_tls_certificate_get_issuer_name (GTlsCertificate *cert);

Returns the issuer name from the certificate.

Since: 2.70

g_tls_certificate_get_not_valid_before ()

GDateTime *
g_tls_certificate_get_not_valid_before
                               (GTlsCertificate *cert);

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

Since: 2.70

g_tls_certificate_get_not_valid_after ()

GDateTime *
g_tls_certificate_get_not_valid_after (GTlsCertificate *cert);

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

Since: 2.70

g_tls_certificate_get_subject_name ()

gchar *
g_tls_certificate_get_subject_name (GTlsCertificate *cert);

Returns the subject name from the certificate.

Since: 2.70

g_tls_certificate_verify ()

GTlsCertificateFlags
g_tls_certificate_verify (GTlsCertificate *cert,
                          GSocketConnectable *identity,
                          GTlsCertificate *trusted_ca);

This verifies cert and returns a set of GTlsCertificateFlags 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 identity is not NULL, cert 's name(s) will be compared against it, and G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return value if it does not match. If identity is NULL, that bit will never be set in the return value.

If trusted_ca is not NULL, then cert (or one of the certificates in its chain) must be signed by it, or else G_TLS_CERTIFICATE_UNKNOWN_CA will be set in the return value. If trusted_ca is NULL, 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 G_TLS_CERTIFICATE_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, GTlsCertificate may not perform as many checks on the certificates as GTlsConnection 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 GTlsConnection handle the verification.

Since: 2.28

g_tls_certificate_is_same ()

gboolean
g_tls_certificate_is_same (GTlsCertificate *cert_one,
                           GTlsCertificate *cert_two);

Check if two GTlsCertificate 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 “issuer”, “private-key”, or “private-key-pem” properties differ.

Since: 2.34

GTlsCertificate

typedef struct _GTlsCertificate GTlsCertificate;

Abstract base class for TLS certificate types.

Since: 2.28

The “certificate” property

  “certificate”              GByteArray *

The DER (binary) encoded representation of the certificate. This property and the “certificate-pem” property represent the same data, just in different forms.

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Since: 2.28

The “certificate-pem” property

  “certificate-pem”          char *

The PEM (ASCII) encoded representation of the certificate. This property and the “certificate” property represent the same data, just in different forms.

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Default value: NULL

Since: 2.28

The “dns-names” property

  “dns-names”                GPtrArray *

The DNS names from the certificate's Subject Alternative Names (SANs), NULL if unavailable.

[transfer container]

Owner: GTlsCertificate

Flags: Read

Since: 2.70

The “ip-addresses” property

  “ip-addresses”             GPtrArray *

The IP addresses from the certificate's Subject Alternative Names (SANs), NULL if unavailable.

[transfer container]

Owner: GTlsCertificate

Flags: Read

Since: 2.70

The “issuer” property

  “issuer”                   GTlsCertificate *

A GTlsCertificate representing the entity that issued this certificate. If NULL, this means that the certificate is either self-signed, or else the certificate of the issuer is not available.

Beware the issuer certificate may not be the same as the certificate that would actually be used to construct a valid certification path during certificate verification. RFC 4158 explains why an issuer certificate cannot be naively assumed to be part of the the certification path (though GLib's TLS backends may not follow the path building strategies outlined in this RFC). Due to the complexity of certification path building, GLib does not provide any way to know which certification path will actually be used. Accordingly, this property cannot be used to make security-related decisions. Only GLib itself should make security decisions about TLS certificates.

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Since: 2.28

The “issuer-name” property

  “issuer-name”              char *

The issuer from the certificate, NULL if unavailable.

[nullable]

Owner: GTlsCertificate

Flags: Read

Default value: NULL

Since: 2.70

The “not-valid-after” property

  “not-valid-after”          GDateTime *

The time at which this cert is no longer valid, NULL if unavailable.

[nullable]

Owner: GTlsCertificate

Flags: Read

Since: 2.70

The “not-valid-before” property

  “not-valid-before”         GDateTime *

The time at which this cert is considered to be valid, NULL if unavailable.

[nullable]

Owner: GTlsCertificate

Flags: Read

Since: 2.70

The “password” property

  “password”                 char *

An optional password used when constructed with GTlsCertificate:pkcs12-data.

[nullable]

Owner: GTlsCertificate

Flags: Write / Construct Only

Default value: NULL

Since: 2.72

The “pkcs11-uri” property

  “pkcs11-uri”               char *

A URI referencing the PKCS #11 objects containing an X.509 certificate and optionally a private key.

If NULL, the certificate is either not backed by PKCS #11 or the GTlsBackend does not support PKCS #11.

[nullable]

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Default value: NULL

Since: 2.68

The “pkcs12-data” property

  “pkcs12-data”              GByteArray *

The PKCS 12 formatted data used to construct the object.

See also: g_tls_certificate_new_from_pkcs12()

[nullable]

Owner: GTlsCertificate

Flags: Write / Construct Only

Since: 2.72

The “private-key” property

  “private-key”              GByteArray *

The DER (binary) encoded representation of the certificate's private key, in either PKCS #1 format or unencrypted PKCS #8 format. PKCS #8 format is supported since 2.32; earlier releases only support PKCS #1. You can use the openssl rsa tool to convert PKCS #8 keys to PKCS #1.

This property (or the “private-key-pem” property) can be set when constructing a key (for example, from a file). Since GLib 2.70, it is now also readable; however, be aware that if the private key is backed by a PKCS #11 URI – for example, if it is stored on a smartcard – then this property will be NULL. If so, the private key must be referenced via its PKCS #11 URI, “private-key-pkcs11-uri”. You must check both properties to see if the certificate really has a private key. When this property is read, the output format will be unencrypted PKCS #8.

[nullable]

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Since: 2.28

The “private-key-pem” property

  “private-key-pem”          char *

The PEM (ASCII) encoded representation of the certificate's private key in either PKCS #1 format ("BEGIN RSA PRIVATE KEY") or unencrypted PKCS #8 format ("BEGIN PRIVATE KEY"). PKCS #8 format is supported since 2.32; earlier releases only support PKCS #1. You can use the openssl rsa tool to convert PKCS #8 keys to PKCS #1.

This property (or the “private-key” property) can be set when constructing a key (for example, from a file). Since GLib 2.70, it is now also readable; however, be aware that if the private key is backed by a PKCS #11 URI - for example, if it is stored on a smartcard - then this property will be NULL. If so, the private key must be referenced via its PKCS #11 URI, “private-key-pkcs11-uri”. You must check both properties to see if the certificate really has a private key. When this property is read, the output format will be unencrypted PKCS #8.

[nullable]

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Default value: NULL

Since: 2.28

The “private-key-pkcs11-uri” property

  “private-key-pkcs11-uri”   char *

A URI referencing a PKCS #11 object containing a private key.

[nullable]

Owner: GTlsCertificate

Flags: Read / Write / Construct Only

Default value: NULL

Since: 2.68

The “subject-name” property

  “subject-name”             char *

The subject from the cert, NULL if unavailable.

[nullable]

Owner: GTlsCertificate

Flags: Read

Default value: NULL

Since: 2.70