Unverified Commit 979c7034 authored by Zelda Hessler's avatar Zelda Hessler Committed by GitHub
Browse files

add: example showing how to use native-tls (#946) 

* add: native-tls example and test
update: aws-config to correctly separate the native-tls and rustls features for its dependencies
fix: native-tls feature gate typo
update: prefix unused id field with an underscore

* update: CHANGELOG.next.toml

* remove: unnecessary aws-sdk-sts feature deps from aws-config

* remove: obsolete dep features
parent a491afe0

CHANGELOG.next.toml

+10 −0
Original line number Diff line number Diff line
@@ -17,6 +17,16 @@ references = ["smithy-rs#949"] 
meta = { "breaking" = false, "tada" = false, "bug" = true }

author = "a-xp"



[[aws-sdk-rust]]

message = """

`aws-config` will now work as intended for users that want to use `native-tls` instead of `rustls`. Previously, it was

difficult to ensure that `rustls` was not in use. Also, there is now an example of how to use `native-tls` and a test

that ensures `rustls` is not in the dependency tree

"""

references = ["aws-sdk-rust#304"]

meta = { "breaking" = false, "tada" = false, "bug" = true }

author = "zhessler"



[[aws-sdk-rust]]

message = """

Removed inaccurate log message when a client was used without a sleep implementation, and

aws/rust-runtime/aws-config/Cargo.toml

+1 −1
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ dns = ["tokio/rt"] 
default = ["default-provider", "rustls", "rt-tokio", "dns", "tcp-connector"]



[dependencies]

aws-sdk-sts = { path = "../../sdk/build/aws-sdk/sdk/sts", optional = true }

aws-sdk-sts = { path = "../../sdk/build/aws-sdk/sdk/sts", default-features = false, optional = true }

aws-smithy-async = { path = "../../sdk/build/aws-sdk/sdk/aws-smithy-async" }

aws-smithy-client = { path = "../../sdk/build/aws-sdk/sdk/aws-smithy-client" }

aws-smithy-types = { path = "../../sdk/build/aws-sdk/sdk/aws-smithy-types" }

aws/rust-runtime/aws-endpoint/src/partition/mod.rs

+2 −2
Original line number Diff line number Diff line
@@ -51,7 +51,7 @@ impl ResolveAwsEndpoint for PartitionResolver { 


#[derive(Debug)]

pub struct Partition {

    id: &'static str,

    _id: &'static str,

    region_regex: Regex,

    partition_endpoint: Option<Region>,

    regionalized: Regionalized,
@@ -114,7 +114,7 @@ impl Builder { 
        let default_endpoint = self.default_endpoint?;

        let endpoints = self.endpoints.into_iter().collect();

        Some(Partition {

            id: self.id?,

            _id: self.id?,

            region_regex: self.region_regex?,

            partition_endpoint: self.partition_endpoint,

            regionalized: self.regionalized.unwrap_or_default(),

aws/sdk/examples/using_native_tls_instead_of_rustls/Cargo.toml

0 → 100644
+18 −0
Original line number Diff line number Diff line 
[package]

name = "using_native_tls_instead_of_rustls"

version = "0.1.0"

authors = ["Zelda Hessler zhessler@amazon.com>"]

edition = "2018"



# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html



[dependencies]

# aws-config pulls in rustls and several other things by default. We have to disable defaults in order to use native-tls

# and then manually bring the other defaults back

aws-config = { path = "../../build/aws-sdk/sdk/aws-config", default-features = false, features = ["default-provider", "native-tls", "rt-tokio", "dns", "tcp-connector"] }

# aws-sdk-s3 brings in rustls by default so we disable that in order to use native-tls only

aws-sdk-s3 = { package = "aws-sdk-s3", path = "../../build/aws-sdk/sdk/s3", default-features = false, features = ["native-tls"] }

# aws-sdk-sts is the same as aws-sdk-s3

aws-sdk-sts = { package = "aws-sdk-sts", path = "../../build/aws-sdk/sdk/sts", default-features = false, features = ["native-tls"] }

tokio = { version = "1", features = ["full"] }

tracing-subscriber = "0.2.18"

aws/sdk/examples/using_native_tls_instead_of_rustls/src/main.rs

0 → 100644
+56 −0
Original line number Diff line number Diff line 
/*

 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

 * SPDX-License-Identifier: Apache-2.0.

 */



/// The SDK defaults to using RusTLS by default but you can also use [`native_tls`](https://github.com/sfackler/rust-native-tls)

/// which will choose a TLS implementation appropriate for your platform. This example looks much like

/// any other. Activating and deactivating `features` in your app's `Cargo.toml` is all that's needed.

#[tokio::main]

async fn main() -> Result<(), aws_sdk_s3::Error> {

    tracing_subscriber::fmt::init();



    let shared_config = aws_config::load_from_env().await;



    let s3_config = aws_sdk_s3::Config::from(&shared_config);

    let client = aws_sdk_s3::Client::from_conf(s3_config);



    let resp = client.list_buckets().send().await?;



    for bucket in resp.buckets().unwrap_or_default() {

        println!("bucket: {:?}", bucket.name().unwrap_or_default())

    }



    Ok(())

}



#[cfg(test)]

mod tests {

    /// You can run this test to ensure that this example is only using `native-tls`

    /// and that nothing is pulling in `rustls` as a dependency

    #[test]

    #[should_panic = "error: package ID specification `rustls` did not match any packages"]

    fn test_rustls_is_not_in_dependency_tree() {

        let cargo_location = std::env::var("CARGO").unwrap();

        let cargo_command = std::process::Command::new(&cargo_location)

            .arg("tree")

            .arg("--invert")

            .arg("rustls")

            .output()

            .expect("failed to run 'cargo tree'");



        let stderr = String::from_utf8_lossy(&cargo_command.stderr);



        // We expect the call to `cargo tree` to error out. If it did, we panic with the resulting

        // message here. In the case that no error message is set, that's bad.

        if !stderr.is_empty() {

            panic!("{}", stderr);

        }



        // Uh oh. We expected an error message but got none, likely because `cargo tree` found

        // `rustls` in our dependencies. We'll print out the message we got to see what went wrong.

        let stdout = String::from_utf8_lossy(&cargo_command.stdout);



        println!("{}", stdout)

    }

}