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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
// Copyright 2019-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.
//! Token authentication.
use async_trait::async_trait;
use reqwest::{Client, RequestBuilder, Url};
use static_assertions::assert_impl_all;
use super::internal::Internal;
use super::protocol;
use super::{IdOrName, Scope};
use crate::{AuthType, EndpointFilters, Error};
/// Token authentication using Identity API V3.
///
/// For any Identity authentication you need to know `auth_url`, which is an authentication endpoint
/// of the Identity service. For the Token authentication you also need:
/// 1. Existing authentication token.
/// 2. Name of the project to use.
/// 3. Domain of the project.
///
/// Start with creating a `Token` object using [new](#method.new), then add a project scope
/// with [with_project_scope](#method.with_project_scope):
///
/// ```rust,no_run
/// use osauth::common::IdOrName;
/// let auth = osauth::identity::Token::new(
/// "https://cloud.local/identity",
/// "<a token>",
/// )
/// .expect("Invalid auth_url")
/// .with_project_scope(IdOrName::from_name("project1"), IdOrName::from_id("default"));
///
/// let session = osauth::Session::new(auth);
/// ```
///
/// The authentication token is cached while it's still valid or until
/// [refresh](../trait.AuthType.html#tymethod.refresh) is called.
/// Clones of a `Token` also start with an empty cache.
#[derive(Debug, Clone)]
pub struct Token {
inner: Internal,
}
assert_impl_all!(Token: Send, Sync);
impl Token {
/// Create a token authentication.
pub fn new<U, S>(auth_url: U, token: S) -> Result<Self, Error>
where
U: AsRef<str>,
S: Into<String>,
{
let body = protocol::AuthRoot {
auth: protocol::Auth {
identity: protocol::Identity::Token(token.into()),
scope: None,
},
};
Ok(Self {
inner: Internal::new(auth_url.as_ref(), body)?,
})
}
/// Scope authentication to the given project.
///
/// A convenience wrapper around `set_scope`.
#[inline]
pub fn set_project_scope(&mut self, project: IdOrName, domain: impl Into<Option<IdOrName>>) {
self.set_scope(Scope::Project {
project,
domain: domain.into(),
});
}
/// Add a scope to the authentication.
///
/// This is required in the most cases.
#[inline]
pub fn set_scope(&mut self, scope: Scope) {
self.inner.set_scope(scope);
}
/// Scope authentication to the given project.
///
/// A convenience wrapper around `with_scope`.
#[inline]
pub fn with_project_scope(
mut self,
project: IdOrName,
domain: impl Into<Option<IdOrName>>,
) -> Token {
self.set_project_scope(project, domain);
self
}
/// Add a scope to the authentication.
#[inline]
pub fn with_scope(mut self, scope: Scope) -> Self {
self.set_scope(scope);
self
}
/// Project name or ID (if project scoped).
#[inline]
pub fn project(&self) -> Option<&IdOrName> {
self.inner.project()
}
}
#[async_trait]
impl AuthType for Token {
/// Authenticate a request.
async fn authenticate(
&self,
client: &Client,
request: RequestBuilder,
) -> Result<RequestBuilder, Error> {
self.inner.authenticate(client, request).await
}
/// Get a URL for the requested service.
async fn get_endpoint(
&self,
client: &Client,
service_type: &str,
filters: &EndpointFilters,
) -> Result<Url, Error> {
self.inner.get_endpoint(client, service_type, filters).await
}
/// Refresh the cached token and service catalog.
async fn refresh(&self, client: &Client) -> Result<(), Error> {
self.inner.refresh(client, true).await
}
}
#[cfg(test)]
pub mod test {
#![allow(unused_results)]
use reqwest::Url;
use super::Token;
use crate::identity::IdOrName;
#[test]
fn test_identity_new() {
let id = Token::new("http://127.0.0.1:8080/", "abcdef").unwrap();
let e = Url::parse(id.inner.token_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(), "/v3/auth/tokens");
}
#[test]
fn test_identity_new_invalid() {
Token::new("http://127.0.0.1 8080/", "abcdef")
.err()
.unwrap();
}
#[test]
fn test_identity_create() {
let id = Token::new("http://127.0.0.1:8080/identity", "abcdef")
.unwrap()
.with_project_scope(
IdOrName::Name("cool project".to_string()),
IdOrName::Name("example.com".to_string()),
);
assert_eq!(
id.project(),
Some(&IdOrName::Name("cool project".to_string()))
);
assert_eq!(
id.inner.token_endpoint(),
"http://127.0.0.1:8080/identity/v3/auth/tokens"
);
}
#[test]
fn test_token_endpoint_with_trailing_slash() {
let id = Token::new("http://127.0.0.1:8080/identity/", "abcdef")
.unwrap()
.with_project_scope(
IdOrName::Name("cool project".to_string()),
IdOrName::Name("example.com".to_string()),
);
assert_eq!(
id.project(),
Some(&IdOrName::Name("cool project".to_string()))
);
assert_eq!(
id.inner.token_endpoint(),
"http://127.0.0.1:8080/identity/v3/auth/tokens"
);
}
#[test]
fn test_token_endpoint_with_v3() {
let id = Token::new("http://127.0.0.1:8080/identity/v3", "abcdef")
.unwrap()
.with_project_scope(
IdOrName::Name("cool project".to_string()),
IdOrName::Name("example.com".to_string()),
);
assert_eq!(
id.project(),
Some(&IdOrName::Name("cool project".to_string()))
);
assert_eq!(
id.inner.token_endpoint(),
"http://127.0.0.1:8080/identity/v3/auth/tokens"
);
}
#[test]
fn test_token_endpoint_with_trailing_slash_v3() {
let id = Token::new("http://127.0.0.1:8080/identity/v3/", "abcdef")
.unwrap()
.with_project_scope(
IdOrName::Name("cool project".to_string()),
IdOrName::Name("example.com".to_string()),
);
assert_eq!(
id.project(),
Some(&IdOrName::Name("cool project".to_string()))
);
assert_eq!(
id.inner.token_endpoint(),
"http://127.0.0.1:8080/identity/v3/auth/tokens"
);
}
#[test]
fn test_token_endpoint_root() {
let id = Token::new("http://127.0.0.1:8080", "abcdef")
.unwrap()
.with_project_scope(
IdOrName::Name("cool project".to_string()),
IdOrName::Name("example.com".to_string()),
);
assert_eq!(
id.project(),
Some(&IdOrName::Name("cool project".to_string()))
);
assert_eq!(
id.inner.token_endpoint(),
"http://127.0.0.1:8080/v3/auth/tokens"
);
}
}