Log information about the runner which may affect the private registry proxy by mbg · Pull Request #3486 · github/codeql-action · GitHub

This PR modifies the start-proxy action to perform a best-effort inspection of some environment variables and language-specific settings which may affect the operation of the authentication proxy. Relevant values are logged so that they are visible in the workflow log.

Risk assessment

For internal use only. Please select the risk level of this change:

Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

Managed - Impacts users with dynamic workflows (Default Setup, CCR, ...).

Products:

Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
Code Quality - The changes impact analyses when analysis-kinds: code-quality.

Environments:

Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.
GHES - Impacts CodeQL workflows on GitHub Enterprise Server.

How did/will you validate this change?

Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

Telemetry - I rely on existing telemetry or have made changes to the telemetry.
- Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
- Alerts - New or existing monitors will trip if something goes wrong with this change.

Are there any special considerations for merging or releasing this change?

No special considerations - This change can be merged at any time.

Merge / deployment checklist

Confirm this change is backwards compatible with existing workflows.
Consider adding a changelog entry for this change.
Confirm the readme and docs have been updated if necessary.

Pull request overview

This PR adds environment inspection capabilities to the start-proxy action to log information about proxy-related settings on the runner. The goal is to provide better observability for debugging potential proxy configuration conflicts that may affect the authentication proxy's operation.

Changes:

Added new src/start-proxy/environment.ts module with functions to inspect environment variables and JDK configuration files for proxy settings
Added comprehensive unit tests in src/start-proxy/environment.test.ts
Extended src/languages.ts with JavaEnvVars enum for consistent reference to Java environment variable names
Refactored src/init-action.ts to use the new JavaEnvVars enum instead of string literals

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/start-proxy/environment.ts	New module implementing environment inspection with functions to check proxy-related environment variables and Java configuration files
src/start-proxy/environment.test.ts	Comprehensive unit tests for the environment inspection module
src/start-proxy-action.ts	Integration of environment inspection with try-catch wrapper for best-effort execution
src/languages.ts	Addition of JavaEnvVars enum for consistent reference to Java environment variable names
src/init-action.ts	Refactored to use JavaEnvVars enum instead of string literals for JAVA_TOOL_OPTIONS
lib/*.js	Auto-generated JavaScript (not reviewed per coding guidelines)

This code logs the complete value of proxy-related environment variables (HTTP_PROXY, HTTPS_PROXY, ALL_PROXY) at INFO level. These environment variables commonly contain embedded credentials in the format http://username:password@proxy:port. Logging these values would expose sensitive credentials in workflow logs.

Consider implementing sanitization to redact credentials from proxy URLs before logging, or logging only the presence/absence of these variables without their values (similar to how the else branch logs at DEBUG level that variables are not set).

I have added some protection against this in 99fcc7b by trying to parse the value as a URL in checkEnvVar and, if successful, clearing the username and password. Broadly, this should only be a concern for the members of ProxyEnvVars since, for the Java properties, there are separate http(s).proxyUser and http(s).proxyPassword which we don't try to find and therefore don't log.

LGTM with a very minor suggestion for yet another FF.

Note also that we run this after `getCredentials` which already instructs Actions to mask credentials that we know about in logs

…eeded

I'm probably grasping at straws here. But what if it is not our Java version that is problematic? But some other Java version chosen at a different point in time. I suppose this is somewhat addressed by the fact that we log File contents explicitly in addition to this effective settings logging

I think this is a valid question and one I have thought about. Other than what you have already said about us inspecting some of the configuration files, my thinking is that there are essentially two scenarios since this is default setup:

The runner is a GH-hosted runner, and the configuration of all available JDKs is the standard one we can observe ourselves.
The runner is self-hosted and the active Java version at the time the action runs is probably the one a customer would intend to run their build with.

Based on that, I don't think this is unreasonable.

mbg added 4 commits February 17, 2026 11:37

Add enum for Java-related env var names

bff89dc

Log information about proxy-related environment variables

33e2dff

Find likely JDK locations and check configurations

a3d7d36

Wrap checkProxyEnvironment call in try/catch for good measure

4250b46

mbg requested a review from esbena February 17, 2026 13:22

mbg self-assigned this Feb 17, 2026

Copilot AI review requested due to automatic review settings February 17, 2026 13:22

mbg requested a review from a team as a code owner February 17, 2026 13:22

github-actions Bot added the size/L May be hard to review label Feb 17, 2026

Copilot started reviewing on behalf of mbg February 17, 2026 13:22 View session

Copilot AI reviewed Feb 17, 2026

View reviewed changes

mbg added 2 commits February 17, 2026 13:28

Clear GHA JAVA_HOME_* env vars for discoverActionsJdks test

ef9cfd9

Fix typos

c1d6ee5

esbena reviewed Feb 17, 2026

View reviewed changes

Comment thread src/start-proxy/environment.ts

Comment thread src/start-proxy-action.ts Outdated

mbg added 3 commits February 17, 2026 13:42

Check whether value is a URL in checkEnvVar and clear credentials

99fcc7b

Note also that we run this after `getCredentials` which already instructs Actions to mask credentials that we know about in logs

Only run when debugging or test mode is enabled

11c6c18

Fixup: add missing .env

44a4bea

mbg force-pushed the mbg/start-proxy/java-env-checks branch from e3e55cc to 8e94084 Compare February 17, 2026 14:27

github-advanced-security AI found potential problems Feb 17, 2026

View reviewed changes

Comment thread src/start-proxy/environment.ts Fixed

Consistently use "\n" to split lines, then trim extra characters if n…

9715925

…eeded

mbg force-pushed the mbg/start-proxy/java-env-checks branch from 8e94084 to 9715925 Compare February 17, 2026 14:58

mbg added 2 commits February 17, 2026 15:22

Move interesting JRE properties out of checkJdkSettings

32ab108

Add more interesting Java properties

46473e0

github-advanced-security AI found potential problems Feb 17, 2026

View reviewed changes

Comment thread src/start-proxy/environment.ts Fixed

mbg force-pushed the mbg/start-proxy/java-env-checks branch from a3e77f2 to 194a305 Compare February 17, 2026 15:53

mbg added 3 commits February 17, 2026 16:49

Run java to show computed settings

906dd89

Merge branch 'main' into mbg/start-proxy/java-env-checks

64300e4

Fix checkExpectedLogMessages not asserting anything on success

61f7dd3

mbg force-pushed the mbg/start-proxy/java-env-checks branch from c16e3c0 to 61f7dd3 Compare February 17, 2026 16:50

mbg requested a review from esbena February 17, 2026 17:12

esbena reviewed Feb 17, 2026

View reviewed changes

esbena approved these changes Feb 17, 2026

View reviewed changes

mbg merged commit 015d8c7 into main Feb 17, 2026
253 of 254 checks passed

mbg deleted the mbg/start-proxy/java-env-checks branch February 17, 2026 20:48

This was referenced Feb 20, 2026

Merge main into releases/v4 #3494

Merged

Merge releases/v4 into releases/v3 #3496

Merged

+              function checkEnvVar(logger: Logger, name: string): boolean {
+                const value = process.env[name];
+                if (isDefined(value)) {
+                  logger.info(`Environment variable '${name}' is set to '${value}'.`);

+              /** Invokes `java` to get it to show us the active configuration. */
+              async function showJavaSettings(logger: Logger): Promise<void> {
+                try {
+                  const java = await io.which("java", true);

Log information about the runner which may affect the private registry proxy by mbg · Pull Request #3486 · github/codeql-action · GitHub

Uh oh!

Log information about the runner which may affect the private registry proxy - #3486

Log information about the runner which may affect the private registry proxy#3486
mbg merged 15 commits into
mainfrom
mbg/start-proxy/java-env-checks

mbg commented Feb 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

mbg Feb 17, 2026

Uh oh!

Uh oh!

esbena left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

esbena Feb 17, 2026

Uh oh!

mbg Feb 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Log information about the runner which may affect the private registry proxy by mbg · Pull Request #3486 · github/codeql-action · GitHub

Uh oh!

Log information about the runner which may affect the private registry proxy - #3486

Log information about the runner which may affect the private registry proxy#3486mbg merged 15 commits intomaingithub/codeql-action:mainfrom mbg/start-proxy/java-env-checksgithub/codeql-action:mbg/start-proxy/java-env-checksCopy head branch name to clipboard

Conversation

mbg commented Feb 17, 2026

Risk assessment

Which use cases does this change impact?

How did/will you validate this change?

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

How will you know if something goes wrong after this change is released?

Are there any special considerations for merging or releasing this change?

Merge / deployment checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

mbg Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

esbena left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

esbena Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

mbg Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Log information about the runner which may affect the private registry proxy#3486
mbg merged 15 commits into
mainfrom
mbg/start-proxy/java-env-checks