开源项目 `selfsigned` 使用教程

1. 项目的目录结构及介绍

selfsigned/
├── bin/
│   └── generate-cert.js
├── lib/
│   ├── asn1.js
│   ├── ca.js
│   ├── cert.js
│   ├── csr.js
│   ├── index.js
│   ├── key.js
│   ├── pem.js
│   ├── private.js
│   ├── public.js
│   ├── serial.js
│   ├── sign.js
│   ├── subject.js
│   ├── utils.js
│   └── x509.js
├── test/
│   ├── ca.test.js
│   ├── cert.test.js
│   ├── csr.test.js
│   ├── key.test.js
│   ├── pem.test.js
│   ├── private.test.js
│   ├── public.test.js
│   ├── serial.test.js
│   ├── sign.test.js
│   ├── subject.test.js
│   ├── utils.test.js
│   └── x509.test.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• bin/: 包含可执行脚本文件，如 generate-cert.js 用于生成证书。
• lib/: 包含项目的主要代码文件，如 asn1.js, ca.js, cert.js 等。
• test/: 包含项目的测试文件，如 ca.test.js, cert.test.js 等。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 忽略的文件和目录。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下的 generate-cert.js。该文件用于生成自签名证书。

#!/usr/bin/env node

const fs = require('fs');
const path = require('path');
const selfsigned = require('../lib');

const argv = require('yargs')
  .option('out', {
    alias: 'o',
    describe: 'Output directory',
    default: process.cwd()
  })
  .option('name', {
    alias: 'n',
    describe: 'Common Name',
    default: 'localhost'
  })
  .option('days', {
    alias: 'd',
    describe: 'Validity in days',
    default: 365
  })
  .option('key', {
    alias: 'k',
    describe: 'Output key file',
    default: 'key.pem'
  })
  .option('cert', {
    alias: 'c',
    describe: 'Output cert file',
    default: 'cert.pem'
  })
  .help()
  .argv;

const outDir = argv.out;
const commonName = argv.name;
const days = argv.days;
const keyFile = argv.key;
const certFile = argv.cert;

const pems = selfsigned.generate([{ name: 'commonName', value: commonName }], { days });

fs.writeFileSync(path.join(outDir, keyFile), pems.private);
fs.writeFileSync(path.join(outDir, certFile), pems.cert);

console.log(`Generated key file: ${path.join(outDir, keyFile)}`);
console.log(`Generated cert file: ${path.join(outDir, certFile)}`);

该脚本使用 yargs 解析命令行参数，生成自签名证书，并将生成的密钥和证书文件写入指定目录。

3. 项目的配置文件介绍

项目的主要配置文件是 package.json，其中包含了项目的依赖、脚本和其他元数据。

{
  "name": "selfsigned",
  "version": "2.0.0",