Skip to content

Commit 16aa220

Browse files
AllanZhengYPtrivikr
AllanZhengYP
and
trivikr
authored
feat(signature-v4-multi-region): support multi-region sigv4a signer (#3518)
* feat(client-eventbridge): support multi-region sigv4a signer * feat(middleare-sdk-eventbridge): initial commit for eventbridge middleware * feat(signature-v3-cross-region): move S3 sigv4a signer to a new package * feat(middleware-sdk-eventbridge): implement inject endpointId mw * chore: generate S3 signer constroctor from new package * chore(eventbridge): add customization code generator * feat(s3-request-presigner): use cross region signer instead of s3 signer Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
1 parent 17d4f47 commit 16aa220

32 files changed

+1029
-47
lines changed

‎clients/client-s3/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
"@aws-sdk/node-config-provider": "*",
5252
"@aws-sdk/node-http-handler": "*",
5353
"@aws-sdk/protocol-http": "*",
54+
"@aws-sdk/signature-v4-multi-region": "*",
5455
"@aws-sdk/smithy-client": "*",
5556
"@aws-sdk/types": "*",
5657
"@aws-sdk/url-parser": "*",

‎clients/client-s3/src/runtimeConfig.shared.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { S3SignatureV4 } from "@aws-sdk/middleware-sdk-s3";
1+
import { SignatureV4MultiRegion } from "@aws-sdk/signature-v4-multi-region";
22
import { Logger as __Logger } from "@aws-sdk/types";
33
import { parseUrl } from "@aws-sdk/url-parser";
44

@@ -14,7 +14,7 @@ export const getRuntimeConfig = (config: S3ClientConfig) => ({
1414
logger: config?.logger ?? ({} as __Logger),
1515
regionInfoProvider: config?.regionInfoProvider ?? defaultRegionInfoProvider,
1616
serviceId: config?.serviceId ?? "S3",
17-
signerConstructor: config?.signerConstructor ?? S3SignatureV4,
17+
signerConstructor: config?.signerConstructor ?? SignatureV4MultiRegion,
1818
signingEscapePath: config?.signingEscapePath ?? false,
1919
urlParser: config?.urlParser ?? parseUrl,
2020
useArnRegion: config?.useArnRegion ?? false,

‎codegen/config/checkstyle/checkstyle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<!-- Files must contain a copyright header. -->
3333
<module name="RegexpHeader">
3434
<property name="header"
35-
value="/\*\n \* Copyright 20(19|20|21) Amazon\.com, Inc\. or its affiliates\. All Rights Reserved\.\n"/>
35+
value="/\*\n \* Copyright 20(19|20|21|22) Amazon\.com, Inc\. or its affiliates\. All Rights Reserved\.\n"/>
3636
<property name="fileExtensions" value="java"/>
3737
</module>
3838

‎codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddEventBridgePlugin.java

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
/*
2+
* Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
package software.amazon.smithy.aws.typescript.codegen;
17+
18+
import static software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin.Convention.HAS_MIDDLEWARE;
19+
20+
import java.util.Collections;
21+
import java.util.List;
22+
import java.util.Map;
23+
import java.util.function.Consumer;
24+
import software.amazon.smithy.aws.traits.ServiceTrait;
25+
import software.amazon.smithy.codegen.core.SymbolProvider;
26+
import software.amazon.smithy.model.Model;
27+
import software.amazon.smithy.model.shapes.Shape;
28+
import software.amazon.smithy.typescript.codegen.LanguageTarget;
29+
import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
30+
import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
31+
import software.amazon.smithy.typescript.codegen.integration.RuntimeClientPlugin;
32+
import software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration;
33+
import software.amazon.smithy.utils.ListUtils;
34+
import software.amazon.smithy.utils.MapUtils;
35+
import software.amazon.smithy.utils.SmithyInternalApi;
36+
37+
/**
38+
* Adds customizations for EventBridge service.
39+
*/
40+
@SmithyInternalApi
41+
public final class AddEventBridgePlugin implements TypeScriptIntegration {
42+
43+
@Override
44+
public List<RuntimeClientPlugin> getClientPlugins() {
45+
return ListUtils.of(
46+
RuntimeClientPlugin.builder()
47+
.withConventions(AwsDependency.EVENTBRIDGE_MIDDLEWARE.dependency, "InjectEndpointId",
48+
HAS_MIDDLEWARE)
49+
.operationPredicate((m, s, o) -> testServiceId(s) && o.getId().getName(s).equals("PutEvents"))
50+
.build()
51+
);
52+
}
53+
54+
public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(TypeScriptSettings settings, Model model,
55+
SymbolProvider symbolProvider, LanguageTarget target) {
56+
if (!testServiceId(settings.getService(model))) {
57+
return Collections.emptyMap();
58+
}
59+
switch (target) {
60+
case SHARED:
61+
return MapUtils.of("signerConstructor", writer -> {
62+
writer.addDependency(AwsDependency.SIGNATURE_V4_MULTIREGION)
63+
.addImport("SignatureV4MultiRegion", "SignatureV4MultiRegion",
64+
AwsDependency.SIGNATURE_V4_MULTIREGION.packageName)
65+
.write("SignatureV4MultiRegion");
66+
});
67+
default:
68+
return Collections.emptyMap();
69+
}
70+
}
71+
72+
private static boolean testServiceId(Shape serviceShape) {
73+
return serviceShape.getTrait(ServiceTrait.class).map(ServiceTrait::getSdkId).orElse("").equals("EventBridge");
74+
}
75+
}

‎codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AddS3Config.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,10 @@ public Map<String, Consumer<TypeScriptWriter>> getRuntimeConfigWriters(TypeScrip
135135
}, "useArnRegion", writer -> {
136136
writer.write("false");
137137
}, "signerConstructor", writer -> {
138-
writer.addDependency(AwsDependency.S3_MIDDLEWARE)
139-
.addImport("S3SignatureV4", "S3SignatureV4", AwsDependency.S3_MIDDLEWARE.packageName)
140-
.write("S3SignatureV4");
138+
writer.addDependency(AwsDependency.SIGNATURE_V4_MULTIREGION)
139+
.addImport("SignatureV4MultiRegion", "SignatureV4MultiRegion",
140+
AwsDependency.SIGNATURE_V4_MULTIREGION.packageName)
141+
.write("SignatureV4MultiRegion");
141142
});
142143
case NODE:
143144
return MapUtils.of("useArnRegion", writer -> {

‎codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsDependency.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ public enum AwsDependency implements SymbolDependencyContainer {
7272
AWS_SDK_UTIL_USER_AGENT_NODE(NORMAL_DEPENDENCY, "@aws-sdk/util-user-agent-node"),
7373
MIDDLEWARE_ENDPOINT_DISCOVERY(NORMAL_DEPENDENCY, "@aws-sdk/middleware-endpoint-discovery"),
7474
AWS_CRYPTO_SHA1_BROWSER(NORMAL_DEPENDENCY, "@aws-crypto/sha1-browser", "2.0.0"),
75+
SIGNATURE_V4_MULTIREGION(NORMAL_DEPENDENCY, "@aws-sdk/signature-v4-multi-region"),
76+
EVENTBRIDGE_MIDDLEWARE(NORMAL_DEPENDENCY, "@aws-sdk/middleware-sdk-eventbridge"),
7577

7678
// Conditionally added when httpChecksum trait exists
7779
MD5_BROWSER(NORMAL_DEPENDENCY, "@aws-sdk/md5-js"),

‎codegen/smithy-aws-typescript-codegen/src/main/resources/META-INF/services/software.amazon.smithy.typescript.codegen.integration.TypeScriptIntegration

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ software.amazon.smithy.aws.typescript.codegen.StripNewEnumNames
2121
software.amazon.smithy.aws.typescript.codegen.AddCrossRegionCopyingPlugin
2222
software.amazon.smithy.aws.typescript.codegen.AddDocumentClientPlugin
2323
software.amazon.smithy.aws.typescript.codegen.AddEndpointDiscoveryPlugin
24-
software.amazon.smithy.aws.typescript.codegen.AddHttpChecksumDependency
24+
software.amazon.smithy.aws.typescript.codegen.AddHttpChecksumDependency
25+
software.amazon.smithy.aws.typescript.codegen.AddEventBridgePlugin

‎packages/middleware-sdk-eventbridge/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/middleware-sdk-eventbridge/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# @aws-sdk/middleware-sdk-eventbridge
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/middleware-sdk-eventbridge/latest.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-eventbridge)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/middleware-sdk-eventbridge.svg)](https://www.npmjs.com/package/@aws-sdk/middleware-sdk-eventbridge)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/middleware-sdk-eventbridge/jest.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
const base = require("../../jest.config.base.js");
2+
3+
module.exports = {
4+
...base,
5+
};

0 commit comments

Comments
 (0)