From bea4da013d05deaccf59a960eee9528a95c427b0 Mon Sep 17 00:00:00 2001 From: David Waite Date: Mon, 22 Jul 2024 04:14:43 -0600 Subject: [PATCH] Revert auto-update script changes to the Makefile and README --- Makefile | 16 ++++++++++++++++ README.md | 56 ++++++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 59 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index de46d56..cb8cfdd 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,19 @@ +SUBDIRS = fixtures LIBDIR := lib include $(LIBDIR)/main.mk +.PHONY: $(SUBDIRS) +fixtures: + @cd fixtures; node --no-warnings nonce.mjs + @cd fixtures; node --no-warnings bbs-keygen.mjs; node --no-warnings bbs-fixtures.mjs + @cd fixtures; node --no-warnings es256-keygen.mjs issuer; \ + node --no-warnings es256-keygen.mjs holder; \ + node --no-warnings es256-keygen.mjs ephemeral; \ + node --no-warnings su-es256-fixtures.mjs + @cd fixtures; node --no-warnings mac-h256-secret-gen.mjs; node --no-warnings mac-h256-fixtures.mjs + +$(drafts_xml): fixtures + $(LIBDIR)/main.mk: ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null)) git submodule sync @@ -9,3 +22,6 @@ else git clone -q --depth 10 $(CLONE_ARGS) \ -b main https://github.com/martinthomson/i-d-template $(LIBDIR) endif + +clean:: + rm -r fixtures/build diff --git a/README.md b/README.md index b2b3b16..8019547 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,49 @@ -# JOSE Drafts +# JSON Web Proofs -This is the working area for IETF [JOSE Working Group](https://datatracker.ietf.org/wg/jose/documents/) Internet-Drafts. +Specification work for JSON Web Proofs -## JSON Proof Algorithms +The JSON Web Proofs effort aims to establish a new JSON based container as a new entry in the JOSE family of container formats. + +While similar to JSON Web Signatures[^JWS], JSON Web Proofs aim to support newer algorithms and cryptographic techniques. These techniques establish the role of a *prover*, which has limited capabilities to derive new forms of from a signed message which can still be cryptographically verified. + +Examples of capabilities an algorithm may support include: + +1. Selectively disclose a subset of information to the verifier +2. Provide for multiple uses of a proof container without correlation due to cryptography +3. Disclose an answer to a predicate without disclosing the values used for evaluation +4. Proof of possession + +## Specifications in Progress + +### JSON Web Proof + +A new container, similar to JWS[^JWS], which allows for more than one payload. + +* [Editor's Copy](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-web-proof.html) +* [Datatracker Page](https://datatracker.ietf.org/doc/draft-ietf-jose-json-web-proof) +* [Working Group Draft](https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-proof) +* [Compare Editor's Copy to Working Group Draft](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-web-proof.diff) + +### JSON Proof Algorithms + +Required and optional capabilities for algorithms within JSON Web Proofs. + +This is loosely analogous to JWA[^JWA], with concrete algorithms defined as separate specifications. * [Editor's Copy](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-proof-algorithms.html) * [Datatracker Page](https://datatracker.ietf.org/doc/draft-ietf-jose-json-proof-algorithms) * [Working Group Draft](https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-proof-algorithms) * [Compare Editor's Copy to Working Group Draft](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-proof-algorithms.diff) -## JSON Proof Token +### JSON Proof Token + +An application of JWP for representing claims about an entity, analogous to JWT[^JWT]. * [Editor's Copy](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-proof-token.html) * [Datatracker Page](https://datatracker.ietf.org/doc/draft-ietf-jose-json-proof-token) * [Working Group Draft](https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-proof-token) * [Compare Editor's Copy to Working Group Draft](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-proof-token.diff) -## JSON Web Proof - -* [Editor's Copy](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-web-proof.html) -* [Datatracker Page](https://datatracker.ietf.org/doc/draft-ietf-jose-json-web-proof) -* [Working Group Draft](https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-proof) -* [Compare Editor's Copy to Working Group Draft](https://json-web-proofs.github.io/json-web-proofs/#go.draft-ietf-jose-json-web-proof.diff) - - ## Contributing See the @@ -33,7 +53,7 @@ Contributions can be made by creating pull requests. The GitHub interface supports creating pull requests using the Edit (✏) button. -## Command Line Usage +### Command Line Usage Formatted text and HTML versions of the draft can be built using `make`. @@ -41,6 +61,16 @@ Formatted text and HTML versions of the draft can be built using `make`. $ make ``` +[^JWS]: [JSON Web Signatures - RFC7515](JWS) +[^JWK]: [JSON Web Keys - RFC7517](JWK) +[^JWA]: [JSON Web Algorithms - RFC7518](JWA) +[^JWT]: [JSON Web Token - RFC7519](JWT) + +[JWS]: https://datatracker.ietf.org/doc/html/rfc7515 +[JWK]: https://datatracker.ietf.org/doc/html/rfc7517 +[JWA]: https://datatracker.ietf.org/doc/html/rfc7518 +[JWT]: https://datatracker.ietf.org/doc/html/rfc7519 + Command line usage requires that you have the necessary software installed. See [the instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md).