|
|
|
GIO Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Known Derived Interfaces | ||||
#include <gio/gio.h>
GTlsDatabase;
enum GTlsDatabaseVerifyFlags;
#define G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER
#define G_TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT
GTlsCertificateFlags g_tls_database_verify_chain (GTlsDatabase *self,
GTlsCertificate *chain,
const gchar *purpose,
GSocketConnectable *identity,
GTlsInteraction *interaction,
GTlsDatabaseVerifyFlags flags,
GCancellable *cancellable,
GError **error);
void g_tls_database_verify_chain_async (GTlsDatabase *self,
GTlsCertificate *chain,
const gchar *purpose,
GSocketConnectable *identity,
GTlsInteraction *interaction,
GTlsDatabaseVerifyFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GTlsCertificateFlags g_tls_database_verify_chain_finish (GTlsDatabase *self,
GAsyncResult *result,
GError **error);
enum GTlsDatabaseLookupFlags;
GTlsCertificate * g_tls_database_lookup_certificate_issuer
(GTlsDatabase *self,
GTlsCertificate *certificate,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GError **error);
void g_tls_database_lookup_certificate_issuer_async
(GTlsDatabase *self,
GTlsCertificate *certificate,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GTlsCertificate * g_tls_database_lookup_certificate_issuer_finish
(GTlsDatabase *self,
GAsyncResult *result,
GError **error);
GList * g_tls_database_lookup_certificates_issued_by
(GTlsDatabase *self,
GByteArray *issuer_raw_dn,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GError **error);
void g_tls_database_lookup_certificates_issued_by_async
(GTlsDatabase *self,
GByteArray *issuer_raw_dn,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GList * g_tls_database_lookup_certificates_issued_by_finish
(GTlsDatabase *self,
GAsyncResult *result,
GError **error);
gchar * g_tls_database_create_certificate_handle
(GTlsDatabase *self,
GTlsCertificate *certificate);
GTlsCertificate * g_tls_database_lookup_certificate_for_handle
(GTlsDatabase *self,
const gchar *handle,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GError **error);
void g_tls_database_lookup_certificate_for_handle_async
(GTlsDatabase *self,
const gchar *handle,
GTlsInteraction *interaction,
GTlsDatabaseLookupFlags flags,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
GTlsCertificate * g_tls_database_lookup_certificate_for_handle_finish
(GTlsDatabase *self,
GAsyncResult *result,
GError **error);
GTlsDatabase is used to lookup certificates and other information from a certificate or key store. It is an abstract base class which TLS library specific subtypes override.
Most common client applications will not directly interact with GTlsDatabase. It is used internally by GTlsConnection.
typedef struct _GTlsDatabase GTlsDatabase;
Abstract base class for the backend-specific database types.
Since 2.30
typedef enum {
G_TLS_DATABASE_VERIFY_NONE = 0
} GTlsDatabaseVerifyFlags;
Flags for g_tls_database_verify_chain().
Since 2.30
#define G_TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER "1.3.6.1.5.5.7.3.1"
The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients.
#define G_TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT "1.3.6.1.5.5.7.3.2"
The purpose used to verify the client certificate in a TLS connection. Used by TLS servers.
GTlsCertificateFlags g_tls_database_verify_chain (GTlsDatabase *self,GTlsCertificate *chain,const gchar *purpose,GSocketConnectable *identity,GTlsInteraction *interaction,GTlsDatabaseVerifyFlags flags,GCancellable *cancellable,GError **error);
Verify's a certificate chain after looking up and adding any missing certificates to the chain.
chain is a chain of GTlsCertificate objects each pointing to the next
certificate in the chain by its issuer property. The chain may initially
consist of one or more certificates. After the verification process is
complete, chain may be modified by adding missing certificates, or removing
extra certificates. If a certificate anchor was found, then it is added to
the chain.
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 check for pinned certificates (trust exceptions)
in the database. These will 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.
This function can block, use g_tls_database_verify_chain_async() to perform
the verification operation asynchronously.
|
a GTlsDatabase |
|
a GTlsCertificate chain |
|
the purpose that this certificate chain will be used for. |
|
the expected peer identity. [allow-none] |
|
used to interact with the user if necessary. [allow-none] |
|
additional verify flags |
|
a GCancellable, or NULL. [allow-none]
|
|
a GError, or NULL. [allow-none]
|
Returns : |
the appropriate GTlsCertificateFlags which represents the result of verification. |
Since 2.30
void g_tls_database_verify_chain_async (GTlsDatabase *self,GTlsCertificate *chain,const gchar *purpose,GSocketConnectable *identity,GTlsInteraction *interaction,GTlsDatabaseVerifyFlags flags,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously verify's a certificate chain after looking up and adding
any missing certificates to the chain. See g_tls_database_verify_chain()
for more information.
|
a GTlsDatabase |
|
a GTlsCertificate chain |
|
the purpose that this certificate chain will be used for. |
|
the expected peer identity. [allow-none] |
|
used to interact with the user if necessary. [allow-none] |
|
additional verify flags |
|
a GCancellable, or NULL. [allow-none]
|
|
callback to call when the operation completes |
|
the data to pass to the callback function |
Since 2.30
GTlsCertificateFlags g_tls_database_verify_chain_finish (GTlsDatabase *self,GAsyncResult *result,GError **error);
Finish an asynchronous verify chain operation. See
g_tls_database_verify_chain() for more information. *
|
a GTlsDatabase |
|
a GAsyncResult. |
|
a GError pointer, or NULL
|
Returns : |
the appropriate GTlsCertificateFlags which represents the result of verification. |
Since 2.30
typedef enum {
G_TLS_DATABASE_LOOKUP_NONE = 0,
G_TLS_DATABASE_LOOKUP_KEYPAIR = 1
} GTlsDatabaseLookupFlags;
Flags for g_tls_database_lookup_certificate_handle(),
g_tls_database_lookup_certificate_issuer(),
and g_tls_database_lookup_certificates_issued_by().
| No lookup flags | |
| Restrict lookup to certificates that have a private key. |
Since 2.30
GTlsCertificate * g_tls_database_lookup_certificate_issuer (GTlsDatabase *self,GTlsCertificate *certificate,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GError **error);
Lookup the issuer of certificate in the database.
The 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.
|
a GTlsDatabase |
|
a GTlsCertificate |
|
used to interact with the user if necessary. [allow-none] |
|
flags which affect the lookup operation |
|
a GCancellable, or NULL. [allow-none]
|
|
a GError, or NULL. [allow-none]
|
Returns : |
a newly allocated issuer GTlsCertificate,
or NULL. Use g_object_unref() to release the certificate. [transfer full]
|
Since 2.30
void g_tls_database_lookup_certificate_issuer_async (GTlsDatabase *self,GTlsCertificate *certificate,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously lookup the issuer of certificate in the database. See
g_tls_database_lookup_certificate_issuer() for more information.
|
a GTlsDatabase |
|
a GTlsCertificate |
|
used to interact with the user if necessary. [allow-none] |
|
flags which affect the lookup operation |
|
a GCancellable, or NULL. [allow-none]
|
|
callback to call when the operation completes |
|
the data to pass to the callback function |
Since 2.30
GTlsCertificate * g_tls_database_lookup_certificate_issuer_finish (GTlsDatabase *self,GAsyncResult *result,GError **error);
Finish an asynchronous lookup issuer operation. See
g_tls_database_lookup_certificate_issuer() for more information.
|
a GTlsDatabase |
|
a GAsyncResult. |
|
a GError pointer, or NULL
|
Returns : |
a newly allocated issuer GTlsCertificate,
or NULL. Use g_object_unref() to release the certificate. [transfer full]
|
Since 2.30
GList * g_tls_database_lookup_certificates_issued_by (GTlsDatabase *self,GByteArray *issuer_raw_dn,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GError **error);
Lookup 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.
|
a GTlsDatabase |
|
a GByteArray which holds the DER encoded issuer DN. |
|
used to interact with the user if necessary. [allow-none] |
|
Flags which affect the lookup operation. |
|
a GCancellable, or NULL. [allow-none]
|
|
a GError, or NULL. [allow-none]
|
Returns : |
a newly allocated list of GTlsCertificate
objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. [transfer full][element-type GTlsCertificate]
|
Since 2.30
void g_tls_database_lookup_certificates_issued_by_async (GTlsDatabase *self,GByteArray *issuer_raw_dn,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously lookup 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 of this asynchronous operation. The byte array should not be modified during this time.
|
a GTlsDatabase |
|
a GByteArray which holds the DER encoded issuer DN. |
|
used to interact with the user if necessary. [allow-none] |
|
Flags which affect the lookup operation. |
|
a GCancellable, or NULL. [allow-none]
|
|
callback to call when the operation completes |
|
the data to pass to the callback function |
Since 2.30
GList * g_tls_database_lookup_certificates_issued_by_finish (GTlsDatabase *self,GAsyncResult *result,GError **error);
Finish an asynchronous lookup of certificates. See
g_tls_database_lookup_certificates_issued_by() for more information.
|
a GTlsDatabase |
|
a GAsyncResult. |
|
a GError pointer, or NULL
|
Returns : |
a newly allocated list of GTlsCertificate objects.
Use g_object_unref() on each certificate, and g_list_free() on the release the list. [transfer full]
|
Since 2.30
gchar * g_tls_database_create_certificate_handle (GTlsDatabase *self,GTlsCertificate *certificate);
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, NULL
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.
|
a GTlsDatabase |
|
certificate for which to create a handle. |
Returns : |
a newly allocated string containing the handle. [allow-none] |
Since 2.30
GTlsCertificate * g_tls_database_lookup_certificate_for_handle (GTlsDatabase *self,const gchar *handle,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GError **error);
Lookup a certificate by its handle.
The handle should have been created by calling
g_tls_database_create_certificate_handle() on a GTlsDatabase 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 NULL will be returned.
This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform
the lookup operation asynchronously.
|
a GTlsDatabase |
|
a certificate handle |
|
used to interact with the user if necessary. [allow-none] |
|
Flags which affect the lookup. |
|
a GCancellable, or NULL. [allow-none]
|
|
a GError, or NULL. [allow-none]
|
Returns : |
a newly allocated
GTlsCertificate, or NULL. Use g_object_unref() to release the certificate. [transfer full][allow-none]
|
Since 2.30
void g_tls_database_lookup_certificate_for_handle_async (GTlsDatabase *self,const gchar *handle,GTlsInteraction *interaction,GTlsDatabaseLookupFlags flags,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
Asynchronously lookup a certificate by its handle in the database. See
g_tls_database_lookup_certificate_for_handle() for more information.
|
a GTlsDatabase |
|
a certificate handle |
|
used to interact with the user if necessary. [allow-none] |
|
Flags which affect the lookup. |
|
a GCancellable, or NULL. [allow-none]
|
|
callback to call when the operation completes |
|
the data to pass to the callback function |
Since 2.30
GTlsCertificate * g_tls_database_lookup_certificate_for_handle_finish (GTlsDatabase *self,GAsyncResult *result,GError **error);
Finish an asynchronous lookup of a certificate by its handle. See
g_tls_database_lookup_certificate_handle() for more information.
If the handle is no longer valid, or does not point to a certificate in
this database, then NULL will be returned.
|
a GTlsDatabase |
|
a GAsyncResult. |
|
a GError pointer, or NULL
|
Returns : |
a newly allocated GTlsCertificate object.
Use g_object_unref() to release the certificate. [transfer full]
|
Since 2.30