Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xeger committed Feb 5, 2023
1 parent 249529e commit 6b13550
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,46 @@ pipx inject awsume awsume-yubikey-plugin
### Configure AWSume

This plugin needs to know which YubiKey OATH token to use for each MFA token.
You can specify this information in a new subsection of `~/.awsume/config.yaml`, that maps MFA token ARNs to the correspodning YubiKey item that can generate MFA codes.
You can specify this information your AWSume configuration file.

An example:

```yaml
# ~/.awsume/config.yaml

colors: true
yubikey: AWS
```

In this example, I have only one MFA token shared among all my accounts (which belong to the same organization).

I have a corresponding YubiKey account that looks like this:

```sh
$ ykman oath accounts list

AWS
```

### Multiple MFA Tokens

```yaml
# ~/.awsume/config.yaml

colors: true
fuzzy-match: false
yubikey:
"arn:aws:iam::12345:mfa/tony": "AWS (12345, tony)"
"arn:aws:iam::67890:mfa/xeger": "AWS (67890, xeger)"
```

In this example, when I assume roles via my AWS account 12345, I use an MFA token associated with the IAM user `tony` that I have configured in the [AWS Console](https://us-east-1.console.aws.amazon.com/iamv2/home).
I have a corresponding YubiKey account that looks like this:
In this example, I work with two login accounts belonging to two different organizations: one where my name is `tony` and another where my name is `xeger`.

I have corresponding YubiKey accounts that look like this:

```sh
$ ykman oath accounts list

AWS (12345, tony)
AWS (67890, xeger)
```

## Usage
Expand Down

0 comments on commit 6b13550

Please sign in to comment.