jose.1.adoc 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. jose(1)
  2. =======
  3. :doctype: manpage
  4. == NAME
  5. jose - Toolkit for performing JSON Object Signing and Encryption
  6. == SYNOPSIS
  7. *jose alg* [-k KIND]
  8. *jose b64 dec* -i B64 [-O BIN]
  9. *jose b64 enc* -I BIN [-o B64]
  10. *jose jwe dec* -i JWE [-I CT] -k JWK [-p] [-O PT]
  11. *jose jwe enc* [-i JWE] -I PT -k JWK [-p] [-r RCP] [-o JWE] [-O CT] [-c]
  12. *jose jwe fmt* -i JWE [-I CT] [-o JWE] [-O CT] [-c]
  13. *jose jwk exc* [-i JWK] -l JWK -r JWK [-o JWK]
  14. *jose jwk gen* -i JWK [-o JWK]
  15. *jose jwk pub* -i JWK [-o JWK]
  16. *jose jwk thp* -i JWK [-a ALG] [-o THP]
  17. *jose jwk use* -i JWK [-a] [-r] -u OP
  18. *jose jws fmt* -i JWS [-I PAY] [-o JWS] [-O PAY] [-c]
  19. *jose jws sig* [-i JWS] [-I PAY] [-s SIG] -k JWK [-o JWS] [-O PAY] [-c]
  20. *jose jws ver* -i JWS [-I PAY] -k JWK [-O PAY] [-a]
  21. == OVERVIEW
  22. José is a C-language implementation of the Javascript Object Signing and
  23. Encryption standards. Specifically, José aims towards implementing the
  24. following standards:
  25. * RFC 7515 - JSON Web Signature (JWS)
  26. * RFC 7516 - JSON Web Encryption (JWE)
  27. * RFC 7517 - JSON Web Key (JWK)
  28. * RFC 7518 - JSON Web Algorithms (JWA)
  29. * RFC 7519 - JSON Web Token (JWT)
  30. * RFC 7520 - Examples of Protecting Content Using JOSE
  31. * RFC 7638 - JSON Web Key (JWK) Thumbprint
  32. The José command line utility provides facilities for the following:
  33. * URL-safe Base64 Encoding & Decoding
  34. * Key Generation and Management
  35. * Encryption & Decryption
  36. * Signing & Verification
  37. == AUTHOR
  38. Nathaniel McCallum <npmccallum@redhat.com>
  39. == SEE ALSO
  40. link:jose-alg.1.adoc[*jose-alg*(1)],
  41. link:jose-b64-dec.1.adoc[*jose-b64-dec*(1)],
  42. link:jose-b64-enc.1.adoc[*jose-b64-enc*(1)],
  43. link:jose-jwe-dec.1.adoc[*jose-jwe-dec*(1)],
  44. link:jose-jwe-enc.1.adoc[*jose-jwe-enc*(1)],
  45. link:jose-jwe-fmt.1.adoc[*jose-jwe-fmt*(1)],
  46. link:jose-jwk-exc.1.adoc[*jose-jwk-exc*(1)],
  47. link:jose-jwk-gen.1.adoc[*jose-jwk-gen*(1)],
  48. link:jose-jwk-pub.1.adoc[*jose-jwk-pub*(1)],
  49. link:jose-jwk-thp.1.adoc[*jose-jwk-thp*(1)],
  50. link:jose-jwk-use.1.adoc[*jose-jwk-use*(1)],
  51. link:jose-jws-fmt.1.adoc[*jose-jws-fmt*(1)],
  52. link:jose-jws-sig.1.adoc[*jose-jws-sig*(1)],
  53. link:jose-jws-ver.1.adoc[*jose-jws-ver*(1)]