secdev/scapy

doc/scapy is not reproducibly built

Open

#3.871 geöffnet am 26. Jan. 2023

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.949 Forks)batch import
bugdochelp wanted

Repository-Metriken

Stars
 (9.312 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 20h) (15 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuchen Sie die diffoscope Ausgabe, um Quellen von Nichtdeterminismus in den HTML Dateien zu identifizieren. Die Probleme sind wahrscheinlich Zeitstempel oder zufällige IDs, die während der Dokumentationsgenerierung eingefügt werden. Zur Behebung stellen Sie sicher, dass Build Tools SOURCE DATE EPOCH respektieren oder entfernen Sie Datumseinbettungen. Überprüfen Sie Dateien wie html/api/scapy.contrib.dtp.html usw. und passen Sie die Sphinx Konfiguration oder Vorlagen an, um reproduzierbare Ausgaben zu erzeugen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80