Promise.<buffer>Generate a private ECDSA key
+bufferGet a public key derived from a RSA or ECDSA key
+stringParse body of PEM encoded object and return a Base64URL string +If multiple objects are chained, the first body will be returned
+objectRead domains from a Certificate Signing Request
+objectRead information from a certificate +If multiple certificates are chained, the first will be read
+Promise.<Array.<buffer>>Create a Certificate Signing Request
+Promise.<Array.<buffer>>Create a self-signed ALPN certificate for TLS-ALPN-01 challenges
+ +booleanValidate that a ALPN certificate contains the expected key authorization
+Alias of createPrivateRsaKey()
Promise.<buffer>Generate a private ECDSA key
-bufferGet a public key derived from a RSA or ECDSA key
-objectGet a JSON Web Key derived from a RSA or ECDSA key
@@ -28,27 +54,6 @@Array.<string>Split chain of PEM encoded objects from string into array
stringParse body of PEM encoded object and return a Base64URL string -If multiple objects are chained, the first body will be returned
-objectRead domains from a Certificate Signing Request
-objectRead information from a certificate -If multiple certificates are chained, the first will be read
-Promise.<Array.<buffer>>Create a Certificate Signing Request
-Promise.<Array.<buffer>>Create a self-signed ALPN certificate for TLS-ALPN-01 challenges
- -booleanValidate that a ALPN certificate contains the expected key authorization
-Promise.<buffer>
-Generate a private RSA key
-
-**Kind**: global function
-**Returns**: Promise.<buffer> - PEM encoded private RSA key
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [modulusLength] | number | 2048 | Size of the keys modulus in bits, default: `2048` |
-
-**Example**
-Generate private RSA key
-```js
-const privateKey = await acme.crypto.createPrivateRsaKey();
-```
-**Example**
-Private RSA key with modulus size 4096
-```js
-const privateKey = await acme.crypto.createPrivateRsaKey(4096);
-```
-
-
-## createPrivateKey()
-Alias of `createPrivateRsaKey()`
-
-**Kind**: global function
-## createPrivateEcdsaKey([namedCurve]) ⇒ Promise.<buffer>
+## createPrivateEcdsaKey ⇒ Promise.<buffer>
Generate a private ECDSA key
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<buffer> - PEM encoded private ECDSA key
| Param | Type | Description |
@@ -109,10 +86,10 @@ const privateKey = await acme.crypto.createPrivateEcdsaKey('P-384');
```
-## getPublicKey(keyPem) ⇒ buffer
+## getPublicKey ⇒ buffer
Get a public key derived from a RSA or ECDSA key
-**Kind**: global function
+**Kind**: global constant
**Returns**: buffer - PEM encoded public key
| Param | Type | Description |
@@ -124,44 +101,13 @@ Get public key
```js
const publicKey = acme.crypto.getPublicKey(privateKey);
```
-
-
-## getJwk(keyPem) ⇒ object
-Get a JSON Web Key derived from a RSA or ECDSA key
-
-https://datatracker.ietf.org/doc/html/rfc7517
-
-**Kind**: global function
-**Returns**: object - JSON Web Key
-
-| Param | Type | Description |
-| --- | --- | --- |
-| keyPem | buffer \| string | PEM encoded private or public key |
-
-**Example**
-Get JWK
-```js
-const jwk = acme.crypto.getJwk(privateKey);
-```
-
-
-## splitPemChain(chainPem) ⇒ Array.<string>
-Split chain of PEM encoded objects from string into array
-
-**Kind**: global function
-**Returns**: Array.<string> - Array of PEM objects including headers
-
-| Param | Type | Description |
-| --- | --- | --- |
-| chainPem | buffer \| string | PEM encoded object chain |
-
-## getPemBodyAsB64u(pem) ⇒ string
+## getPemBodyAsB64u ⇒ string
Parse body of PEM encoded object and return a Base64URL string
If multiple objects are chained, the first body will be returned
-**Kind**: global function
+**Kind**: global constant
**Returns**: string - Base64URL-encoded body
| Param | Type | Description |
@@ -170,10 +116,10 @@ If multiple objects are chained, the first body will be returned
-## readCsrDomains(csrPem) ⇒ object
+## readCsrDomains ⇒ object
Read domains from a Certificate Signing Request
-**Kind**: global function
+**Kind**: global constant
**Returns**: object - {commonName, altNames}
| Param | Type | Description |
@@ -190,11 +136,11 @@ console.log(`Alt names: ${altNames.join(', ')}`);
```
-## readCertificateInfo(certPem) ⇒ object
+## readCertificateInfo ⇒ object
Read information from a certificate
If multiple certificates are chained, the first will be read
-**Kind**: global function
+**Kind**: global constant
**Returns**: object - Certificate info
| Param | Type | Description |
@@ -215,10 +161,10 @@ console.log(`Alt names: ${altNames.join(', ')}`);
```
-## createCsr(data, [keyPem]) ⇒ Promise.<Array.<buffer>>
+## createCsr ⇒ Promise.<Array.<buffer>>
Create a Certificate Signing Request
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<Array.<buffer>> - [privateKey, certificateSigningRequest]
| Param | Type | Description |
@@ -276,12 +222,12 @@ const [, certificateRequest] = await acme.crypto.createCsr({
```
-## createAlpnCertificate(authz, keyAuthorization, [keyPem]) ⇒ Promise.<Array.<buffer>>
+## createAlpnCertificate ⇒ Promise.<Array.<buffer>>
Create a self-signed ALPN certificate for TLS-ALPN-01 challenges
https://datatracker.ietf.org/doc/html/rfc8737
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<Array.<buffer>> - [privateKey, certificate]
| Param | Type | Description |
@@ -303,10 +249,10 @@ const [, alpnCertificate] = await acme.crypto.createAlpnCertificate(authz, keyAu
```
-## isAlpnCertificateAuthorizationValid(certPem, keyAuthorization) ⇒ boolean
+## isAlpnCertificateAuthorizationValid ⇒ boolean
Validate that a ALPN certificate contains the expected key authorization
-**Kind**: global function
+**Kind**: global constant
**Returns**: boolean - True when valid
| Param | Type | Description |
@@ -314,3 +260,62 @@ Validate that a ALPN certificate contains the expected key authorization
| certPem | buffer \| string | PEM encoded certificate |
| keyAuthorization | string | Expected challenge key authorization |
+
+
+## createPrivateRsaKey([modulusLength]) ⇒ Promise.<buffer>
+Generate a private RSA key
+
+**Kind**: global function
+**Returns**: Promise.<buffer> - PEM encoded private RSA key
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [modulusLength] | number | Size of the keys modulus in bits, default: `2048` |
+
+**Example**
+Generate private RSA key
+```js
+const privateKey = await acme.crypto.createPrivateRsaKey();
+```
+**Example**
+Private RSA key with modulus size 4096
+```js
+const privateKey = await acme.crypto.createPrivateRsaKey(4096);
+```
+
+
+## createPrivateKey()
+Alias of `createPrivateRsaKey()`
+
+**Kind**: global function
+
+
+## getJwk(keyPem) ⇒ object
+Get a JSON Web Key derived from a RSA or ECDSA key
+
+https://datatracker.ietf.org/doc/html/rfc7517
+
+**Kind**: global function
+**Returns**: object - JSON Web Key
+
+| Param | Type | Description |
+| --- | --- | --- |
+| keyPem | buffer \| string | PEM encoded private or public key |
+
+**Example**
+Get JWK
+```js
+const jwk = acme.crypto.getJwk(privateKey);
+```
+
+
+## splitPemChain(chainPem) ⇒ Array.<string>
+Split chain of PEM encoded objects from string into array
+
+**Kind**: global function
+**Returns**: Array.<string> - Array of PEM objects including headers
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chainPem | buffer \| string | PEM encoded object chain |
+
diff --git a/packages/core/acme-client/docs/forge.md b/packages/core/acme-client/docs/forge.md
index 65dcab8f..799cc0e1 100644
--- a/packages/core/acme-client/docs/forge.md
+++ b/packages/core/acme-client/docs/forge.md
@@ -8,37 +8,42 @@ major release. Please migrate to the new acme.crypto interface at y
+## Constants
+
+Promise.<buffer>Create public key from a private RSA key
+stringParse body of PEM encoded object from buffer or string +If multiple objects are chained, the first body will be returned
+Array.<string>Split chain of PEM encoded objects from buffer or string into array
+Promise.<buffer>Get modulus
+Promise.<buffer>Get public exponent
+Promise.<object>Read domains from a Certificate Signing Request
+Promise.<object>Read information from a certificate
+Promise.<Array.<buffer>>Create a Certificate Signing Request
+Promise.<buffer>Generate a private RSA key
Promise.<buffer>Create public key from a private RSA key
-stringParse body of PEM encoded object from buffer or string -If multiple objects are chained, the first body will be returned
-Array.<string>Split chain of PEM encoded objects from buffer or string into array
-Promise.<buffer>Get modulus
-Promise.<buffer>Get public exponent
-Promise.<object>Read domains from a Certificate Signing Request
-Promise.<object>Read information from a certificate
-Promise.<Array.<buffer>>Create a Certificate Signing Request
-Promise.<buffer>
-Generate a private RSA key
-
-**Kind**: global function
-**Returns**: Promise.<buffer> - PEM encoded private RSA key
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [size] | number | 2048 | Size of the key, default: `2048` |
-
-**Example**
-Generate private RSA key
-```js
-const privateKey = await acme.forge.createPrivateKey();
-```
-**Example**
-Private RSA key with defined size
-```js
-const privateKey = await acme.forge.createPrivateKey(4096);
-```
-## createPublicKey(key) ⇒ Promise.<buffer>
+## createPublicKey ⇒ Promise.<buffer>
Create public key from a private RSA key
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<buffer> - PEM encoded public RSA key
| Param | Type | Description |
@@ -91,11 +74,11 @@ const publicKey = await acme.forge.createPublicKey(privateKey);
```
-## getPemBody(str) ⇒ string
+## getPemBody ⇒ string
Parse body of PEM encoded object from buffer or string
If multiple objects are chained, the first body will be returned
-**Kind**: global function
+**Kind**: global constant
**Returns**: string - PEM body
| Param | Type | Description |
@@ -104,10 +87,10 @@ If multiple objects are chained, the first body will be returned
-## splitPemChain(str) ⇒ Array.<string>
+## splitPemChain ⇒ Array.<string>
Split chain of PEM encoded objects from buffer or string into array
-**Kind**: global function
+**Kind**: global constant
**Returns**: Array.<string> - Array of PEM bodies
| Param | Type | Description |
@@ -116,10 +99,10 @@ Split chain of PEM encoded objects from buffer or string into array
-## getModulus(input) ⇒ Promise.<buffer>
+## getModulus ⇒ Promise.<buffer>
Get modulus
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<buffer> - Modulus
| Param | Type | Description |
@@ -135,10 +118,10 @@ const m3 = await acme.forge.getModulus(certificateRequest);
```
-## getPublicExponent(input) ⇒ Promise.<buffer>
+## getPublicExponent ⇒ Promise.<buffer>
Get public exponent
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<buffer> - Exponent
| Param | Type | Description |
@@ -154,10 +137,10 @@ const e3 = await acme.forge.getPublicExponent(certificateRequest);
```
-## readCsrDomains(csr) ⇒ Promise.<object>
+## readCsrDomains ⇒ Promise.<object>
Read domains from a Certificate Signing Request
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<object> - {commonName, altNames}
| Param | Type | Description |
@@ -174,10 +157,10 @@ console.log(`Alt names: ${altNames.join(', ')}`);
```
-## readCertificateInfo(cert) ⇒ Promise.<object>
+## readCertificateInfo ⇒ Promise.<object>
Read information from a certificate
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<object> - Certificate info
| Param | Type | Description |
@@ -198,10 +181,10 @@ console.log(`Alt names: ${altNames.join(', ')}`);
```
-## createCsr(data, [key]) ⇒ Promise.<Array.<buffer>>
+## createCsr ⇒ Promise.<Array.<buffer>>
Create a Certificate Signing Request
-**Kind**: global function
+**Kind**: global constant
**Returns**: Promise.<Array.<buffer>> - [privateKey, certificateSigningRequest]
| Param | Type | Description |
@@ -256,3 +239,25 @@ const certificateKey = await acme.forge.createPrivateKey();
const [, certificateRequest] = await acme.forge.createCsr({
altNames: ['test.example.com'],
}, certificateKey);
+
+
+## createPrivateKey([size]) ⇒ Promise.<buffer>
+Generate a private RSA key
+
+**Kind**: global function
+**Returns**: Promise.<buffer> - PEM encoded private RSA key
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [size] | number | Size of the key, default: `2048` |
+
+**Example**
+Generate private RSA key
+```js
+const privateKey = await acme.forge.createPrivateKey();
+```
+**Example**
+Private RSA key with defined size
+```js
+const privateKey = await acme.forge.createPrivateKey(4096);
+```
diff --git a/packages/core/acme-client/package.json b/packages/core/acme-client/package.json
index 51a93b73..b7b17aff 100644
--- a/packages/core/acme-client/package.json
+++ b/packages/core/acme-client/package.json
@@ -3,7 +3,9 @@
"description": "Simple and unopinionated ACME client",
"private": false,
"author": "nmorsman",
- "version": "1.27.0",
+ "version": "1.27.4",
+ "type": "module",
+ "module": "scr/index.js",
"main": "src/index.js",
"types": "types/index.d.ts",
"license": "MIT",
@@ -16,12 +18,14 @@
"types"
],
"dependencies": {
+ "@certd/basic": "^1.27.4",
"@peculiar/x509": "^1.11.0",
"asn1js": "^3.0.5",
"axios": "^1.7.2",
"debug": "^4.3.5",
"http-proxy-agent": "^7.0.2",
"https-proxy-agent": "^7.0.5",
+ "lodash-es": "^4.17.21",
"node-forge": "^1.3.1"
},
"devDependencies": {
@@ -29,14 +33,15 @@
"chai": "^4.4.1",
"chai-as-promised": "^7.1.2",
"eslint": "^8.57.0",
- "eslint-config-airbnb-base": "^15.0.0",
+ "eslint-config-prettier": "^8.5.0",
"eslint-plugin-import": "^2.29.1",
+ "eslint-plugin-prettier": "^4.2.1",
"jsdoc-to-markdown": "^8.0.1",
"mocha": "^10.6.0",
"nock": "^13.5.4",
+ "prettier": "^2.8.8",
"tsd": "^0.31.1",
- "typescript": "^5.4.2",
- "uuid": "^8.3.2"
+ "typescript": "^5.4.2"
},
"scripts": {
"build-docs": "jsdoc2md src/client.js > docs/client.md && jsdoc2md src/crypto/index.js > docs/crypto.md && jsdoc2md src/crypto/forge.js > docs/forge.md",
@@ -60,5 +65,5 @@
"bugs": {
"url": "https://github.com/publishlab/node-acme-client/issues"
},
- "gitHead": "c643d7edc3721a6d2ac701a35ef600f6b6ff4b34"
+ "gitHead": "339554bdbf61c4784614747734a420e744e13bfb"
}
diff --git a/packages/core/acme-client/src/agents.js b/packages/core/acme-client/src/agents.js
deleted file mode 100644
index ab220dff..00000000
--- a/packages/core/acme-client/src/agents.js
+++ /dev/null
@@ -1,104 +0,0 @@
-const nodeHttp = require('node:http');
-const https = require('node:https');
-const { HttpProxyAgent } = require('http-proxy-agent');
-const { HttpsProxyAgent } = require('https-proxy-agent');
-const { log } = require('./logger');
-
-function createAgent(opts = {}) {
- let httpAgent;
- let
- httpsAgent;
- const httpProxy = opts.httpProxy || process.env.HTTP_PROXY || process.env.http_proxy;
- if (httpProxy) {
- log(`acme use httpProxy:${httpProxy}`);
- httpAgent = new HttpProxyAgent(httpProxy, opts);
- }
- else {
- httpAgent = new nodeHttp.Agent(opts);
- }
- const httpsProxy = opts.httpsProxy || process.env.HTTPS_PROXY || process.env.https_proxy;
- if (httpsProxy) {
- log(`acme use httpsProxy:${httpsProxy}`);
- httpsAgent = new HttpsProxyAgent(httpsProxy, opts);
- }
- else {
- httpsAgent = new https.Agent(opts);
- }
- return {
- httpAgent,
- httpsAgent,
- };
-}
-
-let defaultAgents = createAgent();
-
-function getGlobalAgents() {
- return defaultAgents;
-}
-
-function setGlobalProxy(opts) {
- log('acme setGlobalProxy:', opts);
- defaultAgents = createAgent(opts);
-}
-
-class HttpError extends Error {
- // eslint-disable-next-line constructor-super
- constructor(error) {
- if (!error) {
- return;
- }
- super(error.message);
-
- this.message = error.message;
- if (this.message && this.message.indexOf('ssl3_get_record:wrong version number') >= 0) {
- this.message = 'http协议错误，服务端要求http协议，请检查是否使用了https请求';
- }
-
- this.name = error.name;
- this.code = error.code;
-
- if (error.response) {
- this.status = error.response.status;
- this.statusText = error.response.statusText;
- this.response = {
- data: error.response.data,
- };
- if (!this.message) {
- this.message = this.statusText;
- }
- }
-
- let url = '';
- if (error.config) {
- this.request = {
- baseURL: error.config.baseURL,
- url: error.config.url,
- method: error.config.method,
- params: error.config.params,
- data: error.config.data,
- };
- url = (error.config.baseURL || '') + error.config.url;
- }
- if (url) {
- this.message = `${this.message}:${url}`;
- }
- // const { stack, cause } = error;
- delete this.cause;
- delete this.stack;
- // this.cause = cause;
- // this.stack = stack;
- delete error.stack;
- delete error.cause;
- delete error.response;
- delete error.config;
- delete error.request;
- // logger.error(error);
- }
-}
-
-module.exports = {
- setGlobalProxy,
- createAgent,
- getGlobalAgents,
- HttpError,
-};
diff --git a/packages/core/acme-client/src/api.js b/packages/core/acme-client/src/api.js
index 70e21b5b..f3035de6 100644
--- a/packages/core/acme-client/src/api.js
+++ b/packages/core/acme-client/src/api.js
@@ -1,9 +1,7 @@
/**
* ACME API client
*/
-
-const util = require('./util');
-const { log } = require('./logger');
+import * as util from './util.js';
/**
* AcmeApi
@@ -248,4 +246,4 @@ class AcmeApi {
}
/* Export API */
-module.exports = AcmeApi;
+export default AcmeApi;
diff --git a/packages/core/acme-client/src/auto.js b/packages/core/acme-client/src/auto.js
index 7e192616..06b49277 100644
--- a/packages/core/acme-client/src/auto.js
+++ b/packages/core/acme-client/src/auto.js
@@ -1,11 +1,11 @@
/**
* ACME auto helper
*/
+import { readCsrDomains } from './crypto/index.js';
+import { log } from './logger.js';
+import { wait } from './wait.js';
+import { CancelError } from './error.js';
-const { readCsrDomains } = require('./crypto');
-const { log } = require('./logger');
-const { wait } = require('./wait');
-const { CancelError } = require('./error');
const defaultOpts = {
csr: null,
@@ -30,7 +30,7 @@ const defaultOpts = {
* @returns {Promise