dissect.database 0.1.dev2__tar.gz → 0.1.dev4__tar.gz

{dissect_database-0.1.dev2 → dissect_database-0.1.dev4}/COPYRIGHT

@@ -2,4 +2,4 @@ Dissect is released as open source by Fox-IT (https://www.fox-it.com) part of NC
 
 Developed by the Dissect Team (dissect@fox-it.com) and made available at https://github.com/fox-it/dissect.database
 
-License terms: AGPL3 (https://www.gnu.org/licenses/agpl-3.0.html)
+License terms: Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0)

dissect_database-0.1.dev4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Fox-IT B.V.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: dissect.database
-Version: 0.1.dev2
-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
 
@@ -75,4 +79,4 @@ Dissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of
 
 Developed by the Dissect Team (<dissect@fox-it.com>) and made available at <https://github.com/fox-it/dissect>.
 
-License terms: AGPL3 (<https://www.gnu.org/licenses/agpl-3.0.html>). For more information, see the LICENSE file.
+License terms: Apache License 2.0 (<https://www.apache.org/licenses/LICENSE-2.0>). For more information, see the LICENSE file.

{dissect_database-0.1.dev2 → 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
 
@@ -46,4 +50,4 @@ Dissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of
 
 Developed by the Dissect Team (<dissect@fox-it.com>) and made available at <https://github.com/fox-it/dissect>.
 
-License terms: AGPL3 (<https://www.gnu.org/licenses/agpl-3.0.html>). For more information, see the LICENSE file.
+License terms: Apache License 2.0 (<https://www.apache.org/licenses/LICENSE-2.0>). For more information, see the LICENSE file.

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