README.md (2039B)
1 # webauthn-rs-core 2 3 `webauthn-rs-core` is a patched version of [`webauthn-rs-core`](https://crates.io/crates/webauthn-rs-core) that allows 4 the crate to work on OpenBSD-stable in addition to adding Ed25519 support. 5 6 ## Why patch the crate instead of using the `vendored` `feature` in [`openssl`](https://crates.io/crates/openssl)? 7 8 The problem with statically compiling OpenSSL is any security patches are not handled automatically; instead one must know 9 to recompile the crate each time. By relying on the system OpenSSL library, however, any patches that happen through the OS 10 will be applied ensuring a more secure environment. 11 12 ## How to use this crate? 13 14 This crate will hopefully require minimal changes to upstream; as a result, it will not be published to `crates.io`. To use 15 this crate, configure `Cargo.toml` and `.cargo/config.toml` like below: 16 17 ```toml 18 [patch.crates-io] 19 webauthn-rs-core = { git = "https://git.philomathiclife.com/repos/webauthn-rs-core", tag = "v0.4.10" } 20 ``` 21 22 ```toml 23 [net] 24 git-fetch-with-cli = true 25 ``` 26 27 ### Status 28 29 This package will be actively maintained to stay in-sync with the latest versions of OpenBSD-stable and `webauthn-rs-core`; 30 as a result, the crate is only tested on the `x86_64-unknown-openbsd` target. While OpenBSD supports both the most recent 31 -release/-stable release as well as the previous version, only the most recent version will be supported by this 32 library. Note that while the crate is only tested on OpenBSD, it should work on OSes that have an up-to-date installation of 33 LibreSSL. It will also work on OSes with up-to-date installations of OpenSSL 3.x.y; however there is _no_ benefit in using 34 this crate in such an environment. 35 36 Due to philosophical differences and coding differences including but not limited to licensing; adherence to government 37 standards that are not actually cryptographically relevant; and use of OpenSSL 3.x.y, this crate will be abandoned 38 when [`webauthn_rp`](https://docs.rs/webauthn_rp/latest/webauthn_rp/) becomes available.