gi-gio-2.0.12: Gio bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.TlsConnection

Contents

Description

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

For DTLS (Datagram TLS) support, see DtlsConnection.

Synopsis

Exported types

Methods

emitAcceptCertificate

tlsConnectionEmitAcceptCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) 
=> a

conn: a TlsConnection

-> b

peerCert: the peer's TlsCertificate

-> [TlsCertificateFlags]

errors: the problems with peerCert

-> m Bool

Returns: True if one of the signal handlers has returned True to accept peerCert

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

Since: 2.28

getCertificate

tlsConnectionGetCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m TlsCertificate

Returns: conn's certificate, or Nothing

Gets conn's certificate, as set by tlsConnectionSetCertificate.

Since: 2.28

getDatabase

tlsConnectionGetDatabase Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m TlsDatabase

Returns: the certificate database that conn uses or Nothing

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

Since: 2.30

getInteraction

tlsConnectionGetInteraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a connection

-> m TlsInteraction

Returns: The interaction object.

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

Since: 2.30

getPeerCertificate

tlsConnectionGetPeerCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m TlsCertificate

Returns: conn's peer's certificate, or Nothing

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

Since: 2.28

getPeerCertificateErrors

tlsConnectionGetPeerCertificateErrors Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m [TlsCertificateFlags]

Returns: conn's peer's certificate errors

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

Since: 2.28

getRehandshakeMode

tlsConnectionGetRehandshakeMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m TlsRehandshakeMode

Returns: conn's rehandshaking mode

Gets conn rehandshaking mode. See tlsConnectionSetRehandshakeMode for details.

Since: 2.28

getRequireCloseNotify

tlsConnectionGetRequireCloseNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m Bool

Returns: True if conn requires a proper TLS close notification.

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

Since: 2.28

getUseSystemCertdb

tlsConnectionGetUseSystemCertdb Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> m Bool

Returns: whether conn uses the system certificate database

Deprecated: (Since version 2.30)Use tlsConnectionGetDatabase instead

Gets whether conn uses the system certificate database to verify peer certificates. See tlsConnectionSetUseSystemCertdb.

handshake

tlsConnectionHandshake Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) 
=> a

conn: a TlsConnection

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

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, TlsConnection will handle this for you automatically when you try to send or receive data on the connection. However, you can call tlsConnectionHandshake 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 tlsConnectionHandshake later on to renegotiate parameters (encryption methods, etc) with the client.

TlsConnection::accept_certificate may be emitted during the handshake.

Since: 2.28

handshakeAsync

tlsConnectionHandshakeAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsCancellable b) 
=> a

conn: a TlsConnection

-> Int32

ioPriority: the [I/O priority][io-priority] of the request

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to call when the handshake is complete

-> m () 

Asynchronously performs a TLS handshake on conn. See tlsConnectionHandshake for more information.

Since: 2.28

handshakeFinish

tlsConnectionHandshakeFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsAsyncResult b) 
=> a

conn: a TlsConnection

-> b

result: a AsyncResult.

-> m ()

(Can throw GError)

Finish an asynchronous TLS handshake operation. See tlsConnectionHandshake for more information.

Since: 2.28

setCertificate

tlsConnectionSetCertificate Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsCertificate b) 
=> a

conn: a TlsConnection

-> b

certificate: the certificate to use for conn

-> m () 

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 TlsErrorCertificateRequired, that means that the server requires a certificate, and if you try connecting again, you should call this method first. You can call tlsClientConnectionGetAcceptedCas 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 tlsClientConnectionGetAcceptedCas will return non-Nothing.)

Since: 2.28

setDatabase

tlsConnectionSetDatabase Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsDatabase b) 
=> a

conn: a TlsConnection

-> b

database: a TlsDatabase

-> m () 

Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See tlsBackendGetDefaultDatabase. If set to Nothing, then peer certificate validation will always set the TlsCertificateFlagsUnknownCa error (meaning TlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in TlsClientConnection:validation-flags).

Since: 2.30

setInteraction

tlsConnectionSetInteraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a, IsTlsInteraction b) 
=> a

conn: a connection

-> Maybe b

interaction: an interaction object, or Nothing

-> m () 

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

Since: 2.30

setRehandshakeMode

tlsConnectionSetRehandshakeMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> TlsRehandshakeMode

mode: the rehandshaking mode

-> m () 

Sets how conn behaves with respect to rehandshaking requests.

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

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

TlsRehandshakeModeUnsafely 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

setRequireCloseNotify

tlsConnectionSetRequireCloseNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> Bool

requireCloseNotify: whether or not to require close notification

-> m () 

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 TlsErrorEof 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 tlsConnectionSetRequireCloseNotify 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 iOStreamClose 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: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: 2.28

setUseSystemCertdb

tlsConnectionSetUseSystemCertdb Source #

Arguments

:: (HasCallStack, MonadIO m, IsTlsConnection a) 
=> a

conn: a TlsConnection

-> Bool

useSystemCertdb: whether to use the system certificate database

-> m () 

Deprecated: (Since version 2.30)Use tlsConnectionSetDatabase 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 TlsCertificateFlagsUnknownCa error (meaning TlsConnection::accept-certificate will always be emitted on client-side connections, unless that bit is not set in TlsClientConnection:validation-flags).

Properties

baseIoStream

data TlsConnectionBaseIoStreamPropertyInfo Source #

Instances

AttrInfo TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrOrigin TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrLabel TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrGetType TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionBaseIoStreamPropertyInfo Source # 
type AttrAllowedOps TlsConnectionBaseIoStreamPropertyInfo Source # 

certificate

data TlsConnectionCertificatePropertyInfo Source #

Instances

AttrInfo TlsConnectionCertificatePropertyInfo Source # 
type AttrOrigin TlsConnectionCertificatePropertyInfo Source # 
type AttrLabel TlsConnectionCertificatePropertyInfo Source # 
type AttrGetType TlsConnectionCertificatePropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionCertificatePropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionCertificatePropertyInfo Source # 
type AttrAllowedOps TlsConnectionCertificatePropertyInfo Source # 

database

data TlsConnectionDatabasePropertyInfo Source #

Instances

AttrInfo TlsConnectionDatabasePropertyInfo Source # 
type AttrOrigin TlsConnectionDatabasePropertyInfo Source # 
type AttrLabel TlsConnectionDatabasePropertyInfo Source # 
type AttrGetType TlsConnectionDatabasePropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionDatabasePropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionDatabasePropertyInfo Source # 
type AttrAllowedOps TlsConnectionDatabasePropertyInfo Source # 

interaction

data TlsConnectionInteractionPropertyInfo Source #

Instances

AttrInfo TlsConnectionInteractionPropertyInfo Source # 
type AttrOrigin TlsConnectionInteractionPropertyInfo Source # 
type AttrLabel TlsConnectionInteractionPropertyInfo Source # 
type AttrGetType TlsConnectionInteractionPropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionInteractionPropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionInteractionPropertyInfo Source # 
type AttrAllowedOps TlsConnectionInteractionPropertyInfo Source # 

peerCertificate

data TlsConnectionPeerCertificatePropertyInfo Source #

Instances

AttrInfo TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrOrigin TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrLabel TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrGetType TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionPeerCertificatePropertyInfo Source # 
type AttrAllowedOps TlsConnectionPeerCertificatePropertyInfo Source # 

peerCertificateErrors

data TlsConnectionPeerCertificateErrorsPropertyInfo Source #

Instances

AttrInfo TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrOrigin TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrLabel TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrGetType TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionPeerCertificateErrorsPropertyInfo Source # 
type AttrAllowedOps TlsConnectionPeerCertificateErrorsPropertyInfo Source # 

rehandshakeMode

data TlsConnectionRehandshakeModePropertyInfo Source #

Instances

AttrInfo TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrOrigin TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrLabel TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrGetType TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionRehandshakeModePropertyInfo Source # 
type AttrAllowedOps TlsConnectionRehandshakeModePropertyInfo Source # 

requireCloseNotify

data TlsConnectionRequireCloseNotifyPropertyInfo Source #

Instances

AttrInfo TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrOrigin TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrLabel TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrGetType TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionRequireCloseNotifyPropertyInfo Source # 
type AttrAllowedOps TlsConnectionRequireCloseNotifyPropertyInfo Source # 

useSystemCertdb

data TlsConnectionUseSystemCertdbPropertyInfo Source #

Instances

AttrInfo TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrOrigin TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrLabel TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrGetType TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrBaseTypeConstraint TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrSetTypeConstraint TlsConnectionUseSystemCertdbPropertyInfo Source # 
type AttrAllowedOps TlsConnectionUseSystemCertdbPropertyInfo Source # 

Signals

acceptCertificate