TlsDatabase - TLS database type. More...
#include <giomm/tlsdatabase.h>
Public Types | |
| enum class | VerifyFlags { NONE = 0x0 } |
| enum class | LookupFlags { NONE = 0x0 , KEYPAIR = 0x1 } |
 Public Types inherited from Glib::Object | |
| using | DestroyNotify = void(*)(gpointer data) |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. | |
Related Symbols | |
(Note that these are not member symbols.) | |
| Glib::RefPtr< Gio::TlsDatabase > | wrap (GTlsDatabase *object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
| Related Symbols inherited from Glib::Object | |
| Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
Detailed Description
TlsDatabase - TLS database type.
TlsDatabase 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 TlsDatabase. It is used internally by TlsConnection.
Member Enumeration Documentation
◆ LookupFlags
◆ VerifyFlags
Constructor & Destructor Documentation
◆ TlsDatabase() [1/2]
|
noexcept |
◆ ~TlsDatabase()
|
overridenoexcept |
◆ TlsDatabase() [2/2]
|
protected |
Member Function Documentation
◆ create_certificate_handle()
| Glib::ustring Gio::TlsDatabase::create_certificate_handle | ( | const Glib::RefPtr< const TlsCertificate > & | certificate | ) | const |
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, nullptr 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.
◆ create_certificate_handle_vfunc()
|
protectedvirtual |
◆ get_type()
Get the GType for this class, for use with the underlying GObject type system.
◆ gobj() [1/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj() [2/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj_copy()
| GTlsDatabase * Gio::TlsDatabase::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
◆ lookup_certificate_for_handle() [1/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle() [2/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle() [3/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
Look up a certificate by its handle.
The handle should have been created by calling g_tls_database_create_certificate_handle() on a TlsDatabase 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 nullptr 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 Cancellable, or nullptr.
- Returns
- A newly allocated TlsCertificate, or
nullptr. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_for_handle() [4/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
Look up a certificate by its handle.
The handle should have been created by calling g_tls_database_create_certificate_handle() on a TlsDatabase 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 nullptr 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 Cancellable, or nullptr.
- Returns
- A newly allocated TlsCertificate, or
nullptr. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_for_handle() [5/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle() [6/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle() [7/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle() [8/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle | ( | const Glib::ustring & | handle, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_for_handle() convenience overload.
◆ lookup_certificate_for_handle_async() [1/4]
| void Gio::TlsDatabase::lookup_certificate_for_handle_async | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
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 Cancellable, or nullptr.slot Callback to call when the operation completes.
◆ lookup_certificate_for_handle_async() [2/4]
| void Gio::TlsDatabase::lookup_certificate_for_handle_async | ( | const Glib::ustring & | handle, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle_async() convenience overload.
◆ lookup_certificate_for_handle_async() [3/4]
| void Gio::TlsDatabase::lookup_certificate_for_handle_async | ( | const Glib::ustring & | handle, |
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle_async() convenience overload.
◆ lookup_certificate_for_handle_async() [4/4]
| void Gio::TlsDatabase::lookup_certificate_for_handle_async | ( | const Glib::ustring & | handle, |
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_for_handle_async() convenience overload.
◆ lookup_certificate_for_handle_async_vfunc()
|
protectedvirtual |
◆ lookup_certificate_for_handle_finish()
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_for_handle_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
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 nullptr will be returned.
- Parameters
-
result A AsyncResult.
- Returns
- A newly allocated TlsCertificate object. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_for_handle_finish_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ lookup_certificate_for_handle_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ lookup_certificate_issuer() [1/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer() [2/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer() [3/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
Look up the issuer of certificate in the database.
The TlsCertificate::property_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.
- Parameters
-
certificate A TlsCertificate. interaction Used to interact with the user if necessary. flags Flags which affect the lookup operation. cancellable A Cancellable, or nullptr.
- Returns
- A newly allocated issuer TlsCertificate, or
nullptr. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_issuer() [4/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
Look up the issuer of certificate in the database.
The TlsCertificate::property_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.
- Parameters
-
certificate A TlsCertificate. interaction Used to interact with the user if necessary. flags Flags which affect the lookup operation. cancellable A Cancellable, or nullptr.
- Returns
- A newly allocated issuer TlsCertificate, or
nullptr. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_issuer() [5/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer() [6/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer() [7/8]
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer() [8/8]
| Glib::RefPtr< const TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificate_issuer() convenience overload.
◆ lookup_certificate_issuer_async() [1/4]
| void Gio::TlsDatabase::lookup_certificate_issuer_async | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
Asynchronously look up the issuer of certificate in the database.
See g_tls_database_lookup_certificate_issuer() for more information.
- Parameters
-
certificate A TlsCertificate. interaction Used to interact with the user if necessary. flags Flags which affect the lookup operation. cancellable A Cancellable, or nullptr.slot Callback to call when the operation completes.
◆ lookup_certificate_issuer_async() [2/4]
| void Gio::TlsDatabase::lookup_certificate_issuer_async | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer_async() convenience overload.
◆ lookup_certificate_issuer_async() [3/4]
| void Gio::TlsDatabase::lookup_certificate_issuer_async | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer_async() convenience overload.
◆ lookup_certificate_issuer_async() [4/4]
| void Gio::TlsDatabase::lookup_certificate_issuer_async | ( | const Glib::RefPtr< const TlsCertificate > & | certificate, |
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificate_issuer_async() convenience overload.
◆ lookup_certificate_issuer_async_vfunc()
|
protectedvirtual |
◆ lookup_certificate_issuer_finish()
| Glib::RefPtr< TlsCertificate > Gio::TlsDatabase::lookup_certificate_issuer_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finish an asynchronous lookup issuer operation.
See g_tls_database_lookup_certificate_issuer() for more information.
- Parameters
-
result A AsyncResult.
- Returns
- A newly allocated issuer TlsCertificate, or
nullptr. Use Glib::object_unref() to release the certificate.
- Exceptions
-
Glib::Error
◆ lookup_certificate_issuer_finish_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ lookup_certificate_issuer_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ lookup_certificates_issued_by() [1/8]
| std::vector< Glib::RefPtr< TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by() [2/8]
| std::vector< Glib::RefPtr< const TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by() [3/8]
| std::vector< Glib::RefPtr< TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
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 ByteArray 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 Cancellable, or nullptr.
- Returns
- A newly allocated list of TlsCertificate objects.
- Exceptions
-
Glib::Error
◆ lookup_certificates_issued_by() [4/8]
| std::vector< Glib::RefPtr< const TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
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 ByteArray 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 Cancellable, or nullptr.
- Returns
- A newly allocated list of TlsCertificate objects.
- Exceptions
-
Glib::Error
◆ lookup_certificates_issued_by() [5/8]
| std::vector< Glib::RefPtr< TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by() [6/8]
| std::vector< Glib::RefPtr< const TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by() [7/8]
| std::vector< Glib::RefPtr< TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by() [8/8]
| std::vector< Glib::RefPtr< const TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| LookupFlags | flags = LookupFlags::NONE |
||
| ) | const |
A lookup_certificates_issued_by() convenience overload.
◆ lookup_certificates_issued_by_async() [1/4]
| void Gio::TlsDatabase::lookup_certificates_issued_by_async | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
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 A ByteArray 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 Cancellable, or nullptr.slot Callback to call when the operation completes.
◆ lookup_certificates_issued_by_async() [2/4]
| void Gio::TlsDatabase::lookup_certificates_issued_by_async | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by_async() convenience overload.
◆ lookup_certificates_issued_by_async() [3/4]
| void Gio::TlsDatabase::lookup_certificates_issued_by_async | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by_async() convenience overload.
◆ lookup_certificates_issued_by_async() [4/4]
| void Gio::TlsDatabase::lookup_certificates_issued_by_async | ( | const Glib::RefPtr< Glib::ByteArray > & | issuer_raw_dn, |
| const SlotAsyncReady & | slot, | ||
| LookupFlags | flags = LookupFlags::NONE |
||
| ) |
A lookup_certificates_issued_by_async() convenience overload.
◆ lookup_certificates_issued_by_async_vfunc()
|
protectedvirtual |
◆ lookup_certificates_issued_by_finish()
| std::vector< Glib::RefPtr< TlsCertificate > > Gio::TlsDatabase::lookup_certificates_issued_by_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
Finish an asynchronous lookup of certificates.
See g_tls_database_lookup_certificates_issued_by() for more information.
- Parameters
-
result A AsyncResult.
- Returns
- A newly allocated list of TlsCertificate objects.
- Exceptions
-
Glib::Error
◆ lookup_certificates_issued_by_finish_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ lookup_certificates_issued_by_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ operator=()
|
noexcept |
◆ verify_chain() [1/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [2/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [3/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
Determines the validity of a certificate chain, outside the context of a TLS session.
chain is a chain of TlsCertificate objects each pointing to the next certificate in the chain by its TlsCertificate::property_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, Gio::TlsCertificateFlags::BAD_IDENTITY will be set in the return value. If identity is nullptr, 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 Gio::TlsDatabaseVerifyFlags::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 Gio::TlsCertificateFlags::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 Gio::TlsCertificateFlags::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 TlsDatabase during certificate verification by adjusting the TlsCertificate::property_issuer() property of each certificate in chain. Since GLib 2.48, this no longer occurs, so you cannot rely on TlsCertificate::property_issuer() to represent the actual certification path used during certificate verification.
Because TLS session context is not used, TlsDatabase may not perform as many checks on the certificates as TlsConnection 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 TlsConnection 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 TlsCertificate 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 Cancellable, or nullptr.
- Returns
- The appropriate TlsCertificateFlags which represents the result of verification.
- Exceptions
-
Glib::Error
◆ verify_chain() [4/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [5/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [6/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [7/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain() [8/8]
| TlsCertificateFlags Gio::TlsDatabase::verify_chain | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain() convenience overload.
◆ verify_chain_async() [1/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
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 TlsCertificate 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 Cancellable, or nullptr.slot Callback to call when the operation completes.
◆ verify_chain_async() [2/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [3/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [4/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< const SocketConnectable > & | identity, | ||
| const SlotAsyncReady & | slot, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [5/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [6/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const Glib::RefPtr< TlsInteraction > & | interaction, | ||
| const SlotAsyncReady & | slot, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [7/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Cancellable > & | cancellable, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async() [8/8]
| void Gio::TlsDatabase::verify_chain_async | ( | const Glib::RefPtr< TlsCertificate > & | chain, |
| const Glib::ustring & | purpose, | ||
| const SlotAsyncReady & | slot, | ||
| VerifyFlags | flags = VerifyFlags::NONE |
||
| ) | const |
A verify_chain_async() convenience overload.
◆ verify_chain_async_vfunc()
|
protectedvirtual |
◆ verify_chain_finish()
| TlsCertificateFlags Gio::TlsDatabase::verify_chain_finish | ( | const Glib::RefPtr< AsyncResult > & | result | ) |
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 Gio::TlsCertificateFlags::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 AsyncResult.
- Returns
- The appropriate TlsCertificateFlags which represents the result of verification.
- Exceptions
-
Glib::Error
◆ verify_chain_finish_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
◆ verify_chain_vfunc()
|
protectedvirtual |
- Exceptions
-
Glib::Error.
Friends And Related Symbol Documentation
◆ wrap()
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
