CryptoURI.rs

[]gitter-link

A URI-like format for serializing cryptographic objects including keys, signatures, and digests using URI generic syntax:

crypto:pub:key:ed25519:6adfsqvzky9t042tlmfujeq88g8wzuhnm2nzxfd0qgdx3ac82ydqf03cvv

A URI-safe "dasherized" form is also supported:

crypto-pub-key-ed25519-6adfsqvzky9t042tlmfujeq88g8wzuhnm2nzxfd0qgdx3ac82ydqlu986g

Documentation

About CryptoURI

The CryptoURI format leverages the URI generic syntax defined in RFC 3986 to provide simple and succinct encodings of cryptographic keys, including public keys, private/secret keys, encrypted secret keys with password-based key derivation, digital signatures, key fingerprints, and other digests.

Binary data is serialized using the Bech32 encoding format which is designed to prevent human transcription errors by using an alphabet that eliminates similar-looking characters to avoid transcription errors and adds a checksum across the whole URI to detect these errors when they do happen. CryptoURIs which have been mis-transcribed will fail to decode.

Minimum Supported Rust Version

• Rust 1.39+

Help and Discussion

Have questions? Want to suggest a feature or change?

• Gitter: web-based chat about cryptouri
• Google Group: join via web or email (cryptouri+subscribe@googlegroups.com)

Code of Conduct

We abide by the Contributor Covenant and ask that you do as well.

For more information, please see CODE_OF_CONDUCT.md.

Contributing

Bug reports and pull requests are welcome on GitHub at:

https://github.com/cryptouri/cryptouri-rs

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as noted below, without any additional terms or conditions.

License

The cryptouri Rust crate is dual licensed under your choice of either of:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)