Skip to content

Review API docs in BI editor #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daneshk merged 16 commits into from
Dec 10, 2025
Merged

Review API docs in BI editor #607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
2ebce54
Review API docs in BI editor
daneshk Sep 26, 2025
48e0918
correct the API docs
daneshk Sep 26, 2025
3f22a4a
Merge branch 'master' into master
daneshk Oct 5, 2025
358253b
Merge branch 'master' into master
daneshk Nov 11, 2025
2c95299
Merge branch 'master' of https://github.com/ballerina-platform/module…
daneshk Nov 11, 2025
ce22117
Add review suggestions
daneshk Nov 11, 2025
fe25f0c
Merge branch 'master' of https://github.com/daneshk/module-ballerina-…
daneshk Nov 11, 2025
d072e91
Merge branch 'master' of https://github.com/ballerina-platform/module…
daneshk Dec 9, 2025
6918817
[Automated] Update the native jar versions
daneshk Dec 9, 2025
ca8e04a
update the distribution version
daneshk Dec 9, 2025
7dfba45
update time module version
daneshk Dec 9, 2025
b028e7d
[Automated] Update the native jar versions
daneshk Dec 10, 2025
ce4271a
down grade the distribution and time version
daneshk Dec 10, 2025
0e9ba39
down grade the distribution and time version
daneshk Dec 10, 2025
1c48eaa
[Automated] Update the native jar versions
daneshk Dec 10, 2025
9d02686
Fix review suggestions
daneshk Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 64 additions & 64 deletions ballerina/encrypt_decrypt.bal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,35 @@

import ballerina/jballerina.java;

# Represents the padding algorithms supported by AES encryption and decryption.
# The padding algorithms supported by AES encryption and decryption.
public type AesPadding NONE|PKCS5;

# Represents the padding algorithms supported with RSA encryption and decryption.
# The padding algorithms supported with RSA encryption and decryption.
public type RsaPadding PKCS1|OAEPwithMD5andMGF1|OAEPWithSHA1AndMGF1|OAEPWithSHA256AndMGF1|OAEPwithSHA384andMGF1|
OAEPwithSHA512andMGF1;

# No padding.
# No padding for encryption or decryption.
public const NONE = "NONE";

# The `PKCS1` padding mode.
# The PKCS1 padding mode for RSA encryption and decryption.
public const PKCS1 = "PKCS1";

# The `PKCS5` padding mode.
# The PKCS5 padding mode for AES encryption and decryption.
public const PKCS5 = "PKCS5";

# The `OAEPwithMD5andMGF1` padding mode.
# The OAEP padding mode with MD5 and MGF1 for RSA encryption and decryption.
public const OAEPwithMD5andMGF1 = "OAEPwithMD5andMGF1";

# The `OAEPWithSHA1AndMGF1` padding mode.
# The OAEP padding mode with SHA-1 and MGF1 for RSA encryption and decryption.
public const OAEPWithSHA1AndMGF1 = "OAEPWithSHA1AndMGF1";

# The `OAEPWithSHA256AndMGF1` padding mode.
# The OAEP padding mode with SHA-256 and MGF1 for RSA encryption and decryption.
public const OAEPWithSHA256AndMGF1 = "OAEPWithSHA256AndMGF1";

# The `OAEPwithSHA384andMGF1` padding mode.
# The OAEP padding mode with SHA-384 and MGF1 for RSA encryption and decryption.
public const OAEPwithSHA384andMGF1 = "OAEPwithSHA384andMGF1";

# The `OAEPwithSHA512andMGF1` padding mode.
# The OAEP padding mode with SHA-512 and MGF1 for RSA encryption and decryption.
public const OAEPwithSHA512andMGF1 = "OAEPwithSHA512andMGF1";

# Returns the RSA-encrypted value for the given data.
Expand All @@ -59,10 +59,10 @@ public const OAEPwithSHA512andMGF1 = "OAEPwithSHA512andMGF1";
# byte[] cipherText = check crypto:encryptRsaEcb(data, publicKey);
# ```
#
# + input - The content to be encrypted
# + key - Private or public key used for encryption
# + padding - The padding algorithm
# + return - Encrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be encrypted, provided as a byte array
# + key - The RSA key (private or public) used for encryption. The key must be compatible with the RSA algorithm
# + padding - The padding algorithm to use. Supported values are `PKCS1`, `OAEPwithMD5andMGF1`, `OAEPWithSHA1AndMGF1`, `OAEPWithSHA256AndMGF1`, `OAEPwithSHA384andMGF1`, and `OAEPwithSHA512andMGF1`
# + return - The encrypted data as a byte array, or a `crypto:Error` if the key is invalid or an error occurs during encryption
public isolated function encryptRsaEcb(byte[] input, PrivateKey|PublicKey key, RsaPadding padding = PKCS1)
returns byte[]|Error = @java:Method {
name: "encryptRsaEcb",
Expand All @@ -84,11 +84,11 @@ public isolated function encryptRsaEcb(byte[] input, PrivateKey|PublicKey key, R
# byte[] cipherText = check crypto:encryptAesCbc(data, key, initialVector);
# ```
#
# + input - The content to be encrypted
# + key - Encryption key
# + iv - Initialization vector
# + padding - The padding algorithm
# + return - Encrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be encrypted, provided as a byte array
# + key - The encryption key used for AES-CBC encryption
# + iv - The initialization vector used to initialize the AES-CBC encryption process
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + return - The encrypted data as a byte array, or a `crypto:Error` if the key, IV, or padding is invalid
public isolated function encryptAesCbc(byte[] input, byte[] key, byte[] iv, AesPadding padding = PKCS5)
returns byte[]|Error = @java:Method {
name: "encryptAesCbc",
Expand All @@ -106,10 +106,10 @@ public isolated function encryptAesCbc(byte[] input, byte[] key, byte[] iv, AesP
# byte[] cipherText = check crypto:encryptAesEcb(data, key);
# ```
#
# + input - The content to be encrypted
# + key - Encryption key
# + padding - The padding algorithm
# + return - Encrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be encrypted, provided as a byte array
# + key - The encryption key used for AES-ECB encryption
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + return - The encrypted data as a byte array, or a `crypto:Error` if the key or padding is invalid
public isolated function encryptAesEcb(byte[] input, byte[] key, AesPadding padding = PKCS5)
returns byte[]|Error = @java:Method {
name: "encryptAesEcb",
Expand All @@ -131,12 +131,12 @@ public isolated function encryptAesEcb(byte[] input, byte[] key, AesPadding padd
# byte[] cipherText = check crypto:encryptAesGcm(data, key, initialVector);
# ```
#
# + input - The content to be encrypted
# + key - Encryption key
# + iv - Initialization vector
# + padding - The padding algorithm
# + tagSize - Tag size
# + return - Encrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be encrypted, provided as a byte array
# + key - The encryption key used for AES-GCM encryption
# + iv - The initialization vector used to initialize the AES-GCM encryption process
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + tagSize - The size of the authentication tag in bits. Valid values are 128, 120, 112, 104, or 96
# + return - The encrypted data as a byte array, or a `crypto:Error` if the key, IV, or tag size is invalid
public isolated function encryptAesGcm(byte[] input, byte[] key, byte[] iv, AesPadding padding = NONE,
int tagSize = 128) returns byte[]|Error = @java:Method {
name: "encryptAesGcm",
Expand All @@ -157,10 +157,10 @@ public isolated function encryptAesGcm(byte[] input, byte[] key, byte[] iv, AesP
# byte[] plainText = check crypto:decryptRsaEcb(cipherText, privateKey);
# ```
#
# + input - The content to be decrypted
# + key - Private or public key used for encryption
# + padding - The padding algorithm
# + return - Decrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be decrypted, provided as a byte array
# + key - The RSA key (private or public) used for decryption. The key must be compatible with the RSA algorithm
# + padding - The padding algorithm to use. Supported values are `PKCS1`, `OAEPwithMD5andMGF1`, `OAEPWithSHA1AndMGF1`, `OAEPWithSHA256AndMGF1`, `OAEPwithSHA384andMGF1`, and `OAEPwithSHA512andMGF1`
# + return - The decrypted data as a byte array, or a `crypto:Error` if the key is invalid or an error occurs during decryption
public isolated function decryptRsaEcb(byte[] input, PrivateKey|PublicKey key, RsaPadding padding = PKCS1)
returns byte[]|Error = @java:Method {
name: "decryptRsaEcb",
Expand All @@ -183,11 +183,11 @@ public isolated function decryptRsaEcb(byte[] input, PrivateKey|PublicKey key, R
# byte[] plainText = check crypto:decryptAesCbc(cipherText, key, initialVector);
# ```
#
# + input - The content to be decrypted
# + key - Encryption key
# + iv - Initialization vector
# + padding - The padding algorithm
# + return - Decrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be decrypted, provided as a byte array
# + key - The encryption key used for AES-CBC decryption
# + iv - The initialization vector used to initialize the AES-CBC decryption process
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + return - The decrypted data as a byte array, or a `crypto:Error` if the key, IV, or padding is invalid
public isolated function decryptAesCbc(byte[] input, byte[] key, byte[] iv, AesPadding padding = PKCS5)
returns byte[]|Error = @java:Method {
name: "decryptAesCbc",
Expand All @@ -206,10 +206,10 @@ public isolated function decryptAesCbc(byte[] input, byte[] key, byte[] iv, AesP
# byte[] plainText = check crypto:decryptAesEcb(cipherText, key);
# ```
#
# + input - The content to be decrypted
# + key - Encryption key
# + padding - The padding algorithm
# + return - Decrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be decrypted, provided as a byte array
# + key - The encryption key used for AES-ECB decryption
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + return - The decrypted data as a byte array, or a `crypto:Error` if the key or padding is invalid
public isolated function decryptAesEcb(byte[] input, byte[] key, AesPadding padding = PKCS5)
returns byte[]|Error = @java:Method {
name: "decryptAesEcb",
Expand All @@ -232,12 +232,12 @@ public isolated function decryptAesEcb(byte[] input, byte[] key, AesPadding padd
# byte[] plainText = check crypto:decryptAesGcm(cipherText, key, initialVector);
# ```
#
# + input - The content to be decrypted
# + key - Encryption key
# + iv - Initialization vector
# + padding - The padding algorithm
# + tagSize - Tag size
# + return - Decrypted data or else a `crypto:Error` if the key is invalid
# + input - The content to be decrypted, provided as a byte array
# + key - The encryption key used for AES-GCM decryption
# + iv - The initialization vector used to initialize the AES-GCM decryption process
# + padding - The padding algorithm to use. Supported value is `PKCS5`
# + tagSize - The size of the authentication tag in bits. Valid values are 128, 120, 112, 104, or 96
# + return - The decrypted data as a byte array, or a `crypto:Error` if the key, IV, or tag size is invalid
public isolated function decryptAesGcm(byte[] input, byte[] key, byte[] iv, AesPadding padding = PKCS5,
int tagSize = 128) returns byte[]|Error = @java:Method {
name: "decryptAesGcm",
Expand All @@ -250,10 +250,10 @@ public isolated function decryptAesGcm(byte[] input, byte[] key, byte[] iv, AesP
# byte[] cipherText = check crypto:encryptPgp(message, "public_key.asc");
# ```
#
# + plainText - The content to be encrypted
# + publicKey - Path to the public key
# + options - PGP encryption options
# + return - Encrypted data or else a `crypto:Error` if the key is invalid
# + plainText - The content to be encrypted, provided as a byte array
# + publicKey - Path to the public key file in ASCII-armored format
# + options - Optional PGP encryption options, such as compression or cipher preferences
# + return - The encrypted data as a byte array, or a `crypto:Error` if the public key is invalid or an error occurs during encryption
public isolated function encryptPgp(byte[] plainText, string publicKey, *Options options)
returns byte[]|Error = @java:Method {
name: "encryptPgp",
Expand All @@ -266,10 +266,10 @@ public isolated function encryptPgp(byte[] plainText, string publicKey, *Options
# stream<byte[], crypto:Error?>|crypto:Error encryptedStream = crypto:encryptStreamAsPgp(inputStream, "public_key.asc");
# ```
#
# + inputStream - The content to be encrypted as a stream
# + publicKey - Path to the public key
# + options - PGP encryption options
# + return - Encrypted stream or else a `crypto:Error` if the key is invalid
# + inputStream - The content to be encrypted, provided as a stream of byte arrays
# + publicKey - Path to the public key file in ASCII-armored format
# + options - Optional PGP encryption options, such as compression or cipher preferences
# + return - The encrypted content as a stream of byte arrays, or a `crypto:Error` if the public key is invalid or an error occurs during encryption
public isolated function encryptStreamAsPgp(stream<byte[], error?> inputStream, string publicKey,
*Options options) returns stream<byte[], Error?>|Error = @java:Method {
'class: "io.ballerina.stdlib.crypto.nativeimpl.Encrypt"
Expand All @@ -284,10 +284,10 @@ public isolated function encryptStreamAsPgp(stream<byte[], error?> inputStream,
# byte[] decryptedMessage = check crypto:decryptPgp(cipherText, "private_key.asc", passphrase);
# ```
#
# + cipherText - The encrypted content to be decrypted
# + privateKey - Path to the private key
# + passphrase - passphrase of the private key
# + return - Decrypted data or else a `crypto:Error` if the key or passphrase is invalid
# + cipherText - The encrypted content to be decrypted, provided as a byte array
# + privateKey - Path to the private key file in ASCII-armored format
# + passphrase - The passphrase used to unlock the private key
# + return - The decrypted data as a byte array, or a `crypto:Error` if the key or passphrase is invalid
public isolated function decryptPgp(byte[] cipherText, string privateKey, byte[] passphrase)
returns byte[]|Error = @java:Method {
name: "decryptPgp",
Expand All @@ -301,10 +301,10 @@ public isolated function decryptPgp(byte[] cipherText, string privateKey, byte[]
# stream<byte[], crypto:Error?>|crypto:Error decryptedStream = crypto:decryptStreamFromPgp(inputStream, "private_key.asc", passphrase);
# ```
#
# + inputStream - The encrypted content as a stream
# + privateKey - Path to the private key
# + passphrase - passphrase of the private key
# + return - Decrypted stream or else a `crypto:Error` if the key or passphrase is invalid
# + inputStream - The encrypted content provided as a stream of byte arrays
# + privateKey - Path to the private key file in ASCII-armored format
# + passphrase - The passphrase used to unlock the private key
# + return - The decrypted content as a stream of byte arrays, or a `crypto:Error` if the key or passphrase is invalid
public isolated function decryptStreamFromPgp(stream<byte[], error?> inputStream, string privateKey,
byte[] passphrase) returns stream<byte[], Error?>|Error = @java:Method {
'class: "io.ballerina.stdlib.crypto.nativeimpl.Decrypt"
Expand Down
Loading