opensk

OpenSK is an open-source implementation for security keys written in Rust that supports both FIDO U2F and FIDO2 standards.

https://github.com/google/opensk

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
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary

Keywords

ctap2 embedded fido2 firmware hardware opensk rust security security-key tock tock-os u2f webauthn

Last synced: 6 months ago · JSON representation ·

Repository

OpenSK is an open-source implementation for security keys written in Rust that supports both FIDO U2F and FIDO2 standards.

Basic Info

Host: GitHub
Owner: google
License: apache-2.0
Language: Rust
Default Branch: develop
Homepage:
Size: 7.14 MB

Statistics

Stars: 3,183
Watchers: 88
Forks: 310
Open Issues: 32
Releases: 1

Topics

ctap2 embedded fido2 firmware hardware opensk rust security security-key tock tock-os u2f webauthn

Created about 6 years ago · Last pushed 7 months 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 Wasefire applet,
as a Tock OS application, or
as a library.

You are viewing the branch for developers. New features are developed here. Go to the default branch for a more stable version of OpenSK.

FIDO2

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

The develop branch tracks the latest release version 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 is not an officially supported Google product.

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, we use RustCrypto.

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: Google
Login: google
Kind: organization
Email: opensource@google.com
Location: United States of America

Website: https://opensource.google/
Twitter: GoogleOSS
Repositories: 2,773
Profile: https://github.com/google

Google ❤️ Open Source

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

Issues event: 18
Watch event: 183
Delete event: 1
Issue comment event: 56
Push event: 17
Pull request review comment event: 28
Pull request review event: 59
Pull request event: 35
Fork event: 19

Last Year

Issues event: 18
Watch event: 183
Delete event: 1
Issue comment event: 56
Push event: 17
Pull request review comment event: 28
Pull request review event: 59
Pull request event: 35
Fork event: 19

Committers

Last synced: 6 months ago

All Time

Total Commits: 990
Total Committers: 25
Avg Commits per committer: 39.6
Development Distribution Score (DDS): 0.699

Past Year

Commits: 30
Committers: 3
Avg Commits per committer: 10.0
Development Distribution Score (DDS): 0.1

Top Committers

Name	Email	Commits
kaczmarczyck	4****k	298
Julien Cretin	c**n@g**m	227
Jean-Michel Picod	j**l@g**m	157
Guillaume Endignoux	g**e@g**m	122
Kamran Khan	k**n@g**m	33
Mirna	m**y@g**m	31
Egor Duda	e**a@g**m	30
mingxguo27	m**o@g**m	28
hcyang	1****e	21
Liam Murphy	l**m@g**m	16
David Drysdale	d**e@g**m	9
Zach Halvorsen	z**n@g**m	3
Mirna	2****8	3
Derry Pratama	d**o@g**m	1
coelner	w**r@g**m	1
Bubun Das	b**7@g**m	1
DavidKorczynski	d**d@a**m	1
Fred Chien(錢逢祥)	c**t@g**m	1
L0g4n	y**z@p**e	1
Roman A	1****n	1
Shiling Wang	9****g	1
foopub	4****b	1
gebo	3****o	1
浅香ジュン	5****A	1
Geoffrey	g**y@f**m	1

Committer Domains (Top 20 + Academic)

google.com: 9 ftsafe.com: 1 posteo.de: 1 adalogics.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 91
Total pull requests: 155
Average time to close issues: 11 months
Average time to close pull requests: 17 days
Total issue authors: 54
Total pull request authors: 20
Average comments per issue: 4.95
Average comments per pull request: 1.3
Merged pull requests: 128
Bot issues: 2
Bot pull requests: 5

Past Year

Issues: 17
Pull requests: 41
Average time to close issues: about 1 month
Average time to close pull requests: 4 days
Issue authors: 15
Pull request authors: 6
Average comments per issue: 1.12
Average comments per pull request: 0.73
Merged pull requests: 29
Bot issues: 1
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

gendx (9)
kaczmarczyck (8)
micolous (6)
L0g4n (5)
ia0 (3)
bunnie (3)
ebursztein (2)
egor-duda (2)
github-actions[bot] (2)
trustkeysolutions (2)
alriceeeee (2)
Samthebest999 (2)
iayanpahwa (2)
Firemanpl (2)
Phizicks (1)

Pull Request Authors

kaczmarczyck (133)
jmichelp (6)
ia0 (5)
dependabot[bot] (5)
hcyang-google (4)
zhalvorsen (3)
Kemalele (2)
GameRoMan (2)
bradjc-veridian (2)
shilingwangggg (2)
L0g4n (2)
at0m-b0mb (2)
ia (2)
bunnie (2)
iayanpahwa (1)

Top Labels

Issue Labels

enhancement (11) bug (11) question (7) tracking (6) documentation (3) wontfix (3) help wanted (1) blocked (1) duplicate (1)

Pull Request Labels

dependencies (9) documentation (4) bug (3) cla: yes (2) rust (2)

Packages

Total packages: 1
Total downloads:
- cargo 69,618 total

Total dependent packages: 4
Total dependent repositories: 13
Total versions: 3
Total maintainers: 3

crates.io: sk-cbor

CBOR parsing library

Homepage: https://github.com/google/OpenSK
Documentation: https://docs.rs/sk-cbor/
License: Apache-2.0
Latest release: 0.1.2
published over 4 years ago

Versions: 3
Dependent Packages: 4
Dependent Repositories: 13
Downloads: 69,618 Total

Rankings

Stargazers count: 2.6%

Forks count: 2.9%

Average: 5.4%

Downloads: 6.9%

Dependent repos count: 7.2%

Dependent packages count: 7.4%

Maintainers (3)

daviddrysdale gendx kaczmarczyck

Last synced: 6 months ago

Dependencies

Cargo.toml cargo

arrayref 0.3.6
byteorder 1
subtle 2.2

libraries/cbor/fuzz/Cargo.toml cargo

libfuzzer-sys 0.3

libraries/crypto/Cargo.toml cargo

arrayref 0.3.6
byteorder 1
hex 0.3.2
rand 0.6.5
regex 1
ring 0.16.11
serde 1.0
serde_json 1.0
subtle 2.2.3
untrusted 0.7.0

libraries/persistent_store/fuzz/Cargo.toml cargo

libfuzzer-sys 0.3
rand_core 0.5
rand_pcg 0.2
strum 0.19

third_party/lang-items/Cargo.toml cargo

linked_list_allocator 0.8.7

tools/heapviz/Cargo.toml cargo

clap ~2.27.*
lazy_static 1.4.0
ncurses 5.99.0
regex 1

.github/workflows/cargo_audit.yml actions

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

.github/workflows/coveralls.yml actions

actions-rs/cargo v1 composite
actions-rs/grcov v0.1.5 composite
actions-rs/toolchain 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-rs/toolchain v1 composite
actions/checkout v2 composite
actions/setup-python v1 composite
actions/upload-artifact v1 composite

Cargo.lock cargo

aho-corasick 0.7.19
arrayref 0.3.6
autocfg 0.1.8
autocfg 1.1.0
bitflags 1.3.2
bumpalo 3.8.0
byteorder 1.4.3
cc 1.0.73
cfg-if 1.0.0
cloudabi 0.0.3
enum-iterator 0.6.0
enum-iterator-derive 0.6.0
fuchsia-cprng 0.1.1
getrandom 0.2.7
hex 0.3.2
itoa 1.0.4
js-sys 0.3.60
libc 0.2.134
linked_list_allocator 0.8.11
log 0.4.17
memchr 2.5.0
once_cell 1.14.0
proc-macro2 1.0.43
quote 1.0.21
rand 0.6.5
rand_chacha 0.1.1
rand_core 0.3.1
rand_core 0.4.2
rand_hc 0.1.0
rand_isaac 0.1.1
rand_jitter 0.1.4
rand_os 0.1.3
rand_pcg 0.1.2
rand_xorshift 0.1.1
rdrand 0.4.0
regex 1.6.0
regex-syntax 0.6.27
ring 0.16.20
ryu 1.0.11
serde 1.0.145
serde_derive 1.0.145
serde_json 1.0.86
spin 0.5.2
subtle 2.4.1
syn 1.0.101
unicode-ident 1.0.5
untrusted 0.7.1
uuid 0.8.2
wasi 0.11.0+wasi-snapshot-preview1
wasm-bindgen 0.2.83
wasm-bindgen-backend 0.2.83
wasm-bindgen-macro 0.2.83
wasm-bindgen-macro-support 0.2.83
wasm-bindgen-shared 0.2.83
web-sys 0.3.60
winapi 0.3.9
winapi-i686-pc-windows-gnu 0.4.0
winapi-x86_64-pc-windows-gnu 0.4.0

tools/heapviz/Cargo.lock cargo

aho-corasick 0.7.19
ansi_term 0.9.0
atty 0.2.14
bitflags 0.9.1
cc 1.0.73
clap 2.27.1
hermit-abi 0.1.19
lazy_static 1.4.0
libc 0.2.134
memchr 2.5.0
ncurses 5.101.0
pkg-config 0.3.25
regex 1.6.0
regex-syntax 0.6.27
strsim 0.6.0
textwrap 0.9.0
unicode-width 0.1.10
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

boards/nordic/nrf52840_dongle_dfu/Cargo.toml cargo

boards/nordic/nrf52840_mdk_dfu/Cargo.toml cargo

libraries/cbor/Cargo.toml cargo

libraries/persistent_store/Cargo.toml cargo

third_party/libtock-drivers/Cargo.toml cargo

.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 v3 composite
actions/setup-python v1 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

boards/nordic/nrf52840_dongle_opensk/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/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

requirements.txt pypi

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

opensk

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

OpenSK

FIDO2

:warning: Disclaimer

Hardware

Installation

Research

Contributing

Reporting a Vulnerability

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

crates.io: sk-cbor

Rankings

Maintainers (3)

Dependencies