Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgcrea/node-easyrsa
Node.js public key infrastructure management library inspired by EasyRSA.
https://github.com/mgcrea/node-easyrsa
cryptography
Last synced: about 1 month ago
JSON representation
Node.js public key infrastructure management library inspired by EasyRSA.
- Host: GitHub
- URL: https://github.com/mgcrea/node-easyrsa
- Owner: mgcrea
- License: mit
- Created: 2016-01-13T14:39:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-09T09:57:28.000Z (almost 7 years ago)
- Last Synced: 2024-11-25T14:55:26.452Z (about 2 months ago)
- Topics: cryptography
- Language: JavaScript
- Homepage:
- Size: 101 KB
- Stars: 36
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Node.js EasyRSA
[](https://www.npmjs.com/package/easyrsa)
[](https://tldrlegal.com/license/mit-license)
[](http://travis-ci.org/mgcrea/node-easyrsa)
[](https://david-dm.org/mgcrea/node-easyrsa)
[](https://david-dm.org/mgcrea/node-easyrsa#info=devDependencies)
[](https://www.codacy.com/app/mgcrea/node-easyrsa?utm_source=github.com&utm_medium=referral&utm_content=mgcrea/node-easyrsa&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/mgcrea/node-easyrsa?utm_source=github.com&utm_medium=referral&utm_content=mgcrea/node-easyrsa&utm_campaign=Badge_Coverage)
[](https://www.npmjs.com/package/easyrsa)
Node.js public key infrastructure management library inspired by [EasyRSA](https://github.com/OpenVPN/easy-rsa).
- Uses [forge](https://github.com/digitalbazaar/forge) to manage cryptography
- Provides ready-to-use templates to create your certificate authority: `vpn`, `ssl` or `mdm`.
- Available both as a cli and a lib.
- Provides easy-to-use templates for generic use cases (VPN, SSL, MDM)
- Can easily be plugged to a database backend.
## Quickstart
### VPN Server setup
- Command Line Interface
```bash
npm i -g easyrsa
easyrsa init-pki
easyrsa build-ca
easyrsa gen-req EntityName
easyrsa sign-req client EntityName
```
- Node.js usage
```js
import EasyRSA from 'easyrsa';
const easyrsa = new EasyRSA({pkiDir});
const pkiAttributes = {
organizationalUnitName: 'foo.online',
organizationName: 'Foo',
localityName: 'Paris',
stateOrProvinceName: 'Ile-de-France',
countryName: 'France'
}
// Build an OpenVPN infrastructure
easyrsa.initPKI()
.then(() => {
const commonName = `ca@${myHost}`;
const attributes = {
...pkiAttributes
};
log.warn('Building new CA ...');
return easyrsa.buildCA({commonName, attributes, serialNumberBytes: 9, privateKey: ca.privateKey})
.then(({privateKey, cert}) => {
log.info('Built new CA with serialNumber="%s"', cert.serialNumber);
});
})
.then(() => {
const commonName = `server@${myHost}`;
const attributes = {
...pkiAttributes,
unstructuredName: 'OpenVPN Service'
};
log.info('Generating new server certificate with commonName="%s" ...', commonName);
return easyrsa.createServer({commonName, attributes, privateKey: vpn.privateKey})
.then(({privateKey, csr, cert, serial, index}) => {
log.info('Built new certificate for commonName="%s" with serialNumber="%s"', commonName, cert.serialNumber);
});
})
.then(() => {
const commonName = 'client@${myHost}'
const {pkiAttributes} = this.config;
const attributes = {
...pkiAttributes,
unstructuredName: 'My first Client'
};
log.info('Generating new %s client for commonName="%s" ...', type, commonName);
return easyrsa.createClient({commonName, attributes, privateKey})
.then(({csr, cert, serial, index}) => {
log.info('Built new client certificate with commonName="%s" with serialNumber="%s"', commonName, cert.serialNumber);
});
})
```
## Testing
- You can quickly start hacking around
```bash
git clone -o github [email protected]:mgcrea/node-easyrsa.git
cd node-easyrsa
npm i
npm start
```
## Docs
- [EasyRSA quickstart](https://github.com/OpenVPN/easy-rsa/blob/master/README.quickstart.md)