cortex-viz

遵循以下最佳实践的项目将能够自愿的自我认证,并显示他们已经实现了核心基础设施计划(OpenSSF)徽章。

没有一套可以保证软件永远不会有缺陷或漏洞的做法;如果规范或假设是错误的,即使合适的方法也可能失败。也没有哪些做法可以保证一个项目能够维持健康和运作良好的开发者社区。但是,遵循最佳做法可以帮助改善项目的成果。例如,一些做法可以在发布之前进行多人评估,这可以帮助您找到其他难以找到的技术漏洞,并帮助建立信任,并希望不同公司的开发人员之间进行重复的交互。要获得徽章,必须满足所有“必须”和“禁止”的条款,满足所有“应该”条款或有合适的理由,和所有“建议”条款必须满足或未满足(至少希望考虑)。欢迎通过 GitHub网站创建问题或提出请求进行反馈。另外还有一个一般讨论邮件列表。

如果这是您的项目,请在您的项目页面上显示您的徽章状态!徽章状态如下所示: 项目13846的徽章级别为silver 这里是如何嵌入它:
您可以通过将其嵌入在您的Markdown文件中:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13846/badge)](https://www.bestpractices.dev/projects/13846)
或将其嵌入到HTML中来显示您的徽章状态:
<a href="https://www.bestpractices.dev/projects/13846"><img src="https://www.bestpractices.dev/projects/13846/badge"></a>


这些是白银级别条款。您还可以查看通过或黄金级别条款。

Baseline Series: 基准等级1 基准等级2 基准等级3

        

 基本 17/17 ●

  • 常规

    请注意,其他项目可能使用相同的名称。

    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.

    请使用 SPDX许可证表达格式;例子包括“Apache-2.0”,“BSD-2-Clause”,“BSD-3-Clause”,“GPL-2.0+”,“LGPL-3.0 +”,“MIT”和“(BSD-2-Clause OR Ruby)”。
    如果有多种语言,请将它们列为逗号分隔值(可选空格),并将它们从最多到最少使用。如果有长列表,请至少列出前三个最常见的列表。如果没有语言(例如,这是仅文档或仅测试项目),请使用单个字符“ - ”。请使用每种语言的常规大小写,例如“JavaScript”。
    通用平台枚举(CPE)是用于信息技术系统,软件和软件包的结构化命名方案。在报告漏洞时,它可用于多个系统和数据库。
  • 先决条件


    项目必须拥有通过徽章。 [achieve_passing]

  • 基本项目网站内容


    关于如何贡献的信息必须包括对可接受的贡献的要求(例如,引用任何所需的编码标准)。 (需要网址) [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


  • 项目监督


    该项目应该有一个合法机制,所有对项目软件做出显著贡献的开发人员都声明他们有合法授权作出这些贡献。最常用且易于实施的方法是使用开发者原产地证书(DCO),用户可以在其提交中添加“signed-off-by”,另外,项目链接到DCO网站。本条款也可以使用贡献者许可协议(CLA)或其他法律机制实现。 (需要网址) [dco]
    DCO是推荐的机制,因为它易于实现,在源代码中进行跟踪,并且git使用“commit -s”直接支持“签名”功能。更有效的是,项目文件解释了该项目的“签名”手段。 CLA是一项法律协议,用于定义知识产权许可给组织或项目的条款。捐助者转让协议(CAA)是将知识产权权利转让给另一方的法律协议;项目不必具备CAA,因为CAA增加了潜在贡献者不愿贡献的风险,特别是如果接收者是一个营利性组织。 Apache Software Foundation CLA(个人贡献者许可证和公司CLA)是CLA的示例,用于确定项目的这些CLA的风险对项目的影响小于其获益。

    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



    该项目必须明确定义和记录其项目治理模式(决策方式,包括关键角色)。 (需要网址) [governance]
    需要有一些成熟的书面方式来作出决定和解决争端。在小项目中,这可能就像“项目拥有者和负责人做所有最终决定”一样简单。有各种治理模式,包括仁慈的独裁者和正式的精英统治;有关详细信息,请参阅治理模式。集中式(例如,单一维护者)和分散式(例如,组维护者)方法都已经在项目中成功使用。治理信息不需要记录创建项目分支的可能性,因为对于FLOSS项目来说总是可能的。

    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



    该项目必须采取行为守则,并将其发布在标准的位置。 (需要网址) [code_of_conduct]
    项目可能能够提高社区的文明程度,并通过采取行为守则来规定对可接受的行为的期望。这可以帮助在发生问题之前避免问题,并使项目成为更加欢迎的地方来鼓励贡献。这应该只关注项目社区/工作场所的行为。行为规范的示例是贡献者约定行为准则和Linux内核代码冲突。

    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



    该项目必须明确定义和公开记录项目中的关键角色及其职责,包括这些角色必须执行的任务。必须清楚指出谁是什么角色,尽管这可能没有以相同的方式记录下来。 (需要网址) [roles_responsibilities]
    治理和角色和职责的文档可以在一个地方。

    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



    如果任何一个开发者丧失工作能力或丧生,该项目必须能够继续保持最小的中断。特别是,在确认个人无行为能力或死亡的一周内,项目必须能够创建和关闭问题,接受提议的更改和发布软件版本。这可以通过确保其他人有任何必要的密钥,密码和合法权利来继续该项目。运行FLOSS项目的个人可以通过在锁箱中提供密钥,并提供任何所需的合法权利(例如DNS名称)来实现。 (需要网址) [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



    项目必须具有2个或更多的“公交车因子”。 (需要网址) [bus_factor]
    “公交车系数”(又名“卡车因子”)是指最少数量的项目成员,如果突然离开项目(“被公交车撞了”),项目会由于缺乏具备知识的或有能力的人员而暂停。 卡车因子 工具可以对GitHub上的项目进行估计。有关详细信息,请参阅Cosentino等人的评估Git存储库的卡车因子。
  • 文档


    该项目必须有一个文档化的路线图,描述项目打算做什么,至少在下一年做什么。 (需要网址) [documentation_roadmap]
    项目可能没有实现路线图,没关系。路线图的目的是帮助潜在的用户和贡献者了解项目的预期方向。它不需要特别详细。

    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



    该项目必须包括项目生成的软件的架构(也称为高级别设计)的文档。如果项目不产生软件,请选择“不适用”(N/A)。 (需要网址) [documentation_architecture]
    软件架构解释了程序的基本结构,即程序的主要组件,它们之间的关系以及这些组件和关系的关键属性。

    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



    该项目必须书面记录用户从项目生成的软件的安全性上可以获得和不能指望的内容(其“安全需求”)。 (需要网址) [documentation_security]
    这些是软件意图满足的安全需求。

    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



    该项目必须为新用户提供“快速启动”指南,以帮助他们快速使用该软件。 (需要网址) [documentation_quick_start]
    这个想法是向用户展示如何入门,使软件完全可以做事情。这对于潜在用户是至关重要的。

    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



    项目必须努力使文档与当前版本的项目结果(包括项目生成的软件)保持一致。任何已知的文档缺陷使其不一致必须修正。如果文档基本是最新的,但是错误地包括一些不再是真实的旧信息,那么将其视为缺陷,然后像往常一样进行跟踪和修复。 [documentation_current]
    该文档可以包括有关软件版本之间的差异或更改的信息,与/或链接到旧版本的文档。这个条款的意图在于努力保持文档的一致性,而不是文档必须完美。

    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.



    项目存储代码库首页和/或网站必须在获得成就的48小时内标识并超链接任何成就,包括此最佳实践徽章。 (需要网址) [documentation_achievements]
    一个成就是项目致力于满足的任何外部条款,包括徽章。该信息不需要在项目网站首页上。使用GitHub的项目可以通过将其添加到README文件中,将成果放在存储代码库首页。

    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_best_practices]
    对于Web应用程序,请参阅 Web 内容无障碍指导 (WCAG 2.0,英文) 以及其支持文档 理解 WCAG 2.0(英文);或者 W3C 无障碍信息(英文). 图形界面(GUI)应用考虑使用环境特定的无障碍指导(例如 Gnome, KDE, XFCE, Android, iOS, Mac, 以及 Windows). 一些TUI应用 (例如,`ncurses` 程序) 可以做一些特定的工作,增强可访问性(例如,`alpine` 的 `force-arrow-cursor` 设置)。多数命令行应用没有特别的无障碍设置。本条款经常是不涉及(N/A),例如,对于组件库。以下是一些要采取的行动或需要考虑的问题的例子:
    • 提供非文字内容的文字替代,以便于转换为其他需要的格式,如大字体、盲文、语音、符号或者简单文字( WCAG 2.0 指导 1.1 (英文))
    • 颜色不被用作传达信息,指示动作,提示响应或区分视觉元素的唯一视觉方式。 ( WCAG 2.0 指导 1.4.1(英文))
    • 文本和文字图像的视觉呈现对比度至少为4.5:1,除了大文本,次要文本和标识符之外。 ( WCAG 2.0 指导 1.4.3(英文))
    • 使用键盘可访问所有功能 (WCAG 指导 2.1)
    • 图形界面应用(GUI)或者Web应用在目标平台上,应该至少使用一种屏幕阅读器测试(例如,NVDA;Jaws;Windows上的WindowEyes;Mac & iOS上的VoiceOver;Linux/BSD上的Orca;Android上的TalkBack)。TUI程序可以减少过度渲染以防止屏幕阅读器的冗余读取。

    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.



    该项目产生的软件应该被国际化,以便为目标受众的文化,地区或语言进行简单的本地化。如果国际化(i18n)不适用(例如,该软件不会生成针对最终用户的文本,并且不排序可读文本),请选择“不适用”(N/A)。 [internationalization]
    本地化“是指适应产品,应用或文档内容以满足特定目标市场(语言环境)的语言,文化和其他要求。国际化是“设计和开发产品,应用或文档内容,使不同文化,地区或语言的目标受众更容易本地化”。 (请参阅 W3C的“本地化与国际化”)。软件只需通过国际化即可达到此标准。不需要另一种特定语言的本地化,因为一旦软件已被国际化,其他人就可以从事本地化。

    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.


  • 其他


    如果项目站点(网站,存储库和下载URL)存储用于外部用户认证的密码,则必须使用密钥拉伸(迭代)算法将密码存储为具有每用户盐值的迭代散列(例如,PBKDF2,Bcrypt或Scrypt)。如果项目站点不存储密码,请选择“不适用”(N/A)。 [sites_password_security]
    请注意,使用 GitHub 符合此条款。此条款仅适用于用于外部用户认证到项目站点的密码。如果项目站点必须登录到其他站点,则可能需要为此目的存储密码(因为使用像Bcrypt这样的算法会使这些密码无效)。本条款将 crypto_password_storage 条款应用于项目站点,类似于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.


 变更控制 1/1 ●

  • 之前的版本


    该项目必须维护最常用的旧版本的产品或提供较新版本的升级路径。如果升级路径很困难,项目必须记录如何执行升级(例如,给出更改的接口描述和详细的建议步骤以帮助升级)。 [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.


 报告 3/3 ●

  • 错误报告流程


    项目必须使用问题跟踪器来跟踪每个问题。 [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


  • 漏洞报告流程


    除了要求匿名的报告者外,该项目必须对过去12个月内解决的所有漏洞报告的报告者表示感谢。如果过去12个月没有修复漏洞,请选择“不适用”(N/A)。 (需要网址) [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



    该项目必须有一个书面的流程来响应漏洞报告。 (需要网址) [vulnerability_response_process]
    这与security_report_process有很强的相关性,它需要有一个书面的流程来报告漏洞。它还涉及到spam_report_response,它需要在一定时间内响应漏洞报告。

    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


 质量 19/19 ●

  • 编码标准


    该项目必须确定其使用的主要语言的具体编码风格指南,并要求贡献一般情况下符合此要求。 (需要网址) [coding_standards]
    在大多数情况下,这是通过参考一些现有的风格指南来完成的,可能列出差异。这些风格指南可以包括提高可读性的方法和减少缺陷可能性(包括漏洞)的方法。许多编程语言有一个或多个广泛使用的风格指南。样式指南的示例包括 Google风格指南(英文)和 SEI CERT编码标准(英文)。

    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



    如果至少有一个FLOSS工具可以应用于所选择的语言,项目必须自动执行其选定的编码风格。 [coding_standards_enforced]
    这可以使用静态分析工具和/或通过代码重新格式化强制代码实现。在许多情况下,工具配置包含在项目的存储库中(因为不同的项目可能会选择不同的配置)。项目可以允许风格例外(通常会);在发生例外的情况下(应该很少),它们必须在其位置的代码中记录在案,以便可以对这些例外进行检视,并使工具能够在将来自动处理它们。这些工具的例子包括ESLint(JavaScript)和Rubocop(Ruby)。

    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


  • 可工作的构建系统


    本地二进制文件的构建系统必须遵守传递给它们的相关编译器和链接器(环境)变量(例如CC,CFLAGS,CXX,CXXFLAGS和LDFLAGS),并将它们传递给编译器和链接器。构建系统可以使用附加标志来扩展它们,但不能简单地用自己的替换提供的值。如果没有生成本地二进制文件,请选择“不适用”(N/A)。 [build_standard_variables]
    应该很容易启用特殊的构建功能,如地址消毒剂(Address Sanitizer,ASAN),或符合发布加固最佳实践(例如,通过轻松打开编译器标志来实现)。

    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.



    构建和安装系统在在相关标志中要求时,应该保留调试信息(例如,“install -s”未被使用)。如果没有构建或安装系统(例如典型的JavaScript库),请选择“不适用”(N/A)。 [build_preserve_debug]
    例如,如果使用这些语言,则应该设置CFLAGS(C)或CXXFLAGS(C ++)创建相关的调试信息,并且在安装过程中不应该剥离它们。支持和分析时,需要调试信息,也可用于测量编译二进制文件中加固特性的存在。

    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.



    如果子目录中存在交叉依赖关系,则由项目生成的软件的构建系统必须不能递归地构建子目录。如果没有构建或安装系统(例如典型的JavaScript库),请选择“不适用”(N/A)。 [build_non_recursive]
    项目构建系统的内部依赖关系信息需要准确,否则,对项目的更改可能无法正确构建。不正确的构建可能会导致缺陷(包括漏洞)。大型构建系统中的常见错误是使用“递归构建”或“递归生成”,即包含源文件的子目录的层次结构,其中每个子目录都是独立构建的。除非每个子目录完全独立,否则这是一个错误,因为依赖关系信息不正确。

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



    该项目必须能够重复从源代码文件生成的过程,并获得完全相同的比特位结果。如果没有发生构建(例如,直接使用源代码而不是编译使用的脚本语言),请选择“不适用”(N/A)。 [build_repeatable]
    GCC和clang用户可能会发现-frandom-seed选项有用;在某些情况下,这可以通过强制某种排序来解决。更多建议可以在可重复构建(英文)站点找到。

    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_common]
    示例包括使用软件包管理器(在系统或语言级别),“make install/uninstall”(支持DESTDIR),标准格式的容器或标准格式的虚拟机映像。安装和卸载过程(例如,打包)可以由第三方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



    最终用户的安装系统必须遵守用于在安装时选择构建工件写入位置的标准约定。例如,如果在POSIX系统上安装文件,它必须遵守DESTDIR环境变量。如果没有安装系统或没有标准惯例,请选择“不适用”(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.



    该项目必须为潜在开发人员提供一种快速安装所有项目成果和支持环境所必需的环境,包括测试套件和测试环境。必须通过常规惯例执行。 [installation_development_quick]
    可以使用生成的容器和/或安装脚本来实现。外部依赖关系一般通过调用系统和/或语言包管理器(根据 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


  • 外部维护的组件


    项目必须以计算机可处理的方式列出外部依赖关系。 (需要网址) [external_dependencies]
    通常这是使用包管理器和/或构建系统的约定完成的。请注意,这有助于实施 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



    项目必须监视或定期检查其外部依赖(包括便利副本)以检测已知的漏洞,并修复可利用的漏洞或将其验证为不可利用的漏洞。 [dependency_monitoring]
    这可以使用源分析器/依赖项检查工具/软件组成分析工具(例如OWASP的Dependency-Check , Sonatype的Nexus Auditor , Synopsys的Black Duck软件组成分析和Bundler-audit(针对Ruby))来完成。一些程序包管理器包括执行此操作的机制。如果无法利用组件的漏洞,这是可以接受的,但是这种分析是困难的,有时简单地更新或修复零件就更容易。

    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).



    该项目必须满足下述情况之一:
    1. 可以轻松识别和更新重用的外部维护组件; 或
    2. 使用系统或编程语言提供的标准组件。
    这样,如果在重用的组件中发现了一个漏洞,将容易更新该组件。 [updateable_reused_components]
    符合这一条款的典型方法是使用系统和编程语言的包管理系统。许多FLOSS程序与“便利库”一起分发,这些库是标准库的本地副本(可能是分支)。一般没问题。但是,如果程序*必须*使用这些本地(分支)副本,则“标准”库的安全更新将使这些附加副本仍然易受攻击。这对于基于云的系统尤其是一个问题;如果云提供商更新他们的“标准”库,但程序不会使用它们,那么这些更新实际上不会有帮助。参见,例如,“Chromium:为什么它不在Fedora中作为适当的包”(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.



    该项目应避免使用已弃用或过时的功能和API,如果FLOSS替代品在其使用的技术集合(“技术堆栈”)中以及项目支持的大多数用户中可用(以便用户可以随时访问该替代品)。 [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_integration_testing]
    这个要求可以被视为test_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



    该项目必须为过去六个月内修复的至少50%的错误,在自动化测试套件中添加回归测试。 [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



    如果有至少一个FLOSS工具可以以所选语言度量此条款,该项目的FLOSS自动测试套件必须具有至少80%语句覆盖率。 [test_statement_coverage80]
    许多FLOSS工具可用于度量测试覆盖范围,包括gcov / lcov,Blanket.js,Istanbul和JCov。请注意,满足这个条款并不能保证测试套件是完备的,而不满足该条款则意味着测试套件很差。

    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


  • 新功能测试


    该项目必须具有正式的书面策略,一旦添加了主要的新功能,新功能的测试必须被添加到自动测试套件中。 [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



    该项目必须在其关于变更建议的书面指导中包括要为主要新功能添加测试的策略。 [tests_documented_added]
    但是,只要在实践中添加了测试,即使是非正式规则也是可以接受的。

    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


  • 警告标志


    在实际允许时,项目必须最大限度地严格修复项目生成的软件中的警告。 [warnings_strict]
    某些项目无法有效启用某些警告。需要证明的是,项目正在努力的启用警告标志,以便早期发现错误。

    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


 安全 13/13 ●

  • 安全开发知识


    该项目必须实施安全设计原则(来自“know_secure_design”)(如适用)。如果项目不生产软件,请选择“不适用”(N/A)。 [implement_secure_design]
    例如,项目结果应该具有故障安全默认值(默认情况下,访问决策应该拒绝,默认情况下项目的安装应该是安全的),也应该有完全的仲裁(每一个可能被限制的访问权限必须被检查,不可绕过)。请注意,在某些情况下,原则会发生冲突,在这种情况下必须做出选择(例如,许多机制使事情更复杂,违反“机制经济”/“保持最简化”的原则)。

    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


  • 使用基础的良好加密实践

    请注意,某些软件不需要使用加密机制。

    由项目产生的软件中的默认安全机制不得取决于具有已知严重弱点(例如,SHA-1密码散列算法或SSH中的CBC模式)的加密算法或模式。 [crypto_weaknesses]
    在 CERT:SSH CBC漏洞中讨论了SSH中CBC模式的问题。

    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.



    该项目应该支持多种加密算法,如果一个被破解,用户可以快速切换。普通的对称密钥算法包括AES,Twofish和Serpent。通用密码散列算法的选择包括SHA-2(包括SHA-224,SHA-256,SHA-384和SHA-512)和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.



    该项目必须支持在与其他信息(如配置文件,数据库和日志)分离的文件中存储身份验证凭据(如密码和动态令牌)以及私有加密密钥,并允许用户更新和替换它们,而无需重新编译代码。如果项目从不处理身份验证凭据和私有加密密钥,请选择“不适用”(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.



    该项目产生的软件应该支持所有网络通信的安全协议,如SSHv2或更高版本,TLS1.2或更高版本(HTTPS),IPsec,SFTP和SNMPv3。默认情况下,FTP,HTTP,Telnet,SSLv3或更早版本和SSHv1等不安全协议将被禁用,只有在用户专门配置时才启用。如果项目生成的软件不支持网络通信,请选择“不适用”(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.



    项目生成的软件(如果支持或使用TLS)应该至少支持TLS版本1.2。请注意,TLS的前身称为SSL。如果软件不使用TLS,请选择“不适用”(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.



    由项目生成的软件必须,如果它支持TLS,则在使用TLS(包括子资源)时默认执行TLS证书验证。如果软件不使用TLS,请选择“不适用”(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.



    项目生成的软件(如果支持TLS)必须在发送具有私有信息(如安全Cookie)的HTTP头之前执行证书验证。如果软件不使用TLS,请选择“不适用”(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.


  • 安全发布


    该项目必须加密签名旨在广泛使用的项目结果的发布,并且必须有一个书面流程,向用户解释如何获取公共签名密钥并验证签名。这些签名的私钥不得在项目网站上直接向公众发布。如果发行版本不适用于广泛使用,请选择“不适用”(N/A)。 [signed_releases]
    项目结果包括源代码和适用的任何生成的可交付成果(例如,可执行文件,包和容器)。生成的交付项可以单独签名源代码。可以用签名的git标签实现(使用加密数字签名)。项目可以从git类似的工具分别提供生成的结果,但在这些情况下,单独的结果必须单独签署。

    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



    建议在版本控制系统中,每个重要版本标签(作为主要版本的一部分的标签,次要版本或修复公开提到的漏洞)都按照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.


  • 其他安全问题


    项目结果必须检查来自潜在不受信任来源的所有输入,以确保它们有效( *白名单*),如果对数据有限制,则拒绝无效输入。 [input_validation]
    请注意,将输入与“不良格式”(*黑名单*)的列表进行比较通常是不够的,因为攻击者通常可以绕过黑名单。例如,数字被转换成内部格式,然后检查它们是否在最小和最大(包括)之间,并且检查文本字符串以确保它们是有效的文本模式(例如,有效的UTF-8,长度,语法等)。一些数据可能需要是“任何东西”(例如,文件上传器),但这些数据通常是罕见的。

    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]
    加固机制可能包括HTTP头,如内容安全策略(CSP),用于减轻攻击的编译器标志(如-fstack-protector)或用以消除未定义行为的编译器标志。对于此条款的目的,最小权限不被认为是一种加固机制(最少权限是重要的,但是另有条款)。

    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.



    该项目必须提供一个保证案例,证明其满足安全要求。保证案例必须包括:对威胁模型的描述,明确确定信任边界,确定设计原则得到适用,以及常见安全弱点已经被消减。 (需要网址) [assurance_case]
    一个保证案例是“一个文献记录的证据体系,提供了一个有说服力和有效的论据,指出一组关于系统属性的关键权利要求在给定环境中给定应用程序是充分合理的”(使用结构化保证案例模型的软件保证,Thomas Rhodes等人,NIST机构间报告7608)。信任边界是数据或执行改变其信任级别的边界,例如,典型Web应用程序中的服务器边界。常见做法是列出安全设计原则(例如Saltzer和Schroeer)和常见的实施安全漏洞(例如OWASP前10名或CWE / SANS前25名),并显示每个方案如何抵御。 BadgeApp保证案例可能是一个有用的例子。本条款与documentation_security,documentation_architecture和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


 分析 2/2 ●

  • 静态代码分析


    如果至少有一个FLOSS工具能够以所选择的语言实现此条款,则该项目必须至少使用一个具有规则或方式的静态分析工具来查找分析语言或环境中的常见漏洞。 [static_analysis_common_vulnerabilities]
    专门设计用于寻找常见漏洞的静态分析工具更有可能找到它们。也就是说,使用任何静态工具通常会帮助找到一些问题,所以我们“通过”级别的徽章建议,但不要求这个条款。

    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.


  • 动态代码分析


    如果由项目生成的软件包含使用内存不安全语言编写的软件(例如,C或C ++),则项目必须至少使用一个动态工具(例如,fuzzer或web应用扫描程序)与一种检测缓冲区覆写等内存安全问题的机制组合例行使用。如果项目不生成以内存不安全语言编写的软件,请选择“不适用”(N/A)。 [dynamic_analysis_unsafe]
    检测内存安全问题的机制的示例包括AddressSanitizer(ASAN)(可在GCC和LLVM中使用),“Memory Sanitizer”和 valgrind 。其他可能使用的工具包括ThreadSanitizer和UndefinedBehaviorSanitizer。广泛的断言也将起作用。

    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.



您可以使用工具和AI系统通过简单的URL提交变更建议,例如 https://www.bestpractices.dev/zh-CN/projects/13846/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced。请参阅我们的自动化提案系统,了解具体操作方法。 该数据可在社区数据许可协议 – 许可性,版本 2.0 (CDLA-Permissive-2.0)下获取。这意味着数据接收方可以共享数据,无论是否经过修改,只要数据接收方在共享数据时提供本协议文本。请注明Clement和OpenSSF最佳实践徽章贡献者。

项目徽章条目拥有者: Clement.
最后更新于 2026-07-27 22:31:30 UTC, 最后更新于 2026-08-03 17:49:03 UTC。 最后在 2026-08-02 23:50:36 UTC 获得通过徽章。