WireCloud

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

    Widgets Container and Mashup edition tools. Reference implementation of the FIWARE Application Mashup GE

    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://github.com/Wirecloud/wirecloud


    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://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md


    Enough for a badge!

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

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.


    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://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md


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

    The AGPL-3.0-or-later 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]

    // Did not find license in the OSI list. The AGPL-3.0-or-later 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/Wirecloud/wirecloud/blob/develop/LICENSE.


  • Documentation


    Enough for a badge!

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

    Some documentation basics file contents found.


    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://wirecloud.rtfd.io


  • Other


    Enough for a badge!

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

    Given only https: URLs.


    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]

    Enough for a badge!

    The project MUST be maintained. [maintained]


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



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


    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.


    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]

    Interim versions are put on git, not just final versions.


    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]

    The primary development team uses git commit records to identify releases. Regular umbrella releases aligned with the FIWARE Foundation.


    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]

    Git tags are created for each of the releases.


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

    CHANGELOG.md file is in top directory, see: https://github.com/Wirecloud/wirecloud/blob/develop/CHANGELOG.md. Changes are also provided as description in the release tag at GitHub.


    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]

    Documented in our release notes.


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

    Bug reports can be provided using the GitHub issue tracker: https://github.com/Wirecloud/wirecloud/issues


    Enough for a badge!

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

    Issue reports can be tracked using the GitHub issue tracker: https://github.com/Wirecloud/wirecloud/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]

    Yes. This is a requirement for membership of the FIWARE Foundation Catalogue


    Enough for a badge!

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

    The project has been responding to most enhancement requests.


    Enough for a badge!

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

    Yes, via GitHub issue tracker: https://github.com/Wirecloud/wirecloud/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]

    https://github.com/Wirecloud/wirecloud/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]

    https://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md


    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]

    No external reports so far, so this is vacuously true.


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

    Software uses python as main programming language, so it is not require to be built. Anyway, you can ensure all the dependencies are meet by using the requirements.txt file. Docker images and wheel packages (to be used by pip and pypi) can be build using the provided scripts.


    Enough for a badge!

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

    This project uses commons tools: Django tools, docker tools, ...


    Enough for a badge!

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

    WireCloud only uses FLOSS tools


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

    There is a ci_scripts provides scripts for running automated test suite, as also, the project provides documentation to manually passing all those tests if required.


    Enough for a badge!

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

    WireCloud uses common tools for running tests.


    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]

    Currently, tests are covering more than 83% of the code and we are increasing the coverage, including code branches.


    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]

    WireCloud is currently using Travis CI.


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

    Contributing guidelines (https://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md) states tests should be provided. Also, PR are connected to Travis CI and Coveralls, so we always check that coverage remains at the same level or increases.


    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]

    Releases notes provide this details.


    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]

    Contributing guidelines (https://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md) states tests should be provided.


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

    This project uses common linter tools like eslint, flake8, ... for those tasks.


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    In general warnings are addressed. In some cases warnings are disabled for specific cases.


    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]

    The settings for the warning tools are generally fairly strict.


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

    Álvaro Arranz assumes overall responsibility for this along with the development team.


    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]

    Álvaro Arranz assumes overall responsibility for this along with the development team. For a discussion of security requirements, common types of security vulnerabilities, and how this application counters those common kinds of vulnerabilities, see: https://github.com/Wirecloud/wirecloud/blob/develop/doc/security.md


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

    WireCloud delegates authentication to other components such as KeyRock, Keycloak, WSO2 Identity server.... These security components use strong encryption protocols and algorithms to store salted hashed iterated passwords and for storing user information and https+standard crypto protocols to communicate with users.

    WireCloud can also be used for authenticating users, in this case WireCloud uses Django's utils for storing passwords in a secure way. WireCloud also stores some sensitive data when configuring the access to third-party services. In this case WireCloud is using AES encryption to store it on hard disk. In any case, that sensitive information can only be used by the WireCloud's proxy service through secure channels and cannot be read back to the browser.

    Communication with users takes place using https+standard crypto protocols when correctly deployed.


    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]

    WireCloud is relaying on the already available cryptography tools and packages for managing data encryption.


    Enough for a badge!

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

    All required functionality is implemented using FLOSS, including cryptography.


    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]

    WireCloud is using AES-256 for sensitive data.

    Exact key lengths for the other aspects depends on the used component, but Django, KeyRock, KeyCloak, ... are currently using enough key lengths.


    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]

    WireCloud itself does not uses broken cryptographic algorithms. User can configure other services using broken protocols, WireCloud emphasize not to use them and to configure services using proper configurations.


    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]

    WireCloud does not depend on any algorithms or mode with known serious weaknesses at the present time.


    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]

    WireCloud itself is not using protocols requiring perfect forward secrecy, except for accessing HTTPS configured to do so. WireCloud HTTPS configuration should be configured to use perfect forward secrecy. WireCloud points to documentation explaining how to enable Perfect Forward Secrecy.


    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]

    Using Django tools that follows those criteria. OAuth2 tokens are stored in plain as provided by the auth server (server can provide encrypted tokens), but are short lived.


    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]

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

    Documentation states how to configure WireCloud to listen on https. Also, WireClouds connects to other services using https.


    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]

    Does not make this mistake.


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

    No such vulnerabilities at this time.


    Enough for a badge!

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

    No such vulnerabilities at this time.


  • 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 valid private credentials are leaked. Usernames and Passwords may be entered using Docker secrets and ENVs


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

    As noted in https://github.com/Wirecloud/wirecloud/blob/develop/docs/CONTRIBUTING.md, JavaScript client-side code is analyzed using ESLint. Python code is analysed using flake8. These analysis tools are used in local development, as well as the continuous integration server running on Travis CI


    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]

    ESLint specifically looks for common vulnerabilities in JavaScript applications.


    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]

    This is vacuously true, since we've had no reports of vulnerabilities that apply to a deployed system.


    Enough for a badge!

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

    All commits to GitHub are run through Travis, which performs a number of static analysis checks (ESLint, flake8, ...).


  • Dynamic code analysis


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

    Dynamic code analysis has not been applied


    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]

    WireCloud uses languages that are not affected by this.


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

    Instead of embedding run-time assertions, there are many external tests with assertions that are checked during automated testing.


    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]

    WireCloud is not running dynamic code analysis and thus have not found any vulnerabilities in this way.



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 Álvaro Arranz and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Álvaro Arranz.
Entry created on 2020-11-30 10:16:39 UTC, last updated on 2021-03-22 10:47:14 UTC. Last achieved passing badge on 2020-12-14 15:49:44 UTC.

Back