    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

    //! Extractor for the "Bearer" HTTP Authentication Scheme

    use std::{borrow::Cow, default::Default};

    use actix_utils::future::{ready, Ready};
    use actix_web::{
        dev::{Payload, ServiceRequest},
        http::header::Header,
        FromRequest, HttpRequest,
    };

    use super::{config::AuthExtractorConfig, errors::AuthenticationError, AuthExtractor};
    pub use crate::headers::www_authenticate::bearer::Error;
    use crate::headers::{authorization, www_authenticate::bearer};

    /// [BearerAuth](./struct/BearerAuth.html) extractor configuration.
    #[derive(Debug, Clone, Default)]
    pub struct Config(bearer::Bearer);

    impl Config {
        /// Set challenge `scope` attribute.
        ///
        /// The `"scope"` attribute is a space-delimited list of case-sensitive
        /// scope values indicating the required scope of the access token for
        /// accessing the requested resource.
        pub fn scope<T: Into<Cow<'static, str>>>(mut self, value: T) -> Config {
            self.0.scope = Some(value.into());
            self
        }

        /// Set challenge `realm` attribute.
        ///
        /// The "realm" attribute indicates the scope of protection in the manner
        /// described in HTTP/1.1 [RFC2617](https://tools.ietf.org/html/rfc2617#section-1.2).
        pub fn realm<T: Into<Cow<'static, str>>>(mut self, value: T) -> Config {
            self.0.realm = Some(value.into());
            self
        }
    }

    impl AsRef<bearer::Bearer> for Config {
        fn as_ref(&self) -> &bearer::Bearer {
            &self.0
        }
    }

    impl AuthExtractorConfig for Config {
        type Inner = bearer::Bearer;

        fn into_inner(self) -> Self::Inner {
            self.0
        }
    }

    // Needs `fn main` to display complete example.
    #[allow(clippy::needless_doctest_main)]
    /// Extractor for HTTP Bearer auth
    ///
    /// # Example
    ///
    /// ```
    /// use actix_web_httpauth::extractors::bearer::BearerAuth;
    ///
    /// async fn index(auth: BearerAuth) -> String {
    ///     format!("Hello, user with token {}!", auth.token())
    /// }
    /// ```
    ///
    /// If authentication fails, this extractor fetches the [`Config`] instance
    /// from the [app data] in order to properly form the `WWW-Authenticate`
    /// response header.
    ///
    /// ## Example
    ///
    /// ```
    /// use actix_web::{web, App};
    /// use actix_web_httpauth::extractors::bearer::{BearerAuth, Config};
    ///
    /// async fn index(auth: BearerAuth) -> String {
    ///     format!("Hello, {}!", auth.token())
    /// }
    ///
    /// fn main() {
    ///     let app = App::new()
    ///         .app_data(
    ///             Config::default()
    ///                 .realm("Restricted area")
    ///                 .scope("email photo"),
    ///         )
    ///         .service(web::resource("/index.html").route(web::get().to(index)));
    /// }
    /// ```
    #[derive(Debug, Clone)]
    pub struct BearerAuth(authorization::Bearer);

    impl BearerAuth {
        /// Returns bearer token provided by client.
        pub fn token(&self) -> &str {
            self.0.token()
        }
    }

    impl FromRequest for BearerAuth {
        type Future = Ready<Result<Self, Self::Error>>;
        type Error = AuthenticationError<bearer::Bearer>;

        fn from_request(req: &HttpRequest, _payload: &mut Payload) -> <Self as FromRequest>::Future {
            ready(
                authorization::Authorization::<authorization::Bearer>::parse(req)
                    .map(|auth| BearerAuth(auth.into_scheme()))
                    .map_err(|_| {
                        let bearer = req
                            .app_data::<Config>()
                            .map(|config| config.0.clone())
                            .unwrap_or_else(Default::default);

                        AuthenticationError::new(bearer)
                    }),
            )
        }
    }

    impl AuthExtractor for BearerAuth {
        type Future = Ready<Result<Self, Self::Error>>;
        type Error = AuthenticationError<bearer::Bearer>;

        fn from_service_request(req: &ServiceRequest) -> Self::Future {
            ready(
                authorization::Authorization::<authorization::Bearer>::parse(req)
                    .map(|auth| BearerAuth(auth.into_scheme()))
                    .map_err(|_| {
                        let bearer = req
                            .app_data::<Config>()
                            .map(|config| config.0.clone())
                            .unwrap_or_else(Default::default);

                        AuthenticationError::new(bearer)
                    }),
            )
        }
    }

    /// Extended error customization for HTTP `Bearer` auth.
    impl AuthenticationError<bearer::Bearer> {
        /// Attach `Error` to the current Authentication error.
        ///
        /// Error status code will be changed to the one provided by the `kind`
        /// Error.
        pub fn with_error(mut self, kind: Error) -> Self {
            *self.status_code_mut() = kind.status_code();
            self.challenge_mut().error = Some(kind);
            self
        }

        /// Attach error description to the current Authentication error.
        pub fn with_error_description<T>(mut self, desc: T) -> Self
        where
            T: Into<Cow<'static, str>>,
        {
            self.challenge_mut().error_description = Some(desc.into());
            self
        }

        /// Attach error URI to the current Authentication error.
        ///
        /// It is up to implementor to provide properly formed absolute URI.
        pub fn with_error_uri<T>(mut self, uri: T) -> Self
        where
            T: Into<Cow<'static, str>>,
        {
            self.challenge_mut().error_uri = Some(uri.into());
            self
        }
    }