JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 248004
  • Score
    100M100P100Q203321F
  • License MIT

jks-js is a converter of Java Key Store (JKS) to PEM certificates in order to securely connect to Java based servers using node js.

Package Exports

  • jks-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 (jks-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JKS-JS

npm test codecov

Description

jks-js is a converter of Java Keystore to PEM certificates in order to securely connect to Java based servers using node js.

Installation

npm install jks-js

Usage

...
const jks = require('jks-js');

const keystore = jks.toPem(
    fs.readFileSync('keystore.jks'),
    'password'
);

const { cert, key } = keystore['alias'];

after extraction you may use cert and key in your connection settings:

tls.connect('<port>', '<host>', {
    key: key,
    cert: cert,
});

more details

API

const {
    /**
     * Extracts certificates from java keystore or truststore
     * and decrypts private key 
     * 
     * @param keystore content of java keystore or truststore file
     * @param password password for verification and decryption
     * @return {
     *     <alias name>: {
     *         cert: string // compound certificates chain
     *         key: string // decrypted private key 
     *     } | {
     *         ca: string // trusted certificate
     *     }
     * }
     */
    toPem,

    /**
     *  Only extracts certificates
     *  @param keystore
     *  @param password
     *  @return { <alias name>: KeyEntry | TrustedKeyEntry }
     */
    parseJks,

    /**
     * Decrypts private key from DER to PEM
     *
     * @param protectedPrivateKey DER encoded private key
     * @param password password for PKCS8 decryption
     * @return decoded private key 
     */
    decrypt
} = require('jks-js');

How it works

The implementaion is based on JavaKeystore.java logic, which is internally used for creation of java keystore, including keytool.

It is supposed the keystore contains X.509 certificates.

But you may use the library to extract any of certificates.

The decryption constrained by alghorithms that implemented in the crypto module of Node.js.

Issues

If you find any troubles feel free to create an issue.

License

MIT License

Copyright (c) 2020 Volodymyr Liench