Does the smartabyar-smartvillage project follow the Open Source Software Foundation Best Practices?
Review the OpenSSF Best Practices checklist for smartabyar-smartvillage.
Created Mon Oct 24 2022
By Christopher Tate
Red Hat Principal Software Consultant
Open Source Software Foundation
FLOSS Best Practices Criteria overview
Here is our Open Source Software Foundation offers a Best Practices Badge for Smart Village Project.
The Open Source Software Foundation offers a Best Practices Badge to projects following all the suggested standards below. See the FLOSS Best Practices Criteria here. Below is a summary of how Smart Village Project implements these standards.
Basics
Basic project website content
-
The project website MUST succinctly describe what the software does (what problem does it solve?):Here is the project summary page to review succinctly what the software does:
-
The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software:Here is the contribution page to review how to contribute to the software, see bug reports and enhancements, or submit bug reports and enhancements:
-
The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?):The how to contribute guide covers the contribution process and pull requests, see:
-
The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard):The how to contribute guide covers acceptable contributions and coding standards, see:
Basics
FLOSS license
-
The software produced by the project MUST be released as FLOSS.The license for Smart Village Project is the GNU GENERAL PUBLIC LICENSE and can be found here:See here that the GNU GENERAL PUBLIC LICENSE is listed as a FLOSS license:
-
It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI).The rest of the licenses of open source maven dependencies you can find here:
-
The project MUST post the license(s) of its results in a standard location in their source repository.The license for Smart Village Project is in our GitHub repository and can be found here:
Basics
Documentation
-
The project MUST provide basic documentation for the software produced by the project.The documentation for installing Smart Village Project locally and in the OpenShift cloud is available in the README here:Additional documentation can be found in the articles on the home page of the public website for Smart Village Project here:
-
The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project.The complete OpenAPI spec with inputs and outputs for Smart Village Project is available here:
Basics
Other
-
The project sites (website, repository, and download URLs) MUST support HTTPS using TLS.The project website for Smart Village Project supports HTTPS using TLS with valid certificates as you can see here:The repository for Smart Village Project also supports HTTPS using TLS with valid certificates as you can see here:The downloads for Smart Village Project also supports HTTPS using TLS with valid certificates as you can see here:
-
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.There is a public mailing list for Smart Village Project where you can start a discussion about proposed changes and issues:The issues page on GitHub for Smart Village Project is another place to start a discussion about proposed changes and issues:
-
The project MUST provide basic documentation for the software produced by the project.The documentation for Smart Village Project is in English:Additional documentation in English can be found in the articles on the home page of the public website for Smart Village Project here:
-
The project MUST be maintained.The Smart Village Project is actively maintained, as seen in the frequency of commits in the main branch here:
Change Control
Public version-controlled source repository
-
The project MUST have a version-controlled source repository that is publicly readable and has a URL.The Smart Village Project has a public, readable version-controlled source repository on GitHub here:
-
The project's source repository MUST track what changes were made, who made the changes, and when the changes were made.See the changes made to the main branch of Smart Village Project here:
-
To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases.You can find every commit in the main branch of Smart Village Project leading up to a final release here:
-
It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository.GitHub is the common distributed version control software for Smart Village Project, see here:
Change Control
Unique version numbering
-
The project results MUST have a unique version identifier for each release intended to be used by users.The Smart Village Project has unique versions of each release, see:
-
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.The Smart Village Project Semantic Versioning (major, minor, patch) each release. For example 1.0.0, see the releases here:
-
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.Each release of Smart Village Project also corresponds to a tag in GitHub, see the tags here:
Change Control
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".The Smart Village Project provides a human-readable summary of major changes in each release, see:
-
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.See the list of vulnerabilities fixed in the release notes of Smart Village Project here:
Reporting
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).There is a public mailing list for Smart Village Project where you can submit bug reports:The issues page on GitHub for Smart Village Project is another place to submit bug reports:
-
The project SHOULD use an issue tracker for tracking individual issues.The issue tracker is on GitHub for Smart Village Project here:
-
The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix.You can review the open issues on GitHub for Smart Village Project here:
-
The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive).You can review the enhancement requests on GitHub for Smart Village Project here:
-
The project MUST have a publicly available archive for reports and responses for later searching.There is a public mailing list for Smart Village Project has a complete archive of messages:The issues page on GitHub for Smart Village Project has a complete archive of issues:
Reporting
Vulnerability report process
-
The project MUST publish the process for reporting vulnerabilities on the project site.There is a security policy in place for Smart Village Project where you can email a vulnerability privately to the owner of the project:
-
If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept 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:
-
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.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:
Quality
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.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: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: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:
-
It is SUGGESTED that common tools be used for building the software.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:The Java CI with Maven build action provided by GitHub is also open source.
-
The project SHOULD be buildable using only 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:The Java CI with Maven build action provided by GitHub is also open source.
Quality
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).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: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: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: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:
-
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).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: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: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:
Quality
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.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.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.This is still a work-in-progress for Smart Village Project.
Quality
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.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.
-
The project MUST address warnings.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.See all the configuration options for the Super Linter here:
-
It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical.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.See all the configuration options for the Super Linter here:
Security
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.)See the principal developers for Smart Village Project like `computate` a Principal Software Consultant from Red Hat with a background in secure software here:
-
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.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:
Security
Use basic good cryptographic practices
-
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).The project website for Smart Village Project supports HTTPS using TLS with valid certificates as you can see here: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: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:
-
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.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.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.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.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).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.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).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:
-
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.This project does not depend on cryptography of data.
Security
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.The project website for Smart Village Project supports HTTPS using TLS with valid certificates as you can see here:
-
A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature.This project does not depend on retrieving cryptographic hashes.
Security
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.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.We have submitted a pull request to apache/curator to fix several of the current vulnerabilities in the project.
-
Projects SHOULD fix all critical vulnerabilities rapidly after they are reported.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.We have submitted a pull request to apache/curator to fix several of the current vulnerabilities in the project.
Security
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.All credentials for Smart Village Project are stored as environment variables, configuration files, or secrets that are not included in this project.
Analysis
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 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:
-
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.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.
-
All medium and higher severity exploitable vulnerabilities discovered with static code analysis MUST be fixed in a timely way after they are confirmed.See that the medium and higher severity vulnerabilities are resolved for Smart Village Project on GitHub.
-
It is SUGGESTED that static source code analysis occur on every commit or at least daily.Static code analysis is enabled on every commit to the main branch. See the configuration here:
Analysis
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.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).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.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.This is still a work-in-progress for Smart Village Project.
| Monday | |||
| October 24 2022 | Does the smartabyar-smartvillage project follow the Open Source Software Foundation Best Practices? | Review the OpenSSF Best Practices checklist for smartabyar-smartvillage. | Christopher Tate |
| Open Source Software Foundation | FLOSS Best Practices Criteria overview |
| Basics | Basic project website content |
| Basics | FLOSS license |
| Basics | Documentation |
| Basics | Other |
| Change Control | Public version-controlled source repository |
| Change Control | Unique version numbering |
| Change Control | Release notes |
| Reporting | Bug-reporting process |
| Reporting | Vulnerability report process |
| Quality | Working build system |
| Quality | Automated test suite |
| Quality | New functionality testing |
| Quality | Warning flags |
| Security | Secure development knowledge |
| Security | Use basic good cryptographic practices |
| Security | Secured delivery against man-in-the-middle (MITM) attacks |
| Security | Publicly known vulnerabilities fixed |
| Security | Other security issues |
| Analysis | Static code analysis |
| Analysis | Dynamic code analysis |