Skip to content
Ruby implementation of CryptoURI: URN-like namespace for cryptographic objects with Bech32-based encoding
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.rubocop.yml
.ruby-version
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
cryptouri.gemspec

README.md

cryptouri.rb Latest Version Yard Docs Apache 2.0 licensed Build Status Gitter Chat

Ruby implementation of CryptoURI: a URN-like namespace for representing cryptographic objects including keys, signatures, and digests:

crypto:public:key:ed25519:6adfsqvzky9t042tlmfujeq88g8wzuhnm2nzxfd0qgdx3ac82ydq3pkr2c

The "dasherized" syntax provides a URI-safe alternative:

crypto-public-key-ed25519-6adfsqvzky9t042tlmfujeq88g8wzuhnm2nzxfd0qgdx3ac82ydqc3p98e

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.

Help and Discussion

Have questions? Want to suggest a feature or change?

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-rb

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 licensed as noted below, without any additional terms or conditions.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.