Authelia

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 7128 is passing Here is how to embed it:

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

        

 Basics 2/5

  • Identification

    The Single Sign-On Multi-Factor portal for web apps

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

    The about page has a dedicated bus factor section https://www.authelia.com/information/about/#bus-factor



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

    All significant contributors are unassociated, and we have 5 significant contributors https://github.com/authelia/authelia/graphs/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]

    We are already considering to implement this via https://resuse.software


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

    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]

    Our org members all use 2FA, and are required by org policy to use it. No external users can make modifications without an org member reviewing the changes. In addition GitHub from March 13th has required 2FA for all contributors to all GitHub repositories. https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13/



    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 only use cryptographic 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]

    The following guideline document outlines our code review requirements https://www.authelia.com/contributing/guidelines/pull-request/#review



    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]

    All major contributions are reviewed by a primary maintainer and generative AI.

    https://www.authelia.com/contributing/guidelines/pull-request/#review


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

    All of our builds are reproducible with the same inputs.

    Warning: URL required, but no URL found.


  • Automated test suite


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

    The go test tool can be used with our tests https://www.authelia.com/contributing/development/build-and-test/



    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]

    Our CI/CD pipeline is publicly visible at https://buildkite.com/authelia and performs both unit tests and integration tests with all of our external dependencies.



    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]

    We currently do tests but do not meet the 90% requirement.



    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]

    We currently do tests which cover code branches but do not meet the 80% requirement.


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

    By default all connections require TLS1.2 or greater.



    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]

    By default all connections require TLS1.2 or greater.


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

    Found all required security hardening headers (GitHub). The site also has several hardening headers configured here https://github.com/authelia/authelia/blob/master/docs/layouts/index.headers


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

    We have performed internal security reviews and regularly perform them.

    However we'd really prefer an adequately qualified external party to perform them. As we're a non-profit the cost associated is prohibitive at the moment. We have however had an informal audit via a third party which identified one issue which was fixed. We're actively looking for sponsorship. https://www.authelia.com/contributing/prologue/financial/#sponsorship



    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]

    This is on our list of items to implement via go test -fuzz. https://go.dev/doc/security/fuzz/



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

    We run several tests using subtests to enable easy comprehensive static and some basic dynamic testing.



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

Project badge entry owned by: James Elliott.
Entry created on 2023-03-15 03:55:22 UTC, last updated on 2024-02-16 22:51:58 UTC. Last achieved passing badge on 2023-03-15 08:12:14 UTC.

Back