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 Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 17/17 ●

  • Identification

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

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST 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.


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    DCO required for all pull requests: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    https://toc.hyperledger.org/


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    https://github.com/hyperledger/fabric-gateway/blob/main/CODE_OF_CONDUCT.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    https://github.com/hyperledger/fabric-gateway/blob/main/MAINTAINERS.md


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    Project has more than one maintainer, and Hyperledger Foundation staff are able to administer the project in their absence. https://toc.hyperledger.org/governing-documents/inactivity.html


    Enough for a badge!

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

    Two maintainers have broad knowledge of the codebase. Several other significant contributors have a good knowledge. The project is developed with a "clean code" approach with a focus on simplicity, readability and maintainability of the code. Comprehensive unit tests specify behaviour and inform contributors. https://github.com/hyperledger/fabric-gateway/blob/main/MAINTAINERS.md


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    The projects sits under the umbrella of the wider Hyperledger Fabric project. The overall roadmap is documented at https://wiki.hyperledger.org/display/fabric/Hyperledger+Fabric+Roadmap


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    The project provides libraries to be used by consuming application, not standalone software. However, an overall architecture document and initial design (RFC) are published. https://hyperledger-fabric.readthedocs.io/en/latest/gateway.html https://hyperledger.github.io/fabric-rfcs/text/0000-fabric-gateway.html


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    The security model for the overall Hyperledger Fabric system is published at https://hyperledger-fabric.readthedocs.io/en/latest/security_model.html


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    https://hyperledger.github.io/fabric-gateway/


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    Documentation is generated from content within the source code repository. Documentation is updated alongside any code changes.


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]

    Badges are included in the repository README.md: https://github.com/hyperledger/fabric-gateway


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    Project is hosted on GitHub and leverages GitHub's accessibility features. The published documentation use Material for MkDocs, which has accessibility as one of its design principles.


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    Error messages generated by the project use only English language. However, the project provides a library intended only for programmatic usage by consuming applications. It is the responsibility of the consuming application to provide appropriate localization.


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    Repository access is controlled by GitHub key-based authentication. No credentials are stored in the repository itself.


  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    The project maintains only the most current release version but version-to-version compatibility is maintained. Semantic versioning is used to communicate this compatibility.


  • Bug-reporting process


    Enough for a badge!

    The project MUST 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.


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    No vulnerabilities reported. https://github.com/hyperledger/fabric-gateway/security/advisories


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    https://github.com/hyperledger/fabric-gateway/security/policy


  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    Guidance on coding style is provided in the contributing guide: https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md. Coding style is also codified in linting rules.


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    Rigorous linting and static analysis enforces a comprehensive set of code style rules at build time. These checks can be easily run locally by contributors, and are required to pass for all code changes.


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    The project delivers libraries to be used by consuming applications. No native binaries are produced.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    The project delivers libraries for use by consuming applications.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    The project delivers libraries for use by consuming applications.


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    Compilation of TypeScript to JavaScript, and Java to bytecode is carried out by a repeatable, automated build system. The versions and flags used are encoded in the project source and maintained in source control. This is a repeatable process.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    The project delivers libraries for use by consuming applications. Go, Node.js and Java provide standard tools and mechanisms for adding or removing dependencies in consuming applications.


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    The project delivers libraries for use by consuming applications.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    The project content is entirely contained within the source repository. The README file describes prerequisite tools and their versions. Additionally, the project provides a Dev Container definition that allows the entire development environment and all prerequisite tools to be created within a Docker container.


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    Standard Go module, Node.js (NPM) and Java (Maven) project definitions describe all dependencies. https://github.com/hyperledger/fabric-gateway/blob/main/go.mod https://github.com/hyperledger/fabric-gateway/blob/main/node/package.json https://github.com/hyperledger/fabric-gateway/blob/main/java/pom.xml


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    Daily scheduled vulnerability scans are run. Multiple vulnerability scanning tools are employed, including OSV-Scanner, Govulncheck, Sonatype Nancy, NPM audit and OWASP Dependency-Check.


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    Project dependencies (and their versions) are codified using language-specific mechanisms for Go, Node.js (NPM) and Java (Maven).


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    Project dependencies and language versions are actively updated to stay current. Linting and strict compiler flags highlight any usage of deprecated functions.


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    Extensive automated testing is required to pass on every code change.


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    All code changes must be accompanied by appropriate automated tests.


    Enough for a badge!

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

    Code coverage is collected for Go, Node (Jest) and Java (Jacoco) unit test suites. All are above 80%.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    The contributing guide states that code changes should include accompanying tests (and documentation): https://github.com/hyperledger/fabric-gateway/blob/main/CONTRIBUTING.md


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [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


    Enough for a badge!

    Projects MUST 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


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    The project intentionally avoids direct access to cryptographic credentials, accessing cryptographic operations through pluggable APIs. Security is required and enforced by downstream APIs with which this project interacts. In addition to code review with security in mind, static analysis tooling (such as gosec) is used within the build process to aid identification of potential issues.


  • 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 default security mechanisms within the software produced by the project MUST 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.


    Enough for a badge!

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    The cryptographic implementation used is pluggable and specified by the consuming application. Several out-of-the-box implementations are provided for use, including P-256, P384 and Ed25519 for signing, and SHA-2 (SHA-256, SHA-384) and SHA3 (SHA3-256, SHA3-384) for hashing.


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    The project uses a signing implementation function provided by the consuming application. The project code does not make use of private keys directly. The consuming application has responsibility for how authentication credentials are stored.


    Enough for a badge!

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

    The project makes use of gRPC connections with TLS authentication supplied by the consuming application. It is the responsibility of the consuming application to configure appropriate authentication settings on the connection.


    Enough for a badge!

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

    TLS version support is provided by gRPC: https://grpc.io/docs/guides/auth/


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    TLS certificate verification is carried out by gRPC and is out of scope of the project itself.


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    TLS certificate verification is carried out by gRPC as part of the initial establishment of a connection and is out of scope of the project itself.


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    Release artifacts are published to the public NPM registry and Maven Central repository. Both of these include their own signing mechanisms.


    Enough for a badge!

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    https://github.com/hyperledger/fabric-gateway/tags


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    Inputs are used to build API requests. The content is validated at the server end of the API request.


    Enough for a badge!

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

    Strict compiler options and linting are used to enforce safe data access.


    Enough for a badge!

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

    https://hyperledger-fabric.readthedocs.io/en/latest/security_model.html


  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]

    gosec, CodeQL


  • Dynamic code analysis


    Enough for a badge!

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



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