@dotenvx/next-env 0.1.0 → 1.74.3

package/node_modules/@dotenvx/dotenvx/src/cli/commands/armor.js

@@ -0,0 +1,72 @@
+const executeDynamic = require('./../../lib/helpers/executeDynamic')
+const Session = require('./../../db/session')
+
+function configureArmorCommand (armor) {
+  armor
+    .description('move private keys off-device')
+    .allowUnknownOption()
+    .argument('[command]', 'dotenvx-armor command')
+    .argument('[args...]', 'dotenvx-armor command arguments')
+    .action(async function (command, args) {
+      if (command) {
+        return executeDynamic(armor, 'armor', [command, ...(args || [])])
+      }
+
+      const sesh = new Session()
+      await sesh.notifyUpdate()
+      this.help()
+    })
+
+  // dotenvx armor up
+  const upAction = require('./../actions/armor/up')
+  armor
+    .command('up')
+    .description('armor key')
+    .option('-f, --env-file <path>', 'path to your env file')
+    .option('--token <token>', 'set token')
+    .option('--team <team>', 'team to armor private key for')
+    .action(upAction)
+
+  // dotenvx armor down
+  const downAction = require('./../actions/armor/down')
+  armor
+    .command('down')
+    .description('dearmor key')
+    .option('-f, --env-file <path>', 'path to your env file')
+    .option('--token <token>', 'set token')
+    .option('--team <team>', 'team to dearmor private key from')
+    .action(downAction)
+
+  // dotenvx armor push
+  const pushAction = require('./../actions/armor/push')
+  armor
+    .command('push')
+    .description('push armored key (from .env.keys)')
+    .option('-f, --env-file <path>', 'path to your env file')
+    .option('--token <token>', 'set token')
+    .option('--team <team>', 'team to push armored private key for')
+    .action(pushAction)
+
+  // dotenvx armor pull
+  const pullAction = require('./../actions/armor/pull')
+  armor
+    .command('pull')
+    .description('pull armored key (into .env.keys)')
+    .option('-f, --env-file <path>', 'path to your env file')
+    .option('--token <token>', 'set token')
+    .option('--team <team>', 'team to pull armored private key from')
+    .action(pullAction)
+
+  // dotenvx armor move
+  const moveAction = require('./../actions/armor/move')
+  armor
+    .command('move')
+    .description('move armored key (to other team)')
+    .option('-f, --env-file <path>', 'path to your env file')
+    .option('--token <token>', 'set token')
+    .action(moveAction)
+
+  return armor
+}
+
+module.exports = configureArmorCommand

package/node_modules/@dotenvx/dotenvx/src/cli/commands/ext.js

@@ -0,0 +1,85 @@
+const { Command } = require('commander')
+
+const examples = require('./../examples')
+const executeExtension = require('../../lib/helpers/executeExtension')
+const removeDynamicHelpSection = require('../../lib/helpers/removeDynamicHelpSection')
+
+const ext = new Command('ext')
+
+ext
+  .description('🔌 extensions')
+  .allowUnknownOption()
+
+ext
+  .argument('[command]', 'dynamic ext command')
+  .argument('[args...]', 'dynamic ext command arguments')
+  .action((command, args, cmdObj) => {
+    const rawArgs = process.argv.slice(3) // adjust the index based on where actual args start
+    executeExtension(ext, command, rawArgs)
+  })
+
+// dotenvx ext ls
+ext.command('ls')
+  .description('print all .env files in a tree structure')
+  .argument('[directory]', 'directory to list .env files from', '.')
+  .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
+  .option('-ef, --exclude-env-file <excludeFilenames...>', 'path(s) to exclude from your env file(s) (default: none)')
+  .action(function (...args) {
+    return require('./../actions/ls').apply(this, args)
+  })
+
+// dotenvx ext genexample
+ext.command('genexample')
+  .description('generate .env.example')
+  .argument('[directory]', 'directory to generate from', '.')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', '.env')
+  .action(function (...args) {
+    return require('./../actions/ext/genexample').apply(this, args)
+  })
+
+// dotenvx ext gitignore
+ext.command('gitignore')
+  .description('append to .gitignore file (and if existing, .dockerignore, .npmignore, and .vercelignore)')
+  .addHelpText('after', examples.gitignore)
+  .option('--pattern <patterns...>', 'pattern(s) to gitignore', ['.env*'])
+  .action(function (...args) {
+    return require('./../actions/ext/gitignore').apply(this, args)
+  })
+
+// dotenvx ext prebuild
+ext.command('prebuild')
+  .description('prevent including .env files in docker builds')
+  .addHelpText('after', examples.prebuild)
+  .argument('[directory]', 'directory to prevent including .env files from', '.')
+  .action(function (...args) {
+    return require('./../actions/ext/prebuild').apply(this, args)
+  })
+
+// dotenvx ext precommit
+ext.command('precommit')
+  .description('prevent committing .env files to code')
+  .addHelpText('after', examples.precommit)
+  .argument('[directory]', 'directory to prevent committing .env files from', '.')
+  .option('-i, --install', 'install to .git/hooks/pre-commit')
+  .action(function (...args) {
+    return require('./../actions/ext/precommit').apply(this, args)
+  })
+
+// dotenvx ext scan
+ext.command('scan')
+  .description('scan for leaked secrets')
+  .action(function (...args) {
+    return require('./../actions/ext/scan').apply(this, args)
+  })
+
+// override helpInformation to hide dynamic commands
+ext.helpInformation = function () {
+  const originalHelp = Command.prototype.helpInformation.call(this)
+  const lines = originalHelp.split('\n')
+
+  removeDynamicHelpSection(lines)
+
+  return lines.join('\n')
+}
+
+module.exports = ext

package/node_modules/@dotenvx/dotenvx/src/cli/dotenvx.js

@@ -0,0 +1,297 @@
+#!/usr/bin/env node
+
+/* c8 ignore start */
+const { Command, Option } = require('commander')
+const program = new Command()
+
+const { setLogLevel, logger } = require('../shared/logger')
+const examples = require('./examples')
+const packageJson = require('./../lib/helpers/packageJson')
+const Errors = require('./../lib/helpers/errors')
+const getCommanderVersion = require('./../lib/helpers/getCommanderVersion')
+const executeDynamic = require('./../lib/helpers/executeDynamic')
+const removeDynamicHelpSection = require('./../lib/helpers/removeDynamicHelpSection')
+const removeOptionsHelpParts = require('./../lib/helpers/removeOptionsHelpParts')
+
+// for use with run
+const envs = []
+function collectEnvs (type) {
+  return function (value, previous) {
+    envs.push({ type, value })
+    return previous.concat([value])
+  }
+}
+
+// surface hoisting problems
+const commanderVersion = getCommanderVersion()
+if (commanderVersion && parseInt(commanderVersion.split('.')[0], 10) >= 12) {
+  const message = `dotenvx depends on commander@11.x.x but you are attempting to hoist commander@${commanderVersion}`
+  const error = new Errors({ message }).dangerousDependencyHoist()
+  logger.error(error.messageWithHelp)
+}
+
+// global log levels
+program
+  .usage('run -- yourcommand')
+  .option('-l, --log-level <level>', 'set log level', 'info')
+  .option('-q, --quiet', 'sets log level to error')
+  .option('-v, --verbose', 'sets log level to verbose')
+  .option('-d, --debug', 'sets log level to debug')
+  .hook('preAction', (thisCommand, actionCommand) => {
+    const options = thisCommand.opts()
+
+    setLogLevel(options)
+  })
+
+// for dynamic loading of dotenvx-armor, etc
+program
+  .argument('[command]', 'dynamic command')
+  .argument('[args...]', 'dynamic command arguments')
+  .action((command, args, cmdObj) => {
+    const rawArgs = process.argv.slice(3) // adjust the index based on where actual args start
+    executeDynamic(program, command, rawArgs)
+  })
+
+// cli
+program
+  .name('dotenvx')
+  .description(packageJson.description)
+  .version(packageJson.version)
+  .allowUnknownOption()
+
+// dotenvx run -- node index.js
+program.command('run')
+  .description('inject env at runtime [dotenvx run -- yourcommand]')
+  .addHelpText('after', examples.run)
+  .option('-e, --env <strings...>', 'environment variable(s) set as string (example: "HELLO=World")', collectEnvs('env'), [])
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-o, --overload', 'override existing env variables (by default, existing env vars take precedence over .env files)')
+  .option('--strict', 'process.exit(1) on any errors', false)
+  .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\', \'flow\'])')
+  .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
+  .option('--token <token>', 'set Armor ⛨ token')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/run').apply(this, args)
+  })
+
+// dotenvx get
+program.command('get')
+  .usage('[KEY] [options]')
+  .description('return a single environment variable')
+  .argument('[KEY]', 'environment variable name')
+  .option('-e, --env <strings...>', 'environment variable(s) set as string (example: "HELLO=World")', collectEnvs('env'), [])
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-o, --overload', 'override existing env variables (by default, existing env vars take precedence over .env files)')
+  .option('--strict', 'process.exit(1) on any errors', false)
+  .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\', \'flow\'])')
+  .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
+  .option('-a, --all', 'include all machine envs as well')
+  .option('-pp, --pretty-print', 'pretty print output')
+  .option('--pp', 'pretty print output (alias)')
+  .option('--format <type>', 'format of the output (json, shell, colon, eval)', 'json')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/get').apply(this, args)
+  })
+
+// dotenvx set
+program.command('set')
+  .usage('<KEY> <value> [options]')
+  .description('encrypt a single environment variable')
+  .addHelpText('after', examples.set)
+  .allowUnknownOption()
+  .argument('KEY', 'KEY')
+  .argument('value', 'value')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-c, --encrypt', 'encrypt value', true)
+  .option('-p, --plain', 'store value as plain text', false)
+  .option('--no-create', 'do not create .env file(s) when missing')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/set').apply(this, args)
+  })
+
+// dotenvx encrypt
+program.command('encrypt')
+  .description('encrypt .env file(s)')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-k, --key <keys...>', 'keys(s) to encrypt (default: all keys in file)')
+  .option('-ek, --exclude-key <excludeKeys...>', 'keys(s) to exclude from encryption (default: none)')
+  .option('--stdout', 'send to stdout')
+  .option('--token <token>', 'set Armor ⛨ token')
+  .option('--no-create', 'do not create .env file(s) when missing')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/encrypt').apply(this, args)
+  })
+
+// dotenvx decrypt
+program.command('decrypt')
+  .description('decrypt .env file(s)')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-k, --key <keys...>', 'keys(s) to decrypt (default: all keys in file)')
+  .option('-ek, --exclude-key <excludeKeys...>', 'keys(s) to exclude from decryption (default: none)')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .option('--stdout', 'send to stdout')
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/decrypt').apply(this, args)
+  })
+
+// dotenvx rotate
+program.command('rotate')
+  .description('rotate keypair(s) and re-encrypt .env file(s)')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('-k, --key <keys...>', 'keys(s) to encrypt (default: all keys in file)')
+  .option('-ek, --exclude-key <excludeKeys...>', 'keys(s) to exclude from encryption (default: none)')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .option('--stdout', 'send to stdout')
+  .action(function (...args) {
+    this.envs = envs
+    return require('./actions/rotate').apply(this, args)
+  })
+
+// dotenvx keypair
+program.command('keypair')
+  .usage('[KEY] [options]')
+  .description('print public/private keys for .env file(s)')
+  .argument('[KEY]', 'environment variable key name')
+  .option('-f, --env-file <paths...>', 'path(s) to your env file(s)')
+  .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
+  .option('--no-armor', 'disable dotenvx-armor features')
+  .addOption(new Option('--no-ops', 'disable dotenvx-ops features (deprecated. use --no-armor)').hideHelp())
+  .option('-pp, --pretty-print', 'pretty print output')
+  .option('--pp', 'pretty print output (alias)')
+  .option('--format <type>', 'format of the output (json, shell, colon)', 'json')
+  .action(function (...args) {
+    return require('./actions/keypair').apply(this, args)
+  })
+
+// dotenvx ls
+program.command('ls')
+  .description('print all .env files in a tree structure')
+  .argument('[directory]', 'directory to list .env files from', '.')
+  .option('-f, --env-file <filenames...>', 'path(s) to your env file(s)', '.env*')
+  .option('-ef, --exclude-env-file <excludeFilenames...>', 'path(s) to exclude from your env file(s) (default: none)')
+  .action(function (...args) {
+    return require('./actions/ls').apply(this, args)
+  })
+
+// dotenvx doctor
+program.command('doctor', { hidden: true })
+  .description('scan for dotenv loaders')
+  .argument('[directory]', 'directory to scan', '.')
+  .action(function (...args) {
+    return require('./actions/doctor').apply(this, args)
+  })
+
+// dotenvx login
+program.command('login', { hidden: true })
+  .description('log in to move keys off-device, share with your team, and audit access')
+  .allowUnknownOption()
+  .option('--hostname <hostname>', 'set Armor ⛨ hostname')
+  .action(function (...args) {
+    return require('./actions/login').apply(this, args)
+  })
+
+// dotenvx logout
+program.command('logout', { hidden: true })
+  .description('log out of connected security features')
+  .allowUnknownOption()
+  .option('--hostname <hostname>', 'set Armor ⛨ hostname')
+  .action(function (...args) {
+    return require('./actions/logout').apply(this, args)
+  })
+
+// dotenvx help
+program.command('help [command]')
+  .description('display help for command')
+  .action((command) => {
+    if (command) {
+      const subCommand = program.commands.find(c => c.name() === command)
+      if (subCommand) {
+        subCommand.outputHelp()
+      } else {
+        program.outputHelp()
+      }
+    } else {
+      program.outputHelp()
+    }
+  })
+
+// dotenvx armor
+program.addHelpText('after', ' ')
+program.addHelpText('after', 'Professional Security: ')
+program.addHelpText('after', '  login                    log in to move keys off-device, share with your team, and audit access')
+program.addHelpText('after', '  logout                   log out of connected security features')
+program.addHelpText('after', '  armor                    ⛨ move private keys off-device [www.dotenvx.com/armor]')
+program.addHelpText('after', '  ext                      ⊕ extensions')
+
+// dotenvx armor
+require('./commands/armor')(program.command('armor', { hidden: true }))
+
+// dotenvx ext
+program.addCommand(require('./commands/ext'))
+
+//
+// MOVED
+//
+program.command('prebuild')
+  .description('DEPRECATED: moved to [dotenvx ext prebuild]')
+  .addHelpText('after', examples.prebuild)
+  .argument('[directory]', 'directory to prevent including .env files from', '.')
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [prebuild] has moved to [dotenvx ext prebuild]')
+
+    require('./actions/ext/prebuild').apply(this, args)
+  })
+
+program.command('precommit')
+  .description('DEPRECATED: moved to [dotenvx ext precommit]')
+  .addHelpText('after', examples.precommit)
+  .argument('[directory]', 'directory to prevent committing .env files from', '.')
+  .option('-i, --install', 'install to .git/hooks/pre-commit')
+  .action(function (...args) {
+    logger.warn('DEPRECATION NOTICE: [precommit] has moved to [dotenvx ext precommit]')
+
+    require('./actions/ext/precommit').apply(this, args)
+  })
+
+// override helpInformation to hide DEPRECATED and 'ext' commands
+program.helpInformation = function () {
+  const originalHelp = Command.prototype.helpInformation.call(this)
+  const lines = originalHelp.split('\n')
+
+  removeDynamicHelpSection(lines)
+  removeOptionsHelpParts(lines)
+
+  // Filter out the hidden command from the help output
+  const filteredLines = lines.filter(line =>
+    !line.includes('DEPRECATED') &&
+    !line.includes('help [command]') &&
+    !line.includes('🔌 extensions') &&
+    !/^\s*ls\b/.test(line)
+  )
+
+  return filteredLines.join('\n')
+}
+/* c8 ignore stop */
+
+program.parse(process.argv)

package/node_modules/@dotenvx/dotenvx/src/cli/examples.js

@@ -0,0 +1,99 @@
+const run = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx run -- npm run dev
+  $ dotenvx run -- flask --app index run
+  $ dotenvx run -- php artisan serve
+  $ dotenvx run -- bin/rails s
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ echo "HELLO=World" > .env
+  $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
+
+  $ dotenvx run -f .env -- node index.js
+  [dotenvx] injected env (1) from .env
+  Hello World
+  \`\`\`
+  `
+}
+
+const precommit = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx ext precommit
+  $ dotenvx ext precommit --install
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ dotenvx ext precommit
+  [dotenvx@0.45.0][precommit] success
+  \`\`\`
+  `
+}
+
+const prebuild = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx ext prebuild
+  \`\`\`
+
+Try it:
+
+  \`\`\`
+  $ dotenvx ext prebuild
+  [dotenvx@0.10.0][prebuild] success
+  \`\`\`
+  `
+}
+
+const gitignore = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx ext gitignore
+  $ dotenvx ext gitignore --pattern .env.keys
+  \`\`\`
+
+  Try it:
+
+  \`\`\`
+  $ dotenvx ext gitignore
+  ▣ ignored .env* (.gitignore)
+  \`\`\`
+  `
+}
+
+const set = function () {
+  return `
+Examples:
+
+  \`\`\`
+  $ dotenvx set KEY value
+  $ dotenvx set KEY "value with spaces"
+  $ dotenvx set KEY -- "---value with a dash---"
+  $ dotenvx set KEY -- "-----BEGIN OPENSSH PRIVATE KEY-----
+                        b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
+                        -----END OPENSSH PRIVATE KEY-----"
+  \`\`\`
+  `
+}
+
+module.exports = {
+  run,
+  precommit,
+  prebuild,
+  gitignore,
+  set
+}

package/node_modules/@dotenvx/dotenvx/src/db/device.js

@@ -0,0 +1,73 @@
+const Conf = require('conf')
+const { PrivateKey } = require('eciesjs')
+
+const encryptDeviceValue = require('./../lib/helpers/encryptDeviceValue')
+const decryptDeviceValue = require('./../lib/helpers/decryptDeviceValue')
+
+class Device {
+  constructor () {
+    this.store = new Conf({
+      cwd: process.env.DOTENVX_CONFIG || undefined,
+      projectName: 'dotenvx',
+      configName: '.device-key',
+      projectSuffix: '',
+      fileExtension: '',
+      encryptionKey: 'dotenvxpro dotenvxpro dotenvxpro' // backwards compatible
+    })
+  }
+
+  touch () {
+    const _privateKey = this.privateKey()
+    const _publicKey = this.publicKey()
+
+    return {
+      privateKey: _privateKey,
+      publicKey: _publicKey
+    }
+  }
+
+  configPath () {
+    return this.store.path
+  }
+
+  privateKey () {
+    const currentPrivateKey = this.store.get('private_key/1')
+    if (currentPrivateKey && currentPrivateKey.length > 0) {
+      this.store.set('private_key/1', currentPrivateKey)
+
+      return currentPrivateKey
+    }
+
+    // generate privateKey for the first time
+    const kp = new PrivateKey()
+    const _privateKey = kp.secret.toString('hex')
+
+    this.store.set('private_key/1', _privateKey)
+
+    return _privateKey
+  }
+
+  publicKey () {
+    // must have private key to try and get public key
+    const privateKeyHex = this.privateKey()
+    if (!privateKeyHex || privateKeyHex.length < 1) {
+      return ''
+    }
+
+    // create keyPair object from hex string
+    const _privateKey = new PrivateKey(Buffer.from(privateKeyHex, 'hex'))
+
+    // compute publicKey from privateKey
+    return _privateKey.publicKey.toHex()
+  }
+
+  encrypt (value) {
+    return encryptDeviceValue(value, this.publicKey())
+  }
+
+  decrypt (value) {
+    return decryptDeviceValue(value, this.privateKey())
+  }
+}
+
+module.exports = Device