Code Monkey home page Code Monkey logo

yubihsm-go's Introduction

yubihsm-go

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

It also implements a simple SessionManager which keeps connections alive and swaps them if the maximum number of messages is depleted.

Currently the following commands are implemented:

  • DeviceInfo
  • Reset
  • GenerateAsymmetricKey
  • SignDataEddsa
  • SignDataPkcs1
  • PutAsymmetricKey
  • GetPubKey
  • DeriveEcdh
  • Echo
  • ChangeAuthenticationKey
  • PutAuthenticationKey
  • GetOpaque
  • PutOpaque
  • SignAttestationCertificate
  • Authentication & Session related commands
  • GetPseudoRandom

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)
}

echoMessage := []byte("test")

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

resp, err := sm.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"))
}

yubihsm-go's People

Contributors

carte7000 avatar ezekielnewren avatar gdbelvin avatar hendrikhofstadt avatar jakecraige avatar leoluk avatar linuxdev53 avatar mattkanwisher avatar terrbear avatar yunginnanet avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

yubihsm-go's Issues

Segmentation violation running validator with Aiakos + Yubihsm-go

The system was left running overnight on the latest master branch for cosmos-sdk patched with Aiakos initialization. We validated approx. 8200 blocks before the segfault.

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x30 pc=0xcd168d]

goroutine 31 [running]:
github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/securechannel.(*SecureChannel).SendEncryptedCommand(0x0, 0xc00553df58, 0x0, 0x0, 0x0, 0x0)
/home/gopath/src/github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/securechannel/channel.go:184 +0x4d
github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go.(*SessionManager).household.func1(0xc0018a6850)
/home/gopath/src/github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/manager.go:75 +0x166
github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go.(*SessionManager).household(0xc0018a6850)
/home/gopath/src/github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/manager.go:122 +0x2b
github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go.NewSessionManager.func1(0xc0018a6850)
/home/gopath/src/github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/manager.go:59 +0x2b
created by github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go.NewSessionManager
/home/gopath/src/github.com/cosmos/cosmos-sdk/vendor/github.com/certusone/yubihsm-go/manager.go:57 +0x1ce

Implement tests

We need:

  • integration tests (hard without an actual [mock] HSM)
  • tests for the crypto implementation
  • tests for the session logic
  • tests for the session manager

Support for the List Objects command

I am creating this issue just to share, that I will be working on this feature and avoid duplicate work.

If you have any guidance opinions on how to implement this please let me know.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.