shimun/solo
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

add readme

Browse Source
This commit is contained in:
Conor Patrick 2018-04-28 14:15:41 -04:00
parent 28c9fd644f
commit 27aaadff86
1 changed files with 75 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md Normal file
View File

@ -0,0 +1,75 @@
# U2F One
This project is in early development.
It will be a embedded device friendly implementation of FIDO 2.0 and U2F protocols.
No hardware is needed for development.
# Setting up
Clone and Compile CBOR library and FIDO 2 client library.
```bash
git clone https://github.com/conorpp/u2f-one
cd u2f-one/
git submodule update --init
cd tinycbor && make
cd ..
cd python-fido2/
python setup.py install
```
Now compile FIDO 2.0 and U2F authenticator.
```bash
make
```
# Testing and development
The application is set up to send and recv USB HID messages over UDP to ease
development and reduce need for hardware.
Testing can be done using Yubico's client software. Note that the client
software is also a work in progress and the [FIDO 2.0
specification](https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html)
is ultimate. Some small changes to Yubico's Client software make it send
USB HID over UDP to the authenticator application.
Run FIDO 2 / U2F application.
```bash
./main
```
Run client software.
```
python python-fido2/examples/credential.py
```
You should see messages exchange between the client and the authenticator but that's it. Follow specifications to develop further.
[https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html](https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html)
# Contributors
Contributors are welcome. The ultimate goal is to have a FIDO 2 hardware token
capable of USB, Bluetooth, and NFC interfaces. There could be multiple tokens
for each interface. [Hardware is still being decided
on](https://github.com/conorpp/u2f-zero/issues/76).
This is an upgrade to [U2F
Zero](https://github.com/conorpp/u2f-zero). A lot of the hardware and software
will be different so I think it's best to start a new repository.