simono41/steamguard-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
627 commits 1 branch 76 tags 887 KiB
Rust 78.9%
HTML 18.5%
Shell 2.6%
Find a file
dependabot[bot] e032008fdb
Bump webpki from 0.22.0 to 0.22.1 (#321) 
Bumps [webpki](https://github.com/briansmith/webpki) from 0.22.0 to
0.22.1.
<details>
<summary>Commits</summary>
<ul>
<li>See full diff in <a
href="https://github.com/briansmith/webpki/commits">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=webpki&package-manager=cargo&previous-version=0.22.0&new-version=0.22.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/dyc3/steamguard-cli/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-09-13 10:29:08 -04:00
.github adjust error message for when mobile confirmation fails (#311) 2023-09-04 17:10:30 +00:00
.vscode add some unit tests (#234) 2023-06-26 16:44:14 +00:00
docs fix typo in quickstart 2023-06-24 15:52:36 -04:00
scripts misc fixes for deb packaging (#315) 2023-09-13 14:15:58 +00:00
src remove normalize_comments rustfmt rule (#316) 2023-09-10 21:22:23 +00:00
steamguard Bump steamguard v0.12.1, steamguard-cli v0.12.1 2023-09-13 10:17:20 -04:00
.gitignore add check-aur.sh to check if the aur package works 2022-01-15 11:40:25 -05:00
Cargo.lock Bump webpki from 0.22.0 to 0.22.1 (#321) 2023-09-13 10:29:08 -04:00
Cargo.toml Bump steamguard v0.12.1, steamguard-cli v0.12.1 2023-09-13 10:17:20 -04:00
LICENSE licensing and stuff 2021-08-25 08:36:02 -04:00
PKGBUILD update pkgbuild 2023-06-23 15:41:04 -04:00
README.md update readme 2023-07-07 07:25:00 -04:00
rustfmt.toml remove normalize_comments rustfmt rule (#316) 2023-09-10 21:22:23 +00: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.

Quickstart

If you have no idea what the rest of this document is talking about, go read the quickstart.

Features

  • Generate 2FA codes
  • Respond to trade, market or any other confirmations
  • Encrypted storage of your 2FA secrets
    • With the option to store your encryption passkey in the system keyring
  • Special memory-clearing data structures to prevent leaking secrets
  • QR code generation for importing 2FA secrets into other applications, like KeeWeb
  • QR code logins for quickly logging into Steam on a new device, like the Steam Deck
  • Able to read Steam Desktop Authenticator's maFiles format
  • Uses as many official Steam APIs as possible, unlikely to break

Install

If you have the Rust toolchain installed:

cargo install steamguard-cli

Arch-based systems can install from the AUR:

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:

Linux:

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

Windows:

  • %APPDATA%\Roaming\steamguard-cli\maFiles\
  • %USERPROFILE%\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 | 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