discovery-media-player

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 14197 is baseline-2 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/14197/baseline)](https://www.bestpractices.dev/projects/14197)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/14197"><img src="https://www.bestpractices.dev/projects/14197/baseline"></a>


These are the Baseline Level 3 criteria. These are criteria version v2026.02.19.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics

  • General

    Note that other projects may use the same name.

    Self-hosted document viewer: per-recipient tracked links, reading analytics, live presentation. The core knows nothing about the app hosting it.

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

 Controls 20/21

  • Controls


    When a job is assigned permissions in a CI/CD pipeline, the source code or configuration MUST only assign the minimum privileges necessary for the corresponding activity. [OSPS-AC-04.02]
    Configure the project's CI/CD pipelines to assign the lowest available permissions to users and services by default, elevating permissions only when necessary for specific tasks. In some version control systems, this may be possible at the organizational or repository level. If not, set permissions at the top level of the pipeline.

    Every job is granted the minimum for its activity, and the workflow that publishes is the strictest. release.yml declares permissions: {} at workflow level — no scope at all — then grants per job: the verification job contents: read plus actions: read because it queries the Actions API, the publish job contents: read plus id-token: write for OIDC and nothing else, the announce job contents: write alone to create the Release. ci.yml is contents: read throughout, scorecard.yml read-all. The release pipeline is deliberately split into four jobs with disjoint permissions so that the job holding a write scope is never the job that executes downloaded code.



    CI/CD pipelines which accept trusted collaborator input MUST sanitize and validate that input prior to use in the pipeline. [OSPS-BR-01.04]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all collaborator inputs on explicit workflow executions. While collaborators are generally trusted, manual inputs to a workflow cannot be reviewed and could be abused by an account takeover or insider threat.

    The only collaborator input this project accepts is the tag on a workflow_dispatch of release.yml and image.yml. It was already not injectable — TAG is read as a shell environment variable, never interpolated with ${{ }} inside a run block, the same rule applied to untrusted input in cla.yml — and it is now validated as well: the first step of the release pipeline, before any repository access, rejects anything that is not the vX.Y.Z form this project tags, and image.yml has carried the same check. Validation is separate from injectability: a typo previously travelled as far as the checkout to fail on a message about a missing ref, and a compromised collaborator account had a free-text field on the workflow that publishes.



    When an official release is created, all assets within that release MUST be clearly associated with the release identifier or another unique identifier for the asset. [OSPS-BR-02.02]
    Assign a unique version identifier to each software asset produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    Every asset carries the release identifier. The npm tarball is named discovery-media-player-<version>.tgz and is published under that exact version. The container image is pushed on the immutable versioned tag first, with latest promoted afterwards by atomic retag rather than pushed during the build. The GitHub Release is the tag itself, and the CycloneDX SBOM attached to it is named discovery-media-player-<tag>.cdx.json — an SBOM detached from the version it describes describes nothing. CI refuses a tag whose version does not match package.json, and refuses a tag on a commit that is not an ancestor of main.



    The project MUST define a policy for managing secrets and credentials used by the project. The policy should include guidelines for storing, accessing, and rotating secrets and credentials. [OSPS-BR-07.02]
    Document how secrets and credentials are managed and used within the project. This should include details on how secrets are stored (e.g., using a secrets management tool), how access is controlled, and how secrets are rotated or updated. Ensure that sensitive information is not hard-coded in the source code or stored in version control systems.

    docs/SECURITY-PRACTICES.md defines the policy, and its rule is that the project holds no long-lived secret and does not want one. It tabulates every credential, who holds it and how long it lives: npm publishing held by nobody because OIDC issues an identity per run, GHCR push scoped per job, no signing key at all because Sigstore signs against the workflow identity, and the operator's own secrets which never transit through this project. Storing: never in version control, enforced by tools/secrets-en-clair.mjs in CI and pre-push, with .env.example carrying names and no values. Accessing: the resource list in MAINTAINERS.md, granted only after the vetting policy in the same file. Rotating: a table of triggers, with the standing rule that a leaked credential is revoked first and removed second, because a pushed secret is disclosed and rewriting history does not recall it.



    When the project has made a release, the project documentation MUST contain instructions to verify the integrity and authenticity of the release assets. [OSPS-DO-03.01]
    Instructions in the project should contain information about the technology used, the commands to run, and the expected output. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    docs/VERIFYING-RELEASES.md gives the technology, the commands and the expected output for each asset: npm audit signatures for the package, with the verified registry signature and verified attestation lines a consumer should see; gh attestation verify against the OCI reference for the image, plus docker buildx imagetools inspect to read its embedded SBOM and provenance; and gh release download for the CycloneDX SBOM attached to each GitHub Release. A table states what each check proves and, deliberately, what it does not — a verification that is oversold is worse than none, because it stops people looking further. The document also tells readers to fetch it from a source other than the artifact they are checking.



    When the project has made a release, the project documentation MUST contain instructions to verify the expected identity of the person or process authoring the software release. [OSPS-DO-03.02]
    The expected identity may be in the form of key IDs used to sign, issuer and identity from a sigstore certificate, or other similar forms. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    docs/VERIFYING-RELEASES.md carries an explicit identity table for the expected signer. Because publication is signed by a workflow rather than a person, what must match is the Sigstore issuer https://token.actions.githubusercontent.com, the source repository github.com/Juli1artha/discovery-media-player, the workflow .github/workflows/release.yml, and a commit belonging to main — which CI enforces separately by refusing to publish a tag whose commit is not an ancestor. The document states plainly that a signature which verifies but names a different repository or workflow is not this project's release, and that a failing check is handled as an incident through SECURITY.md rather than as a support question.



    When the project has made a release, the project documentation MUST include a descriptive statement about the scope and duration of support for each release. [OSPS-DO-04.01]
    In order to communicate the scope and duration of support for the project's released software assets, the project should have a SUPPORT.md file, a "Support" section in SECURITY.md, or other documentation explaining the support lifecycle, including the expected duration of support for each release, the types of support provided (e.g., bug fixes, security updates), and any relevant policies or procedures for obtaining support.

    SECURITY.md states the scope and duration in a table rather than by implication: the latest release is supported for bug fixes and security fixes, anything earlier for neither. The reasoning is given — the project is young, releases are small and frequent, there is one maintainer, and a long-term support branch would be a promise nobody here could keep. It also says what makes the abrupt cutoff workable: upgrading is npm update or a new image tag, and where a database migration is genuinely required, docs/MIGRATIONS.md documents it and the running instance says so rather than degrading silently.



    When the project has made a release, the project documentation MUST provide a descriptive statement when releases or versions will no longer receive security updates. [OSPS-DO-05.01]
    In order to communicate the scope and duration of support for security fixes, the project should have a SUPPORT.md or other documentation explaining the project's policy for security updates.

    SECURITY.md says exactly when security updates stop: a version stops receiving them the moment the next release is published. There is no backporting — a fix is delivered as a new release, never as a patch to an older line — so a consumer three versions behind when an advisory lands upgrades to current rather than waiting for a fix on their line. The changelog for each version names the security-relevant changes it carries, so what is gained by moving is visible before moving. The document also commits to changing that table first, before any wider support promise is made elsewhere.



    While active, the project documentation MUST have a policy that code collaborators are reviewed prior to granting escalated permissions to sensitive resources. [OSPS-GV-04.01]
    Publish an enforceable policy in the project documentation that requires code collaborators to be reviewed and approved before being granted escalated permissions to sensitive resources, such as merge approval or access to secrets. It is recommended that vetting includes establishing a justifiable lineage of identity such as confirming the contributor's association with a known trusted organization.

    MAINTAINERS.md carries a Granting access policy: nobody receives escalated permissions — merge rights on main, repository settings, publishing, or the security mailbox — without being reviewed first, before the grant rather than after. It states what is examined and in what order: a record of merged pull requests over a period long enough to see how the person behaves when they disagree with review (explicitly not a commit count), the CLA already signed, 2FA confirmed rather than assumed, and the smallest grant that does the job, with access to a secret granted per resource rather than as a bundle. Grants are recorded in the same pull request that makes them, and the policy notes the one place it is currently weaker than it reads: with a single maintainer, the person applying it is the person it would be applied to — which is why it was written before anyone is waiting on it.



    When the project has made a release, all compiled released software assets MUST be delivered with a software bill of materials. [OSPS-QA-02.02]
    It is recommended to auto-generate SBOMs at build time using a tool that has been vetted for accuracy. This enables users to ingest this data in a standardized approach alongside other projects in their environment.

    Both compiled assets ship with an SBOM. The container image is built with sbom: true and provenance: mode=max, so its bill of materials travels as an attestation readable with docker buildx imagetools inspect. The npm package now carries one too: the release workflow generates a CycloneDX SBOM with npm sbom from the same production tree the tarball is published from, verifies it is well-formed CycloneDX with at least one component rather than an empty file, and attaches it to the GitHub Release named discovery-media-player-<tag>.cdx.json. It is generated with --ignore-scripts, because the announcing job is the only one holding contents: write and installing dependencies that execute their own scripts there would hand downloaded code exactly the privilege the four-job split removes. docs/VERIFYING-RELEASES.md tells consumers how to fetch and use it.



    When the project has made a release comprising multiple source code repositories, all subprojects MUST enforce security requirements that are as strict or stricter than the primary codebase. [OSPS-QA-04.02]
    Any additional subproject code repositories produced by the project and compiled into a release must enforce security requirements as applicable to the status and intent of the respective codebase. In addition to following the corresponding OSPS Baseline requirements, this may include requiring a security review, ensuring that it is free of vulnerabilities, and ensuring that it is free of known security issues.

    The project is a single repository. No subproject codebase is compiled into a release, and nothing outside github.com/Juli1artha/discovery-media-player contributes source to the published npm package or container image, so there is no additional codebase whose security requirements could be looser than the primary one.



    While active, project's documentation MUST clearly document when and how tests are run. [OSPS-QA-06.02]
    Add a section to the contributing documentation that explains how to run the tests locally and how to run the tests in the CI/CD pipeline. The documentation should explain what the tests are testing and how to interpret the results.

    CONTRIBUTING.md documents when and how the tests run, in a table naming each of the four benches, the command that invokes it, what it proves that the others cannot, and when it runs — all four on every push and pull request, on Node 22 and 24 for the unit bench. It lists what runs alongside them (lint, typecheck, CodeQL, the blocking dependency-vulnerability check, and the repository's own guards), states that all of it must pass before a pull request can merge and that pull requests are the only way into main, and explains how to read a failure: an ::error:: names your branch, while GARDE NON CONCLUANTE means the guard could not look and the fix is in the guard or its environment, not in your change.



    While active, the project's documentation MUST include a policy that all major changes to the software produced by the project should add or update tests of the functionality in an automated test suite. [OSPS-QA-06.03]
    Add a section to the contributing documentation that explains the policy for adding or updating tests. The policy should explain what constitutes a major change and what tests should be added or updated.

    The policy is CONTRIBUTING.md's stated one rule: a behaviour worth keeping is worth a test that fails without it. It extends to the test's name, which must say which failure it prevents rather than that it tests the happy path — a test that does not will be asked about in review. AGENTS.md repeats it among the conventions that only review enforces. The history shows it applied: the suite stands at 1515 tests across 144 files, and the credential guard added during this badge review shipped with 21 tests of its own, covering both what it catches and what it deliberately lets pass.



    When a commit is made to the primary branch, the project's version control system MUST require at least one non-author human approval of the changes before merging. [OSPS-QA-07.01]
    Configure the project's version control system to require at least one non-author human approval of changes before merging into the release or primary branch. This can be achieved by requiring a pull request to be reviewed and approved by at least one other collaborator before it can be merged.

    Not met: this control requires a non-author human approval before merging, and there is one maintainer — every change is authored by the only person who could approve it, and an AI review is not counted as a human one. What already exists is everything around the missing person: the review standards a second maintainer would apply (CONTRIBUTING.md, "How review is conducted"), the vetting path for granting rights (MAINTAINERS.md), and recruiting that person as the public roadmap's first item. https://github.com/Juli1artha/discovery-media-player/blob/main/ROADMAP.md



    When the project has made a release, the project MUST perform a threat modeling and attack surface analysis to understand and protect against attacks on critical code paths, functions, and interactions within the system. [OSPS-SA-03.02]
    Threat modeling is an activity where the project looks at the codebase, associated processes and infrastructure, interfaces, key components and "thinks like a hacker" and brainstorms how the system be be broken or compromised. Each identified threat is listed out so the project can then think about how to proactively avoid or close off any gaps/vulnerabilities that could arise. Ensure this is updated for new features or breaking changes.

    docs/THREAT-MODEL.md is the threat model and attack-surface analysis. It is organised by asset rather than by feature — documents, reading data, host credentials, in descending order of what their loss would cost an operator — because a model arranged by feature reassures its author and finds nothing. It tabulates every entry point an unauthenticated stranger can reach, then works through eight attack paths: reading a document without being its recipient, server-side request forgery through the file proxy (named the highest-value target, with the realised failure mode of a plausible typo widening the guard), taking or spying on a live presentation, crossing the host boundary, XSS against the nonce-based CSP, reaching the database directly, compromising the supply chain, and denial of service. Each names its residual risk, including the ones deliberately left standing — a link forwarded by its legitimate recipient, and compromise of the single maintainer account. It is reviewed when a feature changes what an actor can do or the host contract breaks.



    While active, any vulnerabilities in the software components not affecting the project MUST be accounted for in a VEX document, augmenting the vulnerability report with non-exploitability details. [OSPS-VM-04.02]
    Establish a VEX feed communicating the exploitability status of known vulnerabilities, including assessment details or any mitigations in place preventing vulnerable code from being executed.

    There is nothing to account for in a VEX document. npm audit reports zero vulnerabilities across both the production and development trees, so no known vulnerability in a component has been assessed as non-exploitable here, and a VEX statement would have no subject. The policy for when that changes is written down rather than left open: docs/DEPENDENCIES.md states that a finding may be suppressed only as not exploitable in this project — never as won't fix — that the suppression records why the vulnerable path cannot be reached, who decided and when, and that the non-exploitability assessment is published with the release carrying it, in that version's changelog section and alongside the SBOM attached to the GitHub Release, so a consumer scanning our SBOM can distinguish a real exposure from one already assessed.



    While active, the project documentation MUST include a policy that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. [OSPS-VM-05.01]
    Document a policy in the project that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. Include the process for identifying, prioritizing, and remediating these findings.

    docs/DEPENDENCIES.md defines the thresholds, and gives each one a reason rather than a number alone. Production tree: no known vulnerability at any severity — it runs on the operator's machine beside their commercial documents and under their credentials, and it holds one dependency, so tolerating anything there would be choosing to ship a known hole in code we can read in full. Development tree: nothing High or Critical — it never leaves the repository, and blocking on a moderate in a test plugin would stall delivery of real fixes for a threat that reaches no instance, while teaching people to route around the check. Licences are held to the same bar: FLOSS and compatible with AGPL-3.0-or-later distribution, and a licence that changes under us is treated as a finding at the same thresholds.



    While active, the project documentation MUST include a policy to address SCA violations prior to any release. [OSPS-VM-05.02]
    Document a policy in the project to address applicable Software Composition Analysis results before any release, and add status checks that verify compliance with that policy prior to release.

    docs/DEPENDENCIES.md states the release rule: no release goes out carrying a violation of either threshold. It is enforced structurally rather than remembered — the check runs on every commit, a tag can only publish a commit that is an ancestor of main, and every commit on main has passed it. The document also says what happens when an advisory lands against an already-published version: the fix goes out as a release of its own rather than waiting for the next feature, which is consistent with the support policy in SECURITY.md, where a fix is always a new release and never a backport.



    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for malicious dependencies and known vulnerabilities in dependencies, then blocked in the event of violations, except when declared and suppressed as non-exploitable. [OSPS-VM-05.03]
    Create a status check in the project's version control system that runs a Software Composition Analysis tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    ci.yml carries a blocking software-composition check on every push and every pull request, evaluated against the documented thresholds and required before merge: npm audit --omit=dev --audit-level=low for the production tree and npm audit --audit-level=high for the development tree, each failing with an error naming which tree breached and pointing at docs/DEPENDENCIES.md. Because pull requests are the only route into main and the check is required, a change introducing a vulnerable or malicious dependency is blocked rather than reported. Suppression is possible only as a recorded non-exploitability assessment, per the policy in the same document. Integrity of what is installed is enforced alongside it: npm ci only, against a committed lockfile carrying an integrity hash per package, with actions pinned to commit SHAs and base images to digests.



    While active, the project documentation MUST include a policy that defines a threshold for remediation of SAST findings. [OSPS-VM-06.01]
    Document a policy in the project that defines a threshold for remediation of Static Application Security Testing (SAST) findings. Include the process for identifying, prioritizing, and remediating these findings.

    docs/SECURITY-PRACTICES.md defines the SAST thresholds in a table: Critical and High must be resolved before the pull request merges and block any release; Medium before the next release, as a fix or a written suppression but never silence; Low and Note triaged within the release cycle and acceptable with a recorded reason. A fourth row overrides the others — any severity in a security-critical path (the file proxy, the access wall, share revocation, the presentation control token, CSP handling) blocks the merge regardless of the tool's own rating, because severity ratings are generic and this codebase is not: a medium in the component that fetches a caller-supplied URL server-side is not a medium here. Suppression is allowed only as not exploitable, with the reason, the decider and the date, and never as a repository-wide rule disablement.



    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for security weaknesses and blocked in the event of violations except when declared and suppressed as non-exploitable. [OSPS-VM-06.02]
    Create a status check in the project's version control system that runs a Static Application Security Testing (SAST) tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    Every change is automatically evaluated and blocked on violation. CodeQL runs the javascript-typescript security query suites on every pull request and every push to main, is a named required check, and is blocking on the publication path; a weekly scheduled run additionally applies new rules to code that has not changed. Alongside it on the same trigger: ESLint with typescript-eslint, tsc under strict with noUnusedLocals, noUnusedParameters and noFallthroughCasesInSwitch, and the repository's own static guards over the workflow YAML, the Dockerfile, the published surface and every tracked file. Because pull requests are the only way into main and these are required checks, a violation blocks the merge. Suppression is governed by the policy in docs/SECURITY-PRACTICES.md and is available only as a recorded non-exploitability assessment. Current state: zero outstanding findings across all of them.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Julien Arthapignet and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Julien Arthapignet.
Entry created on 2026-08-22 00:19:58 UTC, last updated on 2026-08-25 12:37:10 UTC. Last achieved passing badge on 2026-08-22 07:59:01 UTC.