sqlce 0.1.0__tar.gz → 0.1.2__tar.gz

sqlce-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,162 @@
+name: Build and release
+
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  build-linux:
+    name: Build wheel (Linux)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.21.3
+        env:
+          CIBW_ARCHS_LINUX: x86_64
+          CIBW_BUILD_VERBOSITY: 1
+
+      - name: Build sdist
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --sdist
+
+      - name: Collect wheels and sdist into one flat folder
+        run: |
+          mkdir -p collected
+          cp wheelhouse/*.whl collected/
+          cp dist/*.tar.gz collected/
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-linux
+          path: collected/*
+
+  build-windows:
+    name: Build wheel (Windows)
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.21.3
+        env:
+          CIBW_ARCHS_WINDOWS: AMD64
+          CIBW_BUILD_VERBOSITY: 1
+          CIBW_CMAKE_ARGS: "-DSDF_BUILD_PYTHON_BINDINGS=ON"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-windows
+          path: wheelhouse/*
+
+  build-cpp-linux:
+    name: Build C++ library (Linux, ${{ matrix.link }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        link: [static, shared]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure CMake
+        run: |
+          cmake -S . -B build \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DBUILD_SHARED_LIBS=${{ matrix.link == 'shared' && 'ON' || 'OFF' }}
+
+      - name: Build libsdf
+        run: cmake --build build --target libsdf -j
+
+      - name: Package library + headers
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          pkg="libsdf-${version}-linux-x86_64-${{ matrix.link }}"
+          mkdir -p "$pkg/lib" "$pkg/include"
+          cp build/dist/lib/libsdf.* "$pkg/lib/"
+          cp -r core/include/. "$pkg/include/"
+          tar -czf "${pkg}.tar.gz" "$pkg"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cpp-linux-${{ matrix.link }}
+          path: libsdf-*.tar.gz
+
+  build-cpp-windows:
+    name: Build C++ library (Windows, ${{ matrix.link }})
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        link: [static, shared]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure CMake
+        shell: pwsh
+        run: |
+          $shared = if ("${{ matrix.link }}" -eq "shared") { "ON" } else { "OFF" }
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=$shared
+
+      - name: Build libsdf
+        run: cmake --build build --target libsdf --config Release -j
+
+      - name: Package library + headers
+        shell: pwsh
+        run: |
+          $version = "${env:GITHUB_REF_NAME}" -replace '^v', ''
+          $pkg = "libsdf-$version-windows-x86_64-${{ matrix.link }}"
+          New-Item -ItemType Directory -Force -Path "$pkg/lib" | Out-Null
+          New-Item -ItemType Directory -Force -Path "$pkg/include" | Out-Null
+          Copy-Item "build/dist/lib/libsdf.*" "$pkg/lib/"
+          Copy-Item -Recurse "core/include/*" "$pkg/include/"
+          Compress-Archive -Path $pkg -DestinationPath "$pkg.zip"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cpp-windows-${{ matrix.link }}
+          path: libsdf-*.zip
+
+  publish:
+    name: Publish to PyPI
+    needs: [build-linux, build-windows]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist
+          merge-multiple: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+
+  publish-release:
+    name: Publish GitHub Release
+    needs: [build-cpp-linux, build-cpp-windows, build-linux, build-windows]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: cpp-*
+          path: release-assets
+          merge-multiple: true
+
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: release-assets
+          merge-multiple: true
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: release-assets/*
+          generate_release_notes: true

{sqlce-0.1.0 → sqlce-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sqlce
-Version: 0.1.0
+Version: 0.1.2
 Summary: Cross-platform lib for reading SQL Server CE (.sdf)
 Author-Email: boykopovar <boykopovar@gmail.com>
 License: MIT
@@ -19,6 +19,12 @@ Classifier: Operating System :: POSIX :: Linux
 Project-URL: Homepage, https://github.com/boykopovar/sqlce
 Project-URL: Issues, https://github.com/boykopovar/sqlce/issues
 Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: scikit-build-core>=0.10; extra == "dev"
+Requires-Dist: pybind11>=2.12; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
 Description-Content-Type: text/markdown
 
 # sqlce
@@ -27,21 +33,34 @@ Description-Content-Type: text/markdown
  
 Анализ внутреннего устройства формата по декомпилированным компонентам SQL CE. Цель - предоставить кроссплатформенную и независимую от рантайма реализацию чтения `.sdf` и документацию формата.
 
-## Структура
 
 - `core/` - реализация парсера на C++
 - `bindings/` - Биндинги для C++ библиотеки к другим языкам
 - `python/sqlce/` - Python API
 - `research/` - Экспериментальные скрипты
 
-## Установка
 
 ```bash
 pip install sqlce
 ```
 
-[Документирование формата](docs/4.0/ru/00-overview.md)
+```python
+from sqlce import SdfDatabase
 
-Текущая [реализация](main.py) поддерживает чтение списка таблиц, структуры таблиц, содержимого записей. Использует c++.
+db = SdfDatabase("example.sdf", password="secret123")
 
-[Соглашения по написанию кода](docs/CONVENTIONS.md)
+for table_name in db.list_tables():
+    print(table_name, db.table_schema(table_name))
+    for row in db.read_table(table_name):
+        print(row)
+```
+
+Текущая [реализация](main.py) поддерживает чтение (поддерживается передача пароля) списка таблиц, структуры таблиц, содержимого записей. Использует c++.
+
+[Документация](docs/ru/python.md)
+
+[Documentation](docs/en/python.md)
+
+[Соглашения по написанию кода](docs/CONVENTIONS.md) (PR приветствуются)
+
+> Исключительно для интероперабельности с существующими файлами `.sdf` формата. Не содержит оригинальный код продукта.

{sqlce-0.1.0 → sqlce-0.1.2}/README.md

@@ -4,21 +4,34 @@
  
 Анализ внутреннего устройства формата по декомпилированным компонентам SQL CE. Цель - предоставить кроссплатформенную и независимую от рантайма реализацию чтения `.sdf` и документацию формата.
 
-## Структура
 
 - `core/` - реализация парсера на C++
 - `bindings/` - Биндинги для C++ библиотеки к другим языкам
 - `python/sqlce/` - Python API
 - `research/` - Экспериментальные скрипты
 
-## Установка
 
 ```bash
 pip install sqlce
 ```
 
-[Документирование формата](docs/4.0/ru/00-overview.md)
+```python
+from sqlce import SdfDatabase
 
-Текущая [реализация](main.py) поддерживает чтение списка таблиц, структуры таблиц, содержимого записей. Использует c++.
+db = SdfDatabase("example.sdf", password="secret123")
 
-[Соглашения по написанию кода](docs/CONVENTIONS.md)
+for table_name in db.list_tables():
+    print(table_name, db.table_schema(table_name))
+    for row in db.read_table(table_name):
+        print(row)
+```
+
+Текущая [реализация](main.py) поддерживает чтение (поддерживается передача пароля) списка таблиц, структуры таблиц, содержимого записей. Использует c++.
+
+[Документация](docs/ru/python.md)
+
+[Documentation](docs/en/python.md)
+
+[Соглашения по написанию кода](docs/CONVENTIONS.md) (PR приветствуются)
+
+> Исключительно для интероперабельности с существующими файлами `.sdf` формата. Не содержит оригинальный код продукта.

{sqlce-0.1.0 → sqlce-0.1.2}/bindings/src/module.cpp

@@ -9,6 +9,7 @@
 
 #include "sdf/application/ColumnSchema.hpp"
 #include "sdf/application/SdfDatabase.hpp"
+#include "sdf/domain/EncryptionMode.hpp"
 #include "sdf/domain/Row.hpp"
 
 #include "value_convert.hpp"
@@ -26,7 +27,9 @@ constexpr char ModuleDoc[] = "Native reader for SQL Server Compact (.sdf) databa
 constexpr char DatabaseClassName[] = "SdfDatabase";
 constexpr char DatabaseDoc[] = "Reads tables, schemas and rows from a .sdf database file.";
 constexpr char InitDoc[] = "Open a .sdf file at the given path.";
+constexpr char InitWithPasswordDoc[] = "Open a password-protected .sdf file, auto-detecting its encryption mode.";
 constexpr char PathArgName[] = "path";
+constexpr char PasswordArgName[] = "password";
 constexpr char ListTablesName[] = "list_tables";
 constexpr char ListTablesDoc[] = "Return the names of all tables in the database.";
 constexpr char TableSchemaName[] = "table_schema";
@@ -44,6 +47,9 @@ constexpr char DeclaredSizeAttrName[] = "declared_size";
 constexpr char PrecisionAttrName[] = "precision";
 constexpr char ScaleAttrName[] = "scale";
 
+constexpr char UnsupportedEncryptionModeErrorName[] = "UnsupportedEncryptionModeError";
+constexpr char InvalidPasswordErrorName[] = "InvalidPasswordError";
+
 py::dict RowToDict(const domain::Row& row)
 {
     py::dict result;
@@ -75,12 +81,40 @@ std::optional<int> OptionalByteToInt(std::optional<std::uint8_t> value)
     return static_cast<int>(*value);
 }
 
+void RegisterExceptions(py::module_& module)
+{
+    static const py::exception<domain::UnsupportedEncryptionModeException> unsupportedModeError(
+        module, UnsupportedEncryptionModeErrorName, PyExc_ValueError);
+    static const py::exception<domain::InvalidPasswordException> invalidPasswordError(
+        module, InvalidPasswordErrorName, PyExc_ValueError);
+
+    py::register_exception_translator([](std::exception_ptr lastException) {
+        try
+        {
+            if (lastException)
+            {
+                std::rethrow_exception(lastException);
+            }
+        }
+        catch (const domain::UnsupportedEncryptionModeException& error)
+        {
+            PyErr_SetString(unsupportedModeError.ptr(), error.what());
+        }
+        catch (const domain::InvalidPasswordException& error)
+        {
+            PyErr_SetString(invalidPasswordError.ptr(), error.what());
+        }
+    });
+}
+
 }
 
 PYBIND11_MODULE(_sdf_native, module)
 {
     module.doc() = ModuleDoc;
 
+    RegisterExceptions(module);
+
     py::class_<application::ColumnSchema>(module, SchemaClassName, SchemaDoc)
         .def_property_readonly(
             OrdinalAttrName,
@@ -103,6 +137,11 @@ PYBIND11_MODULE(_sdf_native, module)
 
     py::class_<application::SdfDatabase>(module, DatabaseClassName, DatabaseDoc)
         .def(py::init<const std::string&>(), py::arg(PathArgName), InitDoc)
+        .def(
+            py::init<const std::string&, const std::string&>(),
+            py::arg(PathArgName),
+            py::arg(PasswordArgName),
+            InitWithPasswordDoc)
         .def(ListTablesName, &application::SdfDatabase::ListTables, ListTablesDoc)
         .def(
             TableSchemaName,

{sqlce-0.1.0 → sqlce-0.1.2}/core/CMakeLists.txt

@@ -18,21 +18,32 @@ add_library(libsdf
         src/domain/NumericValue.cpp
         src/domain/Row.cpp
         src/domain/TableDef.cpp
+        src/infrastructure/AesCbc.cpp
         src/infrastructure/BinaryReader.cpp
         src/infrastructure/FileStorage.cpp
         src/infrastructure/PageView.cpp
+        src/infrastructure/Sha256.cpp
+        src/infrastructure/Sha512.cpp
         src/parsing/CatalogPageScanner.cpp
         src/parsing/CatalogRow.cpp
         src/parsing/CatalogRowDecoder.cpp
         src/parsing/CatalogSchema.cpp
         src/parsing/LobChainRegistry.cpp
         src/parsing/RowDecoder.cpp
+        src/parsing/SdfPageCipher.cpp
         src/parsing/TableCatalogBuilder.cpp
         src/parsing/TextDecoder.cpp
         src/application/SdfDatabase.cpp
 )
 
-set_target_properties(libsdf PROPERTIES PREFIX "" OUTPUT_NAME "libsdf" POSITION_INDEPENDENT_CODE ON)
+set_target_properties(libsdf PROPERTIES
+        PREFIX ""
+        OUTPUT_NAME "libsdf"
+        POSITION_INDEPENDENT_CODE ON
+        ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/dist/lib"
+        LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/dist/lib"
+        RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/dist/lib"
+)
 
 target_include_directories(libsdf PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
 
@@ -45,7 +56,7 @@ else()
     target_compile_options(libsdf PRIVATE -Wall -Wextra)
 endif()
 
-add_executable(sdf_dump app/main.cpp)
+add_executable(sdf_dump main.cpp)
 target_link_libraries(sdf_dump PRIVATE libsdf)
 
 if(MSVC)
@@ -53,6 +64,14 @@ if(MSVC)
     target_compile_definitions(sdf_dump PRIVATE NOMINMAX _CRT_SECURE_NO_WARNINGS)
 else()
     target_compile_options(sdf_dump PRIVATE -Wall -Wextra)
+    if(MINGW)
+        target_link_options(sdf_dump PRIVATE
+                -static
+                -static-libgcc
+                -static-libstdc++
+                -Wl,-Bstatic,--whole-archive -lwinpthread -Wl,--no-whole-archive
+        )
+    endif()
 endif()
 
 enable_testing()

{sqlce-0.1.0 → sqlce-0.1.2}/core/include/sdf/application/SdfDatabase.hpp

@@ -7,6 +7,7 @@
 #include <vector>
 
 #include "sdf/application/ColumnSchema.hpp"
+#include "sdf/domain/IPageCipher.hpp"
 #include "sdf/domain/IPageStorage.hpp"
 #include "sdf/domain/Row.hpp"
 #include "sdf/domain/TableDef.hpp"
@@ -22,6 +23,7 @@ class SdfDatabase
 {
 public:
     explicit SdfDatabase(const std::string& path);
+    SdfDatabase(const std::string& path, const std::string& password);
 
     std::vector<std::string> ListTables() const;
     std::vector<ColumnSchema> TableSchema(const std::string& tableName) const;
@@ -36,6 +38,10 @@ private:
 
     std::map<std::string, domain::TableDef> _tables;
 
+    explicit SdfDatabase(std::unique_ptr<domain::IPageStorage> storage);
+
+    static std::unique_ptr<domain::IPageStorage> OpenStorage(const std::string& path, const std::string& password);
+
     void AssignDataPages();
     const domain::TableDef& RequireTable(const std::string& tableName) const;
 };

sqlce-0.1.2/core/include/sdf/domain/EncryptionMode.hpp

@@ -0,0 +1,48 @@
+#ifndef SDF_DOMAIN_ENCRYPTION_MODE_HPP
+#define SDF_DOMAIN_ENCRYPTION_MODE_HPP
+
+#include <cstdint>
+#include <stdexcept>
+#include <string>
+
+namespace sdf::domain
+{
+
+enum class EncryptionMode : std::uint32_t
+{
+    None = 0,
+    Rc4Sha1 = 1,
+    Aes128Sha1 = 2,
+    Aes128Sha256 = 3,
+    Aes256Sha512 = 4
+};
+
+class UnsupportedEncryptionModeException final : public std::runtime_error
+{
+public:
+    explicit UnsupportedEncryptionModeException(EncryptionMode mode)
+        : std::runtime_error("unsupported .sdf encryption mode: " + std::to_string(static_cast<std::uint32_t>(mode)))
+        , _mode(mode)
+    {
+    }
+
+    EncryptionMode Mode() const
+    {
+        return _mode;
+    }
+
+private:
+    EncryptionMode _mode;
+};
+
+class InvalidPasswordException final : public std::runtime_error
+{
+public:
+    InvalidPasswordException() : std::runtime_error("password verification failed")
+    {
+    }
+};
+
+}
+
+#endif

sqlce-0.1.2/core/include/sdf/domain/IPageCipher.hpp

@@ -0,0 +1,23 @@
+#ifndef SDF_DOMAIN_I_PAGE_CIPHER_HPP
+#define SDF_DOMAIN_I_PAGE_CIPHER_HPP
+
+#include <cstddef>
+#include <cstdint>
+#include <span>
+#include <vector>
+
+namespace sdf::domain
+{
+
+class IPageCipher
+{
+public:
+    virtual ~IPageCipher() = default;
+
+    virtual bool VerifyPassword() const = 0;
+    virtual std::vector<std::uint8_t> DecryptPage(std::size_t pageNumber, std::span<const std::uint8_t> page) const = 0;
+};
+
+}
+
+#endif

{sqlce-0.1.0 → sqlce-0.1.2}/core/include/sdf/domain/PageLayout.hpp

@@ -14,6 +14,14 @@ constexpr std::size_t LobPageHeaderLength = 16;
 constexpr std::size_t SlotArrayBaseIndex = 1017;
 constexpr std::size_t RowHeaderLength = 28;
 
+constexpr std::size_t PlaintextHeaderLength = 16;
+constexpr std::size_t Page0ModeOffset = 184;
+constexpr std::size_t Page0VerifierOffset = 76;
+constexpr std::size_t Page0VerifierLength = 96;
+constexpr std::size_t Page0KeyParamOffset = 188;
+constexpr std::size_t Page0KeyParamLength = 4;
+constexpr std::size_t MaxPasswordLength = 40;
+
 }
 
 #endif

sqlce-0.1.2/core/include/sdf/infrastructure/AesCbc.hpp

@@ -0,0 +1,30 @@
+#ifndef SDF_INFRASTRUCTURE_AES_CBC_HPP
+#define SDF_INFRASTRUCTURE_AES_CBC_HPP
+
+#include <array>
+#include <cstddef>
+#include <cstdint>
+#include <span>
+#include <vector>
+
+namespace sdf::infrastructure
+{
+
+class AesCbcDecryptor
+{
+public:
+    explicit AesCbcDecryptor(std::span<const std::uint8_t> key, std::span<const std::uint8_t, 16> iv);
+
+    std::vector<std::uint8_t> Decrypt(std::span<const std::uint8_t> ciphertext) const;
+
+private:
+    std::vector<std::uint32_t> _roundKeys;
+    std::size_t _roundCount;
+    std::array<std::uint8_t, 16> _iv;
+
+    void DecryptBlock(const std::uint8_t* in, std::uint8_t* out) const;
+};
+
+}
+
+#endif

{sqlce-0.1.0 → sqlce-0.1.2}/core/include/sdf/infrastructure/FileStorage.hpp

@@ -2,18 +2,23 @@
 #define SDF_INFRASTRUCTURE_FILE_STORAGE_HPP
 
 #include <cstdint>
+#include <optional>
 #include <string>
 #include <vector>
 
+#include "sdf/domain/IPageCipher.hpp"
 #include "sdf/domain/IPageStorage.hpp"
 
 namespace sdf::infrastructure
 {
 
+std::vector<std::uint8_t> ReadFirstPageRaw(const std::string& path);
+
 class FileStorage final : public domain::IPageStorage
 {
 public:
     explicit FileStorage(const std::string& path);
+    FileStorage(const std::string& path, const domain::IPageCipher& cipher);
 
     std::size_t PageCount() const override;
     std::span<const std::uint8_t> PageBytes(std::size_t pageNumber) const override;
@@ -21,6 +26,8 @@ public:
 private:
     std::vector<std::uint8_t> _fileBytes;
     std::size_t _pageCount;
+
+    void Load(const std::string& path);
 };
 
 }

sqlce-0.1.2/core/include/sdf/infrastructure/Sha256.hpp

@@ -0,0 +1,16 @@
+#ifndef SDF_INFRASTRUCTURE_SHA256_HPP
+#define SDF_INFRASTRUCTURE_SHA256_HPP
+
+#include <array>
+#include <cstddef>
+#include <cstdint>
+#include <span>
+
+namespace sdf::infrastructure
+{
+
+std::array<std::uint8_t, 32> Sha256(std::span<const std::uint8_t> message);
+
+}
+
+#endif

sqlce-0.1.2/core/include/sdf/infrastructure/Sha512.hpp

@@ -0,0 +1,16 @@
+#ifndef SDF_INFRASTRUCTURE_SHA512_HPP
+#define SDF_INFRASTRUCTURE_SHA512_HPP
+
+#include <array>
+#include <cstddef>
+#include <cstdint>
+#include <span>
+
+namespace sdf::infrastructure
+{
+
+std::array<std::uint8_t, 64> Sha512(std::span<const std::uint8_t> message);
+
+}
+
+#endif

sqlce-0.1.2/core/include/sdf/parsing/SdfPageCipher.hpp

@@ -0,0 +1,41 @@
+#ifndef SDF_PARSING_SDF_PAGE_CIPHER_HPP
+#define SDF_PARSING_SDF_PAGE_CIPHER_HPP
+
+#include <array>
+#include <cstddef>
+#include <cstdint>
+#include <span>
+#include <string>
+#include <vector>
+
+#include "sdf/domain/EncryptionMode.hpp"
+#include "sdf/domain/IPageCipher.hpp"
+
+namespace sdf::parsing
+{
+
+class SdfPageCipher final : public domain::IPageCipher
+{
+public:
+    SdfPageCipher(std::span<const std::uint8_t> page0, std::string password);
+
+    static domain::EncryptionMode ReadMode(std::span<const std::uint8_t> page0);
+
+    bool VerifyPassword() const override;
+    std::vector<std::uint8_t> DecryptPage(std::size_t pageNumber, std::span<const std::uint8_t> page) const override;
+
+private:
+    domain::EncryptionMode _mode;
+    std::string _password;
+    std::vector<std::uint8_t> _passwordUtf16Le;
+    std::vector<std::uint8_t> _page0Ciphertext;
+    std::array<std::uint8_t, 4> _page0KeyParam;
+
+    std::vector<std::uint8_t> DecryptPage0(std::span<const std::uint8_t> page0) const;
+    std::vector<std::uint8_t> DeriveKey(std::span<const std::uint8_t> keyParam) const;
+    std::vector<std::uint8_t> HashPasswordWith(std::span<const std::uint8_t> keyParam) const;
+};
+
+}
+
+#endif