crypto

package

v0.33.9 Latest Latest Go to latest Published: Jun 19, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/inc-backend/tendermint

README ¶

crypto

crypto is the cryptographic package adapted for Tendermint's uses

Importing it

To get the interfaces, import "github.com/inc-backend/tendermint/crypto"

For any specific algorithm, use its specific module e.g. import "github.com/inc-backend/tendermint/crypto/ed25519"

If you want to decode bytes into one of the types, but don't care about the specific algorithm, use import "github.com/inc-backend/tendermint/crypto/amino"

Binary encoding

For Binary encoding, please refer to the Tendermint encoding spec.

JSON Encoding

crypto .Bytes() uses Amino:binary encoding, but Amino:JSON is also supported.

Example Amino:JSON encodings:

ed25519.PrivKeyEd25519     - {"type":"954568A3288910","value":"EVkqJO/jIXp3rkASXfh9YnyToYXRXhBr6g9cQVxPFnQBP/5povV4HTjvsy530kybxKHwEi85iU8YL0qQhSYVoQ=="}
ed25519.PubKeyEd25519      - {"type":"AC26791624DE60","value":"AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="}
crypto.PrivKeySecp256k1   - {"type":"019E82E1B0F798","value":"zx4Pnh67N+g2V+5vZbQzEyRerX9c4ccNZOVzM9RvJ0Y="}
crypto.PubKeySecp256k1    - {"type":"F8CCEAEB5AE980","value":"A8lPKJXcNl5VHt1FK8a244K9EJuS4WX1hFBnwisi0IJx"}

Documentation ¶

Constants ¶

View Source

const (
	// AddressSize is the size of a pubkey address.
	AddressSize = tmhash.TruncatedSize
)

View Source

const Version = "0.9.0-dev"

Variables ¶

This section is empty.

Functions ¶

func CRandBytes ¶

func CRandBytes(numBytes int) []byte

This only uses the OS's randomness

func CRandHex ¶

func CRandHex(numDigits int) string

CRandHex returns a hex encoded string that's floor(numDigits/2) * 2 long.

Note: CRandHex(24) gives 96 bits of randomness that are usually strong enough for most purposes.

func CReader ¶

func CReader() io.Reader

Returns a crand.Reader.

func Sha256 ¶

func Sha256(bytes []byte) []byte

Types ¶

type Address ¶

type Address = cmn.HexBytes

An address is a []byte, but hex-encoded even in JSON. []byte leaves us the option to change the address length. Use an alias so Unmarshal methods (with ptr receivers) are available too.

func AddressHash ¶

func AddressHash(bz []byte) Address

type PrivKey ¶

type PrivKey interface {
	Bytes() []byte
	Sign(msg []byte) ([]byte, error)
	PubKey() PubKey
	Equals(PrivKey) bool
}

type PubKey ¶

type PubKey interface {
	Address() Address
	Bytes() []byte
	VerifyBytes(msg []byte, sig []byte) bool
	Equals(PubKey) bool
}

type Symmetric ¶

type Symmetric interface {
	Keygen() []byte
	Encrypt(plaintext []byte, secret []byte) (ciphertext []byte)
	Decrypt(ciphertext []byte, secret []byte) (plaintext []byte, err error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ed25519
encoding
amino
merkle Package merkle computes a deterministic minimal height Merkle tree hash.	Package merkle computes a deterministic minimal height Merkle tree hash.
multisig
bitarray
secp256k1
internal/secp256k1 nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library.	nolint:gocritic Package secp256k1 wraps the bitcoin secp256k1 C library.
tmhash

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL