view doc/security.txt @ 8446:14c7c07b32d8

feature: add thread local trace_id and trace_reason to logging. Added trace_id to default logging so that all logs for a given request share the same trace_id. This allows correlation of logs across a request. admin_guide.txt, upgrading.txt: add docs update sample configs to include trace_id. rewrite logging docs in admin_guide. Hopefully they are clearer now. clean up some stuff in the logging config file docs. admin.py: add decorators to run_command to enable trace_id. change calls to db.commit() to use run_command to get trace_id. configuration.py: clean up imports. update docstrings, comments and inline docs. add trace_id to default log format. add function for testing decorated with trace_id. add support for dumping stack trace in logging. add check for pytest in sys.modules to enable log propagation when pytest is running. Otherwise tests fail as the caplog logger doesn't see the roundup logs. logcontext.py: new file to handle thread local contextvar mangement. mailgw.py: add decorators for trace_id etc. scripts/roundup_xlmrpc_server.py: add decorators for trace_id etc. fix encoding bug turning bytes into a string. fix command line issue where we can't set encoding. (not sure if changing encoding via command line even works) cgi/client.py decorate two entry points for trace_id etc. cgi/wsgi_handler.py: decorate entry point for trace_id etc. test/test_config.py: add test for trace_id in new log format. test various cases for sinfo and errors in formating msg.
author John Rouillard <rouilj@ieee.org>
date Tue, 16 Sep 2025 22:53:00 -0400
parents c7a2e01793cd
children
line wrap: on
line source

.. meta::
    :description:
        Documentation on how to report security issues with
        Roundup. Index to recent security related (CVE) descriptions
        in other Roundup documentation. How to verify distribution
        using gpg.

.. index::
   single: Reporting Security Issues
   single: CVE announcements
   single: Security Issues, Reporting
   single: Security Issues, Remediation
   single: Security Issues, CVE announcements


=======================
Roundup Security Issues
=======================

This page documents CVE's fixed starting with version 2.4.0, how to
report security issues, and verify the signatures for Roundup
source release tarballs.

.. contents::
   :local:
   :depth: 2

CVE Announcements
-----------------

  * `CVE-2025-53865`_ - :ref:`XSS security issue with devel or
    responsive templates <CVE-2025-53865>`. Fixed in release 2.5.0,
    directions available for fixing trackers based on these templates.

  * `CVE-2024-39124`_ - :ref:`classhelpers (_generic.help.html) are
    vulnerable to an XSS attack. <CVE-2024-39124>` Requires fixing
    tracker homes.
  * `CVE-2024-39125`_ - :ref:`if Referer header is set to a script tag,
    it will be executed. <CVE-2024-39125>` Fixed in release 2.4.0,
    directions available for fixing in prior versions.
  * `CVE-2024-39126`_ - :ref:`PDF, XML and SVG files downloaded from an
    issue can contain embedded JavaScript which is
    executed. <CVE-2024-39126>` Fixed in release 2.4.0, directions
    available for fixing in prior versions.

.. _CVE-2025-53865:
        https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2025-53865
.. _CVE-2024-39124:
        https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-39124
.. _CVE-2024-39125:
        https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-39125
.. _CVE-2024-39126:
        https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2024-39126


Reporting Security Issues
-------------------------
Security issues with Roundup should be reported by email to:

   rouilj@users.sourceforge.net  (John Rouillard)

   rsc@runtux.com (Ralf Schlatterbeck)

If these fail, you can find rouilj on irc in channel #roundup at
irc.oftc.net (see Contact_ for more directions and web
interface). Methods listed at Contact_ are all public, so they should
be used to contact somebody with the Roundup project for establishing
a proper method of reporting the security issue.

.. _Contact: https://www.roundup-tracker.org/contact.html

Verify Source Tarball
---------------------

.. index::
   single: Distribution, verify with gpg
   single: Signature, verify

If you download the source tarball using ``python3 -m pip download
roundup`` or from https://pypi.org/project/roundup/#files you can
verify the file using gpg.

This is the information on the public PGP/GPG key used to sign Roundup
distributions.  It is used to sign the 1.6.0, 2.2.0, and newer
releases. (Note that the @ sign in email addresses have been replaced
with the word "at" to reduce spam directed at the mailing list.)::

  Key info: Roundup Team (signing key for roundup releases)
      <roundup-devel at lists.sourceforge.net>
  Expires: 2028-07-17
  Key fingerprint = 411E 354B 5D1A F261 25D6  2122 1F2D D0CB 756A 76D8

Releases 1.6.1, 2.0.0 and 2.1.0 were accidentally signed with this key
[1]_::

  Key info: John Rouillard (Roundup Release Key)
      <rouilj+roundup at ieee.org>
  Expires: 2023-07-09
  Key fingerprint =  A1E6 364E 9429 E9D8 2B3B 2373 DB05 ADC4 2330 5876

.. [1] Use gpg to import this key from the keyserver pgp.mit.edu
       if you need to verify one of these releases. Use the gpg
       pgp.mit.edu keyserver example replacing the key fingerprint
       with the one starting A1E6.

Importing the Public Key
~~~~~~~~~~~~~~~~~~~~~~~~

This only has to be added to your keyring once. You can import a key
from pgp.mit.edu using::

   gpg --keyserver pgp.mit.edu --receive-keys 411E354B5D1AF26125D621221F2DD0CB756A76D8

where the fingerprint (without spaces) is used to identify which key
to receive. You can also extract and import the file
``tools/roundup.public.pgp.key`` from the download source tarball
using::

  tar -xzvf roundup-2.2.0.tar.gz -O \
     roundup-2.2.0/tools/roundup.public.pgp.key > pub.key

  gpg --import pub.key

Once you have loaded the public key, you need a detached signature for
your release.


Download Detached Signature and Verify
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This needs to be done once for each release you wish to verify.

The Python Package Index (PyPI) used to support uploading gpg detached
signatures. However that is no longer supported and downloading
existing signatures may not work in the future.

As a result, the signatures for all Roundup final releases starting
with 1.6.0 have been moved and are linked below:

.. rst-class:: multicol

* `2.5.0 <../signatures/roundup-2.5.0.tar.gz.asc>`_
* `2.4.0 <../signatures/roundup-2.4.0.tar.gz.asc>`_
* `2.4.0b2 <../signatures/roundup-2.4.0b2.tar.gz.asc>`_
* `2.3.0 <../signatures/roundup-2.3.0.tar.gz.asc>`_
* `2.3.0b2 <../signatures/roundup-2.3.0b2.tar.gz.asc>`_
* `2.2.0 <../signatures/roundup-2.2.0.tar.gz.asc>`_
* `2.1.0 <../signatures/roundup-2.1.0.tar.gz.asc>`_
* `2.0.0 <../signatures/roundup-2.0.0.tar.gz.asc>`_
* `1.6.1 <../signatures/roundup-1.6.1.tar.gz.asc>`_
* `1.6.0 <../signatures/roundup-1.6.0.tar.gz.asc>`_

To use the signature, download the correct versioned link and verify
it with (note 1.5.7 is a dummy version, use the correct version
number)::

  gpg --verify roundup-1.5.7.tar.gz.asc roundup-1.5.7.tar.gz

You should see::

  gpg: Signature made Wed 13 Jul 2022 12:24:14 AM EDT
  gpg:                using RSA key 411E354B5D1AF26125D621221F2DD0CB756A76D8
  gpg: Good signature from "Roundup Team (signing key for roundup releases) <roundup-devel at lists.sourceforge.net>" [unknown]
  gpg: WARNING: This key is not certified with a trusted signature!
  gpg:          There is no indication that the signature belongs to the owner.
  Primary key fingerprint: 411E 354B 5D1A F261 25D6  2122 1F2D D0CB 756A 76D8

which verifies the tarball integrity. The WARNING is expected.
The date should be close to the release date of the version of Roundup.
As long as you see the output starting with "Good signature from"
followed by the Key Info above, everything is OK.

If something is wrong you will see::

  gpg: Signature made Wed 13 Jul 2022 12:24:14 AM EDT
  gpg:                using RSA key 411E354B5D1AF26125D621221F2DD0CB756A76D8
  gpg: BAD signature from "Roundup Team (signing key for roundup releases) <roundup-devel at lists.sourceforge.net>"

**do not use** the tarball if the signature is BAD. Email the mailing
list: roundup-devel at lists.sourceforge.net if you have this happen
to you.

Roundup Issue Tracker: http://roundup-tracker.org/