Skip to content

Commit 10f1198

Browse files
committed
merged transport article content into overview
1 parent 7c7085d commit 10f1198

File tree

4 files changed

+63
-144
lines changed

4 files changed

+63
-144
lines changed

Yubico.YubiKey/docs/users-manual/yubikey-reference/transports/hidfido.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

Yubico.YubiKey/docs/users-manual/yubikey-reference/transports/hidkeyboard.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

Yubico.YubiKey/docs/users-manual/yubikey-reference/transports/overview.md

Lines changed: 63 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,69 @@ over USB. The HID FIDO interface is enabled when either the U2F or FIDO2 applica
7373
enabled over USB. The CCID (smart card) interface is enabled when the PIV, OATH, or OpenPGP
7474
applications are enabled over USB.
7575

76+
OTP interface output is sent as a series of keystrokes from a virtual HID keyboard. This allows
77+
for OTP to be used in any environment which can accept standard keyboard input.
78+
79+
The FIDO interface has a HID usage page set to `0xF1D0`.
80+
81+
### Linux support
82+
83+
#### HID keyboard
84+
85+
The SDK's HID operations on Linux make use of libudev", and "libc", and "hidraw. Make sure
86+
they are available on the device.
87+
88+
The shared libraries "libudev" and "libc" must in one of the paths the SDK will search
89+
(see the .NET documentation for the `DllImportSearchPath` enum, the SDK uses the value
90+
`SafeDirectories`).
91+
92+
One directory the SDK searches is `/usr/lib`. If the SDK cannot find some needed library,
93+
it will likely be easiest to simply create a symbolic link. For example,
94+
95+
```
96+
$ cd /usr/lib
97+
$ sudo ln -s /usr/lib/x86_64-linux-gnu/libudev.so libudev.so
98+
```
99+
100+
**udev**:
101+
102+
The udev library is part of Linux and will probably already be installed on the device. It
103+
is commonly found in a directory such as
104+
105+
```
106+
/usr/lib/x86_64-linux-gnu/libudev.so
107+
```
108+
109+
If so, there is likely nothing you will need to do. If the SDK cannot find `libudev.so`,
110+
make sure it is on the device (e.g. `$ find /usr -name libudev.so`). If it is, maybe it is
111+
not in a standard location and you need to make a symbolic link.
112+
113+
**libc**:
114+
115+
The SDK expects a libc library named `libc.so.6` to be in the shared library search path.
116+
If it is not, you will likely make a symbolic link in `/usr/lib`.
117+
118+
```
119+
$ cd /usr/lib
120+
$ sudo ln -s /usr/lib/x86_64-linux-gnu/libc.so.6 libc.so.6
121+
```
122+
123+
**hidraw**:
124+
125+
The hidraw library is a driver that provides an interface to USB devices. This driver
126+
should be part of the Linux kernel and there should be nothing you need to do.
127+
128+
#### Smart card
129+
130+
In order to use the SDK to contact a YubiKey on a Linux device, you need to install the
131+
"pcsclite" library. This is an Open Source implementation of PC/SC (personal computers/
132+
smart card), a specification for integrating smart cards into computer environments. If it
133+
is not already installed on your Linux device, you will likely run a command such as
134+
135+
```
136+
$ apt-get install libpcsclite1
137+
```
138+
76139
## NFC
77140

78141
In addition to USB, the YubiKey 5 NFC keys also provide an NFC wireless interface for
@@ -91,9 +154,3 @@ operation will succeed. After a period of inactivity, a YubiKey placed on a desk
91154
may power down to help prevent unintended access to the device. To regain connectivity with
92155
an NFC reader, remove the YubiKey from the reader and reposition it on the reader. Some NFC
93156
readers may power cycle the YubiKey and, in doing so, prevent the device from powering down.
94-
95-
## See also
96-
97-
- [Transport: HID Keyboard (OTP)](xref:YubiKeyTransportHIDKeyboard)
98-
- [Transport: Smart Card (CCID)](xref:YubiKeyTransportSmartCard)
99-
- [Transport: HID FIDO](xref:YubiKeyTransportHIDFIDO)

Yubico.YubiKey/docs/users-manual/yubikey-reference/transports/smartcard.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)