2022-10-28 22:47:36 +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/middleware.rs`." > < meta name = "keywords" content = "rust, rustlang, rust-lang" > < title > middleware.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" href = "../../normalize.css" > < link rel = "stylesheet" href = "../../rustdoc.css" id = "mainThemeStyle" > < link rel = "stylesheet" href = "../../ayu.css" disabled > < link rel = "stylesheet" href = "../../dark.css" disabled > < link rel = "stylesheet" href = "../../light.css" id = "themeStyle" > < script id = "default-settings" > < / script > < script src = "../../storage.js" > < / script > < script defer src = "../../source-script.js" > < / script > < script defer src = "../../source-files.js" > < / script > < script defer src = "../../main.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" > < / nav > < main > < div class = "width-limiter" > < nav class = "sub" > < a class = "sub-logo-container" href = "../../actix_web_httpauth/index.html" > < img class = "rust-logo" src = "../../rust-logo.svg" alt = "logo" > < / a > < form class = "search-form" > < div class = "search-container" > < span > < / span > < input class = "search-input" name = "search" autocomplete = "off" spellcheck = "false" placeholder = "Click or press ‘ ’ ‘ ’ type = "search" > < div id = "help-button" title = "help" tabindex = "-1" > < a href = "../../help.html" > ?< / a > < / div > < div id = "settings-menu" tabindex = "-1" > < a href = "../../settings.html" title = "settings" > < img width = "22" height = "22" alt = "Change settings" src = "../../wheel.svg" > < / a > < / div > < / div > < / form > < / nav > < section id = "main-content" class = "content" > < div class = "example-wrap" > < pre class = "src-line-numbers" > < span id = "1" > 1< / span >
2022-03-15 16:29:58 +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 >
2021-03-22 11:49:07 +00:00
< 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 >
< span id = "177" > 177< / span >
< span id = "178" > 178< / span >
< span id = "179" > 179< / span >
< span id = "180" > 180< / span >
< span id = "181" > 181< / span >
< span id = "182" > 182< / span >
< span id = "183" > 183< / span >
< span id = "184" > 184< / span >
< span id = "185" > 185< / span >
< span id = "186" > 186< / span >
< span id = "187" > 187< / span >
< span id = "188" > 188< / span >
< span id = "189" > 189< / span >
< span id = "190" > 190< / span >
< span id = "191" > 191< / span >
< span id = "192" > 192< / span >
< span id = "193" > 193< / span >
< span id = "194" > 194< / span >
< span id = "195" > 195< / span >
< span id = "196" > 196< / span >
< span id = "197" > 197< / span >
< span id = "198" > 198< / span >
< span id = "199" > 199< / span >
< span id = "200" > 200< / span >
< span id = "201" > 201< / span >
< span id = "202" > 202< / span >
< span id = "203" > 203< / span >
< span id = "204" > 204< / span >
< span id = "205" > 205< / span >
< span id = "206" > 206< / span >
< span id = "207" > 207< / span >
< span id = "208" > 208< / span >
< span id = "209" > 209< / span >
< span id = "210" > 210< / span >
< span id = "211" > 211< / span >
< span id = "212" > 212< / span >
< span id = "213" > 213< / span >
< span id = "214" > 214< / span >
< span id = "215" > 215< / span >
< span id = "216" > 216< / span >
< span id = "217" > 217< / span >
< span id = "218" > 218< / span >
< span id = "219" > 219< / span >
< span id = "220" > 220< / span >
< span id = "221" > 221< / span >
< span id = "222" > 222< / span >
< span id = "223" > 223< / span >
< span id = "224" > 224< / span >
< span id = "225" > 225< / span >
< span id = "226" > 226< / span >
< span id = "227" > 227< / span >
< span id = "228" > 228< / span >
< span id = "229" > 229< / span >
< span id = "230" > 230< / span >
< span id = "231" > 231< / span >
< span id = "232" > 232< / span >
< span id = "233" > 233< / span >
< span id = "234" > 234< / span >
< span id = "235" > 235< / span >
< span id = "236" > 236< / span >
< span id = "237" > 237< / span >
< span id = "238" > 238< / span >
< span id = "239" > 239< / span >
< span id = "240" > 240< / span >
< span id = "241" > 241< / span >
< span id = "242" > 242< / span >
< span id = "243" > 243< / span >
< span id = "244" > 244< / span >
< span id = "245" > 245< / span >
< span id = "246" > 246< / span >
< span id = "247" > 247< / span >
< span id = "248" > 248< / span >
< span id = "249" > 249< / span >
< span id = "250" > 250< / span >
< span id = "251" > 251< / span >
< span id = "252" > 252< / span >
< span id = "253" > 253< / span >
< span id = "254" > 254< / span >
< span id = "255" > 255< / span >
< span id = "256" > 256< / span >
< span id = "257" > 257< / span >
< span id = "258" > 258< / span >
< span id = "259" > 259< / span >
< span id = "260" > 260< / span >
< span id = "261" > 261< / span >
< span id = "262" > 262< / span >
< span id = "263" > 263< / span >
< span id = "264" > 264< / span >
< span id = "265" > 265< / span >
< span id = "266" > 266< / span >
< span id = "267" > 267< / span >
< span id = "268" > 268< / span >
< span id = "269" > 269< / span >
< span id = "270" > 270< / span >
< span id = "271" > 271< / span >
< span id = "272" > 272< / span >
< span id = "273" > 273< / span >
< span id = "274" > 274< / span >
< span id = "275" > 275< / span >
< span id = "276" > 276< / span >
< span id = "277" > 277< / span >
< span id = "278" > 278< / span >
< span id = "279" > 279< / span >
< span id = "280" > 280< / span >
< span id = "281" > 281< / span >
< span id = "282" > 282< / span >
< span id = "283" > 283< / span >
< span id = "284" > 284< / span >
< span id = "285" > 285< / span >
< span id = "286" > 286< / span >
< span id = "287" > 287< / span >
< span id = "288" > 288< / span >
< span id = "289" > 289< / span >
< span id = "290" > 290< / span >
< span id = "291" > 291< / span >
< span id = "292" > 292< / span >
< span id = "293" > 293< / span >
< span id = "294" > 294< / span >
< span id = "295" > 295< / span >
< span id = "296" > 296< / span >
< span id = "297" > 297< / span >
< span id = "298" > 298< / span >
< span id = "299" > 299< / span >
< span id = "300" > 300< / span >
< span id = "301" > 301< / span >
< span id = "302" > 302< / span >
2021-06-27 06:05:12 +00:00
< span id = "303" > 303< / span >
< span id = "304" > 304< / span >
< span id = "305" > 305< / span >
< span id = "306" > 306< / span >
< span id = "307" > 307< / span >
< span id = "308" > 308< / span >
< span id = "309" > 309< / span >
< span id = "310" > 310< / span >
< span id = "311" > 311< / span >
< span id = "312" > 312< / span >
2021-10-26 20:12:39 +00:00
< span id = "313" > 313< / span >
< span id = "314" > 314< / span >
< span id = "315" > 315< / span >
< span id = "316" > 316< / span >
< span id = "317" > 317< / span >
< span id = "318" > 318< / span >
< span id = "319" > 319< / span >
< span id = "320" > 320< / span >
< span id = "321" > 321< / span >
< span id = "322" > 322< / span >
< span id = "323" > 323< / span >
< span id = "324" > 324< / span >
< span id = "325" > 325< / span >
< span id = "326" > 326< / span >
< span id = "327" > 327< / span >
< span id = "328" > 328< / span >
< span id = "329" > 329< / span >
< span id = "330" > 330< / span >
< span id = "331" > 331< / span >
< span id = "332" > 332< / span >
< span id = "333" > 333< / span >
< span id = "334" > 334< / span >
< span id = "335" > 335< / span >
< span id = "336" > 336< / span >
< span id = "337" > 337< / span >
< span id = "338" > 338< / span >
< span id = "339" > 339< / span >
< span id = "340" > 340< / span >
< span id = "341" > 341< / span >
< span id = "342" > 342< / span >
< span id = "343" > 343< / span >
< span id = "344" > 344< / span >
< span id = "345" > 345< / span >
< span id = "346" > 346< / span >
< span id = "347" > 347< / span >
< span id = "348" > 348< / span >
< span id = "349" > 349< / span >
< span id = "350" > 350< / span >
< span id = "351" > 351< / span >
< span id = "352" > 352< / span >
< span id = "353" > 353< / span >
< span id = "354" > 354< / span >
< span id = "355" > 355< / span >
< span id = "356" > 356< / span >
< span id = "357" > 357< / span >
2022-03-01 04:22:48 +00:00
< span id = "358" > 358< / span >
< span id = "359" > 359< / span >
< span id = "360" > 360< / span >
< span id = "361" > 361< / span >
< span id = "362" > 362< / span >
< span id = "363" > 363< / span >
< span id = "364" > 364< / span >
< span id = "365" > 365< / span >
< span id = "366" > 366< / span >
< span id = "367" > 367< / span >
< span id = "368" > 368< / span >
< span id = "369" > 369< / span >
< span id = "370" > 370< / span >
< span id = "371" > 371< / span >
< span id = "372" > 372< / span >
< span id = "373" > 373< / span >
< span id = "374" > 374< / span >
< span id = "375" > 375< / span >
< span id = "376" > 376< / span >
< span id = "377" > 377< / span >
< span id = "378" > 378< / span >
< span id = "379" > 379< / span >
< span id = "380" > 380< / span >
< span id = "381" > 381< / span >
< span id = "382" > 382< / span >
< span id = "383" > 383< / span >
< span id = "384" > 384< / span >
< span id = "385" > 385< / span >
< span id = "386" > 386< / span >
< span id = "387" > 387< / span >
< span id = "388" > 388< / span >
< span id = "389" > 389< / span >
< span id = "390" > 390< / span >
< span id = "391" > 391< / span >
< span id = "392" > 392< / span >
< span id = "393" > 393< / span >
< span id = "394" > 394< / span >
< span id = "395" > 395< / span >
< span id = "396" > 396< / span >
< span id = "397" > 397< / span >
< span id = "398" > 398< / span >
< span id = "399" > 399< / span >
< span id = "400" > 400< / span >
< span id = "401" > 401< / span >
< span id = "402" > 402< / span >
< span id = "403" > 403< / span >
< span id = "404" > 404< / span >
< span id = "405" > 405< / span >
< span id = "406" > 406< / span >
< span id = "407" > 407< / span >
< span id = "408" > 408< / span >
< span id = "409" > 409< / span >
< span id = "410" > 410< / span >
< span id = "411" > 411< / span >
< span id = "412" > 412< / span >
2022-03-29 10:59:51 +00:00
< span id = "413" > 413< / span >
2022-07-19 00:49:23 +00:00
< span id = "414" > 414< / span >
< span id = "415" > 415< / span >
< span id = "416" > 416< / span >
2022-07-21 01:52:33 +00:00
< span id = "417" > 417< / span >
2022-08-24 17:10:06 +00:00
< / pre > < pre class = "rust" > < code > < span class = "doccomment" > //! HTTP Authentication middleware.
< / span > < span class = "kw" > use < / span > std::{
future::Future,
marker::PhantomData,
pin::Pin,
rc::Rc,
sync::Arc,
task::{Context, Poll},
2021-06-27 06:05:12 +00:00
};
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > use < / span > actix_web::{
body::{EitherBody, MessageBody},
dev::{Service, ServiceRequest, ServiceResponse, Transform},
Error, FromRequest,
2021-03-22 11:49:07 +00:00
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > use < / span > futures_core::ready;
< span class = "kw" > use < / span > futures_util::future::{< span class = "self" > self< / span > , LocalBoxFuture, TryFutureExt < span class = "kw" > as _< / span > };
< span class = "kw" > use < / span > < span class = "kw" > crate< / span > ::extractors::{basic, bearer};
< span class = "doccomment" > /// Middleware for checking HTTP authentication.
///
/// If there is no `Authorization` header in the request, this middleware returns an error
/// immediately, without calling the `F` callback.
///
/// Otherwise, it will pass both the request and the parsed credentials into it. In case of
/// successful validation `F` callback is required to return the `ServiceRequest` back.
< / span > < span class = "attribute" > #[derive(Debug, Clone)]
< / span > < span class = "kw" > pub struct < / span > HttpAuthentication< T, F>
< span class = "kw" > where
< / span > T: FromRequest,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
process_fn: Arc< F> ,
_extractor: PhantomData< T> ,
2021-03-22 11:49:07 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < T, F, O> HttpAuthentication< T, F>
< span class = "kw" > where
< / span > T: FromRequest,
F: Fn(ServiceRequest, T) -> O,
O: Future< Output = < span class = "prelude-ty" > Result< / span > < ServiceRequest, (Error, ServiceRequest)> > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "doccomment" > /// Construct `HttpAuthentication` middleware with the provided auth extractor `T` and
/// validation callback `F`.
< / span > < span class = "kw" > pub fn < / span > with_fn(process_fn: F) -> HttpAuthentication< T, F> {
HttpAuthentication {
process_fn: Arc::new(process_fn),
_extractor: PhantomData,
2021-03-22 11:49:07 +00:00
}
}
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < F, O> HttpAuthentication< basic::BasicAuth, F>
< span class = "kw" > where
< / span > F: Fn(ServiceRequest, basic::BasicAuth) -> O,
O: Future< Output = < span class = "prelude-ty" > Result< / span > < ServiceRequest, (Error, ServiceRequest)> > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "doccomment" > /// Construct `HttpAuthentication` middleware for the HTTP " Basic" authentication scheme.
///
/// # Examples
/// ```
/// # use actix_web::{Error, dev::ServiceRequest};
/// # use actix_web_httpauth::{extractors::basic::BasicAuth, middleware::HttpAuthentication};
/// // In this example validator returns immediately, but since it is required to return
/// // anything that implements `IntoFuture` trait, it can be extended to query database or to
/// // do something else in a async manner.
/// async fn validator(
/// req: ServiceRequest,
/// credentials: BasicAuth,
/// ) -> Result< ServiceRequest, (Error, ServiceRequest)> {
/// // All users are great and more than welcome!
/// Ok(req)
/// }
///
/// let middleware = HttpAuthentication::basic(validator);
/// ```
< / span > < span class = "kw" > pub fn < / span > basic(process_fn: F) -> < span class = "self" > Self < / span > {
< span class = "self" > Self< / span > ::with_fn(process_fn)
2021-03-22 11:49:07 +00:00
}
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < F, O> HttpAuthentication< bearer::BearerAuth, F>
< span class = "kw" > where
< / span > F: Fn(ServiceRequest, bearer::BearerAuth) -> O,
O: Future< Output = < span class = "prelude-ty" > Result< / span > < ServiceRequest, (Error, ServiceRequest)> > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "doccomment" > /// Construct `HttpAuthentication` middleware for the HTTP " Bearer" authentication scheme.
///
/// # Examples
/// ```
/// # use actix_web::{Error, dev::ServiceRequest};
/// # use actix_web_httpauth::{
/// # extractors::{AuthenticationError, AuthExtractorConfig, bearer::{self, BearerAuth}},
/// # middleware::HttpAuthentication,
/// # };
/// async fn validator(
/// req: ServiceRequest,
/// credentials: BearerAuth
/// ) -> Result< ServiceRequest, (Error, ServiceRequest)> {
/// if credentials.token() == " mF_9.B5f-4.1JqM" {
/// Ok(req)
/// } else {
/// let config = req.app_data::< bearer::Config> ()
/// .cloned()
/// .unwrap_or_default()
/// .scope(" urn:example:channel=HBO& urn:example:rating=G,PG-13" );
///
/// Err((AuthenticationError::from(config).into(), req))
/// }
/// }
///
/// let middleware = HttpAuthentication::bearer(validator);
/// ```
< / span > < span class = "kw" > pub fn < / span > bearer(process_fn: F) -> < span class = "self" > Self < / span > {
< span class = "self" > Self< / span > ::with_fn(process_fn)
2021-03-22 11:49:07 +00:00
}
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < S, B, T, F, O> Transform< S, ServiceRequest> < span class = "kw" > for < / span > HttpAuthentication< T, F>
< span class = "kw" > where
< / span > S: Service< ServiceRequest, Response = ServiceResponse< B> , Error = Error> + < span class = "lifetime" > ' static< / span > ,
S::Future: < span class = "lifetime" > ' static< / span > ,
F: Fn(ServiceRequest, T) -> O + < span class = "lifetime" > ' static< / span > ,
O: Future< Output = < span class = "prelude-ty" > Result< / span > < ServiceRequest, (Error, ServiceRequest)> > + < span class = "lifetime" > ' static< / span > ,
T: FromRequest + < span class = "lifetime" > ' static< / span > ,
B: MessageBody + < span class = "lifetime" > ' static< / span > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "kw" > type < / span > Response = ServiceResponse< EitherBody< B> > ;
< span class = "kw" > type < / span > Error = Error;
< span class = "kw" > type < / span > Transform = AuthenticationMiddleware< S, F, T> ;
< span class = "kw" > type < / span > InitError = ();
< span class = "kw" > type < / span > Future = future::Ready< < span class = "prelude-ty" > Result< / span > < < span class = "self" > Self< / span > ::Transform, < span class = "self" > Self< / span > ::InitError> > ;
< span class = "kw" > fn < / span > new_transform(< span class = "kw-2" > & < / span > < span class = "self" > self< / span > , service: S) -> < span class = "self" > Self< / span > ::Future {
future::ok(AuthenticationMiddleware {
service: Rc::new(service),
process_fn: < span class = "self" > self< / span > .process_fn.clone(),
_extractor: PhantomData,
2021-03-22 11:49:07 +00:00
})
}
}
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[doc(hidden)]
< / span > < span class = "kw" > pub struct < / span > AuthenticationMiddleware< S, F, T>
< span class = "kw" > where
< / span > T: FromRequest,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
service: Rc< S> ,
process_fn: Arc< F> ,
_extractor: PhantomData< T> ,
2021-03-22 11:49:07 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < S, B, F, T, O> Service< ServiceRequest> < span class = "kw" > for < / span > AuthenticationMiddleware< S, F, T>
< span class = "kw" > where
< / span > S: Service< ServiceRequest, Response = ServiceResponse< B> , Error = Error> + < span class = "lifetime" > ' static< / span > ,
S::Future: < span class = "lifetime" > ' static< / span > ,
F: Fn(ServiceRequest, T) -> O + < span class = "lifetime" > ' static< / span > ,
O: Future< Output = < span class = "prelude-ty" > Result< / span > < ServiceRequest, (Error, ServiceRequest)> > + < span class = "lifetime" > ' static< / span > ,
T: FromRequest + < span class = "lifetime" > ' static< / span > ,
B: MessageBody + < span class = "lifetime" > ' static< / span > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "kw" > type < / span > Response = ServiceResponse< EitherBody< B> > ;
< span class = "kw" > type < / span > Error = S::Error;
< span class = "kw" > type < / span > Future = LocalBoxFuture< < span class = "lifetime" > ' static< / span > , < span class = "prelude-ty" > Result< / span > < < span class = "self" > Self< / span > ::Response, < span class = "self" > Self< / span > ::Error> > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "macro" > actix_web::dev::forward_ready!< / span > (service);
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > fn < / span > call(< span class = "kw-2" > & < / span > < span class = "self" > self< / span > , req: ServiceRequest) -> < span class = "self" > Self< / span > ::Future {
< span class = "kw" > let < / span > process_fn = Arc::clone(< span class = "kw-2" > & < / span > < span class = "self" > self< / span > .process_fn);
< span class = "kw" > let < / span > service = Rc::clone(< span class = "kw-2" > & < / span > < span class = "self" > self< / span > .service);
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
Box::pin(< span class = "kw" > async move < / span > {
< span class = "kw" > let < / span > (req, credentials) = < span class = "kw" > match < / span > Extract::< T> ::new(req).< span class = "kw" > await < / span > {
< span class = "prelude-val" > Ok< / span > (req) => req,
< span class = "prelude-val" > Err< / span > ((err, req)) => {
< span class = "kw" > return < / span > < span class = "prelude-val" > Ok< / span > (req.error_response(err).map_into_right_body());
2021-03-22 11:49:07 +00:00
}
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = < span class = "kw" > match < / span > process_fn(req, credentials).< span class = "kw" > await < / span > {
< span class = "prelude-val" > Ok< / span > (req) => req,
< span class = "prelude-val" > Err< / span > ((err, req)) => {
< span class = "kw" > return < / span > < span class = "prelude-val" > Ok< / span > (req.error_response(err).map_into_right_body());
2022-07-19 00:49:23 +00:00
}
};
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
service.call(req).< span class = "kw" > await< / span > .map(|res| res.map_into_left_body())
2022-07-22 19:14:32 +00:00
})
2021-03-22 11:49:07 +00:00
}
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > struct < / span > Extract< T> {
req: < span class = "prelude-ty" > Option< / span > < ServiceRequest> ,
fut: < span class = "prelude-ty" > Option< / span > < LocalBoxFuture< < span class = "lifetime" > ' static< / span > , < span class = "prelude-ty" > Result< / span > < T, Error> > > ,
_extractor: PhantomData< < span class = "kw" > fn< / span > () -> T> ,
2021-03-22 11:49:07 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < T> Extract< T> {
< span class = "kw" > pub fn < / span > new(req: ServiceRequest) -> < span class = "self" > Self < / span > {
Extract {
req: < span class = "prelude-val" > Some< / span > (req),
fut: < span class = "prelude-val" > None< / span > ,
_extractor: PhantomData,
2021-03-22 11:49:07 +00:00
}
}
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > impl< / span > < T> Future < span class = "kw" > for < / span > Extract< T>
< span class = "kw" > where
< / span > T: FromRequest,
T::Future: < span class = "lifetime" > ' static< / span > ,
T::Error: < span class = "lifetime" > ' static< / span > ,
2021-03-22 11:49:07 +00:00
{
2022-08-24 17:10:06 +00:00
< span class = "kw" > type < / span > Output = < span class = "prelude-ty" > Result< / span > < (ServiceRequest, T), (Error, ServiceRequest)> ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > fn < / span > poll(< span class = "kw-2" > mut < / span > < span class = "self" > self< / span > : Pin< < span class = "kw-2" > & mut < / span > < span class = "self" > Self< / span > > , ctx: < span class = "kw-2" > & mut < / span > Context< < span class = "lifetime" > ' _< / span > > ) -> Poll< < span class = "self" > Self< / span > ::Output> {
< span class = "kw" > if < / span > < span class = "self" > self< / span > .fut.is_none() {
< span class = "kw" > let < / span > req = < span class = "self" > self< / span > .req.as_mut().expect(< span class = "string" > " Extract future was polled twice!" < / span > );
< span class = "kw" > let < / span > fut = req.extract::< T> ().map_err(Into::into);
< span class = "self" > self< / span > .fut = < span class = "prelude-val" > Some< / span > (Box::pin(fut));
2021-03-22 11:49:07 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > fut = < span class = "self" > self
< / span > .fut
.as_mut()
.expect(< span class = "string" > " Extraction future should be initialized at this point" < / span > );
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > credentials = < span class = "macro" > ready!< / span > (fut.as_mut().poll(ctx)).map_err(|err| {
2021-03-22 11:49:07 +00:00
(
2022-08-24 17:10:06 +00:00
err,
< span class = "comment" > // returning request allows a proper error response to be created
< / span > < span class = "self" > self< / span > .req.take().expect(< span class = "string" > " Extract future was polled twice!" < / span > ),
2021-03-22 11:49:07 +00:00
)
})< span class = "question-mark" > ?< / span > ;
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = < span class = "self" > self< / span > .req.take().expect(< span class = "string" > " Extract future was polled twice!" < / span > );
Poll::Ready(< span class = "prelude-val" > Ok< / span > ((req, credentials)))
2021-03-22 11:49:07 +00:00
}
}
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[cfg(test)]
< / span > < span class = "kw" > mod < / span > tests {
< span class = "kw" > use < / span > actix_service::into_service;
< span class = "kw" > use < / span > actix_web::{
dev::Service,
error::{< span class = "self" > self< / span > , ErrorForbidden},
http::StatusCode,
test::TestRequest,
web, App, HttpResponse,
2022-07-21 01:52:33 +00:00
};
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > use super< / span > ::< span class = "kw-2" > *< / span > ;
< span class = "kw" > use < / span > < span class = "kw" > crate< / span > ::extractors::{basic::BasicAuth, bearer::BearerAuth};
2022-03-29 10:59:51 +00:00
2022-08-24 17:10:06 +00:00
< span class = "doccomment" > /// This is a test for https://github.com/actix/actix-extras/issues/10
< / span > < span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_panic() {
< span class = "kw" > let < / span > middleware = AuthenticationMiddleware {
service: Rc::new(into_service(|< span class = "kw" > _< / span > : ServiceRequest| < span class = "kw" > async move < / span > {
actix_web::rt::time::sleep(std::time::Duration::from_secs(< span class = "number" > 1< / span > )).< span class = "kw" > await< / span > ;
< span class = "prelude-val" > Err< / span > ::< ServiceResponse, < span class = "kw" > _< / span > > (error::ErrorBadRequest(< span class = "string" > " error" < / span > ))
2021-03-22 11:49:07 +00:00
})),
2022-08-24 17:10:06 +00:00
process_fn: Arc::new(|req, < span class = "kw" > _< / span > : BearerAuth| < span class = "kw" > async < / span > { < span class = "prelude-val" > Ok< / span > (req) }),
_extractor: PhantomData,
2021-03-22 11:49:07 +00:00
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Bearer 1" < / span > ))
.to_srv_request();
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f = middleware.call(req).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > _res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "macro" > assert!< / span > (f.is_err());
2021-03-22 11:49:07 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "doccomment" > /// This is a test for https://github.com/actix/actix-extras/issues/10
< / span > < span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_panic_several_orders() {
< span class = "kw" > let < / span > middleware = AuthenticationMiddleware {
service: Rc::new(into_service(|< span class = "kw" > _< / span > : ServiceRequest| < span class = "kw" > async move < / span > {
actix_web::rt::time::sleep(std::time::Duration::from_secs(< span class = "number" > 1< / span > )).< span class = "kw" > await< / span > ;
< span class = "prelude-val" > Err< / span > ::< ServiceResponse, < span class = "kw" > _< / span > > (error::ErrorBadRequest(< span class = "string" > " error" < / span > ))
2021-03-22 11:49:07 +00:00
})),
2022-08-24 17:10:06 +00:00
process_fn: Arc::new(|req, < span class = "kw" > _< / span > : BearerAuth| < span class = "kw" > async < / span > { < span class = "prelude-val" > Ok< / span > (req) }),
_extractor: PhantomData,
2021-03-22 11:49:07 +00:00
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Bearer 1" < / span > ))
.to_srv_request();
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f1 = middleware.call(req).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Bearer 1" < / span > ))
.to_srv_request();
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f2 = middleware.call(req).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Bearer 1" < / span > ))
.to_srv_request();
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f3 = middleware.call(req).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > _res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).< span class = "kw" > await< / span > ;
2021-03-22 11:49:07 +00:00
2022-08-24 17:10:06 +00:00
< span class = "macro" > assert!< / span > (f1.is_err());
< span class = "macro" > assert!< / span > (f2.is_err());
< span class = "macro" > assert!< / span > (f3.is_err());
2021-03-22 11:49:07 +00:00
}
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_opt_extractor() {
< span class = "kw" > let < / span > middleware = AuthenticationMiddleware {
service: Rc::new(into_service(|req: ServiceRequest| < span class = "kw" > async move < / span > {
< span class = "prelude-val" > Ok< / span > ::< ServiceResponse, < span class = "kw" > _< / span > > (req.into_response(HttpResponse::Ok().finish()))
2021-10-26 20:12:39 +00:00
})),
2022-08-24 17:10:06 +00:00
process_fn: Arc::new(|req, auth: < span class = "prelude-ty" > Option< / span > < BearerAuth> | {
< span class = "macro" > assert!< / span > (auth.is_none());
< span class = "kw" > async < / span > { < span class = "prelude-val" > Ok< / span > (req) }
2021-10-26 20:12:39 +00:00
}),
2022-08-24 17:10:06 +00:00
_extractor: PhantomData,
2021-10-26 20:12:39 +00:00
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization996" < / span > , < span class = "string" > " Bearer 1" < / span > ))
.to_srv_request();
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f = middleware.call(req).< span class = "kw" > await< / span > ;
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > _res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).< span class = "kw" > await< / span > ;
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "macro" > assert!< / span > (f.is_ok());
2021-10-26 20:12:39 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_res_extractor() {
< span class = "kw" > let < / span > middleware = AuthenticationMiddleware {
service: Rc::new(into_service(|req: ServiceRequest| < span class = "kw" > async move < / span > {
< span class = "prelude-val" > Ok< / span > ::< ServiceResponse, < span class = "kw" > _< / span > > (req.into_response(HttpResponse::Ok().finish()))
2021-10-26 20:12:39 +00:00
})),
2022-08-24 17:10:06 +00:00
process_fn: Arc::new(
|req, auth: < span class = "prelude-ty" > Result< / span > < BearerAuth, < BearerAuth < span class = "kw" > as < / span > FromRequest> ::Error> | {
< span class = "macro" > assert!< / span > (auth.is_err());
< span class = "kw" > async < / span > { < span class = "prelude-val" > Ok< / span > (req) }
2021-10-26 20:12:39 +00:00
},
),
2022-08-24 17:10:06 +00:00
_extractor: PhantomData,
2021-10-26 20:12:39 +00:00
};
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = TestRequest::get()
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " BearerLOL" < / span > ))
.to_srv_request();
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > f = middleware.call(req).< span class = "kw" > await< / span > ;
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > _res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).< span class = "kw" > await< / span > ;
2021-10-26 20:12:39 +00:00
2022-08-24 17:10:06 +00:00
< span class = "macro" > assert!< / span > (f.is_ok());
2021-10-26 20:12:39 +00:00
}
2022-03-01 04:22:48 +00:00
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_works_with_app() {
< span class = "kw" > async fn < / span > validator(
req: ServiceRequest,
_credentials: BasicAuth,
) -> < span class = "prelude-ty" > Result< / span > < ServiceRequest, (actix_web::Error, ServiceRequest)> {
< span class = "prelude-val" > Err< / span > ((ErrorForbidden(< span class = "string" > " You are not welcome!" < / span > ), req))
2022-03-01 04:22:48 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > middleware = HttpAuthentication::basic(validator);
2022-03-01 04:22:48 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > srv = actix_web::test::init_service(
App::new()
.wrap(middleware)
.route(< span class = "string" > " /" < / span > , web::get().to(HttpResponse::Ok)),
2022-03-01 04:22:48 +00:00
)
.< span class = "kw" > await< / span > ;
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = actix_web::test::TestRequest::with_uri(< span class = "string" > " /" < / span > )
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Basic DontCare" < / span > ))
.to_request();
2022-03-01 04:22:48 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > resp = srv.call(req).< span class = "kw" > await< / span > .unwrap();
< span class = "macro" > assert_eq!< / span > (resp.status(), StatusCode::UNAUTHORIZED);
2022-03-01 04:22:48 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "attribute" > #[actix_web::test]
< / span > < span class = "kw" > async fn < / span > test_middleware_works_with_scope() {
< span class = "kw" > async fn < / span > validator(
req: ServiceRequest,
_credentials: BasicAuth,
) -> < span class = "prelude-ty" > Result< / span > < ServiceRequest, (actix_web::Error, ServiceRequest)> {
< span class = "prelude-val" > Err< / span > ((ErrorForbidden(< span class = "string" > " You are not welcome!" < / span > ), req))
2022-03-01 04:22:48 +00:00
}
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > middleware = actix_web::middleware::Compat::new(HttpAuthentication::basic(validator));
2022-03-01 04:22:48 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > srv = actix_web::test::init_service(
App::new().service(
web::scope(< span class = "string" > " /" < / span > )
.wrap(middleware)
.route(< span class = "string" > " /" < / span > , web::get().to(HttpResponse::Ok)),
2022-03-01 04:22:48 +00:00
),
)
.< span class = "kw" > await< / span > ;
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > req = actix_web::test::TestRequest::with_uri(< span class = "string" > " /" < / span > )
.append_header((< span class = "string" > " Authorization" < / span > , < span class = "string" > " Basic DontCare" < / span > ))
.to_request();
2022-03-01 04:22:48 +00:00
2022-08-24 17:10:06 +00:00
< span class = "kw" > let < / span > resp = srv.call(req).< span class = "kw" > await< / span > .unwrap();
< span class = "macro" > assert_eq!< / span > (resp.status(), StatusCode::UNAUTHORIZED);
2022-03-01 04:22:48 +00:00
}
2021-03-22 11:49:07 +00:00
}
2021-08-30 22:13:55 +00:00
< / code > < / pre > < / div >
2022-10-28 22:47:36 +00:00
< / 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.66.0-nightly (0da281b60 2022-10-27)" > < / div > < / body > < / html >
