2025-08-15 16:51:58 -05:00
|
|
|
# Lux Post-Quantum Cryptography Makefile
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2026-05-10 21:38:38 -07:00
|
|
|
.PHONY: all test bench clean fmt lint install-deps verify build gen_kats
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Go parameters
|
|
|
|
|
GOCMD=go
|
|
|
|
|
GOBUILD=$(GOCMD) build
|
|
|
|
|
GOTEST=$(GOCMD) test
|
|
|
|
|
GOGET=$(GOCMD) get
|
|
|
|
|
GOFMT=gofmt
|
|
|
|
|
GOMOD=$(GOCMD) mod
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Packages
|
|
|
|
|
PACKAGES=./mlkem/... ./mldsa/... ./slhdsa/... ./lamport/... ./precompile/...
|
|
|
|
|
ALL_PACKAGES=./...
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Build variables
|
|
|
|
|
CGO_ENABLED ?= 1
|
|
|
|
|
GOFLAGS ?=
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
all: fmt lint test
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Install dependencies
|
|
|
|
|
install-deps:
|
|
|
|
|
@echo "📦 Installing dependencies..."
|
|
|
|
|
$(GOMOD) download
|
|
|
|
|
$(GOMOD) tidy
|
|
|
|
|
@echo "✅ Dependencies installed"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
|
|
|
|
# Format code
|
|
|
|
|
fmt:
|
2025-08-15 16:51:58 -05:00
|
|
|
@echo "🎨 Formatting code..."
|
|
|
|
|
$(GOFMT) -s -w .
|
|
|
|
|
@echo "✅ Code formatted"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Lint code
|
|
|
|
|
lint:
|
|
|
|
|
@echo "🔍 Linting code..."
|
|
|
|
|
@if ! command -v golangci-lint &> /dev/null; then \
|
|
|
|
|
echo "Installing golangci-lint..."; \
|
2025-12-27 12:07:55 -08:00
|
|
|
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.6; \
|
2025-08-15 16:51:58 -05:00
|
|
|
fi
|
|
|
|
|
golangci-lint run --timeout=5m || true
|
|
|
|
|
@echo "✅ Linting complete"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-12-27 07:21:30 -08:00
|
|
|
# Run tests (exclude cgo/ when native C libs not installed, timeout per package)
|
2025-08-15 16:51:58 -05:00
|
|
|
test:
|
2025-12-27 08:13:35 -08:00
|
|
|
@echo "Running tests..."
|
|
|
|
|
@if pkg-config --exists lux-crypto lux-gpu 2>/dev/null; then \
|
2025-12-27 09:05:39 -08:00
|
|
|
CGO_ENABLED=$(CGO_ENABLED) $(GOTEST) -v -race -count=1 -timeout 600s $(ALL_PACKAGES); \
|
2025-12-27 08:13:35 -08:00
|
|
|
else \
|
2025-12-27 09:05:39 -08:00
|
|
|
CGO_ENABLED=$(CGO_ENABLED) $(GOTEST) -v -race -count=1 -timeout 600s $$($(GOCMD) list ./... | grep -v /cgo); \
|
2025-12-27 08:13:35 -08:00
|
|
|
fi
|
|
|
|
|
@echo "Tests complete"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Run tests with coverage
|
|
|
|
|
test-coverage:
|
|
|
|
|
@echo "📊 Running tests with coverage..."
|
|
|
|
|
CGO_ENABLED=$(CGO_ENABLED) $(GOTEST) -v -race -coverprofile=coverage.out -covermode=atomic $(ALL_PACKAGES)
|
|
|
|
|
@echo "Coverage report generated: coverage.out"
|
|
|
|
|
@go tool cover -func=coverage.out
|
|
|
|
|
@echo "✅ Coverage analysis complete"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
|
|
|
|
# Run benchmarks
|
|
|
|
|
bench:
|
2025-08-15 16:51:58 -05:00
|
|
|
@echo "⚡ Running benchmarks..."
|
|
|
|
|
CGO_ENABLED=1 $(GOTEST) -bench=. -benchmem -run=^$ $(ALL_PACKAGES)
|
|
|
|
|
@echo "✅ Benchmarks complete"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Build all packages
|
|
|
|
|
build:
|
|
|
|
|
@echo "🔨 Building packages..."
|
|
|
|
|
CGO_ENABLED=$(CGO_ENABLED) $(GOBUILD) -v $(ALL_PACKAGES)
|
|
|
|
|
@echo "✅ Build complete"
|
2025-07-25 20:12:57 -05:00
|
|
|
|
|
|
|
|
# Verify module
|
|
|
|
|
verify:
|
2025-08-15 16:51:58 -05:00
|
|
|
@echo "✔️ Verifying module..."
|
|
|
|
|
$(GOMOD) verify
|
|
|
|
|
@echo "✅ Module verified"
|
|
|
|
|
|
|
|
|
|
# Clean build artifacts
|
|
|
|
|
clean:
|
|
|
|
|
@echo "🧹 Cleaning..."
|
|
|
|
|
$(GOCMD) clean
|
|
|
|
|
rm -f coverage.out
|
|
|
|
|
@echo "✅ Clean complete"
|
|
|
|
|
|
2026-05-10 21:38:38 -07:00
|
|
|
# Regenerate KAT vector files for crypto/pq/mldsa.
|
|
|
|
|
#
|
|
|
|
|
# The generator is deterministic: a second run produces byte-identical
|
|
|
|
|
# output. The kats package itself has a TestRegen_Deterministic guard
|
|
|
|
|
# that asserts the checked-in vectors_mldsa{44,65,87}.go files match a
|
|
|
|
|
# fresh `go run`. After running this target, commit the regenerated
|
|
|
|
|
# files; the test suite then proves they round-trip.
|
|
|
|
|
gen_kats:
|
|
|
|
|
@echo "Regenerating ML-DSA KAT vectors..."
|
|
|
|
|
GOWORK=off $(GOCMD) run ./pq/mldsa/kats/internal/gen -out pq/mldsa/kats
|
|
|
|
|
@echo "Validating regenerated vectors..."
|
|
|
|
|
GOWORK=off $(GOTEST) -count=1 ./pq/mldsa/kats/...
|
|
|
|
|
@echo "✅ KAT vectors regenerated and validated"
|
|
|
|
|
|
2025-08-15 16:51:58 -05:00
|
|
|
# Install CI tools
|
|
|
|
|
install-tools:
|
|
|
|
|
@echo "🛠️ Installing CI tools..."
|
2025-12-27 12:07:55 -08:00
|
|
|
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.6
|
2025-08-15 16:51:58 -05:00
|
|
|
@echo "✅ Tools installed"
|
|
|
|
|
|
|
|
|
|
# Help
|
|
|
|
|
help:
|
|
|
|
|
@echo "Lux Post-Quantum Cryptography Makefile"
|
|
|
|
|
@echo "Usage: make [target]"
|