roeap commented on code in PR #2509: URL: https://github.com/apache/arrow-rs/pull/2509#discussion_r950810883
########## object_store/src/azure/credential.rs: ########## @@ -0,0 +1,254 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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. + +use crate::client::oauth::ClientSecretOAuthProvider; +use crate::util::hmac_sha256; +use chrono::Utc; +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, + }, + Method, RequestBuilder, +}; +use std::borrow::Cow; +use std::str; +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 RANGE_GET_CONTENT_CRC64: HeaderName = + HeaderName::from_static("x-ms-range-get-content-crc64"); +pub(crate) static MS_RANGE: HeaderName = HeaderName::from_static("x-ms-range"); +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) static RFC1123_FMT: &str = "%a, %d %h %Y %T GMT"; + +/// Provides credentials for use when signing requests +#[derive(Debug)] +pub enum CredentialProvider { + AccessKey(String), + SASToken(Vec<(String, String)>), + ClientSecret(ClientSecretOAuthProvider), +} + +pub(crate) enum AzureCredential { + AccessKey(String), + SASToken(Vec<(String, String)>), + AuthorizationToken(HeaderValue), +} + +/// A list of known Azure authority hosts +pub mod authority_hosts { + /// China-based Azure Authority Host + pub const AZURE_CHINA: &str = "https://login.chinacloudapi.cn";; + /// Germany-based Azure Authority Host + pub const AZURE_GERMANY: &str = "https://login.microsoftonline.de";; + /// US Government Azure Authority Host + pub const AZURE_GOVERNMENT: &str = "https://login.microsoftonline.us";; + /// Public Cloud Azure Authority Host + pub const AZURE_PUBLIC_CLOUD: &str = "https://login.microsoftonline.com";; +} + +pub(crate) trait CredentialExt { + /// Apply authorization to requests against azure storage accounts + /// <https://docs.microsoft.com/en-us/rest/api/storageservices/authorize-requests-to-azure-storage> + 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(); + // we formatted the data string ourselves, so unwrapping should be fine + let date_val = HeaderValue::from_str(&date_str).unwrap(); + self = self + .header("x-ms-date", &date_val) + .header(&VERSION, &AZURE_VERSION); + + // Hack around lack of access to underlying request + // https://github.com/seanmonstar/reqwest/issues/1212 + let request = self + .try_clone() + .expect("not stream") + .build() + .expect("request valid"); + + match credential { + AzureCredential::AccessKey(key) => { + let signature = generate_authorization( + request.headers(), + request.url(), + request.method(), + account, + key.as_str(), + ); + self = self + // "signature" is a base 64 encoded string so it should never contain illegal characters. + .header( + AUTHORIZATION, + HeaderValue::from_str(signature.as_str()).unwrap(), + ); + } + AzureCredential::AuthorizationToken(token) => { + self = self.header(AUTHORIZATION, token); + } + AzureCredential::SASToken(query_pairs) => { + self = self.query(&query_pairs); + } + }; + + self + } +} + +// generate signed key for authorization via access keys +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::decode(key).unwrap(), &str_to_sign); + format!("SharedKey {}:{}", account, base64::encode(auth)) +} + +fn add_if_exists<'a>(h: &'a HeaderMap, key: &HeaderName) -> &'a str { + h.get(key) + .map(|s| s.to_str()) + .transpose() + .ok() + .unwrap_or(Some("")) + .unwrap_or_default() +} + +fn string_to_sign(h: &HeaderMap, u: &Url, method: &Method, account: &str) -> String { + // content length must only be specified if != 0 + // this is valid from 2015-02-21 + let content_length = h Review Comment: it is indeed lighter :). In the docs it talks about "enhanced security functionality" (whatever that may be) when using the normal key. The code would be a bit more legible, but since it works keep it? :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
