umoci

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.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 1084 is silver Here is how to embed it:

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

        

 Basics 13/13

  • Identification

    umoci is a tool for modifying Open Container images

    What programming language(s) are used to implement the project?
  • Basic project website content


    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    The description is given in the README section of the webpage https://github.com/opencontainers/umoci/blob/master/README.md, along with the main wesbite for the project https://umo.ci/.



    The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    This information is included in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md and also in the README https://github.com/opencontainers/umoci/blob/master/README.md.



    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.



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

    This information is included in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md.


  • FLOSS license

    What license(s) is the project released under?



    The software produced by the project MUST be released as FLOSS. [floss_license]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI) and Free Software Foundation (FSF). The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The Apache-2.0 license is approved by the Open Source Initiative (OSI) and Free Software Foundation (FSF). The Apache-2.0 license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    Non-trivial license location file in repository: https://github.com/opencontainers/umoci/blob/master/COPYING.


  • Documentation


    The project MUST provide basic documentation for the software produced by the project. [documentation_basics]

    Basic documentation is provide in the main README of the project https://github.com/opencontainers/umoci/blob/master/README.md, as well as in our quick-start guide https://umo.ci/quick-start/.



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]

    The external interface is described through the manual pages https://github.com/opencontainers/umoci/tree/master/man which are kept up-to-date with the project itself. The format of images is described by the Open Container Initiative (OCI) image specification https://github.com/opencontainers/image-spec as mentioned in the documentation. We also provide reference documentation in https://umo.ci/reference/.


  • Other


    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    GitHub supports discussions on issues and pull requests.



    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    All of the main developers are proficient in English and the entire project is written in English.



    The project MUST be maintained. [maintained]


(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    All development is done in the open, which means that all interim versions are visible in the commit log.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    This project uses Semantic Versioning.



    It is SUGGESTED that the Semantic Versioning (SemVer) or Calendar Versioning (CalVer) version numbering format be used for releases. It is SUGGESTED that those who use CalVer include a micro level value. [version_semver]


    It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags]

    This project uses Semantic Versioning, with each release being signed and tagged with the project owner's PGP key (including a description of the changes for that release).


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    Non-trivial release notes file in repository: https://github.com/opencontainers/umoci/blob/master/CHANGELOG.md.



    The release notes MUST identify every publicly known run-time vulnerability fixed in this release that already had a CVE assignment or similar when the release was created. This criterion may be marked as not applicable (N/A) if users typically cannot practically update the software themselves (e.g., as is often true for kernel updates). This criterion applies only to the project results, not to its dependencies. If there are no release notes or there have been no publicly known vulnerabilities, choose N/A. [release_notes_vulns]

    This project does not have any publicly known vulnerabilities, however as stated in https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md including such notices will be part of the review process.


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

    Users may submit issues through the GitHub issue tracking system https://github.com/opencontainers/umoci/issues.



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

    Users may submit issues through the GitHub issue tracking system https://github.com/opencontainers/umoci/issues.



    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    This can be seen by the current state of https://github.com/opencontainers/umoci/issues.



    The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive). [enhancement_responses]

    This can be seen by the current state of https://github.com/opencontainers/umoci/issues.



    The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive]

    Users may submit issues through the GitHub issue tracking system https://github.com/opencontainers/umoci/issues, which includes a full archive of all issues.


  • Vulnerability report process


    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    This information is included in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md.



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    This information is included in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md.



    The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response]

    There have been no vulnerability reports received in the last 6 months.


  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]

    Non-trivial build file in repository: https://github.com/opencontainers/umoci/blob/master/Makefile.



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Non-trivial build file in repository: https://github.com/opencontainers/umoci/blob/master/Makefile.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    This project uses the Go compiler, and various tools such as make and bash scripts that make up part of a normal GNU installation.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    This bats uses two test suites. Unit tests are tested using the standard Go language test functionality https://golang.org/pkg/testing/, and integration tests are run through the bats test suite https://github.com/bats-core/bats-core. Both are free software.



    A test suite SHOULD be invocable in a standard way for that language. [test_invocation]

    The test suite can be invoked from the project's Makefile https://github.com/opencontainers/umoci/blob/master/Makefile which uses the standard go testing tool for unit tests and runs the bats testing tool for integration tests.



    It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. [test_most]

    As part of our testing, we generate a line coverage profile for the entire project https://www.cyphar.com/blog/post/golang-integration-coverage. The total percentage of tested lines of code is currently >80% https://travis-ci.org/opencontainers/umoci/jobs/221181536#L1846-L2074, with plans to improve this in the future.

    In addition, we test against a large variety of images to ensure that our code correctly handles different distribution idiosyncrasies correctly and safely.



    It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). [test_continuous_integration]

    This project makes use of the free software CI system Travis https://travis-ci.org/opencontainers/umoci, and the actual test framework is the free software project bats https://github.com/bats-core/bats-core.


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    This policy is described in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md.



    The project MUST have evidence that the test_policy for adding tests has been adhered to in the most recent major changes to the software produced by the project. [tests_are_added]

    All releases have their test runs publicly visible from our CI system https://travis-ci.org/opencontainers/umoci. All releases and commits to master have their test output publicly accessible at https://travis-ci.org/github/opencontainers/umoci/builds.



    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    This information is included in the project's CONTRIBUTING.md file https://github.com/opencontainers/umoci/blob/master/CONTRIBUTING.md.


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    The Go compiler does not emit warnings, and we use several linters to further ensure the sanity of our tools https://github.com/opencontainers/umoci/blob/v0.4.0/Makefile#L91. All of the linters (golint, gofmt, govet) we use are free software.



    The project MUST address warnings. [warnings_fixed]

    The Go compiler does not emit warnings, and our test suite will automatically fail if any of the linters we use produce warnings https://github.com/opencontainers/umoci/blob/v0.4.0/Makefile#L91.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    The Go compiler does not emit warnings, and our test suite will automatically fail if any of the linters we use produce warnings.


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    One of the primary developers (Aleksa Sarai) has previously engaged in security research and is aware of various design principles necessary in the design of secure software.



    At least one of the project's primary developers MUST know of common kinds of errors that lead to vulnerabilities in this kind of software, as well as at least one method to counter or mitigate each of them. [know_common_errors]

    One of the primary developers (Aleksa Sarai) has previously engaged in security research and is aware of errors that can result in security vulnerabilities related to umoci, and knows how to mitigate and counter such errors. We provide information on our security design decisions in https://umo.ci/reference/security/.


  • 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 software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    This tool makes use of the sha256 and several other hashing algorithms, which have all been implemented by Google as part of the Go standard library. Those libraries has been reviewed and tested by third parties.



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    This tool makes use of the sha256 and several other hashing algorithms, which have all been implemented by Google as part of the Go standard library. Those libraries has been reviewed and tested by third parties.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    This tool makes use of the sha256 and several other standard hashing algorithms, which have all been implemented by Google as part of the Go standard library as free software. Those libraries has been reviewed and tested by third parties.



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    This project does not use public key cryptography.



    The default security mechanisms within the software produced by the project MUST NOT depend on broken cryptographic algorithms (e.g., MD4, MD5, single DES, RC4, Dual_EC_DRBG), or use cipher modes that are inappropriate to the context, unless they are necessary to implement an interoperable protocol (where the protocol implemented is the most recent version of that standard broadly supported by the network ecosystem, that ecosystem requires the use of such an algorithm or mode, and that ecosystem does not offer any more secure alternative). The documentation MUST describe any relevant security risks and any known mitigations if these broken algorithms or modes are necessary for an interoperable protocol. [crypto_working]

    This tool makes use of the sha256 and several other standard hashing algorithms which are still considered to be secure. In addition, the algorithms used are mandated by the OCI specification.



    The default security mechanisms within the software produced by the project SHOULD 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]

    This tool makes use of the sha256 and several other standard hashing algorithms which are still considered to be secure. In addition, the algorithms used are mandated by the OCI specification.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    This project does not use public key cryptography.



    If the software produced by the project causes the storing of 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). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    This project does not use involve the storage of passwords.



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    This project does not use public key cryptography.


  • Secured delivery against man-in-the-middle (MITM) attacks


    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    All project releases are delivered over SSL https://github.com/opencontainers/umoci/releases and have been signed with the main developers PGP key.



    A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned]

    All project releases are delivered over SSL https://github.com/opencontainers/umoci/releases and have been signed with the main developers PGP key.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    Currently there are no publicly known vulnerabilities in umoci.



    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    Currently there are no publicly known vulnerabilities in umoci.


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    To this date no credentials have been leaked in the main repository, and we have a policy to immediately invalidate any credentials if they have been leaked.


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    Every commit in the project has several static analysis tools applied (govet, golint) as part of the CI process. All failures will result in code not being acceptable for merging. In future, we intend to run even more static analysis tools on each commit such as those listed in https://github.com/mre/awesome-static-analysis#go.



    It is SUGGESTED that at least one of the static analysis tools used for the static_analysis criterion include rules or approaches to look for common vulnerabilities in the analyzed language or environment. [static_analysis_common_vulnerabilities]

    govet is specifically written to look for "suspicious constructs" https://golang.org/cmd/vet/. In addition, we use gosec to find potential security issues (such as not checking error values). https://github.com/securego/gosec/.



    All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed. [static_analysis_fixed]

    Every commit in the project has several static analysis tools applied (govet, golint) as part of the CI process. All failures will result in code not being acceptable for merging. In future, we intend to run even more static analysis tools on each commit such as those listed in https://github.com/mre/awesome-static-analysis#go.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]

    Every commit in the project has several static analysis tools applied (govet, golint) as part of the CI process. All failures will result in code not being acceptable for merging. In future, we intend to run even more static analysis tools on each commit such as those listed in https://github.com/mre/awesome-static-analysis#go.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    It is SUGGESTED that 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) 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]

    Go is not a memory unsafe language.



    It is SUGGESTED that the project use a configuration for at least some dynamic analysis (such as testing or fuzzing) which enables many assertions. In many cases these assertions should not be enabled in production builds. [dynamic_analysis_enable_assertions]

    We have various forms of validation (most notably relating to checksum mismatches), and our test suite validates that such attacks are being correctly detected. However, since we do not have any dynamic analysis suite (our test suite only checks statement coverage not branch coverage), this requirement is technically not met.



    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis MUST be fixed in a timely way after they are confirmed. [dynamic_analysis_fixed]

    We do not run any such tools at this time.



This data is available under the Creative Commons Attribution version 3.0 or later license (CC-BY-3.0+). All are free to share and adapt the data, but must give appropriate credit. Please credit Aleksa Sarai and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Aleksa Sarai.
Entry created on 2017-07-02 06:46:40 UTC, last updated on 2020-06-29 03:43:04 UTC. Last achieved passing badge on 2017-07-02 13:10:18 UTC.

Back