[FAB-7763] Tool to import keys into HSM test fixture

Change-Id: I4b47466ab5c7842138292d0a7ea6176f3fd043b3
Signed-off-by: gbolo <george.bolo@gmail.com>

Author: gbolo

scripts/_go/src/pkcs11helper/Gopkg.lock

@@ -0,0 +1,35 @@
+#
+# Copyright SecureKey Technologies Inc. All Rights Reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#  name = "github.com/x/y"
+#  version = "2.4.0"
+
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/miekg/pkcs11"
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/olekukonko/tablewriter"

scripts/_go/src/pkcs11helper/Gopkg.toml

@@ -0,0 +1,7 @@
+#
+# Copyright SecureKey Technologies Inc. All Rights Reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+/pkcs11helper

scripts/_go/src/pkcs11helper/cmd/pkcs11helper/.gitignore

@@ -0,0 +1,39 @@
+# pkcs11 helper tool
+
+Meant to help import keys for use in fabric.
+
+```
+# prepare slot
+softhsm2-util --init-token --label ForFabric --pin 98765432 --free --so-pin 1234
+
+# tool options
+./pkcs11helper -help
+Usage of ./pkcs11helper:
+  -action string
+    	list,import (default "list")
+  -keyFile string
+    	path to pem encoded EC private key you want to import (default "testdata/key.ec.pem")
+  -lib string
+    	Location of pkcs11 library (Defaults to a list of possible paths to libsofthsm2.so)
+  -pin string
+    	Slot PIN (default "98765432")
+  -slot string
+    	Slot Label (default "ForFabric")
+
+# import ec key
+./pkcs11helper -action import -keyFile testdata/key.ec.pem
+PKCS11 provider found specified slot label: ForFabric (slot: 0, index: 0)
+Object was imported with CKA_LABEL:BCPUB1 CKA_ID:018f389d200e48536367f05b99122f355ba33572009bd2b8b521cdbbb717a5b5
+Object was imported with CKA_LABEL:BCPRV1 CKA_ID:018f389d200e48536367f05b99122f355ba33572009bd2b8b521cdbbb717a5b5
+
+# list objects
+./pkcs11helper -action list
+PKCS11 provider found specified slot label: ForFabric (slot: 0, index: 0)
++-------+-----------------+-----------+------------------------------------------------------------------+
+| COUNT |    CKA CLASS    | CKA LABEL |                              CKA ID                              |
++-------+-----------------+-----------+------------------------------------------------------------------+
+|   001 | CKO_PUBLIC_KEY  | BCPUB1    | 018f389d200e48536367f05b99122f355ba33572009bd2b8b521cdbbb717a5b5 |
+|   002 | CKO_PRIVATE_KEY | BCPRV1    | 018f389d200e48536367f05b99122f355ba33572009bd2b8b521cdbbb717a5b5 |
++-------+-----------------+-----------+------------------------------------------------------------------+
+Total objects found (max 50): 2
+```

scripts/_go/src/pkcs11helper/cmd/pkcs11helper/README.md

@@ -0,0 +1,113 @@
+/*
+Copyright SecureKey Technologies Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strings"
+
+	pw "pkcs11helper/pkg/pkcs11wrapper"
+	"github.com/miekg/pkcs11"
+)
+
+var (
+	defaultPkcs11LibPaths = []string{
+		"/usr/lib/softhsm/libsofthsm2.so",
+		"/usr/lib/x86_64-linux-gnu/softhsm/libsofthsm2.so",
+		"/usr/lib/s390x-linux-gnu/softhsm/libsofthsm2.so",
+		"/usr/lib/powerpc64le-linux-gnu/softhsm/libsofthsm2.so",
+		"/usr/local/Cellar/softhsm/2.1.0/lib/softhsm/libsofthsm2.so",
+	}
+)
+
+func main() {
+
+	// get flags
+	pkcs11Library := flag.String("lib", "", "Location of pkcs11 library (Defaults to a list of possible paths to libsofthsm2.so)")
+	slotLabel := flag.String("slot", "ForFabric", "Slot Label")
+	slotPin := flag.String("pin", "98765432", "Slot PIN")
+	action := flag.String("action", "list", "list,import")
+	keyFile := flag.String("keyFile", "testdata/key.ec.pem", "path to pem encoded EC private key you want to import")
+
+	flag.Parse()
+
+	// initialize pkcs11
+	var p11Lib string
+	var err error
+
+	if *pkcs11Library == "" {
+		// if no lib is specified, just try to find libsofthsm2.so
+		p11Lib, err = searchForLib(strings.Join(defaultPkcs11LibPaths,","))
+		exitWhenError(err)
+	} else {
+		p11Lib, err = searchForLib(*pkcs11Library)
+		exitWhenError(err)
+	}
+
+	p11w := pw.Pkcs11Wrapper{
+		Library: pw.Pkcs11Library{
+			Path: p11Lib,
+		},
+		SlotLabel: *slotLabel,
+		SlotPin:   *slotPin,
+	}
+
+	err = p11w.InitContext()
+	exitWhenError(err)
+
+	err = p11w.InitSession()
+	exitWhenError(err)
+
+	err = p11w.Login()
+	exitWhenError(err)
+
+	// defer cleanup
+	defer p11w.CloseContext()
+
+	// complete actions
+	switch *action {
+
+	case "import":
+		err = p11w.ImportECKeyFromFile(*keyFile)
+		exitWhenError(err)
+
+	default:
+		p11w.ListObjects(
+			[]*pkcs11.Attribute{},
+			50,
+		)
+
+	}
+
+}
+
+// exit properly
+func exitWhenError(err error) {
+	if err != nil {
+		fmt.Println("Error:", err)
+		os.Exit(1)
+	}
+}
+
+// return the first path that is found
+func searchForLib(paths string) (firstFound string, err error) {
+
+	libPaths := strings.Split(paths, ",")
+	for _, path := range libPaths {
+		if _, err = os.Stat(strings.TrimSpace(path)); !os.IsNotExist(err) {
+			firstFound = strings.TrimSpace(path)
+			break
+		}
+	}
+
+	if firstFound == "" {
+		err = fmt.Errorf("no suitable paths for pkcs11 library found: %s", paths)
+	}
+
+	return
+}

scripts/_go/src/pkcs11helper/cmd/pkcs11helper/main.go

@@ -0,0 +1,5 @@
+-----BEGIN PRIVATE KEY-----
+MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgXa3mln4anewXtqrM
+hMw6mfZhslkRa/j9P790ToKjlsihRANCAARnxLhXvU4EmnIwhVl3Bh0VcByQi2um
+9KsJ/QdCDjRZb1dKg447voj5SZ8SSZOUglc/v8DJFFJFTfygjwi+27gz
+-----END PRIVATE KEY-----