[Update 11 Feature] Add support for PGP encryption/decryption with streams

[TharmiganK]

Purpose

$Subject

Fixes: ballerina-platform/ballerina-library#7064
Part of: ballerina-platform/ballerina-library#7252

With this PR, two new functionalities are added to the crypto module:

• encryptStreamAsPgp: Read the content from a stream, encrypt with PGP and return a encrypted stream
• decryptStreamFromPgp: Read the content from an PGP encrypted stream, decrypt with PGP and return a decrypted stream

With this new APIs, large files can be encrypted/decrypted with PGP by loading them as streams rather than loading the entire content into the memory.

Find the following results with large files(the files are generated with random ASCII characters):

File Size	Encryption duration	Encryption max memory usage	Decryption(from the encrypted file) duration	Decryption max memory usage
1 GB	~1 min	~100 MB	~30 s	~125 MB
5 GB	~5 min	~100 MB	~2 min 20 s	~75MB

Examples

• Encryption sample:

stream<byte[], error?> inputStream = check io:fileReadBlocksAsStream("input.txt");
stream<byte[], crypto:Error?>|crypto:Error encryptedStream = crypto:encryptStreamAsPgp(inputStream, "public_key.asc");

• Decryption sample:

byte[] passphrase = check io:fileReadBytes("pass_phrase.txt");
stream<byte[], error?> inputStream = check io:fileReadBlocksAsStream("pgb_encrypted.txt");
stream<byte[], crypto:Error?>|crypto:Error decryptedStream = crypto:decryptStreamFromPgp(inputStream, "private_key.asc", passphrase);

Checklist

• Linked to an issue
• Updated the changelog
• Added tests
• Updated the spec
• Checked native-image compatibility

[codecov]

Codecov Report

Attention: Patch coverage is 68.09816% with 104 lines in your changes missing coverage. Please review.

Project coverage is 84.06%. Comparing base (16e5127) to head (df0e19d).
Report is 48 commits behind head on master.

Files with missing lines	Patch %	Lines
...allerina/stdlib/crypto/nativeimpl/StreamUtils.java	58.25%	30 Missing and 13 partials ⚠️
.../ballerina/stdlib/crypto/BallerinaInputStream.java	56.81%	13 Missing and 6 partials ⚠️
ballerina/stream_iterators.bal	65.62%	11 Missing ⚠️
...allerina/stdlib/crypto/PgpDecryptionGenerator.java	75.55%	7 Missing and 4 partials ⚠️
...allerina/stdlib/crypto/SequentialBufferedPipe.java	61.53%	8 Missing and 2 partials ⚠️
...io/ballerina/stdlib/crypto/nativeimpl/Encrypt.java	71.42%	6 Missing ⚠️
...io/ballerina/stdlib/crypto/nativeimpl/Decrypt.java	76.47%	4 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #567      +/-   ##
============================================
- Coverage     89.11%   84.06%   -5.06%     
- Complexity      172      205      +33     
============================================
  Files            23       27       +4     
  Lines           873     1161     +288     
  Branches        124      167      +43     
============================================
+ Hits            778      976     +198     
- Misses           71      142      +71     
- Partials         24       43      +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[NipunaRanasinghe]

@TharmiganK we may need to update the spec and the changelog along with the new changes

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[TharmiganK]

Closing this PR since this requires Java 21 changes to the master. The feature will be available in the pgp-files branch and a PR will be sent to the master once the Java 21 changes are added to the master

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud