pointblank

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 4310 is passing Here is how to embed it:

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

        

 Basics 4/5 ●

  • Identification

    The pointblank R package lets people easily validate data in data frames, 'tibble' objects, Spark DataFrames, and database tables (e.g., 'PostgreSQL' and 'MySQL'). Validation pipelines can be made using easily-readable, consecutive validation steps. Upon execution of the validation plan, several reporting options are available. The package also facilitates an information management workflow, where the aim is to record, collect, and generate useful information on data tables.

  • Prerequisites


    Not enough for a badge.

    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    Enough for a badge!

    The project MUST have a "bus factor" of 2 or more. (URL required) [bus_factor]

    There are currently two authors involved in the project (https://github.com/rich-iannone/pointblank/blob/18688d816c23651682bb83e5e41d0591880d16c1/DESCRIPTION#L13).


    Enough for a badge!

    The project MUST have at least two unassociated significant contributors. (URL required) [contributors_unassociated]

    There are currently two unassociated significant contributors involved in the project (https://github.com/rich-iannone/pointblank/blob/18688d816c23651682bb83e5e41d0591880d16c1/DESCRIPTION#L13).


  • Other


    Enough for a badge!

    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

    Each source file contains information on the copyright holder and also a brief license statement (with a link to the full license information). An example is available at: https://github.com/rich-iannone/pointblank/blob/master/R/interrogate.R


  • Public version-controlled source repository


    Enough for a badge!

    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

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


    Enough for a badge!

    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]

    Each issue in the Issues page is labeled and certain issue may be labeled with ‘Help Wanted’. Further to this, the predicted difficulty of working on an issue (which could be a big fix, a new feature, documentation, etc.) and the predicted effort level are given as separate labels. In this way, potential contributors could filter the issues list to those that require help by difficulty and effort level. An example of an issue with these labels is https://github.com/rich-iannone/pointblank/issues/16.


    Unknown required information, not enough for a badge.

    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]

    Unknown required information, not enough for a badge.

    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]

  • Coding standards


    Unknown required information, not enough for a badge.

    The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) [code_review_standards]

    Unknown required information, not enough for a badge.

    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

  • Working build system


    Enough for a badge!

    The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible]

    R packages are built during installation and reproducibility for this (along with quality checks) is done through GitHub actions (https://github.com/rich-iannone/pointblank/actions?query=workflow%3AR-CMD-check) for every commit and through CRAN’s automated build/check system (https://cran.r-project.org/web/checks/check_results_pointblank.html) for every release.


  • Automated test suite


    Enough for a badge!

    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]

    The tests are in the standard format for R packages. Using the testthat package (http://github.com/r-lib/testthat), it is easy to run the tests. Standard R package quality checks run these tests, as do testthat::test_package() and devtools::test(). This is the de facto standard for R packages.


    Enough for a badge!

    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]

    The pointblank package uses GitHub Actions to run R CMD check (a comprehensive set of tests for the package) with each commit and pull request (https://github.com/rich-iannone/pointblank/actions?query=workflow%3AR-CMD-check). Merging doesn't typically occur unless all CI checks pass.


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage90]

    One of the GitHub Actions workflows checks for code coverage from the test suite and sends the report to a third-party for further reporting and badge generation. We display the code coverage badge on the project README. Code coverage through this test suite does provide at least 90% coverage and it is a policy to have code coverage be above 90% at all times.


    Unknown required information, not enough for a badge.

    The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_branch_coverage80]

  • 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 software produced by the project MUST 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 MUST 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]

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.


    Enough for a badge!

    The software produced by the project MUST, 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]

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.


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


    Not enough for a badge.

    The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site]

    // X-Content-Type-Options was not set to "nosniff".


  • Other security issues


    Unknown required information, not enough for a badge.

    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]

    Enough for a badge!

    Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. (URL required) [hardening]

    This is out of scope for pointblank and other R packages that do not explicitly focus on privacy and security.


  • Dynamic code analysis


    Enough for a badge!

    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]

    The lintr package (https://github.com/jimhester/lintr) is invoked by a GitHub Actions workflow (https://github.com/rich-iannone/pointblank/blob/main/.github/workflows/lint.yaml) for every commit and pull request. If any lints are found, the maintainer is notified via email and CI correspondingly fails. This status is also transparent in the 'lint' badge shown in the project repository README.md (on GitHub) and in the project website (https://rich-iannone.github.io/pointblank/).


    Enough for a badge!

    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]

    Dynamic analysis is not required for pointblank. This is true for all R packages that are implemented entirely in R (without uses of C, C++, etc.).



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 Richard Iannone and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Richard Iannone.
Entry created on 2020-09-30 13:14:57 UTC, last updated on 2022-02-02 03:54:59 UTC. Last achieved passing badge on 2020-09-30 14:41:58 UTC.

Back