crypto

Documentation

Index

• Constants
• Variables
• func CipherCodeByName(cipherName string) uint8
• func CompressPubkey(pubkey *ecdsa.PublicKey) []byte
• func CreateAddress(b common.Address, nonce uint64) common.Address
• func CreateAddress2(b common.Address, salt [32]byte, inithash []byte) common.Address
• func DecompressPubkey(pubkey []byte) (*ecdsa.PublicKey, error)
• func Ecrecover(hash, sig []byte) ([]byte, error)
• func FromECDSA(priv *ecdsa.PrivateKey) []byte
• func FromECDSAPub(pub *ecdsa.PublicKey) []byte
• func GenerateKey() (*ecdsa.PrivateKey, error)
• func HexToECDSA(hexkey string) (*ecdsa.PrivateKey, error)
• func IsEqualPublicKey(one *ecdsa.PublicKey, two *ecdsa.PublicKey) bool
• func Keccak256(data ...[]byte) []byte
• func Keccak256Hash(data ...[]byte) (h common.Hash)
• func Keccak512(data ...[]byte) []byte
• func LoadECDSA(file string) (*ecdsa.PrivateKey, error)
• func Overhead(cipherCode uint8) uint8
• func PubkeyToAddress(p ecdsa.PublicKey) common.Address
• func S256() elliptic.Curve
• func SaveECDSA(file string, key *ecdsa.PrivateKey) error
• func SigToPub(hash, sig []byte) (*ecdsa.PublicKey, error)
• func Sign(hash []byte, prv *ecdsa.PrivateKey) (sig []byte, err error)
• func ToECDSA(d []byte) (*ecdsa.PrivateKey, error)
• func ToECDSAUnsafe(d []byte) *ecdsa.PrivateKey
• func UnmarshalPubkey(pub []byte) (*ecdsa.PublicKey, error)
• func ValidateSignatureValues(v byte, r, s *big.Int, homestead bool) bool
• func VerifySignature(pubkey, hash, signature []byte) bool
• type CipherKey
  • func GenerateCipherKey(cipherCode uint8) (CipherKey, error)
  • func NewCipherKey(cipherCode uint8, key []byte) (CipherKey, error)

Constants

const (
	// CipherCodeNotSupport is the invalid cipher code
	CipherCodeNotSupport uint8 = iota

	// PlainCipherCode is the cipher code for plainCipherKey
	PlainCipherCode

	// GCMCipherCode is the cipher code for twofish-gcm
	GCMCipherCode
)

Variables

var (
	// ErrInvalidCipherCode is the error type saying that the provided cipher code is not supported.
	// Supported cipher code: PlainCipherCode, GCMCipherCode
	ErrInvalidCipherCode = errors.New("provided CipherType not supported")
)

Functions

func CipherCodeByName

func CipherCodeByName(cipherName string) uint8

CipherCodeByName returns the cipher code associated with the cipher name

func CompressPubkey

func CompressPubkey(pubkey *ecdsa.PublicKey) []byte

CompressPubkey encodes a public key to the 33-byte compressed format.

func CreateAddress

func CreateAddress(b common.Address, nonce uint64) common.Address

CreateAddress creates an ethereum address given the bytes and the nonce

func CreateAddress2

func CreateAddress2(b common.Address, salt [32]byte, inithash []byte) common.Address

CreateAddress2 creates an ethereum address given the address bytes, initial contract code hash and a salt.

func DecompressPubkey

func DecompressPubkey(pubkey []byte) (*ecdsa.PublicKey, error)

DecompressPubkey parses a public key in the 33-byte compressed format.

func Ecrecover

func Ecrecover(hash, sig []byte) ([]byte, error)

Ecrecover returns the uncompressed public key that created the given signature.

func FromECDSA

func FromECDSA(priv *ecdsa.PrivateKey) []byte

FromECDSA exports a private key into a binary dump.

func FromECDSAPub

func FromECDSAPub(pub *ecdsa.PublicKey) []byte

func GenerateKey

func GenerateKey() (*ecdsa.PrivateKey, error)

func HexToECDSA

func HexToECDSA(hexkey string) (*ecdsa.PrivateKey, error)

HexToECDSA parses a secp256k1 private key.

func IsEqualPublicKey

func IsEqualPublicKey(one *ecdsa.PublicKey, two *ecdsa.PublicKey) bool

func Keccak256

func Keccak256(data ...[]byte) []byte

Keccak256 calculates and returns the Keccak256 hash of the input data.

func Keccak256Hash

func Keccak256Hash(data ...[]byte) (h common.Hash)

Keccak256Hash calculates and returns the Keccak256 hash of the input data, converting it to an internal Hash data structure.

func Keccak512

func Keccak512(data ...[]byte) []byte

Keccak512 calculates and returns the Keccak512 hash of the input data.

func LoadECDSA

func LoadECDSA(file string) (*ecdsa.PrivateKey, error)

LoadECDSA loads a secp256k1 private key from the given file.

func Overhead

func Overhead(cipherCode uint8) uint8

Overhead return the size of the overhead for a cipher type specified by cipherCode

func PubkeyToAddress

func PubkeyToAddress(p ecdsa.PublicKey) common.Address

func S256

func S256() elliptic.Curve

S256 returns an instance of the secp256k1 curve.

func SaveECDSA

func SaveECDSA(file string, key *ecdsa.PrivateKey) error

SaveECDSA saves a secp256k1 private key to the given file with restrictive permissions. The key data is saved hex-encoded.

func SigToPub

func SigToPub(hash, sig []byte) (*ecdsa.PublicKey, error)

SigToPub returns the public key that created the given signature.

func Sign

func Sign(hash []byte, prv *ecdsa.PrivateKey) (sig []byte, err error)

Sign calculates an ECDSA signature.

This function is susceptible to chosen plaintext attacks that can leak information about the private key that is used for signing. Callers must be aware that the given hash cannot be chosen by an adversery. Common solution is to hash any input before calculating the signature.

The produced signature is in the [R || S || V] format where V is 0 or 1.

func ToECDSA

func ToECDSA(d []byte) (*ecdsa.PrivateKey, error)

ToECDSA creates a private key with the given D value.

func ToECDSAUnsafe

func ToECDSAUnsafe(d []byte) *ecdsa.PrivateKey

ToECDSAUnsafe blindly converts a binary blob to a private key. It should almost never be used unless you are sure the input is valid and want to avoid hitting errors due to bad origin encoding (0 prefixes cut off).

func UnmarshalPubkey

func UnmarshalPubkey(pub []byte) (*ecdsa.PublicKey, error)

UnmarshalPubkey converts bytes to a secp256k1 public key.

func ValidateSignatureValues

func ValidateSignatureValues(v byte, r, s *big.Int, homestead bool) bool

ValidateSignatureValues verifies whether the signature values are valid with the given chain rules. The v value is assumed to be either 0 or 1.

func VerifySignature

func VerifySignature(pubkey, hash, signature []byte) bool

VerifySignature checks that the given public key created signature over hash. The public key should be in compressed (33 bytes) or uncompressed (65 bytes) format. The signature should have the 64 byte [R || S] format.

Types

type CipherKey

type CipherKey interface {
	// CodeName return the code specified of the CipherKey type
	CodeName() string

	// Overhead returns the overhead for decrypted text
	Overhead() uint8

	// CipherKey return the key for the specified CipherKey type
	Key() []byte

	// Encrypt will encrypt the input byte slice to cipher text
	Encrypt([]byte) ([]byte, error)

	// Decrypt will decrypt the input cipher text to plain text
	Decrypt([]byte) ([]byte, error)

	// DecryptInPlace will reuse the input memory and decrypt into the input byte slice.
	// Note that the cipher text has greater length than plainText, so the plainText start
	// at index of overhead
	DecryptInPlace([]byte) ([]byte, error)
}

CipherKey is the interface for cipher key, which is implemented by plainCipherKey, and gcmCipherKey

func GenerateCipherKey

func GenerateCipherKey(cipherCode uint8) (CipherKey, error)

GenerateCipherKey generate a random seed and new a key according to the CipherKey type specified by cipherCode

func NewCipherKey

func NewCipherKey(cipherCode uint8, key []byte) (CipherKey, error)

NewCipherKey will create a CipherKey using the key type specified by cipherCode, value with the input key