Package Exports

simple-open-ssl
simple-open-ssl/open-ssl.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (simple-open-ssl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Simple OpenSSL for Javascript

Execute OpenSSL commands directly from JavaScript.

Provides a simple, cross-platform interface for cryptographic operations, certificate management, and security tasks.

Usage:

import { runCommandSync } from 'simple-open-ssl';

const standardOutput = runCommandSync(`x509 -in certificate.pem -enddate -noout`);

Windows:

Uses the included packaged version

OpenSSL 3.2.3 3 Sep 2024 (Library: OpenSSL 3.2.3 3 Sep 2024)

Linux/Other:

Uses the local version of OpenSSl that is already installed

manual install required if its not
Debian: sudo apt install openssl
RHEL:   sudo yum install openssl
MacOS:  brew install openssl

Exports

`runCommandSync`

Executes an OpenSSL command synchronously.

Show jsdoc

/**
 * Executes an OpenSSL command synchronously.
 *
 * @description
 * This function runs OpenSSL commands with platform-specific handling:
 * - On Windows, it uses the packaged version of OpenSSL
 * - On other platforms (e.g., Linux, macOS), it uses the locally installed OpenSSL
 *
 * @param {string} opensslCommand - The OpenSSL command to be executed, including any arguments.
 * @param {Object} [execOptions] - Optional execution options for the synchronous command, Defaults to UTF-8 encoding if not provided.
 * @param {string} [execOptions.encoding='utf-8'] - The encoding to use for command output.
 * @param {string} [execOptions.cwd] - Current working directory for the command execution.
 * @param {Object} [execOptions.env] - Environment variables for the command.
 * 
 * @returns {string|undefined} The standard output from the executed command, or `undefined` if the command execution fails.
 */
export function runCommandSync(opensslCommand, execOptions = { encoding: 'utf-8' }) { /* */ }