From 0d982816edac134ae4b9c68cd18e86e3791119cc Mon Sep 17 00:00:00 2001 From: Liam Rougoor Date: Fri, 13 Oct 2023 13:03:18 +0200 Subject: [PATCH 1/3] Update docs to discourage TripleDes. --- README.md | 92 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 54 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 8f573f1..a3f462b 100644 --- a/README.md +++ b/README.md @@ -27,44 +27,58 @@ If you want a (basic) example of how you can use an Azure Function to encrypt/de ## Methods -* [Generate Key](#generate-key) - * [GenerateKey](#generatekey) -* [Encrypt](#encrypt) - * [EncryptFileAsync](#encryptfileasync) - * [EncryptStreamAsync](#encryptstreamasync) - * [EncryptArmoredStringAsync](#encryptarmoredstringasync) -* [Sign](#sign) - * [SignFileAsync](#signfileasync) - * [SignStreamAsync](#signstreamasync) - * [SignArmoredStringAsync](#signarmoredstringasync) -* [ClearSign](#clearsign) - * [ClearSignFileAsync](#clearsignfileasync) - * [ClearSignStreamAsync](#clearsignstreamasync) - * [ClearSignArmoredStringAsync](#clearsignarmoredstringasync) -* [Encrypt and Sign](#encrypt-and-sign) - * [EncryptFileAndSignAsync](#encryptfileandsignasync) - * [EncryptStreamAndSignAsync](#encryptstreamandsignasync) - * [EncryptArmoredStringAndSignAsync](#encryptarmoredstringandsignasync) -* [Decrypt](#decrypt) - * [DecryptFileAsync](#decryptfileasync) - * [DecryptStreamAsync](#decryptstreamasync) - * [DecryptArmoredStringAsync](#decryptarmoredstringasync) -* [Verify](#verify) - * [VerifyFileAsync](#verifyfileasync) - * [VerifyStreamAsync](#verifystreamasync) - * [VerifyArmoredStringAsync](#verifyarmoredstringasync) -* [VerifyClear](#verify) - * [VerifyClearFileAsync](#verifyclearfileasync) - * [VerifyClearStreamAsync](#verifyclearstreamasync) - * [VerifyClearArmoredStringAsync](#verifycleararmoredstringasync) -* [Verify and Read Clear](#verify) - * [VerifyAndReadClearFileAsync](#verifyandreadclearfilessync) - * [VerifyAndReadClearStreamAsync](#verifyandreadclearstreamasync) - * [VerifyAndReadClearArmoredStringAsync](#verifyandreadcleararmoredstringasync) -* [Decrypt and Verify](#decrypt-and-verify) - * [DecryptFileAndVerifyAsync](#decryptfileandverifyasync) - * [DecryptStreamAndVerifyAsync](#decryptstreamandverifyasync) - * [DecryptArmoredStringAndVerifyAsync](#decryptarmoredstringandverifyasync) +- [PgpCore](#pgpcore) +- [Installation](#installation) +- [Dependencies](#dependencies) +- [Usage](#usage) +- [Azure Function Example](#azure-function-example) + - [Methods](#methods) + - [Settings](#settings) + - [Generate Key](#generate-key) + - [GenerateKey](#generatekey) + - [Encrypt](#encrypt) + - [EncryptFileAsync](#encryptfileasync) + - [EncryptStreamAsync](#encryptstreamasync) + - [EncryptArmoredStringAsync](#encryptarmoredstringasync) + - [Sign](#sign) + - [SignFileAsync](#signfileasync) + - [SignStreamAsync](#signstreamasync) + - [SignArmoredStringAsync](#signarmoredstringasync) + - [Clear Sign](#clear-sign) + - [ClearSignFileAsync](#clearsignfileasync) + - [ClearSignStreamAsync](#clearsignstreamasync) + - [ClearSignArmoredStringAsync](#clearsignarmoredstringasync) + - [Encrypt and Sign](#encrypt-and-sign) + - [EncryptFileAndSignAsync](#encryptfileandsignasync) + - [EncryptStreamAndSignAsync](#encryptstreamandsignasync) + - [EncryptArmoredStringAndSignAsync](#encryptarmoredstringandsignasync) + - [Decrypt](#decrypt) + - [DecryptFileAsync](#decryptfileasync) + - [DecryptStreamAsync](#decryptstreamasync) + - [DecryptArmoredStringAsync](#decryptarmoredstringasync) + - [Verify](#verify) + - [VerifyFileAsync](#verifyfileasync) + - [VerifyStreamAsync](#verifystreamasync) + - [VerifyArmoredStringAsync](#verifyarmoredstringasync) + - [Verify Clear](#verify-clear) + - [VerifyClearFileAsync](#verifyclearfileasync) + - [VerifyClearStreamAsync](#verifyclearstreamasync) + - [VerifyClearArmoredStringAsync](#verifycleararmoredstringasync) + - [Verify and Read Clear](#verify-and-read-clear) + - [VerifyAndReadClearFileAsync](#verifyandreadclearfileasync) + - [VerifyAndReadClearStreamAsync](#verifyandreadclearstreamasync) + - [VerifyAndReadClearArmoredStringAsync](#verifyandreadcleararmoredstringasync) + - [Decrypt and Verify](#decrypt-and-verify) + - [DecryptFileAndVerifyAsync](#decryptfileandverifyasync) + - [DecryptStreamAndVerifyAsync](#decryptstreamandverifyasync) + - [DecryptArmoredStringAndVerifyAsync](#decryptarmoredstringandverifyasync) + - [Settings](#settings-1) + - [CompressionAlgorithm](#compressionalgorithm) + - [SymmetricKeyAlgorithm](#symmetrickeyalgorithm) + - [PgpSignatureType](#pgpsignaturetype) + - [PublicKeyAlgorithm](#publickeyalgorithm) + - [FileType](#filetype) + - [HashAlgorithmTag](#hashalgorithmtag) ## Settings * [Compression Algorithm](#compressionalgorithm) @@ -499,6 +513,8 @@ The compression algorithim to be used on the message. This is applied prior to e - ZLib - BZip2 ### SymmetricKeyAlgorithm +> Although TripleDes is the default, it is outdated and being [discouraged by security institutions like NIST](https://en.wikipedia.org/wiki/Triple_DES). Aes is recommended. + The private key encryption algorithim. - Null - Idea From 03ad46046526d8fbed82152be39d32dbaf8f4473 Mon Sep 17 00:00:00 2001 From: Liam Rougoor Date: Fri, 13 Oct 2023 14:13:45 +0200 Subject: [PATCH 2/3] Revert "Update docs to discourage TripleDes." This reverts commit 0d982816edac134ae4b9c68cd18e86e3791119cc. --- README.md | 92 +++++++++++++++++++++++-------------------------------- 1 file changed, 38 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index a3f462b..8f573f1 100644 --- a/README.md +++ b/README.md @@ -27,58 +27,44 @@ If you want a (basic) example of how you can use an Azure Function to encrypt/de ## Methods -- [PgpCore](#pgpcore) -- [Installation](#installation) -- [Dependencies](#dependencies) -- [Usage](#usage) -- [Azure Function Example](#azure-function-example) - - [Methods](#methods) - - [Settings](#settings) - - [Generate Key](#generate-key) - - [GenerateKey](#generatekey) - - [Encrypt](#encrypt) - - [EncryptFileAsync](#encryptfileasync) - - [EncryptStreamAsync](#encryptstreamasync) - - [EncryptArmoredStringAsync](#encryptarmoredstringasync) - - [Sign](#sign) - - [SignFileAsync](#signfileasync) - - [SignStreamAsync](#signstreamasync) - - [SignArmoredStringAsync](#signarmoredstringasync) - - [Clear Sign](#clear-sign) - - [ClearSignFileAsync](#clearsignfileasync) - - [ClearSignStreamAsync](#clearsignstreamasync) - - [ClearSignArmoredStringAsync](#clearsignarmoredstringasync) - - [Encrypt and Sign](#encrypt-and-sign) - - [EncryptFileAndSignAsync](#encryptfileandsignasync) - - [EncryptStreamAndSignAsync](#encryptstreamandsignasync) - - [EncryptArmoredStringAndSignAsync](#encryptarmoredstringandsignasync) - - [Decrypt](#decrypt) - - [DecryptFileAsync](#decryptfileasync) - - [DecryptStreamAsync](#decryptstreamasync) - - [DecryptArmoredStringAsync](#decryptarmoredstringasync) - - [Verify](#verify) - - [VerifyFileAsync](#verifyfileasync) - - [VerifyStreamAsync](#verifystreamasync) - - [VerifyArmoredStringAsync](#verifyarmoredstringasync) - - [Verify Clear](#verify-clear) - - [VerifyClearFileAsync](#verifyclearfileasync) - - [VerifyClearStreamAsync](#verifyclearstreamasync) - - [VerifyClearArmoredStringAsync](#verifycleararmoredstringasync) - - [Verify and Read Clear](#verify-and-read-clear) - - [VerifyAndReadClearFileAsync](#verifyandreadclearfileasync) - - [VerifyAndReadClearStreamAsync](#verifyandreadclearstreamasync) - - [VerifyAndReadClearArmoredStringAsync](#verifyandreadcleararmoredstringasync) - - [Decrypt and Verify](#decrypt-and-verify) - - [DecryptFileAndVerifyAsync](#decryptfileandverifyasync) - - [DecryptStreamAndVerifyAsync](#decryptstreamandverifyasync) - - [DecryptArmoredStringAndVerifyAsync](#decryptarmoredstringandverifyasync) - - [Settings](#settings-1) - - [CompressionAlgorithm](#compressionalgorithm) - - [SymmetricKeyAlgorithm](#symmetrickeyalgorithm) - - [PgpSignatureType](#pgpsignaturetype) - - [PublicKeyAlgorithm](#publickeyalgorithm) - - [FileType](#filetype) - - [HashAlgorithmTag](#hashalgorithmtag) +* [Generate Key](#generate-key) + * [GenerateKey](#generatekey) +* [Encrypt](#encrypt) + * [EncryptFileAsync](#encryptfileasync) + * [EncryptStreamAsync](#encryptstreamasync) + * [EncryptArmoredStringAsync](#encryptarmoredstringasync) +* [Sign](#sign) + * [SignFileAsync](#signfileasync) + * [SignStreamAsync](#signstreamasync) + * [SignArmoredStringAsync](#signarmoredstringasync) +* [ClearSign](#clearsign) + * [ClearSignFileAsync](#clearsignfileasync) + * [ClearSignStreamAsync](#clearsignstreamasync) + * [ClearSignArmoredStringAsync](#clearsignarmoredstringasync) +* [Encrypt and Sign](#encrypt-and-sign) + * [EncryptFileAndSignAsync](#encryptfileandsignasync) + * [EncryptStreamAndSignAsync](#encryptstreamandsignasync) + * [EncryptArmoredStringAndSignAsync](#encryptarmoredstringandsignasync) +* [Decrypt](#decrypt) + * [DecryptFileAsync](#decryptfileasync) + * [DecryptStreamAsync](#decryptstreamasync) + * [DecryptArmoredStringAsync](#decryptarmoredstringasync) +* [Verify](#verify) + * [VerifyFileAsync](#verifyfileasync) + * [VerifyStreamAsync](#verifystreamasync) + * [VerifyArmoredStringAsync](#verifyarmoredstringasync) +* [VerifyClear](#verify) + * [VerifyClearFileAsync](#verifyclearfileasync) + * [VerifyClearStreamAsync](#verifyclearstreamasync) + * [VerifyClearArmoredStringAsync](#verifycleararmoredstringasync) +* [Verify and Read Clear](#verify) + * [VerifyAndReadClearFileAsync](#verifyandreadclearfilessync) + * [VerifyAndReadClearStreamAsync](#verifyandreadclearstreamasync) + * [VerifyAndReadClearArmoredStringAsync](#verifyandreadcleararmoredstringasync) +* [Decrypt and Verify](#decrypt-and-verify) + * [DecryptFileAndVerifyAsync](#decryptfileandverifyasync) + * [DecryptStreamAndVerifyAsync](#decryptstreamandverifyasync) + * [DecryptArmoredStringAndVerifyAsync](#decryptarmoredstringandverifyasync) ## Settings * [Compression Algorithm](#compressionalgorithm) @@ -513,8 +499,6 @@ The compression algorithim to be used on the message. This is applied prior to e - ZLib - BZip2 ### SymmetricKeyAlgorithm -> Although TripleDes is the default, it is outdated and being [discouraged by security institutions like NIST](https://en.wikipedia.org/wiki/Triple_DES). Aes is recommended. - The private key encryption algorithim. - Null - Idea From ebc15c550c376dddd9aa8dde8dfcb224def2160d Mon Sep 17 00:00:00 2001 From: Liam Rougoor Date: Fri, 13 Oct 2023 14:16:17 +0200 Subject: [PATCH 3/3] Update docs without formatting. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f573f1..b250615 100644 --- a/README.md +++ b/README.md @@ -499,7 +499,9 @@ The compression algorithim to be used on the message. This is applied prior to e - ZLib - BZip2 ### SymmetricKeyAlgorithm -The private key encryption algorithim. +The private key encryption algorithm. +> Although TripleDes is the default, it is outdated and being [discouraged by security institutions like NIST](https://en.wikipedia.org/wiki/Triple_DES). Aes is recommended. + - Null - Idea - TripleDes - **Default**