Conan 👨🏼

* Dynamic Library distribution system compiles for each target os + architecture

Author: jeffmur

.github/workflows/publish.yml

@@ -39,41 +39,75 @@ jobs:
     strategy:
       matrix:
         dist:
-          - os: linux
-            arch: x64
-            runner: ubuntu-latest
-          - os: android
-            arch: x86_64
-            runner: ubuntu-latest
-          - os: android
-            arch: armeabi-v7a
-            runner: ubuntu-latest
-          - os: android
-            arch: arm64-v8a
-            runner: ubuntu-latest
-          - os: macos
-            arch: arm64
-            runner: macos-latest
+        - profile: linux-x64
+          runner: ubuntu-latest
+          release: linux-x64
+        - profile: macos-arm64
+          runner: macos-latest
+          release: macos-arm64
+        - profile: android-x86_64
+          runner: ubuntu-latest
+          release: android-x86_64
+        - profile: android-armv8
+          runner: ubuntu-latest
+          release: android-arm64-v8a
+      fail-fast: false
 
     runs-on: ${{ matrix.dist.runner }}
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: "true"
-      - id: dist
-        env:
-          OS: ${{ matrix.dist.os }}
-          ARCH: ${{ matrix.dist.arch }}
-        run: make dist-ci
-      - uses: actions/upload-artifact@v4
-        name: Upload Artifact
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - uses: nttld/setup-ndk@v1
+        if: startsWith(matrix.dist.profile, 'android')
+        id: setup-ndk
         with:
-          path: ${{ steps.dist.outputs.tar_gz_path }}
-          name: ${{ steps.dist.outputs.tar_gz_name }}
+          ndk-version: r26d
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry config virtualenvs.in-project true
+          poetry install -v
+          source .venv/bin/activate
+          conan profile detect
+
+      - name: Compile
+        env:
+          ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}
+        id: compile
+        run: |
+          source .venv/bin/activate
+          if ${{ startsWith(matrix.dist.profile, 'android') }};
+          then
+            conan create . \
+              --profile:host profiles/${{ matrix.dist.profile }} \
+              --conf:host tools.android:ndk_path=$ANDROID_NDK_HOME \
+              --options:host '&:ci=True'
+          else
+            conan create . \
+              --options:host ci=True
+          fi
+
+      - name: Package
+        id: package
+        env:
+          OUTPUT_TAR_NAME: libfhel-${{ matrix.dist.release }}.tar.gz
+        run: |
+          cd ${{ steps.compile.outputs.conan_package_path }}
+          tar -czf $OUTPUT_TAR_NAME *
+          echo "tar_gz_path=$(pwd)/$OUTPUT_TAR_NAME" >> $GITHUB_OUTPUT
+
       - uses: softprops/action-gh-release@v2
         name: GitHub Release
         with:
-          files: ${{ steps.dist.outputs.tar_gz_path }}
+          files: ${{ steps.package.outputs.tar_gz_path }}
           draft: true
           prerelease: false
 

.gitignore

@@ -15,6 +15,19 @@ Testing/
 # Dart
 pubspec.lock
 
+# Python
+.venv
+pyvenv.cfg
+poetry.lock
+
+# Conan
+CMakeFiles/
+CMakeCache.txt
+CMakePresets.json
+cmake_install.cmake
+*conan*
+!conanfile.py
+
 # IntelliJ related
 *.iml
 *.ipr

CMakeLists.txt

@@ -12,10 +12,10 @@ cmake_minimum_required(VERSION 3.10)
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-project(fhel VERSION 0.0.8 LANGUAGES CXX)
+project(fhel VERSION 0.0.12 LANGUAGES CXX)
 
 # Import Backend Library
-add_subdirectory(src/backend/seal)
+add_subdirectory(src/backend/seal seal_build)
 
 # find_package(SEAL REQUIRED)
 

Makefile

@@ -36,24 +36,6 @@ build-cmake:
 .PHONY: build
 build: trust-project build-cmake
 
-# Release helper
-.PHONY: dist-cmake
-dist-cmake: export UNIT_TEST ?= OFF
-dist-cmake: export TARGET_DIR ?= $(FHE_RELEASE_DIR)
-dist-cmake:
-	@make build-cmake
-
-.PHONY: dist
-dist: dist-cmake
-
-.PHONY: dist-ci
-dist-ci: OUTPUT_FILE ?= libfhel-$(OS)-$(ARCH).tar.gz
-dist-ci: OUTPUT_PATH ?= $(FHE_RELEASE_DIR)/$(OUTPUT_FILE)
-dist-ci: dist-cmake
-	@ls -d $(FHE_RELEASE_DIR)/libfhel* | grep -o '[^/]*$$' | tar -czvf $(OUTPUT_PATH) -C $(FHE_RELEASE_DIR) --files-from=-
-	@echo "tar_gz_name=$(OUTPUT_FILE)" >> $(GITHUB_OUTPUT)
-	@echo "tar_gz_path=$(OUTPUT_PATH)" >> $(GITHUB_OUTPUT)
-
 # Generate html dart api docs
 .PHONY: docs
 docs:

README.md

@@ -50,3 +50,15 @@ dart pub publish
 ```
 
 In the future, we may configure an [automated](https://dart.dev/tools/pub/automated-publishing) publishing.
+
+## Distribution 📦
+
+For distribution, we use [Conan](https://conan.io/) to manage C++ dependencies, wrapped with [Poetry](https://python-poetry.org/) to be run in a virtual environment.
+
+From the root of the project:
+```bash
+pip install poetry
+poetry config virtualenvs.create true
+poetry install
+conan create .
+```

conanfile.py

@@ -0,0 +1,106 @@
+from conan import ConanFile
+from conan.tools.files import load, copy
+from conan.errors import ConanInvalidConfiguration
+from conan.tools.cmake import CMake, CMakeToolchain, CMakeDeps
+import conan.tools.files as cfiles
+from pathlib import Path
+import tarfile, os
+
+# for compatibility
+release_arch = {
+  # "windows": {
+  #   "x86_64": "x64",
+  # },
+  "linux": {
+    "x86_64": "x64",
+  },
+  "android": {
+    "x86_64": "x86_64",
+    "armv8": "arm64-v8a",
+    "armv7": "armeabi-v7a",
+  },
+  "macos": {
+    "x86_64": "x64",
+    "armv8": "arm64",
+  },
+  # "ios": {
+  #   "x86_64": "x64",
+  #   "armv8": "arm64",
+  # },
+}
+
+class fhel(ConanFile):
+  name = "fhel"
+  settings = "os", "arch", "compiler", "build_type"
+  exports_sources = "src/*", "include/*", "test/*", "CMakeLists.txt"
+  options = {
+    "ci": [True, False],
+  }
+
+  default_options = {
+    "ci": False,
+  }
+
+  def set_version(self):
+    if not self.recipe_folder:
+      raise ConanInvalidConfiguration("recipe_folder not set")
+
+    if not self.version:
+      version_file = Path(
+        os.path.join(self.recipe_folder, "dart" , "binary.version")
+      )
+      if not version_file.exists():
+        raise ConanInvalidConfiguration("binary.version file not found")
+
+      self.version = load(self, version_file).strip();
+
+  def generate(self):
+    "Generate the cmake toolchain file"
+    tc = CMakeToolchain(self)
+    tc.generate()
+
+  def seal_negative_args(self) -> list[str]:
+    """
+    Append negative options to the cmake command,
+      e.g. -DSEAL_USE_MSGZL=OFF (default is ON)
+    """
+    args = []
+    if self.settings.os == "Android":
+      if self.settings.arch != "armv7":
+        args.append("-DSEAL_BUILD_SEAL_C=1") # 64-bit only
+      args.append("-DSEAL_USE_INTRIN=1")
+      args.append("-DSEAL_ARM64_EXITCODE=0")
+      args.append("-DSEAL_ARM64_EXITCODE__TRYRUN_OUTPUT=''")
+      args.append("-DSEAL___BUILTIN_CLZLL_FOUND_EXITCODE=0")
+      args.append("-DSEAL___BUILTIN_CLZLL_FOUND_EXITCODE__TRYRUN_OUTPUT=''")
+      args.append("-DSEAL__ADDCARRY_U64_FOUND_EXITCODE=0")
+      args.append("-DSEAL__ADDCARRY_U64_FOUND_EXITCODE__TRYRUN_OUTPUT=''")
+      args.append("-DSEAL__SUBBORROW_U64_FOUND_EXITCODE=0")
+      args.append("-DSEAL__SUBBORROW_U64_FOUND_EXITCODE__TRYRUN_OUTPUT=''")
+    return args
+
+  def build(self):
+    "Compile libfhel dynamic library"
+    cmake = CMake(self)
+    cmake.configure(cli_args=self.seal_negative_args())
+    cmake.build()
+
+  def copy_files(self):
+    "Copy the library to the package folder"
+    if not self.source_folder:
+      raise ConanInvalidConfiguration("source_folder not set")
+    if not self.package_folder:
+      raise ConanInvalidConfiguration("package_folder not set")
+
+    copy(self,
+      pattern=f"libfhel*",
+      src=self.source_folder,
+      dst=self.package_folder,
+    )
+
+  def package(self):
+    "Package the compiled library"
+    self.copy_files()
+    if self.options.ci:
+      with open(os.environ['GITHUB_OUTPUT'], "a+") as f:
+        print(f'conan_package_path={self.package_folder}', file=f)

dart/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.0.12
+
+- Added Ciphertext.fromBytes(Uint8List) Constructor
+- Added Ciphertext.toBytes() returns Uint8List
+- Added afhe.decodeDouble returns first element of decoded vector
+
+## 0.0.11
+
+Conan Release Management
+
 ## 0.0.8
 
 Auto-build Android binary in github releases

dart/binary.version

@@ -1 +1 @@
-0.0.8
+0.0.12

dart/lib/afhe.dart

@@ -6,6 +6,7 @@
 library afhe;
 
 import 'dart:ffi';
+import 'dart:typed_data'; // For Uint8List
 import 'package:ffi/ffi.dart'; // for Utf8
 import 'dart:io' show Directory, Platform;
 import 'package:path/path.dart' as path;
@@ -237,6 +238,13 @@ class Afhe {
     return Plaintext.fromPointer(backend, ptr, extractStr: false);
   }
 
+  /// Decodes a [Plaintext] into a double.
+  double decodeDouble(Plaintext plaintext) {
+    Pointer<Double> ptr = _c_decode_vector_double(library, plaintext.obj);
+    raiseForStatus();
+    return ptr[0];
+  }
+
   /// Decodes a [Plaintext] into a list of doubles.
   List<double> decodeVecDouble(Plaintext plaintext, int arrayLength) {
     Pointer<Double> ptr = _c_decode_vector_double(library, plaintext.obj);

dart/lib/afhe/ciphertext.dart

@@ -37,7 +37,6 @@ final _LoadCiphertext _c_load_ciphertext = dylib
     .lookup<NativeFunction<_LoadCiphertextC>>('load_ciphertext')
     .asFunction();
 
-
 /// Represents an underlying C ciphertext object.
 ///
 /// A ciphertext is an encrypted message. It is the output of the encryption function,
@@ -48,6 +47,7 @@ class Ciphertext {
   // String text = "";
   /// Selects the [Backend] used for the encryption scheme.
   Backend backend = Backend();
+
   /// A pointer to the memory address of the underlying C++ object.
   Pointer obj = nullptr;
 
@@ -68,6 +68,18 @@ class Ciphertext {
   /// Saves the [Ciphertext] to a non-human-readable format.
   /// Useful for saving to disk or sending over the network.
   Pointer<Uint8> save() => _c_save_ciphertext(obj);
+
+  /// Converts a [Ciphertext] into a serialized binary format.
+  Uint8List toBytes() => save().asTypedList(saveSize);
+
+  /// Loads a [Ciphertext] from a serialized binary format.
+  Ciphertext.fromBytes(Afhe fhe, Uint8List bytes) {
+    final Pointer<Uint8> pointer = malloc.allocate<Uint8>(bytes.length);
+    // Copy the bytes to the allocated memory
+    final Uint8List pointerContent = pointer.asTypedList(bytes.length);
+    pointerContent.setAll(0, bytes);
+    obj = _c_load_ciphertext(fhe.library, pointer, bytes.length);
+  }
 }
 
 // --- noise budget ---

dart/pubspec.yaml

@@ -2,7 +2,7 @@ name: fhel
 description: |-
   Natively supports Fully Homomorphic Encryption operations on sensitive data without revealing it.
   Supports Key Derivation, Encryption, Decryption, and Mathematical operations.
-version: 0.0.8
+version: 0.0.12
 repository: https://github.com/jeffmur/fhel
 
 environment: