Skip to content

Commit bed40ae

Browse files
committed
fix: update readme
1 parent e2245aa commit bed40ae

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This tool deals with IdP logins via SAML, both into an AWS account directly or v
2727
2828
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.
2929

30-
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 is to be sent to AWS ACS service `https://signin.aws.amazon.com/saml`.
30+
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 is to be sent to AWS ACS service `https://signin.aws.amazon.com/saml`.
3131

3232
Capturing this via hijack request and posting to AWS STS service to exchange this for the temporary credentials.
3333

docs/usage.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,40 @@ Usage:
3434
aws-cli-auth saml <SAML ProviderUrl> [flags]
3535
3636
Flags:
37-
-a, --acsurl string Override the default ACS Url, used for checkin the post of the SAMLResponse (default "https://signin.aws.amazon.com/saml")
38-
-h, --help help for saml
39-
-d, --max-duration int Override default max session duration, in seconds, of the role session [900-43200] (default 900)
40-
--principal string Principal Arn of the SAML IdP in AWS
41-
-p, --provider string Saml Entity StartSSO Url
37+
-a, --acsurl string Override the default ACS Url, used for checkin the post of the SAMLResponse (default "https://signin.aws.amazon.com/saml")
38+
--executable-path string Custom path to an executable
39+
40+
This needs to be a chromium like executable - e.g. Chrome, Chromium, Brave, Edge.
41+
42+
You can find out the path by opening your browser and typing in chrome|brave|edge://version
43+
44+
-h, --help help for saml
45+
--is-sso Enables the new AWS User portal login.
46+
If this flag is specified the --sso-role must also be specified.
47+
--principal string Principal Arn of the SAML IdP in AWS
48+
You should find it in the IAM portal e.g.: arn:aws:iam::1234567891012:saml-provider/MyCompany-Idp
49+
50+
-p, --provider string Saml Entity StartSSO Url.
51+
This is the URL your Idp will make the first call to e.g.: https://company-xyz.okta.com/home/amazon_aws/12345SomeRandonId6789
52+
53+
--reload-before int Triggers a credentials refresh before the specified max-duration. Value provided in seconds. Should be less than the max-duration of the session
54+
-r, --role string Set the role you want to assume when SAML or OIDC process completes
55+
--saml-timeout int32 Timeout in seconds, before the operation of waiting for a response is cancelled via the chrome driver (default 120)
56+
--sso-fed-endpoint string FederationCredEndpoint in a go style fmt.Sprintf string with a region placeholder (default "https://portal.sso.%s.amazonaws.com/federation/credentials/")
57+
--sso-region string If using SSO, you must set the region (default "eu-west-1")
58+
--sso-role string Sso Role name must be in this format - 12345678910:PowerUser
59+
--sso-user-endpoint string UserEndpoint in a go style fmt.Sprintf string with a region placeholder (default "https://portal.sso.%s.amazonaws.com/user")
4260
4361
Global Flags:
44-
--cfg-section string config section name in the yaml config file
45-
-r, --role string Set the role you want to assume when SAML or OIDC process completes
46-
-s, --store-profile By default the credentials are returned to stdout to be used by the credential_process
62+
--cfg-section string Config section name in the default AWS credentials file. To enable priofi
63+
-d, --max-duration int Override default max session duration, in seconds, of the role session [900-43200].
64+
NB: This cannot be higher than the 3600 as the API does not allow for AssumeRole for sessions longer than an hour (default 900)
65+
--role-chain strings If specified it will assume the roles from the base credentials, in order they are specified in
66+
-s, --store-profile By default the credentials are returned to stdout to be used by the
67+
68+
credential_process.
69+
Set this flag to instead store the credentials under a named profile section. You can then reference that profile name via the CLI or for use in an SDK
70+
-v, --verbose Verbose output
4771
```
4872

4973
Example:

0 commit comments

Comments
 (0)