screwdriver

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 4689 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

    An open source build platform designed for continuous delivery.

    What programming language(s) are used to implement the project?

  • Basic project website content


    Enough for a badge!

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

    https://screwdriver.cd/ is the project landing page. It further links to detailed user guide, core team, and where to get support and further information.


    Enough for a badge!

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

    https://docs.screwdriver.cd/about/support has various avenues on how to reach out to Screwdriver community, report bug and further links on how to contribute


    Enough for a badge!

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

    Non-trivial contribution file in repository: https://github.com/screwdriver-cd/screwdriver/blob/master/CONTRIBUTING.md.


    Enough for a badge!

    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]

    https://docs.screwdriver.cd/about/contributing/index provides details on standards, formats for contribution pull requests, and where to get help.


  • FLOSS license

    What license(s) is the project released under?


    Enough for a badge!

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

    https://github.com/screwdriver-cd/screwdriver/blob/master/LICENSE The BSD-3-Clause license is approved by the Open Source Initiative (OSI).


    Enough for a badge!

    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]

    Project is Licensed under BSD 3-Clause license The BSD-3-Clause license is approved by the Open Source Initiative (OSI).


    Enough for a badge!

    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/screwdriver-cd/screwdriver/blob/master/LICENSE.


  • Documentation


    Enough for a badge!

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

    Detailed documentation is available at https://docs.screwdriver.cd/


    Enough for a badge!

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

    https://docs.screwdriver.cd/cluster-management/ Cluster management section of the documentation provides details on how a user can setup Screwdriver application at scale.


  • Other


    Enough for a badge!

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

    https://github.com/screwdriver-cd/ docs.screwdriver.cd/ // Given an http: URL.


    Enough for a badge!

    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.


    Enough for a badge!

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

    Documentation is in English https://docs.screwdriver.cd/ Bug reports taken via Github issues are also in English https://github.com/screwdriver-cd/screwdriver/issues


    Enough for a badge!

    The project MUST be maintained. [maintained]

    Issues in GitHub are regularly triaged and pulled into our backlog: https://github.com/screwdriver-cd/screwdriver/issues KanBan board can be seen here: https://github.com/screwdriver-cd/screwdriver/projects/4 Community info: https://github.com/screwdriver-cd/community



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



Screwdriver is an Open Source CI/CD platform born out of Yahoo! (now Verizon Media). It represents codification of learnings & best practices for building, testing, and deploying software at scale at Yahoo.

  • Public version-controlled source repository


    Enough for a badge!

    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.

    github.com/screwdriver-cd/


    Enough for a badge!

    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.

    github.com/screwdriver-cd/ Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.


    Enough for a badge!

    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]

    Every interim version is available as git tags/npm packages.


    Enough for a badge!

    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


    Enough for a badge!

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

    Each module/service/library for the project are built using Screwdriver with unique version. Npm libraries & Docker containers are using semver.


    Enough for a badge!

    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]

    Enough for a badge!

    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]

    Each library is built and published as npm package. Application as a whole is built and published as Docker containers.


  • Release notes


    Enough for a badge!

    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]

    Release notes are posted at https://blog.screwdriver.cd/


    Enough for a badge!

    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]

    We don't typically call out each vulnerability which gets fixed by dependency upgrade.


  • Bug-reporting process


    Enough for a badge!

    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]

    Using GitHub issues: https://github.com/screwdriver-cd/screwdriver/issues


    Enough for a badge!

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

    Using GitHub issues: https://github.com/screwdriver-cd/screwdriver/issues


    Enough for a badge!

    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]

    We sort and file issues using GitHub labels or comment on each issue


    Enough for a badge!

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

    Issues are sorted and triaged in a timely manner. They might be commented on or pulled into our backlog and actively worked on as well.


    Enough for a badge!

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

    Using GitHub issues: https://github.com/screwdriver-cd/screwdriver/issues


  • Vulnerability report process


    Enough for a badge!

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

    Instructions here: https://docs.screwdriver.cd/about/contributing/issues


    Enough for a badge!

    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]

    Private vulnerability reports are not supported


    Enough for a badge!

    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]

    We haven't received any specific vulnerability reports. However we take each and every bug report very seriously.


  • Working build system


    Enough for a badge!

    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]

    Project can be built locally for development here: https://docs.screwdriver.cd/about/contributing/getting-started-developing Project can be spun up using Kubernetes Helm Chart: https://docs.screwdriver.cd/cluster-management/helm.html


    Enough for a badge!

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

    See above


    Enough for a badge!

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

    See above


  • Automated test suite


    Enough for a badge!

    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]

    We have unit tests in every repo where appropriate and instructions on running them; examples below: https://github.com/screwdriver-cd/screwdriver#testing https://github.com/screwdriver-cd/models#testing https://github.com/screwdriver-cd/launcher#testing


    Enough for a badge!

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

    npm test go install -v ./... && go test -v ./..


    Enough for a badge!

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

    Include tests to improve coverage and prevent regressions. https://docs.screwdriver.cd/about/contributing/


    Enough for a badge!

    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]

    We have a repo for generating new repos with a template for testing, etc: https://github.com/screwdriver-cd/generator-screwdriver/tree/master/app/templates


  • New functionality testing


    Enough for a badge!

    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]

    We attempt to maintain or improve coverage percentage with each PR. Feature tests can be added here: https://github.com/screwdriver-cd/screwdriver/tree/master/features We also have an organization that stores most of our test repos: https://github.com/screwdriver-cd-test/


    Enough for a badge!

    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]

    Using Coveralls in API repo with automated commenting on PRs: https://coveralls.io/github/screwdriver-cd/screwdriver?branch=master


    Enough for a badge!

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

    See above


  • Warning flags


    Enough for a badge!

    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]

    Require "use strict" with our own eslint rules: https://github.com/screwdriver-cd/eslint-config-screwdriver


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    Screwdriver API project is capped at a maximum of 90 eslint warnings which is mainly for coding style and we are actively working to get that to 0. It's well within less than 1 warnings per 100 lines


    Enough for a badge!

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

    Show warnings when not too noisy (see above) Example: https://github.com/screwdriver-cd/ui/blob/master/package.json#L19


  • Secure development knowledge


    Enough for a badge!

    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]

    Screwdriver Project has a Security team who are tasked with looking into Secure Software Development Practices (https://docs.screwdriver.cd/about/security#team) More over Primary contributors to the project Verizon Media and Yahoo! Japan have their own internal Security teams who evaluate the product periodically for any vulnerabilities since it's used at enterprise scale within these organizations.


    Enough for a badge!

    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 Screwdriver project has a Security Team which includes several Screwdriver developers who have experience with working on security issues and provide documentation for other Jenkins developers on how to address common vulnerabilities. Screwdriver core maintainers and the release team are also represented on the Security team. https://docs.screwdriver.cd/about/security#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.

    Enough for a badge!

    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]

    The Screwdriver project uses standard open-source implementations of cryptographic protocols and algorithms. Examples: Implemented by node.js and open source libraries like jsonwebtoken for JWT, iron framework from hapi.js


    Enough for a badge!

    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]

    Screwdriver doesn't implement any cryptographic functions, rather it uses open source libraries like https://github.com/hapijs/iron


    Enough for a badge!

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

    Screwdriver as well as its dependencies are fully FLOSS.


    Enough for a badge!

    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]

    Screwdriver doesn't manage key lengths and instead rely on default's provided by underlying cryptography libraries. Encryption library iron uses AES 256 by default jsonwebtoken uses RS256 (RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm).


    Enough for a badge!

    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]

    Project does not use any broken or old algorithms; in libraries like @hapi.js/iron & jsonwebtoken, we don't specify/force them to use any old or unsupported algorithms.


    Enough for a badge!

    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]

    We don't use any security algorithms in underlying libraries that are insecure. We use defaults provided by the libraries and don't have any product use cases which needs a custom insecure one or changing the secure defaults. Insecure modes would be identified by our multi review process.


    Enough for a badge!

    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]

    In all use-cases we use the default forward secrecy provided by 3rd-party open-source libraries for handling https, ssh etc. We also use generated JWT tokens using a private signing key, which can be invalidated and rotated by a cluster admin either periodically or in response to a compromise.


    Enough for a badge!

    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]

    User/Pipeline Tokens as part of token generation uses PBKDF2 (provided by node.js crypto module & iron module)


    Enough for a badge!

    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]

    Screwdriver uses nodejs crypto module which is part of node.js runtime; we do not attempt to implement any generator on our own.


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


    Enough for a badge!

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

    Project uses https. And software is distributed over npm.js & DockerHub


    Enough for a badge!

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

    Screwdriver doesn't directly distribute hashes, but rely on npm.js & DockerHub


  • Publicly known vulnerabilities fixed


    Enough for a badge!

    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]

    We don't have any existing unpatched vulnerabilities which are known publicly.we do actively look into reports and fixes from automated tools like Snyk and Dependabot from Github and address vulnerabilities. https://docs.screwdriver.cd/about/security#past-security-issues


    Enough for a badge!

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

    Security Team https://docs.screwdriver.cd/about/security#team actively looks into any vulnerability reports and strives to fix them in a timely manner


  • Other security issues


    Enough for a badge!

    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]

    No public repositories under Screwdriver have any leaked credentials https://github.com/screwdriver-cd


  • Static code analysis


    Enough for a badge!

    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]

    Using Coveralls (https://coveralls.io/github/screwdriver-cd/screwdriver?branch=master) and SonarQube (https://sonar.screwdriver.cd)


    Enough for a badge!

    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]

    Using Greenkeeper, Snyk.io (https://app.snyk.io/org/screwdriver-cd), GitHub built-in dependabot


    Enough for a badge!

    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]

    We actively followup on vulnerability reports reported using static analysis tools like Snyk, Dependabot and make sure they are merged.


    Enough for a badge!

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

    See above tools list; tools are set to test weekly or daily


  • Dynamic code analysis


    Enough for a badge!

    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]

    https://cd.screwdriver.cd/ was onboarded to Detectify via VerizonMedia internal Security team and we do have scan reports, though not publicly available. This is not done as part of our CI/CD process but rather on-demand, we are exploring if we can make it part of our CI/CD process.


    Enough for a badge!

    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]

    Screwdriver uses Javascript & golang as its primary programming languages, which are both memory safe.


    Enough for a badge!

    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]

    Screwdriver does not use dynamic analysis tools as a part of the CI/CD pipeline. On the other hand, Screwdriver production clusters produce run-time events such as logs and metrics (via Prometheus) which are exposed to monitoring tools like Grafana and can be used for dynamic analysis.


    Enough for a badge!

    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 use dynamic analysis tools as a part of our CI/CD pipeline



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

Project badge entry owned by: Jithin Emmanuel.
Entry created on 2021-03-08 19:25:00 UTC, last updated on 2021-06-25 22:05:43 UTC. Last achieved passing badge on 2021-06-25 22:05:43 UTC.

Back