JOSE icon indicating copy to clipboard operation
JOSE copied to clipboard

Initial Release Outline

Open tgross35 opened this issue 2 years ago • 3 comments

This is a quick outline of what I think is blocking for each crate's release:

Questions for all crates:

  • [ ] #18

Blockers for specific crates:

  • [ ] jose-b64:
    • [ ] Documentation updates (#19)
    • [ ] Needs unit tests
    • [ ] Needs example on serde usage, and mention about how to use it as streaming (I'm having some trouble figuring these out)
  • [ ] jose-jwa:
    • [ ] Documentation updates (#20)
    • [ ] Possible change in #26?
  • [ ] jose-jwe: Not yet started
  • [ ] jose-jwk: Mostly ready to go
    • [ ] Documentation updates (#21)
    • [ ] RSA update
  • [ ] jose-jws: Most work completed
    • [ ] Documentation updates (#23)
    • [ ] Examples of creating then validating a signed JWS
    • [ ] What should the relationship be with jose-jwt? (same question for jwe-jwt) https://github.com/RustCrypto/JOSE/issues/26
    • [ ] Requires unit tests
    • [ ] Needs compact format support (#22)
    • [ ] RSA update (transitive via jose-jwk)
  • [ ] jose-jwt: Not yet started
  • [ ] jose:
    • [ ] Need to work with crate owner
    • [ ] probably want to wait on all other crates to architect this one

The RSA dependency was mentioned by @tarcieri, any crates that need it shouldn't be released until the next version of the rsa crate is ready (soon)

tgross35 avatar Apr 16 '23 10:04 tgross35

@tarcieri feel free to edit this as you see fit, I just kind of wanted to collect what I think the status of the different crates are

tgross35 avatar Apr 16 '23 20:04 tgross35

Looks good so far

tarcieri avatar Apr 16 '23 21:04 tarcieri

I published v0.1.0 releases of the following crates largely as-is:

  • jose-b64
  • jose-alg
  • jose-jwk
  • jose-jws

We didn't quite tick all of your checkboxes and I think this is still a good list to keep for other reasons as work items.

If you need breaking changes of any of them, no worries, we can publish v0.2.

tarcieri avatar May 21 '23 02:05 tarcieri