drake

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 2135 is passing 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

    The drake R package is a general-purpose workflow manager for data-driven tasks in R. drake rebuilds intermediate data objects when their dependencies change, and it skips work when the results are already up to date. Not every runthrough starts from scratch, and completed workflows have tangible evidence of reproducibility.

    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 main page at https://ropensci.github.io/drake provides motivating context and a user-friendly high-level overview.



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

    Installation instructions are at https://ropensci.github.io/drake/#installation, help and troubleshooting tips are at https://ropensci.github.io/drake/#help-and-troubleshooting, and https://ropensci.github.io/drake/#contributing and its subsections overview how to contribute.



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

    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]

    The pull request template at https://github.com/ropensci/drake/blob/master/.github/PULL_REQUEST_TEMPLATE.md has a checklist for incoming contributions.


  • FLOSS license

    What license(s) is the project released under?



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

    GPL-3 attribution: https://github.com/ropensci/drake/blob/ae914dae96c12b0030850388738bead900f83d89/DESCRIPTION#L14 The GPL-3.0-only 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 GPL-3.0-only 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]

    The DESCRIPTION file is the standard way to specify the license of an R package like drake. https://github.com/ropensci/drake/blob/ae914dae96c12b0030850388738bead900f83d89/DESCRIPTION#L14 declares a GPL-3 license. A GPL license for an R package does not need an explicit license file.


  • Documentation


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

    There is an extensive manual at https://ropenscilabs.github.io/drake-manual (development page: https://github.com/ropenscilabs/drake-manual) along with a plethora of resources linked from https://ropensci.github.io/drake/#documentation and its subsections.



    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 extensive manual at extensive manual at https://ropenscilabs.github.io/drake-manual go into detail about the interface, and help files at https://github.com/ropensci/drake/tree/master/man document and demonstrate every user-side function in full detail. The "man" folder is the standard way to document user-side functions and data objects in an R package.


  • Other


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

    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]

    The issue tracker (https://github.com/ropensci/drake/issues) and pull request page (https://github.com/ropensci/drake/pulls) are very active. See also the drake-r-package tag on Stack Overflow.



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

    Bug reports and discussion: https://github.com/ropensci/drake/pulls.



    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]

    The GitHub releases at https://github.com/ropensci/drake/releases include multiple interim development releases.



    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]

    The drake package follows the versioning guide at http://r-pkgs.had.co.nz/release.html#release-version, the community accepted variant of semantic versioning for R packages.



    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]

    Every release is at https://github.com/ropensci/drake/releases and each has a git/GitHub tag.


  • 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/ropensci/drake/blob/master/NEWS.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]
  • 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]

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

    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]

    The issue tracker has all the bug reports: https://github.com/ropensci/drake/issues



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

    The issue tracker has all the requested features, and the vast majority have been successfully implemented: https://github.com/ropensci/drake/issues



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

    The issue tracker at https://github.com/ropensci/drake/issues has the complete archive of all the reports and responses.


  • Vulnerability report process


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

    Vulnerabilities fall under bugs for this project. The place to report them is https://github.com/ropensci/drake/issues, and the contact information of the maintainer is at https://github.com/ropensci/drake/blob/master/DESCRIPTION.



    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]

    The contact information of the maintainer is at https://github.com/ropensci/drake/blob/master/DESCRIPTION.



    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]

    Responses to issues are much faster than 14 days. Please refer to the discussion logs at https://github.com/ropensci/drake/issues.


  • 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]

    The installation instructions at https://ropensci.github.io/drake/#installation demonstrate how to install the package from the source.



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

    As shown at https://ropensci.github.io/drake/#installation, drake can be installed like a typical R package.



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

    In accordance with the community standard, drake only requires formally released R packages on CRAN http://cran.r-project.org/ to install.


  • 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]

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

    The tests are in the standard format for R packages, and they are powered by testthat: http://github.com/r-lib/testthat. Standard R package quality checks run these tests, as do testthat::test_package() and devtools::test(). This is the community standard for R packages.



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

    The tests run by testthat::test_package()/devtools::test() under the default settings run nearly every line of code in nearly every use case of the package. The testing scenarios at https://github.com/ropensci/drake/tree/master/tests/scenarios run these tests in several high-performance computing scenarios in different environments.



    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]

    drake uses Travis CI and Appveyor CI to check each commit and pull request.


  • 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]

    Policy for new functionality: https://github.com/ropensci/drake/blob/master/.github/PULL_REQUEST_TEMPLATE.md. New tests for the functionality are added to the existing unit test suite, and these tests are checked with continuous integration in a pull request before being merged into the project.



    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]

    The pull requests https://github.com/ropensci/drake/pulls and commit history https://github.com/ropensci/drake/commits/master provide this evidence.



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

    The contribution instructions at https://github.com/ropensci/drake/blob/master/.github/PULL_REQUEST_TEMPLATE.md explicitly state the need for new tests in the checklist.


  • 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 lintr package https://github.com/jimhester/lintr is invoked by Travis CI https://github.com/ropensci/drake/blob/master/.travis.yml#L44 for every commit and pull request with successful tests. If any lints are found, a lint bot sends notifications to the GitHub page.



    The project MUST address warnings. [warnings_fixed]

    Travis CI and Appveyor CI detect warnings in installation and testing, and notifications are sent to the maintainer's email and the GitHub page.



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

    Both Travis CI and Appveyor CI are configured to fail if any warnings are detected in the package quality checks and tests: https://github.com/ropensci/drake/blob/master/.travis.yml#L44, https://github.com/ropensci/drake/blob/b03800e020b0396cfd76dfa4f01ce6d6609397a6/appveyor.yml#L52


  • 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]

    The code base is decomposed into small, uncomplicated functions, and all the user-side functions are documented thoroughly. Nearly the entire code base was written by the current primary maintainer, and incoming contributions are carefully reviewed line by line with a pull request mechanism. Any attempts to sabotage the code are easy to detect.



    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]

    The primary maintainer is highly proficient in R, the language of the implementation, and is able to recognize the errors that lead to vulnerabilities in R packages. Security vulnerabilities are likely to come from other R packages that drake depends on.


  • 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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



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

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



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.drake does not use its hashes for security purposes.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.



    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 is out of scope for drake and other R packages that do not explicitly focus on privacy and security.


  • 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]

    drake's websites (https://github.com/ropensci/drake, etc.) are protected with https.



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

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


  • 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]

    Please see the issue tracker for details: https://github.com/ropensci/drake/issues



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

    Please see the issue tracker for details: https://github.com/ropensci/drake/issues


  • 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]

    https://github.com/ropensci/drake is a completely public repository, and there are no limitations on the access to the package and its source code.


  • 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]

    The lintr package https://github.com/jimhester/lintr is invoked by Travis CI https://github.com/ropensci/drake/blob/master/.travis.yml#L44 for every commit and pull request with successful tests. If any lints are found, a lint bot sends notifications to the GitHub page.



    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]

    The lintr package https://github.com/jimhester/lintr is invoked by Travis CI https://github.com/ropensci/drake/blob/master/.travis.yml#L44 for every commit and pull request with successful tests. If any lints are found, a lint bot sends notifications to the GitHub page.



    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]

    All lints from lintr are promptly addressed after they are automatically discovered in the Travis CI builds and notifications are posted to the GitHub page and sent to the maintainer by email.



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

    The lintr package https://github.com/jimhester/lintr is invoked by Travis CI https://github.com/ropensci/drake/blob/master/.travis.yml#L44 for every commit and pull request with successful tests. If any lints are found, a lint bot sends notifications to the GitHub page.


  • 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]

    The lintr package https://github.com/jimhester/lintr is invoked by Travis CI https://github.com/ropensci/drake/blob/master/.travis.yml#L44 for every commit and pull request with successful tests. If any lints are found, a lint bot sends notifications to the GitHub page.



    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]

    drake does not use any memory-unsafe language. It is entirely implemented in R (with an example small shell script at https://github.com/ropensci/drake/blob/master/inst/shell.sh that has nothing to do with memory issues).



    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]

    dynamic analysis is not required for drake and other R packages that are implemented entirely in R (i.e. without C/C++/Fortran code, etc.)



    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]

    dynamic analysis is not required for drake and other R packages that are implemented entirely in R (i.e. without C/C++/Fortran code, etc.) Any related issues will be solved promptly after they are reported: https://github.com/ropensci/drake/issues.



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

Project badge entry owned by: Will Landau.
Entry created on 2018-08-24 03:11:56 UTC, last updated on 2018-08-24 04:07:56 UTC. Last achieved passing badge on 2018-08-24 04:07:56 UTC.

Back