Skip to content

chore(security): add ReversingLabs malware scan workflow - #2882

Merged
cschetan77 merged 1 commit into
masterfrom
security/add-malwarescan
Nov 3, 2026
Merged

cschetan77 merged 1 commit into
masterfrom
security/add-malwarescan

Conversation

@nirmal-joishi-a0

Copy link
Copy Markdown
Contributor

✏️ Changes

This pull request adds a security hardening workflow. No functional changes are introduced.

🚧 Untested — automated PR. This is a reusable workflow (workflow_call) — it does not run on its own and cannot be validated by merging. To test it, complete the setup steps below, then confirm the scan passes. Do not merge solely because checks appear green.

No release/build CI to wire it into? If this repo builds manually, add CI if viable — otherwise decline with the remediation: not-applicable label.

If the run fails for repo-specific config we can't see (a missing secret, environment/IAM setup), fixing it before merging is the repo owner's responsibility.

ReversingLabs Malware Scan

This PR adds .github/workflows/rl.yml. It is a reusable workflow (workflow_call) that wraps the okta-approved auth0/devsecops-tooling/.github/actions/rl-scan action.

⚠️ Before merging, complete the two steps below.

Steps to wire it up

  1. Replace the placeholder build step in rl.yml with all steps that produce your artifact at the artifact-path you pass — toolchain setup, dependency install, compile, and package.
  2. Add a caller in your release or CI workflow, for example:
    jobs:
      rl-scan:
        uses: ./.github/workflows/rl.yml
        with:
          artifact-name: my-artifact
          artifact-path: dist/my-artifact.tgz   # concrete file path — no globs or directories
          version: ${{ github.event.release.tag_name }}
        secrets: inherit
    artifact-path must be a concrete file — the action's [ -f ] check rejects globs/directories and a missing path fails the job.

Required org secrets — all 8 must be present

The rl-scan action declares all 8 as required inputs — if any is missing or empty the scan job fails. Confirm each is available to this repo (set at the auth0/ org level) before merging:

  • RLSECURE_LICENSE, RLSECURE_SITE_KEY — ReversingLabs license + site key
  • SIGNAL_HANDLER_TOKEN, SIGNAL_HANDLER_DOMAIN — scan telemetry auth + endpoint
  • PRODSEC_TOOLS_ARN — AWS IAM role assumed via OIDC (see below)
  • PRODSEC_TOOLS_USER, PRODSEC_TOOLS_TOKEN, PRODSEC_PYTHON_TOOLS_REPO — private ProdSec Python index creds + URL

AWS OIDC trust — required, not just a secret

The action authenticates to AWS by assuming PRODSEC_TOOLS_ARN via GitHub OIDC (no static keys), so two things must be in place:

  • Job permission: the workflow already sets id-token: write (mints the OIDC token) and contents: read. Removing id-token: write breaks the AWS step.
  • IAM trust policy: the role's trust policy must allow this repository to assume it. If it does not yet trust this repo, Configure AWS credentials fails even with every secret set — an infra change the repo/org owner must arrange before merging.

🟠 Declining this workflow

This is an organization-enforced security-hardening workflow, so closing this PR is not enough — the tool treats a plain close as a discard and opens a fresh replacement PR on its next run.

To permanently decline this category, a maintainer must close this PR and add one of these labels to it:

Label Use when
remediation: not-required The category is already handled another way for this repo.
remediation: not-applicable The category genuinely does not apply (e.g. there is no manifest to scan for SCA, or no release/build CI to wire the malware scan into).

Applying a label requires write, triage, or admin access, so the label is a trusted maintainer signal. Once a closed PR carries one of these labels, the tool respects the decline and will not reopen a replacement.

🔮 Type of Change

  • Standard

🔗 References

This change applies a standard automated security-scanning workflow as part of routine repository hardening.

  • I explained why this change is needed.

📖 Documentation

No user-facing changes have been introduced.

  • I reflected this change in the (internal and/or user-facing) documentation, or added an explanation for why no documentation update is needed.

🎯 Testing

⚠️ This reusable workflow has not been tested in this Repository. Wire it up (steps above) and run it green in this PR — or, if there's no release/build CI to call it, decline with remediation: not-applicable.

  • Wired into CI and run green in this PR (or declined as not-applicable).

🚀 Deployment

  • This change can support multiple releases of the code serving traffic at the same time.

🔥 Rollback

Reverting this PR removes the added workflow file — no further action required.

  • I explained what the rollback for this change will look like.

@nirmal-joishi-a0

Copy link
Copy Markdown
Contributor Author

@auth0/project-dx-sdks-engineer-codeowner please review the files in the PR. This automated security-hardening workflow is untested in this repo — before merging, confirm it triggers and passes (and is not silently ignoring failures); do not merge on a green result alone.

@nirmal-joishi-a0
nirmal-joishi-a0 requested a review from a team as a code owner October 8, 2026 14:08
@nirmal-joishi-a0

Copy link
Copy Markdown
Contributor Author

An internal service ticket has been filed for the owning team to review and merge this PR.

@cschetan77
cschetan77 force-pushed the security/add-malwarescan branch from f8be7bd to e0b03f8 Compare November 2, 2026 12:56
@cschetan77
cschetan77 merged commit ba48a82 into master Nov 3, 2026
5 checks passed
@cschetan77
cschetan77 deleted the security/add-malwarescan branch November 3, 2026 11:24
cschetan77 added a commit that referenced this pull request Nov 3, 2026
### Changes

Switches the `install` target in the `Makefile` from `npm install` to
`npm ci`.

`make install` decides which dependency versions end up in the bundle
built for publishing. `npm install` can resolve newer versions than the
lockfile pins and rewrite `package-lock.json` if it is out of sync with
`package.json`. `npm ci` installs exactly the tree pinned in the
lockfile, verifies integrity hashes, and fails on any mismatch. The
GitHub release workflow (`npm-publish` action) already uses `npm ci`.

This pins the build's dependencies to the reviewed lockfile. It does not
by itself make the bundle byte-identical across environments (Node/npm
versions can still differ).

### References

Found while reviewing #2882 (ReversingLabs scan workflow) and working
out how the npm and CDN artifacts are built.

### Testing

* `npm ci` passes locally against the current lockfile.
* If the lockfile ever drifts from `package.json`, the install step will
now fail instead of silently resolving new versions.

* [ ] This change adds unit test coverage
* [ ] This change adds integration test coverage
* [ ] This change has been tested on the latest version of the
platform/language

### Checklist

* [x] I have read the [Auth0 general contribution
guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
* [x] I have read the [Auth0 Code of
Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
* [x] All code quality tools/guidelines have been run/followed
* [ ] All relevant assets have been compiled
cschetan77 added a commit that referenced this pull request Nov 3, 2026
…lease (#2910)

Wires the ReversingLabs scan from #2882 into the release flow so a
failed scan blocks publishing.

### Changes

- `rl.yml`: drops the placeholder build step and the artifact inputs. It
now builds like the `npm-publish` action does (`npm ci --include=dev
--ignore-scripts`, `npm run build`), then packs and scans two artifacts
with the `rl-scan` action:
  - the npm tarball (`npm pack`)
- a tarball of `build/` (the CDN bundle: `lock.min.js`, `lock.js`,
locale files, source map)

A final step fails the job unless both scans report `success`, since the
action reports a missing artifact through its output without failing the
step. The only input is `node-version`; the version comes from
`package.json`.
- `npm-release.yml`: new `rl-scan` job that calls `rl.yml`, the
`release` job now has `needs: rl-scan`, so nothing is published, tagged
or released unless the scan passes. Declares the 8 scan secrets and
forwards them with `secrets: inherit`.
- `release.yml`: passes the 8 scan secrets through to `npm-release.yml`.

The scan job builds the artifacts and the release job builds again. This
is intentional, to keep the scan separate from the publish step.

### References

- #2882 (automated ReversingLabs workflow PR)

* [ ] This change adds unit test coverage
* [ ] This change adds integration test coverage
* [ ] This change has been tested on the latest version of the
platform/language

### Checklist

* [x] I have read the [Auth0 general contribution
guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
* [x] I have read the [Auth0 Code of
Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
* [x] All code quality tools/guidelines have been run/followed
* [ ] All relevant assets have been compiled
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants