crypto

package
v0.34.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 23, 2021 License: Apache-2.0 Imports: 24 Imported by: 80

Documentation

Index

Constants

View Source 
const AddressHexLength = 2 * AddressLength
View Source 
const AddressLength = binary.Word160Length

Variables

View Source 
var (
	ErrInvalidLengthCrypto        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCrypto          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupCrypto = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var ZeroAddress = Address{}

Functions

func EnsureEd25519PrivateKeyCorrect 

func EnsureEd25519PrivateKeyCorrect(candidatePrivateKey ed25519.PrivateKey) error

Ensures the last 32 bytes of the ed25519 private key is the public key derived from the first 32 private bytes

func GetEthSignatureRecoveryID added in v0.31.0 

func GetEthSignatureRecoveryID(chainID *big.Int, parity *big.Int) *big.Int

func Keccak256 added in v0.29.0 

func Keccak256(data []byte) []byte

func Nonce added in v0.24.4 

func Nonce(caller Address, nonce []byte) []byte

func PublicKeyLength 

func PublicKeyLength(curveType CurveType) int

Returns the length in bytes of the public key

func RIPEMD160 added in v0.29.0 

func RIPEMD160(data []byte) []byte

func SHA256 added in v0.29.0 

func SHA256(data []byte) []byte

func SequenceNonce added in v0.24.4 

func SequenceNonce(address Address, sequence uint64) []byte

Obtain a nearly unique nonce based on a monotonic account sequence number

Types

type Address 

type Address binary.Word160

func AddressFromBytes 

func AddressFromBytes(bs []byte) (address Address, err error)

Returns an address consisting of the first 20 bytes of bs, return an error if the bs does not have length exactly 20 but will still return either: the bytes in bs padded on the right or the first 20 bytes of bs truncated in any case.

func AddressFromHexString 

func AddressFromHexString(str string) (Address, error)

func AddressFromWord256 

func AddressFromWord256(addr binary.Word256) Address

func MaybeAddressFromBytes 

func MaybeAddressFromBytes(bs []byte) (*Address, error)

Returns a pointer to an Address that is nil iff len(bs) == 0 otherwise does the same as AddressFromBytes

func MustAddressFromBytes 

func MustAddressFromBytes(addr []byte) Address

func MustAddressFromHexString added in v0.28.0 

func MustAddressFromHexString(str string) Address

func NewContractAddress 

func NewContractAddress(caller Address, nonce []byte) (newAddr Address)

func NewContractAddress2 added in v0.24.0 

func NewContractAddress2(caller Address, salt [binary.Word256Bytes]byte, initcode []byte) (newAddr Address)

func (Address) Bytes 

func (address Address) Bytes() []byte

Copy address and return a slice onto the copy

func (*Address) Marshal added in v0.20.0 

func (address *Address) Marshal() ([]byte, error)

Gogo proto support

func (Address) MarshalJSON 

func (address Address) MarshalJSON() ([]byte, error)

func (Address) MarshalText 

func (address Address) MarshalText() ([]byte, error)

func (*Address) MarshalTo added in v0.20.0 

func (address *Address) MarshalTo(data []byte) (int, error)

func (*Address) Size added in v0.20.0 

func (address *Address) Size() int

func (Address) String 

func (address Address) String() string

func (*Address) Unmarshal added in v0.20.0 

func (address *Address) Unmarshal(data []byte) error

func (*Address) UnmarshalJSON 

func (address *Address) UnmarshalJSON(data []byte) error

func (*Address) UnmarshalText 

func (address *Address) UnmarshalText(text []byte) error

func (Address) Word256 

func (address Address) Word256() binary.Word256

type Addressable added in v0.20.0 

type Addressable interface {
	// Get the 20 byte EVM address of this account
	GetAddress() Address
	// Public key from which the Address is derived
	GetPublicKey() *PublicKey
}

func NewAddressable added in v0.20.0 

func NewAddressable(publicKey *PublicKey) Addressable

type Addresses 

type Addresses []Address

func (Addresses) Len 

func (as Addresses) Len() int

func (Addresses) Less 

func (as Addresses) Less(i, j int) bool

func (Addresses) Swap 

func (as Addresses) Swap(i, j int)

type CompactSecp256k1Signature added in v0.31.0 

type CompactSecp256k1Signature struct {
	Secp256k1Signature
}

* 

btcec layout is:
input:  [  v   |  r   |  s   ]
bytes:  [  1   |  32  |  32  ]
Where:
  v = 27 + recovery id (which of 4 possible x coords do we take as public key) (single byte but padded)
  r = encrypted random point
  s = signature proof

Signature layout required by btcec:
sig:    [  r   |  s   |  v  ]
bytes:  [  32  |  32  |  1  ]

func (*CompactSecp256k1Signature) Marshal added in v0.31.0 

func (s *CompactSecp256k1Signature) Marshal() ([]byte, error)

func (*CompactSecp256k1Signature) Unmarshal added in v0.31.0 

func (s *CompactSecp256k1Signature) Unmarshal(bs []byte) error

type CurveType 

type CurveType uint32
const (
	CurveTypeUnset CurveType = iota
	CurveTypeEd25519
	CurveTypeSecp256k1
)

func CurveTypeFromString 

func CurveTypeFromString(s string) (CurveType, error)

func (CurveType) ABCIType added in v0.20.0 

func (k CurveType) ABCIType() string

func (CurveType) Byte 

func (k CurveType) Byte() byte

Get this CurveType's 8 bit identifier as a byte

func (CurveType) String 

func (k CurveType) String() string

type EIP155Signature added in v0.31.0 

type EIP155Signature struct {
	Secp256k1Signature
}

func (*EIP155Signature) ToCompactSignature added in v0.31.0 

func (s *EIP155Signature) ToCompactSignature() ([]byte, error)

Get btcec compact signature (our standard)

type ErrInvalidCurve 

type ErrInvalidCurve uint32

func (ErrInvalidCurve) Error 

func (curveType ErrInvalidCurve) Error() string

type PrivateKey 

type PrivateKey struct {
	CurveType CurveType `protobuf:"varint,1,opt,name=CurveType,proto3,casttype=CurveType" json:"CurveType,omitempty"`
	// Note may need initialisation
	PublicKey            []byte   `protobuf:"bytes,2,opt,name=PublicKey,proto3" json:"PublicKey,omitempty"`
	PrivateKey           []byte   `protobuf:"bytes,3,opt,name=PrivateKey,proto3" json:"PrivateKey,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func GeneratePrivateKey 

func GeneratePrivateKey(random io.Reader, curveType CurveType) (PrivateKey, error)

func PrivateKeyFromRawBytes 

func PrivateKeyFromRawBytes(privateKeyBytes []byte, curveType CurveType) (PrivateKey, error)

func PrivateKeyFromSecret 

func PrivateKeyFromSecret(secret string, curveType CurveType) PrivateKey

func (*PrivateKey) Descriptor added in v0.20.0 

func (*PrivateKey) Descriptor() ([]byte, []int)

func (*PrivateKey) GetAddress added in v0.31.0 

func (pk *PrivateKey) GetAddress() Address

func (PrivateKey) GetPublicKey 

func (p PrivateKey) GetPublicKey() *PublicKey

func (*PrivateKey) Marshal added in v0.20.0 

func (m *PrivateKey) Marshal() (dAtA []byte, err error)

func (*PrivateKey) MarshalTo added in v0.20.0 

func (m *PrivateKey) MarshalTo(dAtA []byte) (int, error)

func (*PrivateKey) MarshalToSizedBuffer added in v0.30.0 

func (m *PrivateKey) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrivateKey) ProtoMessage added in v0.20.0 

func (*PrivateKey) ProtoMessage()

func (PrivateKey) RawBytes 

func (p PrivateKey) RawBytes() []byte

func (*PrivateKey) Reset added in v0.20.0 

func (m *PrivateKey) Reset()

func (PrivateKey) Sign 

func (p PrivateKey) Sign(msg []byte) (*Signature, error)

func (*PrivateKey) Size added in v0.20.0 

func (m *PrivateKey) Size() (n int)

func (PrivateKey) String added in v0.20.0 

func (p PrivateKey) String() string

func (*PrivateKey) Unmarshal added in v0.20.0 

func (m *PrivateKey) Unmarshal(dAtA []byte) error

func (*PrivateKey) XXX_DiscardUnknown added in v0.23.0 

func (m *PrivateKey) XXX_DiscardUnknown()

func (*PrivateKey) XXX_Marshal added in v0.23.0 

func (m *PrivateKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrivateKey) XXX_Merge added in v0.23.0 

func (m *PrivateKey) XXX_Merge(src proto.Message)

func (*PrivateKey) XXX_MessageName added in v0.20.0 

func (*PrivateKey) XXX_MessageName() string

func (*PrivateKey) XXX_Size added in v0.23.0 

func (m *PrivateKey) XXX_Size() int

func (*PrivateKey) XXX_Unmarshal added in v0.23.0 

func (m *PrivateKey) XXX_Unmarshal(b []byte) error

type PublicKey 

type PublicKey struct {
	CurveType            CurveType                                     `protobuf:"varint,1,opt,name=CurveType,proto3,casttype=CurveType" json:"CurveType,omitempty"`
	PublicKey            github_com_hyperledger_burrow_binary.HexBytes `protobuf:"bytes,2,opt,name=PublicKey,proto3,customtype=github.com/hyperledger/burrow/binary.HexBytes" json:"PublicKey"`
	XXX_NoUnkeyedLiteral struct{}                                      `json:"-"`
	XXX_unrecognized     []byte                                        `json:"-"`
	XXX_sizecache        int32                                         `json:"-"`
}

func PublicKeyFromBytes 

func PublicKeyFromBytes(bs []byte, curveType CurveType) (*PublicKey, error)

Currently this is a stub that reads the raw bytes returned by key_client and returns an ed25519 public key.

func PublicKeyFromTendermintPubKey added in v0.20.0 

func PublicKeyFromTendermintPubKey(pubKey tmCrypto.PubKey) (*PublicKey, error)

func (*PublicKey) AddressHashType 

func (p *PublicKey) AddressHashType() string

func (*PublicKey) Descriptor added in v0.20.0 

func (*PublicKey) Descriptor() ([]byte, []int)

func (*PublicKey) GetAddress added in v0.23.0 

func (p *PublicKey) GetAddress() Address

func (*PublicKey) GetCurveType added in v0.20.0 

func (m *PublicKey) GetCurveType() CurveType

func (*PublicKey) IsSet added in v0.20.1 

func (p *PublicKey) IsSet() bool

func (*PublicKey) IsValid 

func (p *PublicKey) IsValid() bool

func (*PublicKey) Marshal added in v0.20.0 

func (m *PublicKey) Marshal() (dAtA []byte, err error)

func (*PublicKey) MarshalJSON 

func (p *PublicKey) MarshalJSON() ([]byte, error)

func (*PublicKey) MarshalText 

func (p *PublicKey) MarshalText() ([]byte, error)

func (*PublicKey) MarshalTo added in v0.20.0 

func (m *PublicKey) MarshalTo(dAtA []byte) (int, error)

func (*PublicKey) MarshalToSizedBuffer added in v0.30.0 

func (m *PublicKey) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PublicKey) ProtoMessage added in v0.20.0 

func (*PublicKey) ProtoMessage()

func (*PublicKey) Reset added in v0.20.0 

func (m *PublicKey) Reset()

func (*PublicKey) Size added in v0.20.0 

func (m *PublicKey) Size() (n int)

func (*PublicKey) String 

func (p *PublicKey) String() string

func (PublicKey) TendermintAddress added in v0.29.0 

func (p PublicKey) TendermintAddress() tmCrypto.Address

func (PublicKey) TendermintPubKey added in v0.20.1 

func (p PublicKey) TendermintPubKey() tmCrypto.PubKey

func (*PublicKey) Unmarshal added in v0.20.0 

func (m *PublicKey) Unmarshal(dAtA []byte) error

func (*PublicKey) UnmarshalJSON 

func (p *PublicKey) UnmarshalJSON(text []byte) error

func (*PublicKey) UnmarshalText 

func (p *PublicKey) UnmarshalText(text []byte) error

func (*PublicKey) Verify 

func (p *PublicKey) Verify(msg []byte, signature *Signature) error

func (*PublicKey) XXX_DiscardUnknown added in v0.23.0 

func (m *PublicKey) XXX_DiscardUnknown()

func (*PublicKey) XXX_Marshal added in v0.23.0 

func (m *PublicKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PublicKey) XXX_Merge added in v0.23.0 

func (m *PublicKey) XXX_Merge(src proto.Message)

func (*PublicKey) XXX_MessageName added in v0.20.0 

func (*PublicKey) XXX_MessageName() string

func (*PublicKey) XXX_Size added in v0.23.0 

func (m *PublicKey) XXX_Size() int

func (*PublicKey) XXX_Unmarshal added in v0.23.0 

func (m *PublicKey) XXX_Unmarshal(b []byte) error

type PublicKeyJSON 

type PublicKeyJSON struct {
	CurveType string
	PublicKey string
}

type Secp256k1Signature added in v0.31.0 

type Secp256k1Signature struct {
	// Magic parity byte (value varies by implementation to carry additional information)
	V big.Int `json:"v"`
	R big.Int `json:"r"`
	S big.Int `json:"s"`
}

func (*Secp256k1Signature) BigRecoveryIndex added in v0.31.0 

func (s *Secp256k1Signature) BigRecoveryIndex() *big.Int

func (*Secp256k1Signature) RecoveryIndex added in v0.31.0 

func (s *Secp256k1Signature) RecoveryIndex() uint

Returns either 0 or 1 for the underlying parity of the public key solution

type Signable 

type Signable interface {
	SignBytes(chainID string) ([]byte, error)
}

Signable is an interface for all signable things. It typically removes signatures before serializing.

type Signature 

type Signature struct {
	CurveType            CurveType `protobuf:"varint,1,opt,name=CurveType,proto3,casttype=CurveType" json:"CurveType,omitempty"`
	Signature            []byte    `protobuf:"bytes,2,opt,name=Signature,proto3" json:"Signature,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func SignatureFromBytes 

func SignatureFromBytes(bs []byte, curveType CurveType) (*Signature, error)

func (*Signature) Descriptor added in v0.20.1 

func (*Signature) Descriptor() ([]byte, []int)

func (*Signature) GetCurveType added in v0.20.1 

func (m *Signature) GetCurveType() CurveType

func (*Signature) GetEthSignature added in v0.31.0 

func (sig *Signature) GetEthSignature(chainID *big.Int) (*EIP155Signature, error)

func (*Signature) GetSignature added in v0.20.1 

func (m *Signature) GetSignature() []byte

func (*Signature) Marshal added in v0.20.0 

func (m *Signature) Marshal() (dAtA []byte, err error)

func (*Signature) MarshalTo added in v0.20.0 

func (m *Signature) MarshalTo(dAtA []byte) (int, error)

func (*Signature) MarshalToSizedBuffer added in v0.30.0 

func (m *Signature) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Signature) ProtoMessage added in v0.20.1 

func (*Signature) ProtoMessage()

func (*Signature) RawBytes 

func (sig *Signature) RawBytes() []byte

func (*Signature) Reset added in v0.20.1 

func (m *Signature) Reset()

func (*Signature) Size added in v0.20.0 

func (m *Signature) Size() (n int)

func (*Signature) String added in v0.20.0 

func (sig *Signature) String() string

func (Signature) TendermintSignature added in v0.20.1 

func (sig Signature) TendermintSignature() []byte

func (*Signature) Unmarshal added in v0.20.0 

func (m *Signature) Unmarshal(dAtA []byte) error

func (*Signature) XXX_DiscardUnknown added in v0.23.0 

func (m *Signature) XXX_DiscardUnknown()

func (*Signature) XXX_Marshal added in v0.23.0 

func (m *Signature) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Signature) XXX_Merge added in v0.23.0 

func (m *Signature) XXX_Merge(src proto.Message)

func (*Signature) XXX_MessageName added in v0.20.1 

func (*Signature) XXX_MessageName() string

func (*Signature) XXX_Size added in v0.23.0 

func (m *Signature) XXX_Size() int

func (*Signature) XXX_Unmarshal added in v0.23.0 

func (m *Signature) XXX_Unmarshal(b []byte) error

type Signer 

type Signer interface {
	Sign(msg []byte) (*Signature, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.