backup_yubikey

https://github.com/shadowarrior7/backup_yubikey

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary

Last synced: 9 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: Shadowarrior7
License: apache-2.0
Language: Rust
Default Branch: main
Size: 6.78 MB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Created almost 2 years ago · Last pushed almost 2 years ago

Metadata Files

Readme Contributing License Citation Security

OpenSK

This repository contains a Rust implementation of a FIDO2 security key. Security keys are external devices that can be used for signing in on websites. You can see OpenSK in action in this video on YouTube!

We intend to bring a full open source experience to security keys, from application to operating system. You can even 3D print your own open source enclosure!

OpenSK Enclosure

You can run OpenSK as a Tock OS application, or use the library to bring OpenSK to your own hardware.

You are viewing the CTAP 2.1 version. This branch fixes bugs, but doesn't implement new features. If you want to contribute, go to the develop branch.

FIDO2

OpenSK's version that implemented CTAP 2.0 was certified by the FIDO Alliance.

This branch implements version 2.1 of the CTAP specification. This branch is not FIDO certified. OpenSK supports U2F, and non-discoverable credentials created with either protocol are compatible with the other.

:warning: Disclaimer

This project is proof-of-concept and a research platform. It is NOT meant for a daily usage. This branch is under development, and therefore less rigorously tested than the numbered branches.

We're still in the process of integrating the ARM® CryptoCell-310 embedded in the Nordic nRF52840 chip to enable hardware-accelerated cryptography. In the meantime, there are 2 options for cryptography implementations:

Our own placeholder implementation. The code is research quality and doesn't provide constant-time guarantees.
The RustCrypto interface. Deploy with --rust-crypto. Note that our own ECC implementation is faster and has smaller binary size, so not all boards support RustCrypto yet.

Hardware

You will need one the following supported boards:

Nordic nRF52840-DK development kit. This board is more convenient for development and debug scenarios as the JTAG probe is already on the board.
Nordic nRF52840 Dongle to have a more practical form factor.
Makerdiary nRF52840-MDK USB dongle.
Feitian OpenSK dongle.

Installation

To install OpenSK, 1. follow the general setup steps, 1. then continue with the instructions for your specific hardware: * Nordic nRF52840-DK * Nordic nRF52840 Dongle * Makerdiary nRF52840-MDK USB dongle * Feitian OpenSK dongle

To test whether the installation was successful, visit a demo website and try to register and login. Please check our Troubleshooting and Debugging section if you have problems with the installation process or during development. To find out what else you can do with your OpenSK, see Customization.

Research

We implemented post-quantum cryptography on OpenSK. The code is released under the hybrid-pqc tag. Our paper was published in the ACNS Secure Cryptographic Implementation workshop 2023 and won the best paper award.

Bibtex reference

``` @InProceedings{Ghinea2023hybrid, author= {Diana Ghinea and Fabian Kaczmarczyck and Jennifer Pullman and Julien Cretin and Rafael Misoczki and Stefan Kölbl and Luca Invernizzi and Elie Bursztein and Jean-Michel Picod}, title= {{Hybrid Post-Quantum Signatures in Hardware Security Keys}}, booktitle= {{4th ACNS Workshop on Secure Cryptographic Implementation, Kyoto, Japan}}, month= {June}, year= {2023}, } ```

Contributing

See Contributing.md.

Reporting a Vulnerability

See SECURITY.md.

Owner

Name: Brennan Duncan
Login: Shadowarrior7
Kind: user

Repositories: 1
Profile: https://github.com/Shadowarrior7

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
repository-code: "https://github.com/google/OpenSK"
license: "Apache-2.0"
preferred-citation:
  type: article
  authors:
  - family-names: "Ghinea"
    given-names: "Diana"
  - family-names: "Kaczmarczyck"
    given-names: "Fabian"
  - family-names: "Pullman"
    given-names: "Jennifer"
  - family-names: "Cretin"
    given-names: "Julien"
  - family-names: "Kölbl"
    given-names: "Stefan"
  - family-names: "Invernizzi"
    given-names: "Luca"
  - family-names: "Bursztein"
    given-names: "Elie"
  - family-names: "Picod"
    given-names: "Jean-Michel"
  title: "Hybrid Post-Quantum Signatures in Hardware Security Keys"
  journal: "4th ACNS Workshop on Secure Cryptographic Implementation"
  year: 2023
  month: 6

GitHub Events

Total

Last Year

Dependencies

.github/workflows/cargo_audit.yml actions

actions-rs/audit-check v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite

.github/workflows/cargo_bloat.yml actions

actions-rs/cargo v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite

.github/workflows/ci.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite

.github/workflows/cifuzz.yml actions

actions/upload-artifact v1 composite
google/oss-fuzz/infra/cifuzz/actions/build_fuzzers master composite
google/oss-fuzz/infra/cifuzz/actions/run_fuzzers master composite

.github/workflows/coveralls.yml actions

actions-rs/cargo v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite
coverallsapp/github-action 1.1.3 composite

.github/workflows/mdlint.yml actions

actions/checkout v2 composite
nosborn/github-action-markdown-cli v1.1.1 composite

.github/workflows/reproducible.yml actions

actions/checkout v4 composite
actions/setup-python v5 composite
actions/upload-artifact v1 composite

Cargo.lock cargo

112 dependencies

Cargo.toml cargo

enum-iterator 0.6.0 development
arrayref 0.3.6
byteorder 1
ed25519-compact 1
rand_core 0.6.4

boards/nordic/nrf52840_dongle_dfu/Cargo.toml cargo

boards/nordic/nrf52840_dongle_opensk/Cargo.toml cargo

boards/nordic/nrf52840_mdk_dfu/Cargo.toml cargo

boards/nordic/nrf52840dk_opensk/Cargo.toml cargo

boards/nordic/nrf52840dk_opensk_a/Cargo.toml cargo

boards/nordic/nrf52840dk_opensk_b/Cargo.toml cargo

bootloader/Cargo.lock cargo

aligned 0.3.5
as-slice 0.1.5
bare-metal 0.2.5
bitfield 0.13.2
byteorder 1.5.0
cortex-m 0.6.7
cortex-m 0.7.7
cortex-m-rt 0.7.3
cortex-m-rt-macros 0.7.0
embedded-hal 0.2.7
generic-array 0.12.4
generic-array 0.13.3
generic-array 0.14.7
nb 0.1.3
nb 1.1.0
panic-abort 0.3.2
proc-macro2 1.0.69
quote 1.0.33
rtt-target 0.3.1
rustc_version 0.2.3
semver 0.9.0
semver-parser 0.7.0
stable_deref_trait 1.2.0
syn 1.0.109
tock-registers 0.7.0
typenum 1.17.0
ufmt-write 0.1.0
unicode-ident 1.0.12
vcell 0.1.3
version_check 0.9.4
void 1.0.2
volatile-register 0.2.2

bootloader/Cargo.toml cargo

libraries/cbor/Cargo.toml cargo

libraries/cbor/fuzz/Cargo.toml cargo

libraries/crypto/Cargo.toml cargo

libraries/opensk/Cargo.toml cargo

enum-iterator 0.6.0 development
aes 0.8.2
arbitrary 0.4.7
arrayref 0.3.6
byteorder 1
cbc 0.1.2
ed25519-compact 1
hkdf 0.12.3
hmac 0.12.1
p256 0.13.0
rand 0.8.5
rand_core 0.6.4
sha2 0.10.6
subtle 2.2
zeroize 1.5.7

libraries/opensk/fuzz/Cargo.toml cargo

libraries/opensk/fuzz/fuzz_helper/Cargo.toml cargo

libraries/persistent_store/Cargo.toml cargo

tempfile 3 development

libraries/persistent_store/fuzz/Cargo.toml cargo

third_party/lang-items/Cargo.toml cargo

third_party/libtock-drivers/Cargo.toml cargo

tools/heapviz/Cargo.lock cargo

aho-corasick 1.1.2
ansi_term 0.12.1
atty 0.2.14
bitflags 1.3.2
cc 1.0.83
clap 2.34.0
hermit-abi 0.1.19
lazy_static 1.4.0
libc 0.2.150
memchr 2.6.4
ncurses 5.101.0
pkg-config 0.3.27
regex 1.10.2
regex-automata 0.4.3
regex-syntax 0.8.2
strsim 0.8.0
textwrap 0.11.0
unicode-width 0.1.11
vec_map 0.8.2
winapi 0.3.9
winapi-i686-pc-windows-gnu 0.4.0
winapi-x86_64-pc-windows-gnu 0.4.0

tools/heapviz/Cargo.toml cargo

requirements.txt pypi

colorama *
cryptography *
fido2 >=1.0.0
hid *
intelhex *
pylint *
six *
tockloader ==1.5
tqdm *
yapf *

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science