This project provides a Node reference implementation of the Lite profile of the U-Prove Specification 1.1 (Revision 5). The U-Prove technology enables the creation of unlinkable credentials which can encode attributes of any types, supporting selective subset disclosure; see the U-Prove Technology Overview for more details. The Lite profile of the specification simplifies the implementation by limiting the feature set; namely it does not support:
- Device binding
- Scope-exclusive pseudonyms
- Presenting committed attributes
The project also implements the U-Prove JSON Framework (UPJF), describing a deployment model and JSON serialization for the U-Prove artifacts.
Make sure node.js and npm are installed on your system; the latest Long-Term Support (LTS) version is recommended for both.
- Get the source, for example using
git
git clone -b main https://github.com/microsoft/uprove-node-reference.git
cd uprove-node-reference
- Build the
npmpackage
npm install
npm run build
- Optionally, run the unit tests
npm test
- Optionally, run the samples program
npm run samples
Additionally, the samples/upjf folder contains its own npm project demonstrating a sample 3-party system using the U-Prove JSON Framework; see its README for details.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.