Skip to content

Commit

Permalink
feat(commands): storage import/export commands (#4545)
Browse files Browse the repository at this point in the history
This adds commands to export and import TOTP configurations and Webauthn devices as YAML.
  • Loading branch information
james-d-elliott committed Dec 23, 2022
1 parent 0130edb commit d7ab3bb
Show file tree
Hide file tree
Showing 73 changed files with 1,661 additions and 572 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -169,23 +169,8 @@ This may be inconvenient for some users who wish to export TOTP keys from Authel
a command specifically for exporting TOTP configurations from the database. These commands require the configuration or
at least a minimal configuration that has the storage backend connection details and the encryption key.

Export in [Key URI Format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format):

```bash
authelia storage user totp export --format uri
```

Export as CSV:

```bash
authelia storage user totp export --format csv
```

Help:

```bash
authelia storage user totp export --help
```
See the [CLI Documentation](../../reference/cli/authelia/authelia_storage_user_totp_export.md) for methods to perform
exports.

[RFC4226]: https://www.rfc-editor.org/rfc/rfc4226.html
[RFC6238]: https://www.rfc-editor.org/rfc/rfc6238.html
4 changes: 2 additions & 2 deletions docs/content/en/reference/cli/authelia/authelia.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ authelia --config /etc/authelia/config/
### Options

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
-h, --help help for authelia
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ authelia access-control --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ authelia access-control check-policy --config config.yml --url https://example.c
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/reference/cli/authelia/authelia_build-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ authelia build-info
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/reference/cli/authelia/authelia_crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto certificate --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto certificate ecdsa --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ authelia crypto certificate ecdsa generate --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ authelia crypto certificate ecdsa request --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto certificate ed25519 --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ authelia crypto certificate ed25519 request --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ authelia crypto certificate ed25519 request --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto certificate rsa --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ authelia crypto certificate rsa generate --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ authelia crypto certificate rsa request --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto hash --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ authelia crypto hash generate --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ authelia crypto hash generate argon2 --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
--no-confirm skip the password confirmation prompt
--password string manually supply the password rather than using the terminal prompt
--random uses a randomly generated password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ authelia crypto hash generate bcrypt --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
--no-confirm skip the password confirmation prompt
--password string manually supply the password rather than using the terminal prompt
--random uses a randomly generated password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ authelia crypto hash generate pbkdf2 --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
--no-confirm skip the password confirmation prompt
--password string manually supply the password rather than using the terminal prompt
--random uses a randomly generated password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ authelia crypto hash generate scrypt --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
--no-confirm skip the password confirmation prompt
--password string manually supply the password rather than using the terminal prompt
--random uses a randomly generated password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ authelia crypto hash generate sha2crypt --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
--no-confirm skip the password confirmation prompt
--password string manually supply the password rather than using the terminal prompt
--random uses a randomly generated password
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ authelia crypto hash validate '$5$rounds=500000$WFjMpdCQxIkbNl0k$M0qZaZoK8Gwdh8C
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ authelia crypto pair --help
### Options inherited from parent commands

```
-c, --config strings configuration files or directories to load (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information: authelia --help authelia filters
-c, --config strings configuration files or directories to load, for more information run 'authelia -h authelia config' (default [configuration.yml])
--config.experimental.filters strings list of filters to apply to all configuration files, for more information run 'authelia -h authelia filters'
```

### SEE ALSO
Expand Down

0 comments on commit d7ab3bb

Please sign in to comment.