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
// 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::IOStream;
use crate::SocketConnectable;
use crate::TlsCertificateFlags;
use crate::TlsConnection;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::ptr;
glib::wrapper! {
/// [`TlsClientConnection`][crate::TlsClientConnection] is the client-side subclass of
/// [`TlsConnection`][crate::TlsConnection], representing a client-side TLS connection.
///
/// # Implements
///
/// [`TlsClientConnectionExt`][trait@crate::prelude::TlsClientConnectionExt], [`TlsConnectionExt`][trait@crate::prelude::TlsConnectionExt], [`IOStreamExt`][trait@crate::prelude::IOStreamExt], [`trait@glib::ObjectExt`], [`TlsConnectionExtManual`][trait@crate::prelude::TlsConnectionExtManual], [`IOStreamExtManual`][trait@crate::prelude::IOStreamExtManual]
#[doc(alias = "GTlsClientConnection")]
pub struct TlsClientConnection(Interface<ffi::GTlsClientConnection, ffi::GTlsClientConnectionInterface>) @requires TlsConnection, IOStream;
match fn {
type_ => || ffi::g_tls_client_connection_get_type(),
}
}
impl TlsClientConnection {
pub const NONE: Option<&'static TlsClientConnection> = None;
/// Creates a new [`TlsClientConnection`][crate::TlsClientConnection] wrapping `base_io_stream` (which
/// must have pollable input and output streams) which is assumed to
/// communicate with the server identified by `server_identity`.
///
/// See the documentation for `property::TlsConnection::base-io-stream` for restrictions
/// on when application code can run operations on the `base_io_stream` after
/// this function has returned.
/// ## `base_io_stream`
/// the [`IOStream`][crate::IOStream] to wrap
/// ## `server_identity`
/// the expected identity of the server
///
/// # Returns
///
/// the new
/// [`TlsClientConnection`][crate::TlsClientConnection], or [`None`] on error
#[doc(alias = "g_tls_client_connection_new")]
pub fn new(
base_io_stream: &impl IsA<IOStream>,
server_identity: Option<&impl IsA<SocketConnectable>>,
) -> Result<TlsClientConnection, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_tls_client_connection_new(
base_io_stream.as_ref().to_glib_none().0,
server_identity.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
}
/// Trait containing all [`struct@TlsClientConnection`] methods.
///
/// # Implementors
///
/// [`TlsClientConnection`][struct@crate::TlsClientConnection]
pub trait TlsClientConnectionExt: 'static {
/// Possibly copies session state from one connection to another, for use
/// in TLS session resumption. This is not normally needed, but may be
/// used when the same session needs to be used between different
/// endpoints, as is required by some protocols, such as FTP over TLS.
/// `source` should have already completed a handshake and, since TLS 1.3,
/// it should have been used to read data at least once. `self` should not
/// have completed a handshake.
///
/// It is not possible to know whether a call to this function will
/// actually do anything. Because session resumption is normally used
/// only for performance benefit, the TLS backend might not implement
/// this function. Even if implemented, it may not actually succeed in
/// allowing `self` to resume `source`'s TLS session, because the server
/// may not have sent a session resumption token to `source`, or it may
/// refuse to accept the token from `self`. There is no way to know
/// whether a call to this function is actually successful.
///
/// Using this function is not required to benefit from session
/// resumption. If the TLS backend supports session resumption, the
/// session will be resumed automatically if it is possible to do so
/// without weakening the privacy guarantees normally provided by TLS,
/// without need to call this function. For example, with TLS 1.3,
/// a session ticket will be automatically copied from any
/// [`TlsClientConnection`][crate::TlsClientConnection] that has previously received session tickets
/// from the server, provided a ticket is available that has not
/// previously been used for session resumption, since session ticket
/// reuse would be a privacy weakness. Using this function causes the
/// ticket to be copied without regard for privacy considerations.
/// ## `source`
/// a [`TlsClientConnection`][crate::TlsClientConnection]
#[doc(alias = "g_tls_client_connection_copy_session_state")]
fn copy_session_state(&self, source: &impl IsA<TlsClientConnection>);
/// Gets the list of distinguished names of the Certificate Authorities
/// that the server will accept certificates from. This will be set
/// during the TLS handshake if the server requests a certificate.
/// Otherwise, it will be [`None`].
///
/// Each item in the list is a [`glib::ByteArray`][crate::glib::ByteArray] which contains the complete
/// subject DN of the certificate authority.
///
/// # Returns
///
/// the list of
/// CA DNs. You should unref each element with `g_byte_array_unref()` and then
/// the free the list with `g_list_free()`.
#[doc(alias = "g_tls_client_connection_get_accepted_cas")]
#[doc(alias = "get_accepted_cas")]
fn accepted_cas(&self) -> Vec<glib::ByteArray>;
/// Gets `self`'s expected server identity
///
/// # Returns
///
/// a [`SocketConnectable`][crate::SocketConnectable] describing the
/// expected server identity, or [`None`] if the expected identity is not
/// known.
#[doc(alias = "g_tls_client_connection_get_server_identity")]
#[doc(alias = "get_server_identity")]
fn server_identity(&self) -> Option<SocketConnectable>;
/// SSL 3.0 is no longer supported. See
/// [`set_use_ssl3()`][Self::set_use_ssl3()] for details.
///
/// # Deprecated since 2.56
///
/// SSL 3.0 is insecure.
///
/// # Returns
///
/// [`false`]
#[cfg_attr(feature = "v2_56", deprecated = "Since 2.56")]
#[doc(alias = "g_tls_client_connection_get_use_ssl3")]
#[doc(alias = "get_use_ssl3")]
fn uses_ssl3(&self) -> bool;
/// Gets `self`'s validation flags
///
/// This function does not work as originally designed and is impossible
/// to use correctly. See `property::TlsClientConnection::validation-flags` for more
/// information.
///
/// # Deprecated since 2.72
///
/// Do not attempt to ignore validation errors.
///
/// # Returns
///
/// the validation flags
#[cfg_attr(feature = "v2_72", deprecated = "Since 2.72")]
#[doc(alias = "g_tls_client_connection_get_validation_flags")]
#[doc(alias = "get_validation_flags")]
fn validation_flags(&self) -> TlsCertificateFlags;
/// Sets `self`'s expected server identity, which is used both to tell
/// servers on virtual hosts which certificate to present, and also
/// to let `self` know what name to look for in the certificate when
/// performing [`TlsCertificateFlags::BAD_IDENTITY`][crate::TlsCertificateFlags::BAD_IDENTITY] validation, if enabled.
/// ## `identity`
/// a [`SocketConnectable`][crate::SocketConnectable] describing the expected server identity
#[doc(alias = "g_tls_client_connection_set_server_identity")]
fn set_server_identity(&self, identity: &impl IsA<SocketConnectable>);
/// Since GLib 2.42.1, SSL 3.0 is no longer supported.
///
/// From GLib 2.42.1 through GLib 2.62, this function could be used to
/// force use of TLS 1.0, the lowest-supported TLS protocol version at
/// the time. In the past, this was needed to connect to broken TLS
/// servers that exhibited protocol version intolerance. Such servers
/// are no longer common, and using TLS 1.0 is no longer considered
/// acceptable.
///
/// Since GLib 2.64, this function does nothing.
///
/// # Deprecated since 2.56
///
/// SSL 3.0 is insecure.
/// ## `use_ssl3`
/// a `gboolean`, ignored
#[cfg_attr(feature = "v2_56", deprecated = "Since 2.56")]
#[doc(alias = "g_tls_client_connection_set_use_ssl3")]
fn set_use_ssl3(&self, use_ssl3: bool);
/// Sets `self`'s validation flags, to override the default set of
/// checks performed when validating a server certificate. By default,
/// [`TlsCertificateFlags::VALIDATE_ALL`][crate::TlsCertificateFlags::VALIDATE_ALL] is used.
///
/// This function does not work as originally designed and is impossible
/// to use correctly. See `property::TlsClientConnection::validation-flags` for more
/// information.
///
/// # Deprecated since 2.72
///
/// Do not attempt to ignore validation errors.
/// ## `flags`
/// the [`TlsCertificateFlags`][crate::TlsCertificateFlags] to use
#[cfg_attr(feature = "v2_72", deprecated = "Since 2.72")]
#[doc(alias = "g_tls_client_connection_set_validation_flags")]
fn set_validation_flags(&self, flags: TlsCertificateFlags);
#[doc(alias = "accepted-cas")]
fn connect_accepted_cas_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "server-identity")]
fn connect_server_identity_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[cfg_attr(feature = "v2_56", deprecated = "Since 2.56")]
#[doc(alias = "use-ssl3")]
fn connect_use_ssl3_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[cfg_attr(feature = "v2_72", deprecated = "Since 2.72")]
#[doc(alias = "validation-flags")]
fn connect_validation_flags_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<TlsClientConnection>> TlsClientConnectionExt for O {
fn copy_session_state(&self, source: &impl IsA<TlsClientConnection>) {
unsafe {
ffi::g_tls_client_connection_copy_session_state(
self.as_ref().to_glib_none().0,
source.as_ref().to_glib_none().0,
);
}
}
fn accepted_cas(&self) -> Vec<glib::ByteArray> {
unsafe {
FromGlibPtrContainer::from_glib_full(ffi::g_tls_client_connection_get_accepted_cas(
self.as_ref().to_glib_none().0,
))
}
}
fn server_identity(&self) -> Option<SocketConnectable> {
unsafe {
from_glib_none(ffi::g_tls_client_connection_get_server_identity(
self.as_ref().to_glib_none().0,
))
}
}
fn uses_ssl3(&self) -> bool {
unsafe {
from_glib(ffi::g_tls_client_connection_get_use_ssl3(
self.as_ref().to_glib_none().0,
))
}
}
fn validation_flags(&self) -> TlsCertificateFlags {
unsafe {
from_glib(ffi::g_tls_client_connection_get_validation_flags(
self.as_ref().to_glib_none().0,
))
}
}
fn set_server_identity(&self, identity: &impl IsA<SocketConnectable>) {
unsafe {
ffi::g_tls_client_connection_set_server_identity(
self.as_ref().to_glib_none().0,
identity.as_ref().to_glib_none().0,
);
}
}
fn set_use_ssl3(&self, use_ssl3: bool) {
unsafe {
ffi::g_tls_client_connection_set_use_ssl3(
self.as_ref().to_glib_none().0,
use_ssl3.into_glib(),
);
}
}
fn set_validation_flags(&self, flags: TlsCertificateFlags) {
unsafe {
ffi::g_tls_client_connection_set_validation_flags(
self.as_ref().to_glib_none().0,
flags.into_glib(),
);
}
}
fn connect_accepted_cas_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_accepted_cas_trampoline<
P: IsA<TlsClientConnection>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GTlsClientConnection,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(TlsClientConnection::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::accepted-cas\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_accepted_cas_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_server_identity_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_server_identity_trampoline<
P: IsA<TlsClientConnection>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GTlsClientConnection,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(TlsClientConnection::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::server-identity\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_server_identity_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_use_ssl3_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_use_ssl3_trampoline<
P: IsA<TlsClientConnection>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GTlsClientConnection,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(TlsClientConnection::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::use-ssl3\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_use_ssl3_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_validation_flags_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_validation_flags_trampoline<
P: IsA<TlsClientConnection>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GTlsClientConnection,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(TlsClientConnection::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::validation-flags\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_validation_flags_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for TlsClientConnection {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("TlsClientConnection")
}
}