Add readme

Author: ryarnyah

.github/workflows/build.yml

@@ -12,6 +12,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: 'true'
       - name: Setup Go
         uses: actions/setup-go@v2
         with:

.github/workflows/go-release.yml

@@ -11,10 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: 'true'
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: '1.20'
+          go-version: '1.22'
       - name: Install protoc
         run: |
           sudo apt-get update && sudo apt-get install gcc-multilib nodejs npm curl unzip -y

Makefile

@@ -6,20 +6,19 @@ clean:
 
 .PHONY: pkcs11-proxy-server
 pkcs11-proxy-server: protoc
-	go build -o pkcs11-proxy-server ./cmd/server
+	go build -buildvcs=false -o pkcs11-proxy-server ./cmd/server
 
 .PHONY: pkcs11-proxy-server.exe
 pkcs11-proxy-server.exe: protoc
-	CGO_ENABLED=1 CC=/usr/bin/x86_64-w64-mingw32-gcc GOOS=windows go build -o pkcs11-proxy-server.exe ./cmd/server
+	CGO_ENABLED=1 CC=/usr/bin/x86_64-w64-mingw32-gcc GOOS=windows go build -buildvcs=false -o pkcs11-proxy-server.exe ./cmd/server
 
 .PHONY: pkcs11-proxy-module.so
 pkcs11-proxy-module.so: protoc init
-	go build -o pkcs11-proxy-module.so -buildmode=c-shared ./cmd/module
+	go build -o pkcs11-proxy-module.so -buildvcs=false -buildmode=c-shared ./cmd/module
 
 .PHONY: protoc
 protoc: 
 	protoc -I proto/ \
-	--proto_path=${GOPATH}/src \
 	--go-grpc_out=pkcs11 \
 	--go_out=pkcs11 \
 	proto/schema.proto

README.md

@@ -1,12 +1,39 @@
+# Simple PKCS#11 module proxy over GRPC
+
+Can be used to make a bridge with PKCS#11 windows-only module to use it on linux.
+
+## Usage
+### Generate certs
+```bash
+./generate-keys.sh
+```
+### Server
 ```bash
+# Bind address
 export PKCS11_PROXY_URI="localhost:8080"
-export PKCS11_MODULE="/usr/lib/softhsm/libsofthsm2.so"
-
+# Ca-cert for allowed clients (Optional)
 export PKCS11_PROXY_CACERT=$(pwd)/ca.crt
+# Server cert & key (Optional)
 export PKCS11_PROXY_KEY=$(pwd)/server.key
 export PKCS11_PROXY_CERT=$(pwd)/server.crt
+# Start server
+./pkcs11-proxy-server
+```
 
+### Client
+```bash
+# Dial address of server
+export PKCS11_PROXY_URI="localhost:8080"
+# Module to use on server (must be present only on server host)
+export PKCS11_MODULE="/usr/lib/softhsm/libsofthsm2.so"
+
+# Ca-cert for trusted server (Optional)
 export PKCS11_PROXY_CACERT=$(pwd)/ca.crt
+# Client cert & key (Optional)
 export PKCS11_PROXY_KEY=$(pwd)/client.key
 export PKCS11_PROXY_CERT=$(pwd)/client.crt
+
+# Example usage on client
+p11tool --provider=$(pwd)/pkcs11-proxy-module.so --generate-random=256
+p11tool --provider=$(pwd)/pkcs11-proxy-module.so --list-mechanisms
 ```

go.mod

@@ -1,6 +1,6 @@
 module github.com/ryarnyah/pkcs11-go-proxy
 
-go 1.21.3
+go 1.22.3
 
 require (
 	github.com/miekg/pkcs11 v1.1.1