Smarta Byar Smart Village

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

    Red Hat Global Social Innovation Program is partnering with Boston University and Smarta Byar in order to collaborate on creating a global and open research platform allowing researchers to study what social sustainability means by using a digital twin of Veberöd, Sweden as the test village, supported by Smarta Byar.

    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]

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

    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 GPL-3.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 GPL-3.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/computate-org/smartabyar-smartvillage/blob/main/LICENSE.


  • Documentation


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

    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. https://github.com/computate-org/smartabyar-smartvillage/issues

    There is a public mailing list for Smart Village Project where you can start a discussion about proposed changes and issues: https://computate.topicbox.com/groups/smartabyar-smartvillage



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

    The documentation for Smart Village Project is in English: https://github.com/computate-org/smartabyar-smartvillage/blob/main/README.md

    Additional documentation in English can be found in the articles on the home page of the public website for Smart Village Project here: https://smartvillage.computate.org



    The project MUST be maintained. [maintained]

    The Smart Village Project is actively maintained, as seen in the frequency of commits in the main branch here: https://github.com/computate-org/smartabyar-smartvillage/commits/main



(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. https://github.com/computate-org/smartabyar-smartvillage



    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. See the changes made to the main branch of Smart Village Project here: https://github.com/computate-org/smartabyar-smartvillage/commits/main 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]

    You can find every commit in the main branch of Smart Village Project leading up to a final release here: https://github.com/computate-org/smartabyar-smartvillage/commits/main



    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. https://github.com/computate-org/smartabyar-smartvillage 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]

    The Smart Village Project has unique versions of each release, see: https://github.com/computate-org/smartabyar-smartvillage/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 of Smart Village Project also corresponds to a tag in GitHub, see the tags here: https://github.com/computate-org/smartabyar-smartvillage/tags


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

    The Smart Village Project provides a human-readable summary of major changes in each release, see: https://github.com/computate-org/smartabyar-smartvillage/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]

    See the list of vulnerabilities fixed in the release notes of Smart Village Project here: https://github.com/computate-org/smartabyar-smartvillage/releases


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

    There is a public mailing list for Smart Village Project where you can submit bug reports: https://computate.topicbox.com/groups/smartabyar-smartvillage

    The issues page on GitHub for Smart Village Project is another place to submit bug reports: https://github.com/computate-org/smartabyar-smartvillage/issues



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

    The issue tracker is on GitHub for Smart Village Project here: https://github.com/computate-org/smartabyar-smartvillage/issues



    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]

    You can review the open issues on GitHub for Smart Village Project here: https://github.com/computate-org/smartabyar-smartvillage/issues



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

    You can review the enhancement requests on GitHub for Smart Village Project here: https://github.com/computate-org/smartabyar-smartvillage/issues



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

    There is a public mailing list for Smart Village Project has a complete archive of messages: https://computate.topicbox.com/groups/smartabyar-smartvillage

    The issues page on GitHub for Smart Village Project has a complete archive of issues: https://github.com/computate-org/smartabyar-smartvillage/issues


  • Vulnerability report process


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

    There is a security policy in place for Smart Village Project where you can email a vulnerability privately to the owner of the project: https://github.com/computate-org/smartabyar-smartvillage/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]

    There is a security policy in place for Smart Village Project where you can email a vulnerability privately to the owner of the project: https://github.com/computate-org/smartabyar-smartvillage/security/policy



    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]

    There is a security policy in place for Smart Village Project where you can email a vulnerability privately to the owner of the project who will review the vulnerability: https://github.com/computate-org/smartabyar-smartvillage/security/policy


  • 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/computate-org/smartabyar-smartvillage/blob/main/pom.xml.

    There is a container image build system using the Dockerfile in Smart Village Project on quay.io. See the automatically built tags and latest tag based on the latest from the main branch: https://quay.io/repository/computateorg/smartabyar-smartvillage?tab=tags

    There is also a Java CI with Maven build action for Smart Village Project on GitHub. It compiles the code and runs the tests and reports Success or Failure, errors, and warnings: https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/maven.yml

    Each release of the project is also built for Maven Central. For all the details about the dependencies, vulnerabilities and more see the Maven Repository on Maven Central for Smart Village Project here: https://mvnrepository.com/artifact/org.computate/smartabyar-smartvillage/latest



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

    Non-trivial build file in repository: https://github.com/computate-org/smartabyar-smartvillage/blob/main/pom.xml.

    Quay is a container image registry that enables you to build, organize, distribute, and deploy containers. Quay gives you security over your repositories with image vulnerability scanning and robust access controls. Project Quay provides a scalable open source platform to host container images across any size organization. See: https://www.projectquay.io/

    The Java CI with Maven build action provided by GitHub is also open source. https://github.com/actions/starter-workflows/blob/main/ci/maven.yml



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

    Quay is a container image registry that enables you to build, organize, distribute, and deploy containers. Quay gives you security over your repositories with image vulnerability scanning and robust access controls. Project Quay provides a scalable open source platform to host container images across any size organization. See: https://www.projectquay.io/

    The Java CI with Maven build action provided by GitHub is also open source. https://github.com/actions/starter-workflows/blob/main/ci/maven.yml


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

    A developer can run the automated test suite locally for Smart Village Project with Maven. Building the project with tests is described in the README here: https://github.com/computate-org/smartabyar-smartvillage#running-the-project-build-and-test-suite

    There is a container image build system using the Dockerfile in Smart Village Project on quay.io. See the automatically built tags and latest tag based on the latest from the main branch: https://quay.io/repository/computateorg/smartabyar-smartvillage?tab=tags

    There is also a Java CI with Maven build action for Smart Village Project on GitHub. It compiles the code and runs the tests and reports Success or Failure, errors, and warnings: https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/maven.yml

    Each release of the project is also built for Maven Central. For all the details about the dependencies, vulnerabilities and more see the Maven Repository on Maven Central for Smart Village Project here: https://mvnrepository.com/artifact/org.computate/smartabyar-smartvillage/latest



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

    Invocable with mvn clean install



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

    This is still a work-in-progress for the project.



    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]

    There is a container image build system using the Dockerfile in Smart Village Project on quay.io. See the automatically built tags and latest tag based on the latest from the main branch: https://quay.io/repository/computateorg/smartabyar-smartvillage?tab=tags

    There is also a Java CI with Maven build action for Smart Village Project on GitHub. It compiles the code and runs the tests and reports Success or Failure, errors, and warnings: https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/maven.yml

    Each release of the project is also built for Maven Central. For all the details about the dependencies, vulnerabilities and more see the Maven Repository on Maven Central for Smart Village Project here: https://mvnrepository.com/artifact/org.computate/smartabyar-smartvillage/latest


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

    This is still a work-in-progress for Smart Village Project.



    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]

    This is still a work-in-progress for Smart Village Project.



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

    This is still a work-in-progress for Smart Village Project.


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

    A linter tool to look for code quality errors accomplished with the Super Linter Lint Code Base build action for Smart Village Project on GitHub. It is a simple combination of various linters, written in bash, to help validate your source code. https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/super-linter.yml



    The project MUST address warnings. [warnings_fixed]

    The Super Linter build tool is configured with it's default settings for Smart Village Project. See the configuration of the Super Linter build tool for Smart Village Project. https://github.com/computate-org/smartabyar-smartvillage/blob/main/.github/workflows/super-linter.yml

    See all the configuration options for the Super Linter here: https://github.com/github/super-linter#environment-variables



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

    The Super Linter build tool is configured with it's default settings for Smart Village Project. See the configuration of the Super Linter build tool for Smart Village Project. https://github.com/computate-org/smartabyar-smartvillage/blob/main/.github/workflows/super-linter.yml

    See all the configuration options for the Super Linter here: https://github.com/github/super-linter#environment-variables


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

    See the principal developers for Smart Village Project like computate a Principal Software Consultant from Red Hat with a background in secure software here: https://github.com/computate-org/smartabyar-smartvillage/graphs/contributors



    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]

    See the principal developers for Smart Village Project like computate a Principal Software Consultant from Red Hat with a background in secure software and vulnerabilities here: https://github.com/computate-org/smartabyar-smartvillage/graphs/contributors


  • 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 website for Smart Village Project supports HTTPS using TLS with valid certificates as you can see here: https://smartvillage.computate.org

    The OpenAPI spec for Smart Village Project is using the strong standard openIdConnect scheme of the securitySchemes provided by the OpenAPI Spec for authentication, authorization, and role-based access control. See here: https://github.com/computate-org/smartabyar-smartvillage/blob/main/src/main/resources/webroot/openapi3-enUS.yml

    The authentication provider for Smart Village Project is Red Hat Single Sign On. Red Hat Single Sign-On (RH-SSO) provides Web single sign-on and identity federation based on SAML 2.0, OpenID Connect and OAuth 2.0 specifications. See here: https://smartvillage.computate.org/user



    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]

    This project is not implementing it's own cryptography.



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

    This project does not depend on cryptography of data.



    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]

    This project does not depend on cryptography of data.



    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]

    This project does not depend on cryptography of data.



    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]

    This project does not depend on cryptography of data.



    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]

    This project does not depend on cryptography of data.



    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 trusted authentication provider for Smart Village Project is Red Hat Single Sign On. Red Hat Single Sign-On (RH-SSO) provides Web single sign-on and identity federation based on SAML 2.0, OpenID Connect and OAuth 2.0 specifications. See here: https://smartvillage.computate.org/user



    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]

    This project does not depend on cryptography of data.


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

    The project website for Smart Village Project supports HTTPS using TLS with valid certificates as you can see here: https://smartvillage.computate.org



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

    This project does not depend on retrieving cryptographic hashes.


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

    This is still a work-in-progress for Smart Village Project.

    We have submitted a pull request to vertx-zookeeper that was merged to fix several of the current vulnerabilities in the project. We are waiting for these changes to be released in the right version of Vert.x supported by Red Hat GA. https://github.com/vert-x3/vertx-zookeeper/pull/130

    We have submitted a pull request to apache/curator to fix several of the current vulnerabilities in the project. https://github.com/apache/curator/pull/440



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

    This is still a work-in-progress for Smart Village Project.

    We have submitted a pull request to vertx-zookeeper that was merged to fix several of the current vulnerabilities in the project. We are waiting for these changes to be released in the right version of Vert.x supported by Red Hat GA. https://github.com/vert-x3/vertx-zookeeper/pull/130

    We have submitted a pull request to apache/curator to fix several of the current vulnerabilities in the project. https://github.com/apache/curator/pull/440


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

    All credentials for Smart Village Project are stored as Hashicorp vault data, environment variables, configuration files, or secrets that are not included in this project.


  • 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 code analysis is accomplished with the CodeQL build action for Smart Village Project on GitHub. It analyzes the Java code and reports Success or Failure, errors, and warnings: https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/codeql.yml



    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]

    The CodeQL static code analysis tests for security vulnerabilities, bugs, and other errors, and supports Java code. See the About CodeQL documentation to learn more. https://codeql.github.com/docs/codeql-overview/about-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]

    See that the medium and higher severity vulnerabilities are resolved for Smart Village Project on GitHub. https://github.com/computate-org/smartabyar-smartvillage/actions/workflows/codeql.yml



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

    Static code analysis is enabled on every commit to the main branch. See the configuration here: https://github.com/computate-org/smartabyar-smartvillage/blob/main/.github/workflows/codeql.yml


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

    This is still a work-in-progress for Smart Village 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]

    This is still a work-in-progress for Smart Village Project.



    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]

    This is still a work-in-progress for Smart Village Project.



    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]

    This is still a work-in-progress for Smart Village Project.



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

Project badge entry owned by: Christopher Tate.
Entry created on 2022-12-19 19:44:55 UTC, last updated on 2022-12-19 20:05:02 UTC.

Back