@dotenvx/dotenvx 1.69.1 → 1.70.0

package/src/lib/main.d.ts

@@ -147,7 +147,7 @@ export interface DotenvConfigOptions {
   quiet?: boolean;
 
   /**
-   * Disable spinner output from child Dotenvx Ops commands.
+   * Disable spinner output from child Dotenvx Armor commands.
    *
    * @default false
    * @example require('@dotenvx/dotenvx').config({ noSpinner: true })
@@ -165,21 +165,29 @@ export interface DotenvConfigOptions {
     | 'debug';
 
   /**
-   * Turn off Dotenvx Vlt Ops features. Alias for `noVlt`.
+   * Turn off Dotenvx Armor features.
    *
    * @default false
-   * @example require('@dotenvx/dotenvx').config({ noOps: true })
+   * @example require('@dotenvx/dotenvx').config({ noArmor: true })
    */
-  noOps?: boolean;
+  noArmor?: boolean;
 
   /**
-   * Turn off Dotenvx Vlt Ops features.
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
    *
    * @default false
    * @example require('@dotenvx/dotenvx').config({ noVlt: true })
    */
   noVlt?: boolean;
 
+  /**
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').config({ noOps: true })
+   */
+  noOps?: boolean;
+
 }
 
 export type DotenvConfigEnv =
@@ -248,21 +256,29 @@ export interface SetOptions {
   encrypt?: boolean;
 
   /**
-   * Turn off Dotenvx Vlt Ops features. Alias for `noVlt`.
+   * Turn off Dotenvx Armor features.
    *
    * @default false
-   * @example require('@dotenvx/dotenvx').set(key, value, { noOps: true })
+   * @example require('@dotenvx/dotenvx').set(key, value, { noArmor: true })
    */
-  noOps?: boolean;
+  noArmor?: boolean;
 
   /**
-   * Turn off Dotenvx Vlt Ops features.
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
    *
    * @default false
    * @example require('@dotenvx/dotenvx').set(key, value, { noVlt: true })
    */
   noVlt?: boolean;
 
+  /**
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').set(key, value, { noOps: true })
+   */
+  noOps?: boolean;
+
 }
 
 export type SetProcessedEnv = {
@@ -333,21 +349,29 @@ export interface GetOptions {
   strict?: boolean;
 
   /**
-   * Turn off Dotenvx Vlt Ops features. Alias for `noVlt`.
+   * Turn off Dotenvx Armor features.
    *
    * @default false
-   * @example require('@dotenvx/dotenvx').get('KEY', { noOps: true })
+   * @example require('@dotenvx/dotenvx').get('KEY', { noArmor: true })
    */
-  noOps?: boolean;
+  noArmor?: boolean;
 
   /**
-   * Turn off Dotenvx Vlt Ops features.
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
    *
    * @default false
    * @example require('@dotenvx/dotenvx').get('KEY', { noVlt: true })
    */
   noVlt?: boolean;
 
+  /**
+   * Turn off Dotenvx Armor features. Alias for `noArmor`.
+   *
+   * @default false
+   * @example require('@dotenvx/dotenvx').get('KEY', { noOps: true })
+   */
+  noOps?: boolean;
+
 }
 
 /**

package/src/lib/main.js

@@ -20,7 +20,6 @@ const buildEnvs = require('./helpers/buildEnvs')
 const { determine } = require('./helpers/envResolution')
 const Parse = require('./helpers/parse')
 const fsx = require('./helpers/fsx')
-const localDisplayPath = require('./helpers/localDisplayPath')
 
 /** @type {import('./main').config} */
 const config = function (options = {}) {
@@ -48,8 +47,8 @@ const config = function (options = {}) {
     setLogVersion(options)
   }
 
-  // dotenvx-vlt related
-  const noVlt = resolveNoVlt(options)
+  // dotenvx-armor related
+  const noArmor = resolveNoArmor(options)
 
   try {
     let envs = buildEnvs(options)
@@ -60,7 +59,7 @@ const config = function (options = {}) {
       processedEnvs,
       readableFilepaths,
       uniqueInjectedKeys
-    } = new Run(envs, overload, processEnv, envKeysFile, noVlt, {
+    } = new Run(envs, overload, processEnv, envKeysFile, noArmor, {
       noSpinner: options.noSpinner
     }).runSync()
 
@@ -180,13 +179,13 @@ const set = function (key, value, options = {}) {
 
   const envs = buildEnvs(options)
   const envKeysFilepath = options.envKeysFile
-  const noVlt = resolveNoVlt(options)
+  const noArmor = resolveNoArmor(options)
 
   const {
     processedEnvs,
     changedFilepaths,
     unchangedFilepaths
-  } = new Sets(key, value, envs, encrypt, envKeysFilepath, noVlt).runSync()
+  } = new Sets(key, value, envs, encrypt, envKeysFilepath, noArmor).runSync()
 
   let withEncryption = ''
 
@@ -213,11 +212,8 @@ const set = function (key, value, options = {}) {
   const localKeyAddedEnv = processedEnvs.find((processedEnv) => processedEnv.localPrivateKeyAdded)
   const remoteKeyAddedEnv = processedEnvs.find((processedEnv) => processedEnv.remotePrivateKeyAdded)
 
-  if (localKeyAddedEnv) {
-    keyAddedSuffix = ` + local key (${localDisplayPath(localKeyAddedEnv.envKeysFilepath)})`
-  }
   if (remoteKeyAddedEnv) {
-    keyAddedSuffix = ' + armored key ⛨'
+    keyAddedSuffix = ' · armored ⛨'
   }
 
   if (changedFilepaths.length > 0) {
@@ -247,12 +243,12 @@ const set = function (key, value, options = {}) {
 /* @type {import('./main').get} */
 const get = function (key, options = {}) {
   const envs = buildEnvs(options)
-  const noVlt = resolveNoVlt(options)
+  const noArmor = resolveNoArmor(options)
 
   // ignore
   const ignore = options.ignore || []
 
-  const { parsed, errors } = new Get(key, envs, options.overload, options.all, options.envKeysFile, noVlt).runSync()
+  const { parsed, errors } = new Get(key, envs, options.overload, options.all, options.envKeysFile, noArmor).runSync()
 
   for (const error of errors || []) {
     if (ignore.includes(error.code)) {
@@ -317,8 +313,8 @@ const genexample = function (directory, envFile) {
 }
 
 /** @type {import('./main').keypair} */
-const keypair = function (envFile, key, envKeysFile = null, noVlt = false) {
-  const keypairs = new Keypair(envFile, envKeysFile, noVlt).runSync()
+const keypair = function (envFile, key, envKeysFile = null, noArmor = false) {
+  const keypairs = new Keypair(envFile, envKeysFile, noArmor).runSync()
   if (key) {
     return keypairs[key]
   } else {
@@ -326,9 +322,9 @@ const keypair = function (envFile, key, envKeysFile = null, noVlt = false) {
   }
 }
 
-function resolveNoVlt (options = {}) {
+function resolveNoArmor (options = {}) {
   const sesh = new Session()
-  return options.noVlt === true || options.noOps === true || sesh.noVltSync()
+  return options.noArmor === true || options.noVlt === true || options.noOps === true || sesh.noArmorSync()
 }
 
 module.exports = {

package/src/lib/services/decrypt.js

@@ -25,12 +25,12 @@ const dotenvParse = require('./../helpers/dotenvParse')
 const detectEncoding = require('./../helpers/detectEncoding')
 
 class Decrypt {
-  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noVlt = false) {
+  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noArmor = false) {
     this.envs = determine(envs, process.env)
     this.key = key
     this.excludeKey = excludeKey
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
 
     this.processedEnvs = []
     this.changedFilepaths = new Set()
@@ -77,9 +77,11 @@ class Decrypt {
       const envParsed = dotenvParse(envSrc, false, false, true)
 
       const { privateKeyName } = keyNames(envFilepath)
-      const { privateKeyValue } = await keyValues(envFilepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+      const { privateKeyValue, privateKeySource } = await keyValues(envFilepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
       row.privateKey = privateKeyValue
+      row.privateKeySource = privateKeySource
+      row.armoredPrivateKeyUsed = privateKeySource === 'armor'
       row.privateKeyName = privateKeyName
       row.changed = false // track possible changes
 

package/src/lib/services/encrypt.js

@@ -29,12 +29,12 @@ const detectEncoding = require('./../helpers/detectEncoding')
 const SAMPLE_ENV_KIT = require('./../helpers/kits/sample')
 
 class Encrypt {
-  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noVlt = false, noCreate = false, token = undefined, options = {}) {
+  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noArmor = false, noCreate = false, token = undefined, options = {}) {
     this.envs = determine(envs, process.env)
     this.key = key
     this.excludeKey = excludeKey
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
     this.noCreate = noCreate
     this.token = token
     this.keypairHooks = options.keypairHooks
@@ -105,7 +105,7 @@ class Encrypt {
       const { publicKeyName, privateKeyName } = keyNames(envFilepath)
       const { publicKeyValue, privateKeyValue } = await keyValues(envFilepath, {
         keysFilepath: this.envKeysFilepath,
-        noVlt: this.noVlt,
+        noArmor: this.noArmor,
         keypairHooks: this.keypairHooks
       })
 
@@ -115,7 +115,7 @@ class Encrypt {
           envSrc,
           envFilepath,
           keysFilepath: this.envKeysFilepath,
-          noVlt: this.noVlt,
+          noArmor: this.noArmor,
           token: this.token,
           keypairHooks: this.keypairHooks,
           selectKeyStorage: this.selectKeyStorage

package/src/lib/services/get.js

@@ -3,26 +3,26 @@ const Errors = require('./../helpers/errors')
 const { determine } = require('./../helpers/envResolution')
 
 class Get {
-  constructor (key, envs = [], overload = false, all = false, envKeysFilepath = null, noVlt = false) {
+  constructor (key, envs = [], overload = false, all = false, envKeysFilepath = null, noArmor = false) {
     this.key = key
     this.envs = envs
     this.overload = overload
     this.all = all
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
   }
 
   runSync () {
     const processEnv = { ...process.env }
     const envs = determine(this.envs, processEnv)
-    const { processedEnvs } = new Run(envs, this.overload, processEnv, this.envKeysFilepath, this.noVlt).runSync()
+    const { processedEnvs } = new Run(envs, this.overload, processEnv, this.envKeysFilepath, this.noArmor).runSync()
     return this._result(processedEnvs, processEnv)
   }
 
   async run () {
     const processEnv = { ...process.env }
     const envs = determine(this.envs, processEnv)
-    const { processedEnvs } = await new Run(envs, this.overload, processEnv, this.envKeysFilepath, this.noVlt).run()
+    const { processedEnvs } = await new Run(envs, this.overload, processEnv, this.envKeysFilepath, this.noArmor).run()
     return this._result(processedEnvs, processEnv)
   }
 

package/src/lib/services/keypair.js

@@ -5,10 +5,10 @@ const {
 } = require('./../helpers/keyResolution')
 
 class Keypair {
-  constructor (envFile = '.env', envKeysFilepath = null, noVlt = false) {
+  constructor (envFile = '.env', envKeysFilepath = null, noArmor = false) {
     this.envFile = envFile
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
   }
 
   runSync () {
@@ -17,7 +17,7 @@ class Keypair {
     const filepaths = this._filepaths()
     for (const filepath of filepaths) {
       const { publicKeyName, privateKeyName } = keyNames(filepath)
-      const { publicKeyValue, privateKeyValue } = keyValuesSync(filepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+      const { publicKeyValue, privateKeyValue } = keyValuesSync(filepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
       out[publicKeyName] = publicKeyValue
       out[privateKeyName] = privateKeyValue
@@ -32,7 +32,7 @@ class Keypair {
     const filepaths = this._filepaths()
     for (const filepath of filepaths) {
       const { publicKeyName, privateKeyName } = keyNames(filepath)
-      const { publicKeyValue, privateKeyValue } = await keyValues(filepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+      const { publicKeyValue, privateKeyValue } = await keyValues(filepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
       out[publicKeyName] = publicKeyValue
       out[privateKeyName] = privateKeyValue

package/src/lib/services/rotate.js

@@ -16,7 +16,7 @@ const {
 } = require('./../helpers/keyResolution')
 
 const {
-  vltKeypair,
+  armorKeypair,
   localKeypair,
   encryptValue,
   decryptKeyValue,
@@ -29,12 +29,12 @@ const dotenvParse = require('./../helpers/dotenvParse')
 const detectEncoding = require('./../helpers/detectEncoding')
 
 class Rotate {
-  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noVlt = false) {
+  constructor (envs = [], key = [], excludeKey = [], envKeysFilepath = null, noArmor = false) {
     this.envs = determine(envs, process.env)
     this.key = key
     this.excludeKey = excludeKey
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
 
     this.processedEnvs = []
     this.changedFilepaths = new Set()
@@ -83,15 +83,15 @@ class Rotate {
       const envParsed = dotenvParse(envSrc, false, false, true)
 
       const { publicKeyName, privateKeyName } = keyNames(envFilepath)
-      const { privateKeyValue } = await keyValues(envFilepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+      const { privateKeyValue } = await keyValues(envFilepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
       let newPublicKey
       let newPrivateKey
       let envKeysFilepath
       let envKeysSrc
 
-      if (!this.noVlt) {
-        const kp = await vltKeypair()
+      if (!this.noArmor) {
+        const kp = await armorKeypair()
         newPublicKey = kp.publicKey
         newPrivateKey = kp.privateKey
 
@@ -146,8 +146,8 @@ class Rotate {
       row.privateKeyName = privateKeyName
       row.privateKey = newPrivateKey
 
-      if (this.noVlt) {
-        // keys src only for vlt
+      if (this.noArmor) {
+        // keys src only for local key storage
         envKeysSrc = append(envKeysSrc, privateKeyName, newPrivateKey) // append privateKey
         this.envKeysSources[envKeysFilepath] = envKeysSrc
         row.envKeysSrc = envKeysSrc
@@ -158,7 +158,7 @@ class Rotate {
       if (e.code === 'ENOENT') {
         const missingPath = e.path ? path.resolve(e.path) : null
         const expectedEnvKeysPath = row.envKeysFilepath ? path.resolve(row.envKeysFilepath) : null
-        if (this.noVlt && expectedEnvKeysPath && missingPath === expectedEnvKeysPath) {
+        if (this.noArmor && expectedEnvKeysPath && missingPath === expectedEnvKeysPath) {
           row.error = new Errors({ envKeysFilepath: row.envKeysFilepath }).missingEnvKeysFile()
         } else {
           row.error = new Errors({ envFilepath, filepath }).missingEnvFile()

package/src/lib/services/run.js

@@ -17,12 +17,12 @@ const {
 } = require('./../helpers/keyResolution')
 
 class Run {
-  constructor (envs = [], overload = false, processEnv = process.env, envKeysFilepath = null, noVlt = false, options = {}) {
+  constructor (envs = [], overload = false, processEnv = process.env, envKeysFilepath = null, noArmor = false, options = {}) {
     this.envs = envs
     this.overload = overload
     this.processEnv = processEnv
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
     this.noSpinner = options.noSpinner
     this.keypairHooks = options.keypairHooks
 
@@ -93,8 +93,9 @@ class Run {
     try {
       const {
         privateKeyName: resolvedPrivateKeyName,
-        privateKeyValue
-      } = keyValuesFromEnvSrc(env, privateKeyName, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt, processEnv: this.processEnv })
+        privateKeyValue,
+        privateKeySource
+      } = keyValuesFromEnvSrc(env, privateKeyName, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor, processEnv: this.processEnv })
 
       const {
         parsed,
@@ -105,6 +106,10 @@ class Run {
 
       row.privateKeyName = resolvedPrivateKeyName
       row.privateKey = privateKeyValue
+      if (privateKeySource) {
+        row.privateKeySource = privateKeySource
+        row.armoredPrivateKeyUsed = privateKeySource === 'armor'
+      }
       row.parsed = parsed
       row.errors = errors
       row.injected = injected
@@ -136,9 +141,9 @@ class Run {
       this.readableFilepaths.add(envFilepath)
 
       const { privateKeyName } = keyNames(filepath)
-      const { privateKeyValue } = keyValuesSync(filepath, {
+      const { privateKeyValue, privateKeySource } = keyValuesSync(filepath, {
         keysFilepath: this.envKeysFilepath,
-        noVlt: this.noVlt,
+        noArmor: this.noArmor,
         noSpinner: this.noSpinner
       })
 
@@ -151,6 +156,10 @@ class Run {
 
       row.privateKeyName = privateKeyName
       row.privateKey = privateKeyValue
+      if (privateKeySource) {
+        row.privateKeySource = privateKeySource
+        row.armoredPrivateKeyUsed = privateKeySource === 'armor'
+      }
       row.src = src
       row.parsed = parsed
       row.errors = errors
@@ -185,9 +194,9 @@ class Run {
       this.readableFilepaths.add(envFilepath)
 
       const { privateKeyName } = keyNames(filepath)
-      const { privateKeyValue } = await keyValues(filepath, {
+      const { privateKeyValue, privateKeySource } = await keyValues(filepath, {
         keysFilepath: this.envKeysFilepath,
-        noVlt: this.noVlt,
+        noArmor: this.noArmor,
         keypairHooks: this.keypairHooks
       })
 
@@ -200,6 +209,10 @@ class Run {
 
       row.privateKeyName = privateKeyName
       row.privateKey = privateKeyValue
+      if (privateKeySource) {
+        row.privateKeySource = privateKeySource
+        row.armoredPrivateKeyUsed = privateKeySource === 'armor'
+      }
       row.src = src
       row.parsed = parsed
       row.errors = errors

package/src/lib/services/sets.js

@@ -34,13 +34,13 @@ function allValuesForKey (envSrc, key) {
 }
 
 class Sets {
-  constructor (key, value, envs = [], encrypt = true, envKeysFilepath = null, noVlt = false, noCreate = false) {
+  constructor (key, value, envs = [], encrypt = true, envKeysFilepath = null, noArmor = false, noCreate = false) {
     this.envs = determine(envs, process.env)
     this.key = key
     this.value = value
     this.encrypt = encrypt
     this.envKeysFilepath = envKeysFilepath
-    this.noVlt = noVlt
+    this.noArmor = noArmor
     this.noCreate = noCreate
 
     this.processedEnvs = []
@@ -131,11 +131,11 @@ class Sets {
         let privateKey
 
         const { publicKeyName, privateKeyName } = keyNames(filepath)
-        const { publicKeyValue, privateKeyValue } = keyValuesSync(filepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+        const { publicKeyValue, privateKeyValue } = keyValuesSync(filepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
         // first pass - provisionSync
         if (!privateKeyValue && !publicKeyValue) {
-          const prov = provisionSync({ envSrc, envFilepath, keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+          const prov = provisionSync({ envSrc, envFilepath, keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
           envSrc = prov.envSrc
           publicKey = prov.publicKey
           privateKey = prov.privateKey
@@ -238,11 +238,11 @@ class Sets {
         let privateKey
 
         const { publicKeyName, privateKeyName } = keyNames(filepath)
-        const { publicKeyValue, privateKeyValue } = await keyValues(filepath, { keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+        const { publicKeyValue, privateKeyValue } = await keyValues(filepath, { keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
 
         // first pass - provision
         if (!privateKeyValue && !publicKeyValue) {
-          const prov = await provision({ envSrc, envFilepath, keysFilepath: this.envKeysFilepath, noVlt: this.noVlt })
+          const prov = await provision({ envSrc, envFilepath, keysFilepath: this.envKeysFilepath, noArmor: this.noArmor })
           envSrc = prov.envSrc
           publicKey = prov.publicKey
           privateKey = prov.privateKey

package/src/cli/actions/normalizeVltOptions.js

@@ -1,10 +0,0 @@
-function normalizeVltOptions (options) {
-  if (options.ops === false || options.vlt === false) {
-    options.ops = false
-    options.vlt = false
-  }
-
-  return options
-}
-
-module.exports = normalizeVltOptions

package/src/lib/helpers/cryptography/vltKeypairSync.js

@@ -1,14 +0,0 @@
-const Vlt = require('../../extensions/vlt')
-
-function vltKeypairSync (existingPublicKey, options = {}) {
-  const kp = new Vlt().keypairSync(existingPublicKey, options)
-  const publicKey = kp.public_key
-  const privateKey = kp.private_key
-
-  return {
-    publicKey,
-    privateKey
-  }
-}
-
-module.exports = vltKeypairSync