From 80bedc5a3301bf85e8837beaa155e5ca68eb171c Mon Sep 17 00:00:00 2001 From: Matthew Lopez <73856503+MatthewL246@users.noreply.github.com> Date: Tue, 4 Jun 2024 16:30:00 -0400 Subject: [PATCH] chore: prefix environment variable names with SSSL --- README.md | 18 +++++++++--------- patch.js | 14 +++++++------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fd0e684..4058f7d 100644 --- a/README.md +++ b/README.md @@ -48,15 +48,15 @@ This script can also be run in a Docker container. This script can be configured using environment variables or a `.env` file. Alternatively, it can be run with the `-i` or `--interactive` flag to interactively prompt for all configuration values. -| Environment Variable | Description | Default | -| --------------------- | ------------------------------------------------------------------- | ----------------------------- | -| NINTENDO_CA_G3_PATH | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` | -| NINTENDO_CA_G3_FORMAT | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` | -| CA_PRIVATE_KEY_PATH | Path to private key for forged CA (will generate if not set) | N/A | -| SITE_PRIVATE_KEY_PATH | Path to private key for site certificate (will generate if not set) | N/A | -| CSR_PATH | Path to CSR (will generate if not set) | N/A | -| COMMON_NAME | CN for site certificate (see [the bugs](#the-bugs)) | `*` | -| OUTPUT_FOLDER_PATH | Output folder | `./` | +| Environment Variable | Description | Default | +| -------------------------- | ------------------------------------------------------------------- | ----------------------------- | +| SSSL_NINTENDO_CA_G3_PATH | Path to Nintendo CA - G3 certificate (may be in DER or PEM format) | `./CACERT_NINTENDO_CA_G3.der` | +| SSSL_NINTENDO_CA_G3_FORMAT | Nintendo CA - G3 certificate format (must be "der" or "pem") | `der` | +| SSSL_CA_PRIVATE_KEY_PATH | Path to private key for forged CA (will generate if not set) | N/A | +| SSSL_SITE_PRIVATE_KEY_PATH | Path to private key for site certificate (will generate if not set) | N/A | +| SSSL_CSR_PATH | Path to CSR (will generate if not set) | N/A | +| SSSL_COMMON_NAME | CN for site certificate (see [the bugs](#the-bugs)) | `*` | +| SSSL_OUTPUT_FOLDER_PATH | Output folder | `./` | ## Credits diff --git a/patch.js b/patch.js index dd9b700..ccecbea 100644 --- a/patch.js +++ b/patch.js @@ -26,13 +26,13 @@ async function main() { } const options = { - nintendo_ca_g3_path: process.env.NINTENDO_CA_G3_PATH || defaultOptions.nintendo_ca_g3_path, - nintendo_ca_g3_format: process.env.NINTENDO_CA_G3_FORMAT || defaultOptions.nintendo_ca_g3_format, - ca_private_key_path: process.env.CA_PRIVATE_KEY_PATH || defaultOptions.ca_private_key_path, - site_private_key_path: process.env.SITE_PRIVATE_KEY_PATH || defaultOptions.site_private_key_path, - csr_path: process.env.CSR_PATH || defaultOptions.csr_path, - common_name: process.env.COMMON_NAME || defaultOptions.common_name, - output_folder_path: process.env.OUTPUT_FOLDER_PATH || defaultOptions.output_folder_path + nintendo_ca_g3_path: process.env.SSSL_NINTENDO_CA_G3_PATH || defaultOptions.nintendo_ca_g3_path, + nintendo_ca_g3_format: process.env.SSSL_NINTENDO_CA_G3_FORMAT || defaultOptions.nintendo_ca_g3_format, + ca_private_key_path: process.env.SSSL_CA_PRIVATE_KEY_PATH || defaultOptions.ca_private_key_path, + site_private_key_path: process.env.SSSL_SITE_PRIVATE_KEY_PATH || defaultOptions.site_private_key_path, + csr_path: process.env.SSSL_CSR_PATH || defaultOptions.csr_path, + common_name: process.env.SSSL_COMMON_NAME || defaultOptions.common_name, + output_folder_path: process.env.SSSL_OUTPUT_FOLDER_PATH || defaultOptions.output_folder_path }; if (validateOptions(options)) {