Skip to content
This repository was archived by the owner on Sep 16, 2024. It is now read-only.

Commit e25205b

Browse files
committed
Update README with new apt repo
1 parent b1319ee commit e25205b

File tree

1 file changed

+16
-42
lines changed

1 file changed

+16
-42
lines changed

README.md

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -23,51 +23,25 @@ At a minimum, you must have the following in order to use this repository:
2323

2424
## Install
2525

26-
This repository has been tested with the following setup:
26+
You may want to visit [the
27+
wiki](https://github.com/mgbowen/windows-fido-bridge/wiki/Installing-a-distro-with-OpenSSH-8.3)
28+
that details how to get a Linux distro with a version of OpenSSH that's new
29+
enough to work with windows-fido-bridge.
2730

28-
* Windows 10 version 2004 (>= build 19041)
29-
* Debian 11 (bullseye) running via [Windows Subsystem for Linux (WSL)
30-
2](https://docs.microsoft.com/en-us/windows/wsl/wsl2-install)
31-
* One of the following security keys:
32-
* YubiKey 4
33-
* YubiKey NEO
34-
* YubiKey 5 NFC
31+
### From apt repository
3532

36-
Other execution environments or security keys may work, but have not been
37-
explicitly tested.
38-
39-
### Install Debian bullseye
40-
41-
Debian 10, the current release available in the Microsoft Store, does not have a
42-
version of OpenSSH that's new enough to support FIDO keys. To get a version that
43-
is new enough, you need to upgrade your base system to Debian 11 (bullseye).
44-
45-
To do that, install Debian from the Microsoft Store, then run the following
46-
commands to upgrade your installation to bullseye:
33+
The recommended method of installing windows-fido-bridge is to use its apt
34+
repository at [apt.mgbowen.dev](https://apt.mgbowen.dev). Go to that link and
35+
follow its instructions to set up access to the repository for your operating
36+
system, then run the following:
4737

4838
```
49-
sudo mv /etc/apt/sources.list /etc/apt/sources.list.orig
50-
cat << EOF | sudo tee /etc/apt/sources.list > /dev/null
51-
deb http://deb.debian.org/debian bullseye main
52-
deb http://security.debian.org/debian-security bullseye-security main
53-
EOF
54-
55-
sudo apt update
56-
sudo apt upgrade
57-
sudo apt full-upgrade
58-
sudo apt autoremove --purge
39+
sudo apt install windows-fido-bridge
5940
```
6041

61-
Pulling openssh-client from sid was previously needed, but the package has since
62-
moved directly into bullseye. You can remove the changes you had made with the
63-
following commands:
64-
65-
```
66-
sudo rm /etc/apt/sources.list.d/sid.list /etc/apt/preferences.d/{sid,openssh-client}.pref
67-
sudo apt update
68-
```
42+
### From source
6943

70-
### Build from source
44+
You can also build this repository from source:
7145

7246
```
7347
sudo apt install build-essential cmake g++-mingw-w64-x86-64 git
@@ -105,7 +79,7 @@ To do that, you need to tell OpenSSH what middleware library to use. If you used
10579
the installation instructions above, you can use the following command:
10680

10781
```
108-
SSH_SK_PROVIDER=/usr/local/lib/libwindowsfidobridge.so ssh-keygen -t ecdsa-sk
82+
SSH_SK_PROVIDER=libwindowsfidobridge.so ssh-keygen -t ecdsa-sk
10983
```
11084

11185
If everything goes well, you should see a Windows dialog pop up asking you to
@@ -115,7 +89,7 @@ to your remote server's `.ssh/authorized_keys` file, you can then authenticate
11589
using the following command:
11690

11791
```
118-
ssh -oSecurityKeyProvider=/usr/local/lib/libwindowsfidobridge.so remote-server
92+
ssh -oSecurityKeyProvider=libwindowsfidobridge.so remote-server
11993
```
12094

12195
You should now be logged in to your remote server!
@@ -131,11 +105,11 @@ before calling `ssh-add`. Note that you **must** specify the full path to the
131105
library when passing it to `ssh-add` for `ssh-agent` to accept it. For example:
132106

133107
```
134-
ssh-add -S /usr/local/lib/libwindowsfidobridge.so
108+
ssh-add -S /usr/lib/libwindowsfidobridge.so
135109
136110
# or
137111
138-
SSH_SK_PROVIDER=/usr/local/lib/libwindowsfidobridge.so ssh-add
112+
SSH_SK_PROVIDER=/usr/lib/libwindowsfidobridge.so ssh-add
139113
```
140114

141115
You may also completely omit the explicit library specification if you place the

0 commit comments

Comments
 (0)