Lychee

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 2855 is gold Here is how to embed it:

These are the Gold level criteria. You can also view the Passing or Silver level criteria.

        

 Basics 5/5

  • Identification

    Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely.

  • Prerequisites


    The project MUST achieve a silver level badge. [achieve_silver]

  • Project oversight


    Mradi LAZIMA uwe na "bus factor" ya 2 au zaidi. (URL required) [bus_factor]

    https://github.com/LycheeOrg We have 3 admins.



    Mradi LAZIMA uwe na angalau wachangiaji wawili wasiohusika. (URL required) [contributors_unassociated]

    https://github.com/LycheeOrg/Lychee/graphs/contributors Ildyria, Kamil & Tmp-Hallenser are main contributors.


  • Other


    The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file]

    The full project is under MIT.


  • Public version-controlled source repository


    The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed]

    Repository on GitHub, which uses git. git is distributed.



    The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks]

    We have https://github.com/LycheeOrg/Lychee/labels/good%20first%20issue for those who want to join us and have easy tasks to get familiar with the project.



    The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA]

    We enforce 2FA at the github org level.



    The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA]

    We use GitHub 2FA.


  • Coding standards


    Mradi LAZIMA uandike mahitaji yake ya kukagua msimbo, pamoja na jinsi ukaguzi wa nambari unafanywa, nini lazima ichunguzwe, na nini kinachohitajika ili ikubalike. (URL required) [code_review_standards]

    https://raw.githubusercontent.com/LycheeOrg/Lychee/master/.github/PULL_REQUEST_TEMPLATE.md

    If you're pushing a Feature: - Title it: "This new feature" - Describe what the new feature enables - Add tests to test the new feature. - Ensure it doesn't break any existing features.

    If you're pushing a Fix: - Title it: "Fixes the bug name" - If it is a fix an an existing issue start the description with fixes #xxxx where xxxx is the issue number. - Describe how it fixes in a few words. - Add a test that triggered the bug before fixing it. - Ensure it doesn't break any feature.

    All Pull Requests run with extensive tests for stable and latest versions of PHP. Ensure your tests pass or your PR may be taken down.

    Additionally you can run make phpstan and make formatting on your own machine as they will be required to pass for your PR to be accepted.



    The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review]

    We require all Pull request to be reviewed by someone else than the author. Any new propositions are also discussed internally on Gitter.


  • Working build system


    The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible]

    Lychee is a gallery website written in PHP. There is no building.


  • Automated test suite


    A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation]

    Tests are applied in our CI. We use phpunit. https://github.com/LycheeOrg/Lychee/actions



    The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration]

    Tests are applied in our CI. We use phpunit. https://github.com/LycheeOrg/Lychee/actions



    The project MUST have FLOSS automated test suite(s) that provide at least 90% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage90]

    Our tests suite are running on the code and coverage can be checked here: https://app.codecov.io/gh/LycheeOrg/Lychee



    The project MUST have FLOSS automated test suite(s) that provide at least 80% branch coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_branch_coverage80]

    Our tests suite are running on the code and coverage can be checked here: https://app.codecov.io/gh/LycheeOrg/Lychee


  • 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 support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 MUST be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]


    The software produced by the project MUST, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

  • Secured delivery against man-in-the-middle (MITM) attacks


    The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site]
  • Other security issues


    The project MUST have performed a security review within the last 5 years. This review MUST consider the security requirements and security boundary. [security_review]

    2 of our Devs are crypographers, ensuring high quality of the security requirements and boundary analysis.



    Hardening mechanisms MUST be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. (URL required) [hardening]
  • Dynamic code analysis


    The project MUST apply at least one dynamic analysis tool to any proposed major production release of the software produced by the project before its release. [dynamic_analysis]

    Only static analysis is applicable to PHP. Our php stan rules are extremely strict to avoid any run time errors. https://github.com/LycheeOrg/phpstan-lychee



    The project SHOULD include many run-time assertions in the software it produces and check those assertions during dynamic analysis. [dynamic_analysis_enable_assertions]

    Only static analysis is applicable to PHP. Our php stan rules are extremely strict to avoid any run time errors. https://github.com/LycheeOrg/phpstan-lychee



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

Project badge entry owned by: Benoît Viguier.
Entry created on 2019-05-28 10:36:38 UTC, last updated on 2025-01-19 10:26:54 UTC. Last achieved passing badge on 2019-05-28 12:58:22 UTC.

Back