cortex-viz

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 badge status on your project page! The badge status looks like this: Badge level for project 13846 is silver Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13846/badge)](https://www.bestpractices.dev/projects/13846)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/13846"><img src="https://www.bestpractices.dev/projects/13846/badge"></a>


These are the Silver level criteria. You can also view the Passing or Gold level criteria.

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

        

 Basics 17/17 ●

  • General

    Note that other projects may use the same name.

    Cross-platform visualization MCP for Cortex, usable from Codex, Gemini CLI, Claude Code, and any stdio MCP host. It renders Cortex memory, knowledge, sessions, host-neutral live activity, and codebase graphs through six browser views; Trace can run without the Cortex database.

    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.
  • Prerequisites


    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    CONTRIBUTING.md, section 'Requirements for an acceptable contribution': the coding style per language with the selected tool, the structural limits (500-line file, 50-line function, 4 parameters, 3 nesting levels), the mandatory-tests rule, and the copy rule. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md


  • Project oversight


    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]
    The DCO is the recommended mechanism because it's easy to implement, tracked in the source code, and git directly supports a "signed-off" feature using "commit -s". To be most effective it is best if the project documentation explains what "signed-off" means for that project. A CLA is a legal agreement that defines the terms under which intellectual works have been licensed to an organization or project. A contributor assignment agreement (CAA) is a legal agreement that transfers rights in an intellectual work to another party; projects are not required to have CAAs, since having CAA increases the risk that potential contributors will not contribute, especially if the receiver is a for-profit organization. The Apache Software Foundation CLAs (the individual contributor license and the corporate CLA) are examples of CLAs, for projects which determine that the risks of these kinds of CLAs to the project are less than their benefits.

    No Developer Certificate of Origin sign-off is required and no DCO bot is configured. CONTRIBUTING.md instead states that by opening a pull request a contributor affirms they wrote the contribution or have the right to submit it under the MIT license. On a single-maintainer project with no external contributors to date, a DCO bot would add a gate without adding an assurance anyone is currently relying on. This is a SHOULD and it is recorded as not done. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md#sign-your-work



    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]
    There needs to be some well-established documented way to make decisions and resolve disputes. In small projects, this may be as simple as "the project owner and lead makes all final decisions". There are various governance models, including benevolent dictator and formal meritocracy; for more details, see Governance models. Both centralized (e.g., single-maintainer) and decentralized (e.g., group maintainers) approaches have been successfully used in projects. The governance information does not need to document the possibility of creating a project fork, since that is always possible for FLOSS projects.

    GOVERNANCE.md states how decisions are made (ordinary changes by maintainer review on the pull request, design and scope changes discussed in a public issue first, security changes privately until a fix ships), and that everything except unfixed vulnerabilities is decided in public. https://github.com/cdeust/cortex-viz/blob/main/GOVERNANCE.md



    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]
    Projects may be able to improve the civility of their community and to set expectations about acceptable conduct by adopting a code of conduct. This can help avoid problems before they occur and make the project a more welcoming place to encourage contributions. This should focus only on behavior within the community/workplace of the project. Example codes of conduct are the Linux kernel code of conduct, the Contributor Covenant Code of Conduct, the Debian Code of Conduct, the Ubuntu Code of Conduct, the Fedora Code of Conduct, the GNOME Code Of Conduct, the KDE Community Code of Conduct, the Python Community Code of Conduct, The Ruby Community Conduct Guideline, and The Rust Code of Conduct.

    Contributor Covenant 2.1, adapted, with the enforcement contact (admin@ai-architect.tools) and an explicit note that a single maintainer both receives and decides reports, plus the GitHub escalation path if the report concerns the maintainer. https://github.com/cdeust/cortex-viz/blob/main/CODE_OF_CONDUCT.md



    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]
    The documentation for governance and roles and responsibilities may be in one place.

    GOVERNANCE.md carries a table of the three roles (Maintainer, Contributor, Reporter) with the responsibilities and the concrete permission each is held by, and names who holds the maintainer role. It also states that there are currently no committers besides the maintainer. https://github.com/cdeust/cortex-viz/blob/main/GOVERNANCE.md#roles-and-responsibilities



    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    GOVERNANCE.md documents the credential-free MIT-fork continuation path. A successor can fork the complete public repository, enable and manage Issues, accept pull requests through the inherited CI process, and publish an attested tagged release under the fork's own GitHub OIDC identity within a week. No original signing key, package-registry token, domain, private dependency, or legal assignment is required. This preserves the required issue, change-acceptance, and release capabilities, while honestly not claiming preservation of the original URL or a bus factor above 1. https://github.com/cdeust/cortex-viz/blob/main/GOVERNANCE.md#continuity-stated-honestly



    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]
    A "bus factor" (aka "truck factor") is the minimum number of project members that have to suddenly disappear from a project ("hit by a bus") before the project stalls due to lack of knowledgeable or competent personnel. The truck-factor tool can estimate this for projects on GitHub. For more information, see Assessing the Bus Factor of Git Repositories by Cosentino et al.
  • Documentation


    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]
    The project might not achieve the roadmap, and that's fine; the purpose of the roadmap is to help potential users and contributors understand the intended direction of the project. It need not be detailed.

    docs/ROADMAP.md gives the current state, a near-term section whose items are the assurance gaps named in this file (each with its issue number), medium and longer-term direction, and an explicit 'Not planned' section. https://github.com/cdeust/cortex-viz/blob/main/docs/ROADMAP.md



    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]
    A software architecture explains a program's fundamental structures, i.e., the program's major components, the relationships among them, and the key properties of these components and relationships.

    docs/ARCHITECTURE.md documents the two halves (Python server and browser UI) and how they talk, the five Python layers with the inward dependency rule and the file count per layer, the structural invariant that no import mcp_server.* is permitted anywhere in cortex_viz/, the read contract per data source, the browser directory map, the four trust boundaries in order of exposure, and the build and release path. https://github.com/cdeust/cortex-viz/blob/main/docs/ARCHITECTURE.md



    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]
    These are the security requirements that the software is intended to meet.

    Two documents. SECURITY.md covers what cortex-viz accesses, what it writes, the supply-chain assurance and how to verify it, the reporting process with timelines, reporter credit, and scope: https://github.com/cdeust/cortex-viz/blob/main/SECURITY.md. docs/ASSURANCE_CASE.md is the architectural security documentation: assets, adversaries, per-boundary argument, secure design principles, common weaknesses, and an explicit statement of what the case does not cover: https://github.com/cdeust/cortex-viz/blob/main/docs/ASSURANCE_CASE.md



    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]
    The idea is to show users how to get started and make the software do anything at all. This is critically important for potential users to get started.

    README 'Getting Started' is two commands (marketplace add, plugin install) followed by /cortex-visualize, with a no-database path that needs no setup at all: the Trace view runs against ~/.claude session files alone. https://github.com/cdeust/cortex-viz/blob/main/README.md#getting-started



    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]
    The documentation MAY include information about differences or changes between versions of the software and/or link to older versions of the documentation. The intent of this criterion is that an effort is made to keep the documentation consistent, not that the documentation must be perfect.

    Documentation is corrected when it is found wrong, not left to drift. This change alone corrected a blanket 'read-only / does not write' claim in README, SECURITY.md, and PRIVACY.md that was factually wrong (cortex-viz writes five derived-cache tables of its own, including session_activity) and narrowed a UI-fingerprint claim in SECURITY.md that overstated its coverage of CDN-loaded scripts. CONTRIBUTING.md requires that an observable change updates CHANGELOG.md and an interface change updates the README in the same pull request.



    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]
    An achievement is any set of external criteria that the project has specifically worked to meet, including some badges. This information does not need to be on the project website front page. A project using GitHub can put achievements on the repository front page by adding them to the README file.

    README displays the OpenSSF Best Practices badge for project 13846 in its header badge block, linked to https://www.bestpractices.dev/projects/13846, and the Project > Achievements section records the current state of each achievement rather than only the flattering ones: the badge and its answers file, the OpenSSF Scorecard baseline (3.6, 2026-07-26, recorded as a baseline rather than displayed as a badge), and the Sigstore build-provenance attestation with the exact command a user runs to verify it. https://github.com/cdeust/cortex-viz/blob/main/README.md#achievements


  • Accessibility and internationalization


    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]
    For web applications, see the Web Content Accessibility Guidelines (WCAG 2.0) and its supporting document Understanding WCAG 2.0; see also W3C accessibility information. For GUI applications, consider using the environment-specific accessibility guidelines (such as Gnome, KDE, XFCE, Android, iOS, Mac, and Windows). Some TUI applications (e.g. `ncurses` programs) can do certain things to make themselves more accessible (such as `alpine`'s `force-arrow-cursor` setting). Most command-line applications are fairly accessible as-is. This criterion is often N/A, e.g., for program libraries. Here are some examples of actions to take or issues to consider:
    • Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language ( WCAG 2.0 guideline 1.1)
    • Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. ( WCAG 2.0 guideline 1.4.1)
    • The visual presentation of text and images of text has a contrast ratio of at least 4.5:1, except for large text, incidental text, and logotypes ( WCAG 2.0 guideline 1.4.3)
    • Make all functionality available from a keyboard (WCAG guideline 2.1)
    • A GUI or web-based project SHOULD test with at least one screen-reader on the target platform(s) (e.g. NVDA, Jaws, or WindowEyes on Windows; VoiceOver on Mac & iOS; Orca on Linux/BSD; TalkBack on Android). TUI programs MAY work to reduce overdraw to prevent redundant reading by screen-readers.

    No accessibility standard has been applied or tested against. The product is a dense data-visualization surface (SVG, canvas, and WebGL graph views with hover-driven detail), which is the hard case for accessibility, and no keyboard-only navigation audit, screen-reader pass, or WCAG contrast check has been done. Two things point the right way but neither was done for accessibility reasons and neither is evidence: the palette is resolved from design tokens at runtime with a persistent light/dark surface toggle, and every count on screen is exact text rather than a graphic. Recorded as not done rather than claimed from those.



    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]
    Localization "refers to the adaptation of a product, application or document content to meet the language, cultural and other requirements of a specific target market (a locale)." Internationalization is the "design and development of a product, application or document content that enables easy localization for target audiences that vary in culture, region, or language." (See W3C's "Localization vs. Internationalization".) Software meets this criterion simply by being internationalized. No localization for another specific language is required, since once software has been internationalized it's possible for others to work on localization.

    No internationalization. All UI strings are hardcoded English literals in the JS files with no message catalogue, no locale detection, and no externalized strings. The data rendered (memories, session transcripts, file paths) is passed through unmodified and so displays in whatever language the user's own content is in, but that is a property of not touching the data, not i18n support. No translation has been requested; this is a SHOULD and it is recorded as not done.


  • Other


    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]
    Note that the use of GitHub meets this criterion. This criterion only applies to passwords used for authentication of external users into the project sites (aka inbound authentication). If the project sites must log in to other sites (aka outbound authentication), they may need to store authorization tokens for that purpose differently (since storing a hash would be useless). This applies criterion crypto_password_storage to the project sites, similar to sites_https.

    The project operates no site that accepts passwords. The repository and issue tracker are GitHub, which handles its own authentication, and cortex-viz itself has no accounts, no login, and no password storage of any kind: it is a local server bound to 127.0.0.1 with no authentication subsystem.


 Change Control 1/1 ●

  • Previous versions


    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    There is a single supported line and a documented upgrade path, which is what this criterion asks of a project this size. Upgrading means reinstalling the plugin (or pip install -e . from a clone); no configuration migration has ever been required, and no interface removal has occurred across the 2.x series. Breaking changes and their migration steps are recorded per version in https://github.com/cdeust/cortex-viz/blob/main/CHANGELOG.md. Older versions are not backported: users move to the newest, which is stated rather than implied.


 Reporting 3/3 ●

  • Bug-reporting process


    The project MUST use an issue tracker for tracking individual issues. [report_tracker]

    GitHub Issues is used for bug tracking and for enhancement requests, publicly and searchably, with every issue in the last six months resolved and closed. https://github.com/cdeust/cortex-viz/issues


  • Vulnerability report process


    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    SECURITY.md, 'Credit': reporters are credited by name in the security advisory and the release notes unless they ask not to be, and are invited to state in the report which name or handle they want used or that they prefer to remain anonymous. https://github.com/cdeust/cortex-viz/blob/main/SECURITY.md



    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]
    This is strongly related to vulnerability_report_process, which requires that there be a documented way to report vulnerabilities. It also related to vulnerability_report_response, which requires response to vulnerability reports within a certain time frame.

    SECURITY.md, 'What happens next', publishes the process and its timelines: acknowledgement within 14 days, assessment of severity and affected versions within 30 days of acknowledgement, fix or a written dated plan tracked in the advisory, public disclosure after the fix ships, with an email escalation path if 14 days pass unanswered. The scope of what is and is not covered is stated in the same file. https://github.com/cdeust/cortex-viz/blob/main/SECURITY.md


 Quality 19/19 ●

  • Coding standards


    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]
    In most cases this is done by referring to some existing style guide(s), possibly listing differences. These style guides can include ways to improve readability and ways to reduce the likelihood of defects (including vulnerabilities). Many programming languages have one or more widely-used style guides. Examples of style guides include Google's style guides and SEI CERT Coding Standards.

    CONTRIBUTING.md names the style guide per primary language and the tool for each: PEP 8 for Python with the project's [tool.ruff] configuration in pyproject.toml, and for the browser UI vanilla ESM and IIFE with no bundler or framework, matching the file being edited. It also states the structural limits that review enforces (500-line file, 50-line function, 4 parameters, 3 nesting levels), which are the standard behind issues #17, #23, and #41. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md#coding-style



    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]
    This MAY be implemented using static analysis tool(s) and/or by forcing the code through code reformatters. In many cases the tool configuration is included in the project's repository (since different projects may choose different configurations). Projects MAY allow style exceptions (and typically will); where exceptions occur, they MUST be rare and documented in the code at their locations, so that these exceptions can be reviewed and so that tools can automatically handle them in the future. Examples of such tools include ESLint (JavaScript), Rubocop (Ruby), and devtools check (R).

    Both languages are automatically enforced by required CI jobs. Python: lint runs ruff check (rule set in [tool.ruff.lint].select) plus ruff format --check; ruff is pinned in the dev extra (>=0.15.0,<0.16.0) and installed from uv.lock, so CI runs the same version a contributor does. JavaScript: js-lint runs npm run lint (ESLint 10 flat config, eslint.config.mjs) over ui/, with a rule set scoped to what a reader cannot catch in one file — no-undef, no-implicit-globals, no-redeclare, no-unused-vars and the always-a-bug rules — since the UI is vanilla script-tag JavaScript with hand-maintained load order and no bundler. Vendored minified bundles under ui/**/vendor/ are excluded. Wiring it found and fixed three variables (domainsSeen, globalCount, hotCount in ui/unified/js/knowledge.js) that were assigned without declaration and so leaked onto window. Closed by https://github.com/cdeust/cortex-viz/issues/45


  • Working build system


    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]
    It should be easy to enable special build features like Address Sanitizer (ASAN), or to comply with distribution hardening best practices (e.g., by easily turning on compiler flags to do so).

    There is no make or configure build to pass variables to. The build is PEP 517 via hatchling, driven by pyproject.toml, where the equivalent settings are declarative rather than variable-driven, and the browser UI ships as static assets with no build step at all.



    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]
    E.G., setting CFLAGS (C) or CXXFLAGS (C++) should create the relevant debugging information if those languages are used, and they should not be stripped during installation. Debugging information is needed for support and analysis, and also useful for measuring the presence of hardening features in the compiled binaries.

    Nothing is compiled, so there is no debug-information or symbol-stripping step to preserve. Python source ships as source in the wheel and the UI ships unminified and unbundled, which means the shipped JavaScript is already the readable original.



    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]
    The project build system's internal dependency information needs to be accurate, otherwise, changes to the project may not build correctly. Incorrect builds can lead to defects (including vulnerabilities). A common mistake in large build systems is to use a "recursive build" or "recursive make", that is, a hierarchy of subdirectories containing source files, where each subdirectory is independently built. Unless each subdirectory is fully independent, this is a mistake, because the dependency information is incorrect.

    There is no recursive make. The build is a single PEP 517 hatchling invocation.



    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]
    GCC and clang users may find the -frandom-seed option useful; in some cases, this can be resolved by forcing some sort order. More suggestions can be found at the reproducible build site.

    This is the disposition the criterion prescribes for scripting languages where the source is used directly rather than compiled. Python source and the static UI tree are shipped and executed as-is. The integrity property this criterion protects is provided by different means here and is verifiable: a sha256sum manifest over the whole ui/ tree, per-asset checksums, and a Sigstore build-provenance attestation binding every artifact digest to this repository, workflow, and commit.


  • Installation system


    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]
    Examples include using a package manager (at the system or language level), "make install/uninstall" (supporting DESTDIR), a container in a standard format, or a virtual machine image in a standard format. The installation and uninstallation process (e.g., its packaging) MAY be implemented by a third party as long as it is FLOSS.

    The standard mechanism for this product's ecosystem: the Claude Code plugin marketplace (claude plugin marketplace add cdeust/Cortex then claude plugin install cortex-viz), which is how a plugin is normally installed. For non-plugin use it is a standard PEP 517 package: pip install -e . from a clone, and it registers in any MCP host as a plain stdio process. https://github.com/cdeust/cortex-viz/blob/main/README.md#install



    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    There is no bespoke installer with prefix or destination variables. Installation is delegated to pip and to the plugin host, both of which honour their own standard location and environment conventions.



    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]
    This MAY be implemented using a generated container and/or installation script(s). External dependencies would typically be installed by invoking system and/or language package manager(s), per external_dependencies.

    git clone, pip install -e ".[dev]", python -m pytest gets a working development environment, and npm ci && npm test the browser half. Critically, no external infrastructure is needed to run it: CORTEX_VIZ_NO_DB=1 python3 -m cortex_viz starts the server with no Cortex install and no PostgreSQL, serving the Trace view from ~/.claude session files alone. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md#running-the-suites


  • Externally-maintained components


    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]
    Typically this is done using the conventions of package manager and/or build system. Note that this helps implement installation_development_quick.

    Computer-processable and complete on both halves. Python: pyproject.toml declares runtime dependencies and the viz-tile, community, data, and dev extras, with uv.lock pinning the resolved graph; every release additionally ships a CycloneDX SBOM (cortex-viz.cdx.json) generated from that lock. JavaScript: package.json plus package-lock.json, devDependencies only, since the harness ships nothing. https://github.com/cdeust/cortex-viz/blob/main/pyproject.toml



    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]
    This can be done using an origin analyzer / dependency checking tool / software composition analysis tool such as OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, and Bundler-audit (for Ruby). Some package managers include mechanisms to do this. It is acceptable if the components' vulnerability cannot be exploited, but this analysis is difficult and it is sometimes easier to simply update or fix the part.

    Two independent mechanisms. Dependabot covers all three dependency surfaces weekly (pip, npm, and github-actions, the last so SHA-pinned actions still receive security updates): https://github.com/cdeust/cortex-viz/blob/main/.github/dependabot.yml. OpenSSF Scorecard grades dependency posture weekly: https://github.com/cdeust/cortex-viz/blob/main/.github/workflows/scorecard.yml. Stated honestly, this is new: nothing was watching before, which is exactly why 19 npm advisories in the test harness had gone unnoticed until a manual audit on 2026-07-28 (https://github.com/cdeust/cortex-viz/issues/49).



    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]
    A typical way to meet this criterion is to use system and programming language package management systems. Many FLOSS programs are distributed with "convenience libraries" that are local copies of standard libraries (possibly forked). By itself, that's fine. However, if the program *must* use these local (forked) copies, then updating the "standard" libraries as a security update will leave these additional copies still vulnerable. This is especially an issue for cloud-based systems; if the cloud provider updates their "standard" libraries but the program won't use them, then the updates don't actually help. See, e.g., "Chromium: Why it isn't in Fedora yet as a proper package" by Tom Callaway.

    Reused components are standard registry packages with no forked or vendored convenience copies to diverge: Python via pip and pyproject.toml, JavaScript devDependencies via npm, GitHub Actions SHA-pinned with the version in a trailing comment so Dependabot rewrites pin and comment together. The ui/ tree is first-party source, not a vendored third party. One qualifier, recorded rather than omitted: four UI pages load three.js and 3d-force-graph from the unpkg CDN. Those are version-pinned in the script tag, so identifying and updating them is trivial, but they carry no Subresource Integrity hash and are outside the release fingerprint; https://github.com/cdeust/cortex-viz/issues/50 proposes vendoring them, which would also close that gap.



    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    The documented interface matches the shipped one. Both MCP tools (open_visualization with its view parameter, get_methodology_graph) are documented in the README as implemented, and the data sources behind the HTTP surface are tabulated in docs/ARCHITECTURE.md against the current code. CONTRIBUTING.md requires an interface change to update the README in the same pull request.


  • Automated test suite


    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]
    This requirement can be viewed as a subset of test_continuous_integration, but focused on just testing, without requiring continuous integration.

    CI runs on every push and every pull request, exercising the assembled system rather than isolated units: 431 pytest tests including HTTP endpoint and server-integration suites, and 175 vitest tests that load the real ui/ source files into jsdom and assert cross-module behaviour such as SVG-versus-canvas renderer agreement on one model. Both jobs are required and both report pass or fail per run. https://github.com/cdeust/cortex-viz/blob/main/.github/workflows/ci.yml



    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    The practice holds for defects in code that the suites can reach. #35's fix to the DB-skip fixture, which had silently become a no-op because MemoryReader was lazy, shipped with the corrected assertion; #36 landed its verdict logic as a pure seam with every emission asserted, including the quiet complete state, and gated by Stryker rather than by line coverage. Two of the last six months' fixes carry no test and the reason is stated rather than hidden: #31 was user-visible copy (em-dash removal) and #39 was a CI workflow fix whose failure mode was startup_failure on main, verified by workflow_dispatch post-merge because a push-and-schedule-only workflow is invisible to pull-request CI. Neither is testable by the pytest or vitest suites. The rule is now written down rather than customary: CONTRIBUTING.md requires a regression test that fails on the pre-fix code. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md



    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]
    Many FLOSS tools are available to measure test coverage, including gcov/lcov, Blanket.js, Istanbul, JCov, and covr (R). Note that meeting this criterion is not a guarantee that the test suite is thorough, instead, failing to meet this criterion is a strong indicator of a poor test suite.

    Measured on merged main commit 3a11c6653c1aea74c7b57409c6e762bcd6e9993f. The required CI job runs coverage run -m pytest followed by coverage report; pyproject.toml enforces fail_under = 80, so a regression fails the pull request. The complete local validation reported 988 passed, 10 skipped and 81% Python statement coverage (11,674 statements, 2,272 missed); the post-merge CI run passed. The browser surface is separately gated by 259 JavaScript tests. Evidence: https://github.com/cdeust/cortex-viz/pull/97 and https://github.com/cdeust/cortex-viz/actions/runs/30837051506


  • New functionality testing


    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    CONTRIBUTING.md states it as a requirement in the imperative, not as encouragement: 'As major new functionality is added, tests for that functionality MUST be added to the automated test suite in the same pull request', followed by 'a pull request that adds behaviour without tests will be sent back', and separately that a bug fix requires a regression test failing on the pre-fix code. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md#tests-are-mandatory-for-new-functionality



    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    The requirement, the command for each suite, and the standard tests are judged by are all in CONTRIBUTING.md, including that strength is measured by mutation rather than line coverage, with the Stryker configuration in stryker.conf.json and surviving mutants triaged in tests/js/MUTATION_NOTES.md. https://github.com/cdeust/cortex-viz/blob/main/CONTRIBUTING.md


  • Warning flags


    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    Maximally strict where practical, enforced by a required CI job. The lint job in .github/workflows/ci.yml runs ruff check and ruff format --check over the whole tree on every push and pull request; js-lint runs ESLint over ui/. The Python rule set is wider than ruff's default: [tool.ruff.lint].select is E, W, F, I, N, UP, B, C4, SIM, RUF (pyproject.toml). --select ALL is deliberately NOT the target — it reports 6,369 findings here, dominated by docstring-style (D), annotation-completeness (ANN) and assert-in-test (S101) rules that would be answered with a blanket ignore, which is a preference dressed as a gate. Two rules are ignored with the reason written at the ignore: RUF100, because under a curated select it deletes suppressions for rules the set does not enable (it removed 52 of the 60 it flagged, incl. 4 security ones), and SIM105, because ruff's own fixer withholds it at all 42 sites here — every one carries the named failure mode as a comment, which the rewrite would erase. Note on the earlier figure: the 486 violations cited before were measured with ruff's PREVIEW rules enabled, not the defaults; on stable rules the tree passed then and now. The real gate cost was 386 findings under the widened set, all cleared. Closed by https://github.com/cdeust/cortex-viz/issues/45


 Security 13/13 ●

  • Secure development knowledge


    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]
    For example, the project results should have fail-safe defaults (access decisions should deny by default, and projects' installation should be secure by default). They should also have complete mediation (every access that might be limited must be checked for authority and be non-bypassable). Note that in some cases principles will conflict, in which case a choice must be made (e.g., many mechanisms can make things more complex, contravening "economy of mechanism" / keep it simple).

    The principles are applied concretely and the instances are auditable. Least privilege: Cortex's memory tables are never written and the ban on import mcp_server.* keeps the separation structural; workflow tokens are permissions: read-all by default and widened per job only where a job must write. Fail-safe defaults: binds 127.0.0.1 and never 0.0.0.0, an unreachable database degrades to a named no-DB mode rather than erroring or inventing data, and an unknown static path returns 403 or 404 rather than guessing. Complete mediation: Host, Origin, and same-origin checks run per request in the handler path, not once at startup. Defence in depth: three independent controls on the browser-to-server boundary with distinct failure modes, so a cross-site write requires two of them to fail. Economy of mechanism: no bundler, no framework, no plugin system, no authentication subsystem. Set out with the per-boundary argument in https://github.com/cdeust/cortex-viz/blob/main/docs/ASSURANCE_CASE.md


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]
    Concerns about CBC mode in SSH are discussed in CERT: SSH CBC vulnerability.

    cortex-viz implements no cryptography. It stores no passwords, mints no keys, tokens, or nonces, and runs no cryptographic protocol: it is a local read-mostly visualization server bound to 127.0.0.1. Release signing is delegated entirely to Sigstore via GitHub's attest-build-provenance action, so no signing key is handled by this project's code.



    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    cortex-viz implements no cryptography. It stores no passwords, mints no keys, tokens, or nonces, and runs no cryptographic protocol: it is a local read-mostly visualization server bound to 127.0.0.1. Release signing is delegated entirely to Sigstore via GitHub's attest-build-provenance action, so no signing key is handled by this project's code.



    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    The one credential-bearing value cortex-viz handles is DATABASE_URL, which may embed a database password. It is supplied entirely as external configuration, either the plugin's database_url user setting or the DATABASE_URL environment variable, is never written into a configuration file the project ships, never committed, and never logged. Changing or rotating it requires no code change, no rebuild, and no reinstall: set the value and restart the server. The project stores no other credential and no private key of its own.



    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    Answered against what the software does rather than reinterpreting the question. The HTTP server speaks plain HTTP, not HTTPS. The mitigating facts are real: it binds 127.0.0.1 only, so traffic never leaves the loopback device and there is no network path for an interceptor to sit on, and requests are gated by a Host-header allowlist, an Origin allowlist, and a same-origin check on writes. TLS on loopback would add certificate generation, trust-store, and rotation burden for a local developer tool without countering a threat in the model (a local process capable of sniffing loopback can already read ~/.claude and the database directly). The one outbound request the product makes, the CDN library fetch, is HTTPS. This is a SHOULD, and it is recorded as not met with the reasoning, rather than marked N/A on the grounds that loopback is not a network. See https://github.com/cdeust/cortex-viz/blob/main/docs/ASSURANCE_CASE.md sections 3.1 and 3.5.



    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    The project implements no TLS and terminates no TLS connection: the server is plain HTTP on loopback. The one HTTPS request in the product is the browser's own fetch of a CDN library, where protocol version selection belongs to the browser and to unpkg, not to this software.



    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    The software does not use TLS itself, so there is no certificate for it to verify. The CDN subresource fetch is performed by the browser, which verifies the certificate under its own policy.



    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    The software does not use TLS, and sends no private information over one. It has no cookies, no sessions, no tokens, and no authentication headers of any kind.


  • Secure release


    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]
    The project results include both source code and any generated deliverables where applicable (e.g., executables, packages, and containers). Generated deliverables MAY be signed separately from source code. These MAY be implemented as signed git tags (using cryptographic digital signatures). Projects MAY provide generated results separately from tools like git, but in those cases, the separate results MUST be separately signed.

    Release v2.8.0 was produced by the committed Release.yaml workflow and publishes a wheel, source archive, CycloneDX SBOM, UI fingerprint manifest, and SHA-256 companions. The workflow uses GitHub OIDC with actions/attest-build-provenance, so the signing identity is short-lived and no project private key exists on the distribution site. On 2026-08-03 all four primary assets passed their checksums and gh attestation verify <file> --repo cdeust/cortex-viz, which verifies the Sigstore certificate and transparency-log provenance. Release: https://github.com/cdeust/cortex-viz/releases/tag/v2.8.0. Verification process: https://github.com/cdeust/cortex-viz/blob/main/SECURITY.md and https://github.com/cdeust/cortex-viz/blob/main/.github/workflows/Release.yaml



    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    No version tag is cryptographically signed: git tag -v v2.7.1 reports a non-tag commit object. Signing tags with git tag -s is folded into https://github.com/cdeust/cortex-viz/issues/47 alongside exercising the release workflow, since both concern the same trust chain from tag to artifact.


  • Other security issues


    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]
    Note that comparing input against a list of "bad formats" (aka a *denylist*) is normally not enough, because attackers can often work around a denylist. In particular, numbers are converted into internal formats and then checked if they are between their minimum and maximum (inclusive), and text strings are checked to ensure that they are valid text patterns (e.g., valid UTF-8, length, syntax, etc.). Some data may need to be "anything at all" (e.g., a file uploader), but these would typically be rare.

    Untrusted input is checked against allowlists and rejected, not sanitized-and-hoped. The request-header surface is allowlisted in cortex_viz/server/http_security.py: validate_host_header requires the Host header to name a loopback host from a fixed frozenset (DNS-rebinding defense, CWE-346/350), resolve_allowed_origin allowlists origins (CWE-942), _is_safe_header_value rejects any character below 0x20 plus 0x7f before a request-derived value is reflected into a response header (CWE-113, which Python's send_header does not filter), and enforce_same_origin_write gates writes (CWE-352). The request-path surface is validated before the filesystem is touched: reject empty, NUL-bearing, .., and dot-prefixed components, then resolve() and require containment within the base directory and that the target is an existing file, returning 403 or 404 rather than a guess. The qualifier, stated rather than omitted: CodeQL still reports 10 py/path-injection alerts across four files, of which only the static-serving sites have been read in detail; the site-by-site triage with a traversal regression test per site is https://github.com/cdeust/cortex-viz/issues/46.



    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]
    Hardening mechanisms may include HTTP headers like Content Security Policy (CSP), compiler flags to mitigate attacks (such as -fstack-protector), or compiler flags to eliminate undefined behavior. For our purposes least privilege is not considered a hardening mechanism (least privilege is important, but separate).

    No hardening mechanism is applied in the sense this criterion means. The server sends no security headers on its HTML responses: no Content-Security-Policy, no X-Content-Type-Options, no Referrer-Policy, no frame-ancestors restriction. For a product whose exposed half is 26k lines of browser-executed JavaScript rendering untrusted content (memory text, session transcripts, file paths) into the DOM, a CSP is the hardening measure that would most reduce the impact of the XSS-class defects CodeQL currently reports, by turning a successful injection into a blocked load rather than arbitrary execution. The existing controls (loopback binding, Host and Origin allowlists, CSRF check) are access controls that keep the attacker out; they are not hardening, which is about limiting the damage when a defect is reached anyway, and this file does not count one as the other. Recommended alongside the DOM-sanitisation work in https://github.com/cdeust/cortex-viz/issues/46, and a CSP would also constrain the unpinned CDN loads in https://github.com/cdeust/cortex-viz/issues/50.



    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]
    An assurance case is "a documented body of evidence that provides a convincing and valid argument that a specified set of critical claims regarding a system’s properties are adequately justified for a given application in a given environment" ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Trust boundaries are boundaries where data or execution changes its level of trust, e.g., a server's boundaries in a typical web application. It's common to list secure design principles (such as Saltzer and Schroeer) and common implementation security weaknesses (such as the OWASP top 10 or CWE/SANS top 25), and show how each are countered. The BadgeApp assurance case may be a useful example. This is related to documentation_security, documentation_architecture, and implement_secure_design.

    docs/ASSURANCE_CASE.md contains all four required elements. Threat model: six numbered adversaries with their reach and STRIDE categories, plus an explicit out-of-scope statement. Trust boundaries: four, identified and ordered by exposure. Secure design principles: a table of seven principles each with its concrete instance in this codebase. Common implementation weaknesses: a table of twelve weakness classes with the status of each. It also states where the argument is incomplete (the untriaged findings on the untrusted-data boundary) and what it does not cover, rather than presenting itself as finished. https://github.com/cdeust/cortex-viz/blob/main/docs/ASSURANCE_CASE.md


 Analysis 2/2 ●

  • Static code analysis


    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    The security-and-quality suite includes CodeQL's security queries for both languages, which is how the current py/path-injection, js/remote-property-injection, and js/incomplete-html-attribute-sanitization alerts were surfaced at all.


  • Dynamic code analysis


    If the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) MUST be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    No memory-unsafe language is used. The project is Python and browser JavaScript only; there is no C, C++, or unsafe Rust anywhere in the tree, and no compiled extension is authored by this project.



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/13846/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. See our automation proposals system for how to do that. 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 Clement and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Clement.
Entry created on 2026-07-27 22:31:30 UTC, last updated on 2026-08-03 17:49:03 UTC. Last achieved passing badge on 2026-08-02 23:50:36 UTC.