1
0

jose-jwe-dec.1 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. .\" generated with Ronn/v0.7.3
  2. .\" http://github.com/rtomayko/ronn/tree/0.7.3
  3. .
  4. .TH "JOSE\-JWE\-DEC" "1" "May 2017" "" ""
  5. .
  6. .SH "NAME"
  7. \fBjose\-jwe\-dec\fR \- Decrypts a JWE using the supplied JWKs
  8. .
  9. .SH "SYNOPSIS"
  10. \fBjose jwe dec\fR \-i JWE [\-I CT] \-k JWK [\-p] [\-O PT]
  11. .
  12. .SH "OVERVIEW"
  13. The \fBjose jwe dec\fR command decrypts a JWE using one or more JWK (\fB\-k\fR) or password (\fB\-p\fR)\. Decryption succeeds if any key is able to perform decryption\.
  14. .
  15. .P
  16. If the JWE is a detached JWE, meaning that the ciphertext is stored in binary form external to the JWE itself, the ciphertext can be loaded using the \fB\-I\fR parameter\.
  17. .
  18. .P
  19. Please note that, when specifying the \fB\-O\fR option to output the plaintext, plaintext output begins before ciphertext validation\. Therefore, you must check the return value of the command before using the data\.
  20. .
  21. .SH "OPTIONS"
  22. .
  23. .TP
  24. \fB\-i\fR \fIJSON\fR, \fB\-\-input\fR=\fIJSON\fR
  25. Parse JWE from JSON
  26. .
  27. .TP
  28. \fB\-i\fR \fIFILE\fR, \fB\-\-input\fR=\fIFILE\fR
  29. Read JWE from FILE
  30. .
  31. .TP
  32. \fB\-i\fR \-, \fB\-\-input\fR=\-
  33. Read JWE from standard input
  34. .
  35. .TP
  36. \fB\-I\fR \fIFILE\fR, \fB\-\-detached\fR=\fIFILE\fR
  37. Read decoded ciphertext from FILE
  38. .
  39. .TP
  40. \fB\-I\fR \-, \fB\-\-detached\fR=\-
  41. Read decoded ciphertext from standard input
  42. .
  43. .TP
  44. \fB\-p\fR, \fB\-\-password\fR
  45. Prompt for a decryption password, if necessary
  46. .
  47. .TP
  48. \fB\-k\fR \fIFILE\fR, \fB\-\-key\fR=\fIFILE\fR
  49. Read JWK(Set) from FILE
  50. .
  51. .TP
  52. \fB\-k\fR \-, \fB\-\-key=\-\fR
  53. Read JWK(Set) from standard input
  54. .
  55. .TP
  56. \fB\-O\fR \fIJSON\fR, \fB\-\-detach\fR=\fIJSON\fR
  57. Parse JWE from JSON
  58. .
  59. .TP
  60. \fB\-O\fR \fIFILE\fR, \fB\-\-detach\fR=\fIFILE\fR
  61. Read JWE from FILE
  62. .
  63. .TP
  64. \fB\-O\fR \-, \fB\-\-detach\fR=\-
  65. Read JWE from standard input
  66. .
  67. .SH "EXAMPLES"
  68. Decrypt a JWE with a JWK:
  69. .
  70. .IP "" 4
  71. .
  72. .nf
  73. $ jose jwe dec \-i msg\.jwe \-k rsa\.key \-O msg\.txt
  74. .
  75. .fi
  76. .
  77. .IP "" 0
  78. .
  79. .P
  80. Decrypt a JWE with a password:
  81. .
  82. .IP "" 4
  83. .
  84. .nf
  85. $ jose jwe dec \-i msg\.jwe \-p \-O msg\.txt
  86. Please enter decryption password:
  87. .
  88. .fi
  89. .
  90. .IP "" 0
  91. .
  92. .P
  93. Decrypt a JWE with either of two JWKs:
  94. .
  95. .IP "" 4
  96. .
  97. .nf
  98. $ jose jwe dec \-i msg\.jwe \-k ec\.jwk \-k rsa\.jwk \-O msg\.txt
  99. .
  100. .fi
  101. .
  102. .IP "" 0
  103. .
  104. .SH "AUTHOR"
  105. Nathaniel McCallum <npmccallum@redhat\.com>
  106. .
  107. .SH "SEE ALSO"
  108. \fBjose\-jwe\-enc\fR(1), \fBjose\-jwe\-fmt\fR(1)