Skip to content

Commit

Permalink
Revert auto-update script changes to the Makefile and README
Browse files Browse the repository at this point in the history
  • Loading branch information
dwaite committed Jul 22, 2024
1 parent 4984155 commit bea4da0
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 13 deletions.
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
56 changes: 43 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -33,14 +53,24 @@ 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`.

```sh
$ 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).

0 comments on commit bea4da0

Please sign in to comment.