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
// Copyright 2019 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.
//! Base code for authentication.
use std::fmt::Debug;
use async_trait::async_trait;
use reqwest::{Client, RequestBuilder, Url};
use static_assertions::{assert_impl_all, assert_obj_safe};
use super::{EndpointFilters, Error, ErrorKind};
/// Trait for an authentication type.
///
/// An OpenStack authentication type is expected to be able to:
///
/// 1. get an authentication token to use when accessing services,
/// 2. get an endpoint URL for the given service type.
///
/// An authentication type should cache the token as long as it's valid.
#[async_trait]
pub trait AuthType: Debug + Sync + Send {
/// Authenticate a request.
async fn authenticate(
&self,
client: &Client,
request: RequestBuilder,
) -> Result<RequestBuilder, Error>;
/// Get a URL for the requested service using the provided client (if needed).
async fn get_endpoint(
&self,
client: &Client,
service_type: &str,
filters: &EndpointFilters,
) -> Result<Url, Error>;
/// Refresh the authentication (renew the token, etc).
async fn refresh(&self, client: &Client) -> Result<(), Error>;
}
assert_obj_safe!(AuthType);
/// Authentication type that provides no authentication.
///
/// This type always uses a pre-defined endpoint and sends no authenticaiton information:
/// ```rust,no_run
/// let auth = osauth::NoAuth::new("https://cloud.local/baremetal")
/// .expect("Invalid auth URL");
/// let session = osauth::Session::new(auth);
/// ```
#[derive(Clone, Debug)]
pub struct NoAuth {
endpoint: Option<Url>,
}
assert_impl_all!(NoAuth: Send, Sync);
impl NoAuth {
/// Create a new fake 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.
#[inline]
pub fn new<U>(endpoint: U) -> Result<NoAuth, Error>
where
U: AsRef<str>,
{
let endpoint = Url::parse(endpoint.as_ref())
.map_err(|e| Error::new(ErrorKind::InvalidInput, e.to_string()))?;
Ok(NoAuth {
endpoint: Some(endpoint),
})
}
/// Create a new fake authentication method without an endpoint.
///
/// All calls to `get_endpoint` will fail. This option is only useful with endpoint overrides.
#[inline]
pub fn new_without_endpoint() -> NoAuth {
NoAuth { endpoint: None }
}
}
#[async_trait]
impl AuthType for NoAuth {
/// Authenticate a request.
async fn authenticate(
&self,
_client: &Client,
request: RequestBuilder,
) -> Result<RequestBuilder, Error> {
Ok(request)
}
/// Get a predefined endpoint for all service types
async fn get_endpoint(
&self,
_client: &Client,
service_type: &str,
_filters: &EndpointFilters,
) -> Result<Url, Error> {
self.endpoint.clone().ok_or_else(|| {
Error::new(
ErrorKind::EndpointNotFound,
format!(
"None authentication without an endpoint, use an override for {}",
service_type
),
)
})
}
/// This call does nothing for `NoAuth`.
async fn refresh(&self, _client: &Client) -> Result<(), Error> {
Ok(())
}
}
#[cfg(test)]
pub mod test {
use reqwest::Client;
use super::{AuthType, NoAuth};
#[test]
fn test_noauth_new() {
let a = NoAuth::new("http://127.0.0.1:8080/v1").unwrap();
let e = a.endpoint.unwrap();
assert_eq!(e.scheme(), "http");
assert_eq!(e.host_str().unwrap(), "127.0.0.1");
assert_eq!(e.port().unwrap(), 8080u16);
assert_eq!(e.path(), "/v1");
}
#[test]
fn test_noauth_new_fail() {
let _ = NoAuth::new("foo bar").err().unwrap();
}
#[tokio::test]
async fn test_noauth_get_endpoint() {
let a = NoAuth::new("http://127.0.0.1:8080/v1").unwrap();
let e = a
.get_endpoint(&Client::new(), "foobar", &Default::default())
.await
.unwrap();
assert_eq!(e.scheme(), "http");
assert_eq!(e.host_str().unwrap(), "127.0.0.1");
assert_eq!(e.port().unwrap(), 8080u16);
assert_eq!(e.path(), "/v1");
}
}