[FAB-4015] Fix -M option of fabric-ca-client

The -M option of the
    fabric-ca-client enroll
command is used to specify the MSP directory of a peer or orderer.
However, when it is different from the client's home directory,
the key is not stored in the correct keystore directory.
This change set fixes this and adds an approriate test case.

Change-Id: Ia56c815255c58bf1fc4a86b29af87ba2a8b2e408
Signed-off-by: Keith Smith <bksmith@us.ibm.com>

cmd/fabric-ca-client/main_test.go

@@ -54,6 +54,7 @@ const (
 	rootCertEnvVar       = "FABRIC_CA_CLIENT_TLS_CERTFILES"
 	clientKeyEnvVar      = "FABRIC_CA_CLIENT_TLS_CLIENT_KEYFILE"
 	clientCertEnvVar     = "FABRIC_CA_CLIENT_TLS_CLIENT_CERTFILE"
+	moptionDir           = "moption-test"
 )
 
 const jsonConfig = `{
@@ -303,6 +304,34 @@ func testEnroll(t *testing.T) {
 	os.Remove(defYaml)
 }
 
+// TestMOption tests to make sure that the key is stored in the correct
+// directory when the "-M" option is used.
+func TestMOption(t *testing.T) {
+	os.RemoveAll(moptionDir)
+	port := 7173
+	s := startServer(path.Join(moptionDir, "server"), port, t)
+	if s == nil {
+		return
+	}
+	homedir := path.Join(moptionDir, "client")
+	mspdir := "msp2" // relative to homedir
+	err := RunMain([]string{
+		cmdName, "enroll",
+		"-u", fmt.Sprintf("http://admin:adminpw@localhost:%d", port),
+		"-c", path.Join(homedir, "config.yaml"),
+		"-M", mspdir, "-d"})
+	if err != nil {
+		t.Fatalf("client enroll -u failed: %s", err)
+	}
+	keystore := path.Join(homedir, mspdir, "keystore")
+	count := getNumFiles(keystore, t)
+	if count != 1 {
+		t.Fatalf("client enroll -M failed: expecting 1 file in keystore %s but found %d",
+			keystore, count)
+	}
+	s.Stop()
+}
+
 // TestReenroll tests fabric-ca-client reenroll
 func testReenroll(t *testing.T) {
 	t.Log("Testing Reenroll CMD")
@@ -718,6 +747,7 @@ func TestCleanUp(t *testing.T) {
 	os.Remove(testYaml)
 	os.Remove(fabricCADB)
 	os.RemoveAll(mspDir)
+	os.RemoveAll(moptionDir)
 	cleanMultiCADir()
 }
 
@@ -811,3 +841,37 @@ func extraArgErrorTest(in *TestData, t *testing.T) {
 		}
 	}
 }
+
+// get the number of files in a directory
+func getNumFiles(dir string, t *testing.T) int {
+	files, err := ioutil.ReadDir(dir)
+	if err != nil {
+		t.Fatalf("Failed to get number of files in directory '%s': %s", dir, err)
+	}
+	return len(files)
+}
+
+func startServer(home string, port int, t *testing.T) *lib.Server {
+	affiliations := map[string]interface{}{"org1": nil}
+	srv := &lib.Server{
+		HomeDir: home,
+		Config: &lib.ServerConfig{
+			Debug: true,
+			Port:  port,
+		},
+		CA: lib.CA{
+			Config: &lib.CAConfig{
+				Affiliations: affiliations,
+			},
+		},
+	}
+	err := srv.RegisterBootstrapUser("admin", "adminpw", "")
+	if err != nil {
+		t.Fatalf("Failed to register bootstrap user: %s", err)
+	}
+	err = srv.Start()
+	if err != nil {
+		t.Fatalf("Failed to start server: %s", err)
+	}
+	return srv
+}

lib/ca.go

@@ -119,7 +119,7 @@ func (ca *CA) init(renew bool) (err error) {
 		return err
 	}
 	// Initialize the crypto layer (BCCSP) for this CA
-	ca.csp, err = util.InitBCCSP(&ca.Config.CSP, ca.HomeDir)
+	ca.csp, err = util.InitBCCSP(&ca.Config.CSP, "", ca.HomeDir)
 	if err != nil {
 		return err
 	}

lib/client.go

@@ -88,7 +88,7 @@ func (c *Client) Init() error {
 			return fmt.Errorf("Failed to create cacerts directory: %s", err)
 		}
 		// Initialize BCCSP (the crypto layer)
-		c.csp, err = util.InitBCCSP(&cfg.CSP, c.HomeDir)
+		c.csp, err = util.InitBCCSP(&cfg.CSP, mspDir, c.HomeDir)
 		if err != nil {
 			return err
 		}

lib/server_test.go

@@ -27,6 +27,7 @@ import (
 	"strconv"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/hyperledger/fabric-ca/api"
 	. "github.com/hyperledger/fabric-ca/lib"

util/csp.go

@@ -48,8 +48,8 @@ func GetDefaultBCCSP() bccsp.BCCSP {
 }
 
 // InitBCCSP initializes BCCSP
-func InitBCCSP(optsPtr **factory.FactoryOpts, homeDir string) (bccsp.BCCSP, error) {
-	err := ConfigureBCCSP(optsPtr)
+func InitBCCSP(optsPtr **factory.FactoryOpts, mspDir, homeDir string) (bccsp.BCCSP, error) {
+	err := ConfigureBCCSP(optsPtr, mspDir)
 	if err != nil {
 		return nil, err
 	}
@@ -61,7 +61,7 @@ func InitBCCSP(optsPtr **factory.FactoryOpts, homeDir string) (bccsp.BCCSP, erro
 }
 
 // ConfigureBCCSP configures BCCSP, using
-func ConfigureBCCSP(optsPtr **factory.FactoryOpts) error {
+func ConfigureBCCSP(optsPtr **factory.FactoryOpts, mspDir string) error {
 	var err error
 	if optsPtr == nil {
 		return errors.New("nil argument not allowed")
@@ -83,10 +83,14 @@ func ConfigureBCCSP(optsPtr **factory.FactoryOpts) error {
 		if opts.SwOpts.SecLevel == 0 {
 			opts.SwOpts.SecLevel = 256
 		}
-		// Only override the KeyStorePath if it was left empty
-		if opts.SwOpts.FileKeystore == nil ||
-			opts.SwOpts.FileKeystore.KeyStorePath == "" {
-			opts.SwOpts.FileKeystore = &factory.FileKeystoreOpts{KeyStorePath: path.Join("msp", "keystore")}
+		if opts.SwOpts.FileKeystore == nil {
+			opts.SwOpts.FileKeystore = &factory.FileKeystoreOpts{}
+		}
+		// The mspDir overrides the KeyStorePath; otherwise, if not set, set default
+		if mspDir != "" {
+			opts.SwOpts.FileKeystore.KeyStorePath = path.Join(mspDir, "keystore")
+		} else if opts.SwOpts.FileKeystore.KeyStorePath == "" {
+			opts.SwOpts.FileKeystore.KeyStorePath = path.Join("msp", "keystore")
 		}
 	}
 	log.Debugf("Initializing BCCSP: %+v", opts)
@@ -107,6 +111,7 @@ func ConfigureBCCSP(optsPtr **factory.FactoryOpts) error {
 
 // GetBCCSP returns BCCSP
 func GetBCCSP(opts *factory.FactoryOpts, homeDir string) (bccsp.BCCSP, error) {
+
 	err := makeFileNamesAbsolute(opts, homeDir)
 	if err != nil {
 		return nil, fmt.Errorf("Failed to make BCCSP files absolute: %s", err)

util/csp_test.go

@@ -76,16 +76,16 @@ func TestGetDefaultBCCSP(t *testing.T) {
 func TestInitBCCSP(t *testing.T) {
 	mspDir := "msp"
 	var opts *factory.FactoryOpts
-	_, err := InitBCCSP(&opts, mspDir)
+	_, err := InitBCCSP(&opts, "", mspDir)
 	if err != nil {
 		t.Fatalf("Failed initialization 1 of BCCSP: %s", err)
 	}
 	cfg := &factory.FactoryOpts{ProviderName: "SW"}
-	_, err = InitBCCSP(&cfg, mspDir)
+	_, err = InitBCCSP(&cfg, "msp2", mspDir)
 	if err != nil {
 		t.Fatalf("Failed initialization 2 of BCCSP: %s", err)
 	}
-	_, err = InitBCCSP(nil, mspDir)
+	_, err = InitBCCSP(nil, "", mspDir)
 	if err == nil {
 		t.Fatalf("Initialization 3 of BCCSP should have failed but did not")
 	}