uds

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

    Python package for handling Unified Diagnostic Services (UDS) protocol defined by ISO 14229. It supports different communication buses on both sides of communication (client and server).

    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]

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

    All the information are provided in CONTRIBUTING.md file: https://github.com/mdabrowski1990/uds/blob/main/CONTRIBUTING.md



    The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) [contribution]

    Wiki contains all the necessary information for contributors: https://github.com/mdabrowski1990/uds/wiki Software development process is also documented in the wiki: https://github.com/mdabrowski1990/uds/wiki/Issues-management

    Crucial links are provided in https://github.com/mdabrowski1990/uds/blob/main/CONTRIBUTING.md (including link to wiki)



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

    Wiki contains all the necessary information for contributors: https://github.com/mdabrowski1990/uds/wiki Coding standard is also documented in the wiki: https://github.com/mdabrowski1990/uds/wiki/Coding-Standard

    Crucial links are provided in https://github.com/mdabrowski1990/uds/blob/main/CONTRIBUTING.md (including link to wiki)


  • FLOSS license

    What license(s) is the project released under?



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

    The MIT 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 MIT 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]

    Non-trivial license location file in repository: https://github.com/mdabrowski1990/uds/blob/main/LICENSE


  • Documentation


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

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


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

    Only https URLs are in use.



    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]

    Discussions might take place in issues management system (https://github.com/mdabrowski1990/uds/issues), on pull requests (https://github.com/mdabrowski1990/uds/pulls) and also via mail (https://groups.google.com/g/uds-package-development/about - development mail group).



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

    Code and documentation is written only in english.



    The project MUST be maintained. [maintained]

    Project is maintaned so far by me (the author). I had a long break (a few months) due to serious health problems, but I am back and on track to continue the work.



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

    Repository on GitHub, which provides public git repositories with URLs.



    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.



    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]

    The policy of project repository is described here: https://github.com/mdabrowski1990/uds/wiki/Repository-management

    Package contains interim versions.



    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. Repository on GitHub, which uses git. git is distributed.


  • Unique version numbering


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

    Project uses only unique 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]

    SemVer (https://semver.org/) is used.



    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]

    Git tags are used to identify releases.


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

    GitHub feature is used to provide release notes: https://github.com/mdabrowski1990/uds/releases



    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 has been no publicly known vulnerabilities.


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

    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]

    There are no issues so far, but the plan is to respond ASAP.



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

    There are no feature request so far.

    Filteres for all externally requested features: https://github.com/mdabrowski1990/uds/issues?q=is%3Aopen+%5BINVESTIGATE%5D



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


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

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

    There were not reports so far.


  • Working build system


    If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build]

    Software does not need building software (it is not compiled as this is Python).



    It is SUGGESTED that common tools be used for building the software. [build_common_tools]

    Software is ready to use as this is Python.



    The project SHOULD be buildable using only FLOSS tools. [build_floss_tools]

    Software is ready to use as this is Python.


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

    Automatic test suites exists: https://github.com/mdabrowski1990/uds/actions

    Documentation about testing approach describes CI and how to run the test suites: https://github.com/mdabrowski1990/uds/wiki/Testing

    Links to these information are also included in README and CONTRIBUTING files.



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

    CI uses: - prospector for static code analysis (pydocstyle, pycodestyle, vulture, mccabe, pylint, pyflakes and others are used) - pytest (common Python framework for testing)

    Invocation are also standard: - pytest: pytest tests/software_tests - prospector: prospector --profile tests/prospector_profile.yaml uds



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

    The tests are meant to check the entire code. Documentation is also checked (whether it builds) regularly. Coverage is supposed to be on 100% level all the time. Its measurement result is here: https://coveralls.io/github/mdabrowski1990/uds



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

    Formal testing approach is defined: https://github.com/mdabrowski1990/uds/wiki/Testing

    Formal process is defined: https://github.com/mdabrowski1990/uds/wiki/Software-Development-Life-Cycle

    Testing related chapters: - https://github.com/mdabrowski1990/uds/wiki/Software-Development-Life-Cycle#defining - plan how to test particular change is defined - https://github.com/mdabrowski1990/uds/wiki/Software-Development-Life-Cycle#implementation - unit testing, integration testing and static code analisis is always performed in this phase - https://github.com/mdabrowski1990/uds/wiki/Software-Development-Life-Cycle#testing - additional functional/system tests are performed in this phase



    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]

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

    The entire process is described in https://github.com/mdabrowski1990/uds/wiki/Software-Development-Life-Cycle It also contain information on which stage each type of tests is created and executed.

    Specific information about testing are also defined in https://github.com/mdabrowski1990/uds/wiki/Testing


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

    Advanced static code analysis (linters checking) is performed automatically against the project. CI workflow and results: https://github.com/mdabrowski1990/uds/actions/workflows/ci.yml



    The project MUST address warnings. [warnings_fixed]

    All warnings are addressed. Otherwise it blocks from delivering new changes.



    It is SUGGESTED that projects be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]
  • 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]

    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 autor (https://www.linkedin.com/in/maciej-dabrowski-test-engineer/) has strong Automotive experience (over 6 years of experience in testing Automotive software/systems) and knowledge how to test and protect against these kind of problems.


  • Use basic good cryptographic practices

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

    The software produced by the project MUST use, by default, only cryptographic protocols and algorithms that are publicly published and reviewed by experts (if cryptographic protocols and algorithms are used). [crypto_published]

    Does not apply to UDS protocol as this is defined by the vehicle manufacturer.



    If the software produced by the project is an application or library, and its primary purpose is not to implement cryptography, then it SHOULD only call on software specifically designed to implement cryptographic functions; it SHOULD NOT re-implement its own. [crypto_call]

    There are no need for crypto handlers so far.



    All functionality in the software produced by the project that depends on cryptography MUST be implementable using FLOSS. [crypto_floss]

    So far not applicable, as there is no cryptography feature.



    The security mechanisms within the software produced by the project MUST use default keylengths that at least meet the NIST minimum requirements through the year 2030 (as stated in 2012). It MUST be possible to configure the software so that smaller keylengths are completely disabled. [crypto_keylength]

    Does not apply to UDS protocol as this is defined by the vehicle manufacturer.



    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]

    Does not apply to UDS protocol as this is defined by the vehicle manufacturer.



    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]

    Does not apply to UDS protocol as this is defined by the vehicle manufacturer.



    The security mechanisms within the software produced by the project SHOULD implement perfect forward secrecy for key agreement protocols so a session key derived from a set of long-term keys cannot be compromised if one of the long-term keys is compromised in the future. [crypto_pfs]

    Does not apply to UDS protocol.



    If the software produced by the project causes the storing of 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). See also OWASP Password Storage Cheat Sheet. [crypto_password_storage]

    Does not apply to UDS protocol as this (algorithm, hashes, passwords, etc.) is defined by the vehicle manufacturer.



    The security mechanisms within the software produced by the project MUST generate all cryptographic keys and nonces using a cryptographically secure random number generator, and MUST NOT do so using generators that are cryptographically insecure. [crypto_random]

    Does not apply to UDS protocol as this is defined by the vehicle manufacturer.


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

    Github has strong protection against MITM.



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

    git and github provides these protections


  • 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 were no publicly known issues that are related to the project.



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

    There were no criticial vulnerabilities reported so far.


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

    Secrets are used (github feature).


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

    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]

    There are multiple static code analysis tools used within the project. More details: https://github.com/mdabrowski1990/uds/wiki/Testing#static-code-analysis



    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]

    Vulnerabilities are fixed imidiately after discovery as there is no way to merge changes if static code analysis fails.



    It is SUGGESTED that static source code analysis occur on every commit or at least daily. [static_analysis_often]
  • 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]

    not applicable for this project - related to embedded software



    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]

    Python is used (memory safe)



    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]

    not applicable for this project - related to embedded software



    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]

    So far there are no issues reported, but this is the plan.



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 Maciej Dąbrowski and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Maciej Dąbrowski.
Entry created on 2021-03-12 09:56:51 UTC, last updated on 2021-08-25 08:41:49 UTC. Last achieved passing badge on 2021-08-25 08:25:32 UTC.

Back