OpenLearnr

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

    Open Source Course Management Platform

    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]

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



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

    Add documentation provided in the Github repo as well as any associated website/link is in English (https://github.com/python-sinhala-education-society/OpenLearnr)



    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]

    We use fully automated deployment (Travis CI based https://travis-ci.org/python-sinhala-education-society/OpenLearnr/builds/556946034) with GitHub releases (https://github.com/python-sinhala-education-society/OpenLearnr/releases) which supports discussion. Also the versions are semvar (https://semver.org/) so each patch or minor release will be visible and subject to discussion.



    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]

    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]

    We use semantic versioning with Gihub Releases and Tags; https://github.com/python-sinhala-education-society/OpenLearnr/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]

    Github Releases (with summary for human readable content) and Tags are being used; https://github.com/python-sinhala-education-society/OpenLearnr/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]

    We use dependabot and also patch vulnerabilities as they arise. Example: https://github.com/python-sinhala-education-society/OpenLearnr/releases


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

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

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

    Project build uses Maven; https://maven.apache.o


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

    Spring Test Context Framework (https://docs.spring.io/spring/docs/current/spring-framework-reference/testing.html) is used for integration tests, and Jest (https://jestjs.io/) is used for UI tests. Further information about complete testing suit can be found in our generator documentation; https://www.jhipster.tech/running-tests/



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

    Maven and npm is used; more information can be found at our documentation; https://github.com/python-sinhala-education-society/OpenLearnr/blob/master/docs/DEVELOPER_DOCUMENTATION.md



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

    We try to maintain code coverage to an acceptable level; https://sonarcloud.io/dashboard?id=com.asanka.tutor%3Aopen-learnr



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

    The project MUST address warnings. [warnings_fixed]

    This is automatically kept at a healthy state by SonarQube.



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

    This is automatically kept at a healthy state by SonarQube.


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

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



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

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#security



    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]

    Application base is generated from JHipster (https://www.jhipster.tech/) and we do not override or customize our own cryptographic protocols. Thus everything JHipster has to offer is inherited.

    https://bestpractices.coreinfrastructure.org/en/projects/2159#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. [delivery_mitm]

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

    If you follow our documentation above, this is not possible as you use TLS


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

    Only sample credentials which can be used by other developers and contributors are uploaded to Github and all production credentials are kept privately.


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

    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]

    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]

    We constantly monitor Sonar (https://sonarcloud.io/dashboard?id=com.asanka.tutor%3Aonline-tutor); after each commit to master branch.



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

    Yes, we do this automatically through our Travis Build (https://travis-ci.org/python-sinhala-education-society/OpenLearnr)


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

    Underlying generator (JHipster) uses OWASP with each major release.



    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]

    No memory unsafe languages are used; Java and Typescript are the primary languages used in this 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]

    Underlying generator (JHipster) uses OWASP with each major release.



    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]

    We do this through Github Alerts and Dependabot; example https://github.com/python-sinhala-education-society/OpenLearnr/releases/tag/v1.3.4



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

Project badge entry owned by: Sudharaka Palamakumbura.
Entry created on 2019-07-12 07:18:58 UTC, last updated on 2019-12-24 21:15:40 UTC. Last achieved passing badge on 2019-12-24 21:15:40 UTC.

Back