use crate::azure::STORE;
use crate::client::retry::RetryExt;
use crate::client::token::{TemporaryToken, TokenCache};
use crate::client::{CredentialProvider, TokenProvider};
use crate::util::hmac_sha256;
use crate::RetryConfig;
use async_trait::async_trait;
use base64::prelude::BASE64_STANDARD;
use base64::Engine;
use chrono::{DateTime, Utc};
use reqwest::header::ACCEPT;
use reqwest::{
header::{
HeaderMap, HeaderName, HeaderValue, AUTHORIZATION, CONTENT_ENCODING,
CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, DATE, IF_MATCH,
IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_UNMODIFIED_SINCE, RANGE,
},
Client, Method, RequestBuilder,
};
use serde::Deserialize;
use snafu::{ResultExt, Snafu};
use std::borrow::Cow;
use std::process::Command;
use std::str;
use std::sync::Arc;
use std::time::{Duration, Instant};
use url::Url;
static AZURE_VERSION: HeaderValue = HeaderValue::from_static("2021-08-06");
static VERSION: HeaderName = HeaderName::from_static("x-ms-version");
pub(crate) static BLOB_TYPE: HeaderName = HeaderName::from_static("x-ms-blob-type");
pub(crate) static DELETE_SNAPSHOTS: HeaderName =
HeaderName::from_static("x-ms-delete-snapshots");
pub(crate) static COPY_SOURCE: HeaderName = HeaderName::from_static("x-ms-copy-source");
static CONTENT_MD5: HeaderName = HeaderName::from_static("content-md5");
pub(crate) const RFC1123_FMT: &str = "%a, %d %h %Y %T GMT";
const CONTENT_TYPE_JSON: &str = "application/json";
const MSI_SECRET_ENV_KEY: &str = "IDENTITY_HEADER";
const MSI_API_VERSION: &str = "2019-08-01";
const AZURE_STORAGE_SCOPE: &str = "https://storage.azure.com/.default";
const AZURE_STORAGE_RESOURCE: &str = "https://storage.azure.com";
#[derive(Debug, Snafu)]
pub enum Error {
#[snafu(display("Error performing token request: {}", source))]
TokenRequest { source: crate::client::retry::Error },
#[snafu(display("Error getting token response body: {}", source))]
TokenResponseBody { source: reqwest::Error },
#[snafu(display("Error reading federated token file "))]
FederatedTokenFile,
#[snafu(display("'az account get-access-token' command failed: {message}"))]
AzureCli { message: String },
#[snafu(display("Failed to parse azure cli response: {source}"))]
AzureCliResponse { source: serde_json::Error },
}
pub type Result<T, E = Error> = std::result::Result<T, E>;
impl From<Error> for crate::Error {
fn from(value: Error) -> Self {
Self::Generic {
store: STORE,
source: Box::new(value),
}
}
}
#[derive(Debug, Eq, PartialEq)]
pub enum AzureCredential {
AccessKey(String),
SASToken(Vec<(String, String)>),
BearerToken(String),
}
pub mod authority_hosts {
pub const AZURE_CHINA: &str = "https://login.chinacloudapi.cn";
pub const AZURE_GERMANY: &str = "https://login.microsoftonline.de";
pub const AZURE_GOVERNMENT: &str = "https://login.microsoftonline.us";
pub const AZURE_PUBLIC_CLOUD: &str = "https://login.microsoftonline.com";
}
pub(crate) trait CredentialExt {
fn with_azure_authorization(
self,
credential: &AzureCredential,
account: &str,
) -> Self;
}
impl CredentialExt for RequestBuilder {
fn with_azure_authorization(
mut self,
credential: &AzureCredential,
account: &str,
) -> Self {
let date = Utc::now();
let date_str = date.format(RFC1123_FMT).to_string();
let date_val = HeaderValue::from_str(&date_str).unwrap();
self = self
.header(DATE, &date_val)
.header(&VERSION, &AZURE_VERSION);
match credential {
AzureCredential::AccessKey(key) => {
let (client, request) = self.build_split();
let mut request = request.expect("request valid");
let signature = generate_authorization(
request.headers(),
request.url(),
request.method(),
account,
key.as_str(),
);
request.headers_mut().append(
AUTHORIZATION,
HeaderValue::from_str(signature.as_str()).unwrap(),
);
Self::from_parts(client, request)
}
AzureCredential::BearerToken(token) => self.bearer_auth(token),
AzureCredential::SASToken(query_pairs) => self.query(&query_pairs),
}
}
}
fn generate_authorization(
h: &HeaderMap,
u: &Url,
method: &Method,
account: &str,
key: &str,
) -> String {
let str_to_sign = string_to_sign(h, u, method, account);
let auth = hmac_sha256(BASE64_STANDARD.decode(key).unwrap(), str_to_sign);
format!("SharedKey {}:{}", account, BASE64_STANDARD.encode(auth))
}
fn add_if_exists<'a>(h: &'a HeaderMap, key: &HeaderName) -> &'a str {
h.get(key)
.map(|s| s.to_str())
.transpose()
.ok()
.flatten()
.unwrap_or_default()
}
fn string_to_sign(h: &HeaderMap, u: &Url, method: &Method, account: &str) -> String {
let content_length = h
.get(&CONTENT_LENGTH)
.map(|s| s.to_str())
.transpose()
.ok()
.flatten()
.filter(|&v| v != "0")
.unwrap_or_default();
format!(
"{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}\n{}{}",
method.as_ref(),
add_if_exists(h, &CONTENT_ENCODING),
add_if_exists(h, &CONTENT_LANGUAGE),
content_length,
add_if_exists(h, &CONTENT_MD5),
add_if_exists(h, &CONTENT_TYPE),
add_if_exists(h, &DATE),
add_if_exists(h, &IF_MODIFIED_SINCE),
add_if_exists(h, &IF_MATCH),
add_if_exists(h, &IF_NONE_MATCH),
add_if_exists(h, &IF_UNMODIFIED_SINCE),
add_if_exists(h, &RANGE),
canonicalize_header(h),
canonicalized_resource(account, u)
)
}
fn canonicalize_header(headers: &HeaderMap) -> String {
let mut names = headers
.iter()
.filter_map(|(k, _)| {
(k.as_str().starts_with("x-ms"))
.then(|| (k.as_str(), headers.get(k).unwrap().to_str().unwrap()))
})
.collect::<Vec<_>>();
names.sort_unstable();
let mut result = String::new();
for (name, value) in names {
result.push_str(name);
result.push(':');
result.push_str(value);
result.push('\n');
}
result
}
fn canonicalized_resource(account: &str, uri: &Url) -> String {
let mut can_res: String = String::new();
can_res.push('/');
can_res.push_str(account);
can_res.push_str(uri.path().to_string().as_str());
can_res.push('\n');
let query_pairs = uri.query_pairs();
{
let mut qps: Vec<String> = Vec::new();
for (q, _) in query_pairs {
if !(qps.iter().any(|x| x == &*q)) {
qps.push(q.into_owned());
}
}
qps.sort();
for qparam in qps {
let ret = lexy_sort(query_pairs, &qparam);
can_res = can_res + &qparam.to_lowercase() + ":";
for (i, item) in ret.iter().enumerate() {
if i > 0 {
can_res.push(',');
}
can_res.push_str(item);
}
can_res.push('\n');
}
};
can_res[0..can_res.len() - 1].to_owned()
}
fn lexy_sort<'a>(
vec: impl Iterator<Item = (Cow<'a, str>, Cow<'a, str>)> + 'a,
query_param: &str,
) -> Vec<Cow<'a, str>> {
let mut values = vec
.filter(|(k, _)| *k == query_param)
.map(|(_, v)| v)
.collect::<Vec<_>>();
values.sort_unstable();
values
}
#[derive(Deserialize, Debug)]
struct TokenResponse {
access_token: String,
expires_in: u64,
}
#[derive(Debug)]
pub struct ClientSecretOAuthProvider {
token_url: String,
client_id: String,
client_secret: String,
}
impl ClientSecretOAuthProvider {
pub fn new(
client_id: String,
client_secret: String,
tenant_id: impl AsRef<str>,
authority_host: Option<String>,
) -> Self {
let authority_host = authority_host
.unwrap_or_else(|| authority_hosts::AZURE_PUBLIC_CLOUD.to_owned());
Self {
token_url: format!(
"{}/{}/oauth2/v2.0/token",
authority_host,
tenant_id.as_ref()
),
client_id,
client_secret,
}
}
}
#[async_trait::async_trait]
impl TokenProvider for ClientSecretOAuthProvider {
type Credential = AzureCredential;
async fn fetch_token(
&self,
client: &Client,
retry: &RetryConfig,
) -> crate::Result<TemporaryToken<Arc<AzureCredential>>> {
let response: TokenResponse = client
.request(Method::POST, &self.token_url)
.header(ACCEPT, HeaderValue::from_static(CONTENT_TYPE_JSON))
.form(&[
("client_id", self.client_id.as_str()),
("client_secret", self.client_secret.as_str()),
("scope", AZURE_STORAGE_SCOPE),
("grant_type", "client_credentials"),
])
.send_retry(retry)
.await
.context(TokenRequestSnafu)?
.json()
.await
.context(TokenResponseBodySnafu)?;
Ok(TemporaryToken {
token: Arc::new(AzureCredential::BearerToken(response.access_token)),
expiry: Some(Instant::now() + Duration::from_secs(response.expires_in)),
})
}
}
fn expires_in_string<'de, D>(deserializer: D) -> std::result::Result<u64, D::Error>
where
D: serde::de::Deserializer<'de>,
{
let v = String::deserialize(deserializer)?;
v.parse::<u64>().map_err(serde::de::Error::custom)
}
#[derive(Debug, Clone, Deserialize)]
struct MsiTokenResponse {
pub access_token: String,
#[serde(deserialize_with = "expires_in_string")]
pub expires_in: u64,
}
#[derive(Debug)]
pub struct ImdsManagedIdentityProvider {
msi_endpoint: String,
client_id: Option<String>,
object_id: Option<String>,
msi_res_id: Option<String>,
}
impl ImdsManagedIdentityProvider {
pub fn new(
client_id: Option<String>,
object_id: Option<String>,
msi_res_id: Option<String>,
msi_endpoint: Option<String>,
) -> Self {
let msi_endpoint = msi_endpoint.unwrap_or_else(|| {
"http://169.254.169.254/metadata/identity/oauth2/token".to_owned()
});
Self {
msi_endpoint,
client_id,
object_id,
msi_res_id,
}
}
}
#[async_trait::async_trait]
impl TokenProvider for ImdsManagedIdentityProvider {
type Credential = AzureCredential;
async fn fetch_token(
&self,
client: &Client,
retry: &RetryConfig,
) -> crate::Result<TemporaryToken<Arc<AzureCredential>>> {
let mut query_items = vec![
("api-version", MSI_API_VERSION),
("resource", AZURE_STORAGE_RESOURCE),
];
let mut identity = None;
if let Some(client_id) = &self.client_id {
identity = Some(("client_id", client_id));
}
if let Some(object_id) = &self.object_id {
identity = Some(("object_id", object_id));
}
if let Some(msi_res_id) = &self.msi_res_id {
identity = Some(("msi_res_id", msi_res_id));
}
if let Some((key, value)) = identity {
query_items.push((key, value));
}
let mut builder = client
.request(Method::GET, &self.msi_endpoint)
.header("metadata", "true")
.query(&query_items);
if let Ok(val) = std::env::var(MSI_SECRET_ENV_KEY) {
builder = builder.header("x-identity-header", val);
};
let response: MsiTokenResponse = builder
.send_retry(retry)
.await
.context(TokenRequestSnafu)?
.json()
.await
.context(TokenResponseBodySnafu)?;
Ok(TemporaryToken {
token: Arc::new(AzureCredential::BearerToken(response.access_token)),
expiry: Some(Instant::now() + Duration::from_secs(response.expires_in)),
})
}
}
#[derive(Debug)]
pub struct WorkloadIdentityOAuthProvider {
token_url: String,
client_id: String,
federated_token_file: String,
}
impl WorkloadIdentityOAuthProvider {
pub fn new(
client_id: impl Into<String>,
federated_token_file: impl Into<String>,
tenant_id: impl AsRef<str>,
authority_host: Option<String>,
) -> Self {
let authority_host = authority_host
.unwrap_or_else(|| authority_hosts::AZURE_PUBLIC_CLOUD.to_owned());
Self {
token_url: format!(
"{}/{}/oauth2/v2.0/token",
authority_host,
tenant_id.as_ref()
),
client_id: client_id.into(),
federated_token_file: federated_token_file.into(),
}
}
}
#[async_trait::async_trait]
impl TokenProvider for WorkloadIdentityOAuthProvider {
type Credential = AzureCredential;
async fn fetch_token(
&self,
client: &Client,
retry: &RetryConfig,
) -> crate::Result<TemporaryToken<Arc<AzureCredential>>> {
let token_str = std::fs::read_to_string(&self.federated_token_file)
.map_err(|_| Error::FederatedTokenFile)?;
let response: TokenResponse = client
.request(Method::POST, &self.token_url)
.header(ACCEPT, HeaderValue::from_static(CONTENT_TYPE_JSON))
.form(&[
("client_id", self.client_id.as_str()),
(
"client_assertion_type",
"urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
),
("client_assertion", token_str.as_str()),
("scope", AZURE_STORAGE_SCOPE),
("grant_type", "client_credentials"),
])
.send_retry(retry)
.await
.context(TokenRequestSnafu)?
.json()
.await
.context(TokenResponseBodySnafu)?;
Ok(TemporaryToken {
token: Arc::new(AzureCredential::BearerToken(response.access_token)),
expiry: Some(Instant::now() + Duration::from_secs(response.expires_in)),
})
}
}
mod az_cli_date_format {
use chrono::{DateTime, TimeZone};
use serde::{self, Deserialize, Deserializer};
pub fn deserialize<'de, D>(
deserializer: D,
) -> Result<DateTime<chrono::Local>, D::Error>
where
D: Deserializer<'de>,
{
let s = String::deserialize(deserializer)?;
let date = chrono::NaiveDateTime::parse_from_str(&s, "%Y-%m-%d %H:%M:%S.%6f")
.map_err(serde::de::Error::custom)?;
chrono::Local
.from_local_datetime(&date)
.single()
.ok_or(serde::de::Error::custom(
"azure cli returned ambiguous expiry date",
))
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
struct AzureCliTokenResponse {
pub access_token: String,
#[serde(with = "az_cli_date_format")]
pub expires_on: DateTime<chrono::Local>,
pub token_type: String,
}
#[derive(Default, Debug)]
pub struct AzureCliCredential {
cache: TokenCache<Arc<AzureCredential>>,
}
impl AzureCliCredential {
pub fn new() -> Self {
Self::default()
}
async fn fetch_token(&self) -> Result<TemporaryToken<Arc<AzureCredential>>> {
let program = if cfg!(target_os = "windows") {
"cmd"
} else {
"az"
};
let mut args = Vec::new();
if cfg!(target_os = "windows") {
args.push("/C");
args.push("az");
}
args.push("account");
args.push("get-access-token");
args.push("--output");
args.push("json");
args.push("--scope");
args.push(AZURE_STORAGE_SCOPE);
match Command::new(program).args(args).output() {
Ok(az_output) if az_output.status.success() => {
let output =
str::from_utf8(&az_output.stdout).map_err(|_| Error::AzureCli {
message: "az response is not a valid utf-8 string".to_string(),
})?;
let token_response =
serde_json::from_str::<AzureCliTokenResponse>(output)
.context(AzureCliResponseSnafu)?;
if !token_response.token_type.eq_ignore_ascii_case("bearer") {
return Err(Error::AzureCli {
message: format!(
"got unexpected token type from azure cli: {0}",
token_response.token_type
),
});
}
let duration = token_response.expires_on.naive_local()
- chrono::Local::now().naive_local();
Ok(TemporaryToken {
token: Arc::new(AzureCredential::BearerToken(
token_response.access_token,
)),
expiry: Some(
Instant::now()
+ duration.to_std().map_err(|_| Error::AzureCli {
message: "az returned invalid lifetime".to_string(),
})?,
),
})
}
Ok(az_output) => {
let message = String::from_utf8_lossy(&az_output.stderr);
Err(Error::AzureCli {
message: message.into(),
})
}
Err(e) => match e.kind() {
std::io::ErrorKind::NotFound => Err(Error::AzureCli {
message: "Azure Cli not installed".into(),
}),
error_kind => Err(Error::AzureCli {
message: format!("io error: {error_kind:?}"),
}),
},
}
}
}
#[async_trait]
impl CredentialProvider for AzureCliCredential {
type Credential = AzureCredential;
async fn get_credential(&self) -> crate::Result<Arc<Self::Credential>> {
Ok(self.cache.get_or_insert_with(|| self.fetch_token()).await?)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::client::mock_server::MockServer;
use futures::executor::block_on;
use hyper::body::to_bytes;
use hyper::{Body, Response};
use reqwest::{Client, Method};
use tempfile::NamedTempFile;
#[tokio::test]
async fn test_managed_identity() {
let server = MockServer::new();
std::env::set_var(MSI_SECRET_ENV_KEY, "env-secret");
let endpoint = server.url();
let client = Client::new();
let retry_config = RetryConfig::default();
server.push_fn(|req| {
assert_eq!(req.uri().path(), "/metadata/identity/oauth2/token");
assert!(req.uri().query().unwrap().contains("client_id=client_id"));
assert_eq!(req.method(), &Method::GET);
let t = req
.headers()
.get("x-identity-header")
.unwrap()
.to_str()
.unwrap();
assert_eq!(t, "env-secret");
let t = req.headers().get("metadata").unwrap().to_str().unwrap();
assert_eq!(t, "true");
Response::new(Body::from(
r#"
{
"access_token": "TOKEN",
"refresh_token": "",
"expires_in": "3599",
"expires_on": "1506484173",
"not_before": "1506480273",
"resource": "https://management.azure.com/",
"token_type": "Bearer"
}
"#,
))
});
let credential = ImdsManagedIdentityProvider::new(
Some("client_id".into()),
None,
None,
Some(format!("{endpoint}/metadata/identity/oauth2/token")),
);
let token = credential
.fetch_token(&client, &retry_config)
.await
.unwrap();
assert_eq!(
token.token.as_ref(),
&AzureCredential::BearerToken("TOKEN".into())
);
}
#[tokio::test]
async fn test_workload_identity() {
let server = MockServer::new();
let tokenfile = NamedTempFile::new().unwrap();
let tenant = "tenant";
std::fs::write(tokenfile.path(), "federated-token").unwrap();
let endpoint = server.url();
let client = Client::new();
let retry_config = RetryConfig::default();
server.push_fn(move |req| {
assert_eq!(req.uri().path(), format!("/{tenant}/oauth2/v2.0/token"));
assert_eq!(req.method(), &Method::POST);
let body = block_on(to_bytes(req.into_body())).unwrap();
let body = String::from_utf8(body.to_vec()).unwrap();
assert!(body.contains("federated-token"));
Response::new(Body::from(
r#"
{
"access_token": "TOKEN",
"refresh_token": "",
"expires_in": 3599,
"expires_on": "1506484173",
"not_before": "1506480273",
"resource": "https://management.azure.com/",
"token_type": "Bearer"
}
"#,
))
});
let credential = WorkloadIdentityOAuthProvider::new(
"client_id",
tokenfile.path().to_str().unwrap(),
tenant,
Some(endpoint.to_string()),
);
let token = credential
.fetch_token(&client, &retry_config)
.await
.unwrap();
assert_eq!(
token.token.as_ref(),
&AzureCredential::BearerToken("TOKEN".into())
);
}
}