2021-12-06 01:09:33 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < meta name = "generator" content = "rustdoc" > < meta name = "description" content = "Source of the Rust file `actix-web-httpauth/src/extractors/bearer.rs`." > < meta name = "keywords" content = "rust, rustlang, rust-lang" > < title > bearer.rs - source< / title > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../SourceSerif4-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../FiraSans-Regular.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../FiraSans-Medium.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../SourceCodePro-Regular.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../SourceSerif4-Bold.ttf.woff2" > < link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../../../SourceCodePro-Semibold.ttf.woff2" > < link rel = "stylesheet" type = "text/css" href = "../../../normalize.css" > < link rel = "stylesheet" type = "text/css" href = "../../../rustdoc.css" id = "mainThemeStyle" > < link rel = "stylesheet" type = "text/css" href = "../../../ayu.css" disabled > < link rel = "stylesheet" type = "text/css" href = "../../../dark.css" disabled > < link rel = "stylesheet" type = "text/css" href = "../../../light.css" id = "themeStyle" > < script id = "default-settings" > < / script > < script src = "../../../storage.js" > < / script > < script src = "../../../crates.js" > < / script > < script defer src = "../../../main.js" > < / script > < script defer src = "../../../source-script.js" > < / script > < script defer src = "../../../source-files.js" > < / script >
< noscript > < link rel = "stylesheet" href = "../../../noscript.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../../../favicon-16x16.png" > < link rel = "alternate icon" type = "image/png" href = "../../../favicon-32x32.png" > < link rel = "icon" type = "image/svg+xml" href = "../../../favicon.svg" > < / head > < body class = "rustdoc source" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "sidebar" > < div class = "sidebar-menu" role = "button" > ☰ < / div > < a class = "sidebar-logo" href = '../../../actix_web_httpauth/index.html' > < div class = 'logo-container rust-logo' > < img src = '../../../rust-logo.png' alt = 'logo' > < / div > < / a > < / nav > < main > < div class = "width-limiter" > < div class = "sub-container" > < a class = "sub-logo-container rust-logo" href = '../../../actix_web_httpauth/index.html' > < img src = '../../../rust-logo.png' alt = 'logo' > < / a > < nav class = "sub" > < div class = "theme-picker" > < button id = "theme-picker" aria-label = "Pick another theme!" aria-haspopup = "menu" title = "themes" > < img width = "18" height = "18" alt = "Pick another theme!" src = "../../../brush.svg" > < / button > < div id = "theme-choices" role = "menu" > < / div > < / div > < form class = "search-form" > < div class = "search-container" > < div > < select id = "crate-search" > < option value = "All crates" > All crates< / option > < / select > < input class = "search-input" name = "search" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < / div > < button type = "button" id = "help-button" title = "help" > ?< / button > < a id = "settings-menu" href = "../../../settings.html" title = "settings" > < img width = "18" height = "18" alt = "Change settings" src = "../../../wheel.svg" > < / a > < / div > < / form > < / nav > < / div > < section id = "main-content" class = "content" > < div class = "example-wrap" > < pre class = "line-numbers" > < span id = "1" > 1< / span >
2021-03-22 11:49:07 +00:00
< span id = "2" > 2< / span >
< span id = "3" > 3< / span >
< span id = "4" > 4< / span >
< span id = "5" > 5< / span >
< span id = "6" > 6< / span >
< span id = "7" > 7< / span >
< span id = "8" > 8< / span >
< span id = "9" > 9< / span >
< span id = "10" > 10< / span >
< span id = "11" > 11< / span >
< span id = "12" > 12< / span >
< span id = "13" > 13< / span >
< span id = "14" > 14< / span >
< span id = "15" > 15< / span >
< span id = "16" > 16< / span >
< span id = "17" > 17< / span >
< span id = "18" > 18< / span >
< span id = "19" > 19< / span >
< span id = "20" > 20< / span >
< span id = "21" > 21< / span >
< span id = "22" > 22< / span >
< span id = "23" > 23< / span >
< span id = "24" > 24< / span >
< span id = "25" > 25< / span >
< span id = "26" > 26< / span >
< span id = "27" > 27< / span >
< span id = "28" > 28< / span >
< span id = "29" > 29< / span >
< span id = "30" > 30< / span >
< span id = "31" > 31< / span >
< span id = "32" > 32< / span >
< span id = "33" > 33< / span >
< span id = "34" > 34< / span >
< span id = "35" > 35< / span >
< span id = "36" > 36< / span >
< span id = "37" > 37< / span >
< span id = "38" > 38< / span >
< span id = "39" > 39< / span >
< span id = "40" > 40< / span >
< span id = "41" > 41< / span >
< span id = "42" > 42< / span >
< span id = "43" > 43< / span >
< span id = "44" > 44< / span >
< span id = "45" > 45< / span >
< span id = "46" > 46< / span >
< span id = "47" > 47< / span >
< span id = "48" > 48< / span >
< span id = "49" > 49< / span >
< span id = "50" > 50< / span >
< span id = "51" > 51< / span >
< span id = "52" > 52< / span >
< span id = "53" > 53< / span >
< span id = "54" > 54< / span >
< span id = "55" > 55< / span >
< span id = "56" > 56< / span >
< span id = "57" > 57< / span >
< span id = "58" > 58< / span >
< span id = "59" > 59< / span >
< span id = "60" > 60< / span >
< span id = "61" > 61< / span >
< span id = "62" > 62< / span >
< span id = "63" > 63< / span >
< span id = "64" > 64< / span >
< span id = "65" > 65< / span >
< span id = "66" > 66< / span >
< span id = "67" > 67< / span >
< span id = "68" > 68< / span >
< span id = "69" > 69< / span >
< span id = "70" > 70< / span >
< span id = "71" > 71< / span >
< span id = "72" > 72< / span >
< span id = "73" > 73< / span >
< span id = "74" > 74< / span >
< span id = "75" > 75< / span >
< span id = "76" > 76< / span >
< span id = "77" > 77< / span >
< span id = "78" > 78< / span >
< span id = "79" > 79< / span >
< span id = "80" > 80< / span >
< span id = "81" > 81< / span >
< span id = "82" > 82< / span >
< span id = "83" > 83< / span >
< span id = "84" > 84< / span >
< span id = "85" > 85< / span >
< span id = "86" > 86< / span >
< span id = "87" > 87< / span >
< span id = "88" > 88< / span >
< span id = "89" > 89< / span >
< span id = "90" > 90< / span >
< span id = "91" > 91< / span >
< span id = "92" > 92< / span >
< span id = "93" > 93< / span >
< span id = "94" > 94< / span >
< span id = "95" > 95< / span >
< span id = "96" > 96< / span >
< span id = "97" > 97< / span >
< span id = "98" > 98< / span >
< span id = "99" > 99< / span >
< span id = "100" > 100< / span >
< span id = "101" > 101< / span >
< span id = "102" > 102< / span >
< span id = "103" > 103< / span >
< span id = "104" > 104< / span >
< span id = "105" > 105< / span >
< span id = "106" > 106< / span >
< span id = "107" > 107< / span >
< span id = "108" > 108< / span >
< span id = "109" > 109< / span >
< span id = "110" > 110< / span >
< span id = "111" > 111< / span >
< span id = "112" > 112< / span >
< span id = "113" > 113< / span >
< span id = "114" > 114< / span >
< span id = "115" > 115< / span >
< span id = "116" > 116< / span >
< span id = "117" > 117< / span >
< span id = "118" > 118< / span >
< span id = "119" > 119< / span >
< span id = "120" > 120< / span >
< span id = "121" > 121< / span >
< span id = "122" > 122< / span >
< span id = "123" > 123< / span >
< span id = "124" > 124< / span >
< span id = "125" > 125< / span >
< span id = "126" > 126< / span >
< span id = "127" > 127< / span >
< span id = "128" > 128< / span >
< span id = "129" > 129< / span >
< span id = "130" > 130< / span >
< span id = "131" > 131< / span >
< span id = "132" > 132< / span >
< span id = "133" > 133< / span >
< span id = "134" > 134< / span >
< span id = "135" > 135< / span >
< span id = "136" > 136< / span >
< span id = "137" > 137< / span >
< span id = "138" > 138< / span >
< span id = "139" > 139< / span >
< span id = "140" > 140< / span >
< span id = "141" > 141< / span >
< span id = "142" > 142< / span >
< span id = "143" > 143< / span >
< span id = "144" > 144< / span >
< span id = "145" > 145< / span >
< span id = "146" > 146< / span >
< span id = "147" > 147< / span >
< span id = "148" > 148< / span >
< span id = "149" > 149< / span >
< span id = "150" > 150< / span >
< span id = "151" > 151< / span >
< span id = "152" > 152< / span >
< span id = "153" > 153< / span >
< span id = "154" > 154< / span >
< span id = "155" > 155< / span >
< span id = "156" > 156< / span >
< span id = "157" > 157< / span >
< span id = "158" > 158< / span >
< span id = "159" > 159< / span >
< span id = "160" > 160< / span >
< span id = "161" > 161< / span >
< span id = "162" > 162< / span >
< span id = "163" > 163< / span >
< span id = "164" > 164< / span >
< span id = "165" > 165< / span >
< span id = "166" > 166< / span >
< span id = "167" > 167< / span >
< span id = "168" > 168< / span >
< span id = "169" > 169< / span >
< span id = "170" > 170< / span >
< span id = "171" > 171< / span >
< span id = "172" > 172< / span >
< span id = "173" > 173< / span >
< span id = "174" > 174< / span >
< span id = "175" > 175< / span >
< span id = "176" > 176< / span >
2021-08-30 22:13:55 +00:00
< / pre > < pre class = "rust" > < code > < span class = "doccomment" > //! Extractor for the " Bearer" HTTP Authentication Scheme< / span >
2021-03-22 11:49:07 +00:00
2021-04-09 13:42:26 +00:00
< span class = "kw" > use< / span > < span class = "ident" > std::borrow::Cow< / span > ;
< span class = "kw" > use< / span > < span class = "ident" > std::default::Default< / span > ;
2021-03-22 11:49:07 +00:00
2021-04-09 13:42:26 +00:00
< span class = "kw" > use< / span > < span class = "ident" > actix_web::dev< / span > ::{< span class = "ident" > Payload< / span > , < span class = "ident" > ServiceRequest< / span > };
< span class = "kw" > use< / span > < span class = "ident" > actix_web::http::header::Header< / span > ;
2021-03-22 11:49:07 +00:00
< span class = "kw" > use< / span > < span class = "ident" > actix_web< / span > ::{< span class = "ident" > FromRequest< / span > , < span class = "ident" > HttpRequest< / span > };
2021-04-09 13:42:26 +00:00
< span class = "kw" > use< / span > < span class = "ident" > futures_util::future< / span > ::{< span class = "ident" > ready< / span > , < span class = "ident" > Ready< / span > };
2021-03-22 11:49:07 +00:00
2021-08-30 22:13:55 +00:00
< span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > super< / span > ::config::AuthExtractorConfig< / span > ;
< span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > super< / span > ::errors::AuthenticationError< / span > ;
< span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > super< / span > ::AuthExtractor< / span > ;
< span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > crate< / span > ::headers::authorization< / span > ;
< span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > crate< / span > ::headers::www_authenticate::bearer< / span > ;
< span class = "kw" > pub< / span > < span class = "kw" > use< / span > < span class = "ident" > < span class = "kw" > crate< / span > ::headers::www_authenticate::bearer::Error< / span > ;
2021-03-22 11:49:07 +00:00
< span class = "doccomment" > /// [BearerAuth](./struct/BearerAuth.html) extractor configuration.< / span >
< span class = "attribute" > #[< span class = "ident" > derive< / span > (< span class = "ident" > Debug< / span > , < span class = "ident" > Clone< / span > , < span class = "ident" > Default< / span > )]< / span >
2021-04-09 13:42:26 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > struct< / span > < span class = "ident" > Config< / span > (< span class = "ident" > bearer::Bearer< / span > );
2021-03-22 11:49:07 +00:00
< span class = "kw" > impl< / span > < span class = "ident" > Config< / span > {
< span class = "doccomment" > /// Set challenge `scope` attribute.< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// The `" scope" ` attribute is a space-delimited list of case-sensitive< / span >
< span class = "doccomment" > /// scope values indicating the required scope of the access token for< / span >
< span class = "doccomment" > /// accessing the requested resource.< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > scope< / span > < span class = "op" > < < / span > < span class = "ident" > T< / span > : < span class = "ident" > Into< / span > < span class = "op" > < < / span > < span class = "ident" > Cow< / span > < span class = "op" > < < / span > < span class = "lifetime" > ' static< / span > , < span class = "ident" > str< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > < span class = "op" > > < / span > (< span class = "kw-2" > mut< / span > < span class = "self" > self< / span > , < span class = "ident" > value< / span > : < span class = "ident" > T< / span > ) -> < span class = "ident" > Config< / span > {
2021-03-22 11:49:07 +00:00
< span class = "self" > self< / span > .< span class = "number" > 0< / span > .< span class = "ident" > scope< / span > < span class = "op" > =< / span > < span class = "prelude-val" > Some< / span > (< span class = "ident" > value< / span > .< span class = "ident" > into< / span > ());
< span class = "self" > self< / span >
}
< span class = "doccomment" > /// Set challenge `realm` attribute.< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// The " realm" attribute indicates the scope of protection in the manner< / span >
< span class = "doccomment" > /// described in HTTP/1.1 [RFC2617](https://tools.ietf.org/html/rfc2617#section-1.2).< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > realm< / span > < span class = "op" > < < / span > < span class = "ident" > T< / span > : < span class = "ident" > Into< / span > < span class = "op" > < < / span > < span class = "ident" > Cow< / span > < span class = "op" > < < / span > < span class = "lifetime" > ' static< / span > , < span class = "ident" > str< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > < span class = "op" > > < / span > (< span class = "kw-2" > mut< / span > < span class = "self" > self< / span > , < span class = "ident" > value< / span > : < span class = "ident" > T< / span > ) -> < span class = "ident" > Config< / span > {
2021-03-22 11:49:07 +00:00
< span class = "self" > self< / span > .< span class = "number" > 0< / span > .< span class = "ident" > realm< / span > < span class = "op" > =< / span > < span class = "prelude-val" > Some< / span > (< span class = "ident" > value< / span > .< span class = "ident" > into< / span > ());
< span class = "self" > self< / span >
}
}
2021-04-09 13:42:26 +00:00
< span class = "kw" > impl< / span > < span class = "ident" > AsRef< / span > < span class = "op" > < < / span > < span class = "ident" > bearer::Bearer< / span > < span class = "op" > > < / span > < span class = "kw" > for< / span > < span class = "ident" > Config< / span > {
2021-10-11 01:57:28 +00:00
< span class = "kw" > fn< / span > < span class = "ident" > as_ref< / span > (< span class = "kw-2" > & < / span > < span class = "self" > self< / span > ) -> < span class = "kw-2" > & < / span > < span class = "ident" > bearer::Bearer< / span > {
2021-03-22 11:49:07 +00:00
< span class = "kw-2" > & < / span > < span class = "self" > self< / span > .< span class = "number" > 0< / span >
}
}
< span class = "kw" > impl< / span > < span class = "ident" > AuthExtractorConfig< / span > < span class = "kw" > for< / span > < span class = "ident" > Config< / span > {
2021-04-09 13:42:26 +00:00
< span class = "kw" > type< / span > < span class = "ident" > Inner< / span > < span class = "op" > =< / span > < span class = "ident" > bearer::Bearer< / span > ;
2021-03-22 11:49:07 +00:00
2021-10-11 01:57:28 +00:00
< span class = "kw" > fn< / span > < span class = "ident" > into_inner< / span > (< span class = "self" > self< / span > ) -> < span class = "ident" > < span class = "self" > Self< / span > ::Inner< / span > {
2021-03-22 11:49:07 +00:00
< span class = "self" > self< / span > .< span class = "number" > 0< / span >
}
}
< span class = "comment" > // Needs `fn main` to display complete example.< / span >
2021-04-09 13:42:26 +00:00
< span class = "attribute" > #[< span class = "ident" > allow< / span > (< span class = "ident" > clippy::needless_doctest_main< / span > )]< / span >
2021-03-22 11:49:07 +00:00
< span class = "doccomment" > /// Extractor for HTTP Bearer auth< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// # Example< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// ```< / span >
< span class = "doccomment" > /// use actix_web_httpauth::extractors::bearer::BearerAuth;< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// async fn index(auth: BearerAuth) -> String {< / span >
< span class = "doccomment" > /// format!(" Hello, user with token {}!" , auth.token())< / span >
< span class = "doccomment" > /// }< / span >
< span class = "doccomment" > /// ```< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// If authentication fails, this extractor fetches the [`Config`] instance< / span >
< span class = "doccomment" > /// from the [app data] in order to properly form the `WWW-Authenticate`< / span >
< span class = "doccomment" > /// response header.< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// ## Example< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// ```< / span >
< span class = "doccomment" > /// use actix_web::{web, App};< / span >
< span class = "doccomment" > /// use actix_web_httpauth::extractors::bearer::{BearerAuth, Config};< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// async fn index(auth: BearerAuth) -> String {< / span >
< span class = "doccomment" > /// format!(" Hello, {}!" , auth.token())< / span >
< span class = "doccomment" > /// }< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// fn main() {< / span >
< span class = "doccomment" > /// let app = App::new()< / span >
2021-06-27 06:05:12 +00:00
< span class = "doccomment" > /// .app_data(< / span >
2021-03-22 11:49:07 +00:00
< span class = "doccomment" > /// Config::default()< / span >
< span class = "doccomment" > /// .realm(" Restricted area" )< / span >
< span class = "doccomment" > /// .scope(" email photo" ),< / span >
< span class = "doccomment" > /// )< / span >
< span class = "doccomment" > /// .service(web::resource(" /index.html" ).route(web::get().to(index)));< / span >
< span class = "doccomment" > /// }< / span >
< span class = "doccomment" > /// ```< / span >
< span class = "attribute" > #[< span class = "ident" > derive< / span > (< span class = "ident" > Debug< / span > , < span class = "ident" > Clone< / span > )]< / span >
2021-04-09 13:42:26 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > struct< / span > < span class = "ident" > BearerAuth< / span > (< span class = "ident" > authorization::Bearer< / span > );
2021-03-22 11:49:07 +00:00
< span class = "kw" > impl< / span > < span class = "ident" > BearerAuth< / span > {
< span class = "doccomment" > /// Returns bearer token provided by client.< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > token< / span > (< span class = "kw-2" > & < / span > < span class = "self" > self< / span > ) -> < span class = "kw-2" > & < / span > < span class = "ident" > str< / span > {
2021-03-22 11:49:07 +00:00
< span class = "self" > self< / span > .< span class = "number" > 0< / span > .< span class = "ident" > token< / span > ()
}
}
< span class = "kw" > impl< / span > < span class = "ident" > FromRequest< / span > < span class = "kw" > for< / span > < span class = "ident" > BearerAuth< / span > {
2021-08-30 22:13:55 +00:00
< span class = "kw" > type< / span > < span class = "ident" > Future< / span > < span class = "op" > =< / span > < span class = "ident" > Ready< / span > < span class = "op" > < < / span > < span class = "prelude-ty" > Result< / span > < span class = "op" > < < / span > < span class = "self" > Self< / span > , < span class = "ident" > < span class = "self" > Self< / span > ::Error< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > ;
2021-04-09 13:42:26 +00:00
< span class = "kw" > type< / span > < span class = "ident" > Error< / span > < span class = "op" > =< / span > < span class = "ident" > AuthenticationError< / span > < span class = "op" > < < / span > < span class = "ident" > bearer::Bearer< / span > < span class = "op" > > < / span > ;
2021-03-22 11:49:07 +00:00
2021-11-22 23:22:02 +00:00
< span class = "kw" > fn< / span > < span class = "ident" > from_request< / span > (< span class = "ident" > req< / span > : < span class = "kw-2" > & < / span > < span class = "ident" > HttpRequest< / span > , < span class = "ident" > _payload< / span > : < span class = "kw-2" > & mut< / span > < span class = "ident" > Payload< / span > ) -> < span class = "op" > < < / span > < span class = "self" > Self< / span > < span class = "kw" > as< / span > < span class = "ident" > FromRequest< / span > < span class = "op" > > < / span > < span class = "ident" > ::Future< / span > {
2021-03-22 11:49:07 +00:00
< span class = "ident" > ready< / span > (
2021-04-09 13:42:26 +00:00
< span class = "ident" > authorization::Authorization< / span > ::< span class = "op" > < < / span > < span class = "ident" > authorization::Bearer< / span > < span class = "op" > > < / span > < span class = "ident" > ::parse< / span > (< span class = "ident" > req< / span > )
2021-03-22 11:49:07 +00:00
.< span class = "ident" > map< / span > (< span class = "op" > |< / span > < span class = "ident" > auth< / span > < span class = "op" > |< / span > < span class = "ident" > BearerAuth< / span > (< span class = "ident" > auth< / span > .< span class = "ident" > into_scheme< / span > ()))
.< span class = "ident" > map_err< / span > (< span class = "op" > |< / span > < span class = "kw" > _< / span > < span class = "op" > |< / span > {
< span class = "kw" > let< / span > < span class = "ident" > bearer< / span > < span class = "op" > =< / span > < span class = "ident" > req< / span >
2021-10-21 13:12:20 +00:00
.< span class = "ident" > app_data< / span > ::< span class = "op" > < < / span > < span class = "ident" > Config< / span > < span class = "op" > > < / span > ()
2021-03-22 11:49:07 +00:00
.< span class = "ident" > map< / span > (< span class = "op" > |< / span > < span class = "ident" > config< / span > < span class = "op" > |< / span > < span class = "ident" > config< / span > .< span class = "number" > 0< / span > .< span class = "ident" > clone< / span > ())
2021-04-09 13:42:26 +00:00
.< span class = "ident" > unwrap_or_else< / span > (< span class = "ident" > Default::default< / span > );
2021-03-22 11:49:07 +00:00
2021-04-09 13:42:26 +00:00
< span class = "ident" > AuthenticationError::new< / span > (< span class = "ident" > bearer< / span > )
2021-03-22 11:49:07 +00:00
}),
)
}
}
< span class = "kw" > impl< / span > < span class = "ident" > AuthExtractor< / span > < span class = "kw" > for< / span > < span class = "ident" > BearerAuth< / span > {
2021-08-30 22:13:55 +00:00
< span class = "kw" > type< / span > < span class = "ident" > Future< / span > < span class = "op" > =< / span > < span class = "ident" > Ready< / span > < span class = "op" > < < / span > < span class = "prelude-ty" > Result< / span > < span class = "op" > < < / span > < span class = "self" > Self< / span > , < span class = "ident" > < span class = "self" > Self< / span > ::Error< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > ;
2021-04-09 13:42:26 +00:00
< span class = "kw" > type< / span > < span class = "ident" > Error< / span > < span class = "op" > =< / span > < span class = "ident" > AuthenticationError< / span > < span class = "op" > < < / span > < span class = "ident" > bearer::Bearer< / span > < span class = "op" > > < / span > ;
2021-03-22 11:49:07 +00:00
2021-10-11 01:57:28 +00:00
< span class = "kw" > fn< / span > < span class = "ident" > from_service_request< / span > (< span class = "ident" > req< / span > : < span class = "kw-2" > & < / span > < span class = "ident" > ServiceRequest< / span > ) -> < span class = "ident" > < span class = "self" > Self< / span > ::Future< / span > {
2021-03-22 11:49:07 +00:00
< span class = "ident" > ready< / span > (
2021-04-09 13:42:26 +00:00
< span class = "ident" > authorization::Authorization< / span > ::< span class = "op" > < < / span > < span class = "ident" > authorization::Bearer< / span > < span class = "op" > > < / span > < span class = "ident" > ::parse< / span > (< span class = "ident" > req< / span > )
2021-03-22 11:49:07 +00:00
.< span class = "ident" > map< / span > (< span class = "op" > |< / span > < span class = "ident" > auth< / span > < span class = "op" > |< / span > < span class = "ident" > BearerAuth< / span > (< span class = "ident" > auth< / span > .< span class = "ident" > into_scheme< / span > ()))
.< span class = "ident" > map_err< / span > (< span class = "op" > |< / span > < span class = "kw" > _< / span > < span class = "op" > |< / span > {
< span class = "kw" > let< / span > < span class = "ident" > bearer< / span > < span class = "op" > =< / span > < span class = "ident" > req< / span >
.< span class = "ident" > app_data< / span > ::< span class = "op" > < < / span > < span class = "ident" > Config< / span > < span class = "op" > > < / span > ()
.< span class = "ident" > map< / span > (< span class = "op" > |< / span > < span class = "ident" > config< / span > < span class = "op" > |< / span > < span class = "ident" > config< / span > .< span class = "number" > 0< / span > .< span class = "ident" > clone< / span > ())
2021-04-09 13:42:26 +00:00
.< span class = "ident" > unwrap_or_else< / span > (< span class = "ident" > Default::default< / span > );
2021-03-22 11:49:07 +00:00
2021-04-09 13:42:26 +00:00
< span class = "ident" > AuthenticationError::new< / span > (< span class = "ident" > bearer< / span > )
2021-03-22 11:49:07 +00:00
}),
)
}
}
< span class = "doccomment" > /// Extended error customization for HTTP `Bearer` auth.< / span >
2021-04-09 13:42:26 +00:00
< span class = "kw" > impl< / span > < span class = "ident" > AuthenticationError< / span > < span class = "op" > < < / span > < span class = "ident" > bearer::Bearer< / span > < span class = "op" > > < / span > {
2021-03-22 11:49:07 +00:00
< span class = "doccomment" > /// Attach `Error` to the current Authentication error.< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// Error status code will be changed to the one provided by the `kind`< / span >
< span class = "doccomment" > /// Error.< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > with_error< / span > (< span class = "kw-2" > mut< / span > < span class = "self" > self< / span > , < span class = "ident" > kind< / span > : < span class = "ident" > Error< / span > ) -> < span class = "self" > Self< / span > {
2021-03-22 11:49:07 +00:00
< span class = "kw-2" > *< / span > < span class = "self" > self< / span > .< span class = "ident" > status_code_mut< / span > () < span class = "op" > =< / span > < span class = "ident" > kind< / span > .< span class = "ident" > status_code< / span > ();
< span class = "self" > self< / span > .< span class = "ident" > challenge_mut< / span > ().< span class = "ident" > error< / span > < span class = "op" > =< / span > < span class = "prelude-val" > Some< / span > (< span class = "ident" > kind< / span > );
< span class = "self" > self< / span >
}
< span class = "doccomment" > /// Attach error description to the current Authentication error.< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > with_error_description< / span > < span class = "op" > < < / span > < span class = "ident" > T< / span > < span class = "op" > > < / span > (< span class = "kw-2" > mut< / span > < span class = "self" > self< / span > , < span class = "ident" > desc< / span > : < span class = "ident" > T< / span > ) -> < span class = "self" > Self< / span >
2021-03-22 11:49:07 +00:00
< span class = "kw" > where< / span >
< span class = "ident" > T< / span > : < span class = "ident" > Into< / span > < span class = "op" > < < / span > < span class = "ident" > Cow< / span > < span class = "op" > < < / span > < span class = "lifetime" > ' static< / span > , < span class = "ident" > str< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > ,
{
< span class = "self" > self< / span > .< span class = "ident" > challenge_mut< / span > ().< span class = "ident" > error_description< / span > < span class = "op" > =< / span > < span class = "prelude-val" > Some< / span > (< span class = "ident" > desc< / span > .< span class = "ident" > into< / span > ());
< span class = "self" > self< / span >
}
< span class = "doccomment" > /// Attach error URI to the current Authentication error.< / span >
< span class = "doccomment" > ///< / span >
< span class = "doccomment" > /// It is up to implementor to provide properly formed absolute URI.< / span >
2021-10-11 01:57:28 +00:00
< span class = "kw" > pub< / span > < span class = "kw" > fn< / span > < span class = "ident" > with_error_uri< / span > < span class = "op" > < < / span > < span class = "ident" > T< / span > < span class = "op" > > < / span > (< span class = "kw-2" > mut< / span > < span class = "self" > self< / span > , < span class = "ident" > uri< / span > : < span class = "ident" > T< / span > ) -> < span class = "self" > Self< / span >
2021-03-22 11:49:07 +00:00
< span class = "kw" > where< / span >
< span class = "ident" > T< / span > : < span class = "ident" > Into< / span > < span class = "op" > < < / span > < span class = "ident" > Cow< / span > < span class = "op" > < < / span > < span class = "lifetime" > ' static< / span > , < span class = "ident" > str< / span > < span class = "op" > > < / span > < span class = "op" > > < / span > ,
{
< span class = "self" > self< / span > .< span class = "ident" > challenge_mut< / span > ().< span class = "ident" > error_uri< / span > < span class = "op" > =< / span > < span class = "prelude-val" > Some< / span > (< span class = "ident" > uri< / span > .< span class = "ident" > into< / span > ());
< span class = "self" > self< / span >
}
}
2021-08-30 22:13:55 +00:00
< / code > < / pre > < / div >
2021-12-08 06:19:44 +00:00
< / section > < section id = "search" class = "content hidden" > < / section > < / div > < / main > < div id = "rustdoc-vars" data-root-path = "../../../" data-current-crate = "actix_web_httpauth" data-themes = "ayu,dark,light" data-resource-suffix = "" data-rustdoc-version = "1.59.0-nightly (0b6f079e4 2021-12-07)" > < / div >
2021-06-27 06:05:12 +00:00
< / body > < / html >
