Newsboat

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 3328 is in_progress 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 RSS/Atom feed reader for text terminals

    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]

    The first paragraph at https://newsboat.org/ says: "Newsboat is an RSS/Atom feed reader for the text console. It’s an actively maintained fork of Newsbeuter."


    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]

    https://newsboat.org/ has links all the releases (clearly marking the most recent one), and also lists where to find our issue tracker, our mailing list, and our Git repository.


    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]

    "Contributing" section of our links to a document that mentions our coding guide: https://github.com/newsboat/newsboat#contributing That document also lists some of the guidelines for contributions.


  • 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 MIT 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 MIT 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/newsboat/newsboat/blob/master/LICENSE.


  • Documentation


    Enough for a badge!

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

    Links to documentation are at https://newsboat.org, the docs are also in the repository under "doc" directory.


    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]

    newsboat --help explains command-line options. The program itself has a built-in dialog that explains what different keys do; the help dialog can be invoked with "?" key, which is mentioned at every screen. Man-pages mention all the settings available, partially duplicating the HTML documentation.


  • Other


    Enough for a badge!

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

    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]

    The documentation is only available in English. All discussions (on GitHub, IRC and the mailing list) are in English.


    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]

    The repository is our primary means of collaboration, so commits are small(-ish); we sometimes squash small features into a single commit, but never a whole release.


    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]

    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]

    Newsboat releases are identified through signed Git tags: https://github.com/newsboat/newsboat/releases


  • 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/newsboat/newsboat/blob/master/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]

    Newsboat fixed two vulnerabilities that its parent project had, and identified them in the CHANGELOG: see "Fixed" section in https://github.com/newsboat/newsboat/blob/master/CHANGELOG.md#210---2017-09-20


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

    Bug reports are welcome at https://github.com/newsboat/newsboat/issues. We provide a template to help users gather all the necessary information: https://github.com/newsboat/newsboat/blob/1a71f953905976d50ba816967864eb52080e092c/.github/ISSUE_TEMPLATE


    Enough for a badge!

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

    https://github.com/newsboat/newsboat/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]

    Newsboat's maintainer, Alexander Batischev, triages new issues within a week of their submission. All issues get labels (bug/enhancement/meta etc.), I try to reproduce them with latest version from Git (and, failing that, with reporter's version), and ask for additional details if I can think of something that can help understand and fix the issue.


    Enough for a badge!

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

    The process is the same as with bug reports.


    Enough for a badge!

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

    The whole archive is searchable on GitHub: https://github.com/newsboat/newsboat/issues


  • 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://newsboat.org/ says: "If you have found a security vulnerability, please email security@newsboat.org, and use the aforementioned PGP key if at all possible." The same information is also provided in the README: https://github.com/newsboat/newsboat#support


    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://newsboat.org/ says: "If you have found a security vulnerability, please email security@newsboat.org, and use the aforementioned PGP key if at all possible." The same information is also provided in the README: https://github.com/newsboat/newsboat#support


    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]

    As of 2024-11-20, there are no known vulnerabilities in Newsboat. We fixed two vulnerabilities with our site and credited the reporter in our CHANGELOG.


  • 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/newsboat/newsboat/blob/master/Makefile.


    Enough for a badge!

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

    We use GNU Make and Cargo (Rust's build tool and package manager).


    Enough for a badge!

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

    All the required libraries, compilers, and other tools are free software or open source: https://github.com/newsboat/newsboat/tree/6522b4d2f551cc086c661aa5b74171118b51ec63#dependencies


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

    The test suite is located under "tests" directory. Rust code includes a copy, split between "rust/libnewsboat/tests", "rust/libnewsboat/proptest-regressions", doctests inside documentation, and tests modules inside the source.


    Enough for a badge!

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

    There is a Make target with a commonly-used name check which invokes C++ and Rust test suites in sequence, failing when one of the suites fail.


    Unknown required information, not 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]

    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]

    All the pull requests and merge commits are checked with Cirrus CI and GitHub Actions, which build the code on multitude of platforms using different compilers, and run tests on all of them.


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

    Newsboat's maintainer, Alexander Batischev, asks people to add tests in their pull requests if the modified module already have tests, or if the module is otherwise obviously testeable. We still skip this requirement for modules that we haven't found a way to test yet, like UI.


    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]

    Here are a few recent PRs that added functionality to testeable modules: https://github.com/newsboat/newsboat/pull/543 https://github.com/newsboat/newsboat/pull/584 https://github.com/newsboat/newsboat/pull/590 https://github.com/newsboat/newsboat/pull/653 https://github.com/newsboat/newsboat/pull/658


    Unknown required information, not 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]

    We ask for test when the subsystem already has some, but this policy is not yet documented.


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

    Our C++ code is compiled with -Wall -Wextra -Wunreachable-code: https://github.com/newsboat/newsboat/blob/00a7c26d47ea83408f6b69c6a968a2c36d2d6cc9/Makefile#L19

    Our Rust code is compiled with default settings, which we believe are strict enough.


    Enough for a badge!

    The project MUST address warnings. [warnings_fixed]

    Our C++ code is compiled with -Werror: https://github.com/newsboat/newsboat/blob/00a7c26d47ea83408f6b69c6a968a2c36d2d6cc9/Makefile#L19 We compile the code on multiple platforms with different versions of GCC and Clang, and fix all warnings that pop up.

    Our Rust code is compiled with default settings, but on CI, we turn warnings into errors: see -D warnings in https://github.com/newsboat/newsboat/blob/1a71f953905976d50ba816967864eb52080e092c/.cirrus.yml. We then fix all warnings that pop up.


    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]

    This is met by -Werror for C++ code https://github.com/newsboat/newsboat/blob/00a7c26d47ea83408f6b69c6a968a2c36d2d6cc9/Makefile#L19 and -D warnings for Rust code https://github.com/newsboat/newsboat/blob/1a71f953905976d50ba816967864eb52080e092c/.cirrus.yml.


  • Secure development knowledge


    Unknown required information, not 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]

    Unknown required information, not 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]

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

    This isn't applicable since Newsboat doesn't implement and doesn't directly control what cryptography is used (e.g. client and server are free to negotiate any algorithm during HTTPS handshake, Newsboat has no say in that).


    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]

    Newsboat uses cryptography as part of HTTPS, and through programs that users choose to run (e.g. with theoldreader-passwordeval setting). Newsboat does not implement its own cryptography; it relies on Curl (which in turn relies on any of OpenSSL, LibreSSL, or some other backend) and programs chosen by the user (e.g. GPG).


    Enough for a badge!

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

    Newsboat only requires Curl, which needs an SSL library. There are at least OpenSSL and GnuTLS that are 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]

    This isn't applicable since Newsboat doesn't implement and doesn't directly control what cryptography is used (e.g. client and server are free to negotiate any algorithm during HTTPS handshake, Newsboat has no say in that).


    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]

    This isn't applicable since Newsboat doesn't implement and doesn't directly control what cryptography is used (e.g. client and server are free to negotiate any algorithm during HTTPS handshake, Newsboat has no say in that).


    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]

    This isn't applicable since Newsboat doesn't implement and doesn't directly control what cryptography is used (e.g. client and server are free to negotiate any algorithm during HTTPS handshake, Newsboat has no say in that).


    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]

    This isn't applicable since Newsboat doesn't implement and doesn't directly control what cryptography is used (e.g. client and server are free to negotiate any algorithm during HTTPS handshake, Newsboat has no say in that).


    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]

    Newsboat doesn't provide authentication to external users.


    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]

    Newsboat uses cryptography as part of HTTPS, and through programs that users choose to run (e.g. with theoldreader-passwordeval setting). Newsboat does not implement its own cryptography; it relies on Curl (which in turn relies on any of OpenSSL, LibreSSL, or some other backend) and programs chosen by the user (e.g. GPG).


  • 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 releases are distributed from newsboat.org over HTTPS (enforced by HTTP Strict Transport Security), and are signed with a PGP key available over HTTPS from newsboat.org and also from the public keyserver network.


    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]

    Release signatures are retrieved from newsboat.org over HTTPS, enforced by HTTP Strict Transport Security.


  • 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 are no publicly known vulnerabilities in Newsboat proper. All the publicly known vulnerabilities of the parent project, Newsbeuter, have been fixed; grep for "CVE" in the CHANGELOG: https://github.com/newsboat/newsboat/blob/00a7c26d47ea83408f6b69c6a968a2c36d2d6cc9/CHANGELOG.md


    Enough for a badge!

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

    The last two vulnerabilities to parent project (which are fixed in Newsboat) have been privately disclosed, so it's not possible for me to prove that the fixes were produced rapidly. Take my (Alexander Batischev's) word that they were.


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

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

    Newsboat's maintainer, Alexander Batischev, manually runs cppcheck every 30 days, i.e. three times per release. The check is not automated because of parse errors (as cppcheck doesn't fully support C++11).

    Rust code is not checked (although C++ code that's auto-generated by Rust code is checked).

    This could certainly be improved.


    Unknown required information, not 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]

    Static analysis haven't discovered any such vulnerabilities yet, so we don't have a history of fixing them timely.


    Unknown required information, not enough for a badge.

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

  • Dynamic code analysis


    Unknown required information, not 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]

    Unknown required information, not 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]

    Unknown required information, not 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]

    Unknown required information, not 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]


This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Alexander Batischev and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Alexander Batischev.
Entry created on 2019-10-27 15:23:34 UTC, last updated on 2024-11-20 15:36:10 UTC.

Back