19 releases (4 breaking)

0.5.0 Jul 1, 2024
0.4.0 May 7, 2024
0.3.0 Mar 31, 2024
0.2.4 Dec 23, 2023
0.1.4 Jun 18, 2023

#254 in Magic Beans

Download history 16/week @ 2024-03-24 225/week @ 2024-03-31 161/week @ 2024-04-07 16/week @ 2024-04-14 19/week @ 2024-04-21 19/week @ 2024-04-28 154/week @ 2024-05-05 11/week @ 2024-05-12 72/week @ 2024-05-19 16/week @ 2024-05-26 27/week @ 2024-06-02 168/week @ 2024-06-09 407/week @ 2024-06-16 27/week @ 2024-06-23 210/week @ 2024-06-30 30/week @ 2024-07-07

693 downloads per month
Used in 6 crates

BSD-2-Clause-Patent

29KB
441 lines

Blockchain Commons Uniform Resources ("UR") for Rust

by Wolf McNally


Introduction

Uniform Resources (URs) are URI-encoded CBOR structures developed by Blockchain Commons. This crate is an opinionated wrapper around the ur crate by Dominik Spicher, and is intended primarily for use in higher-level Blockchain Commmons projects like Gordian Envelope.

It is a requirement of the UR specification that the CBOR encoded as URs conform to Gordian dCBOR, which is a deterministic profile of CBOR currently specified in this IETF Internet Draft. The dependency dcbor crate can be used directly for that purpose. This crate provides the traits UREncodable, URDecodable, and URCodable that are built on traits from the dcbor crate such as CBORTaggedEncodable and CBORTaggedDecodable. It is strongly recommended that adopters of URs implement these traits for their types.

This crate does not currenly provide opinionated affordances for multi-part URs using fountain codes, but the dependency ur crate can be used directly for that purpose.

Getting Started

[dependencies]
bc-ur = "0.5.0"

Specification

The primary specification for URs is BCR-2020-005: Uniform Resources and the Swift implementation URKit.

Higher-level Blockchain Commons projects that use this crate include:

Status - Community Review

bc-ur is currently in a community review stage. We would appreciate your consideration and/or testing of the libraries. Obviously, let us know if you find any mistakes or problems. But also let us know if the API meets your needs, if the functionality is easy to use, if the usage of Rust feels properly standardized, and if the library solves any problems you are encountering when doing this kind of coding. Also let us know how it could be improved and what else you'd need for this to be just right for your usage. Comments can be posted to the Gordian Developer Community.

Because this library is still in a community review stage, it should not be used for production tasks until it has had further testing and auditing.

See Blockchain Commons' Development Phases.

Financial Support

bc-ur is a project of Blockchain Commons. We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.

To financially support further development of bc-ur and other projects, please consider becoming a Patron of Blockchain Commons through ongoing monthly patronage as a GitHub Sponsor. You can also support Blockchain Commons with bitcoins at our BTCPay Server.

Contributing

We encourage public contributions through issues and pull requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository require a GPG signed Contributor License Agreement.

Discussions

The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas.

Gordian Developer Community. For standards and open-source developers who want to talk about interoperable wallet specifications, please use the Discussions area of the Gordian Developer Community repo. This is where you talk about Gordian specifications such as Gordian Envelope, bc-shamir, Sharded Secret Key Reconstruction, and bc-ur as well as the larger Gordian Architecture, its Principles of independence, privacy, resilience, and openness, and its macro-architectural ideas such as functional partition (including airgapping, the original name of this community).

Gordian User Community. For users of the Gordian reference apps, including Gordian Coordinator, Gordian Seed Tool, Gordian Server, Gordian Wallet, and SpotBit as well as our whole series of CLI apps. This is a place to talk about bug reports and feature requests as well as to explore how our reference apps embody the Gordian Principles.

Blockchain Commons Discussions. For developers, interns, and patrons of Blockchain Commons, please use the discussions area of the Community repo to talk about general Blockchain Commons issues, the intern program, or topics other than those covered by the Gordian Developer Community or the Gordian User Community.

Other Questions & Problems

As an open-source, open-development community, Blockchain Commons does not have the resources to provide direct support of our projects. Please consider the discussions area as a locale where you might get answers to questions. Alternatively, please use this repository's issues feature. Unfortunately, we can not make any promises on response time.

If your company requires support to use our projects, please feel free to contact us directly about options. We may be able to offer you a contract for support from one of our contributors, or we might be able to point you to another entity who can offer the contractual support that you need.

Credits

The following people directly contributed to this repository. You can add your name here by getting involved. The first step is learning how to contribute from our CONTRIBUTING.md documentation.

Name Role Github Email GPG Fingerprint
Christopher Allen Principal Architect @ChristopherA <ChristopherA@LifeWithAlacrity.com> FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED
Wolf McNally Lead Researcher/Engineer @WolfMcNally <Wolf@WolfMcNally.com> 9436 52EE 3844 1760 C3DC  3536 4B6C 2FCF 8947 80AE

Responsible Disclosure

We want to keep all of our software safe for everyone. If you have discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner. We are unfortunately not able to offer bug bounties at this time.

We do ask that you offer us good faith and use best efforts not to leak information or harm any user, their data, or our developer community. Please give us a reasonable amount of time to fix the issue before you publish it. Do not defraud our users or us in the process of discovery. We promise not to bring legal action against researchers who point out a problem provided they do their best to follow the these guidelines.

Reporting a Vulnerability

Please report suspected security vulnerabilities in private via email to ChristopherA@BlockchainCommons.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.

The following keys may be used to communicate sensitive information to developers:

Name Fingerprint
Christopher Allen FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED

You can import a key by running the following command with that individual’s fingerprint: gpg --recv-keys "<fingerprint>" Ensure that you put quotes around fingerprints that contain spaces.

Dependencies

~3.5MB
~69K SLoC