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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{AuthDomain, ServerMessage};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::boxed::Box as Box_;
glib::wrapper! {
/// Server-side "Digest" authentication.
///
/// #SoupAuthDomainDigest handles the server side of HTTP "Digest"
/// authentication.
///
/// ## Properties
///
///
/// #### `auth-callback`
/// The `callback::AuthDomainDigestAuthCallback.
///
/// Readable | Writeable
///
///
/// #### `auth-data`
/// The data to pass to the `callback::AuthDomainDigestAuthCallback.
///
/// Readable | Writeable
/// <details><summary><h4>AuthDomain</h4></summary>
///
///
/// #### `filter`
/// The `callback::AuthDomainFilter for the domain.
///
/// Readable | Writeable
///
///
/// #### `filter-data`
/// Data to pass to the `callback::AuthDomainFilter.
///
/// Readable | Writeable
///
///
/// #### `generic-auth-callback`
/// The `callback::AuthDomainGenericAuthCallback.
///
/// Readable | Writeable
///
///
/// #### `generic-auth-data`
/// The data to pass to the `callback::AuthDomainGenericAuthCallback.
///
/// Readable | Writeable
///
///
/// #### `proxy`
/// Whether or not this is a proxy auth domain.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `realm`
/// The realm of this auth domain.
///
/// Readable | Writeable | Construct Only
/// </details>
///
/// # Implements
///
/// [`AuthDomainExt`][trait@crate::prelude::AuthDomainExt], [`trait@glib::ObjectExt`]
#[doc(alias = "SoupAuthDomainDigest")]
pub struct AuthDomainDigest(Object<ffi::SoupAuthDomainDigest, ffi::SoupAuthDomainDigestClass>) @extends AuthDomain;
match fn {
type_ => || ffi::soup_auth_domain_digest_get_type(),
}
}
impl AuthDomainDigest {
//#[doc(alias = "soup_auth_domain_digest_new")]
//pub fn new(optname1: &str, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) -> AuthDomainDigest {
// unsafe { TODO: call ffi:soup_auth_domain_digest_new() }
//}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`AuthDomainDigest`] objects.
///
/// This method returns an instance of [`AuthDomainDigestBuilder`](crate::builders::AuthDomainDigestBuilder) which can be used to create [`AuthDomainDigest`] objects.
pub fn builder() -> AuthDomainDigestBuilder {
AuthDomainDigestBuilder::new()
}
/// Sets the callback that @self will use to authenticate incoming
/// requests.
///
/// For each request containing authorization, @self will
/// invoke the callback, and then either accept or reject the request
/// based on @callback's return value.
///
/// You can also set the auth callback by setting the
/// [`auth-callback`][struct@crate::AuthDomainDigest#auth-callback] and
/// [`auth-data`][struct@crate::AuthDomainDigest#auth-data] properties, which can also be used to
/// set the callback at construct time.
/// ## `callback`
/// the callback
#[doc(alias = "soup_auth_domain_digest_set_auth_callback")]
pub fn set_auth_callback<
P: Fn(&AuthDomainDigest, &ServerMessage, &str) -> Option<String> + 'static,
>(
&self,
callback: P,
) {
let callback_data: Box_<P> = Box_::new(callback);
unsafe extern "C" fn callback_func<
P: Fn(&AuthDomainDigest, &ServerMessage, &str) -> Option<String> + 'static,
>(
domain: *mut ffi::SoupAuthDomainDigest,
msg: *mut ffi::SoupServerMessage,
username: *const libc::c_char,
user_data: glib::ffi::gpointer,
) -> *mut libc::c_char {
let domain = from_glib_borrow(domain);
let msg = from_glib_borrow(msg);
let username: Borrowed<glib::GString> = from_glib_borrow(username);
let callback = &*(user_data as *mut P);
(*callback)(&domain, &msg, username.as_str()).to_glib_full()
}
let callback = Some(callback_func::<P> as _);
unsafe extern "C" fn dnotify_func<
P: Fn(&AuthDomainDigest, &ServerMessage, &str) -> Option<String> + 'static,
>(
data: glib::ffi::gpointer,
) {
let _callback = Box_::from_raw(data as *mut P);
}
let destroy_call3 = Some(dnotify_func::<P> as _);
let super_callback0: Box_<P> = callback_data;
unsafe {
ffi::soup_auth_domain_digest_set_auth_callback(
self.to_glib_none().0,
callback,
Box_::into_raw(super_callback0) as *mut _,
destroy_call3,
);
}
}
//#[doc(alias = "auth-data")]
//pub fn auth_data(&self) -> /*Unimplemented*/Basic: Pointer {
// ObjectExt::property(self, "auth-data")
//}
//#[doc(alias = "auth-data")]
//pub fn set_auth_data(&self, auth_data: /*Unimplemented*/Basic: Pointer) {
// ObjectExt::set_property(self,"auth-data", auth_data)
//}
/// Encodes the username/realm/password triplet for Digest
/// authentication.
///
/// That is, it returns a stringified MD5 hash of
/// @username, @realm, and @password concatenated together. This is
/// the form that is needed as the return value of
/// #SoupAuthDomainDigest's auth handler.
///
/// For security reasons, you should store the encoded hash, rather
/// than storing the cleartext password itself and calling this method
/// only when you need to verify it. This way, if your server is
/// compromised, the attackers will not gain access to cleartext
/// passwords which might also be usable at other sites. (Note also
/// that the encoded password returned by this method is identical to
/// the encoded password stored in an Apache .htdigest file.)
/// ## `username`
/// a username
/// ## `realm`
/// an auth realm name
/// ## `password`
/// the password for @username in @realm
///
/// # Returns
///
/// the encoded password
#[doc(alias = "soup_auth_domain_digest_encode_password")]
pub fn encode_password(username: &str, realm: &str, password: &str) -> Option<glib::GString> {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::soup_auth_domain_digest_encode_password(
username.to_glib_none().0,
realm.to_glib_none().0,
password.to_glib_none().0,
))
}
}
#[doc(alias = "auth-data")]
pub fn connect_auth_data_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_auth_data_trampoline<F: Fn(&AuthDomainDigest) + 'static>(
this: *mut ffi::SoupAuthDomainDigest,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::auth-data\0".as_ptr() as *const _,
Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
notify_auth_data_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for AuthDomainDigest {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`AuthDomainDigest`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct AuthDomainDigestBuilder {
builder: glib::object::ObjectBuilder<'static, AuthDomainDigest>,
}
impl AuthDomainDigestBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
//pub fn auth_data(self, auth_data: /*Unimplemented*/Basic: Pointer) -> Self {
// Self { builder: self.builder.property("auth-data", auth_data), }
//}
//pub fn filter_data(self, filter_data: /*Unimplemented*/Basic: Pointer) -> Self {
// Self { builder: self.builder.property("filter-data", filter_data), }
//}
//pub fn generic_auth_data(self, generic_auth_data: /*Unimplemented*/Basic: Pointer) -> Self {
// Self { builder: self.builder.property("generic-auth-data", generic_auth_data), }
//}
/// Whether or not this is a proxy auth domain.
pub fn proxy(self, proxy: bool) -> Self {
Self {
builder: self.builder.property("proxy", proxy),
}
}
/// The realm of this auth domain.
pub fn realm(self, realm: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("realm", realm.into()),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`AuthDomainDigest`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> AuthDomainDigest {
self.builder.build()
}
}