make sboxU an installable python package via pip and nix

Author: Jens Alich

.gitignore

@@ -1,13 +1,14 @@
+# ignore build output
+build/
 # ignore compiled files
 *.pyc
 *.so
-sboxU/sboxU_cython/cpp_ccz.cpp
-sboxU/sboxU_cython/cpp_diff_lin.cpp
-sboxU/sboxU_cython/cpp_equiv.cpp
-sboxU/sboxU_cython/cpp_fp.cpp
-sboxU/sboxU_cython/cpp_utils.cpp
-sboxU/sboxU_cython/cpp_diff_lin_no_fp_lat.cpp
-sboxU/sboxU_cython/build/
+/sboxU/sboxU_cython/cpp_ccz.cpp
+/sboxU/sboxU_cython/cpp_diff_lin.cpp
+/sboxU/sboxU_cython/cpp_equiv.cpp
+/sboxU/sboxU_cython/cpp_fp.cpp
+/sboxU/sboxU_cython/cpp_utils.cpp
+/sboxU/sboxU_cython/cpp_diff_lin_no_fp_lat.cpp
+/sboxU/sboxU_cython/cpp_equiv_approx.cpp
 # ignore automatically generated files
 *~
-

default.nix

@@ -0,0 +1,33 @@
+{
+  packageName,
+  packageVersion,
+
+  buildPythonPackage,
+
+  # build-system
+  gcc,
+  setuptools_scm,
+  cython,
+}:
+
+let
+in buildPythonPackage rec {
+  pname = packageName;
+  version = packageVersion;
+  pyproject = true;
+  build-system = [ setuptools_scm ];
+  src = ./.;
+
+  propagatedBuildInputs = [
+    gcc
+    cython
+  ];
+
+  # pythonImportsCheck = [ packageName ];  # we currently build using python and not sage, thus import checking is not possible
+
+  meta = {
+    description = "SAGE/Python functions useful for studying S-boxes and Boolean functions such as computing the DDT, computing the Walsh spectrum, affine equivalence testing...";
+    homepage = "https://github.com/lpp-crypto/sboxU";
+  };
+}
+

flake.lock

@@ -0,0 +1,54 @@
+{
+  description = "SAGE/Python functions useful for studying S-boxes and Boolean functions such as computing the DDT, computing the Walsh spectrum, affine equivalence testing...";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-24.05";
+  };
+
+  outputs = { self, nixpkgs }: let
+    system = "x86_64-linux";
+    pkgs = import nixpkgs { inherit system; };
+    packageName = "sboxU";
+    packageVersion = "1.0.0";
+  in {
+
+    packages."${system}" = {
+      "${packageName}" = pkgs.python3Packages.callPackage ./default.nix {
+        inherit packageName packageVersion;
+      };
+
+      default = self.packages."${system}"."${packageName}";
+
+      overlay = (final: prev: {
+        pythonPackagesExtensions = prev.pythonPackagesExtensions ++ [
+          (final: prev: {
+            "${packageName}" = self.packages."${system}".default;
+          })
+        ];
+      });
+    };
+
+    devShell."${system}" = let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [ self.packages."${system}".overlay ];
+        };
+
+	customSage = pkgs.sage.override {
+          requireSageTests = false;
+          extraPythonPackages = ps: with ps; [
+            ps."${packageName}"
+	  ];
+        };
+        customPython = with pkgs; (pkgs.sage.withPackages (ps: [
+          ps."${packageName}"
+        ]));
+
+        packages = [ customSage ];
+    in pkgs.mkShell {
+      inherit packages;
+    };
+
+  };
+}
+

flake.nix

@@ -0,0 +1,3 @@
+[build-system]
+requires = [ "setuptools", "wheel", "cython" ]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -2,7 +2,7 @@
 # Time-stamp: <2023-12-05 10:36:16 leo>
 
 import os
-from sboxu_cpp_no_fp_lat cimport *
+from sboxU.sboxU_cython.sboxu_cpp_no_fp_lat cimport *
 from math import log
 
 

sboxU/sboxU_cython/cpp_ccz.pyx

@@ -5,7 +5,7 @@ import os
 from libcpp cimport bool
 from libcpp.vector cimport vector
 from libc.stdint cimport int64_t, uint64_t
-from sboxu_cpp cimport *
+from sboxU.sboxU_cython.sboxu_cpp cimport *
 import os
 from sage.all import Integer
 

sboxU/sboxU_cython/cpp_diff_lin.pyx

@@ -2,7 +2,7 @@
 # Time-stamp: <2023-01-04 15:57:08 lperrin>
 
 import os
-from sboxu_cpp_no_fp_lat cimport *
+from sboxU.sboxU_cython.sboxu_cpp_no_fp_lat cimport *
 
 def linear_equivalence_fast(l0, l1, all_mappings):
     return linear_equivalence_cpp(l0, l1, all_mappings)