Compare commits
150 Commits
Author | SHA1 | Date | |
---|---|---|---|
6425e4a93f | |||
55fa1215ae | |||
3769468b01 | |||
6ea919780c | |||
b5afe8e842 | |||
942e444d41 | |||
1ab15c0b72 | |||
f1db9c1c5d | |||
e3974b3bb1 | |||
016b93ea3a | |||
ab870af0bb | |||
8cda69b3c2 | |||
3641d75e2f | |||
fd343c1558 | |||
76650ac199 | |||
d9ba5f20b1 | |||
941923e90f | |||
e38b4c1215 | |||
d405bf63a3 | |||
737f5bf5cc | |||
149cdf67bb | |||
c35ff8d711 | |||
f2bd9b65aa | |||
018a25ba6a | |||
3c052df1e7 | |||
17c85eb8b9 | |||
2bcb31e4d6 | |||
70aef3fe7e | |||
734bde4a98 | |||
c7d9a42feb | |||
f20bc72abb | |||
cd2cfce683 | |||
44ab180474 | |||
15557dfdd6 | |||
488f616d34 | |||
e920406ce9 | |||
e044fd81bd | |||
edaccc357d | |||
67f645ad50 | |||
bfeced5f34 | |||
24b9794a18 | |||
a781329a47 | |||
6b5e0a1207 | |||
2455adfbca | |||
a2cf86b62f | |||
7277906851 | |||
9da9ebb01e | |||
f70684b773 | |||
8b19b206a4 | |||
6be2866ddd | |||
ab55d3c91a | |||
c7ee7eb774 | |||
02daa13a2f | |||
28944b1100 | |||
7ec04d6d3d | |||
595d4d8894 | |||
04ed28f7d1 | |||
6c95cec709 | |||
59173b3ca8 | |||
c2036bba90 | |||
83afea95e6 | |||
ac515f5e80 | |||
6abbf58b83 | |||
9c25ecdc02 | |||
81a15da2d0 | |||
86929251ba | |||
1d8fb2b296 | |||
9d5f0d7a5d | |||
82b1d68576 | |||
e04b23aceb | |||
8e255938b5 | |||
f2eb9666a7 | |||
cbdb0c8b08 | |||
f821f4d9cc | |||
6cfcf21d95 | |||
a33090bb5e | |||
3151829f85 | |||
eca63e588c | |||
9d23e205d8 | |||
5ecdf7c9fd | |||
2817a65e21 | |||
09a8bc5cb5 | |||
a1134cf227 | |||
4ee1c4b08c | |||
08c3eaa65f | |||
2717f08476 | |||
f16dbeea32 | |||
a0c0230419 | |||
0d1ebf2d1a | |||
6edbf3cb46 | |||
b26f7ac3e9 | |||
5129c5d601 | |||
d09b3fd1bc | |||
14fccd40d8 | |||
c0f45a10e0 | |||
f9db3d28fe | |||
c3fd8750b2 | |||
2b3c28c7a1 | |||
d6b1f942b3 | |||
7eff6ea36a | |||
1ef3615a49 | |||
3653cdc797 | |||
c0271648fc | |||
5546fa5f49 | |||
54fe89860e | |||
d1edf75f6f | |||
6f9c644221 | |||
0b26054687 | |||
e3323ed4ef | |||
24f692636c | |||
a9f709ee7b | |||
1b11b637a5 | |||
ad54bf41ea | |||
060ebf1b29 | |||
a87c6acb8a | |||
62d27619f4 | |||
0faebf2a79 | |||
29ea50796c | |||
26d1b7cbf0 | |||
c0c97835ea | |||
d4d50b7dcf | |||
2492fd4de2 | |||
bef54799b6 | |||
dbe09f320a | |||
18045dadaf | |||
ee300c3e12 | |||
ed4ba0cb61 | |||
a8ab27045d | |||
975c3ed190 | |||
a99dea549b | |||
f8b78c433a | |||
6c33111074 | |||
280335f6f6 | |||
b90092c043 | |||
9e1c73febf | |||
dcf1915816 | |||
748c911168 | |||
3a48cb4ea8 | |||
a035c5c0b0 | |||
f9c521b7b3 | |||
19cfe8bdc5 | |||
601d6b30d3 | |||
57ffc82c43 | |||
312d3c01cd | |||
8814c1fc62 | |||
223a47c997 | |||
651ef6d281 | |||
9eda0da9a7 | |||
3e350dfed5 | |||
6fc280e168 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
19
.gitignore
vendored
19
.gitignore
vendored
@ -1,5 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
pages/
|
||||||
.nogit/
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
@ -1,59 +0,0 @@
|
|||||||
image: hosttoday/ht-docker-node:npmts
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
- trigger
|
|
||||||
- pages
|
|
||||||
|
|
||||||
testLEGACY:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test legacy
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
testLTS:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test lts
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test stable
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
release:
|
|
||||||
stage: release
|
|
||||||
script:
|
|
||||||
- npmci publish
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
stage: trigger
|
|
||||||
script:
|
|
||||||
- npmci trigger
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
pages:
|
|
||||||
image: hosttoday/ht-docker-node:npmpage
|
|
||||||
stage: pages
|
|
||||||
script:
|
|
||||||
- npmci command npmpage --host gitlab
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
artifacts:
|
|
||||||
expire_in: 1 week
|
|
||||||
paths:
|
|
||||||
- public
|
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
29
README.md
29
README.md
@ -1,29 +0,0 @@
|
|||||||
# smartacme
|
|
||||||
acme implementation in TypeScript
|
|
||||||
|
|
||||||
## Availabililty
|
|
||||||
[](https://www.npmjs.com/package/smartacme)
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme)
|
|
||||||
[](https://github.com/umbrellazone/smartacme)
|
|
||||||
[](https://umbrellazone.gitlab.io/smartacme/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/smartacme)
|
|
||||||
[](https://david-dm.org/umbrellazone/smartacme)
|
|
||||||
[](https://www.bithound.io/github/umbrellazone/smartacme/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/umbrellazone/smartacme)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://umbrella.zone)
|
|
1
dist/index.d.ts
vendored
1
dist/index.d.ts
vendored
@ -1 +0,0 @@
|
|||||||
export * from './smartacme.classes.smartacme';
|
|
7
dist/index.js
vendored
7
dist/index.js
vendored
@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
function __export(m) {
|
|
||||||
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
|
|
||||||
}
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
__export(require("./smartacme.classes.smartacme"));
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLG1EQUE2QyJ9
|
|
21
dist/smartacme.classes.acmeaccount.d.ts
vendored
21
dist/smartacme.classes.acmeaccount.d.ts
vendored
@ -1,21 +0,0 @@
|
|||||||
import { SmartAcme } from './smartacme.classes.smartacme';
|
|
||||||
import { AcmeCert } from './smartacme.classes.acmecert';
|
|
||||||
/**
|
|
||||||
* class AcmeAccount represents an AcmeAccount
|
|
||||||
*/
|
|
||||||
export declare class AcmeAccount {
|
|
||||||
parentSmartAcme: SmartAcme;
|
|
||||||
location: string;
|
|
||||||
link: string;
|
|
||||||
JWK: any;
|
|
||||||
constructor(smartAcmeParentArg: SmartAcme);
|
|
||||||
/**
|
|
||||||
* register the account with letsencrypt
|
|
||||||
*/
|
|
||||||
register(): Promise<{}>;
|
|
||||||
/**
|
|
||||||
* agree to letsencrypr terms of service
|
|
||||||
*/
|
|
||||||
agreeTos(): Promise<{}>;
|
|
||||||
createAcmeCert(domainNameArg: string, countryArg?: string, countryShortArg?: string, city?: string, companyArg?: string, companyShortArg?: string): Promise<AcmeCert>;
|
|
||||||
}
|
|
72
dist/smartacme.classes.acmeaccount.js
vendored
72
dist/smartacme.classes.acmeaccount.js
vendored
@ -1,72 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const q = require("smartq");
|
|
||||||
const smartacme_classes_acmecert_1 = require("./smartacme.classes.acmecert");
|
|
||||||
/**
|
|
||||||
* class AcmeAccount represents an AcmeAccount
|
|
||||||
*/
|
|
||||||
class AcmeAccount {
|
|
||||||
constructor(smartAcmeParentArg) {
|
|
||||||
this.parentSmartAcme = smartAcmeParentArg;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* register the account with letsencrypt
|
|
||||||
*/
|
|
||||||
register() {
|
|
||||||
let done = q.defer();
|
|
||||||
this.parentSmartAcme.rawacmeClient.newReg({
|
|
||||||
contact: ['mailto:domains@lossless.org']
|
|
||||||
}, (err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:');
|
|
||||||
console.log(err);
|
|
||||||
done.reject(err);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this.JWK = res.body.key;
|
|
||||||
this.link = res.headers.link;
|
|
||||||
console.log(this.link);
|
|
||||||
this.location = res.headers.location;
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* agree to letsencrypr terms of service
|
|
||||||
*/
|
|
||||||
agreeTos() {
|
|
||||||
let done = q.defer();
|
|
||||||
let tosPart = this.link.split(',')[1];
|
|
||||||
let tosLinkPortion = tosPart.split(';')[0];
|
|
||||||
let url = tosLinkPortion.split(';')[0].trim().replace(/[<>]/g, '');
|
|
||||||
this.parentSmartAcme.rawacmeClient.post(this.location, { Agreement: url, resource: 'reg' }, (err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err);
|
|
||||||
done.reject(err);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
createAcmeCert(domainNameArg, countryArg = 'Germany', countryShortArg = 'DE', city = 'Bremen', companyArg = 'Some Company', companyShortArg = 'SC') {
|
|
||||||
let done = q.defer();
|
|
||||||
let acmeCert = new smartacme_classes_acmecert_1.AcmeCert({
|
|
||||||
bit: 2064,
|
|
||||||
key: null,
|
|
||||||
domain: domainNameArg,
|
|
||||||
country: countryArg,
|
|
||||||
country_short: countryShortArg,
|
|
||||||
locality: city,
|
|
||||||
organization: companyArg,
|
|
||||||
organization_short: companyShortArg,
|
|
||||||
password: null,
|
|
||||||
unstructured: null,
|
|
||||||
subject_alt_names: null
|
|
||||||
}, this);
|
|
||||||
done.resolve(acmeCert);
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.AcmeAccount = AcmeAccount;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhY21lLmNsYXNzZXMuYWNtZWFjY291bnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFjbWUuY2xhc3Nlcy5hY21lYWNjb3VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDRCQUEyQjtBQU0zQiw2RUFBdUQ7QUFFdkQ7O0dBRUc7QUFDSDtJQUtFLFlBQVksa0JBQTZCO1FBQ3ZDLElBQUksQ0FBQyxlQUFlLEdBQUcsa0JBQWtCLENBQUE7SUFDM0MsQ0FBQztJQUVEOztPQUVHO0lBQ0gsUUFBUTtRQUNOLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUNwQixJQUFJLENBQUMsZUFBZSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQ3ZDO1lBQ0UsT0FBTyxFQUFFLENBQUUsNkJBQTZCLENBQUU7U0FDM0MsRUFDRCxDQUFDLEdBQUcsRUFBRSxHQUFHO1lBQ1AsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFDUixPQUFPLENBQUMsS0FBSyxDQUFDLGtDQUFrQyxDQUFDLENBQUE7Z0JBQ2pELE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQ2hCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQ2hCLE1BQU0sQ0FBQTtZQUNSLENBQUM7WUFDRCxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFBO1lBQ3ZCLElBQUksQ0FBQyxJQUFJLEdBQUcsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUE7WUFDNUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDdEIsSUFBSSxDQUFDLFFBQVEsR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQTtZQUNwQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDaEIsQ0FBQyxDQUFDLENBQUE7UUFDSixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0lBRUQ7O09BRUc7SUFDSCxRQUFRO1FBQ04sSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQ3BCLElBQUksT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFFLENBQUMsQ0FBRSxDQUFBO1FBQ3ZDLElBQUksY0FBYyxHQUFHLE9BQU8sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUUsQ0FBQyxDQUFFLENBQUE7UUFDNUMsSUFBSSxHQUFHLEdBQUcsY0FBYyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBRSxDQUFDLENBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQyxDQUFBO1FBQ3BFLElBQUksQ0FBQyxlQUFlLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLEVBQUUsU0FBUyxFQUFFLEdBQUcsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRztZQUNuRyxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO2dCQUNSLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQ2hCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQ2hCLE1BQU0sQ0FBQTtZQUNSLENBQUM7WUFDRCxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDaEIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0lBRUQsY0FBYyxDQUNaLGFBQXFCLEVBQ3JCLFVBQVUsR0FBRyxTQUFTLEVBQ3RCLGVBQWUsR0FBRyxJQUFJLEVBQ3RCLElBQUksR0FBRyxRQUFRLEVBQ2YsVUFBVSxHQUFHLGNBQWMsRUFDM0IsZUFBZSxHQUFHLElBQUk7UUFHdEIsSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBWSxDQUFBO1FBQzlCLElBQUksUUFBUSxHQUFHLElBQUkscUNBQVEsQ0FDekI7WUFDRSxHQUFHLEVBQUUsSUFBSTtZQUNULEdBQUcsRUFBRSxJQUFJO1lBQ1QsTUFBTSxFQUFFLGFBQWE7WUFDckIsT0FBTyxFQUFFLFVBQVU7WUFDbkIsYUFBYSxFQUFFLGVBQWU7WUFDOUIsUUFBUSxFQUFFLElBQUk7WUFDZCxZQUFZLEVBQUUsVUFBVTtZQUN4QixrQkFBa0IsRUFBRSxlQUFlO1lBQ25DLFFBQVEsRUFBRSxJQUFJO1lBQ2QsWUFBWSxFQUFFLElBQUk7WUFDbEIsaUJBQWlCLEVBQUUsSUFBSTtTQUN4QixFQUNELElBQUksQ0FDTCxDQUFBO1FBQ0QsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUN0QixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0NBQ0Y7QUFsRkQsa0NBa0ZDIn0=
|
|
78
dist/smartacme.classes.acmecert.d.ts
vendored
78
dist/smartacme.classes.acmecert.d.ts
vendored
@ -1,78 +0,0 @@
|
|||||||
import { IRsaKeypair } from './smartacme.classes.smartacme';
|
|
||||||
import { AcmeAccount } from './smartacme.classes.acmeaccount';
|
|
||||||
/**
|
|
||||||
* types of challenges supported by letsencrypt and this module
|
|
||||||
*/
|
|
||||||
export declare type TChallengeType = 'dns-01' | 'http-01';
|
|
||||||
/**
|
|
||||||
* values that a challenge's status can have
|
|
||||||
*/
|
|
||||||
export declare type TChallengeStatus = 'pending';
|
|
||||||
export interface ISmartAcmeChallenge {
|
|
||||||
uri: string;
|
|
||||||
status: TChallengeStatus;
|
|
||||||
type: TChallengeType;
|
|
||||||
token: string;
|
|
||||||
keyAuthorization: string;
|
|
||||||
}
|
|
||||||
export interface ISmartAcmeChallengeChosen extends ISmartAcmeChallenge {
|
|
||||||
dnsKeyHash: string;
|
|
||||||
domainName: string;
|
|
||||||
domainNamePrefixed: string;
|
|
||||||
}
|
|
||||||
export interface IAcmeCsrConstructorOptions {
|
|
||||||
bit: number;
|
|
||||||
key: string;
|
|
||||||
domain: string;
|
|
||||||
country: string;
|
|
||||||
country_short: string;
|
|
||||||
locality: string;
|
|
||||||
organization: string;
|
|
||||||
organization_short: string;
|
|
||||||
password: string;
|
|
||||||
unstructured: string;
|
|
||||||
subject_alt_names: string[];
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* class AcmeCert represents a cert for domain
|
|
||||||
*/
|
|
||||||
export declare class AcmeCert {
|
|
||||||
domainName: string;
|
|
||||||
attributes: any;
|
|
||||||
fullchain: string;
|
|
||||||
parentAcmeAccount: AcmeAccount;
|
|
||||||
csr: any;
|
|
||||||
validFrom: Date;
|
|
||||||
validTo: Date;
|
|
||||||
keypair: IRsaKeypair;
|
|
||||||
keyPairFinal: IRsaKeypair;
|
|
||||||
chosenChallenge: ISmartAcmeChallengeChosen;
|
|
||||||
dnsKeyHash: string;
|
|
||||||
constructor(optionsArg: IAcmeCsrConstructorOptions, parentAcmeAccount: AcmeAccount);
|
|
||||||
/**
|
|
||||||
* requests a challenge for a domain
|
|
||||||
* @param domainNameArg - the domain name to request a challenge for
|
|
||||||
* @param challengeType - the challenge type to request
|
|
||||||
*/
|
|
||||||
requestChallenge(challengeTypeArg?: TChallengeType): Promise<ISmartAcmeChallengeChosen>;
|
|
||||||
/**
|
|
||||||
* checks if DNS records are set, will go through a max of 30 cycles
|
|
||||||
*/
|
|
||||||
checkDns(cycleArg?: number): Promise<void>;
|
|
||||||
/**
|
|
||||||
* validates a challenge, only call after you have set the challenge at the expected location
|
|
||||||
*/
|
|
||||||
requestValidation(): Promise<void>;
|
|
||||||
/**
|
|
||||||
* requests a certificate
|
|
||||||
*/
|
|
||||||
requestCert(): Promise<{}>;
|
|
||||||
/**
|
|
||||||
* getCertificate - takes care of cooldown, validation polling and certificate retrieval
|
|
||||||
*/
|
|
||||||
getCertificate(): void;
|
|
||||||
/**
|
|
||||||
* accept a challenge - for private use only
|
|
||||||
*/
|
|
||||||
acceptChallenge(): Promise<{}>;
|
|
||||||
}
|
|
183
dist/smartacme.classes.acmecert.js
vendored
183
dist/smartacme.classes.acmecert.js
vendored
File diff suppressed because one or more lines are too long
32
dist/smartacme.classes.smartacme.d.ts
vendored
32
dist/smartacme.classes.smartacme.d.ts
vendored
@ -1,32 +0,0 @@
|
|||||||
import { AcmeAccount } from './smartacme.classes.acmeaccount';
|
|
||||||
/**
|
|
||||||
* a rsa keypair needed for account creation and subsequent requests
|
|
||||||
*/
|
|
||||||
export interface IRsaKeypair {
|
|
||||||
publicKey: string;
|
|
||||||
privateKey: string;
|
|
||||||
}
|
|
||||||
export { AcmeAccount } from './smartacme.classes.acmeaccount';
|
|
||||||
export { AcmeCert, ISmartAcmeChallenge, ISmartAcmeChallengeChosen } from './smartacme.classes.acmecert';
|
|
||||||
/**
|
|
||||||
* class SmartAcme exports methods for maintaining SSL Certificates
|
|
||||||
*/
|
|
||||||
export declare class SmartAcme {
|
|
||||||
acmeUrl: string;
|
|
||||||
productionBool: boolean;
|
|
||||||
keyPair: IRsaKeypair;
|
|
||||||
rawacmeClient: any;
|
|
||||||
/**
|
|
||||||
* the constructor for class SmartAcme
|
|
||||||
*/
|
|
||||||
constructor(productionArg?: boolean);
|
|
||||||
/**
|
|
||||||
* init the smartacme instance
|
|
||||||
*/
|
|
||||||
init(): Promise<{}>;
|
|
||||||
/**
|
|
||||||
* creates an account if not currently present in module
|
|
||||||
* @executes ASYNC
|
|
||||||
*/
|
|
||||||
createAcmeAccount(): Promise<AcmeAccount>;
|
|
||||||
}
|
|
67
dist/smartacme.classes.smartacme.js
vendored
67
dist/smartacme.classes.smartacme.js
vendored
@ -1,67 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
// third party modules
|
|
||||||
const q = require("smartq"); // promises
|
|
||||||
const plugins = require("./smartacme.plugins");
|
|
||||||
const helpers = require("./smartacme.helpers");
|
|
||||||
const smartacme_classes_acmeaccount_1 = require("./smartacme.classes.acmeaccount");
|
|
||||||
var smartacme_classes_acmeaccount_2 = require("./smartacme.classes.acmeaccount");
|
|
||||||
exports.AcmeAccount = smartacme_classes_acmeaccount_2.AcmeAccount;
|
|
||||||
var smartacme_classes_acmecert_1 = require("./smartacme.classes.acmecert");
|
|
||||||
exports.AcmeCert = smartacme_classes_acmecert_1.AcmeCert;
|
|
||||||
/**
|
|
||||||
* class SmartAcme exports methods for maintaining SSL Certificates
|
|
||||||
*/
|
|
||||||
class SmartAcme {
|
|
||||||
/**
|
|
||||||
* the constructor for class SmartAcme
|
|
||||||
*/
|
|
||||||
constructor(productionArg = false) {
|
|
||||||
this.productionBool = productionArg;
|
|
||||||
this.keyPair = helpers.createKeypair();
|
|
||||||
if (this.productionBool) {
|
|
||||||
this.acmeUrl = plugins.rawacme.LETSENCRYPT_URL;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this.acmeUrl = plugins.rawacme.LETSENCRYPT_STAGING_URL;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* init the smartacme instance
|
|
||||||
*/
|
|
||||||
init() {
|
|
||||||
let done = q.defer();
|
|
||||||
plugins.rawacme.createClient({
|
|
||||||
url: this.acmeUrl,
|
|
||||||
publicKey: this.keyPair.publicKey,
|
|
||||||
privateKey: this.keyPair.privateKey
|
|
||||||
}, (err, client) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:');
|
|
||||||
console.log(err);
|
|
||||||
done.reject(err);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// make client available in class
|
|
||||||
this.rawacmeClient = client;
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* creates an account if not currently present in module
|
|
||||||
* @executes ASYNC
|
|
||||||
*/
|
|
||||||
createAcmeAccount() {
|
|
||||||
let done = q.defer();
|
|
||||||
let acmeAccount = new smartacme_classes_acmeaccount_1.AcmeAccount(this);
|
|
||||||
acmeAccount.register().then(() => {
|
|
||||||
return acmeAccount.agreeTos();
|
|
||||||
}).then(() => {
|
|
||||||
done.resolve(acmeAccount);
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.SmartAcme = SmartAcme;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhY21lLmNsYXNzZXMuc21hcnRhY21lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRhY21lLmNsYXNzZXMuc21hcnRhY21lLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsc0JBQXNCO0FBQ3RCLDRCQUEyQixDQUFDLFdBQVc7QUFDdkMsK0NBQThDO0FBQzlDLCtDQUE4QztBQUU5QyxtRkFBNkQ7QUFVN0QsaUZBQTZEO0FBQXBELHNEQUFBLFdBQVcsQ0FBQTtBQUNwQiwyRUFBdUc7QUFBOUYsZ0RBQUEsUUFBUSxDQUFBO0FBRWpCOztHQUVHO0FBQ0g7SUFNRTs7T0FFRztJQUNILFlBQVksZ0JBQXlCLEtBQUs7UUFDeEMsSUFBSSxDQUFDLGNBQWMsR0FBRyxhQUFhLENBQUE7UUFDbkMsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsYUFBYSxFQUFFLENBQUE7UUFDdEMsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUM7WUFDeEIsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQTtRQUNoRCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDTixJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsdUJBQXVCLENBQUE7UUFDeEQsQ0FBQztJQUNILENBQUM7SUFFRDs7T0FFRztJQUNILElBQUk7UUFDRixJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDcEIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQzFCO1lBQ0UsR0FBRyxFQUFFLElBQUksQ0FBQyxPQUFPO1lBQ2pCLFNBQVMsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVM7WUFDakMsVUFBVSxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVTtTQUNwQyxFQUNELENBQUMsR0FBRyxFQUFFLE1BQU07WUFDVixFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO2dCQUNSLE9BQU8sQ0FBQyxLQUFLLENBQUMsa0NBQWtDLENBQUMsQ0FBQTtnQkFDakQsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtnQkFDaEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQTtnQkFDaEIsTUFBTSxDQUFBO1lBQ1IsQ0FBQztZQUVELGtDQUFrQztZQUNsQyxJQUFJLENBQUMsYUFBYSxHQUFHLE1BQU0sQ0FBQTtZQUMzQixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDaEIsQ0FBQyxDQUNGLENBQUE7UUFDRCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUNyQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsaUJBQWlCO1FBQ2YsSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBZSxDQUFBO1FBQ2pDLElBQUksV0FBVyxHQUFHLElBQUksMkNBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQTtRQUN2QyxXQUFXLENBQUMsUUFBUSxFQUFFLENBQUMsSUFBSSxDQUFDO1lBQzFCLE1BQU0sQ0FBQyxXQUFXLENBQUMsUUFBUSxFQUFFLENBQUE7UUFDL0IsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDO1lBQ04sSUFBSSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUMzQixDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3JCLENBQUM7Q0FDRjtBQTVERCw4QkE0REMifQ==
|
|
10
dist/smartacme.helpers.d.ts
vendored
10
dist/smartacme.helpers.d.ts
vendored
@ -1,10 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
import { IRsaKeypair } from './smartacme.classes.smartacme';
|
|
||||||
/**
|
|
||||||
* creates a keypair to use with requests and to generate JWK from
|
|
||||||
*/
|
|
||||||
export declare let createKeypair: (bit?: number) => IRsaKeypair;
|
|
||||||
/**
|
|
||||||
* prefix a domain name to make sure it complies with letsencrypt
|
|
||||||
*/
|
|
||||||
export declare let prefixName: (domainNameArg: string) => string;
|
|
41
dist/smartacme.helpers.js
vendored
41
dist/smartacme.helpers.js
vendored
@ -1,41 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
require("typings-global");
|
|
||||||
const q = require("smartq");
|
|
||||||
const plugins = require("./smartacme.plugins");
|
|
||||||
/**
|
|
||||||
* creates a keypair to use with requests and to generate JWK from
|
|
||||||
*/
|
|
||||||
exports.createKeypair = (bit = 2048) => {
|
|
||||||
let result = plugins.rsaKeygen.generate(bit);
|
|
||||||
return {
|
|
||||||
publicKey: result.public_key,
|
|
||||||
privateKey: result.private_key
|
|
||||||
};
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* prefix a domain name to make sure it complies with letsencrypt
|
|
||||||
*/
|
|
||||||
exports.prefixName = (domainNameArg) => {
|
|
||||||
return '_acme-challenge.' + domainNameArg;
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* gets an existing registration
|
|
||||||
* @executes ASYNC
|
|
||||||
*/
|
|
||||||
let getReg = (SmartAcmeArg, location) => {
|
|
||||||
let done = q.defer();
|
|
||||||
let body = { resource: 'reg' };
|
|
||||||
SmartAcmeArg.rawacmeClient.post(location, body, SmartAcmeArg.keyPair, (err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:');
|
|
||||||
console.log(err);
|
|
||||||
done.reject(err);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.log(JSON.stringify(res.body));
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhY21lLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFjbWUuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUN2Qiw0QkFBMkI7QUFFM0IsK0NBQThDO0FBSzlDOztHQUVHO0FBQ1EsUUFBQSxhQUFhLEdBQUcsQ0FBQyxHQUFHLEdBQUcsSUFBSTtJQUNwQyxJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsQ0FBQTtJQUM1QyxNQUFNLENBQUM7UUFDTCxTQUFTLEVBQUUsTUFBTSxDQUFDLFVBQVU7UUFDNUIsVUFBVSxFQUFFLE1BQU0sQ0FBQyxXQUFXO0tBQy9CLENBQUE7QUFDSCxDQUFDLENBQUE7QUFFRDs7R0FFRztBQUNRLFFBQUEsVUFBVSxHQUFHLENBQUMsYUFBcUI7SUFDNUMsTUFBTSxDQUFDLGtCQUFrQixHQUFHLGFBQWEsQ0FBQTtBQUMzQyxDQUFDLENBQUE7QUFFRDs7O0dBR0c7QUFDSCxJQUFJLE1BQU0sR0FBRyxDQUFDLFlBQXVCLEVBQUUsUUFBZ0I7SUFDckQsSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQ3BCLElBQUksSUFBSSxHQUFHLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRSxDQUFBO0lBQzlCLFlBQVksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUM3QixRQUFRLEVBQ1IsSUFBSSxFQUNKLFlBQVksQ0FBQyxPQUFPLEVBQ3BCLENBQUMsR0FBRyxFQUFFLEdBQUc7UUFDUCxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ1IsT0FBTyxDQUFDLEtBQUssQ0FBQyxrQ0FBa0MsQ0FBQyxDQUFBO1lBQ2pELE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7WUFDaEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUNoQixNQUFNLENBQUE7UUFDUixDQUFDO1FBQ0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFBO1FBQ3JDLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtJQUNoQixDQUFDLENBQ0YsQ0FBQTtJQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0FBQ3JCLENBQUMsQ0FBQSJ9
|
|
2
dist/smartacme.paths.d.ts
vendored
2
dist/smartacme.paths.d.ts
vendored
@ -1,2 +0,0 @@
|
|||||||
export declare let packageDir: string;
|
|
||||||
export declare let assetDir: string;
|
|
8
dist/smartacme.paths.js
vendored
8
dist/smartacme.paths.js
vendored
@ -1,8 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
const path = require("path");
|
|
||||||
const smartfile = require("smartfile");
|
|
||||||
exports.packageDir = path.join(__dirname, '../');
|
|
||||||
exports.assetDir = path.join(exports.packageDir, 'assets/');
|
|
||||||
smartfile.fs.ensureDirSync(exports.assetDir);
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhY21lLnBhdGhzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRhY21lLnBhdGhzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsNkJBQTRCO0FBQzVCLHVDQUFzQztBQUUzQixRQUFBLFVBQVUsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxLQUFLLENBQUMsQ0FBQTtBQUN2QyxRQUFBLFFBQVEsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLGtCQUFVLEVBQUMsU0FBUyxDQUFDLENBQUE7QUFDckQsU0FBUyxDQUFDLEVBQUUsQ0FBQyxhQUFhLENBQUMsZ0JBQVEsQ0FBQyxDQUFBIn0=
|
|
9
dist/smartacme.plugins.d.ts
vendored
9
dist/smartacme.plugins.d.ts
vendored
@ -1,9 +0,0 @@
|
|||||||
import 'typings-global';
|
|
||||||
declare let rsaKeygen: any;
|
|
||||||
declare let rawacme: any;
|
|
||||||
declare let nodeForge: any;
|
|
||||||
import * as dnsly from 'dnsly';
|
|
||||||
import * as smartdelay from 'smartdelay';
|
|
||||||
import * as smartfile from 'smartfile';
|
|
||||||
import * as smartstring from 'smartstring';
|
|
||||||
export { dnsly, rsaKeygen, rawacme, nodeForge, smartdelay, smartfile, smartstring };
|
|
19
dist/smartacme.plugins.js
vendored
19
dist/smartacme.plugins.js
vendored
@ -1,19 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
require("typings-global"); // typings for node
|
|
||||||
let rsaKeygen = require('rsa-keygen'); // rsa keygen
|
|
||||||
exports.rsaKeygen = rsaKeygen;
|
|
||||||
let rawacme = require('rawacme'); // acme helper functions
|
|
||||||
exports.rawacme = rawacme;
|
|
||||||
let nodeForge = require('node-forge');
|
|
||||||
exports.nodeForge = nodeForge;
|
|
||||||
// push.rocks modules here
|
|
||||||
const dnsly = require("dnsly");
|
|
||||||
exports.dnsly = dnsly;
|
|
||||||
const smartdelay = require("smartdelay");
|
|
||||||
exports.smartdelay = smartdelay;
|
|
||||||
const smartfile = require("smartfile");
|
|
||||||
exports.smartfile = smartfile;
|
|
||||||
const smartstring = require("smartstring");
|
|
||||||
exports.smartstring = smartstring;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRhY21lLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGFjbWUucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QixDQUFDLG1CQUFtQjtBQUczQyxJQUFJLFNBQVMsR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUEsQ0FBQyxhQUFhO0FBWWpELDhCQUFTO0FBWFgsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBLENBQUMsd0JBQXdCO0FBWXZELDBCQUFPO0FBWFQsSUFBSSxTQUFTLEdBQUcsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFBO0FBWW5DLDhCQUFTO0FBVlgsMEJBQTBCO0FBQzFCLCtCQUE4QjtBQU01QixzQkFBSztBQUxQLHlDQUF3QztBQVN0QyxnQ0FBVTtBQVJaLHVDQUFzQztBQVNwQyw4QkFBUztBQVJYLDJDQUEwQztBQVN4QyxrQ0FBVyJ9
|
|
@ -1,59 +0,0 @@
|
|||||||
# smartacme
|
|
||||||
acme implementation in TypeScript
|
|
||||||
|
|
||||||
## Availabililty
|
|
||||||
[](https://www.npmjs.com/package/smartacme)
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme)
|
|
||||||
[](https://github.com/umbrellazone/smartacme)
|
|
||||||
[](https://umbrellazone.gitlab.io/smartacme/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
||||||
[](https://GitLab.com/umbrellazone/smartacme/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/smartacme)
|
|
||||||
[](https://david-dm.org/umbrellazone/smartacme)
|
|
||||||
[](https://www.bithound.io/github/umbrellazone/smartacme/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/umbrellazone/smartacme)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import { SmartAcme } from 'smartacme'
|
|
||||||
|
|
||||||
let smac = new SmartAcme()
|
|
||||||
|
|
||||||
(async () => { // learn async/await, it'll make your life easier
|
|
||||||
|
|
||||||
// optionally accepts a filePath Arg with a stored acmeaccount.json
|
|
||||||
// will create an account and
|
|
||||||
let myAccount = await smac.createAcmeAccount()
|
|
||||||
|
|
||||||
// will return a dnsHash to set in your DNS record
|
|
||||||
let myCert = await myAccount.createAcmeCert('example.com')
|
|
||||||
|
|
||||||
// gets and accepts the specified challenge
|
|
||||||
// first argument optional, defaults to dns-01 (which is the cleanest method for production use)
|
|
||||||
let myChallenge = await myCert.getChallenge('dns-01')
|
|
||||||
|
|
||||||
/* ----------
|
|
||||||
Now you need to set the challenge in your DNS
|
|
||||||
myChallenge.domainNamePrefixed is the address for the record
|
|
||||||
myChallenge.dnsKeyHash is the ready to use txt record value expected by letsencrypt
|
|
||||||
-------------*/
|
|
||||||
})()
|
|
||||||
```
|
|
||||||
|
|
||||||
## Other relevant npm modules
|
|
||||||
module name | description
|
|
||||||
--- | ---
|
|
||||||
cert | a higlevel production module that uses smartacme to manage certs
|
|
||||||
smartnginx | a highlevel production tool for docker environments to manage nginx
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://umbrella.zone
|
|
@ -1,7 +1,38 @@
|
|||||||
{
|
{
|
||||||
"npmci": {
|
"gitzone": {
|
||||||
"globalNpmTools": [
|
"projectType": "npm",
|
||||||
"npmts"
|
"module": {
|
||||||
|
"githost": "code.foss.global",
|
||||||
|
"gitscope": "push.rocks",
|
||||||
|
"gitrepo": "smartacme",
|
||||||
|
"description": "A TypeScript-based ACME client for LetsEncrypt certificate management with a focus on simplicity and power.",
|
||||||
|
"npmPackagename": "@push.rocks/smartacme",
|
||||||
|
"license": "MIT",
|
||||||
|
"projectDomain": "push.rocks",
|
||||||
|
"keywords": [
|
||||||
|
"ACME",
|
||||||
|
"LetsEncrypt",
|
||||||
|
"TypeScript",
|
||||||
|
"certificate management",
|
||||||
|
"DNS challenges",
|
||||||
|
"SSL/TLS",
|
||||||
|
"secure communication",
|
||||||
|
"domain validation",
|
||||||
|
"automation",
|
||||||
|
"crypto",
|
||||||
|
"MongoDB",
|
||||||
|
"dns-01 challenge",
|
||||||
|
"token-based challenges",
|
||||||
|
"certificate renewal",
|
||||||
|
"wildcard certificates"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"npmci": {
|
||||||
|
"npmGlobalTools": [],
|
||||||
|
"npmAccessLevel": "public"
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
|
}
|
||||||
}
|
}
|
86
package.json
86
package.json
@ -1,42 +1,80 @@
|
|||||||
{
|
{
|
||||||
"name": "smartacme",
|
"name": "@push.rocks/smartacme",
|
||||||
"version": "1.0.10",
|
"version": "5.0.0",
|
||||||
"description": "acme implementation in TypeScript",
|
"private": false,
|
||||||
"main": "dist/index.js",
|
"description": "A TypeScript-based ACME client for LetsEncrypt certificate management with a focus on simplicity and power.",
|
||||||
"typings": "dist/index.d.ts",
|
"main": "dist_ts/index.js",
|
||||||
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts --nodocs)"
|
"test": "(tstest test/)",
|
||||||
|
"build": "(tsbuild --web --allowimplicitany)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+ssh://git@gitlab.com/umbrellazone/smartacme.git"
|
"url": "https://code.foss.global/push.rocks/smartacme.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
"ACME",
|
||||||
|
"LetsEncrypt",
|
||||||
"TypeScript",
|
"TypeScript",
|
||||||
"acme",
|
"certificate management",
|
||||||
"letsencrypt"
|
"DNS challenges",
|
||||||
|
"SSL/TLS",
|
||||||
|
"secure communication",
|
||||||
|
"domain validation",
|
||||||
|
"automation",
|
||||||
|
"crypto",
|
||||||
|
"MongoDB",
|
||||||
|
"dns-01 challenge",
|
||||||
|
"token-based challenges",
|
||||||
|
"certificate renewal",
|
||||||
|
"wildcard certificates"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/umbrellazone/smartacme/issues"
|
"url": "https://gitlab.com/umbrellazone/smartacme/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/umbrellazone/smartacme#README",
|
"homepage": "https://code.foss.global/push.rocks/smartacme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/node-forge": "^0.6.8",
|
"@api.global/typedserver": "^3.0.50",
|
||||||
"dnsly": "^2.0.4",
|
"@push.rocks/lik": "^6.0.15",
|
||||||
"node-forge": "^0.7.1",
|
"@push.rocks/smartdata": "^5.2.4",
|
||||||
"rawacme": "^0.2.1",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"rsa-keygen": "^1.0.6",
|
"@push.rocks/smartdns": "^5.0.2",
|
||||||
"smartdelay": "^1.0.1",
|
"@push.rocks/smartlog": "^3.0.7",
|
||||||
"smartfile": "^4.1.10",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"smartq": "^1.1.1",
|
"@push.rocks/smartrequest": "^2.0.22",
|
||||||
"smartstring": "^2.0.24",
|
"@push.rocks/smartstring": "^4.0.15",
|
||||||
"typings-global": "^1.0.16"
|
"@push.rocks/smarttime": "^4.0.6",
|
||||||
|
"@push.rocks/smartunique": "^3.0.9",
|
||||||
|
"@tsclass/tsclass": "^4.0.58",
|
||||||
|
"acme-client": "^4.2.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"cflare": "0.0.19",
|
"@apiclient.xyz/cloudflare": "^6.0.3",
|
||||||
"qenv": "^1.1.3",
|
"@git.zone/tsbuild": "^2.1.80",
|
||||||
"tapbundle": "^1.0.10"
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
}
|
"@git.zone/tstest": "^1.0.90",
|
||||||
|
"@push.rocks/qenv": "^6.0.5",
|
||||||
|
"@push.rocks/tapbundle": "^5.0.23",
|
||||||
|
"@types/node": "^20.14.2"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
8619
pnpm-lock.yaml
generated
Normal file
8619
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
8
qenv.yml
8
qenv.yml
@ -1,3 +1,5 @@
|
|||||||
vars:
|
required:
|
||||||
- CF_EMAIL
|
- CF_TOKEN
|
||||||
- CF_KEY
|
- MONGODB_URL
|
||||||
|
- MONGODB_PASSWORD
|
||||||
|
- MONGODB_DATABASE
|
||||||
|
2
readme.hints.md
Normal file
2
readme.hints.md
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
- this repo is dependent on letsencrypt and its limits
|
||||||
|
- to simpify the outside API, smartacme is stateful, meaning it works with a mongodb and a collection called 'SmartacmeCert'.
|
287
readme.md
Normal file
287
readme.md
Normal file
@ -0,0 +1,287 @@
|
|||||||
|
```markdown
|
||||||
|
# @push.rocks/smartacme
|
||||||
|
|
||||||
|
A TypeScript-based ACME client with an easy yet powerful interface for LetsEncrypt certificate management.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
To install `@push.rocks/smartacme`, you can use npm or yarn. Run one of the following commands in your project directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @push.rocks/smartacme --save
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn add @push.rocks/smartacme
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure your project is set up to use TypeScript and supports ECMAScript Modules (ESM).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
This guide will walk you through using `@push.rocks/smartacme` to set up and manage ACME (Automated Certificate Management Environment) certificates with a focus on the Let's Encrypt service, which provides free SSL certificates. The library provides an easy yet powerful TypeScript interface to automate the process of obtaining, renewing, and installing your SSL certificates.
|
||||||
|
|
||||||
|
### Table of Contents
|
||||||
|
|
||||||
|
1. [Setting Up Your Project](#setting-up-your-project)
|
||||||
|
2. [Creating a SmartAcme Instance](#creating-a-smartacme-instance)
|
||||||
|
3. [Initializing SmartAcme](#initializing-smartacme)
|
||||||
|
4. [Obtaining a Certificate for a Domain](#obtaining-a-certificate-for-a-domain)
|
||||||
|
5. [Automating DNS Challenges](#automating-dns-challenges)
|
||||||
|
6. [Managing Certificates](#managing-certificates)
|
||||||
|
7. [Environmental Considerations](#environmental-considerations)
|
||||||
|
8. [Complete Example](#complete-example)
|
||||||
|
|
||||||
|
### Setting Up Your Project
|
||||||
|
|
||||||
|
Ensure your project includes the necessary TypeScript configuration and dependencies. You'll need to have TypeScript installed and configured for ECMAScript Modules. If you are new to TypeScript, review its [documentation](https://www.typescriptlang.org/docs/) to get started.
|
||||||
|
|
||||||
|
### Creating a SmartAcme Instance
|
||||||
|
|
||||||
|
Start by importing the `SmartAcme` class from the `@push.rocks/smartacme` package. You'll also need to import or define interfaces for your setup options:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { SmartAcme } from '@push.rocks/smartacme';
|
||||||
|
|
||||||
|
const smartAcmeInstance = new SmartAcme({
|
||||||
|
accountEmail: 'youremail@example.com', // Email used for Let's Encrypt registration and recovery
|
||||||
|
accountPrivateKey: null, // Private key for the account (optional, if not provided it will be generated)
|
||||||
|
mongoDescriptor: {
|
||||||
|
mongoDbUrl: 'mongodb://yourmongoURL',
|
||||||
|
mongoDbName: 'yourDbName',
|
||||||
|
mongoDbPass: 'yourDbPassword',
|
||||||
|
},
|
||||||
|
removeChallenge: async (dnsChallenge) => {
|
||||||
|
// Implement logic here to remove DNS challenge records
|
||||||
|
},
|
||||||
|
setChallenge: async (dnsChallenge) => {
|
||||||
|
// Implement logic here to create DNS challenge records
|
||||||
|
},
|
||||||
|
environment: 'integration', // Use 'production' for actual certificates
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Initializing SmartAcme
|
||||||
|
|
||||||
|
Before proceeding to request certificates, initialize your SmartAcme instance:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
await smartAcmeInstance.init();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Obtaining a Certificate for a Domain
|
||||||
|
|
||||||
|
To obtain a certificate for a specific domain, use the `getCertificateForDomain` method. This function ensures that if a valid certificate is already present, it will be reused; otherwise, a new certificate is obtained:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const myDomain = 'example.com';
|
||||||
|
const myCert = await smartAcmeInstance.getCertificateForDomain(myDomain);
|
||||||
|
console.log('Certificate:', myCert);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Automating DNS Challenges
|
||||||
|
|
||||||
|
Part of the ACME protocol involves responding to DNS challenges issued by the certificate authority to prove control over a domain. Implement the `setChallenge` and `removeChallenge` functions in your SmartAcme configuration to automate this process. These functions receive a `dnsChallenge` argument containing details needed to create or remove the necessary DNS records.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import * as cloudflare from '@apiclient.xyz/cloudflare';
|
||||||
|
import { Qenv } from '@push.rocks/qenv';
|
||||||
|
|
||||||
|
const testQenv = new Qenv('./', './.nogit/');
|
||||||
|
const testCloudflare = new cloudflare.CloudflareAccount(testQenv.getEnvVarOnDemand('CF_TOKEN'));
|
||||||
|
|
||||||
|
const smartAcmeInstance = new SmartAcme({
|
||||||
|
accountEmail: 'domains@example.com',
|
||||||
|
accountPrivateKey: null,
|
||||||
|
mongoDescriptor: {
|
||||||
|
mongoDbName: testQenv.getEnvVarRequired('MONGODB_DATABASE'),
|
||||||
|
mongoDbPass: testQenv.getEnvVarRequired('MONGODB_PASSWORD'),
|
||||||
|
mongoDbUrl: testQenv.getEnvVarRequired('MONGODB_URL'),
|
||||||
|
},
|
||||||
|
removeChallenge: async (dnsChallenge) => {
|
||||||
|
testCloudflare.convenience.acmeRemoveDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
setChallenge: async (dnsChallenge) => {
|
||||||
|
testCloudflare.convenience.acmeSetDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
environment: 'integration',
|
||||||
|
});
|
||||||
|
|
||||||
|
await smartAcmeInstance.init();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Managing Certificates
|
||||||
|
|
||||||
|
The library automatically handles fetching, renewing, and storing your certificates in a MongoDB database specified in your configuration. Ensure your MongoDB instance is accessible and properly configured for use with SmartAcme.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const mongoDescriptor = {
|
||||||
|
mongoDbUrl: 'mongodb://yourmongoURL',
|
||||||
|
mongoDbName: 'yourDbName',
|
||||||
|
mongoDbPass: 'yourDbPassword',
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environmental Considerations
|
||||||
|
|
||||||
|
When creating an instance of `SmartAcme`, you can specify an `environment` option. This is particularly useful for testing, as you can use the `integration` environment to avoid hitting rate limits and for testing your setup without issuing real certificates. Switch to `production` when you are ready to obtain actual certificates.
|
||||||
|
|
||||||
|
### Complete Example
|
||||||
|
|
||||||
|
Below is a complete example demonstrating how to use `@push.rocks/smartacme` to obtain and manage an ACME certificate with Let's Encrypt:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { SmartAcme } from '@push.rocks/smartacme';
|
||||||
|
import * as cloudflare from '@apiclient.xyz/cloudflare';
|
||||||
|
import { Qenv } from '@push.rocks/qenv';
|
||||||
|
|
||||||
|
const qenv = new Qenv('./', './.nogit/');
|
||||||
|
const cloudflareAccount = new cloudflare.CloudflareAccount(qenv.getEnvVarOnDemand('CF_TOKEN'));
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
const smartAcmeInstance = new SmartAcme({
|
||||||
|
accountEmail: 'youremail@example.com',
|
||||||
|
accountPrivateKey: null,
|
||||||
|
mongoDescriptor: {
|
||||||
|
mongoDbUrl: qenv.getEnvVarRequired('MONGODB_URL'),
|
||||||
|
mongoDbName: qenv.getEnvVarRequired('MONGODB_DATABASE'),
|
||||||
|
mongoDbPass: qenv.getEnvVarRequired('MONGODB_PASSWORD'),
|
||||||
|
},
|
||||||
|
setChallenge: async (dnsChallenge) => {
|
||||||
|
await cloudflareAccount.convenience.acmeSetDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
removeChallenge: async (dnsChallenge) => {
|
||||||
|
await cloudflareAccount.convenience.acmeRemoveDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
environment: 'integration',
|
||||||
|
});
|
||||||
|
|
||||||
|
await smartAcmeInstance.init();
|
||||||
|
|
||||||
|
const myDomain = 'example.com';
|
||||||
|
const myCert = await smartAcmeInstance.getCertificateForDomain(myDomain);
|
||||||
|
console.log('Certificate:', myCert);
|
||||||
|
|
||||||
|
await smartAcmeInstance.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
main().catch(console.error);
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, `Qenv` is used to manage environment variables, and `cloudflare` library is used to handle DNS challenges required by Let's Encrypt ACME protocol. The `setChallenge` and `removeChallenge` methods are essential for automating the DNS challenge process, which is a key part of domain validation.
|
||||||
|
|
||||||
|
## Additional Details
|
||||||
|
|
||||||
|
### Certificate Object
|
||||||
|
|
||||||
|
The certificate object obtained from the `getCertificateForDomain` method has the following properties:
|
||||||
|
|
||||||
|
- `id`: Unique identifier for the certificate.
|
||||||
|
- `domainName`: The domain name for which the certificate is issued.
|
||||||
|
- `created`: Timestamp of when the certificate was created.
|
||||||
|
- `privateKey`: The private key associated with the certificate.
|
||||||
|
- `publicKey`: The public key or certificate itself.
|
||||||
|
- `csr`: Certificate Signing Request (CSR) used to obtain the certificate.
|
||||||
|
- `validUntil`: Timestamp indicating the expiration date of the certificate.
|
||||||
|
|
||||||
|
### Methods Summary
|
||||||
|
|
||||||
|
- **start()**: Initializes the SmartAcme instance, sets up the ACME client, and registers the account with Let's Encrypt.
|
||||||
|
- **stop()**: Closes the MongoDB connection and performs any necessary cleanup.
|
||||||
|
- **getCertificateForDomain(domainArg: string)**: Retrieves or obtains a certificate for the specified domain name. If a valid certificate exists in the database, it is returned. Otherwise, a new certificate is requested and stored.
|
||||||
|
- **setChallenge(dnsChallenge: any)**: Automates the process of setting DNS challenge records.
|
||||||
|
- **removeChallenge(dnsChallenge: any)**: Automates the process of removing DNS challenge records.
|
||||||
|
|
||||||
|
### Handling Domain Matching
|
||||||
|
|
||||||
|
The `SmartacmeCertMatcher` class is responsible for matching certificates with the broadest scope for wildcard certificates. The `getCertificateDomainNameByDomainName` method ensures that domains at various levels are correctly matched.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { SmartacmeCertMatcher } from '@push.rocks/smartacme';
|
||||||
|
|
||||||
|
const certMatcher = new SmartacmeCertMatcher();
|
||||||
|
const certDomainName = certMatcher.getCertificateDomainNameByDomainName('subdomain.example.com');
|
||||||
|
console.log('Certificate Domain Name:', certDomainName); // Output: example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
Automated tests can be added to ensure that the setup and functions work as expected. Using a testing framework such as `tap` and mock services for DNS providers (e.g., Cloudflare), you can simulate the process of obtaining and managing certificates without the need for actual domain ownership.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { tap, expect } from '@push.rocks/tapbundle';
|
||||||
|
import { Qenv } from '@push.rocks/qenv';
|
||||||
|
import * as cloudflare from '@apiclient.xyz/cloudflare';
|
||||||
|
import * as smartacme from '@push.rocks/smartacme';
|
||||||
|
|
||||||
|
const testQenv = new Qenv('./', './.nogit/');
|
||||||
|
const testCloudflare = new cloudflare.CloudflareAccount(testQenv.getEnvVarOnDemand('CF_TOKEN'));
|
||||||
|
|
||||||
|
let smartAcmeInstance: smartacme.SmartAcme;
|
||||||
|
|
||||||
|
tap.test('should create a valid instance of SmartAcme', async () => {
|
||||||
|
smartAcmeInstance = new smartacme.SmartAcme({
|
||||||
|
accountEmail: 'domains@lossless.org',
|
||||||
|
accountPrivateKey: null,
|
||||||
|
mongoDescriptor: {
|
||||||
|
mongoDbName: testQenv.getEnvVarRequired('MONGODB_DATABASE'),
|
||||||
|
mongoDbPass: testQenv.getEnvVarRequired('MONGODB_PASSWORD'),
|
||||||
|
mongoDbUrl: testQenv.getEnvVarRequired('MONGODB_URL'),
|
||||||
|
},
|
||||||
|
setChallenge: async (dnsChallenge) => {
|
||||||
|
await testCloudflare.convenience.acmeSetDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
removeChallenge: async (dnsChallenge) => {
|
||||||
|
await testCloudflare.convenience.acmeRemoveDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
environment: 'integration',
|
||||||
|
});
|
||||||
|
await smartAcmeInstance.init();
|
||||||
|
expect(smartAcmeInstance).toBeInstanceOf(smartacme.SmartAcme);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get a domain certificate', async () => {
|
||||||
|
const certificate = await smartAcmeInstance.getCertificateForDomain('example.com');
|
||||||
|
console.log('Certificate:', certificate);
|
||||||
|
expect(certificate).toHaveProperty('domainName', 'example.com');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('certmatcher should correctly match domains', async () => {
|
||||||
|
const certMatcher = new smartacme.SmartacmeCertMatcher();
|
||||||
|
const matchedCert = certMatcher.getCertificateDomainNameByDomainName('subdomain.example.com');
|
||||||
|
expect(matchedCert).toBe('example.com');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should stop correctly', async () => {
|
||||||
|
await smartAcmeInstance.stop();
|
||||||
|
expect(smartAcmeInstance).toHaveProperty('client', null);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
|
```
|
||||||
|
|
||||||
|
This comprehensive guide ensures you can set up, manage, and test ACME certificates efficiently and effectively using `@push.rocks/smartacme`.
|
||||||
|
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
122
test/test.ts
122
test/test.ts
@ -1,90 +1,48 @@
|
|||||||
import { expect, tap } from 'tapbundle'
|
import { tap, expect } from '@push.rocks/tapbundle';
|
||||||
import * as cflare from 'cflare'
|
import { Qenv } from '@push.rocks/qenv';
|
||||||
import * as qenv from 'qenv'
|
import * as cloudflare from '@apiclient.xyz/cloudflare';
|
||||||
|
|
||||||
let testQenv = new qenv.Qenv(process.cwd(), process.cwd() + '/.nogit')
|
const testQenv = new Qenv('./', './.nogit/');
|
||||||
|
const testCloudflare = new cloudflare.CloudflareAccount(testQenv.getEnvVarOnDemand('CF_TOKEN'));
|
||||||
|
|
||||||
// import the module to test
|
import * as smartacme from '../ts/index.js';
|
||||||
import * as smartacme from '../dist/index'
|
|
||||||
|
|
||||||
let myCflareAccount = new cflare.CflareAccount()
|
let smartAcmeInstance: smartacme.SmartAcme;
|
||||||
myCflareAccount.auth({
|
|
||||||
email: process.env.CF_EMAIL,
|
|
||||||
key: process.env.CF_KEY
|
|
||||||
})
|
|
||||||
|
|
||||||
let testSmartAcme: smartacme.SmartAcme
|
tap.test('should create a valid instance of SmartAcme', async () => {
|
||||||
let testAcmeAccount: smartacme.AcmeAccount
|
smartAcmeInstance = new smartacme.SmartAcme({
|
||||||
let testAcmeCert: smartacme.AcmeCert
|
accountEmail: 'domains@lossless.org',
|
||||||
let testChallenge: smartacme.ISmartAcmeChallengeChosen
|
accountPrivateKey: null,
|
||||||
|
mongoDescriptor: {
|
||||||
|
mongoDbName: testQenv.getEnvVarRequired('MONGODB_DATABASE'),
|
||||||
|
mongoDbPass: testQenv.getEnvVarRequired('MONGODB_PASSWORD'),
|
||||||
|
mongoDbUrl: testQenv.getEnvVarRequired('MONGODB_URL'),
|
||||||
|
},
|
||||||
|
removeChallenge: async (dnsChallenge) => {
|
||||||
|
testCloudflare.convenience.acmeRemoveDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
setChallenge: async (dnsChallenge) => {
|
||||||
|
testCloudflare.convenience.acmeSetDnsChallenge(dnsChallenge);
|
||||||
|
},
|
||||||
|
environment: 'integration',
|
||||||
|
});
|
||||||
|
await smartAcmeInstance.start();
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('smartacme -> should create a valid instance', async (tools) => {
|
tap.test('should get a domain certificate', async () => {
|
||||||
tools.timeout(10000)
|
const certificate = await smartAcmeInstance.getCertificateForDomain('bleu.de');
|
||||||
testSmartAcme = new smartacme.SmartAcme(false)
|
console.log(certificate);
|
||||||
await testSmartAcme.init().then(async () => {
|
});
|
||||||
expect(testSmartAcme).to.be.instanceOf(smartacme.SmartAcme)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should have created keyPair', async () => {
|
tap.test('certmatcher should correctly match domains', async () => {
|
||||||
expect(testSmartAcme.acmeUrl).to.be.a('string')
|
const certMatcherMod = await import('../ts/smartacme.classes.certmatcher.js');
|
||||||
})
|
const certMatcher = new certMatcherMod.SmartacmeCertMatcher();
|
||||||
|
const matchedCert = certMatcher.getCertificateDomainNameByDomainName('level3.level2.level1');
|
||||||
|
expect(matchedCert).toEqual('level2.level1');
|
||||||
|
});
|
||||||
|
|
||||||
tap.test('smartacme -> should register a new account', async (tools) => {
|
tap.test('should stop correctly', async () => {
|
||||||
tools.timeout(10000)
|
await smartAcmeInstance.stop();
|
||||||
await testSmartAcme.createAcmeAccount().then(async x => {
|
});
|
||||||
testAcmeAccount = x
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should create a AcmeCert', async () => {
|
tap.start();
|
||||||
await testAcmeAccount.createAcmeCert('test2.bleu.de').then(async x => {
|
|
||||||
testAcmeCert = x
|
|
||||||
expect(testAcmeAccount).to.be.instanceOf(smartacme.AcmeCert)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should get a challenge for a AcmeCert', async (tools) => {
|
|
||||||
tools.timeout(10000)
|
|
||||||
await testAcmeCert.requestChallenge().then(async (challengeChosen) => {
|
|
||||||
console.log(challengeChosen)
|
|
||||||
testChallenge = challengeChosen
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should set the challenge', async (tools) => {
|
|
||||||
tools.timeout(20000)
|
|
||||||
await myCflareAccount.createRecord(
|
|
||||||
testChallenge.domainNamePrefixed,
|
|
||||||
'TXT', testChallenge.dnsKeyHash
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should check for a DNS record', async (tools) => {
|
|
||||||
tools.timeout(20000)
|
|
||||||
await testAcmeCert.checkDns().then(x => {
|
|
||||||
console.log(x)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should accept the challenge', async (tools) => {
|
|
||||||
tools.timeout(10000)
|
|
||||||
await testAcmeCert.acceptChallenge()
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should poll for validation of a challenge', async (tools) => {
|
|
||||||
tools.timeout(10000)
|
|
||||||
await testAcmeCert.requestValidation().then(async x => {
|
|
||||||
console.log(x)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.test('smartacme -> should remove the challenge', async (tools) => {
|
|
||||||
tools.timeout(20000)
|
|
||||||
await myCflareAccount.removeRecord(
|
|
||||||
testChallenge.domainNamePrefixed,
|
|
||||||
'TXT'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
tap.start()
|
|
||||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartacme',
|
||||||
|
version: '5.0.0',
|
||||||
|
description: 'A TypeScript-based ACME client for LetsEncrypt certificate management with a focus on simplicity and power.'
|
||||||
|
}
|
@ -1 +1,2 @@
|
|||||||
export * from './smartacme.classes.smartacme'
|
export * from './smartacme.classes.smartacme.js';
|
||||||
|
export { SmartacmeCert as Cert } from './smartacme.classes.cert.js';
|
8
ts/interfaces/accountdata.ts
Normal file
8
ts/interfaces/accountdata.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
export interface IAccountData {
|
||||||
|
id: number;
|
||||||
|
key: { kty: 'RSA'; n: string; e: string; kid: string };
|
||||||
|
contact: string[];
|
||||||
|
initialIp: string;
|
||||||
|
createdAt: string;
|
||||||
|
status: string;
|
||||||
|
}
|
1
ts/interfaces/index.ts
Normal file
1
ts/interfaces/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from './accountdata.js';
|
@ -1,94 +0,0 @@
|
|||||||
import * as q from 'smartq'
|
|
||||||
|
|
||||||
import * as plugins from './smartacme.plugins'
|
|
||||||
import * as helpers from './smartacme.helpers'
|
|
||||||
|
|
||||||
import { SmartAcme, IRsaKeypair } from './smartacme.classes.smartacme'
|
|
||||||
import { AcmeCert } from './smartacme.classes.acmecert'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* class AcmeAccount represents an AcmeAccount
|
|
||||||
*/
|
|
||||||
export class AcmeAccount {
|
|
||||||
parentSmartAcme: SmartAcme
|
|
||||||
location: string
|
|
||||||
link: string
|
|
||||||
JWK
|
|
||||||
constructor(smartAcmeParentArg: SmartAcme) {
|
|
||||||
this.parentSmartAcme = smartAcmeParentArg
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* register the account with letsencrypt
|
|
||||||
*/
|
|
||||||
register() {
|
|
||||||
let done = q.defer()
|
|
||||||
this.parentSmartAcme.rawacmeClient.newReg(
|
|
||||||
{
|
|
||||||
contact: [ 'mailto:domains@lossless.org' ]
|
|
||||||
},
|
|
||||||
(err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:')
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
this.JWK = res.body.key
|
|
||||||
this.link = res.headers.link
|
|
||||||
console.log(this.link)
|
|
||||||
this.location = res.headers.location
|
|
||||||
done.resolve()
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* agree to letsencrypr terms of service
|
|
||||||
*/
|
|
||||||
agreeTos() {
|
|
||||||
let done = q.defer()
|
|
||||||
let tosPart = this.link.split(',')[ 1 ]
|
|
||||||
let tosLinkPortion = tosPart.split(';')[ 0 ]
|
|
||||||
let url = tosLinkPortion.split(';')[ 0 ].trim().replace(/[<>]/g, '')
|
|
||||||
this.parentSmartAcme.rawacmeClient.post(this.location, { Agreement: url, resource: 'reg' }, (err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
done.resolve()
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
createAcmeCert(
|
|
||||||
domainNameArg: string,
|
|
||||||
countryArg = 'Germany',
|
|
||||||
countryShortArg = 'DE',
|
|
||||||
city = 'Bremen',
|
|
||||||
companyArg = 'Some Company',
|
|
||||||
companyShortArg = 'SC'
|
|
||||||
|
|
||||||
) {
|
|
||||||
let done = q.defer<AcmeCert>()
|
|
||||||
let acmeCert = new AcmeCert(
|
|
||||||
{
|
|
||||||
bit: 2064,
|
|
||||||
key: null, // not needed right now
|
|
||||||
domain: domainNameArg,
|
|
||||||
country: countryArg,
|
|
||||||
country_short: countryShortArg,
|
|
||||||
locality: city,
|
|
||||||
organization: companyArg,
|
|
||||||
organization_short: companyShortArg,
|
|
||||||
password: null,
|
|
||||||
unstructured: null,
|
|
||||||
subject_alt_names: null
|
|
||||||
},
|
|
||||||
this
|
|
||||||
)
|
|
||||||
done.resolve(acmeCert)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,255 +0,0 @@
|
|||||||
import * as q from 'smartq'
|
|
||||||
|
|
||||||
import * as plugins from './smartacme.plugins'
|
|
||||||
import * as helpers from './smartacme.helpers'
|
|
||||||
|
|
||||||
import { SmartAcme, IRsaKeypair } from './smartacme.classes.smartacme'
|
|
||||||
import { AcmeAccount } from './smartacme.classes.acmeaccount'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* types of challenges supported by letsencrypt and this module
|
|
||||||
*/
|
|
||||||
export type TChallengeType = 'dns-01' | 'http-01'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* values that a challenge's status can have
|
|
||||||
*/
|
|
||||||
export type TChallengeStatus = 'pending'
|
|
||||||
|
|
||||||
export interface ISmartAcmeChallenge {
|
|
||||||
uri: string
|
|
||||||
status: TChallengeStatus
|
|
||||||
type: TChallengeType
|
|
||||||
token: string
|
|
||||||
keyAuthorization: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ISmartAcmeChallengeChosen extends ISmartAcmeChallenge {
|
|
||||||
dnsKeyHash: string
|
|
||||||
domainName: string
|
|
||||||
domainNamePrefixed: string
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface IAcmeCsrConstructorOptions {
|
|
||||||
bit: number,
|
|
||||||
key: string,
|
|
||||||
domain: string,
|
|
||||||
country: string,
|
|
||||||
country_short: string,
|
|
||||||
locality: string,
|
|
||||||
organization: string,
|
|
||||||
organization_short: string,
|
|
||||||
password: string,
|
|
||||||
unstructured: string,
|
|
||||||
subject_alt_names: string[]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dnsly instance (we really just need one)
|
|
||||||
let myDnsly = new plugins.dnsly.Dnsly('google')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* class AcmeCert represents a cert for domain
|
|
||||||
*/
|
|
||||||
export class AcmeCert {
|
|
||||||
domainName: string
|
|
||||||
attributes
|
|
||||||
fullchain: string
|
|
||||||
parentAcmeAccount: AcmeAccount
|
|
||||||
csr
|
|
||||||
validFrom: Date
|
|
||||||
validTo: Date
|
|
||||||
keypair: IRsaKeypair
|
|
||||||
keyPairFinal: IRsaKeypair
|
|
||||||
chosenChallenge: ISmartAcmeChallengeChosen
|
|
||||||
dnsKeyHash: string
|
|
||||||
constructor(optionsArg: IAcmeCsrConstructorOptions, parentAcmeAccount: AcmeAccount) {
|
|
||||||
this.domainName = optionsArg.domain
|
|
||||||
this.parentAcmeAccount = parentAcmeAccount
|
|
||||||
this.keypair = helpers.createKeypair(optionsArg.bit)
|
|
||||||
let privateKeyForged = plugins.nodeForge.pki.privateKeyFromPem(this.keypair.privateKey)
|
|
||||||
let publicKeyForged = plugins.nodeForge.pki.publicKeyToPem(
|
|
||||||
plugins.nodeForge.pki.setRsaPublicKey(privateKeyForged.n, privateKeyForged.e)
|
|
||||||
)
|
|
||||||
this.keyPairFinal = {
|
|
||||||
privateKey: privateKeyForged,
|
|
||||||
publicKey: publicKeyForged
|
|
||||||
}
|
|
||||||
|
|
||||||
// set dates
|
|
||||||
this.validFrom = new Date()
|
|
||||||
this.validTo = new Date()
|
|
||||||
this.validTo.setDate(this.validFrom.getDate() + 90)
|
|
||||||
|
|
||||||
// set attributes
|
|
||||||
this.attributes = [
|
|
||||||
{ name: 'commonName', value: optionsArg.domain },
|
|
||||||
{ name: 'countryName', value: optionsArg.country },
|
|
||||||
{ shortName: 'ST', value: optionsArg.country_short },
|
|
||||||
{ name: 'localityName', value: optionsArg.locality },
|
|
||||||
{ name: 'organizationName', value: optionsArg.organization },
|
|
||||||
{ shortName: 'OU', value: optionsArg.organization_short },
|
|
||||||
{ name: 'challengePassword', value: optionsArg.password },
|
|
||||||
{ name: 'unstructuredName', value: optionsArg.unstructured }
|
|
||||||
]
|
|
||||||
|
|
||||||
// set up csr
|
|
||||||
this.csr = plugins.nodeForge.pki.createCertificationRequest()
|
|
||||||
this.csr.setSubject(this.attributes)
|
|
||||||
this.csr.setAttributes(this.attributes)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* requests a challenge for a domain
|
|
||||||
* @param domainNameArg - the domain name to request a challenge for
|
|
||||||
* @param challengeType - the challenge type to request
|
|
||||||
*/
|
|
||||||
requestChallenge(challengeTypeArg: TChallengeType = 'dns-01') {
|
|
||||||
let done = q.defer<ISmartAcmeChallengeChosen>()
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.rawacmeClient.newAuthz(
|
|
||||||
{
|
|
||||||
identifier: {
|
|
||||||
type: 'dns',
|
|
||||||
value: this.domainName
|
|
||||||
}
|
|
||||||
},
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.keyPair,
|
|
||||||
(err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:')
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
}
|
|
||||||
let preChosenChallenge = res.body.challenges.filter(x => {
|
|
||||||
return x.type === challengeTypeArg
|
|
||||||
})[ 0 ]
|
|
||||||
|
|
||||||
/**
|
|
||||||
* the key is needed to accept the challenge
|
|
||||||
*/
|
|
||||||
let authKey: string = plugins.rawacme.keyAuthz(
|
|
||||||
preChosenChallenge.token,
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.keyPair.publicKey
|
|
||||||
)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* needed in case selected challenge is of type dns-01
|
|
||||||
*/
|
|
||||||
this.dnsKeyHash = plugins.rawacme.dnsKeyAuthzHash(authKey) // needed if dns challenge is chosen
|
|
||||||
/**
|
|
||||||
* the return challenge
|
|
||||||
*/
|
|
||||||
this.chosenChallenge = {
|
|
||||||
uri: preChosenChallenge.uri,
|
|
||||||
type: preChosenChallenge.type,
|
|
||||||
token: preChosenChallenge.token,
|
|
||||||
keyAuthorization: authKey,
|
|
||||||
status: preChosenChallenge.status,
|
|
||||||
dnsKeyHash: this.dnsKeyHash,
|
|
||||||
domainName: this.domainName,
|
|
||||||
domainNamePrefixed: helpers.prefixName(this.domainName)
|
|
||||||
}
|
|
||||||
done.resolve(this.chosenChallenge)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* checks if DNS records are set, will go through a max of 30 cycles
|
|
||||||
*/
|
|
||||||
async checkDns(cycleArg = 1) {
|
|
||||||
let result = await myDnsly.checkUntilAvailable(helpers.prefixName(this.domainName), 'TXT', this.dnsKeyHash)
|
|
||||||
if (result) {
|
|
||||||
console.log('DNS is set!')
|
|
||||||
return
|
|
||||||
} else {
|
|
||||||
throw new Error('DNS not set!')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* validates a challenge, only call after you have set the challenge at the expected location
|
|
||||||
*/
|
|
||||||
async requestValidation() {
|
|
||||||
let makeRequest = () => {
|
|
||||||
let done = q.defer()
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.rawacmeClient.poll(this.chosenChallenge.uri, async (err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
console.log(`Validation response:`)
|
|
||||||
console.log(JSON.stringify(res.body))
|
|
||||||
if (res.body.status === 'pending' || res.body.status === 'invalid') {
|
|
||||||
await plugins.smartdelay.delayFor(3000)
|
|
||||||
makeRequest().then((x: any) => { done.resolve(x) })
|
|
||||||
} else {
|
|
||||||
console.log('perfect!')
|
|
||||||
done.resolve(res.body)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
await makeRequest()
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* requests a certificate
|
|
||||||
*/
|
|
||||||
requestCert() {
|
|
||||||
let done = q.defer()
|
|
||||||
let payload = {
|
|
||||||
csr: plugins.rawacme.base64.encode(
|
|
||||||
plugins.rawacme.toDer(
|
|
||||||
plugins.nodeForge.pki.certificationRequestToPem(
|
|
||||||
this.csr
|
|
||||||
)
|
|
||||||
)
|
|
||||||
),
|
|
||||||
notBefore: this.validFrom.toISOString(),
|
|
||||||
notAfter: this.validTo.toISOString()
|
|
||||||
}
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.rawacmeClient.newCert(
|
|
||||||
payload,
|
|
||||||
helpers.createKeypair(),
|
|
||||||
(err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
}
|
|
||||||
console.log(res.body)
|
|
||||||
done.resolve(res.body)
|
|
||||||
})
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* getCertificate - takes care of cooldown, validation polling and certificate retrieval
|
|
||||||
*/
|
|
||||||
getCertificate() {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* accept a challenge - for private use only
|
|
||||||
*/
|
|
||||||
acceptChallenge() {
|
|
||||||
let done = q.defer()
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.rawacmeClient.post(
|
|
||||||
this.chosenChallenge.uri,
|
|
||||||
{
|
|
||||||
resource: 'challenge',
|
|
||||||
keyAuthorization: this.chosenChallenge.keyAuthorization
|
|
||||||
},
|
|
||||||
this.parentAcmeAccount.parentSmartAcme.keyPair,
|
|
||||||
(err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
}
|
|
||||||
done.resolve(res.body)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
||||||
}
|
|
64
ts/smartacme.classes.cert.ts
Normal file
64
ts/smartacme.classes.cert.ts
Normal file
@ -0,0 +1,64 @@
|
|||||||
|
import * as plugins from './smartacme.plugins.js';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
import { SmartacmeCertManager } from './smartacme.classes.certmanager.js';
|
||||||
|
|
||||||
|
import { Collection, svDb, unI } from '@push.rocks/smartdata';
|
||||||
|
|
||||||
|
@plugins.smartdata.Collection(() => {
|
||||||
|
return SmartacmeCertManager.activeDB;
|
||||||
|
})
|
||||||
|
export class SmartacmeCert
|
||||||
|
extends plugins.smartdata.SmartDataDbDoc<SmartacmeCert, plugins.tsclass.network.ICert>
|
||||||
|
implements plugins.tsclass.network.ICert
|
||||||
|
{
|
||||||
|
@unI()
|
||||||
|
public id: string;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public domainName: string;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public created: number;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public privateKey: string;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public publicKey: string;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public csr: string;
|
||||||
|
|
||||||
|
@svDb()
|
||||||
|
public validUntil: number;
|
||||||
|
|
||||||
|
public isStillValid(): boolean {
|
||||||
|
return this.validUntil >= Date.now();
|
||||||
|
}
|
||||||
|
|
||||||
|
public shouldBeRenewed(): boolean {
|
||||||
|
const shouldBeValidAtLeastUntil =
|
||||||
|
Date.now() +
|
||||||
|
plugins.smarttime.getMilliSecondsFromUnits({
|
||||||
|
days: 10,
|
||||||
|
});
|
||||||
|
return !(this.validUntil >= shouldBeValidAtLeastUntil);
|
||||||
|
}
|
||||||
|
|
||||||
|
public update(certDataArg: plugins.tsclass.network.ICert) {
|
||||||
|
Object.keys(certDataArg).forEach((key) => {
|
||||||
|
this[key] = certDataArg[key];
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
constructor(optionsArg: plugins.tsclass.network.ICert) {
|
||||||
|
super();
|
||||||
|
if (optionsArg) {
|
||||||
|
Object.keys(optionsArg).forEach((key) => {
|
||||||
|
this[key] = optionsArg[key];
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
77
ts/smartacme.classes.certmanager.ts
Normal file
77
ts/smartacme.classes.certmanager.ts
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
import * as plugins from './smartacme.plugins.js';
|
||||||
|
import { SmartacmeCert } from './smartacme.classes.cert.js';
|
||||||
|
import { SmartAcme } from './smartacme.classes.smartacme.js';
|
||||||
|
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
export class SmartacmeCertManager {
|
||||||
|
// =========
|
||||||
|
// STATIC
|
||||||
|
// =========
|
||||||
|
public static activeDB: plugins.smartdata.SmartdataDb;
|
||||||
|
|
||||||
|
// =========
|
||||||
|
// INSTANCE
|
||||||
|
// =========
|
||||||
|
private mongoDescriptor: plugins.smartdata.IMongoDescriptor;
|
||||||
|
public smartdataDb: plugins.smartdata.SmartdataDb;
|
||||||
|
|
||||||
|
public interestMap: plugins.lik.InterestMap<string, SmartacmeCert>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
smartAcmeArg: SmartAcme,
|
||||||
|
optionsArg: {
|
||||||
|
mongoDescriptor: plugins.smartdata.IMongoDescriptor;
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
this.mongoDescriptor = optionsArg.mongoDescriptor;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async init() {
|
||||||
|
// Smartdata DB
|
||||||
|
this.smartdataDb = new plugins.smartdata.SmartdataDb(this.mongoDescriptor);
|
||||||
|
await this.smartdataDb.init();
|
||||||
|
SmartacmeCertManager.activeDB = this.smartdataDb;
|
||||||
|
|
||||||
|
// Pending Map
|
||||||
|
this.interestMap = new plugins.lik.InterestMap((certName) => certName);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* retrieves a certificate
|
||||||
|
* @returns the Cert class or null
|
||||||
|
* @param certDomainNameArg the domain Name to retrieve the vcertificate for
|
||||||
|
*/
|
||||||
|
public async retrieveCertificate(certDomainNameArg: string): Promise<SmartacmeCert> {
|
||||||
|
const existingCertificate: SmartacmeCert = await SmartacmeCert.getInstance<SmartacmeCert>({
|
||||||
|
domainName: certDomainNameArg,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (existingCertificate) {
|
||||||
|
return existingCertificate;
|
||||||
|
} else {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stores the certificate
|
||||||
|
* @param optionsArg
|
||||||
|
*/
|
||||||
|
public async storeCertificate(optionsArg: plugins.tsclass.network.ICert) {
|
||||||
|
const cert = new SmartacmeCert(optionsArg);
|
||||||
|
await cert.save();
|
||||||
|
const interest = this.interestMap.findInterest(cert.domainName);
|
||||||
|
if (interest) {
|
||||||
|
interest.fullfillInterest(cert);
|
||||||
|
interest.markLost();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async deleteCertificate(certDomainNameArg: string) {
|
||||||
|
const cert: SmartacmeCert = await SmartacmeCert.getInstance<SmartacmeCert>({
|
||||||
|
domainName: certDomainNameArg,
|
||||||
|
});
|
||||||
|
await cert.delete();
|
||||||
|
}
|
||||||
|
}
|
19
ts/smartacme.classes.certmatcher.ts
Normal file
19
ts/smartacme.classes.certmatcher.ts
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
import * as plugins from './smartacme.plugins.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* certmatcher is responsible for matching certificates
|
||||||
|
*/
|
||||||
|
export class SmartacmeCertMatcher {
|
||||||
|
/**
|
||||||
|
* creates a domainName for the certificate that will include the broadest scope
|
||||||
|
* for wild card certificates
|
||||||
|
* @param domainNameArg the domainNameArg to create the scope from
|
||||||
|
*/
|
||||||
|
public getCertificateDomainNameByDomainName(domainNameArg: string): string {
|
||||||
|
const originalDomain = new plugins.smartstring.Domain(domainNameArg);
|
||||||
|
if (!originalDomain.level4) {
|
||||||
|
return `${originalDomain.level2}.${originalDomain.level1}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -1,82 +1,217 @@
|
|||||||
// third party modules
|
import * as plugins from './smartacme.plugins.js';
|
||||||
import * as q from 'smartq' // promises
|
import { SmartacmeCert } from './smartacme.classes.cert.js';
|
||||||
import * as plugins from './smartacme.plugins'
|
import { SmartacmeCertManager } from './smartacme.classes.certmanager.js';
|
||||||
import * as helpers from './smartacme.helpers'
|
import { SmartacmeCertMatcher } from './smartacme.classes.certmatcher.js';
|
||||||
|
import { commitinfo } from './00_commitinfo_data.js';
|
||||||
import { AcmeAccount } from './smartacme.classes.acmeaccount'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* a rsa keypair needed for account creation and subsequent requests
|
* the options for the class @see SmartAcme
|
||||||
*/
|
*/
|
||||||
export interface IRsaKeypair {
|
export interface ISmartAcmeOptions {
|
||||||
publicKey: string
|
accountPrivateKey?: string;
|
||||||
privateKey: string
|
accountEmail: string;
|
||||||
|
mongoDescriptor: plugins.smartdata.IMongoDescriptor;
|
||||||
|
setChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
|
||||||
|
removeChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
|
||||||
|
environment: 'production' | 'integration';
|
||||||
}
|
}
|
||||||
|
|
||||||
export { AcmeAccount } from './smartacme.classes.acmeaccount'
|
|
||||||
export { AcmeCert, ISmartAcmeChallenge, ISmartAcmeChallengeChosen } from './smartacme.classes.acmecert'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class SmartAcme exports methods for maintaining SSL Certificates
|
* class SmartAcme
|
||||||
|
* can be used for setting up communication with an ACME authority
|
||||||
|
*
|
||||||
|
* ```ts
|
||||||
|
* const mySmartAcmeInstance = new SmartAcme({
|
||||||
|
* // see ISmartAcmeOptions for options
|
||||||
|
* })
|
||||||
|
* ```
|
||||||
*/
|
*/
|
||||||
export class SmartAcme {
|
export class SmartAcme {
|
||||||
acmeUrl: string // the acme url to use for this instance
|
private options: ISmartAcmeOptions;
|
||||||
productionBool: boolean // a boolean to quickly know wether we are in production or not
|
|
||||||
keyPair: IRsaKeypair // the keyPair needed for account creation
|
// the acme client
|
||||||
rawacmeClient
|
private client: any;
|
||||||
|
private smartdns = new plugins.smartdns.Smartdns({});
|
||||||
|
public logger: plugins.smartlog.Smartlog;
|
||||||
|
|
||||||
|
// the account private key
|
||||||
|
private privateKey: string;
|
||||||
|
|
||||||
|
// challenge fullfillment
|
||||||
|
private setChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
|
||||||
|
private removeChallenge: (dnsChallengeArg: plugins.tsclass.network.IDnsChallenge) => Promise<any>;
|
||||||
|
|
||||||
|
// certmanager
|
||||||
|
private certmanager: SmartacmeCertManager;
|
||||||
|
private certmatcher: SmartacmeCertMatcher;
|
||||||
|
|
||||||
|
constructor(optionsArg: ISmartAcmeOptions) {
|
||||||
|
this.options = optionsArg;
|
||||||
|
this.logger = plugins.smartlog.Smartlog.createForCommitinfo(commitinfo);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* the constructor for class SmartAcme
|
* starts the instance
|
||||||
|
* ```ts
|
||||||
|
* await myCloudlyInstance.start() // does not support options
|
||||||
|
* ```
|
||||||
*/
|
*/
|
||||||
constructor(productionArg: boolean = false) {
|
public async start() {
|
||||||
this.productionBool = productionArg
|
this.privateKey =
|
||||||
this.keyPair = helpers.createKeypair()
|
this.options.accountPrivateKey || (await plugins.acme.forge.createPrivateKey()).toString();
|
||||||
if (this.productionBool) {
|
this.setChallenge = this.options.setChallenge;
|
||||||
this.acmeUrl = plugins.rawacme.LETSENCRYPT_URL
|
this.removeChallenge = this.options.removeChallenge;
|
||||||
|
|
||||||
|
// CertMangaer
|
||||||
|
this.certmanager = new SmartacmeCertManager(this, {
|
||||||
|
mongoDescriptor: this.options.mongoDescriptor,
|
||||||
|
});
|
||||||
|
await this.certmanager.init();
|
||||||
|
|
||||||
|
// CertMatcher
|
||||||
|
this.certmatcher = new SmartacmeCertMatcher();
|
||||||
|
|
||||||
|
// ACME Client
|
||||||
|
this.client = new plugins.acme.Client({
|
||||||
|
directoryUrl: (() => {
|
||||||
|
if (this.options.environment === 'production') {
|
||||||
|
return plugins.acme.directory.letsencrypt.production;
|
||||||
} else {
|
} else {
|
||||||
this.acmeUrl = plugins.rawacme.LETSENCRYPT_STAGING_URL
|
return plugins.acme.directory.letsencrypt.staging;
|
||||||
}
|
}
|
||||||
|
})(),
|
||||||
|
accountKey: this.privateKey,
|
||||||
|
});
|
||||||
|
|
||||||
|
/* Register account */
|
||||||
|
await this.client.createAccount({
|
||||||
|
termsOfServiceAgreed: true,
|
||||||
|
contact: [`mailto:${this.options.accountEmail}`],
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public async stop() {
|
||||||
|
await this.certmanager.smartdataDb.close();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* init the smartacme instance
|
* gets a certificate
|
||||||
|
* it runs through the following steps
|
||||||
|
*
|
||||||
|
* * look in the database
|
||||||
|
* * if in the database and still valid return it
|
||||||
|
* * if not in the database announce it
|
||||||
|
* * then get it from letsencrypt
|
||||||
|
* * store it
|
||||||
|
* * remove it from the pending map (which it go onto by announcing it)
|
||||||
|
* * retrieve it from the databse and return it
|
||||||
|
*
|
||||||
|
* @param domainArg
|
||||||
*/
|
*/
|
||||||
init() {
|
public async getCertificateForDomain(domainArg: string): Promise<SmartacmeCert> {
|
||||||
let done = q.defer()
|
const certDomainName = this.certmatcher.getCertificateDomainNameByDomainName(domainArg);
|
||||||
plugins.rawacme.createClient(
|
const retrievedCertificate = await this.certmanager.retrieveCertificate(certDomainName);
|
||||||
{
|
|
||||||
url: this.acmeUrl,
|
if (
|
||||||
publicKey: this.keyPair.publicKey,
|
!retrievedCertificate &&
|
||||||
privateKey: this.keyPair.privateKey
|
(await this.certmanager.interestMap.checkInterest(certDomainName))
|
||||||
},
|
) {
|
||||||
(err, client) => {
|
const existingCertificateInterest = this.certmanager.interestMap.findInterest(certDomainName);
|
||||||
if (err) {
|
const certificate = existingCertificateInterest.interestFullfilled;
|
||||||
console.error('smartacme: something went wrong:')
|
return certificate;
|
||||||
console.log(err)
|
} else if (retrievedCertificate && !retrievedCertificate.shouldBeRenewed()) {
|
||||||
done.reject(err)
|
return retrievedCertificate;
|
||||||
return
|
} else if (retrievedCertificate && retrievedCertificate.shouldBeRenewed()) {
|
||||||
|
await retrievedCertificate.delete();
|
||||||
}
|
}
|
||||||
|
|
||||||
// make client available in class
|
// lets make sure others get the same interest
|
||||||
this.rawacmeClient = client
|
const currentDomainInterst = await this.certmanager.interestMap.addInterest(certDomainName);
|
||||||
done.resolve()
|
|
||||||
|
/* Place new order */
|
||||||
|
const order = await this.client.createOrder({
|
||||||
|
identifiers: [
|
||||||
|
{ type: 'dns', value: certDomainName },
|
||||||
|
{ type: 'dns', value: `*.${certDomainName}` },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
/* Get authorizations and select challenges */
|
||||||
|
const authorizations = await this.client.getAuthorizations(order);
|
||||||
|
|
||||||
|
for (const authz of authorizations) {
|
||||||
|
console.log(authz);
|
||||||
|
const fullHostName: string = `_acme-challenge.${authz.identifier.value}`;
|
||||||
|
const dnsChallenge: string = authz.challenges.find((challengeArg) => {
|
||||||
|
return challengeArg.type === 'dns-01';
|
||||||
|
});
|
||||||
|
// process.exit(1);
|
||||||
|
const keyAuthorization: string = await this.client.getChallengeKeyAuthorization(dnsChallenge);
|
||||||
|
|
||||||
|
try {
|
||||||
|
/* Satisfy challenge */
|
||||||
|
await this.setChallenge({
|
||||||
|
hostName: fullHostName,
|
||||||
|
challenge: keyAuthorization,
|
||||||
|
});
|
||||||
|
await plugins.smartdelay.delayFor(30000);
|
||||||
|
await this.smartdns.checkUntilAvailable(fullHostName, 'TXT', keyAuthorization, 100, 5000);
|
||||||
|
console.log('Cool down an extra 60 second for region availability');
|
||||||
|
await plugins.smartdelay.delayFor(60000);
|
||||||
|
|
||||||
|
/* Verify that challenge is satisfied */
|
||||||
|
await this.client.verifyChallenge(authz, dnsChallenge);
|
||||||
|
|
||||||
|
/* Notify ACME provider that challenge is satisfied */
|
||||||
|
await this.client.completeChallenge(dnsChallenge);
|
||||||
|
|
||||||
|
/* Wait for ACME provider to respond with valid status */
|
||||||
|
await this.client.waitForValidStatus(dnsChallenge);
|
||||||
|
} finally {
|
||||||
|
/* Clean up challenge response */
|
||||||
|
try {
|
||||||
|
await this.removeChallenge({
|
||||||
|
hostName: fullHostName,
|
||||||
|
challenge: keyAuthorization,
|
||||||
|
});
|
||||||
|
} catch (e) {
|
||||||
|
console.log(e);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/* Finalize order */
|
||||||
* creates an account if not currently present in module
|
const [key, csr] = await plugins.acme.forge.createCsr({
|
||||||
* @executes ASYNC
|
commonName: `*.${certDomainName}`,
|
||||||
*/
|
altNames: [certDomainName],
|
||||||
createAcmeAccount() {
|
});
|
||||||
let done = q.defer<AcmeAccount>()
|
|
||||||
let acmeAccount = new AcmeAccount(this)
|
await this.client.finalizeOrder(order, csr);
|
||||||
acmeAccount.register().then(() => {
|
const cert = await this.client.getCertificate(order);
|
||||||
return acmeAccount.agreeTos()
|
|
||||||
}).then(() => {
|
/* Done */
|
||||||
done.resolve(acmeAccount)
|
|
||||||
})
|
await this.certmanager.storeCertificate({
|
||||||
return done.promise
|
id: plugins.smartunique.shortId(),
|
||||||
|
domainName: certDomainName,
|
||||||
|
privateKey: key.toString(),
|
||||||
|
publicKey: cert.toString(),
|
||||||
|
csr: csr.toString(),
|
||||||
|
created: Date.now(),
|
||||||
|
validUntil:
|
||||||
|
Date.now() +
|
||||||
|
plugins.smarttime.getMilliSecondsFromUnits({
|
||||||
|
days: 90,
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
const newCertificate = await this.certmanager.retrieveCertificate(certDomainName);
|
||||||
|
currentDomainInterst.fullfillInterest(newCertificate);
|
||||||
|
currentDomainInterst.destroy();
|
||||||
|
return newCertificate;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async getAllCertificates(): Promise<SmartacmeCert[]> {
|
||||||
|
return SmartacmeCert.getInstances({});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,50 +0,0 @@
|
|||||||
import 'typings-global'
|
|
||||||
import * as q from 'smartq'
|
|
||||||
|
|
||||||
import * as plugins from './smartacme.plugins'
|
|
||||||
|
|
||||||
import { SmartAcme, IRsaKeypair } from './smartacme.classes.smartacme'
|
|
||||||
import { AcmeAccount } from './smartacme.classes.acmeaccount'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* creates a keypair to use with requests and to generate JWK from
|
|
||||||
*/
|
|
||||||
export let createKeypair = (bit = 2048): IRsaKeypair => {
|
|
||||||
let result = plugins.rsaKeygen.generate(bit)
|
|
||||||
return {
|
|
||||||
publicKey: result.public_key,
|
|
||||||
privateKey: result.private_key
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* prefix a domain name to make sure it complies with letsencrypt
|
|
||||||
*/
|
|
||||||
export let prefixName = (domainNameArg: string): string => {
|
|
||||||
return '_acme-challenge.' + domainNameArg
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* gets an existing registration
|
|
||||||
* @executes ASYNC
|
|
||||||
*/
|
|
||||||
let getReg = (SmartAcmeArg: SmartAcme, location: string) => {
|
|
||||||
let done = q.defer()
|
|
||||||
let body = { resource: 'reg' }
|
|
||||||
SmartAcmeArg.rawacmeClient.post(
|
|
||||||
location,
|
|
||||||
body,
|
|
||||||
SmartAcmeArg.keyPair,
|
|
||||||
(err, res) => {
|
|
||||||
if (err) {
|
|
||||||
console.error('smartacme: something went wrong:')
|
|
||||||
console.log(err)
|
|
||||||
done.reject(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
console.log(JSON.stringify(res.body))
|
|
||||||
done.resolve()
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return done.promise
|
|
||||||
}
|
|
@ -1,6 +0,0 @@
|
|||||||
import * as path from 'path'
|
|
||||||
import * as smartfile from 'smartfile'
|
|
||||||
|
|
||||||
export let packageDir = path.join(__dirname,'../')
|
|
||||||
export let assetDir = path.join(packageDir,'assets/')
|
|
||||||
smartfile.fs.ensureDirSync(assetDir)
|
|
@ -1,22 +1,39 @@
|
|||||||
import 'typings-global' // typings for node
|
// @apiglobal scope
|
||||||
|
import * as typedserver from '@api.global/typedserver';
|
||||||
|
|
||||||
import * as path from 'path' // native node path module
|
export { typedserver };
|
||||||
let rsaKeygen = require('rsa-keygen') // rsa keygen
|
|
||||||
let rawacme = require('rawacme') // acme helper functions
|
|
||||||
let nodeForge = require('node-forge')
|
|
||||||
|
|
||||||
// push.rocks modules here
|
// @pushrocks scope
|
||||||
import * as dnsly from 'dnsly'
|
import * as lik from '@push.rocks/lik';
|
||||||
import * as smartdelay from 'smartdelay'
|
import * as smartdata from '@push.rocks/smartdata';
|
||||||
import * as smartfile from 'smartfile'
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
import * as smartstring from 'smartstring'
|
import * as smartdns from '@push.rocks/smartdns';
|
||||||
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartrequest from '@push.rocks/smartrequest';
|
||||||
|
import * as smartunique from '@push.rocks/smartunique';
|
||||||
|
import * as smartstring from '@push.rocks/smartstring';
|
||||||
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
|
|
||||||
export {
|
export {
|
||||||
dnsly,
|
lik,
|
||||||
rsaKeygen,
|
smartdata,
|
||||||
rawacme,
|
|
||||||
nodeForge,
|
|
||||||
smartdelay,
|
smartdelay,
|
||||||
smartfile,
|
smartdns,
|
||||||
smartstring
|
smartlog,
|
||||||
}
|
smartpromise,
|
||||||
|
smartrequest,
|
||||||
|
smartunique,
|
||||||
|
smartstring,
|
||||||
|
smarttime,
|
||||||
|
};
|
||||||
|
|
||||||
|
// @tsclass scope
|
||||||
|
import * as tsclass from '@tsclass/tsclass';
|
||||||
|
|
||||||
|
export { tsclass };
|
||||||
|
|
||||||
|
// third party scope
|
||||||
|
import * as acme from 'acme-client';
|
||||||
|
|
||||||
|
export { acme };
|
||||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "tslint-config-standard"
|
|
||||||
}
|
|
Reference in New Issue
Block a user