TlsClientConnection

GTlsClientConnection is the client-side subclass of GTlsConnection, representing a client-side TLS connection.

Constructors

this
this(GTlsClientConnection* gTlsClientConnection)

Sets our main struct and passes it to the parent class

this
this(IOStream baseIoStream, SocketConnectableIF serverIdentity)

Creates a new GTlsClientConnection wrapping base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by server_identity. Since 2.28

Members

Functions

getAcceptedCas
ListG getAcceptedCas()

Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be NULL. Each item in the list is a GByteArray which contains the complete subject DN of the certificate authority. Since 2.28

getServerIdentity
SocketConnectableIF getServerIdentity()

Gets conn's expected server identity Since 2.28

getStruct
void* getStruct()

the main Gtk struct as a void*

getTlsClientConnectionStruct
GTlsClientConnection* getTlsClientConnectionStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getUseSsl3
int getUseSsl3()

Gets whether conn will use SSL 3.0 rather than the highest-supported version of TLS; see g_tls_client_connection_set_use_ssl3(). Since 2.28

getValidationFlags
GTlsCertificateFlags getValidationFlags()

Gets conn's validation flags Since 2.28

setServerIdentity
void setServerIdentity(SocketConnectableIF identity)

Sets conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let conn know what name to look for in the certificate when performing G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. Since 2.28

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setUseSsl3
void setUseSsl3(int useSsl3)

If use_ssl3 is TRUE, this forces conn to use SSL 3.0 rather than trying to properly negotiate the right version of TLS or SSL to use. This can be used when talking to servers that do not implement the fallbacks correctly and which will therefore fail to handshake with a "modern" TLS handshake attempt. Since 2.28

setValidationFlags
void setValidationFlags(GTlsCertificateFlags flags)

Sets conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, G_TLS_CERTIFICATE_VALIDATE_ALL is used. Since 2.28

Variables

gTlsClientConnection
GTlsClientConnection* gTlsClientConnection;

the main Gtk struct

Inherited Members

From TlsConnection

gTlsConnection
GTlsConnection* gTlsConnection;

the main Gtk struct

getTlsConnectionStruct
GTlsConnection* getTlsConnectionStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
onAcceptCertificateListeners
bool delegate(TlsCertificate, GTlsCertificateFlags, TlsConnection)[] onAcceptCertificateListeners;
Undocumented in source.
addOnAcceptCertificate
void addOnAcceptCertificate(bool delegate(TlsCertificate, GTlsCertificateFlags, TlsConnection) dlg, ConnectFlags connectFlags)

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 "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 G_TLS_ERROR_BAD_CERTIFICATE. For a server-side connection, peer_cert is the certificate presented by the client, if this was requested via the server's "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 G_TLS_ERROR_HANDSHAKE, 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. 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. Since 2.28

callBackAcceptCertificate
gboolean callBackAcceptCertificate(GTlsConnection* connStruct, GTlsCertificate* peerCert, GTlsCertificateFlags errors, TlsConnection _tlsConnection)
Undocumented in source. Be warned that the author may not have intended to support it.
setCertificate
void setCertificate(TlsCertificate certificate)

This sets the certificate that conn will present to its peer during the TLS handshake. For a GTlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. For a GTlsClientConnection, this is optional. If a handshake fails with G_TLS_ERROR_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-NULL.) Since 2.28

getCertificate
TlsCertificate getCertificate()

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

getPeerCertificate
TlsCertificate getPeerCertificate()

Gets conn's peer's certificate after the handshake has completed. (It is not set during the emission of "accept-certificate".) Since 2.28

getPeerCertificateErrors
GTlsCertificateFlags getPeerCertificateErrors()

Gets the errors associated with validating conn's peer's certificate, after the handshake has completed. (It is not set during the emission of "accept-certificate".) Since 2.28

setRequireCloseNotify
void setRequireCloseNotify(int requireCloseNotify)

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 G_TLS_ERROR_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 GSocketConnection, 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 "base-io-stream" rather than closing conn itself. Since 2.28

getRequireCloseNotify
int getRequireCloseNotify()

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 2.28

setRehandshakeMode
void setRehandshakeMode(GTlsRehandshakeMode mode)

Sets how conn behaves with respect to rehandshaking requests. G_TLS_REHANDSHAKE_NEVER means that it will never agree to rehandshake after the initial handshake is complete. (For a client, this means it will refuse rehandshake requests from the server, and for a server, this means it will close the connection with an error if the client attempts to rehandshake.) G_TLS_REHANDSHAKE_SAFELY means that the connection will allow a rehandshake only if the other end of the connection supports the TLS renegotiation_info extension. This is the default behavior, but means that rehandshaking will not work against older implementations that do not support that extension. G_TLS_REHANDSHAKE_UNSAFELY means that the connection will allow rehandshaking even without the renegotiation_info extension. On the server side in particular, this is not recommended, since it leaves the server open to certain attacks. However, this mode is necessary if you need to allow renegotiation with older client software. Since 2.28

getRehandshakeMode
GTlsRehandshakeMode getRehandshakeMode()

Gets conn rehandshaking mode. See g_tls_connection_set_rehandshake_mode() for details. Since 2.28

setUseSystemCertdb
void setUseSystemCertdb(int useSystemCertdb)

Warning g_tls_connection_set_use_system_certdb has been deprecated since version 2.30 and should not be used in newly-written code. Use g_tls_connection_set_database() instead Sets whether conn uses the system certificate database to verify peer certificates. This is TRUE by default. If set to FALSE, then peer certificate validation will always set the G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning "accept-certificate" will always be emitted on client-side connections, unless that bit is not set in "validation-flags").

getUseSystemCertdb
int getUseSystemCertdb()

Warning g_tls_connection_get_use_system_certdb has been deprecated since version 2.30 and should not be used in newly-written code. Use g_tls_connection_get_database() instead Gets whether conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb().

getDatabase
TlsDatabase getDatabase()

Gets the certificate database that conn uses to verify peer certificates. See g_tls_connection_set_database(). Since 2.30

setDatabase
void setDatabase(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 NULL, then peer certificate validation will always set the G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning "accept-certificate" will always be emitted on client-side connections, unless that bit is not set in "validation-flags"). Since 2.30

getInteraction
TlsInteraction getInteraction()

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 NULL is returned, then no user interaction will occur for this connection. Since 2.30

setInteraction
void setInteraction(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 GTlsInteraction. NULL can also be provided if no user interaction should occur for this connection. Since 2.30

handshake
int handshake(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) and may need to rehandshake later if the server requests it, GTlsConnection will handle this for you automatically when you try to send or receive data on the connection. However, you can call g_tls_connection_handshake() manually if you want to know for sure whether the initial handshake succeeded or failed (as opposed to just immediately trying to write to conn's output stream, in which case if it fails, it may not be possible to tell if it failed before or after completing the handshake). 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. However, you may call g_tls_connection_handshake() later on to renegotiate parameters (encryption methods, etc) with the client. "accept_certificate" may be emitted during the handshake. Since 2.28

handshakeAsync
void handshakeAsync(int ioPriority, Cancellable cancellable, GAsyncReadyCallback callback, void* userData)

Asynchronously performs a TLS handshake on conn. See g_tls_connection_handshake() for more information. Since 2.28

handshakeFinish
int handshakeFinish(GAsyncResult* result)

Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. Since 2.28

emitAcceptCertificate
int emitAcceptCertificate(TlsCertificate peerCert, GTlsCertificateFlags errors)

Used by GTlsConnection implementations to emit the "accept-certificate" signal. Since 2.28

Meta