@icedevml/tinypki-client-side-cert-req 0.4.1 → 0.4.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 +21 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,28 +3,35 @@
|
|
|
3
3
|
A part of TinyPKI project, with the intention to facilitate higher adoption of mTLS.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
|
-
* Client-side PKCS#10 Certificate Signing Request (CSR) generation using Web Crypto API key pairs (RSA/ECDSA/Ed25519);
|
|
6
|
+
* Client-side PKCS#10 Certificate Signing Request (CSR) generation using Web Crypto API key pairs (supported: RSA/ECDSA/Ed25519);
|
|
7
7
|
* Bundling PEM certificate chain and private key together into PKCS#12 container (`.P12` or `.PFX` file);
|
|
8
8
|
|
|
9
9
|
## Installation
|
|
10
10
|
|
|
11
|
-
This library is distributed in two formats
|
|
12
|
-
* ESM library installable from NPM Registry:
|
|
13
|
-
```
|
|
14
|
-
npm install --save @icedevml/tinypki-client-side-cert-req
|
|
15
|
-
# or
|
|
16
|
-
yarn add @icedevml/tinypki-client-side-cert-req
|
|
17
|
-
```
|
|
18
|
-
* Single-file JavaScript bundle (approx 500 kB) suitable for including on any HTML5 web page without any external
|
|
19
|
-
dependencies (see [GitHub Releases](https://github.com/icedevml/tinypki-client-side-cert-req/releases) for pre-built files)
|
|
11
|
+
This library is distributed in two formats.
|
|
20
12
|
|
|
21
|
-
|
|
13
|
+
### ESM library
|
|
14
|
+
Suitable for SPA frameworks (like React.js), available on npmjs.com:
|
|
22
15
|
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
yarn
|
|
16
|
+
```bash
|
|
17
|
+
npm install --save @icedevml/tinypki-client-side-cert-req
|
|
18
|
+
yarn add @icedevml/tinypki-client-side-cert-req
|
|
26
19
|
```
|
|
27
20
|
|
|
21
|
+
### Single-file JavaScript bundle
|
|
22
|
+
Suitable for usage on classic HTML5 web pages, without requiring any external dependencies.
|
|
23
|
+
The entire bundle is approximately 500 kB.
|
|
24
|
+
|
|
25
|
+
Download: **[tinypki-client-side-cert-req-lib.js](https://github.com/icedevml/tinypki-client-side-cert-req/releases)**
|
|
26
|
+
|
|
28
27
|
## Usage
|
|
29
28
|
|
|
30
29
|
See `demo/` directory for example usage.
|
|
30
|
+
|
|
31
|
+
## Manual building
|
|
32
|
+
|
|
33
|
+
After cloning the repository, run the following commands:
|
|
34
|
+
```
|
|
35
|
+
yarn
|
|
36
|
+
yarn build
|
|
37
|
+
```
|