@auth0/auth0-checkmate 1.4.0 → 1.5.1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,89 @@
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, please email auth0-checkmate@okta.com.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

package/README.md

@@ -1,6 +1,6 @@
-# Auth0 Checkmate
+# CheckMate for Auth0
 
-**Auth0 Checkmate** is a command-line utility that performs configuration checks on your Auth0 tenant. It helps ensure your tenant is securely and correctly configured by validating key settings and generating a detailed report.
+**CheckMate for Auth0** is a command-line utility that performs configuration checks on your Auth0 tenant. It helps ensure your tenant is securely and correctly configured by validating key settings and generating a detailed report.
 
 ---
 
@@ -16,13 +16,13 @@
 
 This tool makes use of the **Auth0 Management API**, which **consumes your tenant’s [rate limits](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations)**. Use it thoughtfully to avoid throttling.
 
-Checkmate for Auth0 is designed to provide visibility into its behavior through your Auth0 tenant's [log events](https://auth0.com/docs/deploy-monitor/logs). Tracking its use is important for monitoring and debugging purposes. You can track its use in several ways, including:
+CheckMate for Auth0 is designed to provide visibility into its behavior through your Auth0 tenant's [log events](https://auth0.com/docs/deploy-monitor/logs). Tracking its use is important for monitoring and debugging purposes. You can track its use in several ways, including:
 
--  The `User-Agent` string in the HTTP request header, which will have a value in the form of `${packageName}/${packageVersion}` (e.g. `auth0-checkmate/1.2.14`). Keep in mind that if the `User-Agent` string is modified on the client side, then Checkmate for Auth0 usage cannot be tracked this way.
-- The `client_name` and `scopes` assigned to Checkmate when configuring initial access
+-  The `User-Agent` string in the HTTP request header, which will have a value in the form of `${packageName}/${packageVersion}` (e.g. `@auth0/auth0-checkmate/1.4.0`). Keep in mind that if the `User-Agent` string is modified on the client side, then CheckMate for Auth0 usage cannot be tracked this way.
+- The `client_name` and `scopes` assigned to CheckMate when configuring initial access
 - `seccft` events (Successful exchange of Access Token for a Client Credentials Grant) in Auth0 logs
 
-As an example, Checkmate activity might result in a log entry like the one shown below. Each field in the log entry provides valuable information for troubleshooting or auditing, such as the `client_name` identifying the application, the `scope` showing granted permissions, and the `user_agent` indicating the tool version used.
+As an example, CheckMate activity might result in a log entry like the one shown below. Each field in the log entry provides valuable information for troubleshooting or auditing, such as the `client_name` identifying the application, the `scope` showing granted permissions, and the `user_agent` indicating the tool version used.
 
 ```json
 {
@@ -66,10 +66,10 @@ As an example, Checkmate activity might result in a log entry like the one shown
 
 ### Option 1 – Global Installation
 
-Install Auth0 Checkmate globally to use it as a standalone CLI tool:
+Install CheckMate for Auth0 globally to use it as a standalone CLI tool:
 
 ```bash
-npm install -g https://github.com/auth0/auth0-checkmate
+npm install -g @auth0/auth0-checkmate
 ```
 
 Then run it with:
@@ -112,7 +112,7 @@ Follow the interactive prompts to get started.
 
 ## 🔐 Auth0 Setup Instructions
 
-To use Auth0 Checkmate, you need a **dedicated Auth0 Application** to authorize calls to the Management API.
+To use CheckMate for Auth0, you need a **dedicated Auth0 Application** to authorize calls to the Management API.
 
 ### Create a Machine-to-Machine Application
 
@@ -122,7 +122,7 @@ To use Auth0 Checkmate, you need a **dedicated Auth0 Application** to authorize
 2. Click **“Create Application”**
 
 3. In the setup form:
-   - **Name:** `Auth0 Checkmate` (or similar)
+   - **Name:** `Auth0 CheckMate` (or similar)
    - **Application Type:** `Machine to Machine Applications`
    - Click **“Create”**
 
@@ -163,4 +163,4 @@ To use Auth0 Checkmate, you need a **dedicated Auth0 Application** to authorize
 
 ## ✅ You're All Set
 
-With your Auth0 application configured and the CLI installed, you’re ready to run **Auth0 Checkmate** and ensure your tenant setup is secure and complete.
+With your Auth0 application configured and the CLI installed, you’re ready to run **CheckMate for Auth0** and ensure your tenant setup is secure and complete.

package/THIRD-PARTY-NOTICES

@@ -1,9 +1,9 @@
-Checkmate for Auth0 Third Party Licenses and Notices
+CheckMate for Auth0 Third Party Licenses and Notices
 
-This document contains third party open source licenses and notices for the Checkmate for Auth0 product. Certain licenses and notices may appear in other parts of the
+This document contains third party open source licenses and notices for the CheckMate for Auth0 product. Certain licenses and notices may appear in other parts of the
 product in accordance with the applicable license requirements.
 
-The Checkmate for Auth0 product that this document references does not necessarily use all the
+The CheckMate for Auth0 product that this document references does not necessarily use all the
 open source software packages referred to below and may also only use portions
 of a given package.
 
@@ -124,26 +124,11 @@ License: MIT
 Copyright (c) 2011-2022 OpenJS Foundation and contributors, https://openjsf.org
 Repository: https://github.com/mochajs/mocha
 
-nock (14.0.1)
-License: MIT
-Copyright (c) 2011-2019 Pedro Teixeira and other contributors
-Repository: https://github.com/nock/nock
-
 nyc (17.1.0)
 License: ISC
 Copyright (c) 2015, Contributors
 Repository: https://github.com/istanbuljs/nyc
 
-proxyquire (2.1.3)
-License: MIT
-Copyright 2013 Thorsten Lorenz
-Repository: https://github.com/thlorenz/proxyquire
-
-sinon (19.0.2)
-License: BSD-3-Clause
-Copyright (c) 2010-2020, Christian Johansen
-Repository: https://github.com/sinonjs/sinon
-
 -------------------------------------------------------------------------------
 License Texts
 -------------------------------------------------------------------------------

package/analyzer/lib/actions/checkActionsHardCodedValues.js

@@ -71,19 +71,22 @@ const acorn = require("acorn");
 const walk = require("estree-walker").walk;
 
 function detectHardcodedValues(code, scriptName) {
-  let processedCode = code.replace(/(?!\w+#)\b#(\w+)/g, "_$1");
+
+  const hardcodedValues = [];
+
+  let processedCode = String(code || '').replace(/(?!\w+#)\b#(\w+)/g, "_$1");
+  
   const ast = acorn.parse(processedCode, {
     ecmaVersion: "latest",
     locations: true,
   });
 
-  const hardcodedValues = [];
-
   // Walk through the AST
   walk(ast, {
     enter(node) {
       // Check for variable assignments with hardcoded literals
       if (node.type === "VariableDeclaration") {
+        
         node.declarations.forEach((declaration) => {
           if (
             declaration.init &&
@@ -91,14 +94,17 @@ function detectHardcodedValues(code, scriptName) {
             typeof declaration.init.value === "string"
           ) {
             // Add the variable name and the type of the hardcoded literal
+            const value = declaration.init.value;
+            
             hardcodedValues.push({
               scriptName: scriptName,
               variableName: declaration.id.name,
               field: "hard_coded_value_detected",
               status: CONSTANTS.FAIL,
               type: typeof declaration.init.value,
-              line: declaration.loc.start.line,
-              column: declaration.loc.start.column,
+              line: declaration.loc?.start?.line || 'N/A', 
+              column: declaration.loc?.start?.column || 'N/A',
+              value: value, 
             });
           }
         });
@@ -135,15 +141,23 @@ function checkActionsHardCodedValues(options) {
     if (_.isEmpty(actionsList)) {
       return callback(reports);
     }
-    actionsList.forEach((action) => {
+    for (const action of actionsList) {
       var actionName = action.name.concat(
         ` (${action.supported_triggers[0].id})`,
       );
-      var report = detectHardcodedValues(action.code, actionName);
-      if (report.length > 0) {
-        reports.push({ name: actionName, report: report });
+      try {
+        var report = detectHardcodedValues(action.code, actionName);
+        if (report.length > 0) {
+          reports.push({ name: actionName, report: report });
+        }
+      } catch (e) {
+        if (e instanceof SyntaxError) {
+          console.error(`[CHECK ERROR] Skipping malformed Actions: ${actionName}`);
+          continue; // Skip to the next action in the loop
+        }
+        throw e; 
       }
-    });
+    }
     return callback(reports);
   });
 }

package/bin/index.js

@@ -12,8 +12,6 @@ const puppeteer = require("puppeteer");
 const { getToday, getFormattedDateTime } = require("../analyzer/tools/utils");
 const Handlebars = require("handlebars");
 const i18n = require("i18n");
-const os = require("os");
-const userHomeDir = os.homedir();
 const Table = require("cli-table3");
 const {
   getAccessToken,
@@ -63,10 +61,6 @@ const templateData = fs.readFileSync(
   path.join(__dirname, "../views/pdf_cli_report.handlebars"),
   "utf8",
 );
-const imagePath = path.join(__dirname, '../images/auth0.png');
-const imageBuffer = fs.readFileSync(imagePath);
-const base64Image = imageBuffer.toString('base64');
-const imageSrc = `data:image/png;base64,${base64Image}`;
 
 /**
  * 
@@ -193,7 +187,6 @@ async function generatePdf(filePath, data) {
     const htmlContent = template({
       locale: data.locale,
       data,
-      logoBase64: imageSrc,
       preamble: data.report.preamble,
     });
     const page = await browser.newPage();
@@ -363,7 +356,7 @@ async function main() {
     name: "filePath",
     message:
       "Enter the full path where you want to save the file (e.g., /path/to/file.pdf):",
-    default: userHomeDir,
+    default: "./reports",
     validate: (input) => {
       if (input.trim() === "") {
         return "Please enter a valid file path.";
@@ -378,7 +371,7 @@ async function main() {
     auth0ClientId: answers.auth0ClientId || null,
     auth0ClientSecret: answers.auth0ClientSecret || null,
     auth0MgmtToken: answers.auth0MgmtToken || null,
-    filePath: path.join(userHomeDir, answers.filePath),
+    filePath: path.isAbsolute(answers.filePath) ? answers.filePath : path.resolve(answers.filePath),
     selectedValidators: selectedValidators ? selectedValidators.split(',') : []
   };
 

package/locales/en.json

@@ -32,7 +32,7 @@
 			"heading": "Summary of findings"
 		}
 	},
-	"report_title": "Checkmate for Auth0 Configuration Report",
+	"report_title": "CheckMate for Auth0 Configuration Report",
 	"list_of_validators": [
 		{
 			"title": "Custom Domains",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth0/auth0-checkmate",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "A command line tool for checking configuration of your Auth0 tenant",
   "main": "analyzer/report.js",
   "scripts": {
@@ -17,21 +17,21 @@
   },
   "dependencies": {
     "acorn": "^8.14.0",
-    "axios": "^1.12.0",
+    "axios": "^1.12.2",
     "chalk": "^4.1.2",
     "cli-table3": "^0.6.5",
     "estree-walker": "^2.0.2",
-    "figlet": "^1.8.0",
+    "figlet": "^1.9.2",
     "glob": "^11.0.1",
     "handlebars": "^4.7.8",
-    "i18n": "^0.15.1",
-    "inquirer": "^12.3.3",
+    "i18n": "^0.15.2",
+    "inquirer": "^12.9.6",
     "jsonwebtoken": "^9.0.2",
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
-    "puppeteer": "^24.10.0",
+    "puppeteer": "^24.23.0",
     "semver": "^7.7.1",
-    "winston": "^3.17.0"
+    "winston": "^3.18.3"
   },
   "devDependencies": {
     "@eslint/js": "^9.23.0",
@@ -40,10 +40,7 @@
     "eslint-plugin-mocha": "^10.5.0",
     "globals": "^16.0.0",
     "mocha": "^11.1.0",
-    "nock": "^14.0.1",
-    "nyc": "^17.1.0",
-    "proxyquire": "^2.1.3",
-    "sinon": "^19.0.2"
+    "nyc": "^17.1.0"
   },
   "publishConfig": {
     "access": "public"

package/views/pdf_cli_report.handlebars

@@ -2,7 +2,7 @@
 
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Checkmate for Auth0 Configuration Report</title>
+    <title>CheckMate for Auth0 Configuration Report</title>
     <link
       href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha3/dist/css/bootstrap.min.css"
       rel="stylesheet"
@@ -254,7 +254,6 @@
       <div
         style="width: 100%; height: 50vh; display: flex; flex-direction: column; justify-content: center; align-items: center;"
       >
-        <img src="{{logoBase64}}" alt="Auth0" width="250" height="98""/>
         <h1
           style="font-size: 36px; margin-bottom: 20px;"
         >{{data.report.report_title}}</h1>