-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2339 from oasislabs/david-yan/wallet-integration
Ledger device support for CLI
- Loading branch information
Showing
17 changed files
with
391 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
go/common/crypto/signature/signers/ledger/ledger_signer.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Package ledger provides a Ledger backed signer. | ||
| package ledger | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
|
|
||
| "github.com/oasislabs/oasis-core/go/common/crypto/signature" | ||
| ledgerCommon "github.com/oasislabs/oasis-core/go/common/ledger" | ||
| ) | ||
|
|
||
| const ( | ||
| // SignerName is the name used to identify the Ledger backed signer. | ||
| SignerName = "ledger" | ||
|
|
||
| // SignerPathCoinType is set to 118, the number owned by Cosmos via SLIP-0044 registration. | ||
| // TODO: Update this number after SLIP-0044 registration is complete. | ||
| SignerPathCoinType uint32 = 118 | ||
| // SignerPathAccount is the account index used to sign transactions. | ||
| SignerPathAccount uint32 = 0 | ||
| // SignerPathChange indicates an external chain. | ||
| SignerPathChange uint32 = 0 | ||
| ) | ||
|
|
||
| var ( | ||
| _ signature.SignerFactoryCtor = NewFactory | ||
| _ signature.SignerFactory = (*Factory)(nil) | ||
| _ signature.Signer = (*Signer)(nil) | ||
|
|
||
| // SignerDerivationRootPath is the derivation path prefix used for | ||
| // generating the signature key on the Ledger device. | ||
| SignerDerivationRootPath = []uint32{ledgerCommon.PathPurpose, SignerPathCoinType, SignerPathAccount, SignerPathChange} | ||
|
|
||
| roleDerivationRootPaths = map[signature.SignerRole][]uint32{ | ||
| signature.SignerEntity: SignerDerivationRootPath, | ||
| } | ||
| ) | ||
|
|
||
| // Factory is a Ledger backed SignerFactory. | ||
| type Factory struct { | ||
| roles []signature.SignerRole | ||
| address string | ||
| index uint32 | ||
| } | ||
|
|
||
| // FactoryConfig is the config necessary to create a Factory for Ledger Signers | ||
| type FactoryConfig struct { | ||
| Address string | ||
| Index uint32 | ||
| } | ||
|
|
||
| // NewFactory creates a new factory with the specified roles. | ||
| func NewFactory(config interface{}, roles ...signature.SignerRole) signature.SignerFactory { | ||
| ledgerConfig, ok := config.(*FactoryConfig) | ||
| if !ok { | ||
| panic("invalid Ledger signer configuration provided") | ||
| } | ||
| return &Factory{ | ||
| roles: append([]signature.SignerRole{}, roles...), | ||
| address: ledgerConfig.Address, | ||
| index: ledgerConfig.Index, | ||
| } | ||
| } | ||
|
|
||
| // EnsureRole ensures that the SignatureFactory is configured for the given | ||
| // role. | ||
| func (fac *Factory) EnsureRole(role signature.SignerRole) error { | ||
| for _, v := range fac.roles { | ||
| if v == role { | ||
| return nil | ||
| } | ||
| } | ||
| return signature.ErrRoleMismatch | ||
| } | ||
|
|
||
| // Generate has the same functionality as Load, since all keys are generated | ||
| // on the Ledger device. | ||
| func (fac *Factory) Generate(role signature.SignerRole, _rng io.Reader) (signature.Signer, error) { | ||
| return fac.Load(role) | ||
| } | ||
|
|
||
| // Load will create a Signer backed by a Ledger device by searching for | ||
| // a device with the expected address. If no address is provided, this will | ||
| // created a Signer with the first Ledger device it finds. | ||
| // The only role allowed is SignerEntity. | ||
| func (fac *Factory) Load(role signature.SignerRole) (signature.Signer, error) { | ||
| pathPrefix, ok := roleDerivationRootPaths[role] | ||
| if !ok { | ||
| return nil, fmt.Errorf("role %d is not supported when using the Ledger backed signer", role) | ||
| } | ||
| device, err := ledgerCommon.ConnectToDevice(fac.address) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &Signer{device, append(pathPrefix, fac.index), nil}, nil | ||
| } | ||
|
|
||
| // Signer is a Ledger backed Signer. | ||
| type Signer struct { | ||
| device *ledgerCommon.Device | ||
| path []uint32 | ||
| publicKey *signature.PublicKey | ||
| } | ||
|
|
||
| // Public retrieves the public key from the Ledger device. | ||
| func (s *Signer) Public() signature.PublicKey { | ||
| if s.publicKey != nil { | ||
| return *s.publicKey | ||
| } | ||
|
|
||
| var pubKey signature.PublicKey | ||
| retrieved, err := s.device.GetPublicKeyEd25519(s.path) | ||
| if err != nil { | ||
| panic(fmt.Errorf("failed to retrieve public key from device: %w", err)) | ||
| } | ||
| copy(pubKey[:], retrieved) | ||
| s.publicKey = &pubKey | ||
| return pubKey | ||
| } | ||
|
|
||
| // ContextSign generates a signature with the private key over the context and | ||
| // message. | ||
| func (s *Signer) ContextSign(context signature.Context, message []byte) ([]byte, error) { | ||
| preparedContext, err := signature.PrepareSignerContext(context) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return s.device.SignEd25519(s.path, preparedContext, message) | ||
| } | ||
|
|
||
| // String returns the address of the account on the Ledger device. | ||
| func (s *Signer) String() string { | ||
| return fmt.Sprintf("[ledger signer: %s]", s.Public()) | ||
| } | ||
|
|
||
| // Reset tears down the Signer. | ||
| func (s *Signer) Reset() { | ||
| s.device.Close() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Packaged ledger contains the common constants and functions related to Ledger devices | ||
| package ledger | ||
|
|
||
| import ( | ||
| ledger "github.com/zondax/ledger-oasis-go" | ||
| ) | ||
|
|
||
| const ( | ||
| // PathPurpose is set to 44 to indicate use of the BIP-0044 specification. | ||
| PathPurpose uint32 = 44 | ||
|
|
||
| // ListingPathCoinType is set to 118, the number owned by Cosmos via SLIP-0044 registration. | ||
| // TODO: Update this number after SLIP-0044 registration is complete. | ||
| ListingPathCoinType uint32 = 118 | ||
| // ListingPathAccount is the account index used to list and connect to Ledger devices by address. | ||
| ListingPathAccount uint32 = 0 | ||
| // ListingPathChange indicates an external chain. | ||
| ListingPathChange uint32 = 0 | ||
| // ListingPathIndex is the address index used to list and connect to Ledger devices by address. | ||
| ListingPathIndex uint32 = 0 | ||
| ) | ||
|
|
||
| var ( | ||
| // ListingDerivationPath is the path used to list and connect to devices by address. | ||
| ListingDerivationPath = []uint32{PathPurpose, ListingPathCoinType, ListingPathAccount, ListingPathChange, ListingPathIndex} | ||
| ) | ||
|
|
||
| // Device is a Ledger device. | ||
| type Device = ledger.LedgerOasis | ||
|
|
||
| // ListDevices will list Ledger devices by address, derived from ListingDerivationPath. | ||
| func ListDevices() { | ||
| ledger.ListOasisDevices(ListingDerivationPath) | ||
| } | ||
|
|
||
| // ConnectToDevice attempts to connect to a Ledger device by address, which is derived by ListingDerivationPath. | ||
| func ConnectToDevice(address string) (*Device, error) { | ||
| return ledger.ConnectLedgerOasisApp(address, ListingDerivationPath) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.