Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pbar1 committed Nov 10, 2024
1 parent 576a3af commit f47b8e3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center" style="border-bottom: none;">:lock: mfaws :lock:</h1>
<h3 align="center">AWS Multi-Factor Authentication manager</h3>
<h3 align="center">AWS multi-Factor authentication manager</h3>

<p align="center">
<a href="https://github.com/pbar1/mfaws/actions/workflows/build.yml">
Expand Down Expand Up @@ -27,8 +27,6 @@
- **[Chocolatey](https://chocolatey.org/packages/mfaws):** `choco install mfaws`
- **[AUR](https://aur.archlinux.org/packages/mfaws-bin):** `yay -S mfaws-bin`



## Usage

`mfaws` works by looking for AWS credentials and an MFA device ARN in profiles suffixed with `-long-term`. It uses those credentials as well as a TOTP code supplied by the user to make an `AssumeRole` call. The outcome of this is another set of short-lived credentials scoped to the role session. These short lived credentials are stored in a separate profile in the credentials file without the `-long-term` suffix.
Expand Down Expand Up @@ -92,7 +90,7 @@ You can use `oathtool` to get TOTP codes directly in the CLI without having to c
oathtool --totp --base32 $YOUR_AWS_TOTP_KEY | mfaws
```

### Combine with [1Password CLI](https://developer.1password.com/docs/cli/) (`op`)
### Combine with [1Password CLI](https://developer.1password.com/docs/cli/)

You can get TOTP codes from MFA keys that you've saved in your 1Password account. This has the advantage of not leaking the secret to disk. In this example, we're requesting a TOTP code from an item called "AWS" in our 1Password account and piping it into `mfaws`:

Expand Down
3 changes: 0 additions & 3 deletions build/package/Dockerfile

This file was deleted.

0 comments on commit f47b8e3

Please sign in to comment.