| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423 |
- const fs = require('fs')
- const path = require('path')
- const os = require('os')
- const crypto = require('crypto')
- // Array of tips to display randomly
- const TIPS = [
- '◈ encrypted .env [www.dotenvx.com]',
- '◈ secrets for agents [www.dotenvx.com]',
- '⌁ auth for agents [www.vestauth.com]',
- '⌘ custom filepath { path: \'/custom/path/.env\' }',
- '⌘ enable debugging { debug: true }',
- '⌘ override existing { override: true }',
- '⌘ suppress logs { quiet: true }',
- '⌘ multiple files { path: [\'.env.local\', \'.env\'] }'
- ]
- // Get a random tip from the tips array
- function _getRandomTip () {
- return TIPS[Math.floor(Math.random() * TIPS.length)]
- }
- function parseBoolean (value) {
- if (typeof value === 'string') {
- return !['false', '0', 'no', 'off', ''].includes(value.toLowerCase())
- }
- return Boolean(value)
- }
- function supportsAnsi () {
- return process.stdout.isTTY // && process.env.TERM !== 'dumb'
- }
- function dim (text) {
- return supportsAnsi() ? `\x1b[2m${text}\x1b[0m` : text
- }
- const LINE = /(?:^|^)\s*(?:export\s+)?([\w.-]+)(?:\s*=\s*?|:\s+?)(\s*'(?:\\'|[^'])*'|\s*"(?:\\"|[^"])*"|\s*`(?:\\`|[^`])*`|[^#\r\n]+)?\s*(?:#.*)?(?:$|$)/mg
- // Parse src into an Object
- function parse (src) {
- const obj = {}
- // Convert buffer to string
- let lines = src.toString()
- // Convert line breaks to same format
- lines = lines.replace(/\r\n?/mg, '\n')
- let match
- while ((match = LINE.exec(lines)) != null) {
- const key = match[1]
- // Default undefined or null to empty string
- let value = (match[2] || '')
- // Remove whitespace
- value = value.trim()
- // Check if double quoted
- const maybeQuote = value[0]
- // Remove surrounding quotes
- value = value.replace(/^(['"`])([\s\S]*)\1$/mg, '$2')
- // Expand newlines if double quoted
- if (maybeQuote === '"') {
- value = value.replace(/\\n/g, '\n')
- value = value.replace(/\\r/g, '\r')
- }
- // Add to object
- obj[key] = value
- }
- return obj
- }
- function _parseVault (options) {
- options = options || {}
- const vaultPath = _vaultPath(options)
- options.path = vaultPath // parse .env.vault
- const result = DotenvModule.configDotenv(options)
- if (!result.parsed) {
- const err = new Error(`MISSING_DATA: Cannot parse ${vaultPath} for an unknown reason`)
- err.code = 'MISSING_DATA'
- throw err
- }
- // handle scenario for comma separated keys - for use with key rotation
- // example: DOTENV_KEY="dotenv://:key_1234@dotenvx.com/vault/.env.vault?environment=prod,dotenv://:key_7890@dotenvx.com/vault/.env.vault?environment=prod"
- const keys = _dotenvKey(options).split(',')
- const length = keys.length
- let decrypted
- for (let i = 0; i < length; i++) {
- try {
- // Get full key
- const key = keys[i].trim()
- // Get instructions for decrypt
- const attrs = _instructions(result, key)
- // Decrypt
- decrypted = DotenvModule.decrypt(attrs.ciphertext, attrs.key)
- break
- } catch (error) {
- // last key
- if (i + 1 >= length) {
- throw error
- }
- // try next key
- }
- }
- // Parse decrypted .env string
- return DotenvModule.parse(decrypted)
- }
- function _warn (message) {
- console.error(`⚠ ${message}`)
- }
- function _debug (message) {
- console.log(`┆ ${message}`)
- }
- function _log (message) {
- console.log(`◇ ${message}`)
- }
- function _dotenvKey (options) {
- // prioritize developer directly setting options.DOTENV_KEY
- if (options && options.DOTENV_KEY && options.DOTENV_KEY.length > 0) {
- return options.DOTENV_KEY
- }
- // secondary infra already contains a DOTENV_KEY environment variable
- if (process.env.DOTENV_KEY && process.env.DOTENV_KEY.length > 0) {
- return process.env.DOTENV_KEY
- }
- // fallback to empty string
- return ''
- }
- function _instructions (result, dotenvKey) {
- // Parse DOTENV_KEY. Format is a URI
- let uri
- try {
- uri = new URL(dotenvKey)
- } catch (error) {
- if (error.code === 'ERR_INVALID_URL') {
- const err = new Error('INVALID_DOTENV_KEY: Wrong format. Must be in valid uri format like dotenv://:key_1234@dotenvx.com/vault/.env.vault?environment=development')
- err.code = 'INVALID_DOTENV_KEY'
- throw err
- }
- throw error
- }
- // Get decrypt key
- const key = uri.password
- if (!key) {
- const err = new Error('INVALID_DOTENV_KEY: Missing key part')
- err.code = 'INVALID_DOTENV_KEY'
- throw err
- }
- // Get environment
- const environment = uri.searchParams.get('environment')
- if (!environment) {
- const err = new Error('INVALID_DOTENV_KEY: Missing environment part')
- err.code = 'INVALID_DOTENV_KEY'
- throw err
- }
- // Get ciphertext payload
- const environmentKey = `DOTENV_VAULT_${environment.toUpperCase()}`
- const ciphertext = result.parsed[environmentKey] // DOTENV_VAULT_PRODUCTION
- if (!ciphertext) {
- const err = new Error(`NOT_FOUND_DOTENV_ENVIRONMENT: Cannot locate environment ${environmentKey} in your .env.vault file.`)
- err.code = 'NOT_FOUND_DOTENV_ENVIRONMENT'
- throw err
- }
- return { ciphertext, key }
- }
- function _vaultPath (options) {
- let possibleVaultPath = null
- if (options && options.path && options.path.length > 0) {
- if (Array.isArray(options.path)) {
- for (const filepath of options.path) {
- if (fs.existsSync(filepath)) {
- possibleVaultPath = filepath.endsWith('.vault') ? filepath : `${filepath}.vault`
- }
- }
- } else {
- possibleVaultPath = options.path.endsWith('.vault') ? options.path : `${options.path}.vault`
- }
- } else {
- possibleVaultPath = path.resolve(process.cwd(), '.env.vault')
- }
- if (fs.existsSync(possibleVaultPath)) {
- return possibleVaultPath
- }
- return null
- }
- function _resolveHome (envPath) {
- return envPath[0] === '~' ? path.join(os.homedir(), envPath.slice(1)) : envPath
- }
- function _configVault (options) {
- const debug = parseBoolean(process.env.DOTENV_CONFIG_DEBUG || (options && options.debug))
- const quiet = parseBoolean(process.env.DOTENV_CONFIG_QUIET || (options && options.quiet))
- if (debug || !quiet) {
- _log('loading env from encrypted .env.vault')
- }
- const parsed = DotenvModule._parseVault(options)
- let processEnv = process.env
- if (options && options.processEnv != null) {
- processEnv = options.processEnv
- }
- DotenvModule.populate(processEnv, parsed, options)
- return { parsed }
- }
- function configDotenv (options) {
- const dotenvPath = path.resolve(process.cwd(), '.env')
- let encoding = 'utf8'
- let processEnv = process.env
- if (options && options.processEnv != null) {
- processEnv = options.processEnv
- }
- let debug = parseBoolean(processEnv.DOTENV_CONFIG_DEBUG || (options && options.debug))
- let quiet = parseBoolean(processEnv.DOTENV_CONFIG_QUIET || (options && options.quiet))
- if (options && options.encoding) {
- encoding = options.encoding
- } else {
- if (debug) {
- _debug('no encoding is specified (UTF-8 is used by default)')
- }
- }
- let optionPaths = [dotenvPath] // default, look for .env
- if (options && options.path) {
- if (!Array.isArray(options.path)) {
- optionPaths = [_resolveHome(options.path)]
- } else {
- optionPaths = [] // reset default
- for (const filepath of options.path) {
- optionPaths.push(_resolveHome(filepath))
- }
- }
- }
- // Build the parsed data in a temporary object (because we need to return it). Once we have the final
- // parsed data, we will combine it with process.env (or options.processEnv if provided).
- let lastError
- const parsedAll = {}
- for (const path of optionPaths) {
- try {
- // Specifying an encoding returns a string instead of a buffer
- const parsed = DotenvModule.parse(fs.readFileSync(path, { encoding }))
- DotenvModule.populate(parsedAll, parsed, options)
- } catch (e) {
- if (debug) {
- _debug(`failed to load ${path} ${e.message}`)
- }
- lastError = e
- }
- }
- const populated = DotenvModule.populate(processEnv, parsedAll, options)
- // handle user settings DOTENV_CONFIG_ options inside .env file(s)
- debug = parseBoolean(processEnv.DOTENV_CONFIG_DEBUG || debug)
- quiet = parseBoolean(processEnv.DOTENV_CONFIG_QUIET || quiet)
- if (debug || !quiet) {
- const keysCount = Object.keys(populated).length
- const shortPaths = []
- for (const filePath of optionPaths) {
- try {
- const relative = path.relative(process.cwd(), filePath)
- shortPaths.push(relative)
- } catch (e) {
- if (debug) {
- _debug(`failed to load ${filePath} ${e.message}`)
- }
- lastError = e
- }
- }
- _log(`injected env (${keysCount}) from ${shortPaths.join(',')} ${dim(`// tip: ${_getRandomTip()}`)}`)
- }
- if (lastError) {
- return { parsed: parsedAll, error: lastError }
- } else {
- return { parsed: parsedAll }
- }
- }
- // Populates process.env from .env file
- function config (options) {
- // fallback to original dotenv if DOTENV_KEY is not set
- if (_dotenvKey(options).length === 0) {
- return DotenvModule.configDotenv(options)
- }
- const vaultPath = _vaultPath(options)
- // dotenvKey exists but .env.vault file does not exist
- if (!vaultPath) {
- _warn(`you set DOTENV_KEY but you are missing a .env.vault file at ${vaultPath}`)
- return DotenvModule.configDotenv(options)
- }
- return DotenvModule._configVault(options)
- }
- function decrypt (encrypted, keyStr) {
- const key = Buffer.from(keyStr.slice(-64), 'hex')
- let ciphertext = Buffer.from(encrypted, 'base64')
- const nonce = ciphertext.subarray(0, 12)
- const authTag = ciphertext.subarray(-16)
- ciphertext = ciphertext.subarray(12, -16)
- try {
- const aesgcm = crypto.createDecipheriv('aes-256-gcm', key, nonce)
- aesgcm.setAuthTag(authTag)
- return `${aesgcm.update(ciphertext)}${aesgcm.final()}`
- } catch (error) {
- const isRange = error instanceof RangeError
- const invalidKeyLength = error.message === 'Invalid key length'
- const decryptionFailed = error.message === 'Unsupported state or unable to authenticate data'
- if (isRange || invalidKeyLength) {
- const err = new Error('INVALID_DOTENV_KEY: It must be 64 characters long (or more)')
- err.code = 'INVALID_DOTENV_KEY'
- throw err
- } else if (decryptionFailed) {
- const err = new Error('DECRYPTION_FAILED: Please check your DOTENV_KEY')
- err.code = 'DECRYPTION_FAILED'
- throw err
- } else {
- throw error
- }
- }
- }
- // Populate process.env with parsed values
- function populate (processEnv, parsed, options = {}) {
- const debug = Boolean(options && options.debug)
- const override = Boolean(options && options.override)
- const populated = {}
- if (typeof parsed !== 'object') {
- const err = new Error('OBJECT_REQUIRED: Please check the processEnv argument being passed to populate')
- err.code = 'OBJECT_REQUIRED'
- throw err
- }
- // Set process.env
- for (const key of Object.keys(parsed)) {
- if (Object.prototype.hasOwnProperty.call(processEnv, key)) {
- if (override === true) {
- processEnv[key] = parsed[key]
- populated[key] = parsed[key]
- }
- if (debug) {
- if (override === true) {
- _debug(`"${key}" is already defined and WAS overwritten`)
- } else {
- _debug(`"${key}" is already defined and was NOT overwritten`)
- }
- }
- } else {
- processEnv[key] = parsed[key]
- populated[key] = parsed[key]
- }
- }
- return populated
- }
- const DotenvModule = {
- configDotenv,
- _configVault,
- _parseVault,
- config,
- decrypt,
- parse,
- populate
- }
- module.exports.configDotenv = DotenvModule.configDotenv
- module.exports._configVault = DotenvModule._configVault
- module.exports._parseVault = DotenvModule._parseVault
- module.exports.config = DotenvModule.config
- module.exports.decrypt = DotenvModule.decrypt
- module.exports.parse = DotenvModule.parse
- module.exports.populate = DotenvModule.populate
- module.exports = DotenvModule
|