Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(smithy-http-auth): add api key auth types #2153

Merged
merged 47 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from 41 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
cf7cf0e
feat(aws-types): add api key to configuration
eduardomourar Dec 26, 2022
da660fc
chore: set package version to 0.52.0
eduardomourar Dec 26, 2022
d8750e2
feat(aws-smithy-types): create auth types
eduardomourar Dec 26, 2022
05deb97
chore: use auth from smithy types
eduardomourar Dec 26, 2022
8ba9a1c
chore: fix return self type
eduardomourar Dec 26, 2022
3a10084
chore: create http auth definition type
eduardomourar Dec 29, 2022
c8f6701
chore: add constructor for http auth definition
eduardomourar Dec 29, 2022
cba79fb
chore: ensure properties are not moved
eduardomourar Dec 30, 2022
b3b8d7e
chore: create convenience constructors
eduardomourar Dec 30, 2022
16bd634
chore: add some todo comments
eduardomourar Dec 31, 2022
dae2980
feat: move query writer to aws-smithy-http crate
eduardomourar Dec 31, 2022
d06aa3a
chore(codegen): expose smithy http tower dependency
eduardomourar Dec 31, 2022
64dd5bf
chore: remove setters for auth definition
eduardomourar Jan 1, 2023
11be011
chore: fix logical error for scheme not allowed
eduardomourar Jan 1, 2023
4a44293
chore: add constructor for basic and digest auth
eduardomourar Jan 1, 2023
5fd556e
chore: allow equality comparision for api key
eduardomourar Jan 2, 2023
10ea5b1
Revert "chore: set package version to 0.52.0"
eduardomourar Jan 2, 2023
a246595
Merge branch 'main' into feat/api-key-auth
eduardomourar Jan 2, 2023
889b9d3
chore: fix additional references to querywriter
eduardomourar Jan 2, 2023
57df9cb
chore: implement from string for api key struct
eduardomourar Jan 3, 2023
7b0e877
chore: disallow none api key in sdk config
eduardomourar Jan 3, 2023
f504249
chore: fix formatting
eduardomourar Jan 3, 2023
8d731b8
chore: add unit tests for auth types
eduardomourar Jan 3, 2023
b2318b0
chore: add auth api key to external types
eduardomourar Jan 3, 2023
b2a23a0
chore: make query writer doc hidden
eduardomourar Jan 30, 2023
16d65f8
feat: create aws-smithy-http-auth crate
eduardomourar Jan 30, 2023
05657e1
chore: use zeroing for auth api key
eduardomourar Jan 30, 2023
accaf93
chore: use builder pattern for auth definition
eduardomourar Jan 30, 2023
87f76fa
chore: restructure http auth package
eduardomourar Jan 30, 2023
ab058ed
Merge branch 'main' into feat/api-key-auth
eduardomourar Jan 30, 2023
8fcf0d6
chore: define default lint warning
eduardomourar Jan 30, 2023
e3cc300
chore: include http auth in runtime common list
eduardomourar Jan 30, 2023
38e61ed
chore: define setter for optional scheme
eduardomourar Jan 30, 2023
ae2ea2e
chore: should panic while building auth definition
eduardomourar Jan 30, 2023
001ee70
chore: return missing required field error
eduardomourar Jan 31, 2023
da25004
chore: make few code simplications for api key
eduardomourar Jan 31, 2023
69a1c4d
Merge branch 'main' into feat/api-key-auth
eduardomourar Jan 31, 2023
0e5d1ee
Revert "chore: add auth api key to external types"
eduardomourar Jan 31, 2023
b506ff0
chore: revert api key from sdk config
eduardomourar Jan 31, 2023
9abb795
chore: panic on missing required field
eduardomourar Jan 31, 2023
f560406
Merge branch 'main' into feat/api-key-auth
eduardomourar Jan 31, 2023
1ef3a38
Merge branch 'main' into feat/api-key-auth
jdisanti Feb 3, 2023
5b9ea0d
Merge branch 'main' into feat/api-key-auth
eduardomourar Feb 3, 2023
436c809
Merge remote-tracking branch 'origin/main' into eduardomourar-api-key…
jdisanti Feb 13, 2023
3d7ef89
Merge branch 'main' into feat/api-key-auth
eduardomourar Feb 13, 2023
f23760a
Merge branch 'main' into feat/api-key-auth
jdisanti Feb 13, 2023
c9a8416
Opt out of `clippy::derive_partial_eq_without_eq`
jdisanti Feb 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@

use crate::date_time::{format_date, format_date_time};
use crate::http_request::error::CanonicalRequestError;
use crate::http_request::query_writer::QueryWriter;
use crate::http_request::settings::UriPathNormalizationMode;
use crate::http_request::sign::SignableRequest;
use crate::http_request::uri_path_normalization::normalize_uri_path;
use crate::http_request::url_escape::percent_encode_path;
use crate::http_request::PercentEncodingMode;
use crate::http_request::{PayloadChecksumKind, SignableBody, SignatureLocation, SigningParams};
use crate::sign::sha256_hex_string;
use aws_smithy_http::query_writer::QueryWriter;
use http::header::{HeaderName, HOST};
use http::{HeaderMap, HeaderValue, Method, Uri};
use std::borrow::Cow;
Expand Down Expand Up @@ -513,13 +513,13 @@ mod tests {
use crate::http_request::canonical_request::{
normalize_header_value, trim_all, CanonicalRequest, SigningScope, StringToSign,
};
use crate::http_request::query_writer::QueryWriter;
use crate::http_request::test::{test_canonical_request, test_request, test_sts};
use crate::http_request::{
PayloadChecksumKind, SignableBody, SignableRequest, SigningSettings,
};
use crate::http_request::{SignatureLocation, SigningParams};
use crate::sign::sha256_hex_string;
use aws_smithy_http::query_writer::QueryWriter;
use http::Uri;
use http::{header::HeaderName, HeaderValue};
use pretty_assertions::assert_eq;
Expand Down
1 change: 0 additions & 1 deletion aws/rust-runtime/aws-sigv4/src/http_request/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@

mod canonical_request;
mod error;
mod query_writer;
mod settings;
mod sign;
mod uri_path_normalization;
Expand Down
2 changes: 1 addition & 1 deletion aws/rust-runtime/aws-sigv4/src/http_request/sign.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ use super::{PayloadChecksumKind, SignatureLocation};
use crate::http_request::canonical_request::header;
use crate::http_request::canonical_request::param;
use crate::http_request::canonical_request::{CanonicalRequest, StringToSign, HMAC_256};
use crate::http_request::query_writer::QueryWriter;
use crate::http_request::SigningParams;
use crate::sign::{calculate_signature, generate_signing_key, sha256_hex_string};
use crate::SigningOutput;
use aws_smithy_http::query_writer::QueryWriter;
use http::header::HeaderValue;
use http::{HeaderMap, Method, Uri};
use std::borrow::Cow;
Expand Down
6 changes: 1 addition & 5 deletions aws/rust-runtime/aws-sigv4/src/http_request/url_escape.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

use aws_smithy_http::{label, query};

pub(super) fn percent_encode_query(value: &str) -> String {
query::fmt_string(value)
}
use aws_smithy_http::label;

pub(super) fn percent_encode_path(value: &str) -> String {
label::fmt_string(value, label::EncodingStrategy::Greedy)
Expand Down
1 change: 1 addition & 0 deletions buildSrc/src/main/kotlin/CrateSet.kt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ object CrateSet {
"aws-smithy-checksums",
"aws-smithy-eventstream",
"aws-smithy-http",
"aws-smithy-http-auth",
"aws-smithy-http-tower",
"aws-smithy-json",
"aws-smithy-protocol-test",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ data class RuntimeType(val path: String, val dependency: RustDependency? = null)
fun smithyClient(runtimeConfig: RuntimeConfig) = CargoDependency.smithyClient(runtimeConfig).toType()
fun smithyEventStream(runtimeConfig: RuntimeConfig) = CargoDependency.smithyEventStream(runtimeConfig).toType()
fun smithyHttp(runtimeConfig: RuntimeConfig) = CargoDependency.smithyHttp(runtimeConfig).toType()
fun smithyHttpTower(runtimeConfig: RuntimeConfig) = CargoDependency.smithyHttpTower(runtimeConfig).toType()
fun smithyJson(runtimeConfig: RuntimeConfig) = CargoDependency.smithyJson(runtimeConfig).toType()
fun smithyQuery(runtimeConfig: RuntimeConfig) = CargoDependency.smithyQuery(runtimeConfig).toType()
fun smithyTypes(runtimeConfig: RuntimeConfig) = CargoDependency.smithyTypes(runtimeConfig).toType()
Expand Down
1 change: 1 addition & 0 deletions rust-runtime/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ members = [
"aws-smithy-checksums",
"aws-smithy-eventstream",
"aws-smithy-http",
"aws-smithy-http-auth",
eduardomourar marked this conversation as resolved.
Show resolved Hide resolved
"aws-smithy-http-tower",
"aws-smithy-json",
"aws-smithy-protocol-test",
Expand Down
20 changes: 20 additions & 0 deletions rust-runtime/aws-smithy-http-auth/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[package]
name = "aws-smithy-http-auth"
version = "0.0.0-smithy-rs-head"
authors = [
"AWS Rust SDK Team <aws-sdk-rust@amazon.com>",
"Eduardo Rodrigues <16357187+eduardomourar@users.noreply.github.com>",
]
description = "Smithy HTTP logic for smithy-rs."
edition = "2021"
license = "Apache-2.0"
repository = "https://github.com/awslabs/smithy-rs"

[dependencies]
zeroize = "1"

[package.metadata.docs.rs]
all-features = true
targets = ["x86_64-unknown-linux-gnu"]
rustdoc-args = ["--cfg", "docsrs"]
# End of docs.rs metadata
175 changes: 175 additions & 0 deletions rust-runtime/aws-smithy-http-auth/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
7 changes: 7 additions & 0 deletions rust-runtime/aws-smithy-http-auth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# aws-smithy-http-auth

HTTP Auth implementation for service clients generated by [smithy-rs](https://github.com/awslabs/smithy-rs).

<!-- anchor_start:footer -->
This crate is part of the [AWS SDK for Rust](https://awslabs.github.io/aws-sdk-rust/) and the [smithy-rs](https://github.com/awslabs/smithy-rs) code generator. In most cases, it should not be used directly.
<!-- anchor_end:footer -->
2 changes: 2 additions & 0 deletions rust-runtime/aws-smithy-http-auth/external-types.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
allowed_external_types = [
]
74 changes: 74 additions & 0 deletions rust-runtime/aws-smithy-http-auth/src/api_key.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/

//! HTTP Auth API Key

use std::cmp::PartialEq;
use std::fmt::Debug;
use std::sync::Arc;
use zeroize::Zeroizing;

/// Authentication configuration to connect to a Smithy Service
#[derive(Clone, Eq, PartialEq)]
pub struct AuthApiKey(Arc<Inner>);

#[derive(Clone, Eq, PartialEq)]
struct Inner {
api_key: Zeroizing<String>,
}

impl Debug for AuthApiKey {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut auth_api_key = f.debug_struct("AuthApiKey");
auth_api_key.field("api_key", &"** redacted **").finish()
}
}

impl AuthApiKey {
/// Constructs a new API key.
pub fn new(api_key: impl Into<String>) -> Self {
Self(Arc::new(Inner {
api_key: Zeroizing::new(api_key.into()),
}))
}

/// Returns the underlying api key.
pub fn api_key(&self) -> &str {
&self.0.api_key
}
}

impl From<&str> for AuthApiKey {
fn from(api_key: &str) -> Self {
Self::from(api_key.to_owned())
}
}

impl From<String> for AuthApiKey {
fn from(api_key: String) -> Self {
Self(Arc::new(Inner {
api_key: Zeroizing::new(api_key),
}))
}
}

#[cfg(test)]
mod tests {
use super::AuthApiKey;

#[test]
fn api_key_is_equal() {
let api_key_a: AuthApiKey = "some-api-key".into();
let api_key_b = AuthApiKey::new("some-api-key");
assert_eq!(api_key_a, api_key_b);
}

#[test]
fn api_key_is_different() {
let api_key_a = AuthApiKey::new("some-api-key");
let api_key_b: AuthApiKey = String::from("another-api-key").into();
assert_ne!(api_key_a, api_key_b);
}
}