jose.1 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. .\" generated with Ronn/v0.7.3
  2. .\" http://github.com/rtomayko/ronn/tree/0.7.3
  3. .
  4. .TH "JOSE" "1" "May 2017" "" ""
  5. .
  6. .SH "NAME"
  7. \fBjose\fR \- Toolkit for performing JSON Object Signing and Encryption
  8. .
  9. .SH "SYNOPSIS"
  10. \fBjose alg\fR [\-k KIND]
  11. .
  12. .P
  13. \fBjose b64 dec\fR \-i B64 [\-O BIN]
  14. .
  15. .P
  16. \fBjose b64 enc\fR \-I BIN [\-o B64]
  17. .
  18. .P
  19. \fBjose jwe dec\fR \-i JWE [\-I CT] \-k JWK [\-p] [\-O PT]
  20. .
  21. .P
  22. \fBjose jwe enc\fR [\-i JWE] \-I PT \-k JWK [\-p] [\-r RCP] [\-o JWE] [\-O CT] [\-c]
  23. .
  24. .P
  25. \fBjose jwe fmt\fR \-i JWE [\-I CT] [\-o JWE] [\-O CT] [\-c]
  26. .
  27. .P
  28. \fBjose jwk exc\fR [\-i JWK] \-l JWK \-r JWK [\-o JWK]
  29. .
  30. .P
  31. \fBjose jwk gen\fR \-i JWK [\-o JWK]
  32. .
  33. .P
  34. \fBjose jwk pub\fR \-i JWK [\-o JWK]
  35. .
  36. .P
  37. \fBjose jwk thp\fR \-i JWK [\-a ALG] [\-o THP]
  38. .
  39. .P
  40. \fBjose jwk use\fR \-i JWK [\-a] [\-r] \-u OP
  41. .
  42. .P
  43. \fBjose jws fmt\fR \-i JWS [\-I PAY] [\-o JWS] [\-O PAY] [\-c]
  44. .
  45. .P
  46. \fBjose jws sig\fR [\-i JWS] [\-I PAY] [\-s SIG] \-k JWK [\-o JWS] [\-O PAY] [\-c]
  47. .
  48. .P
  49. \fBjose jws ver\fR \-i JWS [\-I PAY] \-k JWK [\-O PAY] [\-a]
  50. .
  51. .SH "OVERVIEW"
  52. José is a C\-language implementation of the Javascript Object Signing and Encryption standards\. Specifically, José aims towards implementing the following standards:
  53. .
  54. .IP "\(bu" 4
  55. RFC 7515 \- JSON Web Signature (JWS)
  56. .
  57. .IP "\(bu" 4
  58. RFC 7516 \- JSON Web Encryption (JWE)
  59. .
  60. .IP "\(bu" 4
  61. RFC 7517 \- JSON Web Key (JWK)
  62. .
  63. .IP "\(bu" 4
  64. RFC 7518 \- JSON Web Algorithms (JWA)
  65. .
  66. .IP "\(bu" 4
  67. RFC 7519 \- JSON Web Token (JWT)
  68. .
  69. .IP "\(bu" 4
  70. RFC 7520 \- Examples of Protecting Content Using JOSE
  71. .
  72. .IP "\(bu" 4
  73. RFC 7638 \- JSON Web Key (JWK) Thumbprint
  74. .
  75. .IP "" 0
  76. .
  77. .P
  78. The José command line utility provides facilities for the following:
  79. .
  80. .IP "\(bu" 4
  81. URL\-safe Base64 Encoding & Decoding
  82. .
  83. .IP "\(bu" 4
  84. Key Generation and Management
  85. .
  86. .IP "\(bu" 4
  87. Encryption & Decryption
  88. .
  89. .IP "\(bu" 4
  90. Signing & Verification
  91. .
  92. .IP "" 0
  93. .
  94. .SH "AUTHOR"
  95. Nathaniel McCallum <npmccallum@redhat\.com>
  96. .
  97. .SH "SEE ALSO"
  98. \fBjose\-alg\fR(1), \fBjose\-b64\-dec\fR(1), \fBjose\-b64\-enc\fR(1), \fBjose\-jwe\-dec\fR(1), \fBjose\-jwe\-enc\fR(1), \fBjose\-jwe\-fmt\fR(1), \fBjose\-jwk\-exc\fR(1), \fBjose\-jwk\-gen\fR(1), \fBjose\-jwk\-pub\fR(1), \fBjose\-jwk\-thp\fR(1), \fBjose\-jwk\-use\fR(1), \fBjose\-jws\-fmt\fR(1), \fBjose\-jws\-sig\fR(1), \fBjose\-jws\-ver\fR(1)