Fabric Gateway client API

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

    Go, Node and Java client API for Hyperledger Fabric v2.4+

    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 project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software. [interact]

    Repository README linking to user documentation, reporting issues, requesting enhancements and contributing: https://github.com/hyperledger/fabric-gateway/#readme Go quickstart guide: https://github.com/hyperledger/fabric-gateway/blob/main/pkg/client/README.md Node (TypeScript / JavaScript) quickstart guide: https://github.com/hyperledger/fabric-gateway/blob/main/node/README.md Java quickstart guide: https://github.com/hyperledger/fabric-gateway/blob/main/java/README.md



    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/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md.



    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]

    "Contributing code" section of the contributing guide: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md#contributing-code Many code requirements are codified in the linting checks so contributors can see issues in their code before submitting changes.


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



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



    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/hyperledger/fabric-gateway/blob/main/LICENSE.


  • Documentation


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

    Homepage provides links to quickstart guides, API documentation, runnable sample applications, and migration guide: https://hyperledger.github.io/fabric-gateway/



    The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. [documentation_interface]
  • 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 documentation mentioned above (quickstart guides, API documentation, samples etc.) is provided in English. Bug reports are accepted in English via GitHub issues, as described in the CONTRIBUTING guide: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md



    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]

    Pull requests allow iterative collaborative review of code changes before they are accepted. Every code change is stored in the commit history and is publicly visible. Release versions are periodically tagged and published, and may contain many individual commits: https://github.com/hyperledger/fabric-gateway/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]

    SemVer stye versioning is used for releases. A specific release version applies to associated Go, Node (in the npm registry) and Java (in Maven Central) published artifacts: https://github.com/hyperledger/fabric-gateway/releases



    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]

    Each release has a corresponding Git tag: https://github.com/hyperledger/fabric-gateway/tags Automated build processes publish release artifacts based on the Git 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/hyperledger/fabric-gateway/blob/main/CHANGELOG.md. Release notes are recorded using GitHub releases: https://github.com/hyperledger/fabric-gateway/releases



    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]

    No vulnerabilities have been identified for this project. Release notes include vulnerabilities in dependencies that are resolved by dependency updates in a given release, for example: https://github.com/hyperledger/fabric-gateway/releases/tag/v1.2.2


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

    Bugs reports are submitted using GitHub issues, as described in the CONTRIBUTING guide: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md



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

    The project uses GitHub issues to track bugs and associated pull requests that resolve them.



    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]

    All issues are actively triaged, providing an appropriate combination of comments, issue tagging, and code changes.



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

    All enhancement requests are actively triaged. Enhancements are either appropriately tagged (as backlog items to be addressed by community contribution), resolved by a code enhancement, or closed as not accepted with accompanying comments.



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

    GitHub issues provide visibility of open and previously closed issues: https://github.com/hyperledger/fabric-gateway/issues


  • Vulnerability report process


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

    Security policy document is included in the repository's SECURITY.md file: https://github.com/hyperledger/fabric-gateway/security/policy



    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]

    As described in the security policy, private vulnerability reports are made using the GitHub repository's security advisory page: https://github.com/hyperledger/fabric-gateway/security/advisories



    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]

    No vulnerabilities reported.


  • 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/hyperledger/fabric-gateway/blob/main/Makefile. GitHub Actions for build automation: https://github.com/hyperledger/fabric-gateway/actions



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

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

    All build tools are open source or freely available. Required tools are documented in the project README: https://github.com/hyperledger/fabric-gateway#readme


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

    Complete unit and integration / scenario test suites are included in the repository source. Documentation on running tests is included in the project README: https://github.com/hyperledger/fabric-gateway#readme



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

    All tests are invoked using a Makefile, and are executed using standard frameworks for their corresponding language. The test frameworks used are documented in the CONTRIBUTING guide: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md



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

    Unit tests cover all functionality and have a very high level of branch coverage. Coverage data is collected on unit test runs. Scenario tests provide additional coverage of all key functionality in a real deployment environment.



    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]

    A complete set of automated tests is run on all code submissions before they are accepted: https://github.com/hyperledger/fabric-gateway/actions/workflows/pull_request.yml The complete set of tests is run again on integration of code changes to ensure consistency: https://github.com/hyperledger/fabric-gateway/actions/workflows/push.yml Additionally, a scheduled build runs on the current repository state to ensure compatibility with external components: https://github.com/hyperledger/fabric-gateway/actions/workflows/schedule.yml


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

    The CONTRIBUTING guide documents the requirement for all code submissions to have appropriate accompanying unit and scenario tests: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md This is enforced by project maintainers through the code review process.



    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]

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

    The CONTRIBUTING guide documents the requirement for all code submissions to have appropriate accompanying unit and scenario tests: https://github.com/hyperledger/fabric-gateway/blob/main/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]

    Several linting tools are used to check code correctness.

    Go: staticcheck, errcheck, gocognit, gocyclo, gofmt, goheader, goimports, gosec, gosimple, govet, ineffassign, misspell, typecheck, unused. Node: ESLint Java: PMD

    Compilers are set with strict options and warnings cause a build failure.



    The project MUST address warnings. [warnings_fixed]

    Warnings cause a build failure so code generating warnings fails pull request automated checks and cannot be merged.



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

    Compilers are set with strict options and linters are used aggressively, requiring an explicit documented exception in the code to allow any failing check.


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


    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]

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

    The project makes use of cryptographic signatures, and hashes required by those signatures, with the implementation being pluggable. Default signing implementations provided use ECDSA signatures with NIST-approved curves (P-256, P-384), and hashes (SHA-256, SHA-384, SHA3-256, SHA3-384).



    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]

    The project does not implement these signature and hashing schemes but instead uses publicly published and audited implementations.

    Go: Go standard crypto library. Node: @noble/curves (https://github.com/paulmillr/noble-curves) Java: Bouncy Castle (https://www.bouncycastle.org/java.html) and Java standard security framework.



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


    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]

    The signing and hashing implementations are pluggable and therefore are selected (and can be provided) by the calling application code. The default signing implementation provided by this project uses ECDSA signatures with NIST-approved P-256 curve and SHA-256 hash.



    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]

    The signing and hashing implementations are pluggable and therefore are selected (and can be provided) by the calling application code. The default signing implementation uses ECDSA signatures with NIST-approved P-256 curve and SHA-256 hash.



    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]

    The default signing implementation uses ECDSA signatures with NIST-approved P-256 curve and SHA-256 hash.



    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]

    The project makes use of gRPC connections configured and provided by the calling client application and is out of scope of this project. The key agreement protocol is dictated by the calling client application and the gRPC library capability. Typically this will be the latest TLS specification.



    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]

    The software does not store or have any access to 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]

    Nonces are generated using standard secure cryptographic libraries:

    Go: crypto/rand package from Go standard libraries Node: Node crypto package Java: java.security.SecureRandom from the standard Java library.

    The software does not generate cryptographic keys.


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

    Go code is released by tagging the Git repository, and is obtained by consumers using standard Go tools, which use Git and SSH.

    Node code is released as an npm package in the global npm registry. This uses HTTPS to publish and retrieve packages. Additionally, an auth token is required for publishing.

    Java code is released to the Maven Central repository. This uses HTTPS to publish and retrieve packages. Additionally, user credentials are required for publishing, and artifacts are signed with an approved GPG signature.



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

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

    No vulnerabilities have been reported against the project itself. Dependencies are scanned daily for vulnerabilities and updates applied promptly as required: https://github.com/hyperledger/fabric-gateway/actions/workflows/vulnerability-scan.yml



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

    No vulnerabilities have been reported.


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

    Private credentials used by the build process are stored as build secrets in GitHub Actions. These can only be set by repository administrators and their contents cannot be viewed. The build logs are redacted to ensure secrets are secured.


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

    Static analysis run on every code change and by scheduled builds.

    Go: staticcheck, errcheck, gofmt, goimports, gosec, gosimple, govet, ineffassign, typecheck, unused, CodeQL. Node: eslint, CodeQL. Java: checkstyle, CodeQL.



    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]

    gosec, CodeQL



    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]

    No vulnerabilities discovered.



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

    Most static analysis is carried out on every change, both before and after commit. CodeQL is run on a daily schedule.


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

    Automated test suite with at least 80% branch coverage applied to every code change and on a schedule. Fuzzing is not (yet) carried out.



    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, TypeScript and Java.



    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]

    Testing explicitly confirms conditions that would be asserted.



    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]

    No vulnerabilities discovered.



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 Mark S. Lewis and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Mark S. Lewis.
Entry created on 2023-04-28 09:18:28 UTC, last updated on 2024-07-31 18:02:43 UTC. Last achieved passing badge on 2023-04-28 13:39:40 UTC.

Back