https://github.com/jsumners/self-cert

A simple library to generate self-signed x509 certs
https://github.com/jsumners/self-cert

Last synced: about 1 month ago
JSON representation

A simple library to generate self-signed x509 certs

• Host: GitHub
• URL: https://github.com/jsumners/self-cert
• Owner: jsumners
• Created: 2017-09-07T19:05:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-18T23:30:05.000Z (over 2 years ago)
• Last Synced: 2024-05-01T23:13:14.952Z (7 months ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 7
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# self-cert

This is a simple library for generating a self-signed x509 keypair and certificate.

I looked at [selfsigned](https://npm.im/selfsigned) before writing this

library, but it didn't seem to be well maintained and had a hard dependency

on an outdated version of [node-forge](https://npm.im/node-forge). This library

also depends on `node-forge`, but it does so with semver qualifiers such that

newer versions can be specified by the library user.

The keys and certs generated by this library are configured for usage in any

scenario. Also, the certificate Subject Alternate Names (SANs) are populated

with the IP addresses of the present network interfaces as returned by

`os.networkInterfaces()`.

## Example

```js

const selfCert = require('self-cert')

const certDetails = selfCert({

  attrs: {

    stateName: 'Georgia',

    locality: 'Atlanta',

    orgName: 'Acme Widgets',

    shortName: 'widget42'

  },

  expires: new Date('2030-12-31')

})

/* certDetails = {

  privateKey: 'pem formatted string',

  publicKey: 'pem formatted string',

  certificate: 'pem formatted string'

} */

```

## Options

```js

{

  attrs: {

    commonName: '', // Default: os.hostname()

    countryName: '', // Default: 'US'

    stateName: '', // Default: 'Georgia'

    locality: '', // Default: 'Atlanta'

    orgName: '', // Default: 'None'

    shortName: '' // Default: 'example'

  },

  bits: 4096, // Default: 4096

  expires: new Date(), // Default: 5 years

  logger: {}

}

```

Notes:

+ `commonName` is used for the first SAN.

+ `stateName` maps to `stateOrProvinceName`.

+ `logger` should be a Log4j compliant logger; [Pino](http://getpino.io/) is

recommended. This library logs some progress messages at the `debug` level.

The default is a null logger.

## CLI

This module may also be installed globally as a CLI tool:

```sh

$ npm install -g self-cert

$ self-cert generate --help

```

## License

[MIT License](http://jsumners.mit-license.org/)