From 74a29eddb22acba6d303ff5e138378c2e9647913 Mon Sep 17 00:00:00 2001 From: Randall Date: Tue, 12 Jul 2022 06:19:08 -0400 Subject: [PATCH] sshyp-mfa - added manpage --- sshyp-mfa/extra/manpage | 44 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100755 sshyp-mfa/extra/manpage diff --git a/sshyp-mfa/extra/manpage b/sshyp-mfa/extra/manpage new file mode 100755 index 0000000..eb8db56 --- /dev/null +++ b/sshyp-mfa/extra/manpage @@ -0,0 +1,44 @@ +.TH sshyp-mfa 1 "12 July 2022" "rolling" "sshyp-mfa man page" +.SH NAME +sshyp-mfa \- An MFA (TOTP/Steam) key generator for the sshyp password manager. +.SH SYNOPSIS +sshyp-mfa [/] +.SH DESCRIPTION +sshyp-mfa is an extension for the sshyp password manager that reads MFA data from sshyp entries and generates generic TOTP and Steam keys. +.SH EXAMPLES +Viewing the entry database: + sshyp-mfa + +Generating and copying an MFA key for an existing entry saved as ~/.local/share/sshyp-mfa/development/github.gpg + sshyp-mfa /development/github + +.SH SETUP +sshyp-mfa requires a pre-existing functional sshyp setup. + +MFA keys are generated off of MFA data placed in the second line of a sshyp entry's notes field. This data needs to be added manually, through sshyp, and must be in Authenticator backup format. + +It might be easiest to import all of your MFA keys into Authenticator, export them into plain text, then add all of the exported MFA data into the second notes line in their respective sshyp entries. +.SH FORMAT +Format: otpauth:///?secret=&issuer=&algorithm=&digits=&period= + +Help! What do I put in each of those spaces? + + is almost always 'totp', but in the case of Steam, it needs to be set to 'steam'. + + is a part of the Authenticator backup format, but it is not used in sshyp-mfa. Set to anything. + + refers to the secret used to generate your MFA key. This is usually directly provided by the issuer, but it is sometimes hidden and more easily retrieved by copying it from a QR-compatible MFA app (such as Aegis). + + is a part of the Authenticator backup format, but it is not used in sshyp-mfa. Set to anything. + + refers to the algorithm used to generate your MFA key based on your secret. This is almost always 'sha1'. + + refers to the intended length of your MFA key. This is almost always '6', but in the case of Steam, it needs to be set to '5'. + + refers to the interval at which a new MFA key needs to be generated. This is almost always '30', for 30 seconds. + +Example configuration (for most services, see above for differences regarding Steam): + +otpauth://totp/MyNameIsBob?secret=YUGBSG65SG9SDBSDF56SBFVSC86SBVD6&issuer=Github&algorithm=sha1&digits=6&period=30 +.SH AUTHOR +Randall Winkhart (https://github.com/rwinkhart)