openits

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.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 13354 is silver Here is how to embed it:
You can show your badge status by embedding this in your markdown file:
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13354/badge)](https://www.bestpractices.dev/projects/13354)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/13354"><img src="https://www.bestpractices.dev/projects/13354/badge"></a>


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

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics 17/17 ●

  • General

    Note that other projects may use the same name.

    Open-source enterprise architecture platform for documenting APIs, integrations, IT landscapes, and business domains.

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

    OpenITS is a self-hosted, open-source enterprise architecture and integration documentation platform (Apache 2.0). It helps teams model IT landscapes, design C4 architecture diagrams, document multi-protocol APIs (REST, SOAP, GraphQL, gRPC, WebSocket, etc.), map cross-system integrations, capture ADRs, and govern a technology radar in one workspace.

    The project is implemented as a Laravel 11 (PHP 8.2+) web application with MySQL or SQLite, optional LDAP/Google OAuth authentication, and Sanctum API tokens. Security controls include bcrypt password hashing, login rate limiting, security headers, LDAPS/STARTTLS support, and private vulnerability reporting via SECURITY.md.

    Documentation includes README.md (installation, usage, build, test, security), CONTRIBUTING.md, SECURITY.md, and reference docs for API, CLI, and public service classes under docs/. Bug reports and feature requests use English GitHub issue templates. The test suite has 69 automated PHPUnit tests; code style is enforced with Laravel Pint (composer lint). The project does not yet have an official NIST CPE name.

  • Prerequisites


    Enough for a badge!

    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    Enough for a badge!

    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]

    CONTRIBUTING.md defines acceptable contribution requirements, including the required coding standard (PSR-12, enforced with Laravel Pint), test policy, security rules, and a PR checklist. The README Contributing section links to this document.

    Key URLs:


  • Project oversight


    Enough for a badge!

    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]
    The DCO is the recommended mechanism because it's easy to implement, tracked in the source code, and git directly supports a "signed-off" feature using "commit -s". To be most effective it is best if the project documentation explains what "signed-off" means for that project. A CLA is a legal agreement that defines the terms under which intellectual works have been licensed to an organization or project. A contributor assignment agreement (CAA) is a legal agreement that transfers rights in an intellectual work to another party; projects are not required to have CAAs, since having CAA increases the risk that potential contributors will not contribute, especially if the receiver is a for-profit organization. The Apache Software Foundation CLAs (the individual contributor license and the corporate CLA) are examples of CLAs, for projects which determine that the risks of these kinds of CLAs to the project are less than their benefits.

    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#developer-certificate-of-origin-dco
    https://developercertificate.org/


    Enough for a badge!

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]
    There needs to be some well-established documented way to make decisions and resolve disputes. In small projects, this may be as simple as "the project owner and lead makes all final decisions". There are various governance models, including benevolent dictator and formal meritocracy; for more details, see Governance models. Both centralized (e.g., single-maintainer) and decentralized (e.g., group maintainers) approaches have been successfully used in projects. The governance information does not need to document the possibility of creating a project fork, since that is always possible for FLOSS projects.

    https://github.com/imRezaAlie/openits/blob/main/GOVERNANCE.md


    Enough for a badge!

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]
    Projects may be able to improve the civility of their community and to set expectations about acceptable conduct by adopting a code of conduct. This can help avoid problems before they occur and make the project a more welcoming place to encourage contributions. This should focus only on behavior within the community/workplace of the project. Example codes of conduct are the Linux kernel code of conduct, the Contributor Covenant Code of Conduct, the Debian Code of Conduct, the Ubuntu Code of Conduct, the Fedora Code of Conduct, the GNOME Code Of Conduct, the KDE Community Code of Conduct, the Python Community Code of Conduct, The Ruby Community Conduct Guideline, and The Rust Code of Conduct.

    https://github.com/imRezaAlie/openits/blob/main/CODE_OF_CONDUCT.md


    Enough for a badge!

    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]
    The documentation for governance and roles and responsibilities may be in one place.

    GOVERNANCE.md defines project roles (project lead, maintainer, contributor, user), their responsibilities, and who currently holds each role. SECURITY.md identifies the security contact for vulnerability reports.
    Key URLs:


    Enough for a badge!

    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    Only one maintainer is listed and there is no documented backup access, succession plan, or continuity process for issues, merges, and releases.

    Key URL:
    https://github.com/imRezaAlie/openits/blob/main/GOVERNANCE.md


    Barely enough for a badge.

    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]
    A "bus factor" (aka "truck factor") is the minimum number of project members that have to suddenly disappear from a project ("hit by a bus") before the project stalls due to lack of knowledgeable or competent personnel. The truck-factor tool can estimate this for projects on GitHub. For more information, see Assessing the Bus Factor of Git Repositories by Cosentino et al.

    The project currently has a bus factor of 1. Only one maintainer is documented.

    Key URL:
    https://github.com/imRezaAlie/openits/blob/main/GOVERNANCE.md#current-maintainers


  • Documentation


    Enough for a badge!

    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]
    The project might not achieve the roadmap, and that's fine; the purpose of the roadmap is to help potential users and contributors understand the intended direction of the project. It need not be detailed.

    ROADMAP.md documents planned work and out-of-scope items for the next 12 months (June 2026 – June 2027), including quarterly goals and an explicit "Out of scope (not planned)" section.

    Key URLs:
    https://github.com/imRezaAlie/openits/blob/main/ROADMAP.md
    https://github.com/imRezaAlie/openits/blob/main/ROADMAP.md#out-of-scope-not-planned


    Enough for a badge!

    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]
    A software architecture explains a program's fundamental structures, i.e., the program's major components, the relationships among them, and the key properties of these components and relationships.

    README.md documents the high-level software architecture with Mermaid diagrams: enterprise landscape model, entity-relationship diagram, integration flow, and tech stack. docs/SERVICES.md describes the application service layer.

    Key URLs:
    https://github.com/imRezaAlie/openits#architecture-model
    https://github.com/imRezaAlie/openits/blob/main/README.md#architecture-model
    https://github.com/imRezaAlie/openits/blob/main/docs/SERVICES.md


    Enough for a badge!

    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]
    These are the security requirements that the software is intended to meet.

    README.md Security section and SECURITY.md document what users can expect (bcrypt passwords, rate limiting, security headers, Sanctum tokens, LDAP/TLS options, crypto practices) and what they must configure or cannot expect (HTTPS required in production, no paid bug bounty, operator-managed secrets, supported versions only on latest main).

    Key URLs:
    https://github.com/imRezaAlie/openits#security
    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md
    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#cryptography-practices


    Enough for a badge!

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]
    The idea is to show users how to get started and make the software do anything at all. This is critically important for potential users to get started.

    README.md includes a Quick start guide with clone, Composer install, .env setup, migrations, and php artisan serve so new users can run OpenITS locally.

    Key URLs:
    https://github.com/imRezaAlie/openits#quick-start
    https://github.com/imRezaAlie/openits/blob/main/README.md#quick-start


    Enough for a badge!

    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]
    The documentation MAY include information about differences or changes between versions of the software and/or link to older versions of the documentation. The intent of this criterion is that an effort is made to keep the documentation consistent, not that the documentation must be perfect.

    Documentation is maintained alongside the codebase: README (quick start, architecture, security), CONTRIBUTING.md, SECURITY.md, GOVERNANCE.md, ROADMAP.md, and docs/ (API, CLI, services) match the current Laravel 11 application. The project policy in CONTRIBUTING.md requires updating docs when user-facing or interface changes land. Known inconsistencies are tracked via GitHub Issues and fixed (e.g. restored docs/README.md index linked from README).

    Key URLs:
    https://github.com/imRezaAlie/openits/blob/main/README.md
    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#documentation
    https://github.com/imRezaAlie/openits/tree/main/docs


    Enough for a badge!

    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]
    An achievement is any set of external criteria that the project has specifically worked to meet, including some badges. This information does not need to be on the project website front page. A project using GitHub can put achievements on the repository front page by adding them to the README file.

    The OpenSSF Best Practices badge is linked on the repository front page (README.md) and the project landing page (welcome.blade.php hero and footer), pointing to https://www.bestpractices.dev/projects/13354.

    Key URLs:
    https://github.com/imRezaAlie/openits#openits
    https://www.bestpractices.dev/projects/13354


  • Accessibility and internationalization


    Enough for a badge!

    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]
    For web applications, see the Web Content Accessibility Guidelines (WCAG 2.0) and its supporting document Understanding WCAG 2.0; see also W3C accessibility information. For GUI applications, consider using the environment-specific accessibility guidelines (such as Gnome, KDE, XFCE, Android, iOS, Mac, and Windows). Some TUI applications (e.g. `ncurses` programs) can do certain things to make themselves more accessible (such as `alpine`'s `force-arrow-cursor` setting). Most command-line applications are fairly accessible as-is. This criterion is often N/A, e.g., for program libraries. Here are some examples of actions to take or issues to consider:
    • Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language ( WCAG 2.0 guideline 1.1)
    • Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. ( WCAG 2.0 guideline 1.4.1)
    • The visual presentation of text and images of text has a contrast ratio of at least 4.5:1, except for large text, incidental text, and logotypes ( WCAG 2.0 guideline 1.4.3)
    • Make all functionality available from a keyboard (WCAG guideline 2.1)
    • A GUI or web-based project SHOULD test with at least one screen-reader on the target platform(s) (e.g. NVDA, Jaws, or WindowEyes on Windows; VoiceOver on Mac & iOS; Orca on Linux/BSD; TalkBack on Android). TUI programs MAY work to reduce overdraw to prevent redundant reading by screen-readers.

    OpenITS follows basic accessibility practices where practical: the landing page uses lang="en", navigation toggle aria-label, and descriptive image alt text; README diagrams include alt attributes; documentation and issue templates are in English. ROADMAP.md lists further keyboard and contrast improvements for the C4 editor (Q2 2027). Complex D3 visualizations remain a known limitation for screen-reader users.

    Key URLs:
    https://github.com/imRezaAlie/openits/blob/main/resources/views/welcome.blade.php
    https://github.com/imRezaAlie/openits/blob/main/ROADMAP.md
    https://github.com/imRezaAlie/openits#readme


    Enough for a badge!

    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]
    Localization "refers to the adaptation of a product, application or document content to meet the language, cultural and other requirements of a specific target market (a locale)." Internationalization is the "design and development of a product, application or document content that enables easy localization for target audiences that vary in culture, region, or language." (See W3C's "Localization vs. Internationalization".) Software meets this criterion simply by being internationalized. No localization for another specific language is required, since once software has been internationalized it's possible for others to work on localization.

    OpenITS produces user-facing text and uses Laravel internationalization: lang/en/ translation files (auth, LDAP, Google), __() / @lang() in views and services, and APP_LOCALE in .env. Additional locales can be added under lang/. Most admin UI strings remain English-only; full multi-language support is not yet complete.

    Key URLs:
    https://github.com/imRezaAlie/openits/tree/main/lang
    https://github.com/imRezaAlie/openits/blob/main/.env.example
    https://github.com/imRezaAlie/openits/blob/main/config/app.php


  • Other


    Enough for a badge!

    If the project sites (website, repository, and download URLs) store 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). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]
    Note that the use of GitHub meets this criterion. This criterion only applies to passwords used for authentication of external users into the project sites (aka inbound authentication). If the project sites must log in to other sites (aka outbound authentication), they may need to store authorization tokens for that purpose differently (since storing a hash would be useless). This applies criterion crypto_password_storage to the project sites, similar to sites_https.

    The GitHub repository and release downloads do not store user passwords (N/A). The live demo at openits.ir runs OpenITS, which stores local account passwords as bcrypt iterated hashes with per-user salts (Laravel Hash, BCRYPT_ROUNDS=12).

    Key URLs:
    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#cryptography-practices
    https://github.com/imRezaAlie/openits/blob/main/.env.example
    https://github.com/imRezaAlie/openits#security


 Change Control 1/1 ●

  • Previous versions


    Enough for a badge!

    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    OpenITS does not maintain parallel long-term branches for older releases. Security fixes and active maintenance apply to the latest release on main (see SECURITY.md). Users on older deployments follow a documented upgrade path in UPGRADING.md: backup, fetch/checkout, composer install, php artisan migrate, cache rebuild, and verification. Version-specific notes (e.g. v1.1.0) list configuration, database, and public API interface changes. Release notes are published on GitHub Releases. README links to UPGRADING.md under Build & test and in the documentation table.

    URLs to cite:

    https://github.com/imRezaAlie/openits/blob/main/UPGRADING.md
    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#supported-versions
    https://github.com/imRezaAlie/openits/releases


 Reporting 3/3 ●

  • Bug-reporting process


    Enough for a badge!

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

    The project uses GitHub Issues to track bugs, feature requests, and other work. English issue templates are provided for structured reports.

    Key URLs:


  • Vulnerability report process


    Enough for a badge!

    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    No security vulnerabilities were resolved in the 12 months before 24 June 2026. SECURITY.md documents our credit policy for future fixes (GitHub Security Advisories, release notes, and a rolling 12-month table) and states that reporters who request anonymity are not named publicly.

    tps://github.com/imRezaAlie/openits/blob/main/SECURITY.md#credit-for-security-reporters


    Enough for a badge!

    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]
    This is strongly related to vulnerability_report_process, which requires that there be a documented way to report vulnerabilities. It also related to vulnerability_report_response, which requires response to vulnerability reports within a certain time frame.

    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#vulnerability-response-process

    SECURITY.md documents a full vulnerability response process: private reporting channels (email and GitHub private vulnerability reporting), maintainer steps from receipt through triage, fix, coordinated disclosure, and reporter credit, plus response timelines (48-hour acknowledgment, 7-day status update). Reporting instructions and supported versions are in the same file. README and CONTRIBUTING link to SECURITY.md for security reports.


 Quality 19/19 ●

  • Coding standards


    Enough for a badge!

    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]
    In most cases this is done by referring to some existing style guide(s), possibly listing differences. These style guides can include ways to improve readability and ways to reduce the likelihood of defects (including vulnerabilities). Many programming languages have one or more widely-used style guides. Examples of style guides include Google's style guides and SEI CERT Coding Standards.

    For coding_standards, answer Met. OpenITS already documents named style guides and requires compliance before merge.

    Badge form
    Field Value
    Status
    Met
    URL
    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#coding-standards

    CONTRIBUTING.md identifies coding style guides for the project’s primary languages: PHP follows PSR-12, enforced with Laravel Pint (composer lint / composer lint:fix; config in pint.json). Blade, JavaScript, and database conventions are documented in the same section. Contributors must run the linter and tests before opening a PR; the PR checklist requires composer lint to pass. README links to CONTRIBUTING.md for coding standards.


    Enough for a badge!

    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]
    This MAY be implemented using static analysis tool(s) and/or by forcing the code through code reformatters. In many cases the tool configuration is included in the project's repository (since different projects may choose different configurations). Projects MAY allow style exceptions (and typically will); where exceptions occur, they MUST be rare and documented in the code at their locations, so that these exceptions can be reviewed and so that tools can automatically handle them in the future. Examples of such tools include ESLint (JavaScript), Rubocop (Ruby), and devtools check (R).

    https://github.com/imRezaAlie/openits/blob/main/.github/workflows/lint.yml
    PHP style (PSR-12) is enforced automatically with Laravel Pint (FLOSS). pint.json configures the Laravel preset; composer lint runs vendor/bin/pint --test. GitHub Actions workflow lint.yml runs composer lint on every push and pull request to main. CONTRIBUTING.md and README document the tool and automatic enforcement.


  • Working build system


    Enough for a badge!

    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]
    It should be easy to enable special build features like Address Sanitizer (ASAN), or to comply with distribution hardening best practices (e.g., by easily turning on compiler flags to do so).

    https://github.com/imRezaAlie/openits/blob/main/README.md#build--test

    OpenITS does not generate native binaries. It is a Laravel/PHP web application built with Composer (PHP dependencies) and optional Vite/npm (frontend assets). There is no Makefile, CMake, or autotools build; compiler/linker environment variables (CC, CFLAGS, CXX, CXXFLAGS, LDFLAGS) are not used. README documents the build process under Build & test.


    Enough for a badge!

    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]
    E.G., setting CFLAGS (C) or CXXFLAGS (C++) should create the relevant debugging information if those languages are used, and they should not be stripped during installation. Debugging information is needed for support and analysis, and also useful for measuring the presence of hardening features in the compiled binaries.

    https://github.com/imRezaAlie/openits/blob/main/README.md#build--test

    OpenITS has no native binary build or installation system. The documented build uses Composer (PHP dependencies) and optional Vite/npm (frontend assets). The project does not compile C/C++ binaries or run install steps that strip debugging symbols (e.g. install -s). README Build & test states that native compiler flags and symbol stripping are not applicable.


    Enough for a badge!

    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]
    The project build system's internal dependency information needs to be accurate, otherwise, changes to the project may not build correctly. Incorrect builds can lead to defects (including vulnerabilities). A common mistake in large build systems is to use a "recursive build" or "recursive make", that is, a hierarchy of subdirectories containing source files, where each subdirectory is independently built. Unless each subdirectory is fully independent, this is a mistake, because the dependency information is incorrect.

    OpenITS has no native build or installation system that recursively builds subdirectories. The documented build uses Composer (PHP dependencies) and optional Vite/npm (frontend assets). There is no Makefile, CMake, or autotools with cross-dependent subdirectory recursion. README Build & test documents this.

    https://github.com/imRezaAlie/openits/blob/main/README.md#build--test


    Enough for a badge!

    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]
    GCC and clang users may find the -frandom-seed option useful; in some cases, this can be resolved by forcing some sort order. More suggestions can be found at the reproducible build site.

    https://github.com/imRezaAlie/openits/blob/main/README.md#build--test

    OpenITS is a PHP/Laravel application where PHP source is executed directly (scripting language). There is no compiled native binary build that must be bit-for-bit reproducible. Installation uses Composer for dependencies and optional Vite for frontend assets. README Build & test documents that reproducible compilation of shipped binaries is not applicable.


  • Installation system


    Enough for a badge!

    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]
    Examples include using a package manager (at the system or language level), "make install/uninstall" (supporting DESTDIR), a container in a standard format, or a virtual machine image in a standard format. The installation and uninstallation process (e.g., its packaging) MAY be implemented by a third party as long as it is FLOSS.

    https://github.com/imRezaAlie/openits/blob/main/README.md#quick-start

    OpenITS installs using the standard PHP/Laravel workflow: git clone, composer install, copy .env.example, php artisan key:generate, php artisan migrate, and php artisan serve. Quick start documents each step with commands. Uninstall is documented under the same README: stop services, optionally back up, drop the database, delete the application directory, and remove web server configuration — the usual approach for Composer-based Laravel deployments. CONTRIBUTING.md repeats the development install steps.


    Enough for a badge!

    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    https://github.com/imRezaAlie/openits/blob/main/README.md#build--test

    OpenITS is a self-hosted PHP/Laravel application installed by cloning the repository and running Composer/Artisan commands. There is no POSIX make install or autotools installer that writes built artifacts using DESTDIR or similar standard variables. The deployment directory is chosen at clone time (Quick start). README Build & test documents that DESTDIR/prefix install conventions are not applicable.


    Enough for a badge!

    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]
    This MAY be implemented using a generated container and/or installation script(s). External dependencies would typically be installed by invoking system and/or language package manager(s), per external_dependencies.

    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#development-setup

    CONTRIBUTING.md documents a quick developer setup using the standard PHP/Laravel convention: git clone, composer install (includes PHPUnit and Pint dev dependencies), cp .env.example .env, php artisan key:generate, php artisan migrate --seed, then composer test to verify the PHPUnit environment. A Test environment subsection explains phpunit.xml, RefreshDatabase, and optional SQLite for the fastest local setup. README Quick start and Build & test link to the same workflow and document composer test and composer lint.


  • Externally-maintained components


    Enough for a badge!

    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]
    Typically this is done using the conventions of package manager and/or build system. Note that this helps implement installation_development_quick.

    https://github.com/imRezaAlie/openits/blob/main/composer.json

    External dependencies are listed in standard package-manager manifests: composer.json and composer.lock for PHP (Laravel and libraries), package.json and package-lock.json for optional frontend build tools. README Requirements links to these files and documents composer install / npm ci. This supports installation_development_quick via composer install.


    Enough for a badge!

    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]
    This can be done using an origin analyzer / dependency checking tool / software composition analysis tool such as OWASP's Dependency-Check, Sonatype's Nexus Auditor, Synopsys' Black Duck Software Composition Analysis, and Bundler-audit (for Ruby). Some package managers include mechanisms to do this. It is acceptable if the components' vulnerability cannot be exploited, but this analysis is difficult and it is sometimes easier to simply update or fix the part.

    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#dependency-monitoring

    OpenITS monitors third-party dependencies via GitHub Dependabot (weekly Composer and npm), a scheduled and on-push Dependency audit workflow (composer audit, npm audit), and GitHub dependency alerts. SECURITY.md documents triage: fix via dependency updates, or verify unexploitable with rationale. No vendored convenience copies; manifests are composer.lock and package-lock.json. Known remaining Laravel 11.x advisories without 11.x patches are tracked with mitigation notes pending Laravel 12 upgrade.


    Enough for a badge!

    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]
    A typical way to meet this criterion is to use system and programming language package management systems. Many FLOSS programs are distributed with "convenience libraries" that are local copies of standard libraries (possibly forked). By itself, that's fine. However, if the program *must* use these local (forked) copies, then updating the "standard" libraries as a security update will leave these additional copies still vulnerable. This is especially an issue for cloud-based systems; if the cloud provider updates their "standard" libraries but the program won't use them, then the updates don't actually help. See, e.g., "Chromium: Why it isn't in Fedora yet as a proper package" by Tom Callaway.

    https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#updateable-reused-components

    Externally maintained components are listed in composer.json/composer.lock (PHP) and package.json/package-lock.json (npm). Updates use standard package managers and weekly Dependabot PRs; composer audit and npm audit run in CI. SECURITY.md documents identify/update steps for Composer and npm, and inventories committed static assets under public/vendor/ with upstream sources. vendor/ and node_modules/ are not committed. Vulnerability fixes are applied by merging dependency updates and running composer test.


    Enough for a badge!

    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#coding-standards

    OpenITS targets PHP 8.2+ and Laravel 11 (README Requirements). CONTRIBUTING.md instructs contributors to avoid deprecated or obsolete APIs when FLOSS alternatives exist in the stack: Eloquent and Form Requests instead of legacy database/validation patterns, Laravel Hash/random_bytes instead of weak crypto. The minimum PHP version excludes EOL runtimes for supported users. New code uses PHP 8.2 features (typed properties, return types).


  • Automated test suite


    Enough for a badge!

    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]
    This requirement can be viewed as a subset of test_continuous_integration, but focused on just testing, without requiring continuous integration.

    https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#coding-standards

    OpenITS targets PHP 8.2+ and Laravel 11 (README Requirements). CONTRIBUTING.md instructs contributors to avoid deprecated or obsolete APIs when FLOSS alternatives exist in the stack: Eloquent and Form Requests instead of legacy database/validation patterns, Laravel Hash/random_bytes instead of weak crypto. The minimum PHP version excludes EOL runtimes for supported users. New code uses PHP 8.2 features (typed properties, return types).


    Enough for a badge!

    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    In the last six months there were multiple bug fixes (MySQL index length, asset paths, data-stack loading, integration tree, CRUD/UI, security hardening, etc.), but only some areas—mainly authentication/security—have automated regression tests. There is no evidence that ≥50% of those fixed bugs have corresponding regression tests in the suite, and several hotfixes have no dedicated tests at all.

    To reach Met, track fixed bugs from the last six months and add regression tests for at least half of them (or document a policy + evidence in CONTRIBUTING/issues linking each fix to a test).


    Enough for a badge!

    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]
    Many FLOSS tools are available to measure test coverage, including gcov/lcov, Blanket.js, Istanbul, JCov, and covr (R). Note that meeting this criterion is not a guarantee that the test suite is thorough, instead, failing to meet this criterion is a strong indicator of a poor test suite.

    PHP has FLOSS coverage tools (PHPUnit with PCOV or Xdebug), so this criterion applies.

    OpenITS does not currently meet or enforce 80% statement coverage: there is no coverage reporting in CI, no coverage threshold in phpunit.xml, and the existing 69 tests focus on auth/C4/settings—not enough to plausibly cover ≥80% of statements across app/.

    To work toward Met: add PCOV in the Tests workflow, run php artisan test --coverage --min=80 (or PHPUnit with a coverage report), and expand tests until coverage stays at or above 80%.


  • New functionality testing


    Enough for a badge!

    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    Formal policy is in CONTRIBUTING.md § Test policy: “New major functionality must include tests” (PHPUnit feature/unit tests in tests/Feature/ or tests/Unit/). It is also required in the contribution steps and PR checklist, and linked from README.

    URL: https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#test-policy


    Enough for a badge!

    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]
    However, even an informal rule is acceptable as long as the tests are being added in practice.

    The test policy is documented in CONTRIBUTING.md, which is the project's change-proposal guide. It instructs contributors to add tests for new major functionality, describes where to place them, and includes a PR checklist item requiring tests for new features.

    Key URLs:


  • Warning flags


    Enough for a badge!

    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
    Some warnings cannot be effectively enabled on some projects. What is needed is evidence that the project is striving to enable warning flags where it can, so that errors are detected early.

    For PHP, the project applies practical strictness where compiler-style warning flags are not available: Laravel Pint enforces PSR-12 across the entire codebase (composer lint passes on 241 files with zero issues), CONTRIBUTING.md requires lint before pull requests, and coding standards encourage declare(strict_types=1), typed properties, and return types on PHP 8.2+.

    Key URLs:


 Security 13/13 ●

  • Secure development knowledge


    Enough for a badge!

    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]
    For example, the project results should have fail-safe defaults (access decisions should deny by default, and projects' installation should be secure by default). They should also have complete mediation (every access that might be limited must be checked for authority and be non-bypassable). Note that in some cases principles will conflict, in which case a choice must be made (e.g., many mechanisms can make things more complex, contravening "economy of mechanism" / keep it simple).

    OpenITS applies secure-design practices in code and docs: secure defaults (REGISTRATION_ENABLED=false, APP_DEBUG=false in production), least privilege (admin-only settings), input validation (Form Requests), defense in depth (rate limiting, security headers, Sanctum, LDAPS/TLS), fail-secure login lockouts, and bcrypt/random_bytes() for secrets — documented under README Security and SECURITY.md (crypto, hardening, vulnerability process).

    URL: https://github.com/imRezaAlie/openits/blob/main/README.md#security
    (or https://github.com/imRezaAlie/openits/blob/main/SECURITY.md


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

    Enough for a badge!

    The default security mechanisms within the software produced by the project MUST 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]
    Concerns about CBC mode in SSH are discussed in CERT: SSH CBC vulnerability.

    OpenITS avoids cryptographic algorithms and modes with known serious weaknesses in its default security mechanisms. Password hashing uses bcrypt (not SHA-1). Application encryption uses AES-256-CBC via Laravel (not SSH CBC). API tokens use Laravel Sanctum (SHA-256 class hashing). The project does not implement SSH or use MD5, SHA-1, DES, or RC4 for security-sensitive operations. SECURITY.md documents avoidance of weak algorithms.

    Key URLs: https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#cryptography-practices https://github.com/imRezaAlie/openits/blob/main/config/app.php https://github.com/imRezaAlie/openits#security


    Barely enough for a badge.

    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    OpenITS relies on fixed Laravel/PHP defaults—mainly bcrypt for passwords and AES-256-CBC for app encryption (config/app.php)—without documenting or exposing quick switching among multiple symmetric algorithms (e.g. AES / Twofish / Serpent) or hash families (SHA-2 variants / SHA-3). BCRYPT_ROUNDS adjusts strength, not algorithm. Laravel can use Argon2 via HASH_DRIVER, but OpenITS does not document that as a supported, user-facing agility option.

    URL (current crypto docs): https://github.com/imRezaAlie/openits/blob/main/SECURITY.md#cryptography-practices


    Enough for a badge!

    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    https://github.com/imRezaAlie/openits/blob/main/README.md


    Enough for a badge!

    The software produced by the project SHOULD 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 SHOULD 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]

    https://github.com/imRezaAlie/openits/blob/main/README.md#transport--session-hardening-production


    Enough for a badge!

    The software produced by the project SHOULD, 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]

    https://github.com/imRezaAlie/openits/blob/main/README.md#transport--session-hardening-production


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]
    Note that incorrect TLS certificate verification is a common mistake. For more information, see "The Most Dangerous Code in the World: Validating SSL Certificates in Non-Browser Software" by Martin Georgiev et al. and "Do you trust this application?" by Michael Catanzaro.

    https://github.com/imRezaAlie/openits/blob/main/README.md#transport--session-hardening-production


    Enough for a badge!

    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    https://github.com/imRezaAlie/openits/blob/main/README.md#transport--session-hardening-production


  • Secure release


    Enough for a badge!

    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]
    The project results include both source code and any generated deliverables where applicable (e.g., executables, packages, and containers). Generated deliverables MAY be signed separately from source code. These MAY be implemented as signed git tags (using cryptographic digital signatures). Projects MAY provide generated results separately from tools like git, but in those cases, the separate results MUST be separately signed.

    OpenITS distributes software for public use (GitHub clone, GitHub Releases e.g. v1.1.0), so this is not N/A.

    What is missing for signed_releases:


    Barely enough for a badge.

    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    OpenITS publishes version tags (e.g. v1.1.0; see GOVERNANCE.md) and uses DCO commit sign-off (git commit -s), but release tags are not cryptographically GPG-signed or documented for verification per signed_releases.

    To meet it: sign important tags with GPG (git tag -s v1.2.0 -m "...") and document verification steps in RELEASE/SECURITY docs.


  • Other security issues


    Enough for a badge!

    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]
    Note that comparing input against a list of "bad formats" (aka a *denylist*) is normally not enough, because attackers can often work around a denylist. In particular, numbers are converted into internal formats and then checked if they are between their minimum and maximum (inclusive), and text strings are checked to ensure that they are valid text patterns (e.g., valid UTF-8, length, syntax, etc.). Some data may need to be "anything at all" (e.g., a file uploader), but these would typically be rare.

    Untrusted input is validated with allowlists and rejected when invalid: Laravel Form Request classes (app/Http/Requests/) and $request->validate() across controllers use Rule::in(), in:…, type/length rules, and related constraints (e.g. API version status ∈ {active,deprecated,draft}, LDAP domain limited to configured domains, enum fields for data layers and diagram types). Invalid input is rejected by Laravel validation before business logic runs. Policy is documented in CONTRIBUTING (Form Requests required) and ASSURANCE_CASE (SR-4).

    URL: https://github.com/imRezaAlie/openits/blob/main/CONTRIBUTING.md#coding-standards
    Example code: https://github.com/imRezaAlie/openits/blob/main/app/Http/Requests/Auth/LdapLoginRequest.php


    Enough for a badge!

    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]
    Hardening mechanisms may include HTTP headers like Content Security Policy (CSP), compiler flags to mitigate attacks (such as -fstack-protector), or compiler flags to eliminate undefined behavior. For our purposes least privilege is not considered a hardening mechanism (least privilege is important, but separate).

    OpenITS uses several hardening mechanisms that limit the impact of defects: login rate limiting (LoginThrottleService), security headers middleware, secure production defaults (APP_DEBUG=false, SESSION_ENCRYPT, SESSION_SECURE_COOKIE), LDAPS/TLS and LDAP filter escaping, SSRF checks on LDAP host tests, CSRF protection, bcrypt password hashing, Sanctum token expiration, optional C4 share passwords, and deployment hardening (DEPLOYMENT_ENABLED=false, REGISTRATION_ENABLED=false by default).

    URL: https://github.com/imRezaAlie/openits/blob/main/README.md#security
    (or https://github.com/imRezaAlie/openits/blob/main/SEC


    Enough for a badge!

    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]
    An assurance case is "a documented body of evidence that provides a convincing and valid argument that a specified set of critical claims regarding a system’s properties are adequately justified for a given application in a given environment" ("Software Assurance Using Structured Assurance Case Models", Thomas Rhodes et al, NIST Interagency Report 7608). Trust boundaries are boundaries where data or execution changes its level of trust, e.g., a server's boundaries in a typical web application. It's common to list secure design principles (such as Saltzer and Schroeer) and common implementation security weaknesses (such as the OWASP top 10 or CWE/SANS top 25), and show how each are countered. The BadgeApp assurance case may be a useful example. This is related to documentation_security, documentation_architecture, and implement_secure_design.

    https://github.com/imRezaAlie/openits/blob/main/ASSURANCE_CASE.md

    ASSURANCE_CASE.md is the formal security assurance case. It defines security requirements (SR-1–SR-7), a STRIDE-oriented threat model (assets, adversaries, threats), trust boundaries (client/TLS, public vs authenticated vs admin, data plane), arguments that secure design principles are applied (secure defaults, least privilege, defense in depth, fail secure), and a mapping of common implementation weaknesses (SQLi, XSS, CSRF, broken auth, LDAP injection, SSRF, weak crypto, vulnerable dependencies) to concrete OpenITS controls and code/docs. Linked from SECURITY.md, README Security, and GOVERNANCE.md.


 Analysis 2/2 ●

  • Static code analysis


    Enough for a badge!

    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]
    Static analysis tools that are specifically designed to look for common vulnerabilities are more likely to find them. That said, using any static tools will typically help find some problems, so we are suggesting but not requiring this for the 'passing' level badge.

    No static analysis tool with vulnerability-detection rules is configured. Adding Larastan/PHPStan with security-focused rules (e.g., phpstan/phpstan-strict-rules or a security plugin) would satisfy this criterion.
    Key URLs:
    https://github.com/imRezaAlie/openits/blob/main/composer.json
    https://github.com/imRezaAlie/openits/blob/main/pint.json


  • Dynamic code analysis


    Enough for a badge!

    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) MUST 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]
    Examples of mechanisms to detect memory safety problems include Address Sanitizer (ASAN) (available in GCC and LLVM), Memory Sanitizer, and valgrind. Other potentially-used tools include thread sanitizer and undefined behavior sanitizer. Widespread assertions would also work.

    The project is a Laravel (PHP) web application with JavaScript frontend assets. No C/C++ or other memory-unsafe language code is produced by the project.

    Key URL:
    https://github.com/imRezaAlie/openits/blob/main/composer.json



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

Project badge entry owned by: Reza.
Entry created on 2026-06-24 09:21:24 UTC, last updated on 2026-06-24 12:36:55 UTC. Last achieved passing badge on 2026-06-24 11:07:00 UTC.