monumental-archive-db

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


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

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

        

 Basics 17/17 ●

  • General

    Note that other projects may use the same name.

    The Monumental Archive's PostgreSQL image: official postgres + PostGIS, pgaudit, edtf_postgres — native multi-arch, tested before published, cosign-signed

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


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

  • Basic project website content


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


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

    The legal mechanism is the Developer Certificate of Origin, documented and linked at https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#requirements-for-an-acceptable-contribution, with no CLA and no contributor assignment agreement. Stated honestly for the record: the mechanism is documented policy rather than an enforced one — there is currently no DCO status check on pull requests and no commit-msg hook validating the trailer. That enforcement gap is tracked as issue #21 and is answered Unmet under the stricter baseline control OSPS-LE-01.01, which asks the version control system to require the assertion on every commit rather than merely to have the mechanism.



    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.

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/GOVERNANCE.md — a single-maintainer benevolent-dictator model, stated plainly rather than describing a committee that does not exist, with load-bearing decisions recorded in docs/decisions/.



    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.

    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.

    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]

    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.

    Bus factor is 1. Mitigations documented at https://github.com/CarlAllenn/monumental-archive-db/blob/main/GOVERNANCE.md#access-continuity rather than papered over.


  • Documentation


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

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/roadmap.md — what the project will and will not do over roughly the next year, with the exclusions use-case-gated rather than absolute.



    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.

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/assurance-case.md#trust-boundaries — the publish boundary, the build-stage boundary, the apt boundary, the privilege boundary inside the image and the registry identity boundary. The decision register at https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/decisions/ records the load-bearing architectural choices.



    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.

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md states the security requirements and the scope boundary precisely, and https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/assurance-case.md is the evidence that they hold.



    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.

    Consumers: the README shows the image reference and the cosign verification command. Developers: mise install then task ci, at https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#development-quick-start



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

    Documentation is updated in the same pull request as the change it describes. Documents that name a digest or a version are explicitly tracked as things that can rot without failing anything, and are called out in CONTRIBUTING as a standing contribution opportunity; a documentation defect is treated as a bug.



    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 README badge row identifies and links the project's achievements: CI, publish, OpenSSF Scorecard, licence, and this OpenSSF Best Practices badge. https://github.com/CarlAllenn/monumental-archive-db#readme


  • Accessibility and internationalization


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

    The project produces no user interface — the deliverable is a container image with no web pages, GUI or interactive client.



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

    No user-facing strings are authored in this repository. Localisation in the delivered artifact is PostgreSQL's own, upstream and unmodified.


  • Other


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

    The project operates no site of its own that authenticates external users. The project site and repository are GitHub and the distribution point is GHCR; all authentication is handled by GitHub, and this project stores no user credentials anywhere.


 Change Control 1/1 ●

  • Previous versions


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

    The supported version is the latest published digest, and it is republished weekly by a scheduled cache-free rebuild. The upgrade path is a digest bump, which is what Renovate is for — the :main tag exists so Renovate has something to resolve against. Because consumers pin digests, nothing the project does can change an image already pulled, so an upgrade is always a deliberate, reversible act. https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md#supported-versions


 Reporting 3/3 ●

  • Bug-reporting process


    The project MUST use an issue tracker for tracking individual issues. [report_tracker]
  • Vulnerability report process


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

    Reporters are credited on the published advisory; this is stated in the reporting section itself as a reason to use private advisories. https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md#reporting-a-vulnerability



    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.

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md#what-to-expect — acknowledgement within 7 days, triage verdict within 14, accepted defects fixed and republished as a new digest with that digest named in the published advisory.


 Quality 19/19 ●

  • Coding standards


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

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#coding-standard — the standard is the enforced configuration itself, listed file by file (hadolint, shellcheck, shfmt, actionlint, zizmor, yamllint, markdownlint, taplo, codespell, editorconfig), deliberately rather than as a restatement that would drift.



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

    Enforced mechanically and twice over: lefthook git hooks run the full lint suite on every commit, and required status checks on main run the same tasks in the same order. There are no bypass flags, and personal overrides are confined to a gitignored lefthook-local.yml.


  • Working build system


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

    No native binaries are generated. Nothing is compiled in this repository: the image installs prebuilt PGDG packages and copies a prebuilt extension out of a digest-pinned build stage, so there are no CC, CFLAGS or LDFLAGS invocations to honour.



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

    Nothing is compiled here, so there is no debugging-information setting to preserve.



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

    There is no recursive build system — a single Dockerfile driven by one Task target.



    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.

    Every input is pinned, so the same commit rebuilds to the same content: both FROM lines are pinned by digest and BuildKit fails closed on any mismatch rather than warning, apt package versions are exact pins under the ARG *_VERSION convention so a missing version fails the install rather than silently resolving newer, the toolchain is pinned by mise.lock in strict/locked mode, and the publish path carries no build cache of any kind, so there is no second unreviewed source of layer content. Nothing is compiled, so there is no compiler nondeterminism to control for. Note the deliberate exception: the weekly cache-free rebuild re-resolves the transitive OS layer from trixie-security on purpose — that is the remediation mechanism (https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/decisions/0001-own-the-installation.md), and it changes inputs rather than making identical inputs produce different output.


  • Installation system


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

    docker pull ghcr.io/carlallenn/monumental-archive-db@<digest> — the standard installation convention for this artifact type. Uninstalling is docker rmi. The README documents the reference and the tag policy.



    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]

    The image honours the official postgres image's conventions unchanged: PGDATA and the /var/lib/postgresql/data volume determine where data is written, and the consumer selects the mount. The project overrides none of them.



    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.

    mise install bootstraps the pinned toolchain and the git hooks; task ci then runs the whole gate. Two commands, documented at https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#development-quick-start


  • Externally-maintained components


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

    Every dependency is an explicit, machine-readable pin in https://github.com/CarlAllenn/monumental-archive-db/blob/main/Dockerfile — two digest-pinned FROM lines and exact apt versions in ARG *_VERSION declarations, each with a # renovate: comment above it so the pin cannot silently lose automated coverage. Toolchain dependencies are pinned in mise.toml and mise.lock.



    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.

    Renovate monitors every pin continuously (policy canon in CarlAllenn/renovate-config), trivy scans the filesystem and the built image at all severities on every pull request, and the weekly cache-free rebuild refreshes the one layer that cannot be pinned by anyone.



    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.

    Nothing is vendored, forked or copied in. Every reused component is an external pin that Renovate can bump in place — the two images by digest and the apt packages by exact version — so updating a vulnerable component is a one-line change with no patch to rebase.



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

    The image tracks the current PostgreSQL major (18) on the official image, with no deprecated interfaces in use. The PostgreSQL 19 move is a tracked, deliberately gated roadmap item rather than an automatic bump: https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/roadmap.md


  • Automated test suite


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

    Integration testing by construction — the suite boots the assembled image and queries a live PostgreSQL server rather than testing anything in isolation. It runs on every push and pull request through the CI workflow, and in the publish pipeline it runs per-architecture on native amd64 and arm64 runners and then again on the published bytes pulled back from the registry by digest. Every run reports success or failure as a required status check: https://github.com/CarlAllenn/monumental-archive-db/actions



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

    The standing policy is stronger than 50%: a change to what the image contains must come with a smoke assertion that fails without it, precisely so a later refactor cannot silently drop it. https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#tests-are-part-of-the-change



    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.

    This criterion is conditioned on at least one FLOSS tool being able to measure it, and for a Dockerfile there is none — there is no application code here to instrument. What is testable is the published artifact's behaviour, which the smoke test asserts directly against a running server.


  • New functionality testing


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

    Mandated in writing in CONTRIBUTING and applied at review as one of the four ordered review checks. https://github.com/CarlAllenn/monumental-archive-db/blob/main/CONTRIBUTING.md#tests-are-part-of-the-change



    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.

    Stated in CONTRIBUTING as a requirement for an acceptable contribution, not as a suggestion.


  • Warning flags


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

    Every linter runs at its strictest configured setting, zizmor at --persona=pedantic in particular, and the gate fails on any output with no bypass available.


 Security 13/13 ●

  • Secure development knowledge


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

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/assurance-case.md#secure-design-principles — economy of mechanism (the deliverable is about 95 lines of Dockerfile and a smoke script, so most defect classes are absent because the code that would contain them was never written), fail-safe defaults (digest pins fail closed in BuildKit, exact apt pins fail rather than resolve newer, the server starts non-root and cannot be talked into root because gosu is deleted), complete mediation (one publish path, one signing identity, no manual publish route, no cache), and least privilege (contents: read by default with per-job scopes annotated inline, egress-policy: block on runners, no long-lived credential in existence).


  • Use basic good cryptographic practices

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

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

    No cryptographic code is authored in this repository. It assembles a container image; cryptographic functionality in the delivered artifact is upstream PostgreSQL and OpenSSL, unmodified.



    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]

    No cryptographic code is authored in this repository. It assembles a container image; cryptographic functionality in the delivered artifact is upstream PostgreSQL and OpenSSL, unmodified.



    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]

    No authentication credential or private key is ever baked into the image. The database superuser secret is supplied at runtime through the official image's environment convention (or its _FILE variant, reading from a mounted secret), entirely separate from configuration, logs and image layers, and can be rotated without rebuilding or recompiling anything. On the publishing side the same property holds structurally: there is no long-lived registry or signing secret in existence to store or rotate, because GHCR authentication uses the workflow run's own short-lived token and cosign signs keylessly against an ephemeral Sigstore certificate. https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md



    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]

    No cryptographic code is authored in this repository, and the software produced here initiates no network communication of its own. Network cryptography in the running database is PostgreSQL's TLS, configured by the consumer.



    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]

    No TLS implementation is authored or configured here; TLS termination is explicitly the consumer's deployment decision per https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md



    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]

    No cryptographic code is authored in this repository. It assembles a container image; cryptographic functionality in the delivered artifact is upstream PostgreSQL and OpenSSL, unmodified. The software produced here implements no TLS client.



    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]

    No cryptographic code is authored in this repository. It assembles a container image; cryptographic functionality in the delivered artifact is upstream PostgreSQL and OpenSSL, unmodified. The software produced here implements no TLS client and sends no HTTP headers.


  • Secure release


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

    Every published manifest is cosign-signed keylessly, with this repository's publish workflow on main as the certificate identity — the ref is anchored in the pattern (@refs/heads/main$), so a signature minted from any other ref does not verify. The pipeline then runs cosign verify against that exact identity immediately after signing, because a signing step that exits 0 is not the same as a signature that verifies. The verification process is documented for users at https://github.com/CarlAllenn/monumental-archive-db/blob/main/SECURITY.md#verifying-what-you-pulled and repeated in the README. This criterion's requirement that the private key not live on the distribution site is satisfied absolutely rather than by policy: keyless signing means there is no private key at rest anywhere — the Fulcio certificate is ephemeral and bound to the workflow's OIDC identity. Images additionally carry SPDX SBOM and provenance (mode=max) attestations.



    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]

    There are no version tags to sign — no version tags exist by design (https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/roadmap.md). What this criterion is reaching for is provided by other means: commits are signed and a require-signed-commits ruleset enforces it, a tag-immutability ruleset prevents any tag from moving, and the published manifests themselves are cosign-signed.


  • Other security issues


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

    The delivered artifact validates all client input: PostgreSQL's parser and type system reject malformed input by construction, and the one validation surface this project deliberately adds — edtf_postgres — is a strict, fail-closed EDTF validator, chosen precisely so the database and the archive's web layer cannot diverge in what they accept. Stated plainly for provenance: none of that validation code is authored in this repository, and this repository's own executable content (two shell scripts) takes no untrusted input at all.



    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 server runs as USER postgres with no root phase and no setuid path to one, because gosu is deleted; /docker-entrypoint-initdb.d is emptied; workflows default to contents: read with per-job scopes annotated inline; runners enforce egress-policy: block; every checkout sets persist-credentials: false. https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/assurance-case.md#secure-design-principles



    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.

    https://github.com/CarlAllenn/monumental-archive-db/blob/main/docs/assurance-case.md — threat model in order of exposure, the four supply-chain substitution points, explicit out-of-scope boundaries, the five trust boundaries, secure design principles tied to mechanisms, a table of common implementation weaknesses with countermeasures and evidence, and a closing section naming the residual risks honestly rather than claiming there are none.


 Analysis 2/2 ●

  • Static code analysis


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

    trivy at all severities with --ignore-unfixed over both the filesystem and the built image on every pull request, plus CodeQL's actions analysis for workflow-level vulnerability patterns. The scan tasks are deliberately never checksum-fingerprinted, because vulnerability databases change without commits and a cached skip would be a false pass.


  • Dynamic code analysis


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

    No memory-unsafe code is authored here; the only executable content written in this repository is two shell scripts.



You can use tools and AI systems to propose changes via a simple URL, such as https://www.bestpractices.dev/en/projects/13998/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 Carl Allen and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Carl Allen.
Entry created on 2026-08-09 00:45:46 UTC, last updated on 2026-08-09 01:33:27 UTC. Last achieved passing badge on 2026-08-09 00:58:03 UTC.