dissect.database 0.1.dev3__tar.gz → 0.1.dev4__tar.gz

{dissect_database-0.1.dev3 → dissect_database-0.1.dev4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: dissect.database
-Version: 0.1.dev3
-Summary: A Dissect module implementing parsers for various database formats
+Version: 0.1.dev4
+Summary: A Dissect module implementing parsers for various database formats, including Berkeley DB and SQLite3
 Author-email: Dissect Team <dissect@fox-it.com>
 License-Expression: Apache-2.0
 Project-URL: homepage, https://dissect.tools
@@ -29,8 +29,12 @@ Dynamic: license-file
 
 # dissect.database
 
-A Dissect module implementing parsers for various database formats. For more information,
-please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.database/index.html).
+A Dissect module implementing parsers for various database formats, including:
+
+- Berkeley DB
+- SQLite3
+
+For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.database/index.html).
 
 ## Installation
 

{dissect_database-0.1.dev3 → dissect_database-0.1.dev4}/README.md

@@ -1,7 +1,11 @@
 # dissect.database
 
-A Dissect module implementing parsers for various database formats. For more information,
-please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.database/index.html).
+A Dissect module implementing parsers for various database formats, including:
+
+- Berkeley DB
+- SQLite3
+
+For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.database/index.html).
 
 ## Installation
 

dissect_database-0.1.dev4/dissect/database/__init__.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dissect.database.bsd.db import DB
+from dissect.database.exception import Error
+from dissect.database.sqlite3.sqlite3 import SQLite3
+
+__all__ = [
+    "DB",
+    "Error",
+    "SQLite3",
+]

dissect_database-0.1.dev4/dissect/database/exception.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+
+class Error(Exception):
+    pass

dissect_database-0.1.dev4/dissect/database/sqlite3/__init__.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dissect.database.sqlite3.exception import (
+    InvalidDatabase,
+    InvalidPageNumber,
+    InvalidPageType,
+    InvalidSQL,
+    NoCellData,
+    NoWriteAheadLog,
+)
+from dissect.database.sqlite3.sqlite3 import WAL, Column, Row, SQLite3, Table
+
+__all__ = [
+    "WAL",
+    "Column",
+    "InvalidDatabase",
+    "InvalidPageNumber",
+    "InvalidPageType",
+    "InvalidSQL",
+    "NoCellData",
+    "NoWriteAheadLog",
+    "Row",
+    "SQLite3",
+    "Table",
+]

dissect_database-0.1.dev4/dissect/database/sqlite3/c_sqlite3.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from dissect.cstruct import cstruct
+
+# Resource: https://www.sqlite.org/fileformat.html
+sqlite3_def = """
+#define PAGE_FLAG_INTKEY      0x01
+#define PAGE_FLAG_ZERODATA    0x02
+#define PAGE_FLAG_LEAFDATA    0x04
+#define PAGE_FLAG_LEAF        0x08
+
+#define PAGE_TYPE_INTERIOR_INDEX    PAGE_FLAG_ZERODATA
+#define PAGE_TYPE_INTERIOR_TABLE    PAGE_FLAG_INTKEY | PAGE_FLAG_LEAFDATA
+#define PAGE_TYPE_LEAF_INDEX        PAGE_FLAG_ZERODATA | PAGE_FLAG_LEAF
+#define PAGE_TYPE_LEAF_TABLE        PAGE_FLAG_INTKEY | PAGE_FLAG_LEAFDATA | PAGE_FLAG_LEAF
+
+struct header {
+    char    magic[16];
+    uint16  page_size;
+    uint8   write_version;
+    uint8   read_version;
+    uint8   reserved_size;
+    uint8   max_embedded_payload_fraction;
+    uint8   min_embedded_payload_fraction;
+    uint8   leaf_payload_fraction;
+    uint32  change_counter;
+    uint32  page_count;
+    uint32  first_freelist_page;
+    uint32  freelist_page_count;
+    uint32  schema_cookie;
+    uint32  schema_format_number;
+    uint32  page_cache_size;
+    uint32  largest_root_btree_page;
+    uint32  text_encoding;
+    uint32  user_version;
+    uint32  incremental_vacuum_mode;
+    uint32  application_id;
+    char    reserved1[20];
+    uint32  version_valid_for_number;
+    uint32  sqlite_version_number;
+};
+
+struct page_header {
+    uint8   flags;
+    uint16  first_freeblock;
+    uint16  cell_count;
+    uint16  cell_start;
+    uint8   fragmented_free_bytes;
+};
+
+struct wal_header {
+    uint32  magic;
+    uint32  version;
+    uint32  page_size;
+    uint32  checkpoint_sequence_number;
+    uint32  salt1;
+    uint32  salt2;
+    uint32  checksum1;
+    uint32  checksum2;
+};
+
+struct wal_frame {
+    uint32  page_number;
+    uint32  page_count;
+    uint32  salt1;
+    uint32  salt2;
+    uint32  checksum1;
+    uint32  checksum2;
+};
+"""
+
+c_sqlite3 = cstruct(endian=">").load(sqlite3_def)

dissect_database-0.1.dev4/dissect/database/sqlite3/c_sqlite3.pyi

@@ -0,0 +1,132 @@
+# Generated by cstruct-stubgen
+from typing import BinaryIO, Literal, TypeAlias, overload
+
+import dissect.cstruct as __cs__
+
+class _c_sqlite3(__cs__.cstruct):
+    PAGE_FLAG_INTKEY: Literal[1] = ...
+    PAGE_FLAG_ZERODATA: Literal[2] = ...
+    PAGE_FLAG_LEAFDATA: Literal[4] = ...
+    PAGE_FLAG_LEAF: Literal[8] = ...
+    PAGE_TYPE_INTERIOR_INDEX: Literal[2] = ...
+    PAGE_TYPE_INTERIOR_TABLE: Literal[5] = ...
+    PAGE_TYPE_LEAF_INDEX: Literal[10] = ...
+    PAGE_TYPE_LEAF_TABLE: Literal[13] = ...
+    class header(__cs__.Structure):
+        magic: __cs__.CharArray
+        page_size: _c_sqlite3.uint16
+        write_version: _c_sqlite3.uint8
+        read_version: _c_sqlite3.uint8
+        reserved_size: _c_sqlite3.uint8
+        max_embedded_payload_fraction: _c_sqlite3.uint8
+        min_embedded_payload_fraction: _c_sqlite3.uint8
+        leaf_payload_fraction: _c_sqlite3.uint8
+        change_counter: _c_sqlite3.uint32
+        page_count: _c_sqlite3.uint32
+        first_freelist_page: _c_sqlite3.uint32
+        freelist_page_count: _c_sqlite3.uint32
+        schema_cookie: _c_sqlite3.uint32
+        schema_format_number: _c_sqlite3.uint32
+        page_cache_size: _c_sqlite3.uint32
+        largest_root_btree_page: _c_sqlite3.uint32
+        text_encoding: _c_sqlite3.uint32
+        user_version: _c_sqlite3.uint32
+        incremental_vacuum_mode: _c_sqlite3.uint32
+        application_id: _c_sqlite3.uint32
+        reserved1: __cs__.CharArray
+        version_valid_for_number: _c_sqlite3.uint32
+        sqlite_version_number: _c_sqlite3.uint32
+        @overload
+        def __init__(
+            self,
+            magic: __cs__.CharArray | None = ...,
+            page_size: _c_sqlite3.uint16 | None = ...,
+            write_version: _c_sqlite3.uint8 | None = ...,
+            read_version: _c_sqlite3.uint8 | None = ...,
+            reserved_size: _c_sqlite3.uint8 | None = ...,
+            max_embedded_payload_fraction: _c_sqlite3.uint8 | None = ...,
+            min_embedded_payload_fraction: _c_sqlite3.uint8 | None = ...,
+            leaf_payload_fraction: _c_sqlite3.uint8 | None = ...,
+            change_counter: _c_sqlite3.uint32 | None = ...,
+            page_count: _c_sqlite3.uint32 | None = ...,
+            first_freelist_page: _c_sqlite3.uint32 | None = ...,
+            freelist_page_count: _c_sqlite3.uint32 | None = ...,
+            schema_cookie: _c_sqlite3.uint32 | None = ...,
+            schema_format_number: _c_sqlite3.uint32 | None = ...,
+            page_cache_size: _c_sqlite3.uint32 | None = ...,
+            largest_root_btree_page: _c_sqlite3.uint32 | None = ...,
+            text_encoding: _c_sqlite3.uint32 | None = ...,
+            user_version: _c_sqlite3.uint32 | None = ...,
+            incremental_vacuum_mode: _c_sqlite3.uint32 | None = ...,
+            application_id: _c_sqlite3.uint32 | None = ...,
+            reserved1: __cs__.CharArray | None = ...,
+            version_valid_for_number: _c_sqlite3.uint32 | None = ...,
+            sqlite_version_number: _c_sqlite3.uint32 | None = ...,
+        ): ...
+        @overload
+        def __init__(self, fh: bytes | memoryview | bytearray | BinaryIO, /): ...
+
+    class page_header(__cs__.Structure):
+        flags: _c_sqlite3.uint8
+        first_freeblock: _c_sqlite3.uint16
+        cell_count: _c_sqlite3.uint16
+        cell_start: _c_sqlite3.uint16
+        fragmented_free_bytes: _c_sqlite3.uint8
+        @overload
+        def __init__(
+            self,
+            flags: _c_sqlite3.uint8 | None = ...,
+            first_freeblock: _c_sqlite3.uint16 | None = ...,
+            cell_count: _c_sqlite3.uint16 | None = ...,
+            cell_start: _c_sqlite3.uint16 | None = ...,
+            fragmented_free_bytes: _c_sqlite3.uint8 | None = ...,
+        ): ...
+        @overload
+        def __init__(self, fh: bytes | memoryview | bytearray | BinaryIO, /): ...
+
+    class wal_header(__cs__.Structure):
+        magic: _c_sqlite3.uint32
+        version: _c_sqlite3.uint32
+        page_size: _c_sqlite3.uint32
+        checkpoint_sequence_number: _c_sqlite3.uint32
+        salt1: _c_sqlite3.uint32
+        salt2: _c_sqlite3.uint32
+        checksum1: _c_sqlite3.uint32
+        checksum2: _c_sqlite3.uint32
+        @overload
+        def __init__(
+            self,
+            magic: _c_sqlite3.uint32 | None = ...,
+            version: _c_sqlite3.uint32 | None = ...,
+            page_size: _c_sqlite3.uint32 | None = ...,
+            checkpoint_sequence_number: _c_sqlite3.uint32 | None = ...,
+            salt1: _c_sqlite3.uint32 | None = ...,
+            salt2: _c_sqlite3.uint32 | None = ...,
+            checksum1: _c_sqlite3.uint32 | None = ...,
+            checksum2: _c_sqlite3.uint32 | None = ...,
+        ): ...
+        @overload
+        def __init__(self, fh: bytes | memoryview | bytearray | BinaryIO, /): ...
+
+    class wal_frame(__cs__.Structure):
+        page_number: _c_sqlite3.uint32
+        page_count: _c_sqlite3.uint32
+        salt1: _c_sqlite3.uint32
+        salt2: _c_sqlite3.uint32
+        checksum1: _c_sqlite3.uint32
+        checksum2: _c_sqlite3.uint32
+        @overload
+        def __init__(
+            self,
+            page_number: _c_sqlite3.uint32 | None = ...,
+            page_count: _c_sqlite3.uint32 | None = ...,
+            salt1: _c_sqlite3.uint32 | None = ...,
+            salt2: _c_sqlite3.uint32 | None = ...,
+            checksum1: _c_sqlite3.uint32 | None = ...,
+            checksum2: _c_sqlite3.uint32 | None = ...,
+        ): ...
+        @overload
+        def __init__(self, fh: bytes | memoryview | bytearray | BinaryIO, /): ...
+
+# Technically `c_sqlite3` is an instance of `_c_sqlite3`, but then we can't use it in type hints
+c_sqlite3: TypeAlias = _c_sqlite3

dissect_database-0.1.dev4/dissect/database/sqlite3/exception.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from dissect.database.exception import Error
+
+
+class InvalidDatabase(Error):
+    pass
+
+
+class InvalidPageNumber(Error):
+    pass
+
+
+class InvalidPageType(Error):
+    pass
+
+
+class InvalidSQL(Error):
+    pass
+
+
+class NoCellData(Error):
+    pass
+
+
+class NoWriteAheadLog(Error):
+    pass