Package ch.bailu.gtk.gio

Class TlsDatabase

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gio.TlsDatabase

All Implemented Interfaces:

PointerInterface

public class TlsDatabase
extends Object

#GTlsDatabase is used to look up certificates and other information
from a certificate or key store. It is an abstract base class which
TLS library specific subtypes override.

A #GTlsDatabase may be accessed from multiple threads by the TLS backend.
All implementations are required to be fully thread-safe.

Most common client applications will not directly interact with
#GTlsDatabase. It is used internally by #GTlsConnection.

https://docs.gtk.org/gio/class.TlsDatabase.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TlsDatabase.OnAsyncReadyCallback

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
TlsDatabase(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
Str	createCertificateHandle(TlsCertificate certificate)	Create a handle string for the certificate.
static ClassHandler	getClassHandler()
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
TlsCertificate	lookupCertificateForHandle(Str handle, TlsInteraction interaction, int flags, Cancellable cancellable)	Look up a certificate by its handle.
TlsCertificate	lookupCertificateForHandle(String handle, TlsInteraction interaction, int flags, Cancellable cancellable)	Look up a certificate by its handle.
void	lookupCertificateForHandleAsync(Str handle, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously look up a certificate by its handle in the database.
void	lookupCertificateForHandleAsync(String handle, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously look up a certificate by its handle in the database.
TlsCertificate	lookupCertificateForHandleFinish(AsyncResult result)	Finish an asynchronous lookup of a certificate by its handle.
TlsCertificate	lookupCertificateIssuer(TlsCertificate certificate, TlsInteraction interaction, int flags, Cancellable cancellable)	Look up the issuer of @certificate in the database.
void	lookupCertificateIssuerAsync(TlsCertificate certificate, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously look up the issuer of @certificate in the database.
TlsCertificate	lookupCertificateIssuerFinish(AsyncResult result)	Finish an asynchronous lookup issuer operation.
List	lookupCertificatesIssuedBy(ByteArray issuer_raw_dn, TlsInteraction interaction, int flags, Cancellable cancellable)	Look up certificates issued by this issuer in the database.
void	lookupCertificatesIssuedByAsync(ByteArray issuer_raw_dn, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously look up certificates issued by this issuer in the database.
List	lookupCertificatesIssuedByFinish(AsyncResult result)	Finish an asynchronous lookup of certificates.
int	verifyChain(TlsCertificate chain, Str purpose, SocketConnectable identity, TlsInteraction interaction, int flags, Cancellable cancellable)	Determines the validity of a certificate chain, outside the context of a TLS session.
int	verifyChain(TlsCertificate chain, String purpose, SocketConnectable identity, TlsInteraction interaction, int flags, Cancellable cancellable)	Determines the validity of a certificate chain, outside the context of a TLS session.
void	verifyChainAsync(TlsCertificate chain, Str purpose, SocketConnectable identity, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain.
void	verifyChainAsync(TlsCertificate chain, String purpose, SocketConnectable identity, TlsInteraction interaction, int flags, Cancellable cancellable, TlsDatabase.OnAsyncReadyCallback callback, Pointer user_data)	Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain.
int	verifyChainFinish(AsyncResult result)	Finish an asynchronous verify chain operation.

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

TlsDatabase

public TlsDatabase(PointerContainer pointer)

Method Details

getClassHandler

public static ClassHandler getClassHandler()

createCertificateHandle

public Str createCertificateHandle(@Nonnull
 TlsCertificate 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.

Parameters:

certificate - certificate for which to create a handle.

Returns:

a newly allocated string containing the handle.

lookupCertificateForHandle

public TlsCertificate lookupCertificateForHandle(@Nonnull
 Str handle,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                                          throws AllocationError

Look up 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.

Parameters:

handle - a certificate handle

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup.

cancellable - a #GCancellable, or %NULL

Returns:

a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate.

Throws:

AllocationError

lookupCertificateForHandle

public TlsCertificate lookupCertificateForHandle(String handle,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                                          throws AllocationError

Look up 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.

Parameters:

handle - a certificate handle

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup.

cancellable - a #GCancellable, or %NULL

Returns:

a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate.

Throws:

AllocationError

lookupCertificateForHandleAsync

public void lookupCertificateForHandleAsync(@Nonnull
 Str handle,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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

Parameters:

handle - a certificate handle

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup.

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

lookupCertificateForHandleAsync

public void lookupCertificateForHandleAsync(String handle,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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

Parameters:

handle - a certificate handle

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup.

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

lookupCertificateForHandleFinish

public TlsCertificate lookupCertificateForHandleFinish(@Nonnull
 AsyncResult result)
                                                throws AllocationError

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 %NULL will be returned.

Parameters:

result - a #GAsyncResult.

Returns:

a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate.

Throws:

AllocationError

lookupCertificateIssuer

public TlsCertificate lookupCertificateIssuer(@Nonnull
 TlsCertificate certificate,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                                       throws AllocationError

Look up the issuer of @certificate in the database. The
#GTlsCertificate: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](https://datatracker.ietf.org/doc/html/rfc4158) 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.

Parameters:

certificate - a #GTlsCertificate

interaction - used to interact with the user if necessary

flags - flags which affect the lookup operation

cancellable - a #GCancellable, or %NULL

Returns:

a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate.

Throws:

AllocationError

lookupCertificateIssuerAsync

public void lookupCertificateIssuerAsync(@Nonnull
 TlsCertificate certificate,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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

Parameters:

certificate - a #GTlsCertificate

interaction - used to interact with the user if necessary

flags - flags which affect the lookup operation

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

lookupCertificateIssuerFinish

public TlsCertificate lookupCertificateIssuerFinish(@Nonnull
 AsyncResult result)
                                             throws AllocationError

Finish an asynchronous lookup issuer operation. See
g_tls_database_lookup_certificate_issuer() for more information.

Parameters:

result - a #GAsyncResult.

Returns:

a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate.

Throws:

AllocationError

lookupCertificatesIssuedBy

public List lookupCertificatesIssuedBy(@Nonnull
 ByteArray issuer_raw_dn,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                                throws AllocationError

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.

Parameters:

issuer_raw_dn - a #GByteArray which holds the DER encoded issuer DN.

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup operation.

cancellable - a #GCancellable, 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.

Throws:

AllocationError

lookupCertificatesIssuedByAsync

public void lookupCertificatesIssuedByAsync(@Nonnull
 ByteArray issuer_raw_dn,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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 of this asynchronous operation. The byte array should not be modified during
this time.

Parameters:

issuer_raw_dn - a #GByteArray which holds the DER encoded issuer DN.

interaction - used to interact with the user if necessary

flags - Flags which affect the lookup operation.

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

lookupCertificatesIssuedByFinish

public List lookupCertificatesIssuedByFinish(@Nonnull
 AsyncResult result)
                                      throws AllocationError

Finish an asynchronous lookup of certificates. See
g_tls_database_lookup_certificates_issued_by() for more information.

Parameters:

result - a #GAsyncResult.

Returns:

a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list.

Throws:

AllocationError

verifyChain

public int verifyChain(@Nonnull
 TlsCertificate chain,
 @Nonnull
 Str purpose,
 @Nullable
 SocketConnectable identity,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                throws AllocationError

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

@chain is a chain of #GTlsCertificate objects each pointing to the next
certificate in the chain by its #GTlsCertificate: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 %NULL, 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 #GTlsDatabase during
certificate verification by adjusting the #GTlsCertificate:issuer
property of each certificate in @chain. Since GLib 2.48, this no
longer occurs, so you cannot rely on #GTlsCertificate:issuer to
represent the actual certification path used during certificate
verification.

Because TLS session context is not used, #GTlsDatabase 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.

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.

Parameters:

chain - a #GTlsCertificate chain

purpose - the purpose that this certificate chain will be used for.

identity - the expected peer identity

interaction - used to interact with the user if necessary

flags - additional verify flags

cancellable - a #GCancellable, or %NULL

Returns:

the appropriate #GTlsCertificateFlags which represents the result of verification.

Throws:

AllocationError

verifyChain

public int verifyChain(@Nonnull
 TlsCertificate chain,
 String purpose,
 @Nullable
 SocketConnectable identity,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable)
                throws AllocationError

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

@chain is a chain of #GTlsCertificate objects each pointing to the next
certificate in the chain by its #GTlsCertificate: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 %NULL, 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 #GTlsDatabase during
certificate verification by adjusting the #GTlsCertificate:issuer
property of each certificate in @chain. Since GLib 2.48, this no
longer occurs, so you cannot rely on #GTlsCertificate:issuer to
represent the actual certification path used during certificate
verification.

Because TLS session context is not used, #GTlsDatabase 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.

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.

Parameters:

chain - a #GTlsCertificate chain

purpose - the purpose that this certificate chain will be used for.

identity - the expected peer identity

interaction - used to interact with the user if necessary

flags - additional verify flags

cancellable - a #GCancellable, or %NULL

Returns:

the appropriate #GTlsCertificateFlags which represents the result of verification.

Throws:

AllocationError

verifyChainAsync

public void verifyChainAsync(@Nonnull
 TlsCertificate chain,
 @Nonnull
 Str purpose,
 @Nullable
 SocketConnectable identity,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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 - a #GTlsCertificate chain

purpose - the purpose that this certificate chain will be used for.

identity - the expected peer identity

interaction - used to interact with the user if necessary

flags - additional verify flags

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

verifyChainAsync

public void verifyChainAsync(@Nonnull
 TlsCertificate chain,
 String purpose,
 @Nullable
 SocketConnectable identity,
 @Nullable
 TlsInteraction interaction,
 int flags,
 @Nullable
 Cancellable cancellable,
 TlsDatabase.OnAsyncReadyCallback callback,
 @Nullable
 Pointer user_data)

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 - a #GTlsCertificate chain

purpose - the purpose that this certificate chain will be used for.

identity - the expected peer identity

interaction - used to interact with the user if necessary

flags - additional verify flags

cancellable - a #GCancellable, or %NULL

callback - callback to call when the operation completes

user_data - the data to pass to the callback function

verifyChainFinish

public int verifyChainFinish(@Nonnull
 AsyncResult result)
                      throws AllocationError

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.

Parameters:

result - a #GAsyncResult.

Returns:

the appropriate #GTlsCertificateFlags which represents the result of verification.

Throws:

AllocationError

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()