1
0
mirror of https://github.com/getsops/sotp.git synced 2026-02-05 09:45:59 +01:00

readme update

This commit is contained in:
Julien Vehent
2020-03-31 10:45:32 -04:00
parent c388c2189e
commit 1254c71fde
2 changed files with 21 additions and 3 deletions

View File

@@ -1,10 +1,28 @@
# sotp: sops otp
# SOTP: Sops OTP
small utility to store aws totp secrets into sops encrypted files and generate totp on the command line.
Small utility to store AWS TOTP secrets into Sops encrypted files and generate OTP on the command line.
[![CircleCI](https://circleci.com/gh/mozilla/sotp.svg?style=svg)](https://circleci.com/gh/mozilla/sotp)
usage:
```
$ sotp test1
current one-time password is: 693190
```
```
Sotp reads it's configuration from `config.yaml` in the local directory.
The config must be a valid Sops encrypted YAML file with the syntax:
```yaml
accounts:
- name: test1
totpsecret: YAGQP5IP77OO3HMPS3D2KPMSNLNDIB7EO22EGAN3JEGE3DAR37Z2U5YDGKGN44VA
- name: test2
totpsecret: xyzabcd....
```
* `name` is just a reference name that you'll use when invoking Sotp
* `totpsecret` is a the secret seed you get from the `Adding a virtual MFA` screen in the AWS IAM console of a given user
![aws_mfa_screen](./docs/aws_vmfa.png)

BIN
docs/aws_vmfa.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB