secdev/scapy

doc/scapy is not reproducibly built

Open

#3871 opened on Jan 26, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (9,312 stars) (1,949 forks)batch import
bugdochelp wanted

Description

Brief description

Hi

There is an ongoing effort regarding reproducible builds in Debian so we have tests checking for it. scapy - actually python-scapy-doc package which contains scapy's documentation - is currently not building reproducibly. There are some places where the date/time of the build is embedded and others are randomly generated.

The html pages that differ are:

  • html/api/scapy.contrib.dtp.html
  • html/api/scapy.contrib.gtp.html
  • html/api/scapy.contrib.http2.html
  • html/api/scapy.contrib.skinny.html
  • html/api/scapy.layers.inet.html
  • html/api/scapy.layers.kerberos.html
  • html/api/scapy.layers.snmp.html
  • html/api/scapy.layers.x509.html

I'll attach the diffoscope output here because github doesn't let me paste it ;-)

experiment-1.diffoscope.txt

Scapy version

2.5.0

Python version

3.10

Operating system

Debian unstable

Additional environment information

No response

How to reproduce

Diffoscope two different builds of scapy's documentation

Actual result

No response

Expected result

No response

Related resources

No response

Contributor guide

Tech stack
python
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the diffoscope output to identify sources of non determinism in the html files. The issues are likely timestamps or random IDs inserted during documentation generation. To fix, ensure build tools respect SOURCE DATE EPOCH or remove date embeddings. Check files like html/api/scapy.contrib.dtp.html etc. and adjust the Sphinx configuration or templates to produce reproducible output.