class Gio::TlsConnection

Overview

#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.

For DTLS (Datagram TLS) support, see #GDtlsConnection.

Defined in:

lib/gi-crystal/src/auto/gio-2.0/tls_connection.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Gio::IOStream

==(other : self) ==, clear_pending : Nil clear_pending, close(cancellable : Gio::Cancellable | Nil) : Bool close, close_async(io_priority : Int32, cancellable : Gio::Cancellable | Nil, callback : Gio::AsyncReadyCallback | Nil, user_data : Pointer(Void) | Nil) : Nil close_async, close_finish(result : Gio::AsyncResult) : Bool close_finish, closed? : Bool closed?, has_pending : Bool has_pending, hash(hasher) hash, input_stream : Gio::InputStream input_stream, is_closed : Bool is_closed, output_stream : Gio::OutputStream output_stream, set_pending : Bool set_pending, splice_async(stream2 : Gio::IOStream, flags : Gio::IOStreamSpliceFlags, io_priority : Int32, cancellable : Gio::Cancellable | Nil, callback : Gio::AsyncReadyCallback | Nil, user_data : Pointer(Void) | Nil) : Nil splice_async, splice_finish(result : Gio::AsyncResult) : Bool splice_finish

Constructor methods inherited from class Gio::IOStream

new
new(*, closed : Bool | Nil = nil, input_stream : Gio::InputStream | Nil = nil, output_stream : Gio::OutputStream | Nil = nil)
new

Class methods inherited from class Gio::IOStream

g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new
new
, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Constructor Detail

def self.new #

Initialize a new TlsConnection.


[View source]
def self.new(*, advertised_protocols : Enumerable(String) | Nil = nil, base_io_stream : Gio::IOStream | Nil = nil, certificate : Gio::TlsCertificate | Nil = nil, ciphersuite_name : String | Nil = nil, closed : Bool | Nil = nil, database : Gio::TlsDatabase | Nil = nil, input_stream : Gio::InputStream | Nil = nil, interaction : Gio::TlsInteraction | Nil = nil, negotiated_protocol : String | Nil = nil, output_stream : Gio::OutputStream | Nil = nil, peer_certificate : Gio::TlsCertificate | Nil = nil, peer_certificate_errors : Gio::TlsCertificateFlags | Nil = nil, protocol_version : Gio::TlsProtocolVersion | Nil = nil, rehandshake_mode : Gio::TlsRehandshakeMode | Nil = nil, require_close_notify : Bool | Nil = nil, use_system_certdb : Bool | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def accept_certificate_signal #

[View source]
def advertised_protocols : Enumerable(String) #

[View source]
def advertised_protocols=(value : Enumerable(String)) : Enumerable(String) #

[View source]
def advertised_protocols=(protocols : Enumerable(String) | Nil) : Nil #

Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use g_tls_connection_get_negotiated_protocol() to find the negotiated protocol after the handshake. Specifying nil for the the value of protocols will disable ALPN negotiation.

See IANA TLS ALPN Protocol IDs for a list of registered protocol IDs.


[View source]
def base_io_stream : Gio::IOStream | Nil #

[View source]
def base_io_stream=(value : Gio::IOStream | Nil) : Gio::IOStream | Nil #

[View source]
def certificate : Gio::TlsCertificate | Nil #

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


[View source]
def certificate=(certificate : Gio::TlsCertificate) : Nil #

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-nil.)


[View source]
def certificate=(value : Gio::TlsCertificate | Nil) : Gio::TlsCertificate | Nil #

[View source]
def channel_binding_data(type : Gio::TlsChannelBindingType) : Bool #

Query the TLS backend for TLS channel binding data of type for conn.

This call retrieves TLS channel binding data as specified in RFC 5056, RFC 5929, and related RFCs. The binding data is returned in data. The data is resized by the callee using #GByteArray buffer management and will be freed when the data is destroyed by g_byte_array_unref(). If data is nil, it will only check whether TLS backend is able to fetch the data (e.g. whether type is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support type or the binding data is not available yet due to additional negotiation or input required.


[View source]
def ciphersuite_name : String | Nil #

Returns the name of the current TLS ciphersuite, or nil 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.


[View source]
def database : Gio::TlsDatabase | Nil #

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


[View source]
def database=(database : Gio::TlsDatabase | Nil) : Nil #

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 nil, 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).

There are nonintuitive security implications when using a non-default database. See #GDtlsConnection:database for details.


[View source]
def emit_accept_certificate(peer_cert : Gio::TlsCertificate, errors : Gio::TlsCertificateFlags) : Bool #

Used by #GTlsConnection implementations to emit the #GTlsConnection::accept-certificate signal.


[View source]
def handshake(cancellable : Gio::Cancellable | Nil) : Bool #

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), #GTlsConnection 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 #GTlsConnection created by #GSocketClient, the #GSocketClient performs the initial handshake, so calling this function manually is not recommended.

#GTlsConnection::accept_certificate may be emitted during the handshake.


[View source]
def handshake_async(io_priority : Int32, cancellable : Gio::Cancellable | Nil, callback : Gio::AsyncReadyCallback | Nil, user_data : Pointer(Void) | Nil) : Nil #

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


[View source]
def handshake_finish(result : Gio::AsyncResult) : Bool #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def interaction : Gio::TlsInteraction | Nil #

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


[View source]
def interaction=(interaction : Gio::TlsInteraction | Nil) : Nil #

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. nil can also be provided if no user interaction should occur for this connection.


[View source]
def negotiated_protocol : String | Nil #

Gets the name of the application-layer protocol negotiated during the handshake.

If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of conn's protocols, or the TLS backend does not support ALPN, then this will be nil. See g_tls_connection_set_advertised_protocols().


[View source]
def peer_certificate : Gio::TlsCertificate | Nil #

Gets conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GTlsConnection::accept-certificate.)


[View source]
def peer_certificate_errors : Gio::TlsCertificateFlags #

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 #GTlsConnection::accept-certificate.)

See #GTlsConnection:peer-certificate-errors for more information.


[View source]
def protocol_version : Gio::TlsProtocolVersion #

Returns the current TLS protocol version, which may be %G_TLS_PROTOCOL_VERSION_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 #GTlsProtocolVersion.


[View source]
def rehandshake_mode : Gio::TlsRehandshakeMode #

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

DEPRECATED


[View source]
def rehandshake_mode=(mode : Gio::TlsRehandshakeMode) : Nil #

Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations.

DEPRECATED


[View source]
def require_close_notify : Bool #

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.


[View source]
def require_close_notify=(require_close_notify : Bool) : Nil #

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, but note that this may only be done when no other operations are pending on conn or the base I/O stream.


[View source]
def require_close_notify? : Bool #

[View source]
def use_system_certdb : Bool #

Gets whether conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb().

DEPRECATED


[View source]
def use_system_certdb=(use_system_certdb : Bool) : Nil #

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).

DEPRECATED


[View source]
def use_system_certdb? : Bool #

[View source]