LinuxTV

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

    The LinuxTV community develops and maintains the Linux Kernel Media Subsystems and several userspace libraries and applications.

    The Linux Kernel Media Subsystems provide support for devices like webcams, streaming capture and output, analog TV, digital TV, AM/FM radio, Sofware Digital Radio (SDR), remote controllers and encoders/decoders for compressed video formats. It offers native support for a large number of drivers for commonly available PCI cards and USB devices, but the subsystems are also targeted towards Linux based set-top-boxes and embedded devices like mobile phones.

    The main goal is to develop the Linux Kernel media subsystem.

    We also develop a series of userspace applications, tools and libraries: v4l-utils, ZBar, Kaffeine, XawTv, TVtime, Camorama, EDID decode, Digital TV tables. While several applications are used primarely by end users, for the developers of the project, their primary goal is to be able to test the Kernel development and to provide userspace libraries to enhance the media subsystem support.

    What programming language(s) are used to implement the project?
  • Basic project website content


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

    Project goals is clearly at the main page; each git tree we host have their own short descriptions. We maintain a Wiki page with all project details.



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

    The wiki pages have a developer's section explaining it: https://linuxtv.org/wiki/index.php/Developer_section There are also ReST documentation at the Kernel tree with the Linux Kernel documentation, with applies to all the Kernel development, including the media subsystem.



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

    The contribution process is explained at https://linuxtv.org/wiki/index.php/Developer_section This project doesn't use GitHub. Instead, discussions, patches and pull requests goes via a mailing list (linux-media@vger.kernel.org), for all trees we host (both kernelspace and userspace).



    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]

    We adopt Kernel coding style: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches That's also described at the Wiki.


  • FLOSS license

    What license(s) is the project released under?



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

    GPL-2.0-only The GPL-2.0-only license is approved by the Open Source Initiative (OSI).



    It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI). [floss_license_osi]

    The main license we use is GPL-2.0-only for the Linux Kernel. Userspace libraries and tools developed by the project are under LGPL and GPL. Some documentation are under GFDL with no invariant sections. Both GPL and LGPL are approved OSS licenses. The GPL-2.0-only license is approved by the Open Source Initiative (OSI).



    The project MUST post the license(s) of its results in a standard location in their source repository. (URL required) [license_location]

    At libraries/tools, license is at COPYING files; at the Linux Kernel, the COPYING file points to the location of the SPDX licenses that apply: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/COPYING.


  • Documentation


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

    There is a comprehensive set of documentation at: https://linuxtv.org/docs.php



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

    There is a comprehensive set of documentation at: https://linuxtv.org/docs.php


  • Other


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

    Given only https: URLs.



    The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. [discussion]

    Most discussions happen at the open public mailing list (linux-media@vger.kernel.org). We also maintain #v4l and #linuxtv channels at irc.freenode.net.



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

    English is the preferred language, used on our channels.



    The project MUST be maintained. [maintained]


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



  • Public version-controlled source repository


    The project MUST have a version-controlled source repository that is publicly readable and has a URL. [repo_public]

    We use Git for all sub-projects.



    The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. [repo_track]

    We use Git for all sub-projects.



    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]

    Development is continuous using git. Patches contain incremental changes.



    It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. [repo_distributed]

    We use Git for all sub-projects.


  • Unique version numbering


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

    We use formal release versions.



    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]

    Most of the trees we use use SemVer. Linux Kernel doesn't use, neither does XawTv, due to historical reasons.



    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]

    We have tags for every release stored at the git repository.


  • Release notes


    The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes]

    Kernel community maintain release notes on separate sites, like lwn.net and kernel-newbies: https://kernelnewbies.org/LinuxVersions

    On other sub-projects, we maintain a ChangeLog file summarizing the changes.



    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]

    Kernel CVE are propely documented. For other sub-projects, we never got a CVE assignment.


  • Bug-reporting process


    The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process]

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

    For the Kernel, we use: https://bugzilla.kernel.org. Other sub-projects use GitHub; Kaffeine uses http://bugs.kde.org/.



    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]

    We answer to bug reports via mailing list.



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

    We accept enhancements in the form of patches submitted by interested parties. As this is related to hardware, and the number of media hardware is pretty big, enhancement development require developers to have the specific hardware in hands. We are not able to acquire all hardware we would need for hardware-specific development.



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

    There are several mirrors for the mailing lists. The main one is at: https://lore.kernel.org/linux-media/ we also maintain logs for the IRC channel discussions.


  • Vulnerability report process


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

    The only vulnerabilities we ever got are related to the Kernel. There's a documented process about reporting security issues to the Linux Kernel: https://www.kernel.org/doc/html/latest/admin-guide/security-bugs.html



    If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private]

    The only vulnerabilities we ever got are related to the Kernel. There's a documented process about reporting security issues to the Linux Kernel: https://www.kernel.org/doc/html/latest/admin-guide/security-bugs.html



    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]

    Most of the time, we don't receive any vulnerability to the media subsystem. Last year, we got only one CVE and one private report at the beginning of 2018. Once we received the reports, they were promptly solved.


  • Working build system


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

    Kernel just uses standard Makefiles; other projects use cmake or autotools.



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

    Kernel just uses standard Makefiles; other projects use cmake or autotools.



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

    Everything is buildable with standard FLOSS tools like GNU c and glibc. No need to use proprietary build tools.


  • Automated test suite


    The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). The project MUST clearly show or document how to run the test suite(s) (e.g., via a continuous integration (CI) script or via documentation in files such as BUILD.md, README.md, or CONTRIBUTING.md). [test]

    The Linux Kernel has several CI tools. One of them is at: https://kernelci.org/ We also have apps to check the compliance with hardware drivers with media APIs. We're in the process of adding CI for other sub-projects.



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

    As most of the stuff is hardware-dependent, there's no way to implement unit tests. So, we designed a test suite to check if the Kernel drivers are properly implementing the media APIs. The main tool is v4l2-compliance. We also provide a set of other tools in order to test the hardware.



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

    As most of the stuff is hardware-dependent, there's no way to implement unit tests. So, we designed a test suite to check if the Kernel drivers are properly implementing the media APIs. The main tool is v4l2-compliance. We also provide a set of other tools in order to test the hardware.



    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]

    The Linux Kernel has several CI tools. One of them is at: https://kernelci.org/ We also have apps to check the compliance with hardware drivers with media APIs. We're in the process of adding CI for other sub-projects.


  • New functionality testing


    The project MUST have a general policy (formal or not) that as major new functionality is added to the software produced by the project, tests of that functionality should be added to an automated test suite. [test_policy]

    We follow Linux Kernel policies.



    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]

    New drivers are required to pass at the compliance tools. The results of the tests should be submitted together with the patchsets adding the drivers.



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

    We follow Linux Kernel policies.


  • Warning flags


    The project MUST enable one or more compiler warning flags, a "safe" language mode, or use a separate "linter" tool to look for code quality errors or common simple mistakes, if there is at least one FLOSS tool that can implement this criterion in the selected language. [warnings]

    We have low tolerance to warnings at the project. Besides compiler warnings, we also test the Kernel multimedia subsystem with Coverity, Sparse and Smatch static code analyzers.



    The project MUST address warnings. [warnings_fixed]

    Our goal is to have zero warnings when the media subsystem is built with W=1 (with enables lots of additional warnings over the usual Kernel standard).



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

    We follow the Kernel policies. On distros, usually all warnings produce errors. At the Linux Kernel, this is an optional build feature.


  • Secure development knowledge


    The project MUST have at least one primary developer who knows how to design secure software. (See ‘details’ for the exact requirements.) [know_secure_design]

    The project main maintainer has CISSP certification (https://www.isc2.org/Certifications/CISSP).



    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 main maintainer has CISSP certification (https://www.isc2.org/Certifications/CISSP).


  • Use basic good cryptographic practices

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

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

    We don't implement cryptography at the project. The website are https only.



    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]

    We don't implement cryptography at the project.



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

    We don't implement cryptography at the project. The DVB API supports access to DVB CI hardware modules (with are meant to implement cryptography), but the implementation is out of the scope of the project, as we just enable access to the hardware cryptographic functions.



    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]

    We don't implement cryptography at the project.



    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]

    We don't implement cryptography at the project.



    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]

    We don't implement cryptography at the project.



    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]

    We don't implement cryptography at the project.



    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]

    Only Camorama sub-project may allow the user to optionally store passwords, but this is done via standard Glib authentication mechanism. Nothing is stored directly by it.



    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]

    We don't implement cryptography at the project nor depend on random number generator.


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


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

    Only camorama may use URLs to store camera images on a remote place. The mechanism supports https and scp.



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

    We don't implement cryptography at the project. The website we use is https only.


  • Publicly known vulnerabilities fixed


    There MUST be no unpatched vulnerabilities of medium or higher severity that have been publicly known for more than 60 days. [vulnerabilities_fixed_60_days]

    There's no known unpatch vulnerabilities.



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

    We speed up fixes for critical vulnerabilities.


  • Other security issues


    The public repositories MUST NOT leak a valid private credential (e.g., a working password or private key) that is intended to limit public access. [no_leaked_credentials]

    We do our best efforts to keep private data confidential. We also have a privacy policy implemented: https://linuxtv.org/wiki/index.php/LinuxTVWiki:Privacy_policy


  • Static code analysis


    At least one static code analysis tool (beyond compiler warnings and "safe" language modes) MUST be applied to any proposed major production release of the software before its release, if there is at least one FLOSS tool that implements this criterion in the selected language. [static_analysis]

    Coverity, sparse, smatch.



    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 tools we use check for common vulnerabilities.



    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]

    Our goal is to have zero warnings from static code analyzers and compiler warnings (except for false-positive ones).



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

    We run sparse and smatch for every single commit applied to the tree.


  • Dynamic code analysis


    It is SUGGESTED that at least one dynamic analysis tool be applied to any proposed major production release of the software before its release. [dynamic_analysis]

    https://01.org/lkp/documentation/0-day-test-service runs lots of these tools on all trees before release.



    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]

    We don't run directly any fuzzer, but there are a group of Kernel developers doing that and doing periodic reports to our channels.



    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]

    Look at all of the wonderful BUG_ON() calls in the kernel (hint, you really don't want those to ever trigger, but they are there...) Outside the Kernel, errors are properly handled by the library and tools, reporting runtime errors or using assert() calls.



    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]

    We actively monitor reports from Kernel fuzzer projects and address them.



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

Project badge entry owned by: Mauro Carvalho Chehab.
Entry created on 2019-02-27 12:44:33 UTC, last updated on 2019-02-28 00:30:38 UTC. Last achieved passing badge on 2019-02-27 15:18:02 UTC.

Back