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
// Copyright 2020 Dmitry Tantsur <dtantsur@protonmail.com>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! HTTP basic authentication.
use async_trait::async_trait;
use reqwest::{Client, RequestBuilder, Url};
use static_assertions::assert_impl_all;
use super::{AuthType, EndpointFilters, Error, ErrorKind};
/// Authentication type that uses HTTP basic authentication.
///
/// This type always uses a pre-defined endpoint:
/// ```rust,no_run
/// let auth = osauth::BasicAuth::new("https://cloud.local/baremetal",
/// "username", "password")
/// .expect("Invalid endpoint URL");
/// let session = osauth::Session::new(auth);
/// ```
#[derive(Clone, Debug)]
pub struct BasicAuth {
endpoint: Url,
username: String,
password: String,
}
assert_impl_all!(BasicAuth: Send, Sync);
impl BasicAuth {
/// Create a new HTTP basic authentication method using a fixed endpoint.
///
/// This endpoint will be returned in response to all `get_endpoint` calls
/// of the [AuthType](trait.AuthType.html) trait.
pub fn new<U, S1, S2>(endpoint: U, username: S1, password: S2) -> Result<BasicAuth, Error>
where
U: AsRef<str>,
S1: Into<String>,
S2: Into<String>,
{
let endpoint = Url::parse(endpoint.as_ref())
.map_err(|e| Error::new(ErrorKind::InvalidInput, e.to_string()))?;
Ok(BasicAuth {
endpoint,
username: username.into(),
password: password.into(),
})
}
}
#[async_trait]
impl AuthType for BasicAuth {
/// Authenticate a request.
async fn authenticate(
&self,
_client: &Client,
request: RequestBuilder,
) -> Result<RequestBuilder, Error> {
Ok(request.basic_auth(&self.username, Some(&self.password)))
}
/// Get a predefined endpoint for all service types
async fn get_endpoint(
&self,
_client: &Client,
_service_type: &str,
_filters: &EndpointFilters,
) -> Result<Url, Error> {
Ok(self.endpoint.clone())
}
/// This call does nothing for `BasicAuth`.
async fn refresh(&self, _client: &Client) -> Result<(), Error> {
Ok(())
}
}