simono41/steamguard-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
327 commits 1 branch 76 tags 887 KiB
Rust 78.9%
HTML 18.5%
Shell 2.6%
Find a file
Carson McManus f656dc4853
Merge pull request #96 from dyc3/release 
Update lots of things to prepare for release
2021-08-25 10:30:58 -04:00
.github update package metadata and stuff 2021-08-25 00:26:07 -04:00
.vscode add vscode debug launchers 2021-08-08 11:08:33 -04:00
scripts rename package-deb.sh 2021-08-25 10:20:47 -04:00
src cargo fmt 2021-08-25 09:09:02 -04:00
SteamAuth@e0619528fb update steamauth 2020-10-12 12:35:31 -04:00
steamguard remove the need for nightly toolchain 2021-08-25 10:26:34 -04:00
.gitignore add working 2fa code generation 2021-03-21 23:00:16 -04:00
.gitmodules update .gitmodules to custom SteamAuth, fix #31 2018-04-11 21:18:12 -04:00
AssemblyInfo.cs Update version 2020-10-12 23:05:43 +00:00
bash-tab-completion add --passkey to bash tab completion 2017-05-22 18:34:56 -04:00
Cargo.lock update package metadata and stuff 2021-08-25 00:26:07 -04:00
Cargo.toml remove the need for nightly toolchain 2021-08-25 10:26:34 -04:00
LICENSE licensing and stuff 2021-08-25 08:36:02 -04:00
makefile Fix build issues 2021-05-23 21:25:56 +00:00
makefile.macos Add macOS support documentation 2020-01-27 17:43:25 -04:00
Manifest.cs fix some logging stuff so it's easier to read 2018-03-27 19:17:51 -04:00
Program.cs handle MustConfirmEmail, fixes #41 2020-10-12 13:12:11 -04:00
README.md remove the need for nightly toolchain 2021-08-25 10:26:34 -04:00
rustfmt.toml add rustfmt.toml and run cargo fmt 2021-08-08 12:54:46 -04:00
steamguard-cli.csproj Added --trade to list all trade confirmations 2016-08-25 22:21:12 -04:00
steamguard-cli.sln added .csproj and .sln files 2016-08-23 11:40:51 -04:00
Utils.cs add Utils.Verbose for easy verbose-only Console.WriteLine 2018-03-27 17:48:22 -04:00

README.md

steamguard-cli

Rust

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 legitamate 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

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

Importing 2FA Secret Into Other Applications

It's possible to import your 2FA secret into other applications, like Google Authenticator or KeeWeb. The uri field contains a URI in that starts with otpauth://..., which you can create a QR code for.

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.