Skip to content

Gio.TlsInteraction

class — extends GObject.Object

GTlsInteraction provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords.

To use a GTlsInteraction with a TLS connection use TlsConnection.set_interaction.

Callers should instantiate a derived class that implements the various interaction methods to show the required dialogs.

Callers should use the 'invoke' functions like TlsInteraction.invoke_ask_password to run interaction methods. These functions make sure that the interaction is invoked in the main loop and not in the current thread, if the current thread is not running the main loop.

Derived classes can choose to implement whichever interactions methods they’d like to support by overriding those virtual methods in their class initialization function. Any interactions not implemented will return G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, it must also implement the corresponding finish method.

Methods

ask_password

def ask_password(self, password: TlsPassword, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Run synchronous interaction to ask the user for a password. In general, TlsInteraction.invoke_ask_password should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

ask_password_async

def ask_password_async(self, password: TlsPassword, cancellable: Cancellable | None = ..., callback: Callable[[TlsInteraction | None, AsyncResult], None] | None = ...) -> None

Run asynchronous interaction to ask the user for a password. In general, TlsInteraction.invoke_ask_password should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Certain implementations may not support immediate cancellation.

Parameters:

  • password — a TlsPassword object
  • cancellable — an optional Cancellable cancellation object
  • callback — will be called when the interaction completes

ask_password_finish

def ask_password_finish(self, result: AsyncResult) -> TlsInteractionResult

Complete an ask password user interaction request. This should be once the TlsInteraction.ask_password_async completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the TlsPassword passed to TlsInteraction.ask_password will have its password filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

  • result — the result passed to the callback

invoke_ask_password

def invoke_ask_password(self, password: TlsPassword, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the GLib.MainContext returned by GLib.MainContext.get_thread_default when the interaction is created. This is called by called by TlsConnection or TlsDatabase to ask the user for a password.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

invoke_request_certificate

def invoke_request_certificate(self, connection: TlsConnection, flags: TlsCertificateRequestFlags | int, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the GLib.MainContext returned by GLib.MainContext.get_thread_default when the interaction is created. This is called by called by TlsConnection when the peer requests a certificate during the handshake.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which may or may not abort the TLS connection.

The implementation can either be a synchronous (eg: modal dialog) or an asynchronous one (eg: modeless dialog). This function will take care of calling which ever one correctly.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

  • connection — a TlsConnection object
  • flags — flags providing more information about the request
  • cancellable — an optional Cancellable cancellation object

request_certificate

def request_certificate(self, connection: TlsConnection, flags: TlsCertificateRequestFlags | int, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, TlsInteraction.invoke_request_certificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

If TlsInteractionResult.HANDLED is returned, then the TlsConnection passed to TlsInteraction.request_certificate will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

  • connection — a TlsConnection object
  • flags — flags providing more information about the request
  • cancellable — an optional Cancellable cancellation object

request_certificate_async

def request_certificate_async(self, connection: TlsConnection, flags: TlsCertificateRequestFlags | int, cancellable: Cancellable | None = ..., callback: Callable[[TlsInteraction | None, AsyncResult], None] | None = ...) -> None

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, TlsInteraction.invoke_request_certificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

Parameters:

  • connection — a TlsConnection object
  • flags — flags providing more information about the request
  • cancellable — an optional Cancellable cancellation object
  • callback — will be called when the interaction completes

request_certificate_finish

def request_certificate_finish(self, result: AsyncResult) -> TlsInteractionResult

Complete a request certificate user interaction request. This should be once the TlsInteraction.request_certificate_async completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the TlsConnection passed to TlsInteraction.request_certificate_async will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

  • result — the result passed to the callback

Virtual methods

do_ask_password

def do_ask_password(self, password: TlsPassword, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Run synchronous interaction to ask the user for a password. In general, TlsInteraction.invoke_ask_password should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

do_ask_password_async

def do_ask_password_async(self, password: TlsPassword, cancellable: Cancellable | None = ..., callback: Callable[[TlsInteraction | None, AsyncResult], None] | None = ...) -> None

Run asynchronous interaction to ask the user for a password. In general, TlsInteraction.invoke_ask_password should be used instead of this function.

Derived subclasses usually implement a password prompt, although they may also choose to provide a password from elsewhere. The password value will be filled in and then callback will be called. Alternatively the user may abort this password request, which will usually abort the TLS connection.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Certain implementations may not support immediate cancellation.

Parameters:

  • password — a TlsPassword object
  • cancellable — an optional Cancellable cancellation object
  • callback — will be called when the interaction completes

do_ask_password_finish

def do_ask_password_finish(self, result: AsyncResult) -> TlsInteractionResult

Complete an ask password user interaction request. This should be once the TlsInteraction.ask_password_async completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the TlsPassword passed to TlsInteraction.ask_password will have its password filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

  • result — the result passed to the callback

do_request_certificate

def do_request_certificate(self, connection: TlsConnection, flags: TlsCertificateRequestFlags | int, cancellable: Cancellable | None = ...) -> TlsInteractionResult

Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, TlsInteraction.invoke_request_certificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

If TlsInteractionResult.HANDLED is returned, then the TlsConnection passed to TlsInteraction.request_certificate will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code. Certain implementations may not support immediate cancellation.

Parameters:

  • connection — a TlsConnection object
  • flags — flags providing more information about the request
  • cancellable — an optional Cancellable cancellation object

do_request_certificate_async

def do_request_certificate_async(self, connection: TlsConnection, flags: TlsCertificateRequestFlags | int, cancellable: Cancellable | None = ..., callback: Callable[[TlsInteraction | None, AsyncResult], None] | None = ...) -> None

Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, TlsInteraction.invoke_request_certificate should be used instead of this function.

Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection.

Parameters:

  • connection — a TlsConnection object
  • flags — flags providing more information about the request
  • cancellable — an optional Cancellable cancellation object
  • callback — will be called when the interaction completes

do_request_certificate_finish

def do_request_certificate_finish(self, result: AsyncResult) -> TlsInteractionResult

Complete a request certificate user interaction request. This should be once the TlsInteraction.request_certificate_async completion callback is called.

If TlsInteractionResult.HANDLED is returned, then the TlsConnection passed to TlsInteraction.request_certificate_async will have had its TlsConnection:certificate filled in.

If the interaction is cancelled by the cancellation object, or by the user then TlsInteractionResult.FAILED will be returned with an error that contains a IOErrorEnum.CANCELLED error code.

Parameters:

  • result — the result passed to the callback