grid2op

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 10367 is in_progress 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

    Grid2Op a testbed platform to model sequential decision making in power systems.

    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 "index" page of the documentation has, in my opinion this first description, see https://grid2op.readthedocs.io/

    A short description is also available on the readme: https://github.com/Grid2op/grid2op?tab=readme-ov-file#core-functionalities



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

    The project has a contribute.md file (see here https://github.com/Grid2op/grid2op/blob/master/CONTRIBUTING.md), active github issues (to provide or obtain feedback, bugs or enhancements) here https://github.com/Grid2op/grid2op/issues and a discord chanel (https://discord.gg/cYsYrPT, links on the readme of the project) for public announcements (new versions, new packages, etc.) and direct communication with the maintainer.



    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/Grid2op/grid2op/blob/master/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]
  • FLOSS license

    What license(s) is the project released under?



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

    The MPL-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 MPL-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/Grid2op/grid2op/blob/master/LICENSE.md.


  • Documentation


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

    Some documentation basics file contents found.



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

    There is a public documentation of more than 95% of the public function of grid2op available here: https://grid2op.readthedocs.io/en/latest/

    It contains also examples and "how to" to help people using the interfaces.

    This documentation is more than 700 a4 pages long when last checked.


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

    Documentation is hosted on "read the docs" () and people can submit issues through github issues here https://github.com/Grid2op/grid2op/issues. There are templates for bug report, enhancement or documentation issues.



    The project MUST be maintained. [maintained]


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



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    Repository on GitHub, which provides public git repositories with URLs.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.



    To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. [repo_interim]

    The "master" branch is equal to the last published version (the one available on pypi for example)

    There are also some "dev" branch, for example https://github.com/Grid2op/grid2op/tree/dev_1.11.0 which contain the code the for the next public release. This code is open to review and merge request should be made on this branch (NB this is the last development branch as of writing, this changes for each new release. For example when grid2op 1.11.0 will be finilized, the nex development branch will be dev_1.11.1 as explained in the CONTRIBUTING.md)

    There are also development branch for particular features (2 such branches exists, see https://github.com/Grid2op/grid2op/tree/dev-switches or https://github.com/Grid2op/grid2op/tree/dev_multiagent for example) The difference with the main branch is that these contains contain code that are not ready to be merged (because not fully specified, documented, nor tested but can be reviewed and used by grid2op users. This is the case for the multi-agent branch, see for example https://github.com/Grid2op/grid2op/pull/696 for the pull-request or https://github.com/Grid2op/grid2op/issues/613 for the related issue)



    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]

    Grid2op versions follow python core principles. Available version are on pypi, see, https://pypi.org/project/Grid2Op/#history



    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]

    It is done with git tags, see https://github.com/Grid2op/grid2op/tags (for tags) and https://github.com/Grid2op/grid2op/releases (for releases)


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

    Release notes are included in the github release (see eg https://github.com/Grid2op/grid2op/releases/tag/v1.10.5) and (most of the time) public annoucements are made in a discord post see eg https://discord.com/channels/698080905209577513/698133564381724764)



    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]

    There been no publicly known vulnerabilities yet.


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

    Bug reports are done using github issues (specific type of issues): https://github.com/Grid2op/grid2op/issues



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

    The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. [report_responses]

    See open github issues (https://github.com/Grid2op/grid2op/issues) (tag bug). As far as I know all of them have an answer. Bug reports are treated as soon as possible and merged in the code with the tag "[FIX]" on the changelog here https://github.com/Grid2op/grid2op/blob/master/CHANGELOG.rst, see eg https://github.com/Grid2op/grid2op/blob/master/CHANGELOG.rst#1104---2024-10-14 for a concrete example.

    This is available since the most early stage of grid (2019-11-28 is the first recorded date in the changelog)



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

    See open github issues https://github.com/Grid2op/grid2op/issues (tag enhancements). As far as I know, all of them have an answer. But not all of them are included in the codebase yet.



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

    Done thanks to github issues https://github.com/Grid2op/grid2op/issues (as far as I know no issues have been deleted)


  • Vulnerability report process


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

    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]

    It is explained in https://github.com/Grid2op/grid2op?tab=security-ov-file to sent them via e mail for critical and important security vulnerabilities.



    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 vulnerability has been reported as of writing


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

    Project is developed in "pure python", no build system is required.



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

    Project is developed in "pure python", which does not require any build. It can be installed with the standard "pip" command.



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

    Project is developed in "pure python", which does not require any build. It can be installed with the standard "pip" command.


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

    Each commit is tested on circle ci see https://app.circleci.com/pipelines/github/Grid2op/grid2op for different cases (depending on some the optional dependencies installed). More than 3000 tests are currently run automatically.

    Package is also tested using github actions https://github.com/Grid2op/grid2op/actions Tests there are lighter, but performed for different python versions and on different OS.



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

    The readme indicated how to run the tests of grid2op (see https://github.com/Grid2op/grid2op?tab=readme-ov-file#perform-tests-locally) which can be done with:

    cd grid2op/tests python3 -m unittest discover



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

    Tests are performed by circleci and github actions for all commits of all branches of the main repository.



    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]

    This is done with circleci and github actions.


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

    No building is required for grid2op (pure python)



    The project MUST address warnings. [warnings_fixed]

    No building is required for grid2op (pure python)



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

    No building is required for grid2op (pure python)


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

    Python standard library hashlib and urllib modules are used for such purpose anywhere appropriate.



    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]

    Python standard library hashlib and urllib modules are used for such purpose anywhere appropriate.



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

    Python standard library is FLOSS compliant.



    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]

    Default of the python standard library hashlib are not modified.



    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]

    Nothing of the sort is used within the project, project code is run on the user computer using the user resources.



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

    No such concepts are used withing the project, project code is run on the user computer using the user resources.



    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]

    No password are used by the software, project code is run on the user computer using the user resources.



    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]

    No keys are generated, project code is run on the user computer using the user resources.


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

    data are downloaded using https



    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]


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

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

    This is also automatically checked by github.


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

    2 such tools are actually used: - codacy - sonar cloud



    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]

    Done by both codacy and sonar cloud



    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 have been found yet.



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

    Codacy and sonarcloud are run for every merge request on every branch.


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

    Test coverage is not updated on codacy or sonarcloud (is it required ?) but it is higher than 95% for the entire project.



    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]

    Grid2op is python, which is a "memory safe" language



    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]

    There are no difference between "released package" and "dynamic analysis" in python. Lots of assertions are performed to validate user provided data in both tests and "production".



    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]

    All have been fixed



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Benjamin DONNOT and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Benjamin DONNOT.
Entry created on 2025-03-31 15:06:03 UTC, last updated on 2025-04-01 12:33:58 UTC. Last lost passing badge on 2025-04-01 12:33:58 UTC. Last achieved passing badge on 2025-04-01 09:37:55 UTC.

Back