glibmm 2.78.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::TlsConnection Class Reference

TLS connection type. More...

#include <giomm/tlsconnection.h>

Inheritance diagram for Gio::TlsConnection:
Inheritance graph
[legend]

Public Member Functions

 TlsConnection (TlsConnection && src) noexcept
 
TlsConnectionoperator= (TlsConnection && src) noexcept
 
 ~TlsConnection () noexcept override
 
GTlsConnection * gobj ()
 Provides access to the underlying C GObject. More...
 
const GTlsConnection * gobj () const
 Provides access to the underlying C GObject. More...
 
GTlsConnection * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void set_certificate (const Glib::RefPtr< TlsCertificate > & certificate)
 This sets the certificate that conn will present to its peer during the TLS handshake. More...
 
Glib::RefPtr< TlsCertificateget_certificate ()
 Gets conn's certificate, as set by g_tls_connection_set_certificate(). More...
 
Glib::RefPtr< const TlsCertificateget_certificate () const
 Gets conn's certificate, as set by g_tls_connection_set_certificate(). More...
 
Glib::RefPtr< TlsCertificateget_peer_certificate ()
 Gets conn's peer's certificate after the handshake has completed or failed. More...
 
Glib::RefPtr< const TlsCertificateget_peer_certificate () const
 Gets conn's peer's certificate after the handshake has completed or failed. More...
 
TlsCertificateFlags get_peer_certificate_errors () const
 Gets the errors associated with validating conn's peer's certificate, after the handshake has completed or failed. More...
 
void set_require_close_notify (bool require_close_notify=true)
 Sets whether or not conn expects a proper TLS close notification before the connection is closed. More...
 
bool get_require_close_notify () const
 Tests whether or not conn expects a proper TLS close notification when the connection is closed. More...
 
Glib::RefPtr< TlsDatabaseget_database ()
 Gets the certificate database that conn uses to verify peer certificates. More...
 
Glib::RefPtr< const TlsDatabaseget_database () const
 Gets the certificate database that conn uses to verify peer certificates. More...
 
void set_database (const Glib::RefPtr< TlsDatabase > & database)
 Sets the certificate database that is used to verify peer certificates. More...
 
Glib::RefPtr< TlsInteractionget_interaction ()
 Get the object that will be used to interact with the user. More...
 
Glib::RefPtr< const TlsInteractionget_interaction () const
 Get the object that will be used to interact with the user. More...
 
void set_interaction (const Glib::RefPtr< TlsInteraction > & interaction)
 Set the object that will be used to interact with the user. More...
 
bool handshake (const Glib::RefPtr< Cancellable > & cancellable)
 Attempts a TLS handshake on conn. More...
 
bool handshake ()
 A handshake() convenience overload. More...
 
void handshake_async (const SlotAsyncReady & slot, const Glib::RefPtr< Cancellable > & cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 Asynchronously performs a TLS handshake on conn. More...
 
void handshake_async (const SlotAsyncReady & slot, int io_priority=Glib::PRIORITY_DEFAULT)
 A handshake_async() convenience overload. More...
 
bool handshake_finish (const Glib::RefPtr< AsyncResult > & result)
 Finish an asynchronous TLS handshake operation. More...
 
TlsProtocolVersion get_protocol_version () const
 Returns the current TLS protocol version, which may be Gio::TlsProtocolVersion::UNKNOWN if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized TlsProtocolVersion. More...
 
Glib::ustring get_ciphersuite_name () const
 Returns the name of the current TLS ciphersuite, or nullptr if the connection has not handshaked or has been closed. More...
 
bool emit_accept_certificate (const Glib::RefPtr< const TlsCertificate > & peer_cert, TlsCertificateFlags errors)
 Used by TlsConnection implementations to emit the TlsConnection::signal_accept_certificate() signal. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< IOStream > > property_base_io_stream () const
 The IOStream that the connection wraps. More...
 
Glib::PropertyProxy< Glib::RefPtr< TlsCertificate > > property_certificate ()
 The connection's certificate; see g_tls_connection_set_certificate(). More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsCertificate > > property_certificate () const
 The connection's certificate; see g_tls_connection_set_certificate(). More...
 
Glib::PropertyProxy< Glib::RefPtr< TlsDatabase > > property_database ()
 The certificate database to use when verifying this TLS connection. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsDatabase > > property_database () const
 The certificate database to use when verifying this TLS connection. More...
 
Glib::PropertyProxy< Glib::RefPtr< TlsInteraction > > property_interaction ()
 A TlsInteraction object to be used when the connection or certificate database need to interact with the user. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsInteraction > > property_interaction () const
 A TlsInteraction object to be used when the connection or certificate database need to interact with the user. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsCertificate > > property_peer_certificate () const
 The connection's peer's certificate, after the TLS handshake has completed or failed. More...
 
Glib::PropertyProxy_ReadOnly< TlsCertificateFlagsproperty_peer_certificate_errors () const
 The errors noticed while verifying TlsConnection::property_peer_certificate(). More...
 
Glib::PropertyProxy< bool > property_require_close_notify ()
 Whether or not proper TLS close notification is required. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_require_close_notify () const
 Whether or not proper TLS close notification is required. More...
 
Glib::PropertyProxy_ReadOnly< TlsProtocolVersionproperty_protocol_version () const
 The TLS protocol version in use. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_ciphersuite_name () const
 The name of the TLS ciphersuite in use. More...
 
Glib::SignalProxy< bool(const Glib::RefPtr< const TlsCertificate > &, TlsCertificateFlags)> signal_accept_certificate ()
 
- Public Member Functions inherited from Gio::IOStream
 IOStream (IOStream && src) noexcept
 
IOStreamoperator= (IOStream && src) noexcept
 
 ~IOStream () noexcept override
 
GIOStream * gobj ()
 Provides access to the underlying C GObject. More...
 
const GIOStream * gobj () const
 Provides access to the underlying C GObject. More...
 
GIOStream * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void splice_async (const Glib::RefPtr< IOStream > & stream2, const SlotAsyncReady & slot, const Glib::RefPtr< Cancellable > & cancellable, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
 Asyncronously splice the output stream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this stream. More...
 
void splice_async (const Glib::RefPtr< IOStream > & stream2, const SlotAsyncReady & slot, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
 A non-cancellable version of splice_async(). More...
 
Glib::RefPtr< InputStreamget_input_stream ()
 Gets the input stream for this object. More...
 
Glib::RefPtr< OutputStreamget_output_stream ()
 Gets the output stream for this object. More...
 
bool close (const Glib::RefPtr< Cancellable > & cancellable)
 Closes the stream, releasing resources related to it. More...
 
bool close ()
 A close() convenience overload. More...
 
void close_async (const SlotAsyncReady & slot, const Glib::RefPtr< Cancellable > & cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 
void close_async (const SlotAsyncReady & slot, int io_priority=Glib::PRIORITY_DEFAULT)
 
bool close_finish (const Glib::RefPtr< AsyncResult > & result)
 Closes a stream. More...
 
bool is_closed () const
 Checks if a stream is closed. More...
 
bool has_pending () const
 Checks if a stream has pending actions. More...
 
bool set_pending ()
 Sets stream to have actions pending. More...
 
void clear_pending ()
 Clears the pending flag on stream. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
void * get_data (const QueryQuark & key)
 
void set_data (const Quark & key, void *data)
 
void set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)
 
void set_data (const Quark & key, void *data, DestroyNotify notify)
 Prefer set_data_with_c_callback() with a callback with C linkage. More...
 
void remove_data (const QueryQuark & quark)
 
void * steal_data (const QueryQuark & quark)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
 You probably want to use a specific property_*() accessor method instead. More...
 
void get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
template<class PropertyType >
void set_property (const Glib::ustring & property_name, const PropertyType & value)
 You probably want to use a specific property_*() accessor method instead. More...
 
template<class PropertyType >
void get_property (const Glib::ustring & property_name, PropertyType & value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
template<class PropertyType >
PropertyType get_property (const Glib::ustring & property_name) const
 You probably want to use a specific property_*() accessor method instead. More...
 
sigc::connection connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> & slot)
 You can use the signal_changed() signal of the property proxy instead. More...
 
sigc::connection connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> && slot)
 You can use the signal_changed() signal of the property proxy instead. More...
 
void freeze_notify ()
 Increases the freeze count on object. More...
 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...
 
virtual void reference () const
 Increment the reference count for this object. More...
 
virtual void unreference () const
 Decrement the reference count for this object. More...
 
GObject * gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject * gobj () const
 Provides access to the underlying C GObject. More...
 
GObject * gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gio::IOStream
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static bool splice_finish (const Glib::RefPtr< AsyncResult > & result)
 Finishes an asynchronous io stream splice operation. More...
 

Protected Member Functions

 TlsConnection ()
 
virtual bool handshake_vfunc (const Glib::RefPtr< Cancellable > & cancellable)
 
virtual void handshake_async_vfunc (const SlotAsyncReady & slot, const Glib::RefPtr< Cancellable > & cancellable, int io_priority)
 
virtual bool handshake_finish_vfunc (const Glib::RefPtr< AsyncResult > & result)
 
virtual bool on_accept_certificate (const Glib::RefPtr< const TlsCertificate > & peer_cert, TlsCertificateFlags errors)
 This is a default handler for the signal signal_accept_certificate(). More...
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams & construct_params)
 
 Object (GObject * castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. More...
 
 ObjectBase (const char * custom_type_name)
 A derived constructor always overrides this choice. More...
 
 ObjectBase (const std::type_info & custom_type_info)
 This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. More...
 
 ObjectBase (ObjectBase && src) noexcept
 
ObjectBaseoperator= (ObjectBase && src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject * castitem)
 
void initialize_move (GObject * castitem, Glib::ObjectBase * previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::TlsConnectionwrap (GTlsConnection * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gio::IOStream
enum class  SpliceFlags {
  SpliceFlags::NONE = 0x0 ,
  SpliceFlags::CLOSE_STREAM1 = (1 << 0) ,
  SpliceFlags::CLOSE_STREAM2 = (1 << 1) ,
  SpliceFlags::WAIT_FOR_BOTH = (1 << 2)
}
 GIOStreamSpliceFlags determine how streams should be spliced. More...
 
- Public Types inherited from Glib::Object
using DestroyNotify = void(*)(gpointer data)
 

Detailed Description

TLS connection type.

TlsConnection is the base TLS connection class type, which wraps an IOStream and provides TLS encryption on top of it. Its subclasses that implement TlsClientConnection and TlsServerConnection, implement client-side and server-side TLS, respectively.

Since glibmm 2.36:

Constructor & Destructor Documentation

◆ TlsConnection() [1/2]

Gio::TlsConnection::TlsConnection ( TlsConnection &&  src)
noexcept

◆ ~TlsConnection()

Gio::TlsConnection::~TlsConnection ( )
overridenoexcept

◆ TlsConnection() [2/2]

Gio::TlsConnection::TlsConnection ( )
protected

Member Function Documentation

◆ emit_accept_certificate()

bool Gio::TlsConnection::emit_accept_certificate ( const Glib::RefPtr< const TlsCertificate > &  peer_cert,
TlsCertificateFlags  errors 
)

Used by TlsConnection implementations to emit the TlsConnection::signal_accept_certificate() signal.

Since glibmm 2.28:
Parameters
peer_certThe peer's TlsCertificate.
errorsThe problems with peer_cert.
Returns
true if one of the signal handlers has returned true to accept peer_cert.

◆ get_certificate() [1/2]

Glib::RefPtr< TlsCertificate > Gio::TlsConnection::get_certificate ( )

Gets conn's certificate, as set by g_tls_connection_set_certificate().

Since glibmm 2.28:
Returns
conn's certificate, or nullptr.

◆ get_certificate() [2/2]

Glib::RefPtr< const TlsCertificate > Gio::TlsConnection::get_certificate ( ) const

Gets conn's certificate, as set by g_tls_connection_set_certificate().

Since glibmm 2.28:
Returns
conn's certificate, or nullptr.

◆ get_ciphersuite_name()

Glib::ustring Gio::TlsConnection::get_ciphersuite_name ( ) const

Returns the name of the current TLS ciphersuite, or nullptr if the connection has not handshaked or has been closed.

Beware that the TLS backend may use any of multiple different naming conventions, because OpenSSL and GnuTLS have their own ciphersuite naming conventions that are different from each other and different from the standard, IANA- registered ciphersuite names. The ciphersuite name is intended to be displayed to the user for informative purposes only, and parsing it is not recommended.

Since glibmm 2.70:
Returns
The name of the current TLS ciphersuite, or nullptr.

◆ get_database() [1/2]

Glib::RefPtr< TlsDatabase > Gio::TlsConnection::get_database ( )

Gets the certificate database that conn uses to verify peer certificates.

See g_tls_connection_set_database().

Since glibmm 2.30:
Returns
The certificate database that conn uses or nullptr.

◆ get_database() [2/2]

Glib::RefPtr< const TlsDatabase > Gio::TlsConnection::get_database ( ) const

Gets the certificate database that conn uses to verify peer certificates.

See g_tls_connection_set_database().

Since glibmm 2.30:
Returns
The certificate database that conn uses or nullptr.

◆ get_interaction() [1/2]

Glib::RefPtr< TlsInteraction > Gio::TlsConnection::get_interaction ( )

Get the object that will be used to interact with the user.

It will be used for things like prompting the user for passwords. If nullptr is returned, then no user interaction will occur for this connection.

Since glibmm 2.30:
Returns
The interaction object.

◆ get_interaction() [2/2]

Glib::RefPtr< const TlsInteraction > Gio::TlsConnection::get_interaction ( ) const

Get the object that will be used to interact with the user.

It will be used for things like prompting the user for passwords. If nullptr is returned, then no user interaction will occur for this connection.

Since glibmm 2.30:
Returns
The interaction object.

◆ get_peer_certificate() [1/2]

Glib::RefPtr< TlsCertificate > Gio::TlsConnection::get_peer_certificate ( )

Gets conn's peer's certificate after the handshake has completed or failed.

(It is not set during the emission of TlsConnection::signal_accept_certificate().)

Since glibmm 2.28:
Returns
conn's peer's certificate, or nullptr.

◆ get_peer_certificate() [2/2]

Glib::RefPtr< const TlsCertificate > Gio::TlsConnection::get_peer_certificate ( ) const

Gets conn's peer's certificate after the handshake has completed or failed.

(It is not set during the emission of TlsConnection::signal_accept_certificate().)

Since glibmm 2.28:
Returns
conn's peer's certificate, or nullptr.

◆ get_peer_certificate_errors()

TlsCertificateFlags Gio::TlsConnection::get_peer_certificate_errors ( ) const

Gets the errors associated with validating conn's peer's certificate, after the handshake has completed or failed.

(It is not set during the emission of TlsConnection::signal_accept_certificate().)

See TlsConnection::property_peer_certificate_errors() for more information.

Since glibmm 2.28:
Returns
conn's peer's certificate errors.

◆ get_protocol_version()

TlsProtocolVersion Gio::TlsConnection::get_protocol_version ( ) const

Returns the current TLS protocol version, which may be Gio::TlsProtocolVersion::UNKNOWN if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized TlsProtocolVersion.

Since glibmm 2.70:
Returns
The current TLS protocol version.

◆ get_require_close_notify()

bool Gio::TlsConnection::get_require_close_notify ( ) const

Tests whether or not conn expects a proper TLS close notification when the connection is closed.

See g_tls_connection_set_require_close_notify() for details.

Since glibmm 2.28:
Returns
true if conn requires a proper TLS close notification.

◆ get_type()

static GType Gio::TlsConnection::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GTlsConnection * Gio::TlsConnection::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GTlsConnection * Gio::TlsConnection::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GTlsConnection * Gio::TlsConnection::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ handshake() [1/2]

bool Gio::TlsConnection::handshake ( )

A handshake() convenience overload.

◆ handshake() [2/2]

bool Gio::TlsConnection::handshake ( const Glib::RefPtr< Cancellable > &  cancellable)

Attempts a TLS handshake on conn.

On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after connecting (or after sending a "STARTTLS"-type command), TlsConnection will handle this for you automatically when you try to send or receive data on the connection. You can call g_tls_connection_handshake() manually if you want to know whether the initial handshake succeeded or failed (as opposed to just immediately trying to use conn to read or write, in which case, if it fails, it may not be possible to tell if it failed before or after completing the handshake), but beware that servers may reject client authentication after the handshake has completed, so a successful handshake does not indicate the connection will be usable.

Likewise, on the server side, although a handshake is necessary at the beginning of the communication, you do not need to call this function explicitly unless you want clearer error reporting.

Previously, calling g_tls_connection_handshake() after the initial handshake would trigger a rehandshake; however, this usage was deprecated in GLib 2.60 because rehandshaking was removed from the TLS protocol in TLS 1.3. Since GLib 2.64, calling this function after the initial handshake will no longer do anything.

When using a TlsConnection created by SocketClient, the SocketClient performs the initial handshake, so calling this function manually is not recommended.

TlsConnection::accept_certificate may be emitted during the handshake.

Since glibmm 2.28:
Parameters
cancellableA Cancellable, or nullptr.
Returns
Success or failure.
Exceptions
Glib::Error

◆ handshake_async() [1/2]

void Gio::TlsConnection::handshake_async ( const SlotAsyncReady &  slot,
const Glib::RefPtr< Cancellable > &  cancellable,
int  io_priority = Glib::PRIORITY_DEFAULT 
)

Asynchronously performs a TLS handshake on conn.

See g_tls_connection_handshake() for more information.

Since glibmm 2.28:
Parameters
io_priorityThe [I/O priority][io-priority] of the request.
cancellableA Cancellable, or nullptr.
slotCallback to call when the handshake is complete.

◆ handshake_async() [2/2]

void Gio::TlsConnection::handshake_async ( const SlotAsyncReady &  slot,
int  io_priority = Glib::PRIORITY_DEFAULT 
)

A handshake_async() convenience overload.

◆ handshake_async_vfunc()

virtual void Gio::TlsConnection::handshake_async_vfunc ( const SlotAsyncReady &  slot,
const Glib::RefPtr< Cancellable > &  cancellable,
int  io_priority 
)
protectedvirtual

◆ handshake_finish()

bool Gio::TlsConnection::handshake_finish ( const Glib::RefPtr< AsyncResult > &  result)

Finish an asynchronous TLS handshake operation.

See g_tls_connection_handshake() for more information.

Since glibmm 2.28:
Parameters
resultA AsyncResult.
Returns
true on success, false on failure, in which case error will be set.
Exceptions
Glib::Error

◆ handshake_finish_vfunc()

virtual bool Gio::TlsConnection::handshake_finish_vfunc ( const Glib::RefPtr< AsyncResult > &  result)
protectedvirtual
Exceptions
Glib::Error.

◆ handshake_vfunc()

virtual bool Gio::TlsConnection::handshake_vfunc ( const Glib::RefPtr< Cancellable > &  cancellable)
protectedvirtual
Exceptions
Glib::Error.

◆ on_accept_certificate()

virtual bool Gio::TlsConnection::on_accept_certificate ( const Glib::RefPtr< const TlsCertificate > &  peer_cert,
TlsCertificateFlags  errors 
)
protectedvirtual

This is a default handler for the signal signal_accept_certificate().

◆ operator=()

TlsConnection & Gio::TlsConnection::operator= ( TlsConnection &&  src)
noexcept

◆ property_base_io_stream()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< IOStream > > Gio::TlsConnection::property_base_io_stream ( ) const

The IOStream that the connection wraps.

The connection holds a reference to this stream, and may run operations on the stream from other threads throughout its lifetime. Consequently, after the IOStream has been constructed, application code may only run its own operations on this stream when no IOStream operations are running.

Since glibmm 2.28:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_certificate() [1/2]

Glib::PropertyProxy< Glib::RefPtr< TlsCertificate > > Gio::TlsConnection::property_certificate ( )

The connection's certificate; see g_tls_connection_set_certificate().

Since glibmm 2.28:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_certificate() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsCertificate > > Gio::TlsConnection::property_certificate ( ) const

The connection's certificate; see g_tls_connection_set_certificate().

Since glibmm 2.28:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_ciphersuite_name()

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gio::TlsConnection::property_ciphersuite_name ( ) const

The name of the TLS ciphersuite in use.

See g_tls_connection_get_ciphersuite_name().

Since glibmm 2.70:

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_database() [1/2]

Glib::PropertyProxy< Glib::RefPtr< TlsDatabase > > Gio::TlsConnection::property_database ( )

The certificate database to use when verifying this TLS connection.

If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database().

When using a non-default database, TlsConnection must fall back to using the TlsDatabase to perform certificate verification using g_tls_database_verify_chain(), which means certificate verification will not be able to make use of TLS session context. This may be less secure. For example, if you create your own TlsDatabase that just wraps the default TlsDatabase, you might expect that you have not changed anything, but this is not true because you may have altered the behavior of TlsConnection by causing it to use g_tls_database_verify_chain(). See the documentation of g_tls_database_verify_chain() for more details on specific security checks that may not be performed. Accordingly, setting a non-default database is discouraged except for specialty applications with unusual security requirements.

Since glibmm 2.30:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_database() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsDatabase > > Gio::TlsConnection::property_database ( ) const

The certificate database to use when verifying this TLS connection.

If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database().

When using a non-default database, TlsConnection must fall back to using the TlsDatabase to perform certificate verification using g_tls_database_verify_chain(), which means certificate verification will not be able to make use of TLS session context. This may be less secure. For example, if you create your own TlsDatabase that just wraps the default TlsDatabase, you might expect that you have not changed anything, but this is not true because you may have altered the behavior of TlsConnection by causing it to use g_tls_database_verify_chain(). See the documentation of g_tls_database_verify_chain() for more details on specific security checks that may not be performed. Accordingly, setting a non-default database is discouraged except for specialty applications with unusual security requirements.

Since glibmm 2.30:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_interaction() [1/2]

Glib::PropertyProxy< Glib::RefPtr< TlsInteraction > > Gio::TlsConnection::property_interaction ( )

A TlsInteraction object to be used when the connection or certificate database need to interact with the user.

This will be used to prompt the user for passwords where necessary.

Since glibmm 2.30:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_interaction() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsInteraction > > Gio::TlsConnection::property_interaction ( ) const

A TlsInteraction object to be used when the connection or certificate database need to interact with the user.

This will be used to prompt the user for passwords where necessary.

Since glibmm 2.30:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_peer_certificate()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TlsCertificate > > Gio::TlsConnection::property_peer_certificate ( ) const

The connection's peer's certificate, after the TLS handshake has completed or failed.

Note in particular that this is not yet set during the emission of TlsConnection::signal_accept_certificate().

(You can watch for a Object::signal_notify() signal on this property to detect when a handshake has occurred.)

Since glibmm 2.28:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_peer_certificate_errors()

Glib::PropertyProxy_ReadOnly< TlsCertificateFlags > Gio::TlsConnection::property_peer_certificate_errors ( ) const

The errors noticed while verifying TlsConnection::property_peer_certificate().

Normally this should be 0, but it may not be if TlsClientConnection::property_validation_flags() is not Gio::TlsCertificateFlags::VALIDATE_ALL, or if TlsConnection::signal_accept_certificate() overrode the default behavior.

GLib guarantees that if certificate verification fails, at least one error will be set, 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.

Since glibmm 2.28:

Default value: Gio::TlsCertificateFlags::NO_FLAGS

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_protocol_version()

Glib::PropertyProxy_ReadOnly< TlsProtocolVersion > Gio::TlsConnection::property_protocol_version ( ) const

The TLS protocol version in use.

See g_tls_connection_get_protocol_version().

Since glibmm 2.70:

Default value: Gio::TlsProtocolVersion::UNKNOWN

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_require_close_notify() [1/2]

Glib::PropertyProxy< bool > Gio::TlsConnection::property_require_close_notify ( )

Whether or not proper TLS close notification is required.

See g_tls_connection_set_require_close_notify().

Since glibmm 2.28:

Default value: true

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_require_close_notify() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gio::TlsConnection::property_require_close_notify ( ) const

Whether or not proper TLS close notification is required.

See g_tls_connection_set_require_close_notify().

Since glibmm 2.28:

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ set_certificate()

void Gio::TlsConnection::set_certificate ( const Glib::RefPtr< TlsCertificate > &  certificate)

This sets the certificate that conn will present to its peer during the TLS handshake.

For a TlsServerConnection, it is mandatory to set this, and that will normally be done at construct time.

For a TlsClientConnection, this is optional. If a handshake fails with Gio::TlsError::CERTIFICATE_REQUIRED, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call g_tls_client_connection_get_accepted_cas() on the failed connection to get a list of Certificate Authorities that the server will accept certificates from.

(It is also possible that a server will allow the connection with or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_tls_client_connection_get_accepted_cas() will return non-nullptr.)

Since glibmm 2.28:
Parameters
certificateThe certificate to use for conn.

◆ set_database()

void Gio::TlsConnection::set_database ( const Glib::RefPtr< TlsDatabase > &  database)

Sets the certificate database that is used to verify peer certificates.

This is set to the default database by default. See g_tls_backend_get_default_database(). If set to nullptr, then peer certificate validation will always set the Gio::TlsCertificateFlags::UNKNOWN_CA error (meaning TlsConnection::signal_accept_certificate() will always be emitted on client-side connections, unless that bit is not set in TlsClientConnection::property_validation_flags()).

There are nonintuitive security implications when using a non-default database. See TlsConnection::property_database() for details.

Since glibmm 2.30:
Parameters
databaseA TlsDatabase.

◆ set_interaction()

void Gio::TlsConnection::set_interaction ( const Glib::RefPtr< TlsInteraction > &  interaction)

Set the object that will be used to interact with the user.

It will be used for things like prompting the user for passwords.

The interaction argument will normally be a derived subclass of TlsInteraction. nullptr can also be provided if no user interaction should occur for this connection.

Since glibmm 2.30:
Parameters
interactionAn interaction object, or nullptr.

◆ set_require_close_notify()

void Gio::TlsConnection::set_require_close_notify ( bool  require_close_notify = true)

Sets whether or not conn expects a proper TLS close notification before the connection is closed.

If this is true (the default), then conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a Gio::TlsError::EOF error if the connection is closed without proper notification (since this may indicate a network error, or man-in-the-middle attack).

In some protocols, the application will know whether or not the connection was closed cleanly based on application-level data (because the application-level data includes a length field, or is somehow self-delimiting); in this case, the close notify is redundant and sometimes omitted. (TLS 1.1 explicitly allows this; in TLS 1.0 it is technically an error, but often done anyway.) You can use g_tls_connection_set_require_close_notify() to tell conn to allow an "unannounced" connection close, in which case the close will show up as a 0-length read, as in a non-TLS SocketConnection, and it is up to the application to check that the data has been fully received.

Note that this only affects the behavior when the peer closes the connection; when the application calls g_io_stream_close() itself on conn, this will send a close notification regardless of the setting of this property. If you explicitly want to do an unclean close, you can close conn's TlsConnection::property_base_io_stream() rather than closing conn itself, but note that this may only be done when no other operations are pending on conn or the base I/O stream.

Since glibmm 2.28:
Parameters
require_close_notifyWhether or not to require close notification.

◆ signal_accept_certificate()

Glib::SignalProxy< bool(const Glib::RefPtr< const TlsCertificate > &, TlsCertificateFlags)> Gio::TlsConnection::signal_accept_certificate ( )
Slot Prototype:
bool on_my_accept_certificate(const Glib::RefPtr<const TlsCertificate>& peer_cert, TlsCertificateFlags errors)

Flags: Run Last

Emitted during the TLS handshake after the peer certificate has been received. You can examine peer_cert's certification path by calling g_tls_certificate_get_issuer() on it.

For a client-side connection, peer_cert is the server's certificate, and the signal will only be emitted if the certificate was not acceptable according to conn's TlsClientConnection::property_validation()_flags. If you would like the certificate to be accepted despite errors, return true from the signal handler. Otherwise, if no handler accepts the certificate, the handshake will fail with Gio::TlsError::BAD_CERTIFICATE.

GLib guarantees that if certificate verification fails, this signal will be emitted with at least one error will be set in errors, 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 ignore 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.

For a server-side connection, peer_cert is the certificate presented by the client, if this was requested via the server's TlsServerConnection::property_authentication()_mode. On the server side, the signal is always emitted when the client presents a certificate, and the certificate will only be accepted if a handler returns true.

Note that if this signal is emitted as part of asynchronous I/O in the main thread, then you should not attempt to interact with the user before returning from the signal handler. If you want to let the user decide whether or not to accept the certificate, you would have to return false from the signal handler on the first attempt, and then after the connection attempt returns a Gio::TlsError::BAD_CERTIFICATE, you can interact with the user, and if the user decides to accept the certificate, remember that fact, create a new connection, and return true from the signal handler the next time.

If you are doing I/O in another thread, you do not need to worry about this, and can simply block in the signal handler until the UI thread returns an answer.

Since glibmm 2.28:
Parameters
peer_certThe peer's TlsCertificate.
errorsThe problems with peer_cert.
Returns
true to accept peer_cert (which will also immediately end the signal emission). false to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gio::TlsConnection > wrap ( GTlsConnection *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.