helper.js

- Jump To … +
  lib/helper.js lib/openssl.js lib/pem.js

- # helper.js

- ¶

      'use strict'

      var pathlib = require('path')
      var fs = require('fs')
      var crypto = require('crypto')
      var osTmpdir = require('os-tmpdir')
      var tempDir = process.env.PEMJS_TMPDIR || osTmpdir()

      /**
       * pem helper module
       *
       * @module helper
       */

      /**
       * helper function to check is the string a number or not
       * @param {String} str String that should be checked to be a number
       */
      module.exports.isNumber = function (str) {
        if (Array.isArray(str)) {
          return false
        }
        /*
        var bstr = str && str.toString()
        str = str + ''

        return bstr - parseFloat(bstr) + 1 >= 0 &&
                !/^\s+|\s+$/g.test(str) && /^\d+$/g.test(str) &&
                !isNaN(str) && !isNaN(parseFloat(str))
        */
        return /^\d+$/g.test(str)
      }

      /**
       * helper function to check is the string a hexaceximal value
       * @param {String} hex String that should be checked to be a hexaceximal
       */
      module.exports.isHex = function isHex (hex) {
        return /^(0x){0,1}([0-9A-F]{1,40}|[0-9A-F]{1,40})$/gi.test(hex)
      }

      /**
       * helper function to convert a string to a hexaceximal value
       * @param {String} str String that should be converted to a hexaceximal
       */
      module.exports.toHex = function toHex (str) {
        var hex = ''
        for (var i = 0; i < str.length; i++) {
          hex += '' + str.charCodeAt(i).toString(16)
        }
        return hex
      }

- ¶

  cipherPassword returns an array of supported ciphers.

      /**
       * list of supported ciphers
       * @type {Array}
       */
      module.exports.ciphers = ['aes128', 'aes192', 'aes256', 'camellia128', 'camellia192', 'camellia256', 'des', 'des3', 'idea']
      var ciphers = module.exports.ciphers

      /**
       * Creates a PasswordFile to hide the password form process infos via `ps auxf` etc.
       * @param {Object} options object of cipher, password and passType, mustPass, {cipher:'aes128', password:'xxxx', passType:"in/out/word"}, if the object empty we do nothing
       * @param {String} options.cipher cipher like 'aes128', 'aes192', 'aes256', 'camellia128', 'camellia192', 'camellia256', 'des', 'des3', 'idea'
       * @param {String} options.password password can be empty or at last 4 to 1023 chars
       * @param {String} options.passType passType: can be in/out/word for passIN/passOUT/passWORD
       * @param {Boolean} options.mustPass mustPass is used when you need to set the pass like as "-password pass:" most needed when empty password
       * @param {Object} params params will be extended with the data that need for the openssl command. IS USED AS POINTER!
       * @param {String} PasswordFileArray PasswordFileArray is an array of filePaths that later need to deleted ,after the openssl command. IS USED AS POINTER!
       * @return {Boolean} result
       */
      module.exports.createPasswordFile = function (options, params, PasswordFileArray) {
        if (!options || !Object.prototype.hasOwnProperty.call(options, 'password') || !Object.prototype.hasOwnProperty.call(options, 'passType') || !/^(word|in|out)$/.test(options.passType)) {
          return false
        }
        var PasswordFile = pathlib.join(tempDir, crypto.randomBytes(20).toString('hex'))
        PasswordFileArray.push(PasswordFile)
        options.password = options.password.trim()
        if (options.password === '') {
          options.mustPass = true
        }
        if (options.cipher && (ciphers.indexOf(options.cipher) !== -1)) {
          params.push('-' + options.cipher)
        }
        params.push('-pass' + options.passType)
        if (options.mustPass) {
          params.push('pass:' + options.password)
        } else {
          fs.writeFileSync(PasswordFile, options.password)
          params.push('file:' + PasswordFile)
        }
        return true
      }

      /**
       * Deletes a file or an array of files
       * @param {Array} files array of files that shoudld be deleted
       * @param {errorCallback} callback Callback function with an error object
       */
      module.exports.deleteTempFiles = function (files, callback) {
        var rmFiles = []
        if (typeof files === 'string') {
          rmFiles.push(files)
        } else if (Array.isArray(files)) {
          rmFiles = files
        } else {
          return callback(new Error('Unexcepted files parameter type; only string or array supported'))
        }
        var deleteSeries = function (list, finalCallback) {
          if (list.length) {
            var file = list.shift()
            var myCallback = function (err) {
              if (err && err.code === 'ENOENT') {

- ¶

  file doens’t exist

                return deleteSeries(list, finalCallback)
              } else if (err) {

- ¶

  other errors, e.g. maybe we don’t have enough permission

                return finalCallback(err)
              } else {
                return deleteSeries(list, finalCallback)
              }
            }
            if (file && typeof file === 'string') {
              fs.unlink(file, myCallback)
            } else {
              return deleteSeries(list, finalCallback)
            }
          } else {
            return finalCallback(null) // no errors
          }
        }
        deleteSeries(rmFiles, callback)
      }
      /**
       * Callback for return an error object.
       * @callback errorCallback
       * @param {Error} err - An Error Object or null
       */