Add operation descriptions for some PGP ops

This commit is contained in:
toby 2017-03-20 14:53:29 -04:00
parent fa309ca6ea
commit 6d733ef2d7

View file

@ -3262,7 +3262,22 @@ var OperationConfig = {
]
},
"Sign PGP Detached": {
description: "",
description: [
"Input: The ASCII-armoured PGP private key of the signer, ",
" (and the private key password if necessary).",
"<br><br>",
"This operation uses PGP to produce a cleartext message and its digital signature. ",
"It outputs 3 files as HTML: ",
"the cleartext message (msg), ",
"the ASCII-armoured signature (msg.asc), and ",
"the raw bytes of the signature (msg.sig).",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function relies on OpenPGP.js for the implementation of PGP.",
"<br><br>",
"See more at https://openpgpjs.org/",
].join("\n"),
run: PGP.runSignDetached,
inputType: "string",
outputType: "HTML",
@ -3280,7 +3295,18 @@ var OperationConfig = {
]
},
"Verify PGP Detached": {
description: "",
description: [
"Input: The ASCII-armoured PGP public key of the sender, ",
"the ASCII-armoured signature of the message.",
"<br><br>",
"This operation uses PGP to verify a detached cleartext PGP signature.",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function relies on OpenPGP.js for the implementation of PGP.",
"<br><br>",
"See more at https://openpgpjs.org/",
].join("\n"),
run: PGP.runVerifyDetached,
inputType: "string",
outputType: "string",
@ -3388,7 +3414,21 @@ var OperationConfig = {
]
},
"Detach PGP Cleartext": {
description: "",
description: [
"Input: The PGP cleartext signature you want to detach.",
"<br><br>",
"This operation will detach the cleartext message from the signature.",
"It outputs 3 files as HTML: ",
"the cleartext message (msg), ",
"the ASCII-armoured signature (msg.asc), and ",
"the raw bytes of the signature (msg.sig).",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function relies on OpenPGP.js for the implementation of PGP.",
"<br><br>",
"See more at https://openpgpjs.org/",
].join("\n"),
run: PGP.runDetachClearsig,
inputType: "string",
outputType: "HTML",
@ -3396,7 +3436,18 @@ var OperationConfig = {
],
},
"Add PGP ASCII Armour": {
description: "",
description: [
"Input: The raw PGP bytes of the message or key that you want to add ASCII-armour to, ",
"the kind of thing the raw bytes are: message / public key / private key.",
"<br><br>",
"This operation will output the ASCII-armoured input.",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function relies on OpenPGP.js for the implementation of PGP.",
"<br><br>",
"See more at https://openpgpjs.org/",
].join("\n"),
run: PGP.runAddArmour,
inputType: "byteArray",
outputType: "string",
@ -3409,7 +3460,17 @@ var OperationConfig = {
],
},
"Remove PGP ASCII Armour": {
description: "",
description: [
"Input: The ASCII-armoured PGP message or key that you want to remove the ASCII-armour from.",
"<br><br>",
"This operation will output the raw bytes of the PGP packets.",
"<br><br>",
"Pretty Good Privacy is an encryption standard (OpenPGP) used for encrypting, decrypting, and signing messages.",
"<br><br>",
"This function relies on OpenPGP.js for the implementation of PGP.",
"<br><br>",
"See more at https://openpgpjs.org/",
].join("\n"),
run: PGP.runRemoveArmour,
inputType: "string",
outputType: "byteArray",