gcr_certificate_chain_new ()

GcrCertificateChain *
gcr_certificate_chain_new (void);

Create a new GcrCertificateChain.

gcr_certificate_chain_add ()

void
gcr_certificate_chain_add (GcrCertificateChain *self,
                           GcrCertificate *certificate);

Add certificate to the chain. The order of certificates in the chain are important. The first certificate should be the endpoint certificate, and then come the signers (certificate authorities) each in turn. If a root certificate authority is present, it should come last.

Adding a certificate an already built chain (see gcr_certificate_chain_build()) resets the type of the certificate chain to GCR_CERTIFICATE_CHAIN_UNKNOWN

gcr_certificate_chain_get_certificate ()

GcrCertificate *
gcr_certificate_chain_get_certificate (GcrCertificateChain *self,
                                       guint index);

Get a certificate in the chain. It is an error to call this function with an invalid index.

gcr_certificate_chain_get_status ()

GcrCertificateChainStatus
gcr_certificate_chain_get_status (GcrCertificateChain *self);

Get the status of a certificate chain. If the certificate chain has not been built, then the status will be GCR_CERTIFICATE_CHAIN_UNKNOWN.

A status of GCR_CERTIFICATE_CHAIN_ANCHORED does not mean that the certificate chain has been verified, but merely that an anchor has been found.

gcr_certificate_chain_get_anchor ()

GcrCertificate *
gcr_certificate_chain_get_anchor (GcrCertificateChain *self);

If the certificate chain has been built and is of status GCR_CERTIFICATE_CHAIN_ANCHORED, then this will return the anchor certificate that was found. This is not necessarily a root certificate authority. If an intermediate certificate authority in the chain was found to be anchored, then that certificate will be returned.

If an anchor is returned it does not mean that the certificate chain has been verified, but merely that an anchor has been found.

gcr_certificate_chain_get_endpoint ()

GcrCertificate *
gcr_certificate_chain_get_endpoint (GcrCertificateChain *self);

Get the endpoint certificate in the chain. This is always the first certificate in the chain. The endpoint certificate cannot be anchored.

gcr_certificate_chain_get_length ()

guint
gcr_certificate_chain_get_length (GcrCertificateChain *self);

Get the length of the certificate chain.

gcr_certificate_chain_build ()

gboolean
gcr_certificate_chain_build (GcrCertificateChain *self,
                             const gchar *purpose,
                             const gchar *peer,
                             guint flags,
                             GCancellable *cancellable,
                             GError **error);

Complete a certificate chain. Once a certificate chain has been built its status can be examined.

This operation will lookup missing certificates in PKCS#11 modules and also that each certificate in the chain is the signer of the previous one. If a trust anchor, pinned certificate, or self-signed certificate is found, then the chain is considered built. Any extra certificates are removed from the chain.

It's important to understand that building of a certificate chain does not constitute verifying that chain. This is merely the first step towards trust verification.

The purpose is a string like GCR_PURPOSE_CLIENT_AUTH and is the purpose for which the certificate chain will be used. Trust anchors are looked up for this purpose. This argument is required.

The peer is usually the host name of the peer whith which this certificate chain is being used. It is used to look up pinned certificates that have been stored for this peer. If NULL then no pinned certificates will be considered.

If the GCR_CERTIFICATE_CHAIN_NO_LOOKUPS flag is specified then no lookups for anchors or pinned certificates are done, and the resulting chain will be neither anchored or pinned. Additionally no missing certificate authorities are looked up in PKCS#11

This call will block, see gcr_certificate_chain_build_async() for the asynchronous version.

gcr_certificate_chain_build_async ()

void
gcr_certificate_chain_build_async (GcrCertificateChain *self,
                                   const gchar *purpose,
                                   const gchar *peer,
                                   guint flags,
                                   GCancellable *cancellable,
                                   GAsyncReadyCallback callback,
                                   gpointer user_data);

Complete a certificate chain. Once a certificate chain has been built its status can be examined.

This will lookup missing certificates in PKCS#11 modules and also that each certificate in the chain is the signer of the previous one. If a trust anchor, pinned certificate, or self-signed certificate is found, then the chain is considered built. Any extra certificates are removed from the chain.

It's important to understand that building of a certificate chain does not constitute verifying that chain. This is merely the first step towards trust verification.

The purpose is a string like GCR_PURPOSE_CLIENT_AUTH and is the purpose for which the certificate chain will be used. Trust anchors are looked up for this purpose. This argument is required.

The peer is usually the host name of the peer whith which this certificate chain is being used. It is used to look up pinned certificates that have been stored for this peer. If NULL then no pinned certificates will be considered.

If the GCR_CERTIFICATE_CHAIN_NO_LOOKUPS flag is specified then no lookups for anchors or pinned certificates are done, and the resulting chain will be neither anchored or pinned. Additionally no missing certificate authorities are looked up in PKCS#11

When the operation is finished, callback will be called. You can then call gcr_certificate_chain_build_finish() to get the result of the operation.

gcr_certificate_chain_build_finish ()

gboolean
gcr_certificate_chain_build_finish (GcrCertificateChain *self,
                                    GAsyncResult *result,
                                    GError **error);

Finishes an asynchronous operation started by gcr_certificate_chain_build_async().

GCR_TYPE_CERTIFICATE_CHAIN_FLAGS

#define GCR_TYPE_CERTIFICATE_CHAIN_FLAGS (gcr_certificate_chain_flags_get_type ())

The flags GType for GcrCertificateChainFlags.

GCR_TYPE_CERTIFICATE_CHAIN_STATUS

#define GCR_TYPE_CERTIFICATE_CHAIN_STATUS (gcr_certificate_chain_status_get_type ())

The enum GType for GcrCertificateChainStatus.

struct GcrCertificateChain

struct GcrCertificateChain;

A chain of certificates.

struct GcrCertificateChainClass

struct GcrCertificateChainClass {
	GObjectClass parent_class;
};

The class for GcrCertificateChain.

enum GcrCertificateChainStatus

The status of a built certificate chain. Will be set to GCR_CERTIFICATE_CHAIN_UNKNOWN for certificate chains that have not been built.

enum GcrCertificateChainFlags

Flags to be used with the gcr_certificate_chain_build() operation.

The “length” property

  “length”                   guint

The length of the certificate chain.

Flags: Read

Default value: 0

The “status” property

  “status”                   GcrCertificateChainStatus

The certificate chain status. See GcrCertificateChainStatus

Flags: Read

Default value: GCR_CERTIFICATE_CHAIN_UNKNOWN