simono41/steamguard-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
502 commits 1 branch 76 tags 887 KiB
Rust 78.9%
HTML 18.5%
Shell 2.6%
Find a file
Carson McManus 8366173eb1 fix a couple of lints
2022-12-06 10:07:25 -05:00
.github update badges 2022-02-04 12:29:55 -05:00
.vscode add vscode debug launchers 2021-08-08 11:08:33 -04:00
scripts actually fix architecture field on deb package 2022-12-05 12:07:39 -05:00
src fix a couple of lints 2022-12-06 10:07:25 -05:00
steamguard fix a couple of lints 2022-12-06 10:07:25 -05:00
.gitignore add check-aur.sh to check if the aur package works 2022-01-15 11:40:25 -05:00
Cargo.lock Release steamguard v0.7.0, steamguard-cli v0.7.0, safety bump steamguard-cli v0.7.0 2022-12-05 11:58:57 -05:00
Cargo.toml Release steamguard v0.7.0, steamguard-cli v0.7.0, safety bump steamguard-cli v0.7.0 2022-12-05 11:58:57 -05:00
LICENSE licensing and stuff 2021-08-25 08:36:02 -04:00
PKGBUILD Fix pkgver, always use version for steamguard-cli 2022-02-02 16:34:01 +01:00
README.md add the ability to generate a QR code for 2fa secrets 2022-12-05 08:47:33 -05:00
rustfmt.toml add rustfmt.toml and run cargo fmt 2021-08-08 12:54:46 -04:00

README.md

steamguard-cli

Lint, Build, Test AUR Tester

A command line utility for setting up and using Steam Mobile Authenticator (AKA Steam 2FA). It can also be used to respond to trade and market confirmations.

The only legitimate place to download steamguard-cli binaries is through this repo's releases, or by any package manager that is linked in this document.

Disclaimer

This utility is effectively in beta. Use this software at your own risk. Make sure to back up your maFiles regularly, and make sure to actually write down your revocation code. If you lose both of these, we can't help you, your only recourse is to beg Steam support.

Install

If you have the Rust toolchain installed:

cargo install steamguard-cli

Arch-based systems can install from the AUR:

  • For steamguard-cli-git
  • Non-git release is not officially provided. Please open an issue if you would like to help set that up.

Otherwise, you can download binaries from the releases.

Building From Source

cargo build --release

Usage

steamguard-cli looks for your maFiles/manifest.json in at these paths, in this order:

  • ~/.config/steamguard-cli/maFiles/
  • ~/maFiles/

Your maFiles can be created with or imported from Steam Desktop Authenticator. You can create maFiles with steamguard-cli using the setup action (steamguard setup).

REMEMBER TO MAKE BACKUPS OF YOUR maFiles, AND TO WRITE DOWN YOUR RECOVERY CODE!

Full helptext can be displayed with:

steamguard --help

One Liners

Generate and copy a new code to clipboard:

steamguard-cli | xclip -selection clipboard

Importing 2FA Secret Into Other Applications

It's possible to import your 2FA secret into other applications. This is useful if you want to use a password manager to generate your 2FA codes, like KeeWeb.

To make this easy, steamguard-cli can generate a QR code for your 2FA secret. You can then scan this QR code with your password manager.

steamguard qr # print QR code for the first account in your maFiles
steamguard -u <account name> qr # print QR code for a specific account

There are some applications that do not generate correct 2fa codes from the secret, so do not use them:

  • Google Authenticator
  • Authy

Contributing

By contributing code to this project, you give me and any future maintainers a non-exclusive transferable license to use that code for this project, including permission to modify, redistribute, and relicense it.

License

steamguard-cli, the command line program is licensed under GPLv3.

steamguard, the library that is used by steamguard-cli is dual licensed under MIT or Apache 2.0, at your option.

Used By