# @splpa-org/cert-helper

> npm package to add openssl cert scripts to projects.

Latest version **1.0.5** (published 2024-02-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install @splpa-org/cert-helper
pnpm add @splpa-org/cert-helper
yarn add @splpa-org/cert-helper
bun add @splpa-org/cert-helper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-02-26 |
| First published | 2024-01-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Jose A. Vargas |
| Maintainers | splpa |
| Keywords | openssl, helper |

## Links

- npm: https://www.npmjs.com/package/@splpa-org/cert-helper
- Repository: https://github.com/splpa/cert-helper
- Homepage: https://github.com/splpa/cert-helper#readme
- Issues: https://github.com/splpa/cert-helper/issues
- npm.io page: https://npm.io/package/@splpa-org/cert-helper

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2024-02-26
- 1.0.4 — 2024-02-23
- 1.0.3 — 2024-02-23
- 1.0.2 — 2024-01-19
- 1.0.1 — 2024-01-19
- 1.0.0 — 2024-01-19

## README

# certHelper

certHelper is a small collection of scripts to implement TLS certificates for express web services.
Specifically designed to work with [spl-ca](https://github.com/splpa/spl-ca) webservice. 

## Installation

```bash
npm i --save @splpa-org/cert-helper
```
Then install the other use packages if you intend to use certManager.js
```bash
npm i --save jsrsasign node-cron axios
```
## Usage _certHelper.sh (Linux)
### linux:
Required: openssl to be installed and added to PATH variable.
```bash
  #Make executable
chmod +x _certHeler.sh
  #Run script, "service name" is the name of all the expected and generated files
./_certHelper.sh "service name" 
    #"service name.cfg" this is expected to exist and in the same format as the template.cfg file
    #"service name.key" this is expected to exist and is the private key name in PEM format
    #"service name.crt" this is the expected response DEM cert from spl-ca service. Place in certs/ directory.
    #"service name.pem" this is the the PEM formatted cert converted from the DEM "service name.crt" file.
    #enter all the info, alternative names must be done through the cfg file, they are not prompted through CLI.
    #Once you enter the info the CSR will be saved as "service name.req". 
    #Have this signed by your CA the place the DEM formatted cert as "service name.crt" and the script will 
    #auto convert the cert to PEM and prompt if you want to clean up the csr and crt file.
    #if you enter "y" it will just delete these files.
```
## Usage _certHelper.bat (Windows)
Required: openssl to be installed and added to PATH variable.
```cmd
  #Make executable
chmod +x _certHeler.sh
  #Run script, "service name" is the name of all the expected and generated files
./_certHelper.sh "service name" 
    #"service name.cfg" this is expected to exist and in the same format as the template.cfg file
    #"service name.key" this is expected to exist and is the private key name in PEM format
    #"service name.crt" this is the expected response DEM cert from spl-ca service. Place in certs/ directory.
    #"service name.pem" this is the the PEM formatted cert converted from the DEM "service name.crt" file.
    #enter all the info, alternative names must be done through the cfg file, they are not prompted through CLI.
    #Once you enter the info the CSR will be saved as "service name.req". 
    #Have this signed by your CA the place the DEM formatted cert as "service name.crt" and the script will 
    #auto convert the cert to PEM and prompt if you want to clean up the csr and crt file.
    #if you enter "y" it will just delete these files.
```
## Usage certManager.js
To use certManager.js you'll first have to install jsrsasign, node-cron, and axios
```bash
npm i --save jsrsasign node-cron axios
```
You will then need to import the module
```javascript
const { checkCert } = require("./certs/certManager.js");
let checkCertCB = (res) => {
  //as configured this runs the first time and will run in the cron task if passed to checkCert
  let {isError, isDue, msg} = res;
  if ( isError ) {
    //Error checking the cert, msg has error message
  } else if ( isDue ) {
    //the was due and was auto renewed, msg has success message
  } else {
    //was not due and there was no error checking.
  }
}
checkCertCB( await checkCert("pem_cert_path", "pem_key_path", "cert_cfg_path", checkCertCB, "env_file_path") );
```

## Contributing

Not really looking for input, though I will check out suggestion or modifications. This is mainly to import into my own custom services.

---
_Source: https://npm.io/package/@splpa-org/cert-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
