• Stars
    star
    293
  • Rank 141,748 (Top 3 %)
  • Language
    Rust
  • License
    Apache License 2.0
  • Created about 7 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

U2F security token emulator written in Rust

Rust U2F

A software-only Universal 2nd Factor token. Supports Google Chrome and Firefox on Linux. Written in Rust.

This program is basically complete, I am not currently planning to add new features like passwordless login the newer FIDO2 standard supports.

Security

Disclaimer: This is a personal project, I am not a security expert and make no guarantee of security.

Like any U2F authenticator this program provides a degree of protection against phishing and poorly chosen passwords. It does not provide the same level of protection against malware that a hardware authenticator does.

If your machine is compromised by malware, the attacker could steal a copy of the secret keys stored by this authenticator. In this situation you should immediately unregister this authenticator anywhere it is registered in addition to changing the passwords of any potentially compromised accounts. With a hardware authenticator secret keys never leave the device, so in the case of malware you can simply unplug from the infected machine and be confident your accounts are safe from further compromise.

Installation

After installing, test your new virtual U2F device on a site supporting it such as: https://demo.yubico.com/webauthn-technical/registration

Arch

Install the AUR package maintained by @grawity: https://aur.archlinux.org/packages/softu2f/

Then enable and start the installed services:

systemctl --system enable --now softu2f.socket
systemctl --user   enable --now softu2f.service

Fedora

curl -s https://packagecloud.io/install/repositories/danstiner/softu2f/script.rpm.sh | sudo bash
sudo dnf install softu2f
systemctl --system start softu2f.socket
systemctl --user   start softu2f.service

Ubuntu

sudo apt install -y curl
curl -s https://packagecloud.io/install/repositories/danstiner/softu2f/script.deb.sh | sudo bash
sudo apt install -y softu2f
systemctl --system start softu2f.socket
systemctl --user   start softu2f.service

Building

See Dockerfile.debian or Dockerfile.fedora for pre-requisite packages that must be installed.

Then run cd linux && make.

To install run cd linux && make install. The install target uses sudo so you will be prompted for your password.

Bump version

  • Run bumpversion --no-tag patch
  • Update linux/meta-package/debian/changelog and amend the commit
  • Push and manually tag the release
  • Package for all platforms and upload package files

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.