Skip to content

Commit 3670381

Browse files
committed
feat(util-credentials): move shared credential utils to util-credential package
1 parent f239221 commit 3670381

File tree

13 files changed

+345
-49
lines changed

13 files changed

+345
-49
lines changed

packages/credential-provider-ini/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"@aws-sdk/property-provider": "3.20.0",
2828
"@aws-sdk/shared-ini-file-loader": "3.20.0",
2929
"@aws-sdk/types": "3.20.0",
30+
"@aws-sdk/util-credentials": "3.0.0",
3031
"tslib": "^2.0.0"
3132
},
3233
"devDependencies": {

packages/credential-provider-ini/src/index.ts

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,10 @@ import { fromEnv } from "@aws-sdk/credential-provider-env";
22
import { fromContainerMetadata, fromInstanceMetadata } from "@aws-sdk/credential-provider-imds";
33
import { AssumeRoleWithWebIdentityParams, fromTokenFile } from "@aws-sdk/credential-provider-web-identity";
44
import { CredentialsProviderError } from "@aws-sdk/property-provider";
5-
import {
6-
loadSharedConfigFiles,
7-
ParsedIniData,
8-
Profile,
9-
SharedConfigFiles,
10-
SharedConfigInit,
11-
} from "@aws-sdk/shared-ini-file-loader";
5+
import { ParsedIniData, Profile } from "@aws-sdk/shared-ini-file-loader";
126
import { CredentialProvider, Credentials } from "@aws-sdk/types";
7+
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/util-credentials";
138

14-
const DEFAULT_PROFILE = "default";
159
export const ENV_PROFILE = "AWS_PROFILE";
1610

1711
/**
@@ -47,21 +41,6 @@ export interface AssumeRoleParams {
4741
TokenCode?: string;
4842
}
4943

50-
export interface SourceProfileInit extends SharedConfigInit {
51-
/**
52-
* The configuration profile to use.
53-
*/
54-
profile?: string;
55-
56-
/**
57-
* A promise that will be resolved with loaded and parsed credentials files.
58-
* Used to avoid loading shared config files multiple times.
59-
*
60-
* @internal
61-
*/
62-
loadedConfig?: Promise<SharedConfigFiles>;
63-
}
64-
6544
export interface FromIniInit extends SourceProfileInit {
6645
/**
6746
* A function that returns a promise fulfilled with an MFA token code for
@@ -153,28 +132,6 @@ export const fromIni =
153132
return resolveProfileData(getMasterProfileName(init), profiles, init);
154133
};
155134

156-
/**
157-
* Load profiles from credentials and config INI files and normalize them into a
158-
* single profile list.
159-
*
160-
* @internal
161-
*/
162-
export const parseKnownFiles = async (init: SourceProfileInit): Promise<ParsedIniData> => {
163-
const { loadedConfig = loadSharedConfigFiles(init) } = init;
164-
165-
const parsedFiles = await loadedConfig;
166-
return {
167-
...parsedFiles.configFile,
168-
...parsedFiles.credentialsFile,
169-
};
170-
};
171-
172-
/**
173-
* @internal
174-
*/
175-
export const getMasterProfileName = (init: { profile?: string }): string =>
176-
init.profile || process.env[ENV_PROFILE] || DEFAULT_PROFILE;
177-
178135
const resolveProfileData = async (
179136
profileName: string,
180137
profiles: ParsedIniData,

packages/credential-provider-node/src/index.spec.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ jest.mock("@aws-sdk/credential-provider-ini", () => {
2727
fromIni: jest.fn().mockReturnValue(iniProvider),
2828
};
2929
});
30-
import { ENV_PROFILE, fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
30+
import { fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
3131
import { ENV_CONFIG_PATH, ENV_CREDENTIALS_PATH } from "@aws-sdk/shared-ini-file-loader";
32+
import { ENV_PROFILE } from "@aws-sdk/util-credentials";
3233

3334
jest.mock("@aws-sdk/credential-provider-process", () => {
3435
const processProvider = jest.fn();

packages/credential-provider-node/src/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ import {
66
fromInstanceMetadata,
77
RemoteProviderInit,
88
} from "@aws-sdk/credential-provider-imds";
9-
import { ENV_PROFILE, fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
9+
import { fromIni, FromIniInit } from "@aws-sdk/credential-provider-ini";
1010
import { fromProcess, FromProcessInit } from "@aws-sdk/credential-provider-process";
1111
import { fromSSO, FromSSOInit } from "@aws-sdk/credential-provider-sso";
1212
import { fromTokenFile, FromTokenFileInit } from "@aws-sdk/credential-provider-web-identity";
1313
import { chain, CredentialsProviderError, memoize } from "@aws-sdk/property-provider";
1414
import { loadSharedConfigFiles } from "@aws-sdk/shared-ini-file-loader";
1515
import { CredentialProvider } from "@aws-sdk/types";
16+
import { ENV_PROFILE } from "@aws-sdk/util-credentials";
1617

1718
export const ENV_IMDS_DISABLED = "AWS_EC2_METADATA_DISABLED";
1819

packages/credential-provider-process/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121
},
2222
"license": "Apache-2.0",
2323
"dependencies": {
24-
"@aws-sdk/credential-provider-ini": "3.20.0",
2524
"@aws-sdk/property-provider": "3.20.0",
2625
"@aws-sdk/shared-ini-file-loader": "3.20.0",
2726
"@aws-sdk/types": "3.20.0",
27+
"@aws-sdk/util-credentials": "3.0.0",
2828
"tslib": "^2.0.0"
2929
},
3030
"devDependencies": {

packages/credential-provider-process/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/credential-provider-ini";
21
import { CredentialsProviderError } from "@aws-sdk/property-provider";
32
import { ParsedIniData } from "@aws-sdk/shared-ini-file-loader";
43
import { CredentialProvider, Credentials } from "@aws-sdk/types";
4+
import { getMasterProfileName, parseKnownFiles, SourceProfileInit } from "@aws-sdk/util-credentials";
55
import { exec } from "child_process";
66

77
/**

packages/util-credentials/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 2019 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/util-credentials/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# @aws-sdk/util-credentials
2+
3+
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/credential-provider-sso/latest.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-sso)
4+
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/credential-provider-sso.svg)](https://www.npmjs.com/package/@aws-sdk/credential-provider-sso)
5+
6+
> An internal package
7+
8+
This package provides shared utilities for all credential providers.
9+
10+
## Usage
11+
12+
You probably shouldn't, at least directly.
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+
};
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"name": "@aws-sdk/util-credentials",
3+
"version": "3.0.0",
4+
"description": "Shared utilities for all credential providers.",
5+
"main": "./dist/cjs/index.js",
6+
"module": "./dist/es/index.js",
7+
"scripts": {
8+
"build:cjs": "tsc -p tsconfig.cjs.json",
9+
"build:es": "tsc -p tsconfig.es.json",
10+
"build": "yarn build:es && yarn build:cjs",
11+
"downlevel-dts": "downlevel-dts dist/types dist/types/ts3.4",
12+
"test": "jest"
13+
},
14+
"keywords": [
15+
"aws",
16+
"credentials"
17+
],
18+
"author": {
19+
"name": "AWS SDK for JavaScript Team",
20+
"url": "https://aws.amazon.com/javascript/"
21+
},
22+
"license": "Apache-2.0",
23+
"dependencies": {
24+
"@aws-sdk/shared-ini-file-loader": "3.20.0",
25+
"@aws-sdk/types": "3.20.0",
26+
"tslib": "^2.0.0"
27+
},
28+
"devDependencies": {
29+
"@types/jest": "^26.0.4",
30+
"@types/node": "^10.0.0",
31+
"jest": "^26.1.0",
32+
"typescript": "~4.3.2"
33+
},
34+
"types": "./dist/types/index.d.ts",
35+
"engines": {
36+
"node": ">= 10.0.0"
37+
},
38+
"typesVersions": {
39+
"<4.0": {
40+
"types/*": [
41+
"types/ts3.4/*"
42+
]
43+
}
44+
},
45+
"homepage": "https://github.com/aws/aws-sdk-js-v3/tree/master/packages/util-credentials",
46+
"repository": {
47+
"type": "git",
48+
"url": "https://github.com/aws/aws-sdk-js-v3.git",
49+
"directory": "packages/util-credentials"
50+
}
51+
}

0 commit comments

Comments
 (0)