yubihsm-go/README.md

yubihsm-go

Yubihsm-go is a minimal implementation of the securechannel and connector protocol of the YubiHSM2.

It also implements a simple SessionManager which can pool connections.

Currently the following commands are implemented:

• Reset
• GenerateAsymmetricKey
• SignDataEddsa
• PutAsymmetricKey
• GetPubKey
• Echo
• Authentication & Session related commands

Implementing new commands is really easy. Please consult commands/constructors.go and commands/response.go for reference.

Please submit a PR if you have implemented new commands or extended existing constructors.

Example of usage

c := connector.NewHTTPConnector("localhost:1234")
sm, err := yubihsm.NewSessionManager(c, 1, "password", 2)
if err != nil {
	panic(err)
}

select {
case <-sm.Connected:
	println("connected and authed")
case <-time.After(5 * time.Second):
	panic(errors.New("connection/authentication with the HSM timed out; look at aiakos logs for more info"))
}

session, err := sm.GetSession()
if err != nil {
	panic(err)
}

echoMessage := []byte("test")

command, err := commands.CreateEchoCommand(echoMessage)
if err != nil {
	panic(err)
}

resp, err := session.SendEncryptedCommand(command)
if err != nil {
	panic(err)
}

parsedResp, matched := resp.(*commands.EchoResponse)
if !matched {
	panic("invalid response type")
}

if bytes.Equal(parsedResp.Data, echoMessage) {
	println("successfully echoed data")
} else {
	panic(errors.New("echoed message did not equal requested message"))
}