Skip to content

Commit 3948193

Browse files
committed
style[docs]: update main readme
1 parent 7d1474a commit 3948193

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# aws-cli-auth
22

3-
CLI tool for retrieving AWS temporary credentials using OIDC or SAML providers.
3+
CLI tool for retrieving AWS temporary credentials using SAML providers.
44

55
Firstly, this package currently deals with SAML only (OIDC to come), however if you have an OIDC IdP provider set up to AWS you can use this [package](https://github.com/openstandia/aws-cli-oidc) and likewise this [package](https://github.com/Versent/saml2aws) for standard SAML AWS integrations.
66

7-
If, however, you need to support a non standard user journeys enforced by your IdP i.e. a sub company selection within your organization portal, or a selection screen for different MFA providers - PingID or RSA HardToken etc.... you cannot reliably automate the flow or it would have to be too specific.
7+
If, however, you need to support a non standard user journeys enforced by your IdP i.e. a sub company selection within your organization login portal, or a selection screen for different MFA providers - PingID or RSA HardToken etc.... you cannot reliably automate the flow or it would have to be too specific.
88

99
As such this approach uses [go-rod](https://github.com/go-rod/rod) library to uniformly allow the user to complete any and all auth steps and selections in a managed browser session up to the point of where the SAMLResponse were to be sent to AWS ACS service `https://signin.aws.amazon.com/saml`. Capturing this via hijack request and posting to AWS STS service to exchange this for the temporary credentials.
1010

@@ -25,11 +25,20 @@ Download from [Releases page](https://github.com/dnitsch/aws-cli-auth/releases).
2525
MacOS
2626

2727
```bash
28-
curl -L https://github.com/dnitsch/aws-cli-auth/releases/download/v0.1.0/aws-cli-auth-darwin-amd64 -o aws-cli-auth
28+
curl -L https://github.com/dnitsch/aws-cli-auth/releases/download/v0.3.0/aws-cli-auth-darwin -o aws-cli-auth
2929
chmod +x aws-cli-auth
3030
sudo mv aws-cli-auth /usr/local/bin
3131
```
3232

33+
Linux
34+
```bash
35+
curl -L https://github.com/dnitsch/aws-cli-auth/releases/download/v0.3.0/aws-cli-auth-linux -o aws-cli-auth
36+
chmod +x aws-cli-auth
37+
sudo mv aws-cli-auth /usr/local/bin
38+
```
39+
40+
41+
3342
## Usage
3443

3544
```

0 commit comments

Comments
 (0)