gio/auto/tls_interaction.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{
ffi, AsyncResult, Cancellable, TlsCertificateRequestFlags, TlsConnection, TlsInteractionResult,
TlsPassword,
};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};
glib::wrapper! {
/// `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
/// [`TlsConnectionExt::set_interaction()`][crate::prelude::TlsConnectionExt::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
/// [`TlsInteractionExt::invoke_ask_password()`][crate::prelude::TlsInteractionExt::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.
///
/// # Implements
///
/// [`TlsInteractionExt`][trait@crate::prelude::TlsInteractionExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GTlsInteraction")]
pub struct TlsInteraction(Object<ffi::GTlsInteraction, ffi::GTlsInteractionClass>);
match fn {
type_ => || ffi::g_tls_interaction_get_type(),
}
}
impl TlsInteraction {
pub const NONE: Option<&'static TlsInteraction> = None;
}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::TlsInteraction>> Sealed for T {}
}
/// Trait containing all [`struct@TlsInteraction`] methods.
///
/// # Implementors
///
/// [`TlsInteraction`][struct@crate::TlsInteraction]
pub trait TlsInteractionExt: IsA<TlsInteraction> + sealed::Sealed + 'static {
/// Run synchronous interaction to ask the user for a password. In general,
/// g_tls_interaction_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`][crate::TlsInteractionResult::Failed] will be returned with an error that
/// contains a [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] error code. Certain implementations may
/// not support immediate cancellation.
/// ## `password`
/// a #GTlsPassword object
/// ## `cancellable`
/// an optional #GCancellable cancellation object
///
/// # Returns
///
/// The status of the ask password interaction.
#[doc(alias = "g_tls_interaction_ask_password")]
fn ask_password(
&self,
password: &impl IsA<TlsPassword>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<TlsInteractionResult, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_ask_password(
self.as_ref().to_glib_none().0,
password.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Run asynchronous interaction to ask the user for a password. In general,
/// g_tls_interaction_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`][crate::TlsInteractionResult::Failed] will be returned with an error that
/// contains a [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] error code. Certain implementations may
/// not support immediate cancellation.
///
/// Certain implementations may not support immediate cancellation.
/// ## `password`
/// a #GTlsPassword object
/// ## `cancellable`
/// an optional #GCancellable cancellation object
/// ## `callback`
/// will be called when the interaction completes
#[doc(alias = "g_tls_interaction_ask_password_async")]
fn ask_password_async<P: FnOnce(Result<TlsInteractionResult, glib::Error>) + 'static>(
&self,
password: &impl IsA<TlsPassword>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn ask_password_async_trampoline<
P: FnOnce(Result<TlsInteractionResult, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_ask_password_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = ask_password_async_trampoline::<P>;
unsafe {
ffi::g_tls_interaction_ask_password_async(
self.as_ref().to_glib_none().0,
password.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn ask_password_future(
&self,
password: &(impl IsA<TlsPassword> + Clone + 'static),
) -> Pin<
Box_<dyn std::future::Future<Output = Result<TlsInteractionResult, glib::Error>> + 'static>,
> {
let password = password.clone();
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.ask_password_async(&password, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Invoke the interaction to ask the user for a password. It invokes this
/// interaction in the main loop, specifically the #GMainContext returned by
/// g_main_context_get_thread_default() when the interaction is created. This
/// is called by called by #GTlsConnection or #GTlsDatabase 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`][crate::TlsInteractionResult::Failed] will be returned with an error that
/// contains a [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] error code. Certain implementations may
/// not support immediate cancellation.
/// ## `password`
/// a #GTlsPassword object
/// ## `cancellable`
/// an optional #GCancellable cancellation object
///
/// # Returns
///
/// The status of the ask password interaction.
#[doc(alias = "g_tls_interaction_invoke_ask_password")]
fn invoke_ask_password(
&self,
password: &impl IsA<TlsPassword>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<TlsInteractionResult, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_invoke_ask_password(
self.as_ref().to_glib_none().0,
password.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// 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 #GMainContext returned by
/// g_main_context_get_thread_default() when the interaction is
/// created. This is called by called by #GTlsConnection 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`][crate::TlsInteractionResult::Failed] will be returned with an error that
/// contains a [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] error code. Certain implementations may
/// not support immediate cancellation.
/// ## `connection`
/// a #GTlsConnection object
/// ## `flags`
/// flags providing more information about the request
/// ## `cancellable`
/// an optional #GCancellable cancellation object
///
/// # Returns
///
/// The status of the certificate request interaction.
#[doc(alias = "g_tls_interaction_invoke_request_certificate")]
fn invoke_request_certificate(
&self,
connection: &impl IsA<TlsConnection>,
flags: TlsCertificateRequestFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<TlsInteractionResult, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_invoke_request_certificate(
self.as_ref().to_glib_none().0,
connection.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Run synchronous interaction to ask the user to choose a certificate to use
/// with the connection. In general, g_tls_interaction_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`][crate::TlsInteractionResult::Handled] is returned, then the #GTlsConnection
/// passed to g_tls_interaction_request_certificate() will have had its
/// #GTlsConnection:certificate filled in.
///
/// If the interaction is cancelled by the cancellation object, or by the
/// user then [`TlsInteractionResult::Failed`][crate::TlsInteractionResult::Failed] will be returned with an error that
/// contains a [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] error code. Certain implementations may
/// not support immediate cancellation.
/// ## `connection`
/// a #GTlsConnection object
/// ## `flags`
/// flags providing more information about the request
/// ## `cancellable`
/// an optional #GCancellable cancellation object
///
/// # Returns
///
/// The status of the request certificate interaction.
#[doc(alias = "g_tls_interaction_request_certificate")]
fn request_certificate(
&self,
connection: &impl IsA<TlsConnection>,
flags: TlsCertificateRequestFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<TlsInteractionResult, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_request_certificate(
self.as_ref().to_glib_none().0,
connection.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Run asynchronous interaction to ask the user for a certificate to use with
/// the connection. In general, g_tls_interaction_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.
/// ## `connection`
/// a #GTlsConnection object
/// ## `flags`
/// flags providing more information about the request
/// ## `cancellable`
/// an optional #GCancellable cancellation object
/// ## `callback`
/// will be called when the interaction completes
#[doc(alias = "g_tls_interaction_request_certificate_async")]
fn request_certificate_async<P: FnOnce(Result<TlsInteractionResult, glib::Error>) + 'static>(
&self,
connection: &impl IsA<TlsConnection>,
flags: TlsCertificateRequestFlags,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn request_certificate_async_trampoline<
P: FnOnce(Result<TlsInteractionResult, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_tls_interaction_request_certificate_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(from_glib(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = request_certificate_async_trampoline::<P>;
unsafe {
ffi::g_tls_interaction_request_certificate_async(
self.as_ref().to_glib_none().0,
connection.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn request_certificate_future(
&self,
connection: &(impl IsA<TlsConnection> + Clone + 'static),
flags: TlsCertificateRequestFlags,
) -> Pin<
Box_<dyn std::future::Future<Output = Result<TlsInteractionResult, glib::Error>> + 'static>,
> {
let connection = connection.clone();
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.request_certificate_async(&connection, flags, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
}
impl<O: IsA<TlsInteraction>> TlsInteractionExt for O {}