@hugoalh/github-sodium 2.0.1 → 2.0.3
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 +48 -25
- package/lib/github-sodium-sealer.js +5 -5
- package/lib/github-sodium-sealer.mjs +5 -5
- package/lib/seal.js +1 -1
- package/lib/seal.mjs +1 -1
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -1,28 +1,26 @@
|
|
|
1
1
|
# GitHub Sodium (NodeJS)
|
|
2
2
|
|
|
3
3
|
[`GitHubSodium.NodeJS`](https://github.com/hugoalh-studio/github-sodium-nodejs)
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
[) | **Pre** () |
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/stargazers)
|
|
8
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/graphs/contributors)
|
|
9
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/issues)
|
|
10
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/pulls)
|
|
11
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/discussions)
|
|
12
|
+
[](https://www.codefactor.io/repository/github/hugoalh-studio/github-sodium-nodejs)
|
|
13
|
+
|
|
14
|
+
| **Releases** | **Latest** () | **Pre** () |
|
|
17
15
|
|:-:|:-:|:-:|
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
16
|
+
| [](https://github.com/hugoalh-studio/github-sodium-nodejs/releases)  |  |  |
|
|
17
|
+
| [](https://www.npmjs.com/package/@hugoalh/github-sodium)  |  |  |
|
|
20
18
|
|
|
21
19
|
## 📝 Description
|
|
22
20
|
|
|
23
|
-
A NodeJS module to provide an easier sodium for GitHub
|
|
21
|
+
A NodeJS module to provide an easier sodium for GitHub secrets.
|
|
24
22
|
|
|
25
|
-
This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/libsodium.js))([NPM](https://www.npmjs.com/package/libsodium))(for ModuleJS) and `tweetsodium` ([GitHub](https://github.com/github/tweetsodium))([NPM](https://www.npmjs.com/package/tweetsodium))(for CommonJS) with optimization for GitHub
|
|
23
|
+
This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/libsodium.js))([NPM](https://www.npmjs.com/package/libsodium))(for ModuleJS) and `tweetsodium` ([GitHub](https://github.com/github/tweetsodium))([NPM](https://www.npmjs.com/package/tweetsodium))(for CommonJS) with optimization for GitHub secrets.
|
|
26
24
|
|
|
27
25
|
## 📚 Documentation
|
|
28
26
|
|
|
@@ -30,20 +28,21 @@ This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/li
|
|
|
30
28
|
|
|
31
29
|
#### Install
|
|
32
30
|
|
|
33
|
-
- NodeJS >=
|
|
34
|
-
- NPM >= v6.14.8
|
|
31
|
+
- NodeJS >= v10.13.0
|
|
35
32
|
|
|
36
33
|
```sh
|
|
37
34
|
npm install @hugoalh/github-sodium
|
|
38
35
|
```
|
|
39
36
|
|
|
40
|
-
#### Use
|
|
37
|
+
#### Use
|
|
38
|
+
|
|
39
|
+
##### CommonJS
|
|
41
40
|
|
|
42
41
|
```js
|
|
43
42
|
const githubSodium = require("@hugoalh/github-sodium");
|
|
44
43
|
```
|
|
45
44
|
|
|
46
|
-
|
|
45
|
+
##### ModuleJS
|
|
47
46
|
|
|
48
47
|
```js
|
|
49
48
|
/* Either */
|
|
@@ -56,13 +55,37 @@ import { ... } from "@hugoalh/github-sodium";// Part / Tree-shake
|
|
|
56
55
|
|
|
57
56
|
#### Class
|
|
58
57
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
58
|
+
<ul>
|
|
59
|
+
<li><code>GitHubSodiumSealer</code></li>
|
|
60
|
+
<ul>
|
|
61
|
+
<li>
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
@constructor(publicKey: string): GitHubSodiumSealer
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
</li>
|
|
68
|
+
<li>
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
encrypt(value: string): string
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
</li>
|
|
75
|
+
</ul>
|
|
76
|
+
</ul>
|
|
62
77
|
|
|
63
78
|
#### Function
|
|
64
79
|
|
|
65
|
-
|
|
80
|
+
<ul>
|
|
81
|
+
<li>
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
seal(publicKey: string, value: string): string
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
</li>
|
|
88
|
+
</ul>
|
|
66
89
|
|
|
67
90
|
### Example
|
|
68
91
|
|
|
@@ -13,9 +13,9 @@ class GitHubSodiumSealer {
|
|
|
13
13
|
constructor(publicKey) {
|
|
14
14
|
if (!advancedDetermine.isString(publicKey, { empty: false })) {
|
|
15
15
|
throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
|
|
16
|
-
}
|
|
16
|
+
}
|
|
17
17
|
this.#publicKeyStorage = Buffer.from(publicKey, "base64");
|
|
18
|
-
}
|
|
18
|
+
}
|
|
19
19
|
/**
|
|
20
20
|
* @method
|
|
21
21
|
* @param {string} value Value that need to encrypt as secret value.
|
|
@@ -24,8 +24,8 @@ class GitHubSodiumSealer {
|
|
|
24
24
|
encrypt(value) {
|
|
25
25
|
if (!advancedDetermine.isString(value, { empty: false })) {
|
|
26
26
|
throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
|
|
27
|
-
}
|
|
27
|
+
}
|
|
28
28
|
return Buffer.from(tweetsodium.seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
|
|
29
|
-
}
|
|
30
|
-
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
31
|
module.exports = GitHubSodiumSealer;
|
|
@@ -14,9 +14,9 @@ class GitHubSodiumSealer {
|
|
|
14
14
|
constructor(publicKey) {
|
|
15
15
|
if (!adIsString(publicKey, { empty: false })) {
|
|
16
16
|
throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
|
|
17
|
-
}
|
|
17
|
+
}
|
|
18
18
|
this.#publicKeyStorage = Buffer.from(publicKey, "base64");
|
|
19
|
-
}
|
|
19
|
+
}
|
|
20
20
|
/**
|
|
21
21
|
* @method
|
|
22
22
|
* @param {string} value Value that need to encrypt as secret value.
|
|
@@ -25,8 +25,8 @@ class GitHubSodiumSealer {
|
|
|
25
25
|
encrypt(value) {
|
|
26
26
|
if (!adIsString(value, { empty: false })) {
|
|
27
27
|
throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
|
|
28
|
-
}
|
|
28
|
+
}
|
|
29
29
|
return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
|
|
30
|
-
}
|
|
31
|
-
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
32
|
export default GitHubSodiumSealer;
|
package/lib/seal.js
CHANGED
package/lib/seal.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hugoalh/github-sodium",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.3",
|
|
4
4
|
"description": "A module to provide an easier sodium for GitHub secret.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"github",
|
|
@@ -24,16 +24,19 @@
|
|
|
24
24
|
"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@hugoalh/advanced-determine": "^7.
|
|
27
|
+
"@hugoalh/advanced-determine": "^7.2.0",
|
|
28
28
|
"libsodium-wrappers": "^0.7.10",
|
|
29
|
-
"tweetsodium": "
|
|
29
|
+
"tweetsodium": "0.0.5"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@types/libsodium-wrappers": "^0.7.
|
|
32
|
+
"@types/libsodium-wrappers": "^0.7.10",
|
|
33
|
+
"@types/node": "^18.8.4",
|
|
34
|
+
"eslint": "^8.25.0",
|
|
35
|
+
"eslint-plugin-only-warn": "^1.0.3",
|
|
36
|
+
"typescript": "^4.8.4"
|
|
33
37
|
},
|
|
34
38
|
"engines": {
|
|
35
|
-
"node": ">=
|
|
36
|
-
"npm": ">= 6.14.8"
|
|
39
|
+
"node": ">=10.13.0"
|
|
37
40
|
},
|
|
38
41
|
"private": false
|
|
39
42
|
}
|