@edirect/encrypt-modules 11.0.48 → 11.0.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -15
- package/dist/README.md +21 -15
- package/dist/package.json +2 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -59,9 +59,9 @@ export class SecureDataService {
|
|
|
59
59
|
|
|
60
60
|
**`PgpEncryptService` API:**
|
|
61
61
|
|
|
62
|
-
| Method
|
|
63
|
-
|
|
64
|
-
| `encrypt` | `(pgpKey: string, dataToEncrypt: string): Promise<string>`
|
|
62
|
+
| Method | Signature | Description |
|
|
63
|
+
| --------- | ------------------------------------------------------------------------------- | ------------------------------------ |
|
|
64
|
+
| `encrypt` | `(pgpKey: string, dataToEncrypt: string): Promise<string>` | Encrypt data using a PGP public key |
|
|
65
65
|
| `decrypt` | `(pgpKey: string, encryptedData: string, passphrase?: string): Promise<string>` | Decrypt data using a PGP private key |
|
|
66
66
|
|
|
67
67
|
### AES Encryption (`AesEncryptModule`)
|
|
@@ -79,8 +79,14 @@ export class AppModule {}
|
|
|
79
79
|
import { AesEncryptService } from '@edirect/encrypt-modules';
|
|
80
80
|
|
|
81
81
|
// Default: AES-256-CBC
|
|
82
|
-
const encrypted = aesService.encrypt(
|
|
83
|
-
|
|
82
|
+
const encrypted = aesService.encrypt(
|
|
83
|
+
'secret data',
|
|
84
|
+
'my-32-char-passphrase-here!!!!!'
|
|
85
|
+
);
|
|
86
|
+
const decrypted = aesService.decrypt(
|
|
87
|
+
encrypted,
|
|
88
|
+
'my-32-char-passphrase-here!!!!!'
|
|
89
|
+
);
|
|
84
90
|
|
|
85
91
|
// With custom IV and encoding
|
|
86
92
|
const encrypted2 = aesService.encrypt('data', passphrase, {
|
|
@@ -92,9 +98,9 @@ const encrypted2 = aesService.encrypt('data', passphrase, {
|
|
|
92
98
|
|
|
93
99
|
**`AesEncryptService` API:**
|
|
94
100
|
|
|
95
|
-
| Method
|
|
96
|
-
|
|
97
|
-
| `encrypt` | `(message: string, passphrase: CipherKey, options?: IaesEncryptOptionalParameters): string`
|
|
101
|
+
| Method | Signature | Description |
|
|
102
|
+
| --------- | ----------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
103
|
+
| `encrypt` | `(message: string, passphrase: CipherKey, options?: IaesEncryptOptionalParameters): string` | Synchronous AES encryption |
|
|
98
104
|
| `decrypt` | `(encryptedMessage: string, passphrase: BinaryLike, options?: IaesDecryptOptionalParameters): string` | Synchronous AES decryption |
|
|
99
105
|
|
|
100
106
|
### RSA Encryption (`RsaEncryptModule`)
|
|
@@ -128,13 +134,13 @@ export class AppModule {}
|
|
|
128
134
|
|
|
129
135
|
## AES Optional Parameters
|
|
130
136
|
|
|
131
|
-
| Option
|
|
132
|
-
|
|
133
|
-
| `iv`
|
|
134
|
-
| `encryptionMethod` | `string`
|
|
135
|
-
| `inputEncoding`
|
|
136
|
-
| `outputEncoding`
|
|
137
|
-
| `options`
|
|
137
|
+
| Option | Type | Default | Description |
|
|
138
|
+
| ------------------ | ------------------ | --------------- | ---------------------------------- |
|
|
139
|
+
| `iv` | `BinaryLike` | Random | Initialization vector |
|
|
140
|
+
| `encryptionMethod` | `string` | `'aes-256-cbc'` | Cipher algorithm |
|
|
141
|
+
| `inputEncoding` | `Encoding` | `'utf8'` | Input data encoding |
|
|
142
|
+
| `outputEncoding` | `Encoding` | `'hex'` | Output encoding for encrypted data |
|
|
143
|
+
| `options` | `TransformOptions` | — | Additional stream options |
|
|
138
144
|
|
|
139
145
|
## Security Notes
|
|
140
146
|
|
package/dist/README.md
CHANGED
|
@@ -59,9 +59,9 @@ export class SecureDataService {
|
|
|
59
59
|
|
|
60
60
|
**`PgpEncryptService` API:**
|
|
61
61
|
|
|
62
|
-
| Method
|
|
63
|
-
|
|
64
|
-
| `encrypt` | `(pgpKey: string, dataToEncrypt: string): Promise<string>`
|
|
62
|
+
| Method | Signature | Description |
|
|
63
|
+
| --------- | ------------------------------------------------------------------------------- | ------------------------------------ |
|
|
64
|
+
| `encrypt` | `(pgpKey: string, dataToEncrypt: string): Promise<string>` | Encrypt data using a PGP public key |
|
|
65
65
|
| `decrypt` | `(pgpKey: string, encryptedData: string, passphrase?: string): Promise<string>` | Decrypt data using a PGP private key |
|
|
66
66
|
|
|
67
67
|
### AES Encryption (`AesEncryptModule`)
|
|
@@ -79,8 +79,14 @@ export class AppModule {}
|
|
|
79
79
|
import { AesEncryptService } from '@edirect/encrypt-modules';
|
|
80
80
|
|
|
81
81
|
// Default: AES-256-CBC
|
|
82
|
-
const encrypted = aesService.encrypt(
|
|
83
|
-
|
|
82
|
+
const encrypted = aesService.encrypt(
|
|
83
|
+
'secret data',
|
|
84
|
+
'my-32-char-passphrase-here!!!!!'
|
|
85
|
+
);
|
|
86
|
+
const decrypted = aesService.decrypt(
|
|
87
|
+
encrypted,
|
|
88
|
+
'my-32-char-passphrase-here!!!!!'
|
|
89
|
+
);
|
|
84
90
|
|
|
85
91
|
// With custom IV and encoding
|
|
86
92
|
const encrypted2 = aesService.encrypt('data', passphrase, {
|
|
@@ -92,9 +98,9 @@ const encrypted2 = aesService.encrypt('data', passphrase, {
|
|
|
92
98
|
|
|
93
99
|
**`AesEncryptService` API:**
|
|
94
100
|
|
|
95
|
-
| Method
|
|
96
|
-
|
|
97
|
-
| `encrypt` | `(message: string, passphrase: CipherKey, options?: IaesEncryptOptionalParameters): string`
|
|
101
|
+
| Method | Signature | Description |
|
|
102
|
+
| --------- | ----------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
103
|
+
| `encrypt` | `(message: string, passphrase: CipherKey, options?: IaesEncryptOptionalParameters): string` | Synchronous AES encryption |
|
|
98
104
|
| `decrypt` | `(encryptedMessage: string, passphrase: BinaryLike, options?: IaesDecryptOptionalParameters): string` | Synchronous AES decryption |
|
|
99
105
|
|
|
100
106
|
### RSA Encryption (`RsaEncryptModule`)
|
|
@@ -128,13 +134,13 @@ export class AppModule {}
|
|
|
128
134
|
|
|
129
135
|
## AES Optional Parameters
|
|
130
136
|
|
|
131
|
-
| Option
|
|
132
|
-
|
|
133
|
-
| `iv`
|
|
134
|
-
| `encryptionMethod` | `string`
|
|
135
|
-
| `inputEncoding`
|
|
136
|
-
| `outputEncoding`
|
|
137
|
-
| `options`
|
|
137
|
+
| Option | Type | Default | Description |
|
|
138
|
+
| ------------------ | ------------------ | --------------- | ---------------------------------- |
|
|
139
|
+
| `iv` | `BinaryLike` | Random | Initialization vector |
|
|
140
|
+
| `encryptionMethod` | `string` | `'aes-256-cbc'` | Cipher algorithm |
|
|
141
|
+
| `inputEncoding` | `Encoding` | `'utf8'` | Input data encoding |
|
|
142
|
+
| `outputEncoding` | `Encoding` | `'hex'` | Output encoding for encrypted data |
|
|
143
|
+
| `options` | `TransformOptions` | — | Additional stream options |
|
|
138
144
|
|
|
139
145
|
## Security Notes
|
|
140
146
|
|
package/dist/package.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"dist"
|
|
18
18
|
],
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"@nestjs/common": "^11.1.
|
|
20
|
+
"@nestjs/common": "^11.1.16",
|
|
21
21
|
"archiver": "7.0.1",
|
|
22
22
|
"archiver-zip-encrypted": "^2.0.0",
|
|
23
23
|
"node-rsa": "1.1.1",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
29
|
"@types/archiver": "^7.0.0",
|
|
30
|
-
"@types/node": "^25.
|
|
30
|
+
"@types/node": "^25.4.0",
|
|
31
31
|
"@types/node-rsa": "^1.1.4",
|
|
32
32
|
"@types/stream-buffers": "^3.0.8"
|
|
33
33
|
},
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@edirect/encrypt-modules",
|
|
3
|
-
"version": "11.0.
|
|
3
|
+
"version": "11.0.49",
|
|
4
4
|
"description": "Encrypt Modules",
|
|
5
5
|
"packageScope": "@edirect",
|
|
6
6
|
"main": "./dist/src/index.js",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dist"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@nestjs/common": "^11.1.
|
|
21
|
+
"@nestjs/common": "^11.1.16",
|
|
22
22
|
"archiver": "7.0.1",
|
|
23
23
|
"archiver-zip-encrypted": "^2.0.0",
|
|
24
24
|
"node-rsa": "1.1.1",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@nestjs/cli": "^11.0.16",
|
|
31
31
|
"@types/archiver": "^7.0.0",
|
|
32
|
-
"@types/node": "^25.
|
|
32
|
+
"@types/node": "^25.4.0",
|
|
33
33
|
"@types/node-rsa": "^1.1.4",
|
|
34
34
|
"@types/stream-buffers": "^3.0.8"
|
|
35
35
|
},
|