kurento-media-server

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 4385 is passing 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

    Media Server responsible for media transmission, processing, loading and recording

    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]

    http://www.kurento.org/whats-kurento


    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]

    http://www.kurento.org/community


    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]

    Projects on GitHub by default use issues and pull requests, as encouraged by documentation such as https://guides.github.com/activities/contributing-to-open-source/.


    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]

    https://doc-kurento.readthedocs.io/en/stable/project/contributing.html


  • 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/Kurento/kurento-media-server/blob/master/LICENSE.


  • Documentation


    Enough for a badge!

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

    https://doc-kurento.readthedocs.io/en/stable/


    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://doc-kurento.readthedocs.io/en/stable/features/kurento_api.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.


    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.


    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]

    In http://www.kurento.org/ you may find all the documentation in English about everything from general information, technical and dev, how to interact with the community, how to contribute, how to report bugs, etc


    Enough for a badge!

    The project MUST be maintained. [maintained]


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


    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.


    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]

    Al the code pushed to master is a interim version with appropriate comments and public available nightly versions to test.


    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.


  • 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://doc-kurento.readthedocs.io/en/stable/dev/release.html here you can find how the versioning works and how it must be interpreted.


    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/Kurento/kurento-media-server/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/Kurento/kurento-media-server/blob/master/CHANGELOG.md. Change log is also available in the project main page https://doc-kurento.readthedocs.io/en/latest/project/relnotes/index.html


    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]

    We will use the security label in the bugtracker in combination with the rest of the badges to mark the criticalness. And then in the release notes the id of the github issue will be used. Within the Release Notes we have a section "Fixed" where all the bugs fixed are listed -with its reference to the github issue id (if any) is provided- We don't have an specific way of register or link them with known CVE. That is because all the security bugs found and solved have been bugs on third party libraries, for example a bug on the libnice library that is reported to have a security bug, and we will update this third party library in the next release, with the latest version that solves this issue. Kurento could be probably added to the low-level software.


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

    We have both mailing list https://groups.google.com/forum/#!forum/kurento and issue trackerhttps://github.com/Kurento/bugtracker


    Enough for a badge!

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

    https://github.com/Kurento/bugtracker


    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]

    Met on best effort the project is maintained by a small group but is big and heavily used and we try to acknowledge all the issues reported and provide workarrounds or evaluate the criticalness.


    Enough for a badge!

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

    Met on best effort the project is maintained by a small group but is big and heavily used and we try to acknowledge all the enhancement request .


    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/Kurento/bugtracker


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

    There is an specific label on the GitHub. We don't have an specific way of reporting but the usual one, the community has used the bugtracker or the mailing list effectively and the issues have always being addressed. https://github.com/Kurento/bugtracker/issues


    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]

    No private reports are requested or supported by default.


    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]

    We give our first response to all the issues reported as soon as possible being always under 7 days from reporting. This is no a vulnerability exactly but is an enhanced related to security and you can assess that we are actively listening the community regarding this. https://github.com/Kurento/bugtracker/issues/518 yo may take also any other issue of the last 6 months.


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

    Non-trivial build file in repository: https://github.com/Kurento/kurento-media-server/blob/master/CMakeLists.txt.


    Enough for a badge!

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

    Non-trivial build file in repository: https://github.com/Kurento/kurento-media-server/blob/master/CMakeLists.txt.


    Enough for a badge!

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

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

    We have a Jenkins CI in place with some jobs that run the available jobs found in the repositories. https://doc-kurento.readthedocs.io/en/stable/dev/ci.html


    Enough for a badge!

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

    https://doc-kurento.readthedocs.io/en/latest/dev/testing.html here there is a whole explanation of what are the provided test and how execute them.


    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]

    Kurento not only provides a big set of unitary tests but provides functional tests over demo projects to address the validation of each release and validate it is working. Kurento doesn't maintain different code branches, doesn't have user interaction (no input fields).


    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]

    We have a Jenkins CI in place that compiles, test and submit the compiled and dockerized software to the standard repositories.


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

    Unitary tests are always developed for new functionalities, unless they are irrelevant. The CI/CV server executes all test before any release and the tests are public for al the contributors and users to use.


    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]

    The tests are public and main functionality is quite stable. Major changes that affect tests provoke the tests to be changed or they will fail and the release could not happen. Just if the SW has been released it means it has been tested.


    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]

    In the "Instructions for change requests" the template of PR ask twice for the tests (https://github.com/Kurento/.github/blob/master/pull_request_template.md): 1. In a free text field where it should be explained how it has been tested 2. Checkbox indicating if new tests have been written. We usually evaluate those conditions as compulsory requirement.


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

    Kurento Releases are built firstly as .deb packages to be instaled in Debian/Ubuntu systems. The system tools which generate this files are also the ones activating all security mechanisms when compiling sources: (i) all warnings as errors, (2) memory safety ASLR and many other following the usual recomendations of binary compilings.


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    As treating all WARNING as ERRORS at compilation time if the WARNING isn't addressed there wouldn't be a new release.


    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]

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

    https://github.com/j1elo


    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]

    https://github.com/j1elo


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

    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]

    Enough for a badge!

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

    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]

    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]

    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]

    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]

    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]

    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]

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

    We delegate the secutirty to our standard distribution mechanisms. Deb repositories verify all the packages with a unique GPG for each project this way even HTTP downloads can be granted as secured. On the other hand we deliver the software as Docker images publicly hosted on DockerHub and we relay on the download security mechanism DockerHub may implement.


    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]

    See previous answer.


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

    We prioritize vulnerabilities and crashes over any other issue or request for changes.


    Enough for a badge!

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

    We prioritize vulnerabilities and crashes over any other issue or request for changes.


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

    No need of private Keys


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

    We use clang-tidy y clang-analyzer.


    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]

    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]

    Barely enough for a badge.

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

    We execute them manually when we see fit.


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

    Valgrind & AddressSanitizer, but we don't have them integrated in the release cycle we use them when we see fit.


    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]

    Valgrind y AddressSanitizer. But as our memory leaks or similar problems usually occur under scenarios very difficult to reproduce. Thus we offer a custom Docker image with AddressSanitizer to users. Then in the case any user finds memory leaks the execution of this image in their specific use case will provide us (and all the community) with the results and can help us to solve the issue.


    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]

    We do but we deactivate all asserts for final builds each release because third party assertions -specifically libnice- were more than a 20% of reported crashes, However they are enabled for debug sessions and code analysis.


    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]

    Any error including exploitable vulnerabilities detected are always addressed before launching a release and if detected after the release will be solved and released as a patch in case of critical vulnerabilities or added to the next release for not critical vulnerabilities. .



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

Project badge entry owned by: Guiomar.
Entry created on 2020-10-29 10:50:56 UTC, last updated on 2020-11-12 09:50:41 UTC. Last achieved passing badge on 2020-11-12 09:42:10 UTC.

Back