Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marianozunino/openssl-ts
Openssl-ts is a modern openssl wrapper written in typescript with 0 dependencies.
https://github.com/marianozunino/openssl-ts
nodejs openssl typescript wrapper
Last synced: about 6 hours ago
JSON representation
Openssl-ts is a modern openssl wrapper written in typescript with 0 dependencies.
- Host: GitHub
- URL: https://github.com/marianozunino/openssl-ts
- Owner: marianozunino
- License: mit
- Created: 2022-02-28T19:22:56.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T19:29:52.000Z (about 1 year ago)
- Last Synced: 2024-08-10T09:14:53.629Z (5 months ago)
- Topics: nodejs, openssl, typescript, wrapper
- Language: TypeScript
- Homepage:
- Size: 666 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/marianozunino/morpheus/actions/workflows/build_deploy.yml)
[](https://opensource.org/licenses/MIT)
[](https://coveralls.io/github/marianozunino/openssl-ts)
[](https://npmjs.com/package/openssl-ts)
# Openssl Ts
Openssl-ts is a modern openssl **wrapper** written in typescript with 0 dependencies.
This library is not responsible of doing any filesystem operations (read/write).
It just handles the openssl calls.
Output from openssl should be **handled by the caller (you)**.
> This project has been testing with Node >= v8.17 and with openssl >= 1.1.1m
# Installation
Using npm:
```sh
npm install openssl-ts
```
or using the [Yarn](https://yarnpkg.com) package manager:
```sh
yarn add openssl-ts
```
# Usage
The signature is pretty simple:
First parameter is an array of strings (openssl arguments).
The second parameter is an optional object with the following properties:
- `opensslPath`: path to the openssl executable.
You can override this by using the `OPENSSL_PATH` environment variable as well.
Default: `openssl` (must be in the PATH)
- `stdin`: buffer to be passed to openssl as stdin
This would be like using `cat` and piping the input to openssl.
example: `cat private.key | openssl rsa -check`
This is useful when the content is already in RAM, and you want to pass it to OpenSSL without having to write it to a file first.
**Notice**: `cat` is not being used to pipe the input to openssl.
# Examples
Using out flag
```ts
import { openssl } from 'openssl-ts';
const output = await openssl(['genrsa', '-out', 'private.key', '2048']);
// output is a Buffer
console.log(output.toString());
/*
Generating RSA private key, 2048 bit long modulus (2 primes)
................................................+++++
...........+++++
e is 65537 (0x010001)
*/
// if you want the private.key content, you should read the file from the filesystem
```
Without out flag
```ts
import { openssl } from 'openssl-ts';
const output = await openssl(['genrsa', '2048']);
// output is a Buffer
console.log(output.toString());
/*
Generating RSA private key, 2048 bit long modulus (2 primes)
....................................................................+++++
.............................+++++
e is 65537 (0x010001)
-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEAoNKO2MDD9TzZ9KpSJ7JAuIWDhTY5qZJGbgUltnUKqTts+A7s
...
-----END RSA PRIVATE KEY-----
*/
// if you want just the key you must parse the output
```
Using in flag
```ts
import { openssl } from 'openssl-ts';
const output = await openssl(['rsa', '-in', 'private.key', '-check']);
// output is a Buffer
console.log(output.toString());
/*
RSA key ok
writing RSA key
-----BEGIN RSA PRIVATE KEY-----
....
-----END RSA PRIVATE KEY-----
*/
```
Piping STDIN to openssl
```ts
import { openssl } from 'openssl-ts';
const buffer = readFileSync('private.key');
const output = await openssl(['rsa', 'check'], {
stdin: buffer,
});
// output is a Buffer
console.log(output.toString());
/*
RSA key ok
writing RSA key
-----BEGIN RSA PRIVATE KEY-----
....
-----END RSA PRIVATE KEY-----
*/
```
NestJS Example
You can find an example of how to use this library in a NestJS project in the **examples** folder.
PS: Is just the same as the previous examples, but with a NestJS service.
# Tests
Running all test:
```sh
yarn test
```
Running with coverage:
```sh
yarn test:cov
```
# Debugging
You can use the `NODE_DEBUG` environment variable to enable debugging.
Example:
```sh
NODE_DEBUG=openssl node yourscript.js
```
This will print the openssl command that will be executed and its parameters.