Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.IOStream
Gio.TlsConnection

Class Gio.TlsConnection

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GTlsConnection
Class :	TlsConnection
Extends:	Gio.IOStream

GTlsConnection is the base TLS connection class type, which wraps
a GIOStream and provides TLS encryption on top of it. Its
subclasses, GTlsClientConnection and GTlsServerConnection,
implement client-side and server-side TLS, respectively.

Properties
Properties		Defined By
	base_io_stream : Gio.IOStream The GIOStream that the connection wraps The GIOStream that the connection wraps	Gio.TlsConnection
	certificate : Gio.TlsCertificate The connection's certificate; see g_tls_connection_set_certificate(). The connection's certificate; see g_tls_connection_set_certificate().	Gio.TlsConnection
	closed : gboolean	Gio.IOStream
	input_stream : Gio.InputStream read only	Gio.IOStream
	output_stream : Gio.OutputStream read only	Gio.IOStream
	parent_instance : Gio.IOStream read only	Gio.TlsConnection
	peer_certificate : Gio.TlsCertificate read only The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. The connection's peer's certificate, after the TLS handshake has completed and the certificate has been accepted. Note in particular that this is not yet set during the emission of GTlsConnection::accept-certificate. (You can watch for a GObject::notify signal on this property to detect when a handshake has occurred.)	Gio.TlsConnection
	peer_certificate_errors : Gio.TlsCertificateFlags read only The errors noticed-and-ignored while verifying GTlsConnection:peer-certificate. The errors noticed-and-ignored while verifying GTlsConnection:peer-certificate. Normally this should be %0, but it may not be if GTlsClientConnection::validation-flags is not G_TLS_CERTIFICATE_VALIDATE_ALL, or if GTlsConnection::accept-certificate overrode the default behavior.	Gio.TlsConnection
	priv : Gio.TlsConnectionPrivate read only	Gio.TlsConnection
	rehandshake_mode : Gio.TlsRehandshakeMode The rehandshaking mode. The rehandshaking mode. See g_tls_connection_set_rehandshake_mode().	Gio.TlsConnection
	require_close_notify : gboolean Whether or not proper TLS close notification is required. Whether or not proper TLS close notification is required. See g_tls_connection_set_require_close_notify().	Gio.TlsConnection
	use_system_certdb : gboolean Whether or not the system certificate database will be used to verify peer certificates. Whether or not the system certificate database will be used to verify peer certificates. See g_tls_connection_set_use_system_certdb().	Gio.TlsConnection

Methods / Constructors
Method / Constructor		Defined By
	new Gio.TlsConnection (Object *properties) Create a new Gio.TlsConnection Create a new Gio.TlsConnection Parameters: Object properties*
	clear_pending () : none Clears the pending flag on stream. Clears the pending flag on stream. Returns: none	Gio.IOStream
	close (Cancellable *cancellable) : gboolean Closes the stream, releasing resources related to it. Closes the stream, releasing resources related to it. This will also closes the individual input and output streams, if they are not already closed. Once the stream is closed, all other operations will return G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. Closing a stream will automatically flush any outstanding buffers in the stream. Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details. On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still return G_IO_ERROR_CLOSED* for all operations. Still, it is important to check and report the error to the user, otherwise there might be a loss of data as all data might not be written. If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors. The default implementation of this method just calls close on the individual input/output streams. Parameters: Gio.Cancellable cancellable optional GCancellable object, NULL to ignore Returns: gboolean TRUE on success, FALSE on failure	Gio.IOStream
	close_async (gint32 *io_priority, Cancellable cancellable, Function callback, void *user_data) : none Requests an asynchronous close of the stream, releasing resources related to it. Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback* will be called. You can then call g_io_stream_close_finish() to get the result of the operation. For behaviour details see g_io_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. Parameters: gint32 io_priority Required (not null) the io priority of the request Gio.Cancellable cancellable optional cancellable object Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the request is satisfied void user_data Required (not null) the data to pass to callback function Returns: none	Gio.IOStream
	close_finish (AsyncResult *result) : gboolean Closes a stream. Closes a stream. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult Returns: gboolean TRUE if stream was successfully closed, FALSE otherwise.	Gio.IOStream
	emit_accept_certificate (TlsCertificate *peer_cert, TlsCertificateFlags errors) : gboolean Used by GTlsConnection* implementations to emit the GTlsConnection::accept-certificate signal. Used by GTlsConnection implementations to emit the GTlsConnection::accept-certificate signal. TRUE to accept peer_cert Parameters: Gio.TlsCertificate peer_cert Required (not null) the peer's GTlsCertificate Gio.TlsCertificateFlags errors Required (not null) the problems with peer_cert Returns: gboolean TRUE if one of the signal handlers has returned	Gio.TlsConnection
	get_certificate () : Gio.TlsCertificate Gets conn's certificate, as set by g_tls_connection_set_certificate(). Gets conn's certificate, as set by g_tls_connection_set_certificate(). Returns: Gio.TlsCertificate conn's certificate, or NULL	Gio.TlsConnection
	get_input_stream () : Gio.InputStream Gets the input stream for this object. Gets the input stream for this object. This is used for reading. Do not free. Returns: Gio.InputStream a GInputStream, owned by the GIOStream.	Gio.IOStream
	get_output_stream () : Gio.OutputStream Gets the output stream for this object. Gets the output stream for this object. This is used for writing. Do not free. Returns: Gio.OutputStream a GOutputStream, owned by the GIOStream.	Gio.IOStream
	get_peer_certificate () : Gio.TlsCertificate Gets conn's peer's certificate after the handshake has completed. Gets conn's peer's certificate after the handshake has completed. (It is not set during the emission of GTlsConnection::accept-certificate.) Returns: Gio.TlsCertificate conn's peer's certificate, or NULL	Gio.TlsConnection
	get_peer_certificate_errors () : Gio.TlsCertificateFlags Gets the errors associated with validating conn's peer's certificate, after the handshake has completed. Gets the errors associated with validating conn's peer's certificate, after the handshake has completed. (It is not set during the emission of GTlsConnection::accept-certificate.) Returns: Gio.TlsCertificateFlags conn's peer's certificate errors	Gio.TlsConnection
	get_rehandshake_mode () : Gio.TlsRehandshakeMode Gets conn rehandshaking mode. Gets conn rehandshaking mode. See g_tls_connection_set_rehandshake() for details. Returns: Gio.TlsRehandshakeMode conn's rehandshaking mode	Gio.TlsConnection
	get_require_close_notify () : gboolean Tests whether or not conn expects a proper TLS close notification when the connection is closed. 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. notification. Returns: gboolean TRUE if conn requires a proper TLS close	Gio.TlsConnection
	get_use_system_certdb () : gboolean Gets whether conn uses the system certificate database to verify peer certificates. Gets whether conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Returns: gboolean whether conn uses the system certificate database	Gio.TlsConnection
	handshake (Cancellable *cancellable) : gboolean Attempts a TLS handshake on conn. 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. GTlsConnection::accept_certificate may be emitted during the handshake. Parameters: Gio.Cancellable cancellable a GCancellable, or NULL Returns: gboolean success or failure	Gio.TlsConnection
	handshake_async (gint32 *io_priority, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously performs a TLS handshake on conn. Asynchronously performs a TLS handshake on conn. See g_tls_connection_handshake() for more information. Parameters: gint32 io_priority* Required (not null) the I/O priority of the request. Gio.Cancellable cancellable a GCancellable, or NULL Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the handshake is complete void user_data Required (not null) the data to pass to the callback function Returns: none	Gio.TlsConnection
	handshake_finish (AsyncResult *result) : gboolean Finish an asynchronous TLS handshake operation. Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. case error* will be set. Parameters: Gio.AsyncResult result Required (not null) a GAsyncResult. Returns: gboolean TRUE on success, FALSE on failure, in which	Gio.TlsConnection
	has_pending () : gboolean Checks if a stream has pending actions. Checks if a stream has pending actions. Returns: gboolean TRUE if stream has pending actions.	Gio.IOStream
	is_closed () : gboolean Checks if a stream is closed. Checks if a stream is closed. Returns: gboolean TRUE if the stream is closed.	Gio.IOStream
	set_certificate (TlsCertificate *certificate) : none This sets the certificate that conn* will present to its peer during the TLS handshake. 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.) Parameters: Gio.TlsCertificate certificate Required (not null) the certificate to use for conn Returns: none	Gio.TlsConnection
	set_pending () : gboolean Sets stream to have actions pending. Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set Returns: gboolean TRUE if pending was previously unset and is now set.	Gio.IOStream
	set_rehandshake_mode (TlsRehandshakeMode *mode) : none Sets how conn* behaves with respect to rehandshaking requests. 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. Parameters: Gio.TlsRehandshakeMode mode Required (not null) the rehandshaking mode Returns: none	Gio.TlsConnection
	set_require_close_notify (gboolean *require_close_notify) : none Sets whether or not conn* expects a proper TLS close notification before the connection is closed. 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 GTlsConnection:base-io-stream rather than closing conn itself. Parameters: gboolean require_close_notify Required (not null) whether or not to require close notification Returns: none	Gio.TlsConnection
	set_use_system_certdb (gboolean *use_system_certdb) : none Sets whether conn* uses the system certificate database to verify peer certificates. 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 GTlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in GTlsClientConnection:validation-flags). Parameters: gboolean use_system_certdb Required (not null) whether to use the system certificate database Returns: none	Gio.TlsConnection
	splice_async (IOStream *stream2, IOStreamSpliceFlags flags, gint32 io_priority, Cancellable cancellable, Function callback, void *user_data) : none Asyncronously splice the output stream of stream1 to the input stream of When the operation is finished callback* will be called. Asyncronously splice the output stream of stream1 to the input stream of When the operation is finished callback will be called. You can then call g_io_stream_splice_finish() to get the result of the operation. Parameters: Gio.IOStream stream2 Required (not null) a GIOStream. Gio.IOStreamSpliceFlags flags Required (not null) a set of GIOStreamSpliceFlags. gint32 io_priority Required (not null) the io priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback. void user_data Required (not null) user data passed to callback. Returns: none	Gio.IOStream

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	accept_certificate (TlsConnection *self, TlsCertificate peer_cert, TlsCertificateFlags errors) : gboolean Emitted during the TLS handshake after the peer certificate has been received. 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 GTlsClientConnection: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 GTlsServerConnection: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. 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. Parameters: Gio.TlsConnection self Gio.TlsCertificate peer_cert Gio.TlsCertificateFlags errors Returns: {gboolean}	Gio.TlsConnection