ssl2

SSL Toolsets

ssl2 includes a collection of toolsets which will make it easier to manager certificates.

Table of contents

• Get Started
• API
• Examples
• Why ssl2
• Honorable Dependents
• About
• References

Links

• CHANGE LOG
• Homepage

Get Started

ssl2 offers both CLI (command line interface) and API (application programming interface).

# Install the package globally and command "ssl" will be available. 
npm install -g ssl2
 
# Run for manual. 
ssl2 help

It also offers API to be used in Node.js programs.

const ssl2cert = require('ssl2/cert');
ssl2cert.fingerprint('/path/to/certificate');

API

According to my design, ssl2 will be made up with several related but different toolsets. However, only cert is available now.

const ssl2cert = require('ssl2/cert');  // Recommended requirement.
const ssl2cert = requrie('ssl2').cert;  // It works but is not recommended.

ssl2cert.delete

To delete a certificate from system store (or KeyChain in Mac OS).

• ssl2cert.delete(string path)
  path is the pathname of the certificate to be deleted from system store.
• ssl2cert.delete(string hash)
  hash is SHA-1 hash of the certificate to be deleted from system store.
• ssl2cert.delete(object options)
  options SHOULD has one of properties path, hash or sha1. Property sha1 is alias of property hash.

ssl2cert.distrust

To distrust a certificate.

• ssl2cert.distrust(string path)
  path is the pathname of the certificate to be distrusted by system.
• ssl2cert.distrust(object options)
  options SHOULD has path property.

ssl2cert.fingerprint

Acquire the fingerprint of a certificate.

• ssl2cert.fingerprint(string path)
  path is the pathname of the certificate.
• ssl2cert.fingerprint(object options)
  options SHOULD has path property.

ssl2cert.import

Import a certificate into system store.

• ssl2cert.import(string path)
  path is the pathname of the certificate.
• ssl2cert.import(object options)
  options SHOULD has path property.

ssl2cert.trust

To trust a certificate.

• ssl2cert.trust(string path)
  path is the pathname of the certificate.
• ssl2cert.trust(object options)
  options SHOULD has path property.

ssl2cert.verify

To verify a certificate.

• ssl2cert.verify(string path)
  path is the pathname of the certificate.
• ssl2cert.verify(object options)
  options SHOULD has path property.

Examples

Why ssl2

Honorable Dependents

About

References

• OpenSSL, Binaries
• Microsoft, Manage Trusted Root Certificates
• Microsoft, Certmgr.exe (Certificate Manager Tool)
• What are JavaScript options objects?