Class: Gio::TlsDatabase

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

The class for GTls::Database. Derived classes should implement the various virtual methods. _async and _finish methods have a default implementation that runs the corresponding sync method in a thread.

Instance Method Summary collapse

Instance Method Details

#create_certificate_handle(certificate) ⇒ String

Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, nil will be returned.

This handle should be stable across various instances of the application, and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it. handle.

Parameters:

Returns:

  • (String) —

    a newly allocated string containing the

#lookup_certificate_for_handle(handle, interaction, flags, cancellable) ⇒ Gio::TlsCertificate

Look up a certificate by its handle.

The handle should have been created by calling g_tls_database_create_certificate_handle() on a GTls::Database object of the same TLS backend. The handle is designed to remain valid across instantiations of the database.

If the handle is no longer valid, or does not point to a certificate in this database, then nil will be returned.

This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform the lookup operation asynchronously. GTls::Certificate, or nil. Use g_object_unref() to release the certificate.

Parameters:

Returns:

#lookup_certificate_for_handle_async(handle, interaction, flags, cancellable, callback, user_data) ⇒ nil

Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information.

Parameters:

  • handle (String) —

    a certificate handle

  • interaction (Gio::TlsInteraction) —

    used to interact with the user if necessary

  • flags (Gio::TlsDatabaseLookupFlags) —

    Flags which affect the lookup.

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the operation completes

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#lookup_certificate_for_handle_finish(result) ⇒ Gio::TlsCertificate

Finish an asynchronous lookup of a certificate by its handle. See g_tls_database_lookup_certificate_for_handle() for more information.

If the handle is no longer valid, or does not point to a certificate in this database, then nil will be returned. Use g_object_unref() to release the certificate.

Parameters:

Returns:

#lookup_certificate_issuer(certificate, interaction, flags, cancellable) ⇒ Gio::TlsCertificate

Look up the issuer of certificate in the database. The GTls::Certificate:issuer property of certificate is not modified, and the two certificates are not hooked into a chain.

This function can block. Use g_tls_database_lookup_certificate_issuer_async() to perform the lookup operation asynchronously.

Beware this function cannot be used to build certification paths. The issuer certificate returned by this function 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 when verifying a TLS certificate. Accordingly, this function cannot be used to make security-related decisions. Only GLib itself should make security decisions about TLS certificates. or nil. Use g_object_unref() to release the certificate.

Parameters:

Returns:

#lookup_certificate_issuer_async(certificate, interaction, flags, cancellable, callback, user_data) ⇒ nil

Asynchronously look up the issuer of certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information.

Parameters:

  • certificate (Gio::TlsCertificate) —

    a GTls::Certificate

  • interaction (Gio::TlsInteraction) —

    used to interact with the user if necessary

  • flags (Gio::TlsDatabaseLookupFlags) —

    flags which affect the lookup operation

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the operation completes

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#lookup_certificate_issuer_finish(result) ⇒ Gio::TlsCertificate

Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. or nil. Use g_object_unref() to release the certificate.

Parameters:

Returns:

#lookup_certificates_issued_by(issuer_raw_dn, interaction, flags, cancellable) ⇒ GLib::List<Gio::TlsCertificate>

Look up certificates issued by this issuer in the database.

This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list.

Parameters:

  • issuer_raw_dn (Array<Integer>) —

    a GByte::Array which holds the DER encoded issuer DN.

  • interaction (Gio::TlsInteraction) —

    used to interact with the user if necessary

  • flags (Gio::TlsDatabaseLookupFlags) —

    Flags which affect the lookup operation.

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

Returns:

#lookup_certificates_issued_by_async(issuer_raw_dn, interaction, flags, cancellable, callback, user_data) ⇒ nil

Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information.

The database may choose to hold a reference to the issuer byte array for the duration of this asynchronous operation. The byte array should not be modified during this time.

Parameters:

  • issuer_raw_dn (Array<Integer>) —

    a GByte::Array which holds the DER encoded issuer DN.

  • interaction (Gio::TlsInteraction) —

    used to interact with the user if necessary

  • flags (Gio::TlsDatabaseLookupFlags) —

    Flags which affect the lookup operation.

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the operation completes

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#lookup_certificates_issued_by_finish(result) ⇒ GLib::List<Gio::TlsCertificate>

Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list.

Parameters:

Returns:

#verify_chain(chain, purpose, identity, interaction, flags, cancellable) ⇒ Gio::TlsCertificateFlags

Determines the validity of a certificate chain, outside the context of a TLS session.

chain is a chain of GTls::Certificate objects each pointing to the next certificate in the chain by its GTls::Certificate:issuer property.

purpose describes the purpose (or usage) for which the certificate is being used. Typically purpose will be set to %G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER which means that the certificate is being used to authenticate a server (and we are acting as the client).

The identity is used to ensure the server certificate is valid for the expected peer identity. If the identity does not match the certificate, %G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return value. If identity is nil, that bit will never be set in the return value. The peer identity may also be used to check for pinned certificates (trust exceptions) in the database. These may override the normal verification process on a host-by-host basis.

Currently there are no flags, and %G_TLS_DATABASE_VERIFY_NONE should be used.

If chain is found to be valid, then the return value will be 0. If chain is found to be invalid, then the return value will indicate at least one problem found. If the function is unable to determine whether chain is valid (for example, because cancellable is triggered before it completes) then the return value will be %G_TLS_CERTIFICATE_GENERIC_ERROR and error will be set accordingly. error is not set when chain is successfully analyzed but found to be invalid.

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.

Prior to GLib 2.48, GLib's default TLS backend modified chain to represent the certification path built by GTls::Database during certificate verification by adjusting the GTls::Certificate:issuer property of each certificate in chain. Since GLib 2.48, this no longer occurs, so you cannot rely on GTls::Certificate:issuer to represent the actual certification path used during certificate verification.

Because TLS session context is not used, GTls::Database may not perform as many checks on the certificates as GTls::Connection 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 GTls::Connection handle the verification.

The TLS backend may attempt to look up and add missing certificates to the chain. This may involve HTTP requests to download missing certificates.

This function can block. Use g_tls_database_verify_chain_async() to perform the verification operation asynchronously. result of verification.

Parameters:

Returns:

#verify_chain_async(chain, purpose, identity, interaction, flags, cancellable, callback, user_data) ⇒ nil

Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information.

Parameters:

  • chain (Gio::TlsCertificate) —

    a GTls::Certificate chain

  • purpose (String) —

    the purpose that this certificate chain will be used for.

  • identity (Gio::SocketConnectable) —

    the expected peer identity

  • interaction (Gio::TlsInteraction) —

    used to interact with the user if necessary

  • flags (Gio::TlsDatabaseVerifyFlags) —

    additional verify flags

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

  • callback (Gio::AsyncReadyCallback) —

    callback to call when the operation completes

  • user_data (GObject) —

    the data to pass to the callback function

Returns:

  • (nil)

#verify_chain_finish(result) ⇒ Gio::TlsCertificateFlags

Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information.

If chain is found to be valid, then the return value will be 0. If chain is found to be invalid, then the return value will indicate the problems found. If the function is unable to determine whether chain is valid or not (eg, because cancellable is triggered before it completes) then the return value will be %G_TLS_CERTIFICATE_GENERIC_ERROR and error will be set accordingly. error is not set when chain is successfully analyzed but found to be invalid. result of verification.

Parameters:

Returns: