podtrace

本サイトが提示する下記のベストプラクティスを実行するプロジェクトは、Open Source Security Foundation (OpenSSF) バッジを達成したことを自主的に自己認証し、そのことを外部に示すことができます。

ソフトウェアに欠陥や脆弱性がないことを保証する手立てはありません。形式論的な証明ができたとしても、仕様や前提が間違っていると誤動作の可能性があります。また、プロジェクトが健全で、かつ機能的な開発コミュニティであり続けることを保証する手立てもありません。しかし、ベストプラクティスの採用は、プロジェクトの成果の向上に寄与する可能性があります。たとえば、いくつものベストプラクティスがリリース前の複数人によるレビューを定めていますが、それによりレビュー以外では発見困難な技術的脆弱性を見つけるのを助け、同時に異なる企業の開発者間の信頼を築き、さらに交流を続けることに対する意欲を生んでいます。バッジを獲得するには、すべてのMUSTおよびMUST NOT基準を満たさなければなりません。すべてのSHOULD基準も満たさなければなりませんが、正当な理由がある場合は満たさなくても構いません。そしてすべてのSUGGESTED基準も満たさなければなりませんが、満たさないとしても、少なくとも考慮することが望まれます。フィードバックは、 GitHubサイトのissueまたはpull requestとして提示されれば歓迎します。また、議論のためのメールリストも用意されています。

私たちは多言語で情報を提供していますが、翻訳版に矛盾や意味の不一致がある場合は、英語版を正式な記述とします。
これがあなたのプロジェクトなら、あなたのプロジェクトページにあなたのバッジステータスを表示してください!バッジステータスは次のようになります。 プロジェクト 12882 のバッジ レベルは passing です バッジステータスの埋め込み方法は次のとおりです。
バッジステータスを表示するには、あなたのプロジェクトのマークダウンファイルに以下を埋め込みます
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/12882/badge)](https://www.bestpractices.dev/projects/12882)
あるいは、以下をHTMLに埋め込みます
<a href="https://www.bestpractices.dev/projects/12882"><img src="https://www.bestpractices.dev/projects/12882/badge"></a>


これらはシルバーレベルの基準です。合格またはゴールドレベル基準を表示することもできます。

Baseline Series: ベースラインレベル1 ベースラインレベル2 ベースラインレベル3

        

 基本的情報 15/17

  • 一般

    他のプロジェクトが同じ名前を使用していないか注意してください。

    eBPF-driven diagnostic tool for Kubernetes applications 🐝

    SPDXライセンスの表現形式を使用してください。 例:「Apache-2.0」、「BSD-2-Clause」、「BSD-3-Clause」、「GPL-2.0+」、「LGPL-3.0+」、「MIT」、「(BSD-2-Clause OR Ruby)」。一重引用符または二重引用符を含めないでください。
    複数の言語がある場合は、コンマを区切り(スペースを入れてもよい)としてリストし、使用頻度の高いものから順に並べます。使用言語が多くある場合は、少なくとも最初の3つの最も多く使われるものをリストアップしてください。言語がない場合(例:ドキュメントだけ、またはテスト専用のプロジェクトの場合)、1文字 " - "を使用します。言語ごとにある大文字・小文字の慣用を踏襲してください(例:「JavaScript」)。
    Common Platform Enumeration(CPE)は、情報技術(IT)システム、ソフトウェア、およびパッケージのための構造化された命名体系です。脆弱性を報告する際に、多くのシステムやデータベースで使用されています。
  • 前提要件


    プロジェクトは合格レベルバッジに達成しなければなりません。 [achieve_passing]

  • 基本的なプロジェクト ウェブサイトのコンテンツ


    貢献する方法に関する情報には、受け入れ可能な貢献の要件(例えば、必要なコーディング標準への言及)が含まれなければなりません。 (URLが必要です) [contribution_requirements]
  • プロジェクトの管理・運営


    プロジェクトは、プロジェクト ソフトウェアのそれなりの量を開発しているすべての開発者が、これらの貢献を行うことが法的に認められていると主張すりょうな法的な仕組みを持っていなければなりません。これを行うための最も一般的で簡単に実装されたアプローチは、開発者証明書(DCO)を使用することです。ユーザーは、 DCOのウェブサイトへのプロジェクトのリンクが表示されます。ただし、これはコントリビュータ ライセンス契約(CLA)またはその他の法的な仕組みとして実装することができます。 (URLが必要です) [dco]
    DCOは、実装が容易で、ソースコードで追跡され、gitが "commit -s"を使用して "サインオフ"機能を直接サポートするため、推奨されるメカニズムです。最も効果的であるためには、プロジェクト文書が、そのプロジェクトに対して「サインオフ」とは何を意味するのかを説明するのが最善です。 CLAは、知的著作物が組織またはプロジェクトにライセンスされている条件を定義する法的合意です。コントリビュータ アサイン アグリーメント(CAA)は、知的著作物の権利を他の当事者に移転する法的合意です。プロジェクトはCAAを必ずしも持つ必要はありません。なぜなら、CAAは、特に受領者が営利目的の組織である場合には、潜在的な貢献者が貢献しないリスクを高めます。 Apache Software Foundation CLA(個々のコントリビュータ ライセンスと法人CLA)は、この種のCLAのリスクを判断するプロジェクトにとって、リスクが便益よりも小さいのCLAの例です。

    Podtrace uses the Developer Certificate of Origin (DCO), not a CLA or CAA.

    Policy and explanation: https://github.com/gma1k/podtrace/blob/main/CONTRIBUTING.md#developer-certificate-of-origin
    The section links to https://developercertificate.org/ and states what signing off means for this project: the contributor asserts they wrote the code or have the right to submit it under Apache-2.0, that they have employer permission where the employer owns the copyright, and that the name and email in the trailer are public and permanent. Contributors add the trailer with git commit -s.

    Enforcement: https://github.com/gma1k/podtrace/blob/main/.github/workflows/dco.yml
    The workflow runs on every pull request and verifies that each commit in the PR carries a Signed-off-by: trailer whose email matches the commit author's email. Missing sign-offs fail the check and block the merge. Machine-generated commits from bot accounts (renovate, dependabot, github-actions) are exempt, since a bot cannot make the DCO assertion.

    Contributors are also reminded in the pull request template: https://github.com/gma1k/podtrace/blob/main/.github/PULL_REQUEST_TEMPLATE.md



    プロジェクトは、プロジェクト ガバナンス モデル(主要な役割を含む意思決定方法)を明確に定義し、文書化しなければなりません。 (URLが必要です) [governance]
    決定を下し、論争を解決するための十分に確立された文書化された方法が必要です。小規模なプロジェクトでは、これは「プロジェクトオーナーとリーダーがすべての最終決定を下す」という単純なものです。慈愛の強い独裁者や正式な能力主義を含む様々な統治モデルが存在します。詳細については、統治モデルを参照してください。集中化された(例えば、単一メインテナー)および分散された(例えば、グループ メインテナー)アプローチの両方が、プロジェクトにおいて成功のうちに使用されています。統治情報は、プロジェクトフォークを作成する可能性について文書化する必要はありません。なぜなら、これはFLOSSプロジェクトでは常に可能であるからです。

    Podtrace documents a maintainer-led governance model in GOVERNANCE.md:
    https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md

    Roles: the document defines Contributors (anyone opening an issue, answering in Discussions, improving docs, or sending a PR; no formal status required or conferred) and Maintainers (hold merge rights). Maintainers are named in https://github.com/gma1k/podtrace/blob/main/MAINTAINERS.md and their per-path review authority is encoded in https://github.com/gma1k/podtrace/blob/main/CODEOWNERS, which GitHub enforces as required approvals.

    Decision-making: decisions are made in the open on the pull request or issue that proposes them, with the bar scaled to how hard the change is to reverse. Bug fixes, docs, tests, and dependency bumps need a PR with CODEOWNERS approval. New features, probes, and adapters need a feature request or epic issue first so the shape is agreed before code is written. Changes to the public surface (CRDs, CLI flags, Helm values, env vars) additionally require an explicit read of STABILITY.md, with breaking changes marked in the commit subject and accompanied by a migration note. Security fixes are handled privately under SECURITY.md until an advisory ships.

    Dispute resolution: disagreements are resolved by discussion on the thread. Where consensus is not reached, maintainers decide, and are required to state their reasoning in the thread rather than merging silently.

    Role changes: maintainership follows demonstrated work (a track record of merged non-trivial contributions, reviews that catch real problems, and sustained engagement) and is extended by invitation from existing maintainers. Maintainers who step back are recorded as emeritus rather than removed. Governance changes themselves go through the same PR process as code, proposed as their own PR.

    Related: code of conduct and its enforcement path at https://github.com/gma1k/podtrace/blob/main/CODE_OF_CONDUCT.md, and support and communication channels at https://github.com/gma1k/podtrace/blob/main/SUPPORT.md



    プロジェクトは、行動規範を採択し、標準的な場所に掲示しなければなりません。 (URLが必要です) [code_of_conduct]
    プロジェクトは、地域社会の礼儀正しさを向上させることと、行動規範を採択することで受け入れられる行動についての期待を設定すること、ができるかもしれません。これにより、問題が発生する前に問題を回避し、プロジェクトをより貢献を促す場所にすることができます。これは、プロジェクトのコミュニティ内や職場内の行動にのみ焦点を当てるべきです。行動規範の例としては、以下のようなものがあります。Linuxカーネル行動規範コントリビューター規約行動規範Debian行動規範Ubuntu行動規範Fedora行動規範GNOME行動規範KDEコミュニティ行動規範Pythonコミュニティ行動規範Rubyコミュニティ行動指針、およびRust 行動規範

    Podtrace has adopted the Contributor Covenant, version 2.1, as its code of conduct, posted at the standard repository-root location:
    https://github.com/gma1k/podtrace/blob/main/CODE_OF_CONDUCT.md

    Because the file is CODE_OF_CONDUCT.md at the root, GitHub detects it automatically and surfaces it in the repository's Community Standards profile and in the contributor-facing prompts on issues and pull requests. The canonical upstream text is linked at https://www.contributor-covenant.org/version/2/1/code_of_conduct/

    Scope: the code of conduct applies to all project-managed spaces (issue tracker, pull requests, discussions, and official off-platform communication) and to individuals officially representing the project in public. It addresses behavior within the project community only.

    Reporting: concerns are reported privately to the maintainer. All reports are reviewed and investigated promptly and fairly, and the maintainer is obligated to respect the privacy and security of the reporter.

    Enforcement: the project applies the Contributor Covenant Enforcement Guidelines (https://www.contributor-covenant.org/version/2/1/code_of_conduct/#enforcement-guidelines), with four escalating levels: correction, warning, temporary ban, and permanent ban. Enforcement authority rests with the maintainer listed in https://github.com/gma1k/podtrace/blob/main/MAINTAINERS.md, consistent with the maintainer-led model documented in https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md



    プロジェクトは、プロジェクトでの重要な役割と役割が実行しなければならないタスクを含む責任を明確に定義し、公的に文書化しなければなりません。誰がどの役割を持っているかは明確でなければなりませんが、これは同じ方法で文書化されていない可能性があります。 (URLが必要です) [roles_responsibilities]
    統治と役割と責任に関する文章は1か所にあるのが良いでしょう。

    Podtrace documents its roles and their responsibilities across two linked files, plus a machine-enforced ownership map.

    Roles are defined in https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md#roles
    Contributors are anyone who opens an issue, answers a question in Discussions, improves docs, or sends a pull request; no formal status is required and none is conferred. Maintainers hold merge rights.

    Maintainer responsibilities and required tasks are listed in https://github.com/gma1k/podtrace/blob/main/MAINTAINERS.md#what-maintainers-do
    Maintainers: (1) review and merge pull requests and are the required approvers under CODEOWNERS; (2) triage incoming issues, apply area and type labels, and close duplicates; (3) cut releases following the release flow in CONTRIBUTING.md; (4) handle private vulnerability reports under SECURITY.md; (5) decide what lands in the public surface governed by STABILITY.md.

    Several of these tasks carry documented, measurable commitments. SECURITY.md (https://github.com/gma1k/podtrace/blob/main/SECURITY.md) binds vulnerability handling to acknowledgement within 3 business days, triage and confirmation within 7 business days, and a default 90-day coordinated disclosure window. CODE_OF_CONDUCT.md (https://github.com/gma1k/podtrace/blob/main/CODE_OF_CONDUCT.md) assigns code-of-conduct enforcement to the maintainer under the Contributor Covenant Enforcement Guidelines.

    Contributor-side responsibilities are documented in https://github.com/gma1k/podtrace/blob/main/CONTRIBUTING.md, covering DCO sign-off, Conventional Commit format, the required test plan, and regeneration of manifests and clientsets when API types change.

    Who holds which role: MAINTAINERS.md names the current maintainer (Ghassan Malke, GitHub @gma1k) with contact details and areas of ownership. Per-path review authority is encoded in https://github.com/gma1k/podtrace/blob/main/CODEOWNERS, which GitHub enforces as required approval, making the role assignment machine-checkable rather than only asserted in prose. MAINTAINERS.md requires that the maintainer list, CODEOWNERS, and the repository's collaborator settings be updated together, so the documented roster cannot silently diverge from the enforced one.

    Role changes: https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md#becoming-a-maintainer describes how maintainership is earned (a track record of merged non-trivial contributions, reviews that catch real problems, demonstrated compatibility judgment, and sustained engagement), with invitations extended by existing maintainers. Maintainers who step back are recorded as emeritus rather than removed.



    いずれかの人が仕事を継続できなくなるまたは死亡した場合、プロジェクトは最小限の中断で継続することができなければなりません。特に、プロジェクトは、課題の作成と終了、提案された変更の受け入れ、およびバージョンのソフトウェアのリリース、1週間内に個人が仕事を継続できくなったことまたは死亡したことの確認、行うことができなければならない。これは、他の誰かがプロジェクトを継続するのに必要な鍵、パスワード、法的権利を持っていることを保証することによって行うことができます。 FLOSSプロジェクトを実行する個人は、ロックボックスにキーを提供し、必要な法的権利を提供する意志(例えば、DNS名のために)を提供することによって、これを行うことができます。 (URLが必要です) [access_continuity]

    Podtrace currently has one maintainer, which the project states openly in its roadmap rather than leaving implicit. Continuity is addressed through a documented succession arrangement:
    https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md#continuity

    Credentials: the maintainer's GitHub account credentials, including two-factor recovery codes, are held by a designated successor through emergency access on the project's credential manager. GitHub account access transitively covers everything required to continue the project: the repository, its issue tracker, branch protection settings, the ghcr.io/gma1k container and chart registry namespaces, and repository secrets. The successor can therefore create and close issues, approve and merge pull requests, and publish a release well within one week of confirmed loss of support.

    Signing keys: podtrace holds no private signing keys, so there is no key material that can be lost with an individual. All artifacts are signed with cosign keyless via GitHub OIDC, with signing events recorded in the public Sigstore Rekor transparency log (see https://github.com/gma1k/podtrace/blob/main/.github/workflows/release.yml). Any successor with repository write access produces signatures that verify identically to those issued today.

    Release process: releases are fully automated via release-please and GitHub Actions using the workflow's built-in GITHUB_TOKEN, and are documented at https://github.com/gma1k/podtrace/blob/main/CONTRIBUTING.md. No personal credentials or undocumented local tooling are required to cut a release. The one external token, used for OperatorHub publication, is [held by the successor / reissuable by the successor following the steps documented in the continuity section].

    Legal rights and domain names: podtrace uses no custom domain. The podtrace.io string appears solely as a Kubernetes annotation namespace and requires no DNS registration, so no domain transfer or testamentary instrument is required. The project is licensed Apache-2.0 (with GPL-2.0 for the eBPF programs under bpf/) and holds no trademark or infrastructure assets requiring transfer.

    Fork rights: as a FLOSS project under Apache-2.0, the full history and build tooling are public, so continuation by fork is available to the community independent of any individual.



    プロジェクトは2以上の "バス ファクタ"を持っているべきです。 (URLが必要です) [bus_factor]
    「バス ファクタ」(別名「トラック ファクタ」)は、知見があり有能な人材が離脱して、プロジェクトが停止に至る時に、プロジェクトから突然消失する(「バスに当たった」)プロジェクトメンバーの最小人数です。 トラック ファクタツールは、GitHub上のプロジェクトに対してこれを見積もることができます。詳細については、Cosentino et al。の Gitリポジトリのバス ファクタの評価を参照してください。

    Podtrace does not currently meet this criterion. The project has a bus factor of 1.

    Measurement: of 311 human-authored commits (excluding renovate and dependabot), 307 are from the sole maintainer. The remaining four are one-off contributions from four separate individuals, none of whom has sustained involvement. Under the truck-factor methodology of Cosentino et al., removing the single maintainer orphans effectively the entire codebase.

    The project states this openly rather than leaving it implicit. https://github.com/gma1k/podtrace/blob/main/ROADMAP.md names project sustainability as roadmap item 10: "Podtrace has one maintainer. That is the single largest risk to anyone adopting it, more than any individual feature, and it is worth naming plainly rather than leaving implicit. A second maintainer with real review authority is the goal."

    Mitigations in place, aimed at the criterion's concern that a project stalls for lack of knowledgeable personnel:

    Knowledge is externalized rather than tacit. The repository carries 37 reference documents at https://github.com/gma1k/podtrace/tree/main/docs, covering system architecture, eBPF internals, the event schema, the development workflow, kernel and Kubernetes compatibility constraints, and end-to-end verification procedure. The kernel-version and BTF pitfalls that would otherwise exist only as maintainer expertise are documented.

    Intended behavior is captured executably. The tree contains 525 Go test files against 313 non-test source files, plus 22 chainsaw end-to-end scenarios that exercise the operator and agent against a real cluster. A successor can verify correctness without reconstructing intent.

    The release process requires no individual. Releases are automated end to end via release-please and GitHub Actions, with keyless cosign signing through GitHub OIDC, so no private key or undocumented local tooling is involved. The process is documented at https://github.com/gma1k/podtrace/blob/main/CONTRIBUTING.md

    A documented path to a second maintainer exists at https://github.com/gma1k/podtrace/blob/main/GOVERNANCE.md#becoming-a-maintainer, with criteria based on demonstrated contribution and review quality, and per-path review authority tracked in https://github.com/gma1k/podtrace/blob/main/CODEOWNERS

    As an Apache-2.0 project with full public history and reproducible build tooling, continuation by fork is available to the community independent of any individual.

    Raising the bus factor to 2 is an active goal, tracked as roadmap.


  • ドキュメンテーション


    プロジェクトは、少なくとも翌年に、プロジェクトが何をしたいか、やるつもりはないかを記述した文書化されたロードマップを持っていなければなりません。 (URLが必要です) [documentation_roadmap]
    このプロジェクトはロードマップを達成できないかもしれません。それは問題ありません。ロードマップの目的は、潜在的なユーザーや貢献者がプロジェクトの意図された方向を理解するのを助けることです。詳細にする必要はありません。

    Podtrace maintains a roadmap covering both intended work and explicit non-goals:
    https://github.com/gma1k/podtrace/blob/main/ROADMAP.md

    What the project intends to do: the roadmap lists ten items grouped into Now, Next, and Later horizons. Near-term work covers reconciling the documented CRD inventory, publishing a per-CRD v1beta1 readiness assessment, and completing the supply-chain baseline with SLSA provenance and an OpenSSF Security Insights manifest. Medium-term work covers defining a formal API deprecation policy, graduating individual CRDs from v1alpha1 to v1beta1, resolving whether to ship conversion webhooks, and making the importable Go API usable externally through runnable godoc examples. Longer-term work covers reaching v1.0.0 against the gates defined in https://github.com/gma1k/podtrace/blob/main/STABILITY.md, stating platform support in CI-verified versus best-effort tiers, and recruiting a second maintainer.

    What the project intends not to do: the roadmap includes an explicit Non-goals section. Podtrace will not become a non-Linux agent, because its tracing core is eBPF and therefore Linux-kernel bound by construction. It will not become a policy engine, admission controller, or service mesh, because it observes workloads rather than admitting, mutating, or routing them. It will not implement agent self-update, so that agent version remains whatever the operator deploys and upgrades stay under the cluster owner's control. Non-goals are open to challenge through project Discussions.

    Time horizon: the roadmap deliberately records themes and rough ordering rather than dates or quarters, on the stated reasoning that a roadmap with slipped quarters is worse than no roadmap. The scope covers well beyond one year: v1.0.0 is described as downstream of every other item and "not near," and the intervening work (per-CRD API graduation, a deprecation policy, a conversion story, supply-chain attestation, and tiered platform support) represents multi-year effort at the project's current capacity. Version-gating rules are kept separately in STABILITY.md so the roadmap states direction while STABILITY.md states commitments.

    The roadmap is kept current: its status table reflects the shipped v0.14.x line and the 22 end-to-end chainsaw suites present in the repository. It is linked from the project README and cross-referenced from GOVERNANCE.md and CONTRIBUTING.md.



    プロジェクトは、プロジェクトによって作成されたソフトウェアのアーキテクチャー(いわゆる高水準設計)の文書を含まなければなりません。プロジェクトでソフトウェアが作成されない場合は、「該当なし」(N/A)を選択します。 (URLが必要です) [documentation_architecture]
    ソフトウェア アーキテクチャは、プログラムの基本的な構造、すなわちプログラムの主な構成要素、それらの間の関係、およびこれらの構成要素および関係の主要な特性を説明します。

    Podtrace documents its high-level design across a set of indexed architecture documents, entry point at https://github.com/gma1k/podtrace/blob/main/docs/README.md

    Primary architecture document: https://github.com/gma1k/podtrace/blob/main/docs/architecture.md
    Describes the system's major components and how they relate: eBPF programs running in the kernel (kprobes, uprobes, and tracepoints), a shared ring-buffer map carrying events across the kernel/userspace boundary, and a Go userspace layer comprising the tracer lifecycle manager, the object loader, the probe attachment layer, the event parser, and the cgroup filter that scopes events to a target pod. It documents the end-to-end data flow from kernel event through ring buffer, cgroup filtering, and enrichment, to the output surfaces (live CLI diagnostics, Prometheus metrics, and trace exporters).

    Podtrace runs in three modes, each documented:

    CLI: https://github.com/gma1k/podtrace/blob/main/docs/cli-architecture.md explains the node-spawn model. The CLI does not load eBPF on the invoking workstation; it identifies the node hosting each target pod and runs a short-lived privileged pod on that node, so the kernel loading eBPF is the same kernel running the target workload. The document states the structural reason: eBPF executes in the kernel where it is loaded, so a workstation kernel has no visibility into a remote node's processes or cgroups.

    Operator and agent: https://github.com/gma1k/podtrace/blob/main/docs/operator.md documents the control plane. An operator Deployment runs three reconcilers, each owning one CRD. TracerConfigReconciler manages cluster-wide infrastructure including the agent ServiceAccount, RBAC, and the agent DaemonSet. PodTraceReconciler handles continuous tracing and aggregates per-node status. PodTraceSessionReconciler handles bounded diagnose sessions by spawning per-node Jobs. The agent DaemonSet runs one pod per node and performs the actual kernel-level tracing.

    Per-session Jobs: documented in https://github.com/gma1k/podtrace/blob/main/docs/crd-podtracesession.md, including the per-session Role and RoleBinding the operator generates to scope report writes.

    Kernel-side design detail is in https://github.com/gma1k/podtrace/blob/main/docs/ebpf-internals.md and the binary wire format crossing the kernel/userspace boundary is specified in https://github.com/gma1k/podtrace/blob/main/docs/event-schema.md

    Key architectural properties are documented alongside the structure: the privilege model for each component (unprivileged operator, agent with CAP_BPF and CAP_PERFMON, session Jobs inheriting the agent's capability set) in https://github.com/gma1k/podtrace/blob/main/SECURITY.md; cgroup-based event isolation to the target pod; and cross-namespace consent gating enforced at both reconcile and admission, in https://github.com/gma1k/podtrace/blob/main/docs/cross-namespace-cr-targeting.md

    Supported kernel, Kubernetes, and architecture matrices are in https://github.com/gma1k/podtrace/blob/main/docs/compatibility.md



    プロジェクトは、ユーザーが、プロジェクトによって作成されたソフトウェアからセキュリティの観点から期待できるものと期待できないものを文書化しなければなりません。(セキュリティ要件) (URLが必要です) [documentation_security]
    これらは、ソフトウェアが満たすことが意図されているセキュリティ要件です。

    Podtrace documents its security requirements, including both the guarantees it provides and the limits it explicitly does not cover, primarily in:
    https://github.com/gma1k/podtrace/blob/main/SECURITY.md

    What users can expect. The security model section states the privilege posture and blast radius of each component. The operator runs unprivileged (distroless nonroot, no host mounts); a compromised operator can only manipulate CRDs in its own namespace and cannot escalate to host privileges directly. The agent DaemonSet runs with CAP_BPF, CAP_PERFMON, and hostPID on each node, and the documentation states plainly that a compromised agent is roughly equivalent to a compromised privileged workload on that node. Per-session Jobs inherit the agent's capability set and are confined to the same single-node blast radius.

    Tenant isolation is the central guarantee, because podtrace observes decrypted application-layer traffic. Cross-namespace tracing is consent-gated: a namespaced custom resource may target pods in a foreign namespace only when that namespace opts in via the podtrace.io/allow-tracing-from annotation. This is enforced by the operator at every reconcile, which is authoritative, and by a validating webhook at admission for fast feedback. Without the grant, a custom resource is confined to its own namespace and cannot capture another tenant's decrypted L7 traffic, DNS queries, syscalls, or file paths. Full semantics are documented at https://github.com/gma1k/podtrace/blob/main/docs/cross-namespace-cr-targeting.md

    Supply-chain guarantees: all published artifacts (container image, Helm chart, release tarballs) are signed with cosign keyless via GitHub OIDC, with signing events recorded in the public Sigstore Rekor transparency log. Verification commands are documented at https://github.com/gma1k/podtrace/blob/main/docs/installation.md

    What users cannot expect. SECURITY.md contains an explicit out-of-scope section. Issues in upstream Kubernetes, the host kernel's BPF verifier, and third-party exporters are not in scope. Attacks that presuppose an adversary already holding cluster-admin privileges are stated to be outside the threat model. Denial of service through excessive trace events on the agent's ring buffer is a user-side concern, with the bounding controls named (samplePercent and thresholds). Development-only paths are excluded.

    Feature-level limits are documented the same way. https://github.com/gma1k/podtrace/blob/main/docs/crypto-detection.md states that AF_ALG crypto-socket detection is observation rather than enforcement: it surfaces use of the vulnerable interface, but does not block the syscall, does not detect exploitation, and is not a substitute for patching. It is also off by default.

    Security-relevant defaults are documented at https://github.com/gma1k/podtrace/blob/main/docs/configuration.md, including that PII redaction (PODTRACE_REDACT_PII) and DNS-name stripping (PODTRACE_REDACT_DNS_NAMES) are disabled by default, and that plaintext export to non-loopback hosts is disabled by default and must be explicitly enabled.

    Hardening guidance for deployments where attacker capability is a concern, covering image digest pinning, RBAC restriction of custom-resource creation, narrow granting of the cross-namespace annotation, and per-node session capacity caps, is in the hardening section of SECURITY.md, with per-distribution notes (SELinux, AppArmor, Pod Security Standards) in the platform guides under https://github.com/gma1k/podtrace/tree/main/docs

    Supported versions and the backport window are stated at the top of SECURITY.md.



    プロジェクトでは、新規ユーザーがソフトウェアで何かをすばやく実行できるようにするための「クイックスタート」ガイドを提供する必要があります。 (URLが必要です) [documentation_quick_start]
    このアイデアは、ユーザーにソフトウェアを始動させる方法と何かをさせる方法を示すことです。これは潜在的なユーザーが開始するために非常に重要です。

    kubectl apply -f https://github.com/gma1k/podtrace/releases/latest/download/quickstart.yaml
    kubectl apply -f https://github.com/gma1k/podtrace/releases/latest/download/quickstart-demo.yaml

    podtrace -n production my-pod # realtime trace
    podtrace -n production my-pod --diagnose 30s --export json # bounded diagnose with a JSON report

    Prerequisites (kernel 5.8 or later, BTF availability, Kubernetes 1.28 or later) are stated in the installation guide and detailed at https://github.com/gma1k/podtrace/blob/main/docs/compatibility.md, with the full CLI reference at https://github.com/gma1k/podtrace/blob/main/docs/usage.md and a documentation index at https://github.com/gma1k/podtrace/blob/main/docs/README.md



    プロジェクトは、現行バージョンのプロジェクト結果(プロジェクトによって作成されたソフトウェアを含む)とドキュメントの整合性を保つために努力しなければならない。 不一致を招く既知のドキュメントの欠陥は、修正しなければなりません。ドキュメントが一般的に最新のものですが、古い情報が誤って含まれて、もはや正しくない場合は、それを欠陥として扱い、通常どおりに追跡して修正してください。 [documentation_current]
    ドキュメントには、ソフトウェアのバージョン間の相違点や変更点、および/またはドキュメントの古いバージョンへのリンクに関する情報が含まれていてもよいです。この基準の意図は、ドキュメントが完璧である必要があることではなく、ドキュメントの一貫性を保つための努力がなされていることです。

    Podtrace treats documentation currency as part of the change process rather than as periodic cleanup.

    Process: the pull request template at https://github.com/gma1k/podtrace/blob/main/.github/PULL_REQUEST_TEMPLATE.md requires contributors to confirm that user-facing changes are accompanied by updates under docs/, and that generated manifests and clientsets are regenerated and committed when API types change. CODEOWNERS routes documentation changes for review alongside code.

    Evidence of currency: the configuration reference at https://github.com/gma1k/podtrace/blob/main/docs/configuration.md documents every user-facing environment variable the codebase reads. A diff of documented variables against those referenced in source shows no undocumented user-facing options; the only variables absent from the documentation are internal test fixtures. The roadmap at https://github.com/gma1k/podtrace/blob/main/ROADMAP.md reflects the currently shipped release line and the actual count of end-to-end test suites in the repository. The changelog at https://github.com/gma1k/podtrace/blob/main/CHANGELOG.md is generated automatically from Conventional Commits by release-please on every release, so version history cannot drift from what shipped.

    Version differences: https://github.com/gma1k/podtrace/blob/main/STABILITY.md documents what each version line promises, the rules governing when custom resource definitions may change incompatibly, and the graduation gates from v1alpha1 to v1beta1 and from v0.x to v1.0.0. https://github.com/gma1k/podtrace/blob/main/docs/migration.md provides a translation table for users moving between the CLI and custom-resource workflows.

    Defect handling: documentation defects are tracked and fixed like code defects. Recent examples: [link the issues you open] corrected an undercount of the custom resource definition inventory in STABILITY.md, corrected the quickstart command sequence in the README to apply both released manifests in the required order, and updated docs/architecture.md to cover all three deployment modes (CLI node-spawn, operator with agent DaemonSet, and per-session Jobs) and to align its stated capability requirements with SECURITY.md. Known documentation inconsistencies identified during review of the OpenSSF Best Practices criteria have been resolved.

    The documentation set is indexed at https://github.com/gma1k/podtrace/blob/main/docs/README.md and spans 37 reference documents covering architecture, installation, per-CRD field references, eBPF internals, the event wire format, compatibility matrices, and per-platform guides.



    プロジェクトのリポジトリのフロントページおよび/またはウェブサイトは、このベストプラクティスのバッジを含め、成果が達成されたことを一般に認められてから48時間以内に特定し、ハイパーリンクする必要があります。 (URLが必要です) [documentation_achievements]
    達成とは、いくつかのバッジを含めて、プロジェクトが具体的に満たしている外部基準のセットです。この情報は、プロジェクトのウェブサイトのフロントページにある必要はありません。 GitHubを使用するプロジェクトは、READMEファイルに追加することで、リポジトリのフロントページに成果を置くことができます。

    The podtrace repository front page identifies and hyperlinks its achievements in a badge block at the top of the README, above the project description:
    https://github.com/gma1k/podtrace#readme

    The OpenSSF Best Practices badge is displayed and hyperlinked to the project's badge entry at https://www.bestpractices.dev/projects/12882

    The badge is embedded using the dynamic badge image endpoint (https://www.bestpractices.dev/projects/12882/badge) rather than a static image. BadgeApp serves that endpoint with the project's current attainment level, so any change in badge level is reflected on the repository front page immediately and automatically, with no commit required. The 48-hour requirement is therefore satisfied structurally: the displayed badge cannot become stale relative to the recognition it represents.

    Other achievements identified and hyperlinked in the same badge block:

    OpenSSF Scorecard, linked to the project's live Scorecard report at https://scorecard.dev/viewer/?uri=github.com/gma1k/podtrace, also served as a dynamic badge reflecting the current score.
    Artifact Hub, linked to the published Helm repository listing at https://artifacthub.io/packages/helm/podtrace/podtrace
    eBPF Landscape, linked to the ebpf.io applications listing at https://ebpf.io/applications/
    FOSSA license compliance and security status, linked to the project's FOSSA reports.
    RepoGrade, linked to https://www.repo-grade.com/report/gma1k/podtrace
    Go Reference (pkg.go.dev), release version, CI build status, test results, and test coverage.
    Two further external acceptances are identified and hyperlinked in the README body, each of which required passing a third-party review process for inclusion: the OperatorHub.io community operator catalog (https://operatorhub.io/operator/podtrace) and the Kubernetes krew plugin index (https://krew.sigs.k8s.io/), through which podtrace is installable as kubectl krew install podtrace.


  • アクセシビリティと国際化


    プロジェクト(プロジェクト サイトとプロジェクト結果の両方)は、アクセシビリティのベストプラクティスに従い、障害のある人が引き続きプロジェクトに参加し、プロジェクトの結果を合理的な範囲で使用することができるようにするべきです。 [accessibility_best_practices]
    ウェブアプリケーションについては、ウェブ コンテンツ アクセシビリティ ガイドライン(WCAG 2.0)とそのサポート ドキュメント WCAG 2.0の理解; W3Cアクセシビリティ情報を参照してください。 GUIアプリケーションの場合は、環境固有のアクセシビリティ ガイドラインの使用を検討して下さい(GnomeKDEXFCE Android bility/ios/" > iOS Mac Windows )。いくつかのTUIアプリケーション(例えば、「ncurses」プログラム)は、「alpine」の 「force-arrow-cursor」設定のような、よりアクセスしやすくするためにいくつかのことを行うことができます。ほとんどのコマンドライン アプリケーションは、そのままの状態でかなりアクセス可能です。この基準は、例えば、プログラム ライブラリの場合、「該当なし」(N/A)であることが多いです。取り上げるべき行動や考慮すべき課題の例を以下に示します。
    • テキスト以外のコンテンツの代替テキストを提供するkotode, 人々が必要とする他の形式に変更することができます。大きな印刷物、点字、スピーチ、記号またはより単純な言語などです。( WCAG 2.0ガイドライン1.1
    • アクションを示したり、応答を促したり、または視覚的要素を区別するために、色が唯一の視覚的な伝達手段として使用されるわけではありません。( WCAG 2.0ガイドライン1.4.1
    • 大文字、付随的なテキストとロゴタイプを除いて、テキストの視覚的提示とテキストのイメージには、少なくとも4.5:1の比率のコントラストがあります( WCAG 2.0ガイドライン1.4.3
    • キーボードからすべての機能を利用できるようにする(WCAGガイドライン2.1)
    • GUIまたはウェブ ベースのプロジェクトは少なくとも1つターゲットプラットフォーム上のスクリーンリーダーでテストするべきです(例えば、NVDA、Jaws、またはWindows上のWindowEyes; MacとiOSのVoiceOver Linux / BSDのOrca;AndroidのTalkBack)。 TUIプログラムは、スクリーンリーダーによる冗長な読み取りを防止するために、オーバードローを減らせるかもしれません。

    Podtrace produces a command-line tool and a Kubernetes operator. It has no graphical or web user interface of its own, so the criterion applies chiefly to terminal output and to project documentation.

    Color is never the sole means of conveying information (WCAG 2.0 guideline 1.4.1). Podtrace's CLI emits no color at all: the codebase includes no terminal-color dependency and no ANSI color escape sequences in any output path. All diagnostic information is conveyed through text and document structure, so output remains fully intelligible when piped, redirected to a file, or read by a screen reader. Text contrast (guideline 1.4.3) is governed entirely by the user's own terminal configuration.

    Text alternatives are provided for non-text content (guideline 1.1). Every image on the repository front page, including the project logo and all status badges, carries a descriptive alt attribute: https://github.com/gma1k/podtrace#readme. All documentation is authored in Markdown, which renders as semantic HTML and degrades cleanly to plain text.

    All functionality is available from a keyboard (guideline 2.1). The CLI requires no pointer input, and the operator interface is declarative YAML applied with kubectl, so every capability is keyboard-driven and scriptable.

    Terminal output integrity: podtrace displays data captured from traced application traffic, which is untrusted input. The project strips ANSI escape sequences from captured payloads before display, with test coverage for both color and cursor-movement injection. This prevents captured data from corrupting terminal state or disrupting assistive-technology output.

    Screen-reader considerations: the optional real-time display refreshes by redrawing the report every five seconds, which produces overdraw. The project documents alternative output modes that avoid this entirely and provide identical information: bounded diagnose mode (--diagnose), structured JSON export (--export json), and the PodTraceSession custom resource, which writes its report to a Kubernetes ConfigMap or to object storage. These are documented at https://github.com/gma1k/podtrace/blob/main/docs/usage.md and https://github.com/gma1k/podtrace/blob/main/docs/viewing-events.md, so no capability is available only through the refreshing display.

    The project ships an optional Grafana dashboard definition for its Prometheus metrics. Rendering and accessibility of that dashboard are governed by the user's own Grafana instance, which provides its own accessibility settings, rather than by podtrace.



    プロジェクトによって作成されたソフトウェアは、ターゲット オーディエンスの文化、地域、または言語へのローカリゼーションを容易にするために国際化されるべきです。国際化(i18n)が適用されない場合(たとえば、ソフトウェアがエンドユーザー向けのテキストを生成せず、人間が読めるテキストを扱わない場合)、「該当なし」(N/A)を選択します。 [internationalization]
    ローカリゼーションとは、「特定のターゲット市場(ロケール)の言語、文化、およびその他の要件を満たす、製品、アプリケーションまたはドキュメントのコンテンツの適合を指します」。国際化とは、「文化、地域、言語によって異なるターゲットオーディエンスに対してローカライズを容易にする製品、アプリケーション、またはドキュメントコンテンツの設計と開発」のことです。 ( W3Cの「ローカリゼーションと国際化」を参照してください。)ソフトウェアは国際化されるだけでこの基準を満たします。いったんソフトウェアが国際化されると、他の人がローカライゼーションに取り組むことができるので、別の特定の言語のローカリゼーションは必要ありません。

    Internationalization does not meaningfully apply to podtrace's output.

    Podtrace is a kernel-level tracing tool. Its user-facing output consists overwhelmingly of technical identifiers that are fixed by the systems being observed and are not translatable: kernel symbol names (tcp_v4_connect, vfs_read, do_sys_openat2), syscall names, socket address families (AF_ALG, AF_INET), Linux capability names (CAP_BPF, CAP_PERFMON), protocol identifiers (TCP, UDP, DNS, HTTP/3, QUIC, gRPC), cgroup paths, filesystem paths, and Kubernetes API object kinds and field paths. These appear identically regardless of locale, because they are the names the kernel and the Kubernetes API themselves use.

    The remaining prose is a thin layer of report section headings and summary labels wrapped around that technical content. Localizing it would degrade rather than improve usability: an operator reading a translated heading above untranslated kernel symbols must still search for those symbols in English in kernel documentation, source, and logs, so a partially translated report is harder to act on than a consistent one.

    Locale-dependent formatting defects, which are the substantive risk this criterion guards against, are absent. All timestamps are emitted in locale-independent form: RFC 3339 in structured output and an explicit UTC pattern in report filenames. The codebase performs no locale-dependent number or date formatting. Sorting throughout the diagnostic layer is by event count, timestamp, or machine identifier rather than by locale-sensitive collation of human-readable text, so no incorrect ordering behavior exists in any locale.

    Where podtrace's data is consumed by presentation layers that may serve a localized audience, it is emitted as structured data rather than prose: JSON export, OpenTelemetry traces (OTLP, Jaeger, Splunk, DataDog, Zipkin), and Prometheus metrics. Any downstream dashboard or integration can render that data in its users' language without podtrace being localized. See https://github.com/gma1k/podtrace/blob/main/docs/viewing-events.md and https://github.com/gma1k/podtrace/blob/main/docs/tracing-exporters.md


  • その他


    プロジェクト サイト(ウェブサイト、リポジトリ、およびダウンロードURL)が外部ユーザーの認証用のパスワードを格納する場合、パスワードは、キーストレッチ(反復)アルゴリズム(PBKDF2、Bcrypt、Scrypt、PBKDF2など)を使用してユーザーごとのソルトで反復ハッシュとして保存する必要があります。プロジェクトサイトがこの目的のためにパスワードを保存しない場合は、「該当なし」(N/A)を選択します。 [sites_password_security]
    GitHub の使用はこの基準を満たしていることに注意してください。この基準は、プロジェクト サイトへの外部ユーザーの認証に使用されるパスワードにのみ適用されます(別名インバウンド認証)。プロジェクト サイトが他のサイトにログインしなければならない場合(別名:アウトバウンド認証)、その目的のために別の方法で認証トークンを保存する必要があるかもしれません(ハッシュを保存しても意味がないため)。これは、crypto_password_storage の基準を sites_httpsと同様にプロジェクトサイトに適用します。

    The project stores no passwords for authentication of external users.

    Podtrace operates no website of its own. There is no documentation site, no GitHub Pages deployment, and no custom domain; documentation is Markdown rendered directly in the repository. All project sites are hosted by GitHub: the repository, issue tracker, discussions, and pull requests at https://github.com/gma1k/podtrace, release downloads at https://github.com/gma1k/podtrace/releases, and the container image and Helm OCI chart in GitHub Container Registry at ghcr.io/gma1k.

    All inbound authentication for these surfaces is performed by GitHub, and this criterion states that the use of GitHub meets it. The project itself neither implements nor stores credentials for external user authentication.

    Remaining project-related listings (Artifact Hub, OperatorHub.io, the krew index, pkg.go.dev, OpenSSF Scorecard, FOSSA) are third-party services not operated by the project.


 変更管理 0/1

  • 以前のバージョン


    プロジェクトは、最も頻繁に使用される古いバージョンの製品を維持するか、または新しいバージョンへのアップ グレードを提供しなければなりません。アップ グレード方法が困難な場合は、プロジェクトは、アップグレード方法(変更されたインターフェイスや、アップグレードに役立つ詳細な手順など)を記載しなければなりません。 [maintenance_or_update]

 報告 1/3

  • バグ報告プロセス


    プロジェクトは、個々の課題を追跡するための課題トラッカーを使用する必要があります。 [report_tracker]

    警告:もっと長い正当性が必要です。


  • 脆弱性報告プロセス


    プロジェクトは、匿名の報告者を除いて、過去12ヶ月間に解決されたすべての脆弱性の報告者に信用していることを伝えなければなりません。過去12ヶ月間に解決された脆弱性がない場合は、「該当なし」(N / A)を選択します。 (URLが必要です) [vulnerability_report_credit]


    プロジェクトには、脆弱性レポートに対応するための文書化されたプロセスがなければなりません。 (URLが必要です) [vulnerability_response_process]
    これはvulnerability_report_processに強く関連しており、脆弱性を報告するための文書化された方法が必要です。これは、特定の時間枠内の脆弱性レポートへの応答を必要とする、vulnerability_report_responseにも関連しています。

    https://github.com/gma1k/podtrace/security/advisories/new [vulnerability_report_process] [osps_vm_01_01]


 品質 5/19

  • コーディング標準


    プロジェクトは、使用する主要な言語のための特定のコーディング スタイル ガイドを指定しなければなりませんし、貢献が一般にそれに準拠することを要求しなければなりません。 (URLが必要です) [coding_standards]
    ほとんどの場合、これはいくつかの既存のスタイル ガイドを参照し、おそらく差異をリストすることによって行われます。これらのスタイル ガイドには、可読性を向上させる方法や、欠陥(脆弱性を含む)の可能性を減らす方法が含まれています。多くのプログラミング言語には、広く使用されているスタイル ガイドが1つ以上あります。スタイルガイドの例には、 Googleスタイル ガイド SEI CERTコーディング標準を参照してください。


    選択した言語において行うことができるFLOSSツールが少なくとも1つあれば、プロジェクトは自動的に選択したコーディングスタイルを適用しなければなりません。 [coding_standards_enforced]
    これは、静的解析ツールを使用して、および/またはコード再フォーマットを介してコードを強制することによって実装することができます。多くの場合、ツールの設定は、プロジェクトのリポジトリに含まれます(プロジェクトによって異なる設定が選択される可能性があるため)。プロジェクトはスタイルの例外を許可するかもしれません(通常はそうなります)。例外が発生した場合は、それらの場所のコードでまれで、文書化されていなければなりませんので、それらの例外が再検討され、ツールが将来自動的にそれらを処理できるようにできます。このようなツールの例には、ESLint(JavaScript)、Rubocop(Ruby)、および devtools check (R)があります。

  • 作業ビルドシステム


    ネイティブ バイナリのビルドシステムは、それらに渡される関連するコンパイラおよびリンカ(環境)変数(CC、CFLAGS、CXX、CXXFLAGS、LDFLAGSなど)を受け入れ、コンパイラおよびリンカ呼び出しに渡す必要があります。ビルド システムは追加のフラグでそれらを拡張するかもしれません。提供された値を単にそれ自身のものに置き換えてはいけません。ネイティブバイナリが生成されていない場合は、「該当なし」(N/A)を選択します。 [build_standard_variables]
    Address Sanitizer(ASAN)などの特別なビルド機能を有効にしたり、ディストリビューション強化のベストプラクティスに準拠したりするのは簡単です(コンパイラフラグを簡単にオンにするなどして)。


    ビルドとインストール システムは、関連するフラグ(例えば、 "install -s"が使用されていない)で要求されたデバッグ情報を保存しておくべきです。ビルドやインストール システムがない場合(例:一般的なJavaScriptライブラリ)は、「該当なし」(N/A)を選択します。 [build_preserve_debug]
    すなわち、CFLAGS(C)またはCXXFLAGS(C ++)を設定すると、それらの言語が使用されている場合に、関連デバッグ情報が作成されるべきですし、インストール時には削除するべきではありません。デバッグ情報は、サポートと分析のために必要であり、コンパイルされたバイナリのハードニング機能の存在を測定するのにも役立ちます。


    プロジェクトによって作成されたソフトウェアのビルド システムは、サブディレクトリに相互依存関係がある場合、再帰的にサブディレクトリをビルドしてはなりません。ビルドやインストール システムがない場合(例:一般的なJavaScriptライブラリ)は、「該当なし」(N/A)を選択します。 [build_non_recursive]
    プロジェクトのビルド システムの内部依存情報は、正確でなければなりません。そうでないと、プロジェクトへの変更が正しくビルドされないことがあります。ビルドが正しくないと、欠陥(脆弱性を含む)が発生する可能性があります。大規模ビルドシステムでよく見られる間違いは、ソースファイルを含むサブディレクトリの階層で、各サブディレクトリが独立してビルドされるとき、「再帰的ビルド」か「再帰的Make」を使用することです。各サブディレクトリが完全に独立していない限り、依存関係の情報が正しくないため、これらを使用することは間違いです。


    プロジェクトは、ソースファイルから情報を生成するプロセスを繰り返すことができなければならず、ビット単位でまったく同じ結果を得ることができなければなりません。ビルドが発生しない場合(例えば、ソースコードをコンパイルする代わりに直接使用するスクリプト言語)は、「該当なし」(N/A)を選択します。 [build_repeatable]
    GCCとclangのユーザーには、-frandom-seedオプションが有用であるかもしれません。場合によっては、ソート順を強制することで解決できます。 再現可能なビルドサイトで、より多くの提案を見つけることができます。

  • インストールシステム


    プロジェクトは、プロジェクトで作成されたソフトウェアを一般的に使用されているやり方で簡単にインストールおよびアンインストールする方法を提供する必要があります。 [installation_common]
    たとえば、パッケージマネージャー(システムまたは言語レベル)、「make install / uninstall」(DESTDIRをサポート)、標準形式のコンテナー、または標準形式の仮想マシンイメージを使用することが挙げられます。インストールとアンインストールのプロセス(たとえば、パッケージング)は、FLOSSである限り、サードパーティによって実装されてもよいです。


    エンドユーザ用のインストール システムは、インストール時にビルドされる生成物が書き込まれる場所を選択するための標準的な規則を守らなければなりません。たとえば、POSIXシステムにファイルをインストールする場合は、DESTDIR環境変数を守らなければなりません。インストール システムがない場合や標準的な規約がない場合は、「該当なし」(N / A)を選択します。 [installation_standard_variables]


    プロジェクトは、潜在的な開発者がすべてのプロジェクト結果を迅速にインストールし、テストやテスト環境を含む変更を行うために必要な環境を迅速にインストールする方法を提供しなければなりません。これは、一般に使用されている手法で実行する必要があります。 [installation_development_quick]
    これは生成されたコンテナおよび/またはインストール スクリプトを使用して実装できます。外部依存部分は、典型的には、external_dependenciesごとにシステムおよび/または言語パッケージマネージャを呼び出すことによってインストールされます。

    [osps_do_07_01]


  • 外部で維持管理されるコンポーネント


    プロジェクトは、外部依存関係をコンピュータ処理可能な方法でリストしなければなりません。 (URLが必要です) [external_dependencies]
    通常、これはパッケージ マネージャーやビルドシステムのやり方を使用して行われます。これは installation_development_quick の実装に役立ちます。

    [osps_br_05_01]

    警告:URLが必要ですが、URLは見つかりません。



    プロジェクトは、既知の脆弱性を検出し、悪用可能な脆弱性を修正したり、悪用できない脆弱性として確認するために、外部の依存先(コンビニエンス コピーを含む)を監視または定期的にチェックしなければなりません。 [dependency_monitoring]
    これは、 OWASPのDependency-Check SinatypeのNexus Auditor SynopsysのBlack Duck Software Composition Analysis Bundler-audit (Rubyの場合)などのオリジンアナライザー/依存性検査ツールを使用して行うことができます。パッケージ マネージャーには、これを行うためのメカニズムが含まれています。コンポーネントの脆弱性を悪用することはできない場合、分析が難しいが、単に更新または修正する方が簡単なであれば、それは許容できます。

    Each workflow and job declares a narrowly scoped permissions: block: contents: read for build/test/lint/scan jobs, pull-requests: write only for labeling, security-events: write only for CodeQL upload, and contents: write / packages: write / id-token: write only in release jobs. [osps_vm_05_03]



    プロジェクトは
    1. 再使用された外部管理コンポーネントの識別と更新を容易にできるようにしている、 または
    2. システムまたはプログラミング言語によって提供される標準コンポーネントを使用している
    のどちらかでなければなりません。そうすれば、再利用されたコンポーネントに脆弱性が見つかった場合に、そのコンポーネントを簡単に更新することができます。 [updateable_reused_components]
    この基準を満たす典型的な方法は、システムおよびプログラミング言語のパッケージ管理システムを使用することです。多くのFLOSSプログラムは、標準ライブラリーのローカルコピーである "コンビニエンス ライブラリー"と一緒に頒布されます(フォークされている可能性があります)。それ自体は、それでいいです。しかし、プログラムがこれらのローカルな(フォークされた)コピーを使用しなければならない場合、 セキュリティ アップデートとして"標準"ライブラリをアップデートすると、これらの追加のコピーは依然として脆弱のままです。これは、特にクラウド ベース システムの問題です。クラウド プロバイダが "標準"ライブラリを更新してもプログラムがそれらを使用しない場合、更新プログラムは実際には役に立ちません。たとえば、「Chromium:適切なパッケージとしてFedoraにまだない理由は何ですか?」Tom Callaway著を参照してください。

    [osps_qa_02_01]



    プロジェクトは、使用するテクノロジ セット(その "テクノロジ スタック")において、プロジェクトがサポートするユーザの超大多数がFLOSSの代替案を利用可能な(ユーザが代替手段にアクセスしている)場合には、評価の低いまたは時代遅れの機能とAPIの使用を避けるべきです。 [interfaces_current]

  • 自動テスト スイート


    少なくとも1つのブランチの共有リポジトリへの各チェックインに対して、自動テスト スイートが適用される必要があります。このテスト スイートは、テストの成功または失敗に関するレポートを生成しなければなりません。 [automated_integration_testing]
    この要件は、test_continuous_integrationのサブセットと見ることができますが、継続的な統合を範囲外として、テストだけに焦点を当てています。

    [test_continuous_integration] [osps_qa_06_01]



    プロジェクトは、過去6ヶ月以内に修正されたバグの少なくとも50%について、自動テスト スイートに回帰テストを追加しなければなりません。 [regression_tests_added50]


    プロジェクトは、選択された言語でこの基準を測定できる少なくとも1つのFLOSSツールがある場合、少なくとも80%のステートメントカバレッジを提供するFLOSS自動テストスイートを備えていなければなりません。 [test_statement_coverage80]
    gcov/lcov、Blanket.js、Istanbul、JCov、covr (R) など、多くのFLOSSツールが、テストカバレッジを測定できます。この基準を満たすことは、テスト スイートが徹底していることを保証するものではないですが、それよりも、この基準を満たさないことは、貧弱なテスト スイートであることを示す強い指標であることに注意してください。

  • 新機能テスト


    プロジェクトには、主要な新機能が追加されると、新しい機能のテストが自動化されたテスト スイートに追加されなければならないという正式な文書化されたポリシーがなければなりません。 [test_policy_mandated]

    [tests_documented_added] [osps_qa_06_03]



    プロジェクトは、変更提案のための文書化された手順に、重要な新機能用にテストを追加するという方針を含まなければなりません。 [tests_documented_added]
    しかし、実際にテストが追加されている限り、非公式の規則でも許容されます。

    警告:もっと長い正当性が必要です。


  • 警告フラグ


    プロジェクトによって作成されたソフトウェアにある警告に、実際的な場合には、最大限に厳格にならなければなりません。 [warnings_strict]
    一部の警告は、あるプロジェクトでは効果的に有効にすることはできません。必要なのは、プロジェクトが可能な限り警告フラグを有効にするように努力しており、エラーが早期に検出されるという証拠です。

    警告:もっと長い正当性が必要です。


 セキュリティ 1/13

  • セキュリティに関する開発知識


    適用できる場合、プロジェクトはセキュア設計原則(「know_secure_design」から)を実装しなければなりません。プロジェクトでソフトウェアが作成されていない場合は、「該当なし」(N / A)を選択します。 [implement_secure_design]
    たとえば、プロジェクトの結果は、フェール セーフのデフォルト値を持つべきです(デフォルトではアクセスの決定は拒否されるべきで、プロジェクトのインストールはデフォルトでセキュリティ保護されているべきです)。また、完全なメディエーションであるべきです(制限されているすべてのアクセスは、権限がチェックされバイパス不可能でなければなりません)。原則が矛盾する場合があります。その場合、選択が必要です(たとえば、多くの仕組みは、「機構の節約」に反して複雑にすることも、単純にすることもできます)。

  • 優良な暗号手法を使用する

    一部のソフトウェアは暗号化メカニズムを使用する必要がないことに注意してください。あなたのプロジェクトが作成するソフトウェアが、(1) 暗号化機能を含む、アクティブ化する、または有効化し、(2) 米国(US)から米国外または米国市民以外にリリースされる可能性がある場合は、法的に義務付けられた追加手順の実行を要求される可能性があります。通常、これにはメールの送信が含まれます。詳細については、 Understanding Open Source Technology & US Export Controls「オープンソース技術と米国の輸出管理について」)の暗号化のセクションを参照してください。

    プロジェクトによって作成されたソフトウェア内のデフォルトのセキュリティ メカニズムは、既知の重大な脆弱性を持つ暗号アルゴリズムやモード(たとえば、SHA-1暗号ハッシュ アルゴリズムまたはSSHのCBC モード)に依存してはいけません。 [crypto_weaknesses]
    SSHのCBCモードに関する懸念事項は、 CERT: SSH CBC 脆弱性にて議論されています。.

    警告:もっと長い正当性が必要です。



    プロジェクトは複数の暗号アルゴリズムをサポートするべきですので、ユーザーは破られた場合に素早く切り替えることができます。一般的な対称鍵アルゴリズムには、AES、Twofish、およびSerpentがあります。一般的な暗号化ハッシュ アルゴリズムには、SHA-2(SHA-224、SHA-256、SHA-384およびSHA-512を含む)およびSHA-3があります。 [crypto_algorithm_agility]


    プロジェクトは、他の情報(構成ファイル、データベース、ログなど)とは別にしたファイルに、認証資格情報(パスワードやダイナミックトークンなど)やプライベート暗号鍵を格納することをサポートしなければなりませんし、ユーザーがコードの再コンパイルなしにそれらを更新や置き換えできるように許可しなければなりません。プロジェクトが認証資格情報とプライベート暗号化鍵を決して処理しない場合は、「該当なし」(N/A)を選択します。 [crypto_credential_agility]


    プロジェクトで作成されたソフトウェアは、ネットワーク通信すべてに対して、SSHv2以降、TLS1.2以降 (HTTPS)、IPsec、SFTP、SNMPv3などのセキュア プロトコルをサポートするべきです。FTP、HTTP、telnet、SSLv3以前、およびSSHv1などのセキュアでないプロトコルは、デフォルトで無効にし、ユーザーが特別に設定した場合のみ有効にするべきです。プロジェクトによって作成されたソフトウェアがネットワーク通信をサポートしない場合は、「該当なし」(N/A)を選択します。 [crypto_used_network]


    プロジェクトによって作成されたソフトウェアは、TLSをサポートあるいは使用する場合、少なくともTLSバージョン1.2をサポートするべきです。TLSの前身は、SSLと呼ばれていたことに注意して下さい。ソフトウェアがTLSを使用ない場合、「該当なし」(N/A)を選択します。 [crypto_tls12]


    TLSをサポートしている場合、プロジェクトで作成されたソフトウェアは、TLSを使う時には、サブリソースを含めて、デフォルトでTLS認証を受けなければなりません。ソフトウェアがTLSを使用しない場合、「該当なし」(N/A)を選択します。 [crypto_certificate_verification]
    誤ったTLS認証の検証は、よくある間違いであることに注意して下さい。詳細については、「世界でもっとも危険なコード:非ブラウザー ソフトウェアでのSSL認証の検証」Martin Georgiev et al著「このアプリケーションを信頼しますか?」Michael Catanzaro著.を参照して下さい。


    TLSをサポートしている場合、プロジェクトによって作成されたソフトウェアは、(たとえばセキュアクッキーなど)プライベートな情報をHTTPヘッダと共に送信する前に、証明書の検証をしなければなりません。ソフトウェアがTLSを使用しない場合は、「該当なし」(N/A)を選択します。 [crypto_verification_private]

  • 公開物の安全性


    プロジェクトは、広く普及することを意図しているプロジェクト結果のリリースには暗号で署名しなければなりませんし、パブリック署名鍵を入手して署名を検証する方法をユーザに説明するプロセスがなければなりません。これらの署名の秘密鍵は、ソフトウェアを一般に直接配布するために使用されるサイトにあってはなりません。リリースが広く普及することを意図していない場合は、「該当なし」(N/A)を選択します。 [signed_releases]
    プロジェクトの結果には、ソースコードと生成された成果物(実行可能ファイル、パッケージ、コンテナなど)が含まれます。生成された成果物は、ソースコードとは別に署名することができます。これらは、(暗号デジタル署名を使用して)署名付きgitタグとして実装できます。プロジェクトはgitのようなツールとは別に生成された結果を提供するかもしれませんが、そのような場合、別々の結果を別々に署名しなければなりません。

    [osps_do_03_02]



    バージョン管理システムでは、 signed_releases で説明されているように、重要なバージョンタグ(メジャーリリース、マイナーリリース、または公開されている脆弱性の一部であるタグ)を暗号署名して検証することが推奨されています。 [version_tags_signed]

  • その他のセキュリティ上の課題


    プロジェクトの結果は、潜在的に信頼できないソースからのすべての入力をチェックして有効であること(*allowlist*)を確認し、データに何らかの制限がある場合は無効な入力を拒否しなければなりません。 [input_validation]
    攻撃者はしばしばブラックリストを回避することができるので、入力を "不正な形式" のリスト(別名*denylist*)と比較するのは、通常十分ではないことに注意してください。特に、数値は内部形式に変換され、最小値と最大値の間であるかがチェックされますし、文字列は、有効なテキストパターン(有効なUTF-8、長さ、構文など)であることを確認するためにチェックされます。一部のデータは「何でもよい」(たとえばファイル アップローダー)ことがありますが、通常はまれです。


    プロジェクトによって作成されたソフトウェアで強化メカニズムを使用するべきですので、ソフトウェア欠陥がセキュリティ上の脆弱性を引き起こす可能性が低くなります。 [hardening]
    強化メカニズムは、Content Security Policy(CSP)などのHTTPヘッダー、攻撃を緩和するコンパイラ フラグ(-fstack-protectorなど)、または未定義の動作を排除するためのコンパイラ フラグを含みます。私たちの目的のために、最低限の特権は強化メカニズムとはみなされません(最低の特権は重要ですが、別の話です)。


    プロジェクトは、そのセキュリティ要件が満たされていることを証明する保証ケースを提供しなければならない。保証ケースには、脅威モデルの説明、信頼境界の明確な識別、セキュアな設計原則が適用されていることの議論、共通の実装セキュリティの弱点が対処されたことの議論が含まれなければならない。 (URLが必要です) [assurance_case]
    保証ケースは、「システムのプロパティに関する特定の一連の重大なクレームが、特定の環境とアプリケーションに対して適切に正当化されていることを説得力のある正当な議論で示す証拠」である(「構造化された保証ケースモデルを使用したソフトウェア保証」、Thomas Rhodes他、NIST Interagency Report 7608 )。信頼境界は、データまたは実行がその信頼レベル、例えば、典型的なウェブアプリケーションにおけるサーバの境界、を変更する境界である。安全な設計原則(SaltzerやSchroeerなど)と一般的な実装セキュリティの弱点(OWASPトップ10やCWE / SANSトップ25など)をリストし、それぞれがどのように対抗しているかを示すのは一般的です。 BadgeAppの保証ケースは良い参考例になるかもしれません。これは、documentation_security、documentation_architecture、およびimplement_secure_designに関連しています。

    Every workflow in .github/workflows/ declares an explicit top-level permissions: block scoped to the minimum needed (contents: read for all CI/test/scan workflows), so no job inherits broader permissions than the pipeline grants. [osps_sa_03_01]

    警告:URLが必要ですが、URLは見つかりません。


 分析 0/2

  • 静的コード解析


    プロジェクトは、選択された言語でこの基準を実装できる少なくとも1つのFLOSSツールがある場合、解析された言語または環境で共通の脆弱性を探すためのルールまたはアプローチを備えた少なくとも1つの静的解析ツールを使用しなければならなりません。 [static_analysis_common_vulnerabilities]
    一般的な脆弱性を探すために特別に設計された静的解析ツールは、それらを見つける可能性が高いです。つまり、静的ツールを使用すると、通常は問題を見つけるのに役立ちますので、利用を提案しますが、「合格」レベルのバッジには要求しません。

    警告:もっと長い正当性が必要です。


  • 動的コード分析


    もしプロジェクトで作成されたソフトウェアにメモリ安全でない言語(CやC ++など)を使用して作成されたソフトウェアが含まれているならば、そのときには 少なくとも1つの動的ツール(たとえば、ファジーまたはウェブ アプリケーション スキャナ)を、バッファの上書きなどのメモリの安全性の問題を検出するメカニズムと一緒にいつも使用します。プロジェクトがメモリ安全でない言語で書かれたソフトウェアを作成しない場合は、「該当なし」(N/A)を選択します。 [dynamic_analysis_unsafe]
    メモリの安全性の問題を検出するメカニズムの例としては、アドレスサニタイザー(ASAN)(GCCおよびLLVMで利用可能)、 Memory Sanitizer 、および valgrind が含まれます。他に使用される可能性のあるツールには、スレッドサニタイザ定義されていない動作サニタイザを参照してください。広範なアサーションも機能します。

    警告:もっと長い正当性が必要です。



このデータは、Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0)のもとで利用可能です。これは、データ受領者が、データ受領者がこの契約のテキストを共有データとともに利用可能にする限り、変更の有無にかかわらずデータを共有できることを意味します。Ghassan MalkeおよびOpenSSFベストプラクティスバッジのコントリビューターにクレジットを表示してください。

プロジェクト バッジ登録の所有者: Ghassan Malke.
エントリの作成日時 2026-05-18 11:01:40 UTC、 最終更新日 2026-08-06 19:53:50 UTC 最後に2026-05-18 11:12:38 UTCにバッジ合格を達成しました。