Scripts across various package encapsulated into a package named "scripts". Added a script to verify no secrets were leaked into the Git .env files (#74)
This commit is contained in:
committed by
GitHub
parent
8d1cdcfa11
commit
df944bb1e5
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"name": "license",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"scripts": {
|
||||
"dev": "node src/index.mjs"
|
||||
}
|
||||
}
|
||||
9
tooling/scripts/package.json
Normal file
9
tooling/scripts/package.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"name": "scripts",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"scripts": {
|
||||
"dev": "node ./src/dev.mjs",
|
||||
"checks": "node ./src/checks.mjs"
|
||||
}
|
||||
}
|
||||
111
tooling/scripts/src/checks.mjs
Normal file
111
tooling/scripts/src/checks.mjs
Normal file
@@ -0,0 +1,111 @@
|
||||
import { readFileSync, readdirSync } from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
const whitelist = {
|
||||
STRIPE_SECRET_KEY: [/sk_test_*/],
|
||||
STRIPE_WEBHOOK_SECRET: [/whsec_*/],
|
||||
EMAIL_PASSWORD: ['password'],
|
||||
SUPABASE_DB_WEBHOOK_SECRET: ['WEBHOOKSECRET'],
|
||||
SUPABASE_SERVICE_ROLE_KEY: ['eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU'],
|
||||
};
|
||||
|
||||
// List of sensitive environment variables that should not be in .env files
|
||||
const sensitiveEnvVars = [
|
||||
'STRIPE_SECRET_KEY',
|
||||
'STRIPE_WEBHOOK_SECRET',
|
||||
'LEMON_SQUEEZY_SECRET_KEY',
|
||||
'LEMON_SQUEEZY_SIGNING_SECRET',
|
||||
'KEYSTATIC_GITHUB_TOKEN',
|
||||
'SUPABASE_DB_WEBHOOK_SECRET',
|
||||
'SUPABASE_SERVICE_ROLE_KEY',
|
||||
'EMAIL_PASSWORD',
|
||||
'CAPTCHA_SECRET_TOKEN',
|
||||
];
|
||||
|
||||
// Files to check
|
||||
const envFiles = ['.env', '.env.development', '.env.production'];
|
||||
|
||||
function checkEnvFiles(rootPath) {
|
||||
let hasSecrets = false;
|
||||
|
||||
envFiles.forEach((file) => {
|
||||
try {
|
||||
const envPath = path.join(process.cwd(), rootPath, file);
|
||||
const contents = readFileSync(envPath, 'utf8');
|
||||
const lines = contents.split('\n');
|
||||
|
||||
lines.forEach((line, index) => {
|
||||
// Skip empty lines and comments
|
||||
if (!line || line.startsWith('#')) return;
|
||||
|
||||
// Check if line contains any sensitive vars
|
||||
sensitiveEnvVars.forEach((secret) => {
|
||||
if (line.startsWith(`${secret}=`)) {
|
||||
// Extract the value
|
||||
const value = line.split('=')[1].trim().replace(/["']/g, '');
|
||||
|
||||
// Skip if value is whitelisted
|
||||
if (isValueWhitelisted(secret, value)) {
|
||||
return;
|
||||
}
|
||||
|
||||
console.error(`⚠️ Secret key "${secret}" found in ${file} on line ${index + 1}`);
|
||||
|
||||
hasSecrets = true;
|
||||
}
|
||||
});
|
||||
});
|
||||
} catch (err) {
|
||||
// File doesn't exist, skip
|
||||
if (err.code === 'ENOENT') return;
|
||||
|
||||
throw err;
|
||||
}
|
||||
});
|
||||
|
||||
if (hasSecrets) {
|
||||
console.error('\n❌ Error: Secret keys found in environment files');
|
||||
|
||||
console.error(
|
||||
'\nPlease remove sensitive information from .env files and store them securely:',
|
||||
);
|
||||
|
||||
console.error('- Use environment variables in your CI/CD system');
|
||||
console.error('- For local development, use .env.local (git ignored)');
|
||||
process.exit(1);
|
||||
} else {
|
||||
const appName = rootPath.split('/').pop();
|
||||
|
||||
console.log(`✅ No secret keys found in staged environment files for the app ${appName}`);
|
||||
}
|
||||
}
|
||||
|
||||
const apps = readdirSync('../../apps');
|
||||
|
||||
apps.forEach(app => {
|
||||
checkEnvFiles(`../../apps/${app}`);
|
||||
});
|
||||
|
||||
function isValueWhitelisted(key, value) {
|
||||
if (!(key in whitelist)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const whiteListedValue = whitelist[key];
|
||||
|
||||
if (whiteListedValue instanceof RegExp) {
|
||||
return whiteListedValue.test(value);
|
||||
}
|
||||
|
||||
if (Array.isArray(whiteListedValue)) {
|
||||
return whiteListedValue.some(allowed => {
|
||||
if (allowed instanceof RegExp) {
|
||||
return allowed.test(value);
|
||||
}
|
||||
|
||||
return allowed.trim() === value.trim();
|
||||
});
|
||||
}
|
||||
|
||||
return whiteListedValue.trim() === value.trim();
|
||||
}
|
||||
4
tooling/scripts/src/dev.mjs
Normal file
4
tooling/scripts/src/dev.mjs
Normal file
@@ -0,0 +1,4 @@
|
||||
import { checkPendingMigrations } from './migrations.mjs';
|
||||
import './license.mjs';
|
||||
|
||||
checkPendingMigrations();
|
||||
@@ -2,7 +2,7 @@ import { execSync } from 'node:child_process';
|
||||
|
||||
export function checkPendingMigrations() {
|
||||
try {
|
||||
console.log('\nChecking for pending migrations...');
|
||||
console.info('\x1b[34m%s\x1b[0m', 'Checking for pending migrations...');
|
||||
|
||||
const output = execSync('pnpm --filter web supabase migration list', { encoding: 'utf-8', stdio: 'pipe' });
|
||||
const lines = output.split('\n');
|
||||
@@ -25,6 +25,6 @@ export function checkPendingMigrations() {
|
||||
console.log('\x1b[32m%s\x1b[0m', '✅ All migrations are up to date.');
|
||||
}
|
||||
} catch (error) {
|
||||
console.log('\x1b[33m%s\x1b[0m', '⚠️ No remote Supabase project found. You may not yet have linked your Supabase project. Feel free to ignore this message.');
|
||||
console.log('\x1b[33m%s\x1b[0m', '⚠️ Migrations: No remote Supabase project found, we could not check pending migrations. This is normal if you have not yet have linked your Supabase project. Feel free to ignore this message.');
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"name": "version",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"scripts": {
|
||||
"dev": "node src/index.mjs"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user