Skip to content

Commit 77cf98e

Browse files
authored
docs: add roadmap and notes (#4)
1 parent 556212f commit 77cf98e

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

readme.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# mfaws
22

3-
A CLI tool to easily manage AWS credentials for MFA-enabled accounts. **mfaws** talks to the [AWS Security Token Service API](https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html) and allows you to obtain temporary credentials using your AWS access key, AWS secret key and MFA device.
3+
A cross-platform CLI tool to easily manage AWS credentials for MFA-enabled accounts. **mfaws** talks to the [AWS Security Token Service API](https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html) and allows you to obtain temporary credentials using your AWS access key, AWS secret key and MFA device.
44

55
Supported STS operations:
66

@@ -158,15 +158,23 @@ Options:
158158
Print version
159159
```
160160

161+
## Roadmap and Todos
162+
163+
- As of now, all requests to STS hit `us-east-1` instead of a regional endpoint. Millisecond latency does not really matter for this tool, but it'd be nice being able to specify a custom regional endpoint (or read it from `~/.aws/conf`)
164+
161165
## Migrating from `aws-mfa`: What's different?
162166

163167
1. By default, all profiles are considered long-term profiles unless they end with the short term suffix set by `--short-term-suffix [SHUFFIX]`. There is no such thing as an _explicit_ long-term suffix (hence, also no `--long-term-suffix` flag)
164-
2. `--role-session-name [NAME]` does not use the [login name of your user](https://docs.python.org/3/library/getpass.html) by default but the static string `mfa-user`
168+
2. Unlike `aws-mfa`, where actions (AssumeRole/GetSessionToken) are implicitly given by the presence of the `--assume-role` flag, **mfaws** has dedicated sub-commands for each operation
169+
3. `--assume-role` is `--role-arn`
170+
4. `--role-session-name [NAME]` does not use the [login name of your user](https://docs.python.org/3/library/getpass.html) by default but the static string `mfa-user`
165171

166172
## Contributing and Notes
167173

168-
- TODO
174+
At this point, **mfaws** is merely out of its "alpha" stage and, although stable, lacks a lot cruical properties. There's no testing strategy, no integration/e2e tests 😢.
175+
176+
I'm still a complete beginner with Rust, and suggestions on how to improve this project and make things prettier are very welcome! Of course, I'm also very happy for general feedback, bugfixes and feature ideas.
169177

170178
## Acknowledgements
171179

172-
- [broamski](https://github.com/broamski) for the MIT license of [aws-mfa](https://github.com/broamski/aws-mfa). The general idea for this tool and much of the help command descriptions were stolen from his work.
180+
- [broamski](https://github.com/broamski) for the MIT license of [`aws-mfa`](https://github.com/broamski/aws-mfa). The general idea for this tool and much of the help command descriptions were stolen from his work.

0 commit comments

Comments
 (0)