dayendar

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

    Dayendar for advanced day calendar operations

    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]

    Through the README.md file hosted on GitHub and Rust Crates.io: https://crates.io/crates/dayendar or https://github.com/racherb/dayendar/blob/dev/README.md



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


    Habari juu ya jinsi ya kuchangia LAZIMA ieleze mchakato wa uchangiaji (kwa mfano, je! Maombi ya kuvuta yanatumika?) (URL required) [contribution]

    Non-trivial contribution file in repository: https://github.com/racherb/dayendar/blob/dev/CONTRIBUTING.md.



    Habari juu ya jinsi ya kuchangia INAPASWA kujumuisha mahitaji ya michango inayokubalika (k.m., rejeleo la kiwango chochote kinachohitajika cha usimbaji). (URL required) [contribution_requirements]

    The requirements for contributions are clearly stated in the documents CONTRIBUTING.md and README.md: https://github.com/racherb/dayendar/blob/HEAD/CONTRIBUTING.md


  • FLOSS license

    What license(s) is the project released under?



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

    The Apache-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 Apache-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/racherb/dayendar/blob/dev/LICENSE.


  • Documentation


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

    Documentation published in crates.io: https://docs.rs/dayendar/latest/dayendar/



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

    The project provides full reference documentation describing the external interface of our software. This documentation is written directly into the code as documentation comments and is automatically generated in HTML format using the rustdoc tool included with Rust. The generated documentation is available at [https://docs.rs/dayendar/latest/dayendar/] for easy reference without the need to go through the entire source code. In addition, our README.md file in the repository provides basic information and relevant links to help users and developers understand and use our software correctly.


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

    All documentation is provided in English.



    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]


    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]

    We use semantic versioning to tag our releases. Additionally, we include the commit identifier: https://github.com/racherb/dayendar/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]

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

    // No release notes file found.



    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]

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


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

    Issue Tracker through GitHub



    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]

    By using GitHub's Issue Tracker, we ensure that every bug report or issue submitted is logged, timestamped, and available for review by the development team. GitHub's notification system ensures that the repository maintainers and contributors are informed of new issues when they are created. This facilitates timely acknowledgment. Furthermore, GitHub provides features like comments, reactions (e.g., thumbs up, thumbs down), and labels. These can be used to acknowledge bug reports. Even if a fix is not immediately available, team members can comment on the issue to acknowledge its receipt, provide interim solutions, or request further information. This ensures open communication with the reporter and demonstrates that the project is actively monitored and maintained. Thus, by utilizing the features and notifications of GitHub's Issue Tracker, we can efficiently acknowledge and respond to the majority of bug reports within the specified timefram



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

    Using GitHub's Issue Tracker, we have a centralized system to monitor, label, and categorize enhancement requests. With the labeling feature, we can specifically tag issues as "enhancements" and ensure they are addressed. The platform's built-in notification and commenting system ensures that maintainers are informed and can respond, even if the response is a simple acknowledgment, discussion, or a 'no'. By actively engaging with these enhancement requests, we demonstrate that the project remains active and responsive to user feedback.



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

    By hosting our project on GitHub, every issue (which includes bug reports, enhancement requests, etc.) and its associated responses are inherently archived and publicly accessible. GitHub's Issue Tracker provides a history of all interactions, ensuring transparency and availability for later review or searching: https://github.com/racherb/dayendar/issues


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


    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]

  • Working build system


    Ikiwa programu iliyotengenezwa na mradi inahitaji ujenzi wa matumizi, mradi LAZIMA utoe mfumo wa kujenga ambao unaweza kujenga programu kiotomatiki kutoka kwa chanzo-msimbo. [build]

    Through gitHub Action. Currently there are two workflows. One of them compiles the code and runs the automated unit tests.



    INAPENDEKEZWA kuwa zana za kawaida zitumike kujenga programu. [build_common_tools]

    Cargo, Rust's standard package manager and build system, is used to build software. Cargo is widely recognised and used in the Rust community for dependency management, build, testing and other tasks related to the software development lifecycle. Instructions for building the project using Cargo are available in our README.md file at https://github.com/racherb/dayendar/blob/dev/README.md.



    Mradi UNAPASWA kujengwa kwa kutumia zana za FLOSS pekee yake. [build_floss_tools]

    The project uses Rust and Cargo for building and dependency management, both are open source tools distributed under MIT/Apache-2.0 licenses. All dependencies and additional tools used in the project are FLOSS, ensuring that the project is buildable using only free and open source software tools.


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

    The project uses the Rust integrated test system to implement automated tests. These tests are included in the public repository and can be run using cargo test. The tests and the project code are released under the Apache-2.0 licence and are fully FLOSS. Instructions for running the tests are documented in our CONTRIBUTING.md file https://github.com/racherb/dayendar/blob/dev/CONTRIBUTING.md, as appropriate). In addition, we have configured GitHub Actions to automatically run these tests on every commit, ensuring the quality and functionality of the code.



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

    Executing "cargo test"



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


    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 uses the rustc compiler which, by default, triggers a number of warnings to ensure code quality and prevent common bugs. In addition, we use Clippy, a Rust-specific linting tool, which provides additional suggestions and warnings to improve code quality and readability. Instructions on how to use these tools are documented in our CONTRIBUTING.md file.



    The project MUST address warnings. [warnings_fixed]

    The project actively monitors and addresses warnings generated by the rustc compiler and the Clippy linting tool. We strive to maintain high quality code and fix all relevant warnings. In cases where we consider a warning to be a false positive, we flag it and document it in the source code.



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

    The Rust project follows a policy of being as strict as possible with warnings and bugs. We use the rustc compiler and Clippy linting tool with strict settings to detect and correct problems in the early stages of development. In addition, our continuous integration (CI) ensures that any new code meets these strict standards. Our policy and practices regarding warnings are clearly documented in our CONTRIBUTING.md file.


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

    Programu iliyotengenezwa na mradi LAZIMA itumie, kwa chaguo-msingi, tu itifaki za kriptografia na mifumbo ambazo zimechapishwa hadharani na kukaguliwa na wataalam (ikiwa itifaki za kriptografia na mafumbo imetumika). [crypto_published]


    Ikiwa programu iliyotengenezwa na mradi ni programu au maktaba, na kusudi lake la msingi sio kutekeleza usimbuaji, basi INAPASWA tu kuita programu iliyoundwa kihususa kutekeleza kazi za kielelezo; HAIPASWI kutekeleza-upya shughuli hiyo. [crypto_call]


    Utendaji wote katika programu iliyotengenezwa na mradi ambayo inategemea usimbuaji LAZIMA iweze kutekelezwa kwa kutumia FLOSS. [crypto_floss]


    Mifumo ya usalama ndani ya programu inayozalishwa na mradi LAZIMA itumie kwa msingi keylengths ambazo angalau zinakidhi mahitaji ya chini ya NIST kufikia mwaka wa 2030 (kama ilivyoelezwa mnamo 2012). LAZIMA iwe rahisi kusanidi programu ili keylengths ndogo zimezimwa kabisa. [crypto_keylength]


    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]


    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]


    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi INAPASWA kutekeleza kwa ukamilifu usiri wa umbele ya itifaki za makubaliano ya funguo ili funguo la kipindi kilicho tokana na kikao cha vifungo muda-mrefu haziwezi kuridhi mabaya ikiwa mojawapo ya vifunguo vya muda-mrefu imeridhi mabaya katika usoni. [crypto_pfs]


    Ikiwa programu iliyotengenezwa na mradi imesababisha uhifadhi wa nywila kwa minajili ya uthibitishaji ya watumiaji wa kutoka nje, nywila LAZIMA zihifadhiwe kwa mficho uliorudiarudia na chumvi kwa kila-mtumiaji kwa kutumia kanuni ya upanuaji (rudiarudia) wa funguo (k.m., Argon2id, Bcrypt, Scrypt, or PBKDF2). Ona pia Kurasadogo ya Uhifadhi wa Nywila la OWASP). [crypto_password_storage]


    Mifumo ya usalama ndani ya programu iliyotengenezwa na mradi LAZIMA itoe funguo zote za kriptologia na nonces kwa kutumia kitengeneza cha nambari za bahati kuptia kriptologia salama, na ISIWEZE kufanya hivo kutumia vitengenezi zisizo salama kikriptologia. [crypto_random]

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

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

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

    Rust inherently emphasizes safety through its type system and ownership properties. To meet the above requirement, beyond the compiler's assurances: Clippy: A linting tool for Rust, it detects common errors, suggests improvements, and ensures adherence to Rust's best practices. While Rustc has its built-in linter, Clippy provides more detailed, specific checks. Cargo-audit: This tool checks Rust project dependencies for known vulnerabilities, referencing the RustSec Advisory Database. Before a major production release, running Clippy ensures lint-free code, and Cargo-audit verifies the absence of known vulnerable dependencies. By using these tools, we leverage both Rust's built-in security capabilities and additional open-source tools to ensure software quality and safety.



    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]

    For Rust projects, while the language's design inherently mitigates many common vulnerabilities, we can still employ tools that further scrutinize the codebase for potential issues: Clippy: Beyond linting for code quality, some of Clippy's lints can indirectly identify code patterns that might lead to vulnerabilities, especially when they deviate from Rust's idiomatic practices. Cargo-audit: Directly addresses the criterion's suggestion. It scans the project's dependencies for known security vulnerabilities, ensuring that the software doesn't inadvertently include libraries with recognized vulnerabilities. By integrating both Clippy and Cargo-audit into the development workflow, we not only uphold Rust's safety principles but also actively scan for common vulnerabilities, aligning with the requirement's intent.



    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]


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

    Static analysis through "cargo clippy" and "cargo audit" are automated through GitHub Actions flows.


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

    For dynamic code analysis we are enabling the use of "cargo fuzzy".



    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]

    In our project we use the Rust programming language which is characterised by memory safety, however, we apply fuzzing techniques through "cargo fuzz".



    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]


    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 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 Raciel Hernández and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Raciel Hernández.
Entry created on 2023-10-21 14:07:03 UTC, last updated on 2023-10-23 01:07:11 UTC.

Back