Merge pull request #16 from katzenpost/fix_ctidh.1

Fix ctidh compatibility build tags
katzenpost · May 26, 2024 · 69a1b3e · 69a1b3e
2 parents 4cbbfa2 + f3f4c8a
commit 69a1b3e
Show file tree

Hide file tree

Showing 29 changed files with 411 additions and 241 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -4,7 +4,13 @@ permissions:
   contents: read
 jobs:
   test:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        arch: [amd64, arm64]
+        go-version: ["1.21.x", "1.22.0"]
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -16,8 +22,4 @@ jobs:
           go-version-file: go.mod
           check-latest: true
       - name: Run tests
-        run: go test ./...
-      - name: Run tests (short + race)
-        run: go test -short -race ./...
-      - name: KEM Benchmark tests
-        run: cd kem/schemes && go test -v -bench=. -run Benchmark
+        run: go test -v ./...
diff --git a/.github/workflows/macos-golang-test.yml b/.github/workflows/macos-golang-test.yml
@@ -0,0 +1,47 @@
+name: MacOS Golang build and test
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.OS }}
+    strategy:
+      matrix:
+        OS: ["macos-14"]
+        go-version: ["1.21.x", "1.22.0"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Display Go version
+        shell: bash
+        run: go version
+
+      - name: Install golang dependencies
+        shell: bash
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          go get -v ./...
+
+      - name: Build golang
+        shell: bash
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          go build -v ./...
+
+      - name: Golang test
+        shell: bash
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          go test -v ./...
+
+
diff --git a/.github/workflows/ubuntu-golang-cross-compile-test.yml b/.github/workflows/ubuntu-golang-cross-compile-test.yml
@@ -0,0 +1,35 @@
+name: Go cross compile
+
+on:
+  push:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        CC: ["clang"]
+        ARCH: ["amd64", "arm32v5", "arm32v6", "arm32v7", "i386", "arm64", "mips64", "mips64le", "mips", "mipsle", "ppc64", "ppc64le", "riscv64", "s390x"]
+        go-version: [ '1.19', '1.20', '1.21.x' ]
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Go ${{ matrix.go-version }}
+      uses: actions/setup-go@v5
+      with:
+        go-version: ${{ matrix.go-version }}
+    - name: Display Go version
+      run: go version
+
+    - name: Install Golang deps
+      run: sudo ./misc/install-debian-go-deps-by-arch.sh ${{ matrix.ARCH }}
+
+      - name: Install Go (from go.mod)
+        uses: actions/setup-go@v4
+        with:
+          go-version-file: go.mod
+          check-latest: true
+      - name: Run tests
+        run: go test -v ./...
diff --git a/.github/workflows/windows-msys-64bit-gcc-ucrt-msvcrt-golang-test.yml b/.github/workflows/windows-msys-64bit-gcc-ucrt-msvcrt-golang-test.yml
@@ -0,0 +1,72 @@
+name: Windows Msys2 64bit (cygwin,msvcrt,ucrt) gcc golang build and test
+
+on: [push]
+
+jobs:
+  windows-build-and-test-golang:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        OS: ["windows-2019", "windows-2022"]
+        CC: ["gcc"]
+        ENVIRONMENT: ["UCRT64", "MINGW64"] # https://www.msys2.org/docs/environments/
+        go-version: [ "1.21.x", "1.22.x"]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Msys2
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: ${{ matrix.ENVIRONMENT }}
+          install: >-
+            base-devel
+            mingw-w64-x86_64-toolchain
+            mingw-w64-x86_64-pkg-config
+            mingw-w64-x86_64-gcc
+            mingw-w64-ucrt-x86_64-gcc
+            mingw-w64-x86_64-go
+            mingw-w64-ucrt-x86_64-go
+            make
+            git
+            gcc
+
+      - name: Setup Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Gather runtime environment
+        shell: msys2 {0}
+        run: |
+         echo ${{ matrix.ENVIRONMENT }}
+         uname -a
+         bash --version
+         ${{ matrix.CC }} -v
+         go version
+
+      - name: Install golang dependencies
+        shell: bash
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          go get -v ./...
+
+      - name: Build golang
+        shell: msys2 {0}
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          export GOEXPERIMENT=cgocheck2
+          export GODEBUG=cgocheck=1
+          go build -v ./...
+
+      - name: Golang test
+        shell: msys2 {0}
+        run: |
+          export HIGHCTIDH_PORTABLE=1
+          export CGO_ENABLED=1
+          export GOEXPERIMENT=cgocheck2
+          export GODEBUG=cgocheck=1
+          export CGO_LDFLAGS="-Wl,--no-as-needed -Wl,-allow-multiple-definition"
+          go test -v ./...
diff --git a/kem/adapter/kem.go b/kem/adapter/kem.go
@@ -91,7 +91,10 @@ var _ kem.PrivateKey = (*PrivateKey)(nil)
 
 // FromNIKE creates a new KEM adapter Scheme
 // using the given NIKE Scheme.
-func FromNIKE(nike nike.Scheme) *Scheme {
+func FromNIKE(nike nike.Scheme) kem.Scheme {
+	if nike == nil {
+		return nil
+	}
 	return &Scheme{
 		nike: nike,
 	}
@@ -185,6 +188,9 @@ func (a *Scheme) Decapsulate(myPrivkey kem.PrivateKey, ct []byte) ([]byte, error
 
 // Unmarshals a PublicKey from the provided buffer.
 func (a *Scheme) UnmarshalBinaryPublicKey(b []byte) (kem.PublicKey, error) {
+	if len(b) != a.PublicKeySize() {
+		return nil, fmt.Errorf("UnmarshalBinaryPublicKey: wrong key size %d != %d", len(b), a.PublicKeySize())
+	}
 	pubkey, err := a.nike.UnmarshalBinaryPublicKey(b)
 	if err != nil {
 		return nil, err
@@ -197,6 +203,9 @@ func (a *Scheme) UnmarshalBinaryPublicKey(b []byte) (kem.PublicKey, error) {
 
 // Unmarshals a PrivateKey from the provided buffer.
 func (a *Scheme) UnmarshalBinaryPrivateKey(b []byte) (kem.PrivateKey, error) {
+	if len(b) != a.PrivateKeySize() {
+		return nil, fmt.Errorf("UnmarshalBinaryPrivateKey: wrong key size %d != %d", len(b), a.PrivateKeySize())
+	}
 	privkey, err := a.nike.UnmarshalBinaryPrivateKey(b)
 	if err != nil {
 		return nil, err

diff --git a/kem/schemes/schemes.go b/kem/schemes/schemes.go
@@ -35,7 +35,17 @@ import (
 	"github.com/katzenpost/hpqc/rand"
 )
 
-var allSchemes = [...]kem.Scheme{
+var potentialSchemes = [...]kem.Scheme{
+
+	// post quantum KEM schemes
+
+	adapter.FromNIKE(ctidh511.Scheme()),
+	adapter.FromNIKE(ctidh512.Scheme()),
+	adapter.FromNIKE(ctidh1024.Scheme()),
+	adapter.FromNIKE(ctidh2048.Scheme()),
+}
+
+var allSchemes = []kem.Scheme{
 
 	// classical KEM schemes (converted from NIKE via hashed elgamal construction)
 	adapter.FromNIKE(diffiehellman.Scheme()),
@@ -45,11 +55,15 @@ var allSchemes = [...]kem.Scheme{
 	// post quantum KEM schemes
 
 	mlkem768.Scheme(),
+
 	sntrup.Scheme(),
+
 	kyber512.Scheme(),
 	kyber768.Scheme(),
 	kyber1024.Scheme(),
+
 	frodo640shake.Scheme(),
+
 	mceliece348864.Scheme(),
 	mceliece348864f.Scheme(),
 	mceliece460896.Scheme(),
@@ -61,13 +75,6 @@ var allSchemes = [...]kem.Scheme{
 	mceliece8192128.Scheme(),
 	mceliece8192128f.Scheme(),
 
-	// post quantum KEM schemes
-	// (converted from NIKE via hashed ElGamal construction)
-	adapter.FromNIKE(ctidh511.Scheme()),
-	adapter.FromNIKE(ctidh512.Scheme()),
-	adapter.FromNIKE(ctidh1024.Scheme()),
-	adapter.FromNIKE(ctidh2048.Scheme()),
-
 	// hybrid KEM schemes
 
 	xwing.Scheme(),
@@ -80,6 +87,7 @@ var allSchemes = [...]kem.Scheme{
 		kyber768.Scheme(),
 	),
 
+	// An alternative to Xwing using a generic and secure KEM combiner.
 	combiner.New(
 		"MLKEM768-X25519",
 		[]kem.Scheme{
@@ -88,107 +96,26 @@ var allSchemes = [...]kem.Scheme{
 		},
 	),
 
+	/* doesn't work on arm64 for some reason
 	combiner.New(
 		"DH4096_RFC3526-MLKEM768",
 		[]kem.Scheme{
 			adapter.FromNIKE(diffiehellman.Scheme()),
 			mlkem768.Scheme(),
 		},
 	),
-
-	combiner.New(
-		"x25519-mceliece8192128f-ctidh512",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			mceliece8192128f.Scheme(),
-			adapter.FromNIKE(ctidh512.Scheme()),
-		},
-	),
-
-	combiner.New(
-		"x448-mceliece8192128f-mlkem768",
-		[]kem.Scheme{
-			adapter.FromNIKE(x448.Scheme(rand.Reader)),
-			mceliece8192128f.Scheme(),
-			mlkem768.Scheme(),
-		},
-	),
-
-	combiner.New(
-		"x448-mceliece8192128f-ctidh512",
-		[]kem.Scheme{
-			adapter.FromNIKE(x448.Scheme(rand.Reader)),
-			mceliece8192128f.Scheme(),
-			adapter.FromNIKE(ctidh512.Scheme()),
-		},
-	),
-
-	combiner.New(
-		"sntrup4591761-X25519",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			sntrup.Scheme(),
-		},
-	),
-
-	combiner.New(
-		"ctidh512-X25519",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			adapter.FromNIKE(ctidh512.Scheme()),
-		},
-	),
-
-	combiner.New(
-		"ctidh1024-X25519",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			adapter.FromNIKE(ctidh1024.Scheme()),
-		},
-	),
-
-	combiner.New(
-		"ctidh2048-X25519",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			adapter.FromNIKE(ctidh2048.Scheme()),
-		},
-	),
-
-	// hybrid KEM schemes with two post quantum KEMs
-
-	combiner.New(
-		"X25519-mlkem768-sntrup4591761",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			mlkem768.Scheme(),
-			sntrup.Scheme(),
-		},
-	),
-
-	combiner.New(
-		"X25519-mlkem768-ctidh512",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			mlkem768.Scheme(),
-			adapter.FromNIKE(ctidh512.Scheme()),
-		},
-	),
-
-	combiner.New(
-		"X25519-mlkem768-ctidh1024",
-		[]kem.Scheme{
-			adapter.FromNIKE(x25519.Scheme(rand.Reader)),
-			mlkem768.Scheme(),
-			adapter.FromNIKE(ctidh1024.Scheme()),
-		},
-	),
+	*/
 }
 
 var allSchemeNames map[string]kem.Scheme
 
 func init() {
 	allSchemeNames = make(map[string]kem.Scheme)
+	for _, scheme := range potentialSchemes {
+		if scheme != nil {
+			allSchemes = append(allSchemes, scheme)
+		}
+	}
 	for _, scheme := range allSchemes {
 		allSchemeNames[strings.ToLower(scheme.Name())] = scheme
 	}