Skip to content

Commit b62ca0a

Browse files
sbera87sbera87
authored
Smithy Identity auth refactor for Rest XML S3 client (#3262)
1 parent a35ebd9 commit b62ca0a

File tree

54 files changed

+5528
-2575
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+5528
-2575
lines changed

‎generated/src/aws-cpp-sdk-s3/include/aws/s3/S3Client.h‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,22 @@
44
*/
55

66
#pragma once
7+
78
#include <aws/s3/S3_EXPORTS.h>
89
#include <aws/core/client/ClientConfiguration.h>
9-
#include <aws/core/client/AWSClient.h>
1010
#include <aws/core/client/AWSClientAsyncCRTP.h>
11-
#include <aws/core/auth/AWSAuthSigner.h>
12-
#include <aws/core/utils/xml/XmlSerializer.h>
13-
#include <aws/core/utils/DNS.h>
1411
#include <aws/s3/S3ServiceClientModel.h>
12+
#include <smithy/client/AwsSmithyClient.h>
13+
#include <smithy/identity/auth/built-in/SigV4MultiAuthResolver.h>
14+
#include <smithy/identity/auth/built-in/SigV4AuthScheme.h>
15+
#include <smithy/identity/auth/built-in/SigV4aAuthScheme.h>
16+
#include <aws/s3/S3ExpressSigV4AuthScheme.h>
17+
#include <smithy/client/serializer/XmlOutcomeSerializer.h>
18+
#include <aws/core/utils/DNS.h>
19+
20+
#include <aws/s3/S3ErrorMarshaller.h>
21+
22+
1523

1624
// TODO: temporary fix for naming conflicts on Windows.
1725
#ifdef _WIN32
@@ -32,19 +40,28 @@ namespace Aws
3240
static const char SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY[] = "x-amz-server-side-encryption-customer-key";
3341
static const char SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5[] = "x-amz-server-side-encryption-customer-key-MD5";
3442
} // SS3Headers
43+
AWS_S3_API extern const char SERVICE_NAME[];
3544

3645
//max expiration for presigned urls in s3 is 7 days.
3746
static const unsigned MAX_EXPIRATION_SECONDS = 7 * 24 * 60 * 60;
3847

3948
/**
4049
* <p/>
4150
*/
42-
class AWS_S3_API S3Client : public Aws::Client::AWSXMLClient, public Aws::Client::ClientWithAsyncTemplateMethods<S3Client>
51+
class AWS_S3_API S3Client : public smithy::client::AwsSmithyClientT<Aws::S3::SERVICE_NAME,
52+
Aws::S3::S3ClientConfiguration,
53+
smithy::SigV4MultiAuthSchemeResolver<S3EndpointProvider, Aws::S3::S3ClientConfiguration>,
54+
Aws::Crt::Variant<smithy::SigV4AuthScheme,S3::S3ExpressSigV4AuthScheme,smithy::SigV4aAuthScheme>,
55+
S3EndpointProviderBase,
56+
smithy::client::XmlOutcomeSerializer,
57+
smithy::client::XmlOutcome,
58+
Aws::Client::S3ErrorMarshaller>,
59+
Aws::Client::ClientWithAsyncTemplateMethods<S3Client>
4360
{
4461
public:
45-
typedef Aws::Client::AWSXMLClient BASECLASS;
4662
static const char* GetServiceName();
4763
static const char* GetAllocationTag();
64+
inline const char* GetServiceClientName() const override { return "S3"; }
4865

4966
typedef S3ClientConfiguration ClientConfigurationType;
5067
typedef S3EndpointProvider EndpointProviderType;
@@ -6989,8 +7006,7 @@ namespace Aws
69897006
private:
69907007
friend class Aws::Client::ClientWithAsyncTemplateMethods<S3Client>;
69917008
void init(const S3ClientConfiguration& clientConfiguration);
6992-
S3ClientConfiguration m_clientConfiguration;
6993-
std::shared_ptr<S3EndpointProviderBase> m_endpointProvider;
7009+
69947010
};
69957011

69967012
} // namespace S3

‎generated/src/aws-cpp-sdk-s3/include/aws/s3/S3ClientConfiguration.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ namespace Aws
6262
IdentityProviderSupplier identityProviderSupplier = [](const S3Client &client) -> std::shared_ptr<S3ExpressIdentityProvider> {
6363
return Aws::MakeShared<DefaultS3ExpressIdentityProvider>("S3ClientConfiguration", client);
6464
};
65+
using SmithyIdentityProviderSupplier = std::function<std::shared_ptr<SmithyS3ExpressIdentityProvider> (const S3Client &)>;
66+
SmithyIdentityProviderSupplier smithyIdentityProviderSupplier = [](const S3Client &client) -> std::shared_ptr<SmithyS3ExpressIdentityProvider> {
67+
return Aws::MakeShared<SmithyDefaultS3ExpressIdentityProvider>("S3ClientConfiguration", client);
68+
};
6569
private:
6670
void LoadS3SpecificConfig(const Aws::String& profileName);
6771
};

‎generated/src/aws-cpp-sdk-s3/include/aws/s3/S3ExpressAuthSchemeResolver.h‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/**
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
* SPDX-License-Identifier: Apache-2.0.
4+
*/
5+
6+
#pragma once
7+
8+
#include <aws/s3/S3ExpressSigner.h>
9+
#include <smithy/identity/auth/built-in/SigV4MultiAuthResolver.h>
10+
#include <aws/s3/S3ExpressSigV4AuthSchemeOption.h>
11+
#include <aws/s3/S3ExpressSigV4AuthScheme.h>
12+
13+
namespace Aws {
14+
namespace S3 {
15+
class AWS_S3_API S3ExpressAuthSchemeResolver : public smithy::SigV4MultiAuthSchemeResolver<S3EndpointProvider, S3::S3ClientConfiguration>{
16+
17+
public:
18+
Aws::Vector<smithy::AuthSchemeOption> resolveAuthScheme(const ServiceAuthSchemeParameters& identityProperties) override
19+
{
20+
//pack endpoint params from identityProperties
21+
Aws::Endpoint::EndpointParameters epParams;
22+
23+
for (auto& identParam : identityProperties.additionalProperties) {
24+
if (identParam.second.template holds_alternative<bool>())
25+
{
26+
epParams.emplace_back(Aws::Endpoint::EndpointParameter(identParam.first, identParam.second.template get<bool>()));
27+
}
28+
if (identParam.second.template holds_alternative<Aws::String>())
29+
{
30+
epParams.emplace_back(Aws::Endpoint::EndpointParameter(identParam.first ,identParam.second.template get<Aws::String>()));
31+
}
32+
}
33+
34+
//resolve endpoint first time to fetch auth schemes
35+
if(m_endpointProviderForAuth)
36+
{
37+
auto epResolutionOutcome = m_endpointProviderForAuth->ResolveEndpoint(epParams);
38+
if (epResolutionOutcome.IsSuccess())
39+
{
40+
auto endpoint = std::move(epResolutionOutcome.GetResultWithOwnership());
41+
if (endpoint.GetAttributes())
42+
{
43+
auto authSchemeName = endpoint.GetAttributes()->authScheme.GetName();
44+
if(strcmp(authSchemeName.c_str(),Aws::Auth::ASYMMETRIC_SIGV4_SIGNER) == 0)
45+
{
46+
return {smithy::SigV4aAuthSchemeOption::sigV4aAuthSchemeOption};
47+
}
48+
else if(strcmp(authSchemeName.c_str(),Aws::Auth::SIGV4_SIGNER) == 0)
49+
{
50+
return {smithy::SigV4AuthSchemeOption::sigV4AuthSchemeOption};
51+
}
52+
else if(strcmp(authSchemeName.c_str(), S3::S3_EXPRESS_SIGNER_NAME) == 0)
53+
{
54+
return {S3ExpressSigV4AuthSchemeOption::s3ExpressSigV4AuthSchemeOption};
55+
}
56+
}
57+
}
58+
}
59+
60+
return {smithy::SigV4AuthSchemeOption::sigV4AuthSchemeOption};
61+
}
62+
};
63+
}
64+
}

‎generated/src/aws-cpp-sdk-s3/include/aws/s3/S3ExpressIdentityProvider.h‎

Lines changed: 144 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@
88
#include <aws/core/utils/memory/stl/AWSSet.h>
99
#include <aws/core/utils/memory/stl/AWSString.h>
1010
#include <aws/core/utils/ConcurrentCache.h>
11-
#include <aws/core/auth/signer/AWSAuthSignerBase.h>
12-
#include <aws/s3/S3ExpressIdentity.h>
1311
#include <smithy/identity/resolver/AwsIdentityResolverBase.h>
12+
#include <smithy/identity/identity/AwsCredentialIdentity.h>
13+
#include <aws/s3/S3ExpressIdentity.h>
1414
#include <thread>
1515
#include <condition_variable>
16+
#include <aws/s3/S3_EXPORTS.h>
1617

1718
namespace Aws {
1819
namespace Http {
@@ -21,80 +22,155 @@ namespace Aws {
2122

2223
namespace S3 {
2324
class S3Client;
24-
class S3ExpressIdentityProvider: public smithy::IdentityResolverBase<S3ExpressIdentity> {
25-
public:
26-
explicit S3ExpressIdentityProvider(const S3Client &s3Client) : m_s3Client(s3Client) {}
27-
28-
virtual S3ExpressIdentity
25+
class AWS_S3_API S3ExpressIdentityProvider : public smithy::IdentityResolverBase<S3ExpressIdentity> {
26+
public:
27+
explicit S3ExpressIdentityProvider(const S3Client& s3Client);
28+
ResolveIdentityFutureOutcome getIdentity(
29+
const IdentityProperties& identityProperties,
30+
const AdditionalParameters& additionalParameters) override;
31+
32+
virtual S3ExpressIdentity
2933
GetS3ExpressIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) = 0;
3034

31-
ResolveIdentityFutureOutcome
32-
getIdentity(const IdentityProperties& identityProperties, const AdditionalParameters& additionalParameters) override;
33-
S3ExpressIdentity
34-
getIdentity(const Aws::String &bucketName);
35+
protected:
36+
37+
S3ExpressIdentity GetCredentialsFromBucket(const Aws::String& bucketName) const;
3538

36-
virtual ~S3ExpressIdentityProvider() {}
39+
private:
40+
const Aws::S3::S3Client& m_s3Client;
41+
mutable std::mutex m_bucketNameMapMutex;
42+
Aws::Map<Aws::String, std::shared_ptr<std::mutex>> m_bucketNameMutex;
3743

38-
protected:
39-
std::shared_ptr<std::mutex> GetMutexForBucketName(const Aws::String& bucketName);
40-
41-
private:
42-
const S3Client &m_s3Client;
43-
mutable std::mutex m_bucketNameMapMutex;
44-
Aws::Map<Aws::String, std::shared_ptr<std::mutex>> m_bucketNameMutex;
44+
protected:
45+
std::shared_ptr<std::mutex> GetMutexForBucketName(const Aws::String& bucketName);
46+
};
47+
48+
49+
class AWS_S3_API DefaultS3ExpressIdentityProvider : public S3ExpressIdentityProvider {
50+
public:
51+
explicit DefaultS3ExpressIdentityProvider(const S3Client& s3Client);
52+
explicit DefaultS3ExpressIdentityProvider(
53+
const S3Client& s3Client,
54+
std::shared_ptr<Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> credentialsCache);
55+
DefaultS3ExpressIdentityProvider(const DefaultS3ExpressIdentityProvider& other) = delete;
56+
DefaultS3ExpressIdentityProvider(DefaultS3ExpressIdentityProvider&& other) noexcept = delete;
57+
DefaultS3ExpressIdentityProvider& operator=(const DefaultS3ExpressIdentityProvider& other) = delete;
58+
DefaultS3ExpressIdentityProvider& operator=(DefaultS3ExpressIdentityProvider&& other) noexcept = delete;
59+
virtual ~DefaultS3ExpressIdentityProvider() override = default;
60+
S3ExpressIdentity GetS3ExpressIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
61+
62+
private:
63+
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> m_credentialsCache;
4564
};
4665

47-
class DefaultS3ExpressIdentityProvider : public S3ExpressIdentityProvider {
48-
public:
49-
explicit DefaultS3ExpressIdentityProvider(const S3Client &m_s3Client);
50-
51-
DefaultS3ExpressIdentityProvider(const S3Client &s3Client,
52-
std::shared_ptr<Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> credentialsCache);
53-
54-
DefaultS3ExpressIdentityProvider(const DefaultS3ExpressIdentityProvider& other) = delete;
55-
DefaultS3ExpressIdentityProvider(DefaultS3ExpressIdentityProvider&& other) noexcept = delete;
56-
DefaultS3ExpressIdentityProvider& operator=(const DefaultS3ExpressIdentityProvider& other) = delete;
57-
DefaultS3ExpressIdentityProvider& operator=(DefaultS3ExpressIdentityProvider&& other) noexcept = delete;
58-
59-
virtual ~DefaultS3ExpressIdentityProvider() override = default;
60-
61-
S3ExpressIdentity GetS3ExpressIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
66+
class AWS_S3_API DefaultAsyncS3ExpressIdentityProvider : public S3ExpressIdentityProvider {
67+
public:
68+
explicit DefaultAsyncS3ExpressIdentityProvider(
69+
const S3Client& s3Client,
70+
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
71+
72+
explicit DefaultAsyncS3ExpressIdentityProvider(
73+
const S3Client& s3Client,
74+
std::shared_ptr<Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> credentialsCache,
75+
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
76+
77+
DefaultAsyncS3ExpressIdentityProvider(const DefaultAsyncS3ExpressIdentityProvider& other) = delete;
78+
DefaultAsyncS3ExpressIdentityProvider(DefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
79+
DefaultAsyncS3ExpressIdentityProvider& operator=(
80+
const DefaultAsyncS3ExpressIdentityProvider& other) = delete;
81+
DefaultAsyncS3ExpressIdentityProvider& operator=(DefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
82+
virtual ~DefaultAsyncS3ExpressIdentityProvider() override;
83+
S3ExpressIdentity GetS3ExpressIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
84+
85+
private:
86+
void refreshIdentities(std::chrono::minutes refreshPeriod);
87+
void threadSafeKeyInsert(const Aws::String& key);
88+
bool threadSafeKeyHas(const Aws::String& key);
89+
void threadSafeKeyEmpty();
90+
91+
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> m_credentialsCache;
92+
Aws::Set<Aws::String> m_keysUsed;
93+
mutable std::mutex m_keysUsedMutex;
94+
mutable bool m_shouldStopBackgroundRefresh;
95+
Aws::UniquePtr<std::thread> m_backgroundRefreshThread;
96+
mutable std::mutex m_shutDownMutex;
97+
mutable std::condition_variable m_shutdownCondition;
98+
};
6299

63-
private:
64-
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> m_credentialsCache;
100+
/*------ Smithy version -----*/
101+
class AWS_S3_API SmithyS3ExpressIdentityProvider : public smithy::IdentityResolverBase<smithy::AwsCredentialIdentityBase> {
102+
public:
103+
explicit SmithyS3ExpressIdentityProvider(const S3Client& s3Client);
104+
ResolveIdentityFutureOutcome getIdentity(
105+
const IdentityProperties& identityProperties,
106+
const AdditionalParameters& additionalParameters) override;
107+
108+
protected:
109+
110+
virtual smithy::AwsCredentialIdentity GetS3ExpressAwsIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) = 0;
111+
smithy::AwsCredentialIdentity GetCredentialsFromBucket(const Aws::String& bucketName) const;
112+
113+
private:
114+
const Aws::S3::S3Client& m_s3Client;
115+
mutable std::mutex m_bucketNameMapMutex;
116+
Aws::Map<Aws::String, std::shared_ptr<std::mutex>> m_bucketNameMutex;
117+
118+
protected:
119+
std::shared_ptr<std::mutex> GetMutexForBucketName(const Aws::String& bucketName);
65120
};
66121

67-
class DefaultAsyncS3ExpressIdentityProvider : public S3ExpressIdentityProvider {
68-
public:
69-
explicit DefaultAsyncS3ExpressIdentityProvider(const S3Client &m_s3Client,
70-
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
71-
72-
DefaultAsyncS3ExpressIdentityProvider(const S3Client &s3Client,
73-
std::shared_ptr<Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> credentialsCache,
74-
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
75-
76-
DefaultAsyncS3ExpressIdentityProvider(const DefaultAsyncS3ExpressIdentityProvider& other) = delete;
77-
DefaultAsyncS3ExpressIdentityProvider(DefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
78-
DefaultAsyncS3ExpressIdentityProvider& operator=(const DefaultAsyncS3ExpressIdentityProvider& other) = delete;
79-
DefaultAsyncS3ExpressIdentityProvider& operator=(DefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
80-
81-
virtual ~DefaultAsyncS3ExpressIdentityProvider() override;
82-
83-
S3ExpressIdentity GetS3ExpressIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
84-
85-
private:
86-
void refreshIdentities(std::chrono::minutes refreshPeriod);
87-
void threadSafeKeyInsert(const Aws::String& key);
88-
bool threadSafeKeyHas(const Aws::String& key);
89-
void threadSafeKeyEmpty();
90-
91-
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, S3ExpressIdentity>> m_credentialsCache;
92-
Aws::Set<Aws::String> m_keysUsed;
93-
mutable std::mutex m_keysUsedMutex;
94-
mutable bool m_shouldStopBackgroundRefresh;
95-
Aws::UniquePtr<std::thread> m_backgroundRefreshThread;
96-
mutable std::mutex m_shutDownMutex;
97-
mutable std::condition_variable m_shutdownCondition;
122+
class AWS_S3_API SmithyDefaultS3ExpressIdentityProvider : public SmithyS3ExpressIdentityProvider {
123+
public:
124+
explicit SmithyDefaultS3ExpressIdentityProvider(const S3Client& s3Client);
125+
explicit SmithyDefaultS3ExpressIdentityProvider(
126+
const S3Client& s3Client,
127+
std::shared_ptr<Utils::ConcurrentCache<Aws::String, smithy::AwsCredentialIdentity>> credentialsCache);
128+
SmithyDefaultS3ExpressIdentityProvider(const SmithyDefaultS3ExpressIdentityProvider& other) = delete;
129+
SmithyDefaultS3ExpressIdentityProvider(SmithyDefaultS3ExpressIdentityProvider&& other) noexcept = delete;
130+
SmithyDefaultS3ExpressIdentityProvider& operator=(const SmithyDefaultS3ExpressIdentityProvider& other) = delete;
131+
SmithyDefaultS3ExpressIdentityProvider& operator=(SmithyDefaultS3ExpressIdentityProvider&& other) noexcept = delete;
132+
virtual ~SmithyDefaultS3ExpressIdentityProvider() override = default;
133+
134+
protected:
135+
smithy::AwsCredentialIdentity GetS3ExpressAwsIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
136+
137+
private:
138+
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, smithy::AwsCredentialIdentity>> m_credentialsCache;
139+
};
140+
141+
class AWS_S3_API SmithyDefaultAsyncS3ExpressIdentityProvider : public SmithyS3ExpressIdentityProvider {
142+
public:
143+
explicit SmithyDefaultAsyncS3ExpressIdentityProvider(
144+
const S3Client& s3Client,
145+
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
146+
147+
explicit SmithyDefaultAsyncS3ExpressIdentityProvider(
148+
const S3Client& s3Client,
149+
std::shared_ptr<Utils::ConcurrentCache<Aws::String, smithy::AwsCredentialIdentity>> credentialsCache,
150+
std::chrono::minutes refreshPeriod = std::chrono::minutes(1));
151+
152+
SmithyDefaultAsyncS3ExpressIdentityProvider(const SmithyDefaultAsyncS3ExpressIdentityProvider& other) = delete;
153+
SmithyDefaultAsyncS3ExpressIdentityProvider(SmithyDefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
154+
SmithyDefaultAsyncS3ExpressIdentityProvider& operator=(
155+
const SmithyDefaultAsyncS3ExpressIdentityProvider& other) = delete;
156+
SmithyDefaultAsyncS3ExpressIdentityProvider& operator=(SmithyDefaultAsyncS3ExpressIdentityProvider&& other) noexcept = delete;
157+
virtual ~SmithyDefaultAsyncS3ExpressIdentityProvider() override;
158+
protected:
159+
smithy::AwsCredentialIdentity GetS3ExpressAwsIdentity(const std::shared_ptr<Aws::Http::ServiceSpecificParameters> &serviceSpecificParameters) override;
160+
161+
private:
162+
void refreshIdentities(std::chrono::minutes refreshPeriod);
163+
void threadSafeKeyInsert(const Aws::String& key);
164+
bool threadSafeKeyHas(const Aws::String& key);
165+
void threadSafeKeyEmpty();
166+
167+
mutable std::shared_ptr<Aws::Utils::ConcurrentCache<Aws::String, smithy::AwsCredentialIdentity>> m_credentialsCache;
168+
Aws::Set<Aws::String> m_keysUsed;
169+
mutable std::mutex m_keysUsedMutex;
170+
mutable bool m_shouldStopBackgroundRefresh;
171+
Aws::UniquePtr<std::thread> m_backgroundRefreshThread;
172+
mutable std::mutex m_shutDownMutex;
173+
mutable std::condition_variable m_shutdownCondition;
98174
};
99175
}
100-
}
176+
}

0 commit comments

Comments
 (0)