micropython / micropython/micropython-lib

tarfile-write issue with file/folder permissions

Offen
#797 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
2.9k
Forks
1.1k
Ø Merge
7 T. 6 Std.
Gemergte PRs (30 T.)
3

Beschreibung

Context

I've been playing with tarfile for a few days and yesterday started trying to create my own archives using tarfile-write installed via mip.

Adding a folder to it works recursively, but transferring the file to the PC via mpremote and expanding it yields all files and folders with --- --- --- permissions (0x000).

Discovery

I investigated and found the source of the issue is related to how the TarInfo object is composed in these lines

in particular on line 102 we find mode to be set to the os.stat(FILE)[0]

tarinfo.mode = stat[0]

stat[0] is either 0x8000 (file) or 0x4000 (folder).
And the subsequently applied masking yields 0x000 as permissions set while adding it to the archive.
I think that mode should be safely set to 0x1a4 > 644 > rw- r-- r--

I have tested by manually composing a TarInfo object to be handed to addfile() rather than patching add()

How to reproduce:
import tarfile
import os

os.mkdir('test_folder')
f = open('test_folder/test_file_01.txt', 'w')
f.write('file 01')
f.close()

os.mkdir('test_folder/sub_folder')

f = open('test_folder/sub_folder/test_file_02.txt', 'w')
f.write('file 02')
f.close()

archive = tarfile.TarFile('test_archive.tar', 'w')
archive.add('test_folder')
archive.close()

Copy the archive from the board to the PC via mpremote cp :test_archive.tar test_archive.tar

Expand the archive and verify the permissions for test_folder.
From Mac os I was not able to chmod 644 test_folder, but using the UI I could unrestrict access.
CleanShot 2024-02-03 at 21 50 23@2x

Looking at the folder content you can verify the same permission issue happens with sub_folder and contained file(s)
CleanShot 2024-02-03 at 21 51 27@2x

Environment:
I run a custom build for ESP32-S3, but this issue is not related to changes I have applied
(name='micropython', version=(1, 23, 0, 'preview'), _machine='LilyGo T-QT Pro with ESP32S3', _mpy=10758)

MicroPython v1.23.0-preview.48.g076516d88.dirty on 2024-01-21; LilyGo T-QT Pro with ESP32S3
Board: ESP32-S3
TarFile version: '0.4.1'

Hope someone can take a look :)
u.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne in python-stdlib/tarfile-write/tarfile/write.py bei der TarInfo-Zusammenstellung um die Zeilen 102-106, führe dann die Reproduktion mit tarfile.TarFile.add() aus und untersuche die Berechtigungen des extrahierten Archivs. Vergleiche den aus stat abgeleiteten Modus mit dem im Archiv gespeicherten Modus; abgeschlossen ist die Aufgabe, wenn extrahierte Dateien und Ordner nutzbare Berechtigungen statt 0x000 beibehalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
operating-systems
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.