Neighbour Problem Manager

    @imdevesh/verify-valid-ssl

    1.0.2 • Public • Published

    Verify valid SSL Certs

    npm version

    This module is a validator for SSL Certificates using the PEM node module. You can validate SSL Keys, SSL Certificates, SSL Certificate Domains, SSL Certificate Bundles, etc.

    Installation

    npm i @imdevesh/verify-valid-ssl

    or

    yarn add @imdevesh/verify-valid-ssl

    API Documentation

    All of these functions will throw an error if something is invalid, except the isValid functions, which will return true or false.

    Validate SSL

    const { validateSSL } = require("@imdevesh/verify-valid-ssl");
    
    await validateSSL(cert, options);
    Option Type Default Description
    skipDateValidation Boolean false Skip verifying the certificate's and/or bundle's validity period.
    key String When given, validates that the key and certificate are a pair.
    domain String When given, verifies the certificate is valid for this domain. e.g. 'github.com'
    bundle String When given, verifies the certificate bundle and certificate go together.

    Validate SSL Cert

    This function validates that the certificate is an SSL certificate and checks the validity period.

    const { validateSSLCert } = require("@imdevesh/verify-valid-ssl");
    await validateSSLCert(cert, options);
    Option Type Default Description
    skipDateValidation Boolean false Skip verifying the given certificate's validity period.

    Validate SSL Key

    This function validates that the certificate is an SSL certificate and checks the validity period.

    const { validateSSLKey } = require("@imdevesh/verify-valid-ssl");
    await validateSSLKey(key);

    Validate Cert Bundle

    This function validates that the certificate and the bundle are certificates, and ensures that the bundle and certificate go together.

    const { validateCertBundle } = require("@imdevesh/verify-valid-ssl";
    await validateCertBundle(cert, bundle, options);
    Option Type Default Description
    skipDateValidation Boolean false Skip verifying the certificate's and bundle's validity period.

    Validate Cert Key Pair

    This function validates that the given certificate and key are a matching pair.

    const { validateCertKeyPair } = require("@imdevesh/verify-valid-ssl");
    await validateCertKeyPair(cert, key, options);
    Option Type Default Description
    skipDateValidation Boolean false Skip verifying the given certificate's validity period.

    Validate Cert To Domain

    This function validates the given certificate and that it matches the given domain.

    const { validateCertToDomain } = require("@imdevesh/verify-valid-ssl");
    await validateCertToDomain(cert, domain, options);
    Option Type Default Description
    skipDateValidation Boolean false Skip verifying the given certificate's validity period.

    IsValid Functions

    Each of the functions listed above (validateSSL, validateSSLCert, etc.) has a counterpart that will not throw any errors but will return true when valid and false when not valid. All arguments and options are listed above are valid.

    Original Function Name Predicate Function Name
    validateSSL isValidSSL
    validateSSLCert isValidSSLCert
    validateSSLKey isValidSSLKey
    validateCertBundle isValidCertBundle
    validateCertKeyPair isValidCertKeyPair
    validateCertToDomain isValidCertToDomain
    const { isValidSSL } = require("@imdevesh/verify-valid-ssl");
    if (!(await isValidSSL(cert))) {
        return { message: "Sorry, the certificate supplied is not valid." };
    }

    License

    The module is available as open source under the terms of the Apache v2.0.

    Install

    npm i @imdevesh/verify-valid-ssl

    DownloadsWeekly Downloads

    0

    Version

    1.0.2

    License

    Apache 2.0

    Unpacked Size

    50.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • imdevesh