Skip to content

Commit

Permalink
v1.42
Browse files Browse the repository at this point in the history
  • Loading branch information
rpm5099 committed Oct 16, 2024
1 parent e22d7b1 commit 27c9587
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 22 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@

<div align="center">
<h1><img src="images/lock_logo_3d_400.png"/></h1>
<h1><img src="https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/lock_logo_3d_400.png?raw=true"/></h1>
</div>

![image](images/mfa_word_logo.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/mfa_word_logo.png?raw=true)

# **MFAwesome: CLI Multi Factor Authenticaton**

[[_TOC_]]


# Summary

Expand All @@ -25,7 +23,7 @@ Due to the large size of the dependencies required for python's [qreader](https:

# Preview

![image](images/run_cont.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/run_cont.png?raw=true)

# Requirements

Expand Down Expand Up @@ -202,10 +200,10 @@ There are five `mfa` subcommands some of which in turn have additional subcomman
| :exclamation: WARNING |
| ---------------------- |
Showing secrets will subject the to viewing by others as well as terminal output logging. A warning is issued if the config option `keylogprotection: true` is set.
![image](images/run_show_secrets.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/run_show_secrets.png?raw=true)

`mfa -c`: Run and display codes for 90s (or whatever is specified as timeout)
![image](images/run_cont.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/run_cont.png?raw=true)

```
$mfa run -h
Expand Down Expand Up @@ -288,41 +286,41 @@ mfa secrets commands:

`mfa config encrypt`

![image](images/encrypt.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/encrypt.png?raw=true)

`mfa config decrypt`

![image](images/decrypt.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/decrypt.png?raw=true)

`mfa config print`

![image](images/config_print.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/config_print.png?raw=true)

`mfa config debug`

![image](images/config_debug.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/config_debug.png?raw=true)

`mfa hotp`

![image](images/hotp.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/hotp.png?raw=true)

| :exclamation: WARNING |
| ---------------------- |
Running in debug mode can output sensitive information to the terminal and could potentially be logged. A warning is issued if the config option `keylogprotection: true` is set.

`mfa secrets search`

![image](images/search_secrets.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/search_secrets.png?raw=true)

- `--addqrsecrets TEXT`: The required term is the name of the directory containing screenshots/images of QR images from Google Authenticator (or other source) you wish to import to your config

| :exclamation: WARNING |
| ---------------------- |
***MFAwesome makes every attempt to ensure that your secrets are cleared from the screen following execution unless you have explicitly enabled \'\--noclearscreen/-l\', including on keyboard interrupt (SIGINT signal). However, Ctrl+Z (SIGTSTP signal) will stop the processs without leaving python a chance to clear output.***

![image](images/keyboard_interrupt.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/keyboard_interrupt.png?raw=true)

![image](images/finished_codes.png)
![image](https://github.com/rpm5099/mfawesome/blob/e22d7b1387ec9e6492e82327da3c17fd543c585d/images/finished_codes.png?raw=true)

# Running From a Jupyter Notebook

Expand Down
14 changes: 7 additions & 7 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ long_description = file: README.md
long_description_content_type= text/markdown
description_file = README.md

title = "MFAwesome"
description = attr: mfawesome.__description__
version = attr: mfawesome.__version__
url = attr: mfawesome.__url__
build_date = attr: mfawesome.__build_date__
author = attr: mfawesome.__author__
author_email = attr: mfawesome.__author_email__
title = MFAwesome
description = 2FA CLI Authenticator Tool
version = 0.1.42
url = https://github.com/rpm5099/mfawesome
build_date = 2024-10-16
author = Rob Milloy
author_email = [email protected]

[options]
python_requires = >=3.11
Expand Down

0 comments on commit 27c9587

Please sign in to comment.