docker-net-dhcp

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

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

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


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

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

        

 Basics 16/17 ●

  • General

    Note that other projects may use the same name.

    Docker network plugin: containers get DHCP leases from the LAN. Modernized fork of devplayer0/docker-net-dhcp with macvlan attachment mode.

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

  • Prerequisites


    Enough for a badge!

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

  • Basic project website content


    Enough for a badge!

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

    https://github.com/claymore666/docker-net-dhcp/blob/main/README.md#contributing


  • Project oversight


    Barely enough for a badge.

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

    The project has no DCO sign-off requirement or CLA today. Contributions are accepted under the repository's GPL-3.0 license via GitHub pull requests. The PR checks do enforce an authorship rule (commits must be authored by a person, no AI-assistant attribution), but that is not a legal assertion mechanism.


    Enough for a badge!

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

    Governance model, decision-making process, and the path to becoming a maintainer are documented at https://github.com/claymore666/docker-net-dhcp/blob/main/GOVERNANCE.md


    Enough for a badge!

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

    Contributor Covenant based code of conduct in the standard location: https://github.com/claymore666/docker-net-dhcp/blob/main/CODE_OF_CONDUCT.md


    Enough for a badge!

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

    Roles (maintainer, contributors) and their responsibilities — triage, review/merge, releases, security response, CI/CD ownership — are documented at https://github.com/claymore666/docker-net-dhcp/blob/main/GOVERNANCE.md#roles-and-responsibilities and it is clear who holds the maintainer role.


    Not enough for a badge.

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

    Honestly unmet: this is a single-maintainer project, and that one maintainer holds the repository, registry, and signing access. GOVERNANCE.md states this openly rather than implying otherwise, and explicitly invites co-maintainers. Worth recording that the criterion does not strictly require a second active maintainer — it can also be satisfied by ensuring a successor holds the necessary keys, passwords and legal rights, which remains an open option here.


    Barely enough for a badge.

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

    The bus factor is 1. This is stated openly rather than glossed at https://github.com/claymore666/docker-net-dhcp/blob/main/GOVERNANCE.md — the project is single-maintainer today and explicitly invites co-maintainers.


  • Documentation


    Enough for a badge!

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

    The project's direction for roughly the next year, including the work that is blocked on upstream Docker changes and an explicit list of what the project will deliberately not do and why, is documented at https://github.com/claymore666/docker-net-dhcp/blob/main/docs/roadmap.md and linked from the README. It is reviewed at every release as part of the runbook's documentation step.


    Enough for a badge!

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

    High-level design — the veth + DHCP-client flow per attachment mode, the event loop, and how endpoint state survives a plugin restart — is documented at https://github.com/claymore666/docker-net-dhcp/blob/main/docs/internals.md


    Enough for a badge!

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

    Security expectations, scope, trust boundary, and what is explicitly out of scope (a hostile DHCP server can still hand out bad addressing — that is the protocol, not a plugin defect) are documented at https://github.com/claymore666/docker-net-dhcp/blob/main/SECURITY.md


    Enough for a badge!

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

    A copy-pasteable quick start — install the plugin, create a network, run a container on it — is the first section of the README: https://github.com/claymore666/docker-net-dhcp#quick-start


    Enough for a badge!

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

    Keeping documentation consistent with the release is a mandatory step in the release runbook (step 3): every release branch gets a top-to-bottom review of README and docs/ against what the release actually contains, with the release-candidate window as the last checkpoint. See https://github.com/claymore666/docker-net-dhcp/blob/main/docs/release-runbook.md


    Enough for a badge!

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

    The repository front page carries a badge row linking to this best practices badge, the OpenSSF Scorecard report, and the CI status badges: https://github.com/claymore666/docker-net-dhcp#docker-net-dhcp


  • Accessibility and internationalization


    Enough for a badge!

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

    The software has no GUI — it is a daemon whose entire user-facing output is plain text log lines, which are readable by screen readers and terminal accessibility tooling. The project site is a mkdocs-material build (semantic HTML, keyboard navigation, light/dark contrast themes), and project participation happens through GitHub, which follows its own accessibility program.


    Enough for a badge!

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

    The software produces no end-user-facing text: output is English-language operator/diagnostic logging, and the project performs no human-readable text sorting or collation.


  • Other


    Enough for a badge!

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

    The project runs no sites of its own that store user passwords. The website, repository, and download URLs are GitHub, GitHub Pages, GHCR, and Docker Hub.


 Change Control 1/1 ●

  • Previous versions


    Enough for a badge!

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

    The upgrade path is a single documented command sequence (disable, rm, install the new tag), and it is deliberately cheap — see https://github.com/claymore666/docker-net-dhcp/blob/main/docs/reference.md#install-upgrade-uninstall. The support policy (latest release, no backports, because upgrades are cheap) is stated in SECURITY.md, and every behavioural change is recorded per release in RELEASE_NOTES.md.


 Reporting 3/3 ●

  • Bug-reporting process


    Enough for a badge!

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

    GitHub Issues, with structured issue forms for bug reports and feature requests: https://github.com/claymore666/docker-net-dhcp/issues


  • Vulnerability report process


    Enough for a badge!

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

    No vulnerabilities have been reported or resolved in the last 12 months (zero published security advisories). SECURITY.md commits in advance to crediting reporters in the advisory and the release notes unless they request anonymity.


    Enough for a badge!

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

    Documented in the "Reporting a vulnerability" and "Response process" sections of https://github.com/claymore666/docker-net-dhcp/blob/main/SECURITY.md — private GitHub security advisory intake, triage and confirmation, fix in a released version, published advisory with reporter credit.


 Quality 19/19 ●

  • Coding standards


    Enough for a badge!

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

    The required style guides are named in the Contributing section: Go code must be gofmt-formatted and pass go vet and staticcheck; shell and workflow files must pass shellcheck and actionlint. Compliance is a stated requirement for an acceptable contribution. See https://github.com/claymore666/docker-net-dhcp#contributing


    Enough for a badge!

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

    gofmt, go vet, and staticcheck run in the test workflow on every pull request, and actionlint runs as its own required status check. Branch protection on dev and main makes these checks blocking, so a non-conforming change cannot merge.


  • Working build system


    Enough for a badge!

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

    The Makefile invokes plain go build -o <out> ./cmd/<name> with no injected or overriding compiler/linker flags, so GOFLAGS, CGO_ENABLED, CGO_CFLAGS, and CGO_LDFLAGS supplied by the environment are honoured and passed through to the toolchain unchanged.


    Enough for a badge!

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

    Nothing in the build strips the binaries: there is no -ldflags "-s -w", no strip, and no install -s. Symbol tables and DWARF debug information are preserved in the shipped binaries.


    Enough for a badge!

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

    There is one top-level Makefile and no recursive make: it never invokes make in subdirectories. Cross-package dependencies are resolved by the Go toolchain from the package graph.


    Enough for a badge!

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

    Verified empirically, not inferred. The plugin was built twice from a clean export of the same commit, the second time with docker build --no-cache so no layer or cached object could be reused, and the resulting binaries compared by SHA-256: identical both times (dhcp-handler 0eb5b698698f2d8f4e997062c77f295726915c9ba31125db1800e602edfa4bf8, net-dhcp 0ac36b87391c5bd5ea7a4b268183ca3fd86c686bf9b5d0505b97c4e0780d710b). The preconditions are pinned deliberately: dependencies fixed by go.mod/go.sum with checksum verification, the golang and alpine base images pinned by sha256 digest, Alpine package versions pinned and enforced by an apk-pin-check workflow, and a fixed build path inside the container.


  • Installation system


    Enough for a badge!

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

    Installed and removed with the standard Docker plugin convention: docker plugin install ghcr.io/claymore666/docker-net-dhcp:vX.Y.Z, and docker plugin disable + docker plugin rm to uninstall. Documented at https://github.com/claymore666/docker-net-dhcp/blob/main/docs/reference.md#install-upgrade-uninstall


    Enough for a badge!

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

    There is no filesystem installation step for end users and therefore no DESTDIR-style convention to honour: the deliverable is a Docker managed plugin, installed by the daemon from a registry with docker plugin install.


    Enough for a badge!

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

    A developer runs make (which builds the rootfs image, creates the plugin, and enables it) to get a working local install, and make integration-test to bring up the full test environment — the suite provisions its own dnsmasq DHCP fixtures on veth pairs, so no LAN setup or external server is needed. Standard convention (make + Docker), no bespoke bootstrap.


  • Externally-maintained components


    Enough for a badge!

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

    Go dependencies are listed machine-readably with pinned versions and checksums in https://github.com/claymore666/docker-net-dhcp/blob/main/go.mod and go.sum; runtime OS packages are version-pinned in the Dockerfile; and every release publishes an SBOM alongside the image.


    Enough for a badge!

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

    Dependabot opens grouped weekly update PRs for Go modules and GitHub Actions; govulncheck runs as a required status check on every pull request and on a weekly schedule; CodeQL, Trivy, and GitHub Dependency Review also run in CI. Vulnerabilities with no fixed release available are recorded individually in .github/vuln-allowlist.txt with a written justification and a review date — never a bare identifier — and are re-evaluated by the gate on every run.


    Enough for a badge!

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

    All reused components are standard Go modules resolved through go.mod, so updating one is a go get plus a lockfile change; Dependabot automates exactly that. No vendored or convenience copies of third-party source are carried in the repository.


    Enough for a badge!

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

    staticcheck runs as a blocking CI check and its SA1019 rule fails the build on use of deprecated functions and APIs, so deprecated interfaces cannot silently accumulate. The stack is kept current deliberately — this fork exists partly because upstream stopped building against modern Docker; it tracks a current Go toolchain and Docker SDK.


  • Automated test suite


    Enough for a badge!

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

    A live integration suite runs on every pull request as a required status check, exercising all three attachment modes plus DHCPv6, restart recovery, and failure injection against a real kernel, a real Docker daemon, and real dnsmasq DHCP servers. It reports pass/fail per scenario in the workflow run.


    Enough for a badge!

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

    Measured over the bug-fix commits merged in the six months to 2026-08-02: 37 fix commits, of which 23 also add or extend an automated test (a Go _test.go file or a scenario under test/integration), giving 62 percent. The misses are concentrated in the older part of the window and in CI and release-workflow fixes; every plugin behaviour fix merged since 2026-07-28 ships with a regression test. The rule is that a fix lands with the test that would have caught it — see the container-restart failures #402/#408, the v1.3.4 lease-lifecycle fixes, and TestHostConfig_NoSlowStopOptOut, which exists specifically to stop a test being weakened to make it pass.


    Enough for a badge!

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

    Merged unit-plus-integration statement coverage is 85.8 percent, computed as a statement-weighted total over the shipped packages (pkg/plugin 85.0 percent of 1811 statements, pkg/dhcp 89.9 of 338, pkg/util 98.5 of 78, cmd/net-dhcp 76.4 of 72, cmd/dhcp-handler 75.0 of 16). Coverage is measured in CI by a dedicated workflow that merges the unit run with a coverage-instrumented build of the plugin exercised by the live integration suite. Per-package floors are recorded in .github/coverage-baseline.txt and enforced by a ratchet script that blocks any release regressing them.


  • New functionality testing


    Enough for a badge!

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

    Written policy in the Contributing section — new functionality is expected to ship with tests — backed by a per-package coverage ratchet that is a required check on the release pull request, so a feature that adds untested code cannot ship. See https://github.com/claymore666/docker-net-dhcp#contributing


    Enough for a badge!

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

    The policy is stated in the documented instructions for change proposals. The README's Contributing section lists, among the requirements for an acceptable contribution: new functionality is expected to ship with tests, and a coverage ratchet enforces this at release time. See https://github.com/claymore666/docker-net-dhcp#contributing


  • Warning flags


    Enough for a badge!

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

    staticcheck runs with its full default check set (all of SA, S, ST and QF) over the whole module rather than a reduced subset, and the linter version is pinned so an upgrade is a deliberate change. Unit tests additionally run under the Go race detector (go test -race).


 Security 13/13 ●

  • Secure development knowledge


    Enough for a badge!

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

    Secure design principles are applied and argued explicitly in the assurance case at https://github.com/claymore666/docker-net-dhcp/blob/main/SECURITY.md#security-assurance-case — memory-safe implementation language, no home-grown cryptography, an explicit trust boundary around DHCP-server-supplied bytes, and the minimum privilege set the plugin can function with, declared in config.json and shown to the user at install time.


  • Use basic good cryptographic practices

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

    Enough for a badge!

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

    The software implements no cryptographic functionality of its own. It is a Docker network driver: it speaks DHCP and DHCPv6 over UDP through dhcpcd, manipulates network interfaces via netlink, and serves the libnetwork remote-driver API over a local Unix domain socket. It stores no passwords, establishes no authenticated or encrypted channel, and selects no cryptographic algorithms or key lengths.


    Enough for a badge!

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

    The project implements no cryptography of its own; there is no algorithm to switch. Release signing is delegated to cosign/Sigstore.


    Enough for a badge!

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

    The plugin never processes authentication credentials or private cryptographic keys.


    Barely enough for a badge.

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

    Honestly unmet, and structurally so: the plugin's purpose is to obtain addresses from the LAN's existing DHCP server, and DHCP (v4 and v6) has no encrypted variant to prefer or fall back to. Its other communication channel is the local Docker Unix socket, which does not traverse a network. SECURITY.md documents the resulting residual risk — a hostile DHCP server can hand out bad addressing — as accepted and outside the plugin's control.


    Enough for a badge!

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

    The software neither supports nor uses TLS.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]
    Note that incorrect TLS certificate verification is a common mistake. For more information, see "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" by Martin Georgiev et al. and "Do you trust this application?" by Michael Catanzaro.

    The plugin implements no TLS. Its only network protocol is DHCP (v4/v6) via dhcpcd; it talks to the Docker daemon over a local Unix socket. No TLS client or server code exists in the project.


    Enough for a badge!

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

    The plugin implements no TLS and sends no HTTP headers carrying private information.


  • Secure release


    Enough for a badge!

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

    Every release from v1.1.0 onward is cryptographically signed: the plugin image is cosign-signed (keyless, via Sigstore) and the release-artifact checksums.txt manifest is cosign-signed so one signature covers every attached file. SLSA build provenance and an SBOM are published with each release. Signing happens in the release workflow using Sigstore's ephemeral keyless flow, so no long-lived private key exists on the distribution sites. Copy-pasteable verification commands, pinned per release, are in https://github.com/claymore666/docker-net-dhcp#verifying-releases


    Enough for a badge!

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

    Release tags are cryptographically signed (SSH signing) by the maintainer and display as Verified on GitHub; the signing key is published on the maintainer's GitHub account.


  • Other security issues


    Enough for a badge!

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

    The untrusted inputs are DHCP server responses and the DHCP client's hook events. Both are parsed through validating code paths (pkg/dhcp BuildEvent and the handler-pipe JSON decoder) that reject malformed input rather than propagating it, and both carry native Go fuzz targets with seed corpora that run in CI on every pull request, so malformed input is exercised rather than assumed safe.


    Enough for a badge!

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

    The plugin is written in Go, a memory-safe language, and imports the unsafe package in zero source files, so entire classes of memory-corruption defects cannot occur. The race detector runs over the unit suite in CI, the untrusted parsers are fuzzed on every pull request, and the plugin requests an explicit, minimal capability set in config.json rather than running fully privileged — the daemon shows that set to the user before installation. See https://github.com/claymore666/docker-net-dhcp/blob/main/SECURITY.md#security-assurance-case


    Enough for a badge!

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

    A written assurance case — security goals, threat model, trust boundary, an argument that secure design principles were applied, and an argument that common implementation weaknesses are countered (memory-safe language, fuzzed untrusted parsers, live integration coverage of the escape-relevant paths, signed and attested supply chain) — together with the accepted residual risk, is published at https://github.com/claymore666/docker-net-dhcp/blob/main/SECURITY.md#security-assurance-case


 Analysis 2/2 ●

  • Static code analysis


    Enough for a badge!

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

    CodeQL security queries + govulncheck (reachability) + dependency-review


  • Dynamic code analysis


    Enough for a badge!

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

    Go — memory-safe language



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/13229/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. See our automation proposals system for how to do that. This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Chris and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Chris.
Entry created on 2026-06-14 12:10:55 UTC, last updated on 2026-09-28 18:09:32 UTC. Last achieved passing badge on 2026-06-14 13:17:33 UTC.