PySquashfsImage-0.9.0/0000775000175000017500000000000014450340472015154 5ustar debalancedebalancePySquashfsImage-0.9.0/PySquashfsImage/0000775000175000017500000000000014450340472020225 5ustar debalancedebalancePySquashfsImage-0.9.0/PySquashfsImage/const.py0000664000175000017500000000165314450340472021732 0ustar debalancedebalancefrom enum import IntEnum SQUASHFS_CHECK = 2 SQUASHFS_UIDS = 256 SQUASHFS_GUIDS = 255 SQUASHFS_MAJOR = 4 SQUASHFS_MINOR = 0 SQUASHFS_MAGIC = 0x73717368 SQUASHFS_START = 0 SQUASHFS_METADATA_SIZE = 8192 SQUASHFS_METADATA_LOG = 13 FRAGMENT_BUFFER_DEFAULT = 256 DATA_BUFFER_DEFAULT = 256 SQUASHFS_NAME_LEN = 256 SQUASHFS_INVALID = 0xFFFFFFFFFFFF SQUASHFS_INVALID_FRAG = 0xFFFFFFFF SQUASHFS_INVALID_XATTR = 0xFFFFFFFF SQUASHFS_INVALID_BLK = 0xFFFFFFFFFFFFFFFF # -1 SQUASHFS_USED_BLK = SQUASHFS_INVALID_BLK - 1 # -2 SQUASHFS_COMPRESSED_BIT = 1 << 15 SQUASHFS_COMPRESSED_BIT_BLOCK = 1 << 24 class Type(IntEnum): DIR = 1 FILE = 2 SYMLINK = 3 BLKDEV = 4 CHRDEV = 5 FIFO = 6 SOCKET = 7 LDIR = 8 LREG = 9 LSYMLINK = 10 LBLKDEV = 11 LCHRDEV = 12 LFIFO = 13 LSOCKET = 14 class Compression(IntEnum): NO = 0 ZLIB = 1 LZMA = 2 LZO = 3 XZ = 4 LZ4 = 5 ZSTD = 6 PySquashfsImage-0.9.0/PySquashfsImage/file.py0000664000175000017500000001436514450340472021527 0ustar debalancedebalanceimport posixpath import sys from collections import OrderedDict from .const import Type class File(object): # Python 2 """Abstract base class for files.""" def __init__(self, image, inode, name, parent): self._image = image self._inode = inode self._name = name self._parent = parent def __str__(self): return self.name def __repr__(self): if sys.version_info >= (3, 3): return "{}({!r})".format(self.__class__.__qualname__, self.name) else: return "{}({!r})".format(self.__class__.__name__, self.name) def __lt__(self, other): if not isinstance(other, File): return NotImplemented return self._name < other._name def __le__(self, other): if not isinstance(other, File): return NotImplemented return self._name <= other._name @property def image(self): return self._image @property def inode(self): return self._inode @property def name(self): return self._name.decode() @property def parent(self): return self._parent @property def path(self): """Return the file's absolute path.""" if self._parent is None: return '/' else: return posixpath.join(self._parent.path, self.name) @property def mode(self): return self._inode.mode @property def uid(self): return self._inode.uid @property def gid(self): return self._inode.gid @property def time(self): return self._inode.time @property def size(self): """Return the data attribute of this file's inode. - regular file: uncompressed file size in bytes - directory: uncompressed listing size in bytes - symlink: uncompressed target path size in bytes - device file: device number, major and minor - FIFO and socket should be 0 """ return self._inode.data @property def xattr(self): return self._inode.xattr @property def filemode(self): return self._inode.filemode @property def is_dir(self): return False @property def is_file(self): return False @property def is_symlink(self): return False @property def is_block_device(self): return False @property def is_char_device(self): return False @property def is_fifo(self): return False @property def is_socket(self): return False def _lselect(self, lpath, ofs): # print lpath,self.name,ofs if ofs >= len(lpath): return self return None class Directory(File): def __init__(self, image, inode, name=b'', parent=None, children=None): super(Directory, self).__init__(image, inode, name, parent) # Python 2 # OrderedDict for Python 3.6 and lower compatibility. self._children = children if children is not None else OrderedDict() def __len__(self): return len(self._children) def __iter__(self): return self.iterdir() def __getitem__(self, key): return self._children[key] def __contains__(self, item): if isinstance(item, str): return item in self._children elif isinstance(item, File): return item in self._children.values() return False def __reversed__(self): for filename in reversed(self._children): yield self._children[filename] @property def is_dir(self): return True @property def children(self): return self._children def iterdir(self): for file in self._children.values(): yield file def riter(self): """Iterate over this directory recursively.""" yield self for file in self._children.values(): if file.is_dir: for f in file.riter(): yield f else: yield file def find(self, filename): """Find the first file with this name in the subtree.""" for file in self.riter(): if file.name == filename: return file return None def select(self, path): if path == "/": path = '' lpath = path.split('/') start = self ofs = 0 if not lpath[0]: ofs = 1 while start.parent: start = start.parent if ofs >= len(lpath): return start for child_name, child in start.children.items(): if child_name == lpath[ofs]: return child._lselect(lpath, ofs + 1) return None def _lselect(self, lpath, ofs): # print lpath,self.name,ofs if ofs >= len(lpath): return self for child_name, child in self._children.items(): if child_name == lpath[ofs]: return child._lselect(lpath, ofs + 1) return None class RegularFile(File): @property def is_file(self): return True def iter_bytes(self): return self._image.iter_file(self._inode) def read_bytes(self): return self._image.read_file(self._inode) def read_text(self, encoding="utf8", errors="strict"): return self.read_bytes().decode(encoding, errors) class Symlink(File): @property def is_symlink(self): return True def readlink(self): return self._inode.symlink class FIFO(File): @property def is_fifo(self): return True class Socket(File): @property def is_socket(self): return True class _Device(File): @property def major(self): return (self._inode.data & 0xFFF00) >> 8 @property def minor(self): return (self._inode.data & 0xFF) | ((self._inode.data >> 12) & 0xFFF00) class CharacterDevice(_Device): @property def is_char_device(self): return True class BlockDevice(_Device): @property def is_block_device(self): return True filetype = { Type.FILE: RegularFile, Type.DIR: Directory, Type.SYMLINK: Symlink, Type.FIFO: FIFO, Type.SOCKET: Socket, Type.BLKDEV: BlockDevice, Type.CHRDEV: CharacterDevice } PySquashfsImage-0.9.0/PySquashfsImage/macro.py0000664000175000017500000000566414450340472021713 0ustar debalancedebalancefrom .const import SQUASHFS_CHECK, SQUASHFS_COMPRESSED_BIT, SQUASHFS_COMPRESSED_BIT_BLOCK, SQUASHFS_METADATA_SIZE def SQUASHFS_COMPRESSED_SIZE(B): if B & ~SQUASHFS_COMPRESSED_BIT: return B & ~SQUASHFS_COMPRESSED_BIT else: return SQUASHFS_COMPRESSED_BIT def SQUASHFS_BIT(flag, bit): return ((flag >> bit) & 1) != 0 def SQUASHFS_CHECK_DATA(flags): return SQUASHFS_BIT(flags, SQUASHFS_CHECK) def SQUASHFS_COMPRESSED(B): return (B & SQUASHFS_COMPRESSED_BIT) == 0 def SQUASHFS_COMPRESSED_SIZE_BLOCK(B): return B & ~SQUASHFS_COMPRESSED_BIT_BLOCK def SQUASHFS_COMPRESSED_BLOCK(B): return (B & SQUASHFS_COMPRESSED_BIT_BLOCK) == 0 def SQUASHFS_INODE_BLK(a): return (a >> 16) & 0xFFFFFFFF def SQUASHFS_INODE_OFFSET(a): return a & 0xFFFF def SQUASHFS_MKINODE(A, B): return ((A << 16) + B) & 0xFFFFFFFFFFFFFFFF def SQUASHFS_MK_VFS_INODE(a, b): return ((a << 8) + (b >> 2) + 1) & 0xFFFFFFFF def SQUASHFS_MODE(a): return a & 0xFFF def SQUASHFS_FRAGMENT_BYTES(A): return A * 16 def SQUASHFS_FRAGMENT_INDEX(A): return SQUASHFS_FRAGMENT_BYTES(A) // SQUASHFS_METADATA_SIZE def SQUASHFS_FRAGMENT_INDEX_OFFSET(A): return SQUASHFS_FRAGMENT_BYTES(A) % SQUASHFS_METADATA_SIZE def SQUASHFS_FRAGMENT_INDEXES(A): return (SQUASHFS_FRAGMENT_BYTES(A) + SQUASHFS_METADATA_SIZE - 1) // SQUASHFS_METADATA_SIZE def SQUASHFS_FRAGMENT_INDEX_BYTES(A): return SQUASHFS_FRAGMENT_INDEXES(A) * 8 def SQUASHFS_LOOKUP_BYTES(A): return A * 8 def SQUASHFS_LOOKUP_BLOCK(A): return SQUASHFS_LOOKUP_BYTES(A) // SQUASHFS_METADATA_SIZE def SQUASHFS_LOOKUP_BLOCK_OFFSET(A): return SQUASHFS_LOOKUP_BYTES(A) % SQUASHFS_METADATA_SIZE def SQUASHFS_LOOKUP_BLOCKS(A): return (SQUASHFS_LOOKUP_BYTES(A) + SQUASHFS_METADATA_SIZE - 1) // SQUASHFS_METADATA_SIZE def SQUASHFS_LOOKUP_BLOCK_BYTES(A): return SQUASHFS_LOOKUP_BLOCKS(A) * 8 def SQUASHFS_ID_BYTES(A): return A * 4 def SQUASHFS_ID_BLOCK(A): return SQUASHFS_ID_BYTES(A) // SQUASHFS_METADATA_SIZE def SQUASHFS_ID_BLOCK_OFFSET(A): return SQUASHFS_ID_BYTES(A) % SQUASHFS_METADATA_SIZE def SQUASHFS_ID_BLOCKS(A): return (SQUASHFS_ID_BYTES(A) + SQUASHFS_METADATA_SIZE - 1) // SQUASHFS_METADATA_SIZE def SQUASHFS_ID_BLOCK_BYTES(A): return SQUASHFS_ID_BLOCKS(A) * 8 def SQUASHFS_XATTR_BYTES(A): return A * 16 def SQUASHFS_XATTR_BLOCK(A): return SQUASHFS_XATTR_BYTES(A) // SQUASHFS_METADATA_SIZE def SQUASHFS_XATTR_BLOCK_OFFSET(A): return SQUASHFS_XATTR_BYTES(A) % SQUASHFS_METADATA_SIZE def SQUASHFS_XATTR_BLOCKS(A): return (SQUASHFS_XATTR_BYTES(A) + SQUASHFS_METADATA_SIZE - 1) // SQUASHFS_METADATA_SIZE def SQUASHFS_XATTR_BLOCK_BYTES(A): return SQUASHFS_XATTR_BLOCKS(A) * 8 def SQUASHFS_XATTR_BLK(A): return (A >> 16) & 0xFFFFFFFF def SQUASHFS_XATTR_OFFSET(A): return A & 0xFFFF def LOOKUP_INDEX(NUMBER): return NUMBER >> 12 def LOOKUP_OFFSET(NUMBER): return NUMBER & 0xFFF PySquashfsImage-0.9.0/PySquashfsImage/structure/0000775000175000017500000000000014450340472022265 5ustar debalancedebalancePySquashfsImage-0.9.0/PySquashfsImage/structure/inode.py0000664000175000017500000002101214450340472023731 0ustar debalancedebalanceimport stat import sys from ctypes import c_uint16, c_uint32, c_uint64 from ..const import SQUASHFS_INVALID_XATTR from ..structure import _Base class InodeHeader(_Base): _fields_ = [ ("_inode_type", c_uint16), ("_mode", c_uint16), ("_uid", c_uint16), ("_guid", c_uint16), ("_mtime", c_uint32), ("_inode_number", c_uint32), ] @property def inode_type(self): return self._inode_type @property def mode(self): return self._mode @property def uid(self): """Index of the UID in the table.""" return self._uid @property def guid(self): """Index of the GUID in the table.""" return self._guid @property def mtime(self): return self._mtime @property def inode_number(self): return self._inode_number class _BaseInode(_Base): _header = None _uid = None _gid = None _mode = None @property def header(self): return self._header @property def uid(self): return self._uid @property def gid(self): return self._gid @property def mode(self): return self._mode @property def type(self): return self._header.inode_type @property def time(self): return self._header.mtime @property def inode_number(self): return self._header.inode_number @property def data(self): return 0 @property def xattr(self): return getattr(self, "_xattr", SQUASHFS_INVALID_XATTR) @property def filemode(self): if sys.version_info >= (3, 3): return stat.filemode(self._mode) ret = ['-'] * 10 if self.is_socket: ret[0] = 's' if self.is_symlink: ret[0] = 'l' if self.is_block_device: ret[0] = 'b' if self.is_dir: ret[0] = 'd' if self.is_char_device: ret[0] = 'c' if self.is_fifo: ret[0] = 'p' if (self._mode & stat.S_IRUSR) == stat.S_IRUSR: ret[1] = 'r' if (self._mode & stat.S_IWUSR) == stat.S_IWUSR: ret[2] = 'w' if (self._mode & stat.S_IRGRP) == stat.S_IRGRP: ret[4] = 'r' if (self._mode & stat.S_IWGRP) == stat.S_IWGRP: ret[5] = 'w' if (self._mode & stat.S_IROTH) == stat.S_IROTH: ret[7] = 'r' if (self._mode & stat.S_IWOTH) == stat.S_IWOTH: ret[8] = 'w' if (self._mode & stat.S_IXUSR) == stat.S_IXUSR: ret[3] = 'x' if (self._mode & stat.S_ISUID) == stat.S_ISUID: ret[3] = 's' if (self._mode & stat.S_IXGRP) == stat.S_IXGRP: ret[6] = 'x' if (self._mode & stat.S_ISGID) == stat.S_ISGID: ret[6] = 's' if (self._mode & stat.S_IXOTH) == stat.S_IXOTH: ret[9] = 'x' return ''.join(ret) @property def is_dir(self): return stat.S_ISDIR(self._mode) @property def is_file(self): return stat.S_ISREG(self._mode) @property def is_symlink(self): return stat.S_ISLNK(self._mode) @property def is_block_device(self): return stat.S_ISBLK(self._mode) @property def is_char_device(self): return stat.S_ISCHR(self._mode) @property def is_fifo(self): return stat.S_ISFIFO(self._mode) @property def is_socket(self): return stat.S_ISSOCK(self._mode) class _DirectoryInodeCommon: @property def start_block(self): return self._start_block @property def nlink(self): return self._nlink @property def file_size(self): return self._file_size @property def offset(self): return self._offset @property def parent_inode(self): return self._parent_inode # These fields are either shortcuts or filled in read_inode(). @property def data(self): return self.file_size @property def start(self): return self.start_block class DirectoryInode(_DirectoryInodeCommon, _BaseInode): _fields_ = [ ("_start_block", c_uint32), ("_nlink", c_uint32), ("_file_size", c_uint16), ("_offset", c_uint16), ("_parent_inode", c_uint32), ] class ExtendedDirectoryInode(_DirectoryInodeCommon, _BaseInode): _fields_ = [ ("_nlink", c_uint32), ("_file_size", c_uint32), ("_start_block", c_uint32), ("_parent_inode", c_uint32), ("_i_count", c_uint16), ("_offset", c_uint16), ("_xattr", c_uint32), ] _index = None # Not used anywhere for now. @property def i_count(self): return self._i_count @property def index(self): return self._index class _RegularFileInodeCommon: _block_list = None _frag_bytes = None _blocks = None _block_start = None _block_offset = None _sparse = 0 @property def start_block(self): return self._start_block @property def fragment(self): return self._fragment @property def offset(self): return self._offset @property def file_size(self): return self._file_size @property def block_list(self): return self._block_list # These fields are either shortcuts or filled in read_inode(). @property def data(self): return self.file_size @property def frag_bytes(self): return self._frag_bytes @property def blocks(self): return self._blocks @property def start(self): return self.start_block @property def block_start(self): return self._block_start @property def block_offset(self): return self._block_offset @property def sparse(self): return self._sparse class RegularFileInode(_RegularFileInodeCommon, _BaseInode): _fields_ = [ ("_start_block", c_uint32), ("_fragment", c_uint32), ("_offset", c_uint32), ("_file_size", c_uint32), ] class ExtendedRegularFileInode(_RegularFileInodeCommon, _BaseInode): _fields_ = [ ("_start_block", c_uint64), ("_file_size", c_uint64), ("_sparse", c_uint64), ("_nlink", c_uint32), ("_fragment", c_uint32), ("_offset", c_uint32), ("_xattr", c_uint32), ] @property def sparse(self): return self._sparse != 0 @property def nlink(self): return self._nlink class SymlinkInode(_BaseInode): _fields_ = [ ("_nlink", c_uint32), ("_symlink_size", c_uint32), ] _symlink = None @property def nlink(self): return self._nlink @property def symlink_size(self): return self._symlink_size @property def symlink(self): return self._symlink.decode() # These fields are either shortcuts or filled in read_inode(). @property def data(self): return self.symlink_size class ExtendedSymlinkInode(SymlinkInode): pass class _DeviceInode(_BaseInode): _fields_ = [ ("_nlink", c_uint32), ("_rdev", c_uint32), ] @property def nlink(self): return self._nlink @property def rdev(self): return self._rdev # These fields are either shortcuts or filled in read_inode(). @property def data(self): return self.rdev class _ExtendedDeviceInode(_DeviceInode): _fields_ = [ ("_xattr", c_uint32), ] class BlockDeviceInode(_DeviceInode): pass class ExtendedBlockDeviceInode(_ExtendedDeviceInode): pass class CharacterDeviceInode(_DeviceInode): pass class ExtendedCharacterDeviceInode(_ExtendedDeviceInode): pass class _IPCInode(_BaseInode): _fields_ = [ ("_nlink", c_uint32), ] @property def nlink(self): return self._nlink class _ExtendedIPCInode(_IPCInode): _fields_ = [ ("_xattr", c_uint32), ] class FIFOInode(_IPCInode): pass class ExtendedFIFOInode(_ExtendedIPCInode): pass class SocketInode(_IPCInode): pass class ExtendedSocketInode(_ExtendedIPCInode): pass inomap = { 1: DirectoryInode, 2: RegularFileInode, 3: SymlinkInode, 4: BlockDeviceInode, 5: CharacterDeviceInode, 6: FIFOInode, 7: SocketInode, 8: ExtendedDirectoryInode, 9: ExtendedRegularFileInode, 10: ExtendedSymlinkInode, 11: ExtendedBlockDeviceInode, 12: ExtendedCharacterDeviceInode, 13: ExtendedFIFOInode, 14: ExtendedSocketInode, } PySquashfsImage-0.9.0/PySquashfsImage/structure/__init__.py0000664000175000017500000001130314450340472024374 0ustar debalancedebalancefrom ctypes import LittleEndianStructure, c_int16, c_uint16, c_uint32, c_uint64, sizeof from ..const import Type class _Base(LittleEndianStructure): def __iter__(self): # This allows calling dict() on instances of this class. for name, _ in self._fields_: name = name.lstrip('_') yield name, getattr(self, name) @classmethod def from_bytes(cls, bytes_, offset=0): return cls.from_buffer_copy(bytes_, offset) @classmethod def from_fd(cls, fd): return cls.from_bytes(fd.read(sizeof(cls))) class Superblock(_Base): _fields_ = [ ("_s_magic", c_uint32), ("_inodes", c_uint32), ("_mkfs_time", c_uint32), ("_block_size", c_uint32), ("_fragments", c_uint32), ("_compression", c_uint16), ("_block_log", c_uint16), ("_flags", c_uint16), ("_no_ids", c_uint16), ("_s_major", c_uint16), ("_s_minor", c_uint16), ("_root_inode", c_uint64), ("_bytes_used", c_uint64), ("_id_table_start", c_uint64), ("_xattr_id_table_start", c_uint64), ("_inode_table_start", c_uint64), ("_directory_table_start", c_uint64), ("_fragment_table_start", c_uint64), ("_lookup_table_start", c_uint64) ] @property def s_magic(self): return self._s_magic @property def inodes(self): return self._inodes @property def mkfs_time(self): return self._mkfs_time @property def block_size(self): return self._block_size @property def fragments(self): return self._fragments @property def compression(self): return self._compression @property def block_log(self): return self._block_log @property def flags(self): return self._flags @property def no_ids(self): return self._no_ids @property def s_major(self): return self._s_major @property def s_minor(self): return self._s_minor @property def root_inode(self): return self._root_inode @property def bytes_used(self): return self._bytes_used @property def id_table_start(self): return self._id_table_start @property def xattr_id_table_start(self): return self._xattr_id_table_start @property def inode_table_start(self): return self._inode_table_start @property def directory_table_start(self): return self._directory_table_start @property def fragment_table_start(self): return self._fragment_table_start @property def lookup_table_start(self): return self._lookup_table_start class DirEntry(_Base): _fields_ = [ ("_offset", c_uint16), ("_inode_number", c_int16), ("_type", c_uint16), ("_size", c_uint16), ] _name = None @property def offset(self): return self._offset @property def inode_number(self): return self._inode_number @property def type(self): return Type(self._type) @property def size(self): return self._size @property def name(self): return self._name.decode() class DirHeader(_Base): _fields_ = [ ("_count", c_uint32), ("_start_block", c_uint32), ("_inode_number", c_uint32), ] @property def count(self): return self._count @property def start_block(self): return self._start_block @property def inode_number(self): return self._inode_number class FragmentEntry(_Base): _fields_ = [ ("_start_block", c_uint64), ("_size", c_uint32), ("_unused", c_uint32) ] @property def start_block(self): return self._start_block @property def size(self): return self._size @property def unused(self): return self._unused class XattrId(_Base): _fields_ = [ ("_xattr", c_uint64), ("_count", c_uint32), ("_size", c_uint32) ] @property def xattr(self): return self._xattr @property def count(self): return self._count @property def size(self): return self._size class XattrTable(_Base): _fields_ = [ ("_xattr_table_start", c_uint64), ("_xattr_ids", c_uint32), ("_unused", c_uint32) ] @property def xattr_table_start(self): return self._xattr_table_start @property def xattr_ids(self): return self._xattr_ids @property def unused(self): return self._unused PySquashfsImage-0.9.0/PySquashfsImage/extract.py0000664000175000017500000001512514450340472022255 0ustar debalancedebalancefrom __future__ import print_function import os import sys from contextlib import contextmanager from errno import EEXIST, ENOENT, EPERM from stat import S_IFBLK, S_IFCHR, S_IFIFO, S_IFSOCK, S_IWUSR from .file import FIFO, BlockDevice, CharacterDevice, RegularFile, Socket, Symlink from .macro import LOOKUP_INDEX, LOOKUP_OFFSET from .xattr import has_xattrs, write_xattr try: from os import geteuid except ImportError: _root = False else: _root = geteuid() == 0 try: from os import supports_follow_symlinks except ImportError: supports_follow_symlinks = set() try: from os import chown except ImportError: def chown(path, uid, gid): pass try: from os import lchown except ImportError: def lchown(path, uid, gid): pass try: from os import makedev except ImportError: def makedev(major, minor): pass try: from os import mknod except ImportError: def mknod(path, mode=0o600, device=0): pass def set_attributes(pathname, file, set_mode): # unsquashfs.c os.utime(pathname, (file.time, file.time)) mode = file.mode if _root: chown(pathname, file.uid, file.gid) else: mode &= ~0o6000 write_xattr(pathname, file) if set_mode or (mode & 0o7000): try: os.chmod(pathname, mode) except (IOError, OSError) as e: if _root or e.errno != EPERM or not (mode & 0o1000): raise else: os.chmod(pathname, mode & ~0o1000) def _write_file(file, pathname): mode = file.mode if not _root and not (mode & S_IWUSR) and has_xattrs(file): mode |= S_IWUSR flags = os.O_CREAT | os.O_WRONLY if sys.platform == "win32": flags |= os.O_BINARY fd = os.open(pathname, flags, mode & 0o777) # Use os.open() because umask try: for block in file.iter_bytes(): os.write(fd, block) finally: os.close(fd) @contextmanager def appropriate_umask(): if not _root: yield return old = os.umask(0) try: yield finally: os.umask(old) def unlink(path): try: os.unlink(path) except Exception: pass def write_file(file, pathname, force=False): # unsquashfs.c -> write_file try: os.lstat(pathname) except (IOError, OSError) as e: # Should be FileNotFoundError (Python 2 compatibility) if e.errno != ENOENT: raise else: if force: os.unlink(pathname) # Don't ignore errors here. elif sys.version_info >= (3, 3): raise FileExistsError("file already exists") else: raise OSError("file already exists") with appropriate_umask(): _write_file(file, pathname) set_ = not _root and not (file.mode & S_IWUSR) and has_xattrs(file) set_attributes(pathname, file, force or set_) def _lookup(lookup_table, number): # unsquash-34.c index = LOOKUP_INDEX(number - 1) offset = LOOKUP_OFFSET(number - 1) if lookup_table.get(index) is None: return None return lookup_table[index].get(offset) def _insert_lookup(lookup_table, number, pathname): # unsquash-34.c index = LOOKUP_INDEX(number - 1) offset = LOOKUP_OFFSET(number - 1) if lookup_table.get(index) is None: lookup_table[index] = {} lookup_table[index][offset] = pathname def _print(*args, **kwargs): if not kwargs.pop("quiet", False): print(*args, **kwargs) def extract_file(file, dest=None, force=False, lookup_table=None, quiet=True): # unsquashfs.c -> create_inode dest = dest if dest else os.path.basename(file.path) _print("extract {} to {}".format(file.path, dest), quiet=quiet) lookup_table = lookup_table if lookup_table is not None else {} link_path = _lookup(lookup_table, file.inode.inode_number) if link_path is not None: if force: unlink(dest) if sys.version_info >= (3, 3) and os.link in supports_follow_symlinks: os.link(link_path, dest, follow_symlinks=False) return if isinstance(file, RegularFile): write_file(file, dest, force) elif isinstance(file, Symlink): if force: unlink(dest) try: os.symlink(file.readlink(), dest) except (OSError, AttributeError) as e: # Windows + Python < 3.2 -> AttributeError # Windows + unprivileged user + Developer Mode disabled -> OSError if isinstance(e, OSError) and not (hasattr(e, "winerror") and e.winerror == 1314): raise elif isinstance(e, AttributeError) and os.path.isfile(dest): raise OSError("file already exists") with open(dest, "wb") as f: f.write(file.inode._symlink) os.utime(dest, (file.time, file.time)) if sys.version_info >= (3, 3) and os.utime in supports_follow_symlinks: os.utime(dest, (file.time, file.time), follow_symlinks=False) if _root: lchown(dest, file.uid, file.gid) write_xattr(dest, file) elif isinstance(file, (BlockDevice, CharacterDevice)): if _root: chrdev = isinstance(file, CharacterDevice) if force: unlink(dest) mknod(dest, S_IFCHR if chrdev else S_IFBLK, makedev(file.major, file.minor)) set_attributes(dest, file, True) else: _print("WARNING: could not create block or character device because you are not root", quiet=quiet) elif isinstance(file, FIFO): if force: unlink(dest) mknod(dest, S_IFIFO, 0) set_attributes(dest, file, True) elif isinstance(file, Socket): mknod(dest, S_IFSOCK, 0) set_attributes(dest, file, True) else: raise Exception("unknown file type") _insert_lookup(lookup_table, file.inode.inode_number, dest) def extract_dir(directory, dest="squashfs-root", force=False, lookup_table=None, quiet=True): _print("extract {} to {}".format(directory.path, dest), quiet=quiet) lookup_table = lookup_table if lookup_table is not None else {} try: os.mkdir(dest, 0o700) except (IOError, OSError) as e: # Should be FileExistsError (Python 2 compatibility) if force and e.errno == EEXIST: os.chmod(dest, 0o700) else: raise for file in directory: path = os.path.join(dest, os.path.relpath(file.path, directory.path)) if file.is_dir: extract_dir(file, path, force, lookup_table, quiet) else: extract_file(file, path, force, lookup_table, quiet) set_attributes(dest, directory, True) PySquashfsImage-0.9.0/PySquashfsImage/compressor.py0000664000175000017500000000302514450340472022773 0ustar debalancedebalancefrom .const import Compression class Compressor: name = "none" def uncompress(self, src, size, outsize): return src class ZlibCompressor(Compressor): name = "gzip" def __init__(self): import zlib self._lib = zlib def uncompress(self, src, size, outsize): return self._lib.decompress(src) class LZOCompressor(Compressor): name = "lzo" def __init__(self): import lzo self._lib = lzo def uncompress(self, src, size, outsize): return self._lib.decompress(src, False, outsize) class XZCompressor(Compressor): name = "xz" def __init__(self): try: import lzma except ImportError: from backports import lzma self._lib = lzma def uncompress(self, src, size, outsize): return self._lib.decompress(src) class LZ4Compressor(Compressor): name = "lz4" def __init__(self): import lz4.frame self._lib = lz4.frame def uncompress(self, src, size, outsize): return self._lib.decompress(src) class ZSTDCompressor(Compressor): name = "zstd" def __init__(self): import zstandard self._lib = zstandard.ZstdDecompressor() def uncompress(self, src, size, outsize): return self._lib.decompress(src) compressors = { Compression.NO: Compressor, Compression.ZLIB: ZlibCompressor, Compression.LZO: LZOCompressor, Compression.XZ: XZCompressor, Compression.LZ4: LZ4Compressor, Compression.ZSTD: ZSTDCompressor } PySquashfsImage-0.9.0/PySquashfsImage/__main__.py0000664000175000017500000002034514450340472022323 0ustar debalancedebalance#!/usr/bin/env python import argparse import os import posixpath import sys from datetime import datetime, timedelta try: from datetime import timezone except ImportError: pass from time import localtime _is36 = sys.version_info >= (3, 6) if not _is36: from dateutil.tz import tzlocal, tzutc UTC = tzutc() else: UTC = timezone.utc from . import SquashFsImage, __version__ from .const import Compression from .extract import extract_dir, extract_file from .file import BlockDevice, CharacterDevice from .util import find_superblocks DTFMT = "%Y-%m-%d %H:%M:%S" ROOT = posixpath.sep def extract(args): with SquashFsImage.from_file(args.file, args.offset) as image: file = image.select(args.path) if file is None: raise Exception("{} not found".format(args.path)) parent = args.dest or '' basename = os.path.basename(file.path) or "squashfs-root" dest = os.path.join(parent, basename) dirname = os.path.dirname(dest) if dirname and not os.path.isdir(dirname): os.makedirs(dirname) if file.is_dir: extract_dir(file, dest, args.force, quiet=args.quiet) else: extract_file(file, dest, args.force, quiet=args.quiet) def _dtfromts(timestamp, utc=False): if utc: tz = UTC elif _is36: time = localtime(timestamp) tz = timezone(timedelta(seconds=time.tm_gmtoff), time.tm_zone) else: tz = tzlocal() return datetime.fromtimestamp(timestamp, tz) def print_file(file, utc=False, show_tz=False): width = 25 - len(str(file.uid)) - len(str(file.gid)) if isinstance(file, (BlockDevice, CharacterDevice)): width = max(0, width - 7) data = "{:{width}}{:3d},{:3d}".format(' ', file.major, file.minor, width=width) else: width = max(0, width) data = "{:{width}}".format(file.inode.data, width=width) dt = _dtfromts(file.inode.time, utc) print("{} {}/{} {} {} {}".format( file.filemode, file.uid, file.gid, data, dt if show_tz else dt.strftime(DTFMT), file.path ) + (" -> {}".format(file.readlink()) if file.is_symlink else '')) def list_(args): types = args.type if types is not None: types = set(''.join(types).replace('f', '-')) count = 0 with SquashFsImage.from_file(args.file, args.offset) as image: file = image.select(args.path) if file is None: raise Exception("{} not found".format(args.path)) if not file.is_dir: print_file(file, args.utc, args.show_tz) return recursive = not args.recursive if args.path == ROOT else args.recursive directory = file.riter() if recursive else file if types is None: for file in directory: print_file(file, args.utc, args.show_tz) count += 1 else: for file in directory: if file.filemode[0] in types: print_file(file, args.utc, args.show_tz) count += 1 print("{} file(s) found".format(count)) def scan(args): width = 29 superblocks = find_superblocks(args.file) if not superblocks: print("No squashfs 4.0 superblock found") return for idx, superblock in enumerate(superblocks): sblk = argparse.Namespace(**superblock) dt = _dtfromts(sblk.mkfs_time, args.utc) dtstr = dt if args.show_tz else dt.strftime(DTFMT) print("Superblock #{}".format(idx + 1)) print("{:{width}} 0x{:X}".format("Magic:", sblk.s_magic, width=width)) print("{:{width}} {}".format("Major:", sblk.s_major, width=width)) print("{:{width}} {}".format("Minor:", sblk.s_minor, width=width)) print("{:{width}} {}".format("Creation or last append time:", dtstr, width=width)) print("{:{width}} {}".format("Size:", sblk.bytes_used, width=width)) print("{:{width}} {}".format("Compression:", Compression(sblk.compression).name, width=width)) print("{:{width}} {}".format("Block size:", sblk.block_size, width=width)) print("{:{width}} {}".format("Flags:", sblk.flags, width=width)) print("{:{width}} {}".format("Number of fragments:", sblk.fragments, width=width)) print("{:{width}} {}".format("Number of inodes:", sblk.inodes, width=width)) print("{:{width}} {}".format("Number of ids:", sblk.no_ids, width=width)) print("{:{width}} 0x{:X}".format("Inode table start:", sblk.inode_table_start, width=width)) print("{:{width}} 0x{:X}".format("Directory table start:", sblk.directory_table_start, width=width)) print("{:{width}} 0x{:X}".format("Fragment table start:", sblk.fragment_table_start, width=width)) print("{:{width}} 0x{:X}".format("Lookup table start:", sblk.lookup_table_start, width=width)) print("{:{width}} 0x{:X}".format("ID table start:", sblk.id_table_start, width=width)) print("{:{width}} 0x{:X}".format("xattr ID table start:", sblk.xattr_id_table_start, width=width)) print("{:{width}} {}".format("Offset:", sblk.offset, width=width)) if idx != len(superblocks) - 1: print() def main(): parser = argparse.ArgumentParser(description="Print information about squashfs images.") parser.add_argument("-V", "--version", action="version", version="%(prog)s {}".format(__version__)) subparsers = parser.add_subparsers() # TODO: required=True Python 3 pfile = argparse.ArgumentParser(add_help=False) pfile.add_argument("file", help="squashfs filesystem") poffset = argparse.ArgumentParser(add_help=False) poffset.add_argument("-o", "--offset", type=int, default=0, help="absolute position of file system's start. Default: %(default)s") ptz = argparse.ArgumentParser(add_help=False) ptz.add_argument("--utc", action="store_true", help="use UTC rather than local time zone when displaying time. Default: %(default)s") ptz.add_argument("--showtz", action="store_true", dest="show_tz", help="show UTC offset when displaying time. Default: %(default)s") helplist = "List the contents of the file system" parser_l = subparsers.add_parser("list", parents=[pfile, poffset, ptz], help=helplist.lower(), description=helplist) parser_l.add_argument("-p", "--path", default=ROOT, help="absolute path of directory or file to list. Default: %(default)r") parser_l.add_argument("-r", "--recursive", action="store_true", help="whether to list recursively. For the root directory the value is inverted. Default: %(default)s") parser_l.add_argument("-t", "--type", nargs='+', metavar="TYPE", choices=list("fdlpsbc"), help="when listing a directory, filter by file type with %(choices)s") parser_l.set_defaults(func=list_) helpextr = "Extract files from the file system" parser_e = subparsers.add_parser("extract", parents=[pfile, poffset], help=helpextr.lower(), description=helpextr) parser_e.add_argument("-d", "--dest", help="directory that will contain the extracted file(s). If it doesn't exist it will be created. Default: current directory") parser_e.add_argument("-p", "--path", default=ROOT, help="absolute path of directory or file to extract. Default: %(default)r") parser_e.add_argument("-f", "--force", action="store_true", help="overwrite files that already exist. Default: %(default)s") parser_e.add_argument("-q", "--quiet", action="store_true", help="don't print extraction status. Default: %(default)s") parser_e.set_defaults(func=extract) helpscan = "Find and show all the superblocks that can be found in a file" parser_s = subparsers.add_parser("scan", parents=[pfile, ptz], help=helpscan.lower(), description=helpscan) parser_s.set_defaults(func=scan) args = parser.parse_args() if "file" not in args: parser.error("the following arguments are required: subcommand") if not os.path.isfile(args.file): sys.exit("error: file does not exist") if "path" in args and not posixpath.isabs(args.path): sys.exit("error: path is not absolute") if "offset" in args and args.offset is not None and args.offset < 0: sys.exit("error: offset cannot be negative") try: args.func(args) except Exception as e: sys.exit("error: {}".format(e)) if __name__ == "__main__": main() PySquashfsImage-0.9.0/PySquashfsImage/util.py0000664000175000017500000000360014450340472021553 0ustar debalancedebalanceimport io from functools import partial from .const import SQUASHFS_MAGIC, Compression from .structure import Superblock try: MAGIC_BYTES = SQUASHFS_MAGIC.to_bytes(4, "little") except AttributeError: MAGIC_BYTES = b'hsqs' # Python 2 def check_super(sblk): if sblk.s_magic != SQUASHFS_MAGIC or sblk.s_major != 4 or sblk.s_minor != 0: return False if not min(Compression) <= sblk.compression <= max(Compression): return False return True def _find_superblocks(stream, size=1024**2): stream.seek(0) indexes = set() result = [] prev_block = b'' for count, next_block in enumerate(iter(partial(stream.read, size), b'')): # We don't want to "cut" in the middle of a magic. block = prev_block + next_block index = block.find(MAGIC_BYTES) if index != -1: indexes.add(index + (count * size) - len(prev_block)) prev_block = next_block[-(len(MAGIC_BYTES) - 1) :] for index in sorted(indexes): stream.seek(index) sblk = Superblock.from_fd(stream) if check_super(sblk): result.append(dict(sblk, offset=index)) return result def find_superblocks(file_or_bytes, size=1024**2): """Return a list of dictionaries representing the superblocks found in the file with their offset. """ if hasattr(file_or_bytes, "read"): return _find_superblocks(file_or_bytes, size) try: with open(file_or_bytes, "rb") as f: return _find_superblocks(f, size) except (IOError, OSError, TypeError, UnicodeDecodeError): # TypeError and IOError: Python 2 only # UnicodeDecodeError: Python 3 only, when argument is file as bytes pass try: return _find_superblocks(io.BytesIO(file_or_bytes), size) except TypeError: pass raise Exception("file not found or wrong type") # TODO: Python 3 from None PySquashfsImage-0.9.0/PySquashfsImage/__init__.py0000664000175000017500000003675014450340472022351 0ustar debalancedebalance# -*- coding: utf-8 -*- """ This module is released with the LGPL license. Copyright 2011-2012 Matteo Mattei Nicola Ponzeveroni It is intended to be used to access files inside a Squashfs 4.0 little endian image file. Based on squashfs-tools by Phillip Lougher https://github.com/matteomattei/PySquashfsImage https://github.com/plougher/squashfs-tools """ __all__ = ["SquashFsImage"] __version__ = "0.9.0" import io import stat import struct import sys from ctypes import sizeof try: from functools import lru_cache except ImportError: def lru_cache(maxsize=128, typed=False): return lambda user_function: user_function from .compressor import compressors from .const import ( SQUASHFS_INVALID_BLK, SQUASHFS_INVALID_FRAG, SQUASHFS_METADATA_SIZE, Type, ) from .file import Directory, filetype from .macro import ( SQUASHFS_CHECK_DATA, SQUASHFS_COMPRESSED, SQUASHFS_COMPRESSED_BLOCK, SQUASHFS_COMPRESSED_SIZE, SQUASHFS_COMPRESSED_SIZE_BLOCK, SQUASHFS_FRAGMENT_BYTES, SQUASHFS_FRAGMENT_INDEXES, SQUASHFS_ID_BLOCK_BYTES, SQUASHFS_ID_BLOCKS, SQUASHFS_ID_BYTES, SQUASHFS_INODE_BLK, SQUASHFS_INODE_OFFSET, SQUASHFS_XATTR_BLOCK_BYTES, SQUASHFS_XATTR_BLOCKS, SQUASHFS_XATTR_BYTES, ) from .structure import DirEntry, DirHeader, FragmentEntry, Superblock, XattrId, XattrTable from .structure.inode import InodeHeader, inomap from .util import check_super SQUASHFS_LOOKUP_TYPE = [ 0, stat.S_IFDIR, stat.S_IFREG, stat.S_IFLNK, stat.S_IFBLK, stat.S_IFCHR, stat.S_IFIFO, stat.S_IFSOCK, stat.S_IFDIR, stat.S_IFREG, stat.S_IFLNK, stat.S_IFBLK, stat.S_IFCHR, stat.S_IFIFO, stat.S_IFSOCK ] class SquashFsImage(object): def __init__(self, fd, offset=0, closefd=True): self._fd = fd self._offset = offset self._closefd = closefd self._sblk = None self._root = None self._comp = None self._inode_table_hash = {} self._directory_table_hash = {} self._fragment_table = [] self._id_table = {} self._hash_table = {} self._xattrs = b"" self._initialize() def __enter__(self): return self def __exit__(self, exc_type, exc_value, traceback): if self._closefd: self.close() def __iter__(self): return self._root.riter() @property def root(self): return self._root @property def sblk(self): return self._sblk @property def size(self): """Filesystem size in bytes.""" return self._sblk.bytes_used @classmethod def from_bytes(cls, bytes_, offset=0): return cls(io.BytesIO(bytes_), offset) @classmethod def from_file(cls, path, offset=0): return cls(open(path, "rb"), offset) def close(self): self._fd.close() self._fd = None def _read_super(self): self._sblk = Superblock.from_fd(self._fd) if not check_super(self._sblk): raise IOError("The file supplied is not a squashfs 4.0 image") self._comp = self._get_compressor(self._sblk.compression) def _get_compressor(self, compression_id): if compression_id not in compressors: raise ValueError("Unknown compression method %r" % compression_id) return compressors[compression_id]() def _initialize(self): self._fd.seek(self._offset) self._read_super() self._read_uids_guids() self._read_fragment_table() self._read_xattrs_from_disk() root_block = SQUASHFS_INODE_BLK(self._sblk.root_inode) root_offs = SQUASHFS_INODE_OFFSET(self._sblk.root_inode) self._root = self._dir_scan(root_block, root_offs) @lru_cache(maxsize=256) def _read_data_block(self, start, size): c_byte = SQUASHFS_COMPRESSED_SIZE_BLOCK(size) self._fd.seek(self._offset + start) data = self._fd.read(c_byte) if SQUASHFS_COMPRESSED_BLOCK(size): return self._comp.uncompress(data, c_byte, self._sblk.block_size) else: return data def iter_file(self, inode): # unsquashfs.c -> write_file start = inode.start file_end = inode.data // self._sblk.block_size if inode.blocks: block_list = self._read_block_list(inode.block_start, inode.block_offset, inode.blocks) for i, block in enumerate(block_list): if block == SQUASHFS_INVALID_FRAG: continue if block: # non sparse file yield self._read_data_block(start, block) start += SQUASHFS_COMPRESSED_SIZE_BLOCK(block) else: if i == file_end: yield b'\x00' * (inode.data & (self._sblk.block_size - 1)) else: yield b'\x00' * self._sblk.block_size if inode.frag_bytes: start, size = self._read_fragment(inode.fragment) buffer = self._read_data_block(start, size) yield buffer[inode.offset : inode.offset + inode.frag_bytes] def read_file(self, inode): return b''.join(self.iter_file(inode)) def _read_block_list(self, start, offset, blocks): # unsquash-4.c size = 4 # sizeof(unsigned int) idata, _, _ = self._read_inode_data(start, offset, blocks * size) ret = [] ofs = 0 for _ in range(blocks): # use struct.iter_unpack when Py3 only ret.append(self._make_buf_integer(idata, ofs, size)) ofs += size return ret def _read_block(self, start, expected=SQUASHFS_METADATA_SIZE): """Read a block starting at offset `start` relative to the start of the image. Return the uncompressed block and the start of the next compressed one. """ # unsquashfs.c self._fd.seek(self._offset + start) c_byte = self._read_short() offset = 3 if SQUASHFS_CHECK_DATA(self._sblk.flags) else 2 self._fd.seek(self._offset + start + offset) size = SQUASHFS_COMPRESSED_SIZE(c_byte) block = self._fd.read(size) if SQUASHFS_COMPRESSED(c_byte): block = self._comp.uncompress(block, size, expected) return block, start + offset + size def _read_fragment_table(self): # unsquash-4.c bytes_ = SQUASHFS_FRAGMENT_BYTES(self._sblk.fragments) indexes = SQUASHFS_FRAGMENT_INDEXES(self._sblk.fragments) if self._sblk.fragments == 0: return self._fd.seek(self._offset + self._sblk.fragment_table_start) fragment_table_index = [self._read_long() for _ in range(indexes)] table = b'' for i, index in enumerate(fragment_table_index): if (i + 1) != indexes: expected = SQUASHFS_METADATA_SIZE else: expected = bytes_ & (SQUASHFS_METADATA_SIZE - 1) table += self._read_block(index, expected)[0] ofs = 0 while ofs < len(table): entry = FragmentEntry.from_bytes(table, ofs) ofs += sizeof(FragmentEntry) self._fragment_table.append(entry) def _read_fragment(self, fragment): # unsquash-4.c entry = self._fragment_table[fragment] return (entry.start_block, entry.size) def _read_inode(self, start_block, offset): # unsquash-4.c start = self._sblk.inode_table_start + start_block idata, start, offset = self._read_inode_data(start, offset, sizeof(InodeHeader)) header = InodeHeader.from_bytes(idata) cls = inomap[header.inode_type] idata, start, offset = self._read_inode_data(start, offset, sizeof(cls)) ino = cls.from_bytes(idata) ino._header = header ino._uid = self._id_table[header.uid] ino._gid = self._id_table[header.guid] ino._mode = SQUASHFS_LOOKUP_TYPE[header.inode_type] | header.mode try: inode_type = Type(header.inode_type) except ValueError: raise RuntimeError("Unknown inode type %d in read_inode!\n" % header.inode_type) if inode_type in (Type.FILE, Type.LREG): ino._block_start = start ino._block_offset = offset if ino.fragment == SQUASHFS_INVALID_FRAG: ino._frag_bytes = 0 ino._blocks = (ino.data + self._sblk.block_size - 1) >> self._sblk.block_log else: ino._frag_bytes = ino.file_size % self._sblk.block_size ino._blocks = ino.data >> self._sblk.block_log elif inode_type in (Type.SYMLINK, Type.LSYMLINK): idata, start, offset = self._read_inode_data(start, offset, ino.symlink_size) ino._symlink = idata if inode_type == Type.LSYMLINK: idata, start, offset = self._read_inode_data(start, offset, 4) ino._xattr = self._make_buf_integer(idata, 0, len(idata)) return ino def _opendir(self, block_start, offset): # unsquash-4.c -> squashfs_opendir inode = self._read_inode(block_start, offset) directory = Directory(self, inode) directory.entries = [] if inode.data == 3: return directory start = self._sblk.directory_table_start + inode.start offset = inode.offset size = inode.data - 3 bytes_ = 0 while bytes_ < size: ddata, start, offset = self._read_directory_data(start, offset, sizeof(DirHeader)) dirh = DirHeader.from_bytes(ddata) bytes_ += sizeof(DirHeader) for _ in range(dirh.count + 1): ddata, start, offset = self._read_directory_data(start, offset, sizeof(DirEntry)) dire = DirEntry.from_bytes(ddata) namelen = dire.size + 1 ddata, start, offset = self._read_directory_data(start, offset, namelen) dire._name = ddata bytes_ += sizeof(DirEntry) + namelen directory.entries.append({ "name": dire._name, "start_block": dirh.start_block, "offset": dire.offset, "type": dire.type }) return directory def _read_uids_guids(self): size = 4 bytes_ = SQUASHFS_ID_BYTES(self._sblk.no_ids) indexes = SQUASHFS_ID_BLOCKS(self._sblk.no_ids) id_index_table = [] self._fd.seek(self._offset + self._sblk.id_table_start) for _ in range(indexes): id_index_table.append(self._make_integer(SQUASHFS_ID_BLOCK_BYTES(1))) for i, idx in enumerate(id_index_table): if (i + 1) != indexes: expected = SQUASHFS_METADATA_SIZE else: expected = bytes_ & (SQUASHFS_METADATA_SIZE - 1) block = self._read_block(idx, expected)[0] offset = 0 index = i * (SQUASHFS_METADATA_SIZE // 4) while offset < len(block): self._id_table[index] = self._make_buf_integer(block, offset, size) offset += size index += 1 def _read_xattrs_from_disk(self): # read_xattrs.c if self._sblk.xattr_id_table_start == SQUASHFS_INVALID_BLK: return SQUASHFS_INVALID_BLK self._fd.seek(self._offset + self._sblk.xattr_id_table_start) id_table = XattrTable.from_fd(self._fd) ids = id_table.xattr_ids xattr_table_start = id_table.xattr_table_start indexes = SQUASHFS_XATTR_BLOCKS(ids) index = [] for _ in range(indexes): index.append(self._make_integer(SQUASHFS_XATTR_BLOCK_BYTES(1))) bytes_ = SQUASHFS_XATTR_BYTES(ids) xattr_ids = {} for i, idx in enumerate(index): if (i + 1) != indexes: expected = SQUASHFS_METADATA_SIZE else: expected = bytes_ & (SQUASHFS_METADATA_SIZE - 1) block = self._read_block(idx, expected)[0] cur_idx = (i * SQUASHFS_METADATA_SIZE) / 16 ofs = 0 while ofs < len(block): xattr_ids[cur_idx] = XattrId.from_bytes(block, ofs) cur_idx += 1 ofs += sizeof(XattrId) start = xattr_table_start i = 0 while start < index[0]: self._hash_table[start] = i * SQUASHFS_METADATA_SIZE block, start = self._read_block(start) for i in range(len(block), SQUASHFS_METADATA_SIZE): block += b'\x00' self._xattrs += block i += 1 return ids def _dir_scan(self, start_block, offset): directory = self._opendir(start_block, offset) for entry in directory.entries: # No need for squashfs_readdir() start_block = entry["start_block"] offset = entry["offset"] if entry["type"] == Type.DIR: subdir = self._dir_scan(start_block, offset) subdir._parent = directory subdir._name = entry["name"] directory.children[subdir.name] = subdir else: inode = self._read_inode(start_block, offset) cls = filetype[entry["type"]] file = cls(self, inode, entry["name"], directory) directory.children[file.name] = file del directory.entries return directory def _make_integer(self, length): """Assemble multibyte integer.""" return self._make_buf_integer(self._fd.read(length), 0, length) def _make_buf_integer(self, buf, start, length): """Assemble multibyte integer.""" if sys.version_info < (3, 2): ret = 0 pwr = 1 for i in range(start, start + length): ret += (ord(buf[i]) & 0xFF) * pwr pwr *= 0x100 return ret else: return int.from_bytes(buf[start : start + length], byteorder='little') def _read_integer(self, fmt): return struct.unpack(fmt, self._fd.read(struct.calcsize(fmt)))[0] def _read_short(self): return self._read_integer(" v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'PyUbootImagedoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'PyUbootImage.tex', u'PyUbootImage Documentation', u'Matteo Mattei; Nicola Ponzeveroni', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'pysquashfsimage', u'PySquashfsImage Documentation', [u'Matteo Mattei; Nicola Ponzeveroni'], 1) ] PySquashfsImage-0.9.0/docs/index.rst0000664000175000017500000000072114450340472017745 0ustar debalancedebalance.. PySquashfsImage documentation master file, created by sphinx-quickstart on Thu Dec 1 13:03:48 2011. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to PySquashfsImage's documentation! ======================================== Contents: .. toctree:: :maxdepth: 2 getting_started Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` PySquashfsImage-0.9.0/MANIFEST.in0000664000175000017500000000011614450340472016710 0ustar debalancedebalanceinclude LICENSE* recursive-include PyUbootImage *.py recursive-include docs * PySquashfsImage-0.9.0/LICENSE.LGPL0000664000175000017500000006350414450340472016726 0ustar debalancedebalance GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! PySquashfsImage-0.9.0/README.md0000664000175000017500000001620014450340472016432 0ustar debalancedebalancePySquashfsImage is a lightweight library and tool for reading and extracting squashfs 4.0 little endian images in Python. It provides a high-level API for easy access to these file systems. It is compatible with Python 2.7 and Python 3.1+. ## Installation ``` pip install PySquashfsImage ``` ### Compression Supported compression methods: - Gzip - [LZ4](https://pypi.org/project/lz4/) (requires Python 3.7+) - [LZO](https://pypi.org/project/python-lzo/) (requires Python 2.7 or 3.5+, also see [here](https://test.pypi.org/project/python-lzo/)) - [XZ](https://pypi.org/project/backports.lzma/) (included in Python 3.3+) - [Zstandard](https://pypi.org/project/zstandard/) (requires Python 3.7+) Some of them require a third-party library that you'll need to install separately if needed. ## Use as a library ### List all elements in the image: ```python from PySquashfsImage import SquashFsImage image = SquashFsImage.from_file('/path/to/my/image.img') for item in image: print(item.name) image.close() ``` ### Print all entries with their absolute path: ```python from PySquashfsImage import SquashFsImage # Use with a context manager (recommended). with SquashFsImage.from_file('/path/to/my/image.img') as image: for file in image: print(file.path) ``` ### Print all entries that aren't directories: ```python from PySquashfsImage import SquashFsImage with open('/path/to/my/image.img', "rb") as f: imgbytes = f.read() # Create an image from bytes. with SquashFsImage.from_bytes(imgbytes) as image: for item in image: if not item.is_dir: print(item.path) ``` ### Save the content of a file: ```python from PySquashfsImage import SquashFsImage from PySquashfsImage.extract import extract_file with SquashFsImage.from_file('/path/to/my/image.img') as image: myfile = image.find('myfilename') if myfile is not None: with open('/tmp/' + myfile.name, 'wb') as f: print('Saving original ' + myfile.path + ' in /tmp/' + myfile.name) f.write(myfile.read_bytes()) # If the file is large it's preferable to iterate over its content. hugefile = image.select("/hugedir/myhugefile.big") with open("myhugefile.big", "wb") as f: for block in hugefile.iter_bytes(): f.write(block) # Or use extract_file(), which preserves the file's metadata (except extended attributes). extract_file(myfile, "myextractedfile") ``` ### Save the content of a directory: ```python from PySquashfsImage import SquashFsImage from PySquashfsImage.extract import extract_dir with SquashFsImage.from_file('/path/to/my/image.img') as image: mydir = image.select("/mydir") if mydir is not None: # Metadata is handled the same way as with extract_file(). extract_dir(mydir, "/tmp/mydir") ``` ## Use as a command ### List ``` $ pysquashfs list -h usage: pysquashfs list [-h] [-o OFFSET] [--utc] [--showtz] [-p PATH] [-r] [-t TYPE [TYPE ...]] file List the contents of the file system positional arguments: file squashfs filesystem optional arguments: -h, --help show this help message and exit -o OFFSET, --offset OFFSET absolute position of file system's start. Default: 0 --utc use UTC rather than local time zone when displaying time. Default: False --showtz show UTC offset when displaying time. Default: False -p PATH, --path PATH absolute path of directory or file to list. Default: '/' -r, --recursive whether to list recursively. For the root directory the value is inverted. Default: False -t TYPE [TYPE ...], --type TYPE [TYPE ...] when listing a directory, filter by file type with f, d, l, p, s, b, c ``` Similar to `unsquashfs -ll -full`. Example that only lists directories under the root directory: ``` $ pysquashfs list myimage.img -r -t d drwxrwxrwx 1049/1049 468 2018-10-10 08:14:16 /bin drwxrwxrwx 1049/1049 3 2021-05-14 18:46:17 /dev drwxrwxrwx 1049/1049 869 2019-11-12 09:31:30 /etc drwxrwxrwx 1049/1049 3 2021-05-14 18:46:17 /home drwxrwxrwx 1049/1049 406 2017-12-11 08:14:16 /lib drwxrwxrwx 1049/1049 98 2021-05-14 18:46:17 /mnt drwxrwxrwx 1049/1049 3 2021-05-14 15:12:17 /proc drwxrwxrwx 1049/1049 3 2021-05-14 15:12:17 /root drwxrwxrwx 1049/1049 690 2021-05-14 12:11:44 /sbin drwxrwxrwx 1049/1049 3 2021-05-14 15:12:17 /sys drwxrwxrwx 1049/1049 3 2021-05-14 18:46:17 /tmp drwxrwxrwx 1049/1049 364 2021-05-14 18:46:17 /usr drwxrwxrwx 1049/1049 60 2018-11-09 05:38:43 /var 13 file(s) found ``` ### Extract ``` $ pysquashfs extract -h usage: pysquashfs extract [-h] [-o OFFSET] [-d DEST] [-p PATH] [-f] [-q] file Extract files from the file system positional arguments: file squashfs filesystem optional arguments: -h, --help show this help message and exit -o OFFSET, --offset OFFSET absolute position of file system's start. Default: 0 -d DEST, --dest DEST directory that will contain the extracted file(s). If it doesn't exist it will be created. Default: current directory -p PATH, --path PATH absolute path of directory or file to extract. Default: '/' -f, --force overwrite files that already exist. Default: False -q, --quiet don't print extraction status. Default: False ``` On Unix, this command tries to give the same output as `unsquashfs`, but should not be preferred over it. Some features like extended attributes are missing. On Windows, you might create symlinks with a privileged account or with an unprivileged one if Developer Mode is enabled. Otherwise, a regular file containing the target will be created. Special files are ignored. Example command that will extract `/bin` under `/tmp`: ``` $ pysquashfs extract myimage.img -p /bin -d /tmp ``` ### Scan ``` $ pysquashfs scan -h usage: pysquashfs scan [-h] [--utc] [--showtz] file Find and show all the superblocks that can be found in a file positional arguments: file squashfs filesystem optional arguments: -h, --help show this help message and exit --utc use UTC rather than local time zone when displaying time. Default: False --showtz show UTC offset when displaying time. Default: False ``` Output is similar to `unsquashfs -s [-UTC]`. Example: ``` $ pysquashfs scan myimage.img Superblock #1 Magic: 0x73717368 Major: 4 Minor: 0 Creation or last append time: 2018-06-16 16:46:23 Size: 7864320 Compression: XZ Block size: 524288 Flags: 192 Number of fragments: 27 Number of inodes: 361 Number of ids: 1 Inode table start: 0x77E924 Directory table start: 0x77FAF2 Fragment table start: 0x781448 Lookup table start: 0x7817C6 ID table start: 0x7817D4 xattr ID table start: 0xFFFFFFFFFFFFFFFF Offset: 161843 ```PySquashfsImage-0.9.0/LICENSE.GPL30000664000175000017500000010600614450340472016670 0ustar debalancedebalance GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ------------------------------------------------------------------------- In addition, as a special exception, Nokia gives permission to link the code of its release of Qt with the OpenSSL project's "OpenSSL" library (or modified versions of it that use the same license as the "OpenSSL" library), and distribute the linked executables. You must comply with the GNU General Public License versions 2.0 or 3.0 in all respects for all of the code used other than the "OpenSSL" code. If you modify this file, you may extend this exception to your version of the file, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version of this file. PySquashfsImage-0.9.0/setup.cfg0000664000175000017500000000024114450340472016772 0ustar debalancedebalance[build_sphinx] source-dir = docs build-dir = docs/_build all_files = 1 [upload_sphinx] upload-dir = docs/_build/html [metadata] description-file = README.md PySquashfsImage-0.9.0/setup.py0000664000175000017500000000503014450340472016664 0ustar debalancedebalance#!/usr/bin/env python import os.path from io import open # Remove this import when dropping Python 2 support from setuptools import setup, find_packages with open("README.md", 'r', encoding="utf8") as f: long_description = f.read() def get_version(): here = os.path.abspath(os.path.dirname(__file__)) with open(os.path.join(here, "PySquashfsImage/__init__.py")) as f: for line in f: if line.startswith("__version__"): delim = '"' if '"' in line else "'" return line.split(delim)[1] raise RuntimeError("Unable to find version string.") setup( name='PySquashfsImage', version=get_version(), description='Squashfs image parser', long_description=long_description, long_description_content_type="text/markdown", author='Matteo Mattei; Nicola Ponzeveroni;', author_email='info@matteomattei.com', url='https://github.com/matteomattei/PySquashfsImage', packages=find_packages(), keywords=["filesystem", "parser", "squash", "squashfs"], python_requires=">=2.7, !=3.0.*", install_requires=[ "argparse;python_version == '3.1'", "enum34;python_version < '3.4'", "python-dateutil;python_version < '3.6'" ], classifiers=[ "Development Status :: 4 - Beta", "Environment :: Other Environment", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.1", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: System :: Filesystems", "Topic :: Utilities", ], entry_points={ "console_scripts": [ "pysquashfs = PySquashfsImage.__main__:main", ] } ) PySquashfsImage-0.9.0/build_and_upload.sh0000775000175000017500000000015414450340472021000 0ustar debalancedebalance#!/bin/bash python setup.py clean check build sdist bdist_egg bdist_wheel build_sphinx twine upload dist/*