Skip to content

Commit

Permalink
Adde pricing and IAM example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Breidenstein committed Feb 24, 2020
1 parent 97e223a commit c66ff46
Showing 1 changed file with 44 additions and 4 deletions.
48 changes: 44 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,46 @@

This tool helps you to share a virtual TOTP MFA-device with a team by saving the intial seed at AWS SecretsManager.

## Pricing
SecretsManager is charged both per secret and per 10.000 API calls. Every secret costs 0.40\$/Month which will be the
main operational costs of this tool. 10k API calls will cost you 0.05$, which you probably never reach in a month even
with a larger people using this tool multiple times a day.

Because every value in AWS SecretsManager is a JSON object we could save all
seeds in a single key/value pair and cap the monthly costs 0.40\$/month by
this, but would loose the feature of fine-grained access control with an IAM
rule.

## IAM permissions
With this policy one could use all features of this tool. If you want people to just have read access, just remove the
`Delete` and `Create` actions.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"secretsmanager:GetSecretValue",
"secretsmanager:DeleteSecret"
],
"Resource": "arn:aws:secretsmanager:eu-central-1:<your-account-id>:secret:2fa-*"
},
{
"Sid": "VisualEditor1",
"Effect": "Allow",
"Action": [
"secretsmanager:CreateSecret",
"secretsmanager:ListSecrets"
],
"Resource": "*"
}
]
}
```

## Usage
```
Available Commands:
add Create a new entry
Expand All @@ -11,31 +51,31 @@ Available Commands:
list A brief description of your command
```

## add
### add
```
Create a new entry
Usage:
shared-2fa add <name> <seed>
```

## delete
### delete
```
Delete an entry
Usage:
shared-2fa delete <name>
```

## generate
### generate
```
Generate a token for the given entry
Usage:
shared-2fa generate <name>
```

## list
### list
```
List all available entries
Expand Down

0 comments on commit c66ff46

Please sign in to comment.