anomalib

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 8330 is silver 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

    An anomaly detection library comprising state-of-the-art algorithms and features such as experiment management, hyper-parameter optimization, and edge inference.

    What programming language(s) are used to implement the project?

  • Basic project website content


    Enough for a badge!

    The project website MUST succinctly describe what the software does (what problem does it solve?). [description_good]

    https://github.com/openvinotoolkit/anomalib


    Enough for a badge!

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

    Bug report https://github.com/openvinotoolkit/anomalib/issues/new?assignees=&labels=&projects=&template=bug_report.yaml&title=%5BBug%5D%3A+

    Contribution https://github.com/openvinotoolkit/anomalib/blob/main/CONTRIBUTING.md


    Enough for a badge!

    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/openvinotoolkit/anomalib/blob/main/CONTRIBUTING.md.


    Enough for a badge!

    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]

    Anomalib list the pre-commit checks that are the main requirements to be able to merge a pr https://github.com/openvinotoolkit/anomalib/blob/main/CONTRIBUTING.md#development--prs


  • FLOSS license

    What license(s) is the project released under?


    Enough for a badge!

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


    Enough for a badge!

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


    Enough for a badge!

    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/openvinotoolkit/anomalib/blob/main/LICENSE.


  • Documentation


    Enough for a badge!

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

    https://anomalib.readthedocs.io/en/latest/


    Enough for a badge!

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

    https://anomalib.readthedocs.io/en/latest/markdown/guides/reference/index.html


  • Other


    Enough for a badge!

    The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. [sites_https]

    Given only https: URLs. https://github.com/openvinotoolkit/anomalib https://anomalib.readthedocs.io/en


    Enough for a badge!

    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. https://github.com/openvinotoolkit/anomalib/issues https://github.com/openvinotoolkit/anomalib/discussions


    Enough for a badge!

    The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. [english]

    https://github.com/openvinotoolkit/anomalib/issues/new/choose


    Enough for a badge!

    The project MUST be maintained. [maintained]

    Anomalib is maintained daily. You could refer to the git history. https://github.com/openvinotoolkit/anomalib/commits/main/



(Advanced) What other users have additional rights to edit this badge entry? Currently: []



  • Public version-controlled source repository


    Enough for a badge!

    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. https://github.com/openvinotoolkit/anomalib


    Enough for a badge!

    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. https://github.com/openvinotoolkit/anomalib/commits/main/ Repository on GitHub, which uses git. git can track the changes, who made them, and when they were made.


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/releases


    Enough for a badge!

    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. https://github.com/openvinotoolkit/anomalib Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


    Enough for a badge!

    The project results MUST have a unique version identifier for each release intended to be used by users. [version_unique]

    https://github.com/openvinotoolkit/anomalib/tags


    Enough for a badge!

    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]

    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/tags


  • Release notes


    Enough for a badge!

    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]

    Non-trivial release notes file in repository: https://github.com/openvinotoolkit/anomalib/blob/main/CHANGELOG.md.


    Enough for a badge!

    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]

    there have been no publicly known vulnerabilities


  • Bug-reporting process


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/issues/new?assignees=&labels=&projects=&template=bug_report.yaml&title=%5BBug%5D%3A+


    Enough for a badge!

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

    https://github.com/openvinotoolkit/anomalib/issues


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/issues?q=is%3Aissue+is%3Aclosed


    Enough for a badge!

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

    https://github.com/openvinotoolkit/anomalib/issues?q=is%3Aissue+is%3Aclosed


    Enough for a badge!

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

    https://github.com/openvinotoolkit/anomalib/issues?q=is%3Aissue+is%3Aclosed


  • Vulnerability report process


    Enough for a badge!

    The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process]

    https://github.com/openvinotoolkit/anomalib/security/policy


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/blob/main/SECURITY.md


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/issues?q=is%3Aissue+is%3Aclosed


  • Working build system


    Enough for a badge!

    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]

    the project provides both pypi installation and source installation options, with instructions showing how to do each https://github.com/openvinotoolkit/anomalib?tab=readme-ov-file#-installation


    Enough for a badge!

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

    the project provides both pypi installation and source installation options, with instructions showing how to do each https://github.com/openvinotoolkit/anomalib?tab=readme-ov-file#-installation


    Enough for a badge!

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

    Readme https://github.com/openvinotoolkit/anomalib/blob/main/README.md

    Docs https://anomalib.readthedocs.io/en/latest/index.html

    Dependencies https://github.com/openvinotoolkit/anomalib/tree/main/requirements

    Setup File https://github.com/openvinotoolkit/anomalib/blob/main/setup.py


  • Automated test suite


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/blob/main/CONTRIBUTING.md


    Enough for a badge!

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

    Anomalib uses tox to automate tests. https://github.com/openvinotoolkit/anomalib/blob/main/tox.ini


    Enough for a badge!

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

    Anomalib achieves 83% test coverage https://app.codecov.io/gh/openvinotoolkit/anomalib


    Enough for a badge!

    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]

    Anomalib uses github actions to trigger tests for each pull request created https://github.com/openvinotoolkit/anomalib/tree/main/.github/workflows


  • New functionality testing


    Enough for a badge!

    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]

    Anomalib has a pull request template that explicitly asks for tests when there is a new functionality added https://github.com/openvinotoolkit/anomalib/blob/main/.github/pull_request_template.md


    Enough for a badge!

    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]

    Each PR is checked by codecov https://app.codecov.io/gh/openvinotoolkit/anomalib

    Each tests results are reported in github actions https://github.com/openvinotoolkit/anomalib/actions/runs/7667924427


    Enough for a badge!

    It is SUGGESTED that this policy on adding tests (see test_policy) be documented in the instructions for change proposals. [tests_documented_added]

    it is documented in conrtibuting guidelines https://github.com/openvinotoolkit/anomalib/blob/main/CONTRIBUTING.md

    as well as in the developer guides in the docs https://anomalib.readthedocs.io/en/latest/


  • Warning flags


    Enough for a badge!

    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]

    anomalib uses ruff to enables these warnings https://github.com/openvinotoolkit/anomalib/blob/main/pyproject.toml


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    The PRs cannot be merged without these warnings are addressed. https://github.com/openvinotoolkit/anomalib/blob/main/tox.ini#L20


    Enough for a badge!

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

    Anomalib uses almost all of the ruff checks to be maximally strict with the warnings https://github.com/openvinotoolkit/anomalib/blob/main/pyproject.toml


  • Secure development knowledge


    Enough for a badge!

    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]

    The project has three core engineers who knows how to design secure software.


    Enough for a badge!

    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]

    The project has three core engineers who know of common kinds of errors that lead to vulnerabilities. In addition, the project is regularly checked for vulnerabilities.


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

    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]

    The project uses secure cryptographic criteria. For example see the following https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


    Enough for a badge!

    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]

    The project uses already well established functions. for example https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py#L7


    Enough for a badge!

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

    https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


    Enough for a badge!

    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]

    https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


    Enough for a badge!

    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 project uses sha-256 https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


    Enough for a badge!

    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]

    The project uses SHA-256 to compare the hash when downloading files https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


    Enough for a badge!

    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]

    The project uses Weights and Biases and Comet.ML, both of which have their own security measures for keys. https://wandb.ai/site https://www.comet.com/site/


    Enough for a badge!

    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]

    The project does not require password authentication. when logging data, the project optionally uses external tools such as weights and biases and comet.ml, both of which have their own strict security measures for password authentication https://wandb.ai/site https://www.comet.com/site/


    Enough for a badge!

    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]

    The project uses numpy's new secure random number generator https://numpy.org/doc/stable/reference/random/generator.html


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


    Enough for a badge!

    The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm]

    The project uses Github as the project's source code, which support HTTPS and SSH for data transmission.


    Enough for a badge!

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

    The project has a hash checker utility function that used sha-256 https://github.com/openvinotoolkit/anomalib/blob/main/src/anomalib/data/utils/download.py


  • Publicly known vulnerabilities fixed


    Enough for a badge!

    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]

    There is no unpatched vulnerabilities of medium or higher severity in the repo that have been publicly known for more than 60 days. https://github.com/openvinotoolkit/anomalib/security


    Enough for a badge!

    Projects SHOULD fix all critical vulnerabilities rapidly after they are reported. [vulnerabilities_critical_fixed]

    https://github.com/openvinotoolkit/anomalib/security https://github.com/openvinotoolkit/anomalib/pull/1672


  • Other security issues


    Enough for a badge!

    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]

    the project uses github and ssh protocol and does not leak any private credential https://github.com/openvinotoolkit/anomalib


  • Static code analysis


    Enough for a badge!

    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]

    The project uses ruff, pylint, flake8 and many other tools to analyse the code https://github.com/openvinotoolkit/anomalib/blob/main/pyproject.toml


    Enough for a badge!

    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]

    The project is scanned by Trivy daily. https://github.com/openvinotoolkit/anomalib/blob/main/.github/workflows/code_scan.yml


    Enough for a badge!

    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]

    The anomalib team always quickly address the vulnerabilities in a timely manner https://github.com/openvinotoolkit/anomalib/pull/1672 https://github.com/openvinotoolkit/anomalib/pull/1668 https://github.com/openvinotoolkit/anomalib/pull/1656 https://github.com/openvinotoolkit/anomalib/pull/1643


    Enough for a badge!

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

    The project uses pre-commit to perform the static code analysis on every commit. https://github.com/openvinotoolkit/anomalib/blob/main/.pre-commit-config.yaml


  • Dynamic code analysis


    Enough for a badge!

    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]

    The project uses pytest and tox to automate test for dynamic analysis, which is performed for each pull request. https://github.com/openvinotoolkit/anomalib/blob/main/.github/workflows/pre_merge.yml


    Enough for a badge!

    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]

    the project is written with python


    Enough for a badge!

    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]

    the project has a testing suite for dynamic analysis that enables many assertions. https://github.com/openvinotoolkit/anomalib/tree/main/tests


    Enough for a badge!

    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]

    All medium and higher severity exploitable vulnerabilities discovered with dynamic code analysis are fixed timely. Otherwise, The PRs cannot be merged https://github.com/openvinotoolkit/anomalib/pulls?q=is%3Apr+is%3Aclosed



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

Project badge entry owned by: Samet Akcay.
Entry created on 2024-01-23 14:42:46 UTC, last updated on 2024-02-20 13:59:47 UTC. Last achieved passing badge on 2024-01-26 15:12:24 UTC.

Back