AcmeClient
-objectACME client
-Promise.<(string\|null)>
- * [.getAccountUrl()](#AcmeClient+getAccountUrl) ⇒ string
- * [.createAccount([data])](#AcmeClient+createAccount) ⇒ Promise.<object>
- * [.updateAccount([data])](#AcmeClient+updateAccount) ⇒ Promise.<object>
- * [.updateAccountKey(newAccountKey, [data])](#AcmeClient+updateAccountKey) ⇒ Promise.<object>
- * [.createOrder(data)](#AcmeClient+createOrder) ⇒ Promise.<object>
- * [.getOrder(order)](#AcmeClient+getOrder) ⇒ Promise.<object>
- * [.finalizeOrder(order, csr)](#AcmeClient+finalizeOrder) ⇒ Promise.<object>
- * [.getAuthorizations(order)](#AcmeClient+getAuthorizations) ⇒ Promise.<Array.<object>>
- * [.deactivateAuthorization(authz)](#AcmeClient+deactivateAuthorization) ⇒ Promise.<object>
- * [.getChallengeKeyAuthorization(challenge)](#AcmeClient+getChallengeKeyAuthorization) ⇒ Promise.<string>
- * [.verifyChallenge(authz, challenge)](#AcmeClient+verifyChallenge) ⇒ Promise
- * [.completeChallenge(challenge)](#AcmeClient+completeChallenge) ⇒ Promise.<object>
- * [.waitForValidStatus(item)](#AcmeClient+waitForValidStatus) ⇒ Promise.<object>
- * [.getCertificate(order, [preferredChain])](#AcmeClient+getCertificate) ⇒ Promise.<string>
- * [.revokeCertificate(cert, [data])](#AcmeClient+revokeCertificate) ⇒ Promise
- * [.auto(opts)](#AcmeClient+auto) ⇒ Promise.<string>
-
-
-
-### new AcmeClient(opts)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| opts | object | |
-| opts.directoryUrl | string | ACME directory URL |
-| opts.accountKey | buffer \| string | PEM encoded account private key |
-| [opts.accountUrl] | string | Account URL, default: `null` |
-| [opts.externalAccountBinding] | object | |
-| [opts.externalAccountBinding.kid] | string | External account binding KID |
-| [opts.externalAccountBinding.hmacKey] | string | External account binding HMAC key |
-| [opts.backoffAttempts] | number | Maximum number of backoff attempts, default: `10` |
-| [opts.backoffMin] | number | Minimum backoff attempt delay in milliseconds, default: `5000` |
-| [opts.backoffMax] | number | Maximum backoff attempt delay in milliseconds, default: `30000` |
-
-**Example**
-Create ACME client instance
-```js
-const client = new acme.Client({
- directoryUrl: acme.directory.letsencrypt.staging,
- accountKey: 'Private key goes here',
-});
-```
-**Example**
-Create ACME client instance
-```js
-const client = new acme.Client({
- directoryUrl: acme.directory.letsencrypt.staging,
- accountKey: 'Private key goes here',
- accountUrl: 'Optional account URL goes here',
- backoffAttempts: 10,
- backoffMin: 5000,
- backoffMax: 30000,
-});
-```
-**Example**
-Create ACME client with external account binding
-```js
-const client = new acme.Client({
- directoryUrl: 'https://acme-provider.example.com/directory-url',
- accountKey: 'Private key goes here',
- externalAccountBinding: {
- kid: 'YOUR-EAB-KID',
- hmacKey: 'YOUR-EAB-HMAC-KEY',
- },
-});
-```
-
-
-### acmeClient.getTermsOfServiceUrl() ⇒ Promise.<(string\|null)>
-Get Terms of Service URL if available
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<(string\|null)> - ToS URL
-**Example**
-Get Terms of Service URL
-```js
-const termsOfService = client.getTermsOfServiceUrl();
-
-if (!termsOfService) {
- // CA did not provide Terms of Service
-}
-```
-
-
-### acmeClient.getAccountUrl() ⇒ string
-Get current account URL
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: string - Account URL
-**Throws**:
-
-- Error No account URL found
-
-**Example**
-Get current account URL
-```js
-try {
- const accountUrl = client.getAccountUrl();
-}
-catch (e) {
- // No account URL exists, need to create account first
-}
-```
-
-
-### acmeClient.createAccount([data]) ⇒ Promise.<object>
-Create a new account
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.3
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Account
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [data] | object | Request data |
-
-**Example**
-Create a new account
-```js
-const account = await client.createAccount({
- termsOfServiceAgreed: true,
-});
-```
-**Example**
-Create a new account with contact info
-```js
-const account = await client.createAccount({
- termsOfServiceAgreed: true,
- contact: ['mailto:test@example.com'],
-});
-```
-
-
-### acmeClient.updateAccount([data]) ⇒ Promise.<object>
-Update existing account
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.3.2
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Account
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [data] | object | Request data |
-
-**Example**
-Update existing account
-```js
-const account = await client.updateAccount({
- contact: ['mailto:foo@example.com'],
-});
-```
-
-
-### acmeClient.updateAccountKey(newAccountKey, [data]) ⇒ Promise.<object>
-Update account private key
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.3.5
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Account
-
-| Param | Type | Description |
-| --- | --- | --- |
-| newAccountKey | buffer \| string | New PEM encoded private key |
-| [data] | object | Additional request data |
-
-**Example**
-Update account private key
-```js
-const newAccountKey = 'New private key goes here';
-const result = await client.updateAccountKey(newAccountKey);
-```
-
-
-### acmeClient.createOrder(data) ⇒ Promise.<object>
-Create a new order
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.4
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Order
-
-| Param | Type | Description |
-| --- | --- | --- |
-| data | object | Request data |
-
-**Example**
-Create a new order
-```js
-const order = await client.createOrder({
- identifiers: [
- { type: 'dns', value: 'example.com' },
- { type: 'dns', value: 'test.example.com' },
- ],
-});
-```
-
-
-### acmeClient.getOrder(order) ⇒ Promise.<object>
-Refresh order object from CA
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.4
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Order
-
-| Param | Type | Description |
-| --- | --- | --- |
-| order | object | Order object |
-
-**Example**
-```js
-const order = { ... }; // Previously created order object
-const result = await client.getOrder(order);
-```
-
-
-### acmeClient.finalizeOrder(order, csr) ⇒ Promise.<object>
-Finalize order
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.4
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Order
-
-| Param | Type | Description |
-| --- | --- | --- |
-| order | object | Order object |
-| csr | buffer \| string | PEM encoded Certificate Signing Request |
-
-**Example**
-Finalize order
-```js
-const order = { ... }; // Previously created order object
-const csr = { ... }; // Previously created Certificate Signing Request
-const result = await client.finalizeOrder(order, csr);
-```
-
-
-### acmeClient.getAuthorizations(order) ⇒ Promise.<Array.<object>>
-Get identifier authorizations from order
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.5
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<Array.<object>> - Authorizations
-
-| Param | Type | Description |
-| --- | --- | --- |
-| order | object | Order |
-
-**Example**
-Get identifier authorizations
-```js
-const order = { ... }; // Previously created order object
-const authorizations = await client.getAuthorizations(order);
-
-authorizations.forEach((authz) => {
- const { challenges } = authz;
-});
-```
-
-
-### acmeClient.deactivateAuthorization(authz) ⇒ Promise.<object>
-Deactivate identifier authorization
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.5.2
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Authorization
-
-| Param | Type | Description |
-| --- | --- | --- |
-| authz | object | Identifier authorization |
-
-**Example**
-Deactivate identifier authorization
-```js
-const authz = { ... }; // Identifier authorization resolved from previously created order
-const result = await client.deactivateAuthorization(authz);
-```
-
-
-### acmeClient.getChallengeKeyAuthorization(challenge) ⇒ Promise.<string>
-Get key authorization for ACME challenge
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-8.1
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<string> - Key authorization
-
-| Param | Type | Description |
-| --- | --- | --- |
-| challenge | object | Challenge object returned by API |
-
-**Example**
-Get challenge key authorization
-```js
-const challenge = { ... }; // Challenge from previously resolved identifier authorization
-const key = await client.getChallengeKeyAuthorization(challenge);
-
-// Write key somewhere to satisfy challenge
-```
-
-
-### acmeClient.verifyChallenge(authz, challenge) ⇒ Promise
-Verify that ACME challenge is satisfied
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| authz | object | Identifier authorization |
-| challenge | object | Authorization challenge |
-
-**Example**
-Verify satisfied ACME challenge
-```js
-const authz = { ... }; // Identifier authorization
-const challenge = { ... }; // Satisfied challenge
-await client.verifyChallenge(authz, challenge);
-```
-
-
-### acmeClient.completeChallenge(challenge) ⇒ Promise.<object>
-Notify CA that challenge has been completed
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.5.1
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Challenge
-
-| Param | Type | Description |
-| --- | --- | --- |
-| challenge | object | Challenge object returned by API |
-
-**Example**
-Notify CA that challenge has been completed
-```js
-const challenge = { ... }; // Satisfied challenge
-const result = await client.completeChallenge(challenge);
-```
-
-
-### acmeClient.waitForValidStatus(item) ⇒ Promise.<object>
-Wait for ACME provider to verify status on a order, authorization or challenge
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.5.1
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<object> - Valid order, authorization or challenge
-
-| Param | Type | Description |
-| --- | --- | --- |
-| item | object | An order, authorization or challenge object |
-
-**Example**
-Wait for valid challenge status
-```js
-const challenge = { ... };
-await client.waitForValidStatus(challenge);
-```
-**Example**
-Wait for valid authorization status
-```js
-const authz = { ... };
-await client.waitForValidStatus(authz);
-```
-**Example**
-Wait for valid order status
-```js
-const order = { ... };
-await client.waitForValidStatus(order);
-```
-
-
-### acmeClient.getCertificate(order, [preferredChain]) ⇒ Promise.<string>
-Get certificate from ACME order
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.4.2
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<string> - Certificate
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| order | object | | Order object |
-| [preferredChain] | string | null | Indicate which certificate chain is preferred if a CA offers multiple, by exact issuer common name, default: `null` |
-
-**Example**
-Get certificate
-```js
-const order = { ... }; // Previously created order
-const certificate = await client.getCertificate(order);
-```
-**Example**
-Get certificate with preferred chain
-```js
-const order = { ... }; // Previously created order
-const certificate = await client.getCertificate(order, 'DST Root CA X3');
-```
-
-
-### acmeClient.revokeCertificate(cert, [data]) ⇒ Promise
-Revoke certificate
-
-https://datatracker.ietf.org/doc/html/rfc8555#section-7.6
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| cert | buffer \| string | PEM encoded certificate |
-| [data] | object | Additional request data |
-
-**Example**
-Revoke certificate
-```js
-const certificate = { ... }; // Previously created certificate
-const result = await client.revokeCertificate(certificate);
-```
-**Example**
-Revoke certificate with reason
-```js
-const certificate = { ... }; // Previously created certificate
-const result = await client.revokeCertificate(certificate, {
- reason: 4,
-});
-```
-
-
-### acmeClient.auto(opts) ⇒ Promise.<string>
-Auto mode
-
-**Kind**: instance method of [AcmeClient](#AcmeClient)
-**Returns**: Promise.<string> - Certificate
-
-| Param | Type | Description |
-| --- | --- | --- |
-| opts | object | |
-| opts.csr | buffer \| string | Certificate Signing Request |
-| opts.challengeCreateFn | function | Function returning Promise triggered before completing ACME challenge |
-| opts.challengeRemoveFn | function | Function returning Promise triggered after completing ACME challenge |
-| [opts.email] | string | Account email address |
-| [opts.termsOfServiceAgreed] | boolean | Agree to Terms of Service, default: `false` |
-| [opts.skipChallengeVerification] | boolean | Skip internal challenge verification before notifying ACME provider, default: `false` |
-| [opts.challengePriority] | Array.<string> | Array defining challenge type priority, default: `['http-01', 'dns-01']` |
-| [opts.preferredChain] | string | Indicate which certificate chain is preferred if a CA offers multiple, by exact issuer common name, default: `null` |
-
-**Example**
-Order a certificate using auto mode
-```js
-const [certificateKey, certificateRequest] = await acme.crypto.createCsr({
- altNames: ['test.example.com'],
-});
-
-const certificate = await client.auto({
- csr: certificateRequest,
- email: 'test@example.com',
- termsOfServiceAgreed: true,
- challengeCreateFn: async (authz, challenge, keyAuthorization) => {
- // Satisfy challenge here
- },
- challengeRemoveFn: async (authz, challenge, keyAuthorization) => {
- // Clean up challenge here
- },
-});
-```
-**Example**
-Order a certificate using auto mode with preferred chain
-```js
-const [certificateKey, certificateRequest] = await acme.crypto.createCsr({
- altNames: ['test.example.com'],
-});
-
-const certificate = await client.auto({
- csr: certificateRequest,
- email: 'test@example.com',
- termsOfServiceAgreed: true,
- preferredChain: 'DST Root CA X3',
- challengeCreateFn: async () => {},
- challengeRemoveFn: async () => {},
-});
-```
-
-
-## Client : object
-ACME client
-
-**Kind**: global namespace
diff --git a/packages/core/acme-client/package.json b/packages/core/acme-client/package.json
index 15c4afb7d..6770b712d 100644
--- a/packages/core/acme-client/package.json
+++ b/packages/core/acme-client/package.json
@@ -50,10 +50,9 @@
"scripts": {
"before-build": "node -e \"const fs=require('fs');fs.rmSync('dist',{recursive:true,force:true});fs.rmSync('tsconfig.tsbuildinfo',{force:true});\"",
"build": "npm run before-build && tsc -p tsconfig.build.json --skipLibCheck",
- "build-docs": "jsdoc2md dist/client.js > docs/client.md && jsdoc2md dist/crypto/index.js > docs/crypto.md && jsdoc2md dist/crypto/forge.js > docs/forge.md",
"lint": "eslint \"src/**/*.ts\" \"types/**/*.ts\"",
"lint-types": "tsd --files \"types/index.test-d.ts\"",
- "prepublishOnly": "npm run build && npm run build-docs",
+ "prepublishOnly": "npm run build",
"test": "mocha -t 60000 \"test/setup.js\" \"test/**/*.spec.js\"",
"before-test:unit": "node -e \"const fs=require('fs');fs.rmSync('dist-test',{recursive:true,force:true});fs.rmSync('tsconfig.test.tsbuildinfo',{force:true});\"",
"test:unit": "cross-env NODE_ENV=unittest npm run before-test:unit && cross-env NODE_ENV=unittest tsc -p tsconfig.test.json --skipLibCheck && cross-env NODE_ENV=unittest mocha -t 60000 \"dist-test/**/*.test.js\"",
@@ -76,5 +75,5 @@
"bugs": {
"url": "https://github.com/publishlab/node-acme-client/issues"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/core/basic/package.json b/packages/core/basic/package.json
index 339348660..53a3c38dd 100644
--- a/packages/core/basic/package.json
+++ b/packages/core/basic/package.json
@@ -54,5 +54,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/core/pipeline/package.json b/packages/core/pipeline/package.json
index 12633be94..49166b6b5 100644
--- a/packages/core/pipeline/package.json
+++ b/packages/core/pipeline/package.json
@@ -51,5 +51,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/lib-huawei/package.json b/packages/libs/lib-huawei/package.json
index e586b9c0d..d7fd2cc63 100644
--- a/packages/libs/lib-huawei/package.json
+++ b/packages/libs/lib-huawei/package.json
@@ -30,5 +30,5 @@
"prettier": "3.3.3",
"tslib": "^2.8.1"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/lib-iframe/package.json b/packages/libs/lib-iframe/package.json
index c39a53447..e2b703232 100644
--- a/packages/libs/lib-iframe/package.json
+++ b/packages/libs/lib-iframe/package.json
@@ -37,5 +37,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/lib-jdcloud/package.json b/packages/libs/lib-jdcloud/package.json
index 1c42d5be8..5ddb04716 100644
--- a/packages/libs/lib-jdcloud/package.json
+++ b/packages/libs/lib-jdcloud/package.json
@@ -62,5 +62,5 @@
"fetch"
]
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/lib-k8s/package.json b/packages/libs/lib-k8s/package.json
index ae908db54..95cd97771 100644
--- a/packages/libs/lib-k8s/package.json
+++ b/packages/libs/lib-k8s/package.json
@@ -38,5 +38,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/lib-server/package.json b/packages/libs/lib-server/package.json
index 0200eb389..090b53b9b 100644
--- a/packages/libs/lib-server/package.json
+++ b/packages/libs/lib-server/package.json
@@ -69,5 +69,5 @@
"typeorm": "^0.3.20",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/libs/midway-flyway-js/package.json b/packages/libs/midway-flyway-js/package.json
index 7d27adfed..914d9d658 100644
--- a/packages/libs/midway-flyway-js/package.json
+++ b/packages/libs/midway-flyway-js/package.json
@@ -52,5 +52,5 @@
"typeorm": "^0.3.20",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/plugins/plugin-cert/package.json b/packages/plugins/plugin-cert/package.json
index 4888d9586..7a4d179d0 100644
--- a/packages/plugins/plugin-cert/package.json
+++ b/packages/plugins/plugin-cert/package.json
@@ -38,5 +38,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}
diff --git a/packages/plugins/plugin-lib/package.json b/packages/plugins/plugin-lib/package.json
index 972cbf4c5..765eb1522 100644
--- a/packages/plugins/plugin-lib/package.json
+++ b/packages/plugins/plugin-lib/package.json
@@ -45,5 +45,5 @@
"tslib": "^2.8.1",
"typescript": "^5.4.2"
},
- "gitHead": "bc731e4fb119787930e816a7d57c808b1b5cd66a"
+ "gitHead": "b46948c0ba67069ebcd2bb71b21b6c289d99f1b8"
}