README
¶
go-libp2p-peer
PKI based identities for use in go-libp2p
Install
TODO
Usage
TODO
Format
An ID is a multihash with type either SHA2_256 or identity.
For most key types the type is SHA2_256 and the payload is the value of github.com/libp2p/go-libp2p-crypto.PubKey.Bytes().
<SHA2_256 mc><length (32)><SHA256 hash>
<0x12 ><0x20 ><SHA256 hash>
Ed25519 public keys instead are encoded with type identity and as payload a multicodec key in packed format.
<identity mc><length (2 + 32 = 34)><ed25519-pub mc><ed25519 pubkey>
<0x00 ><0x22 ><0xed01 ><ed25519 pubkey>
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
Want to hack on IPFS?
License
MIT
Documentation
¶
Overview ¶
package peer implements an object used to represent peers in the ipfs network.
Index ¶
- Variables
- func IDB58Encode(id ID) string
- func IDHexEncode(id ID) string
- type ID
- func IDB58Decode(s string) (ID, error)
- func IDFromBytes(b []byte) (ID, error)
- func IDFromEd25519PublicKey(pk ic.PubKey) (ID, error)
- func IDFromPrivateKey(sk ic.PrivKey) (ID, error)
- func IDFromPublicKey(pk ic.PubKey) (ID, error)
- func IDFromString(s string) (ID, error)
- func IDHexDecode(s string) (ID, error)
- func (id ID) ExtractEd25519PublicKey() (ic.PubKey, error)
- func (id ID) ExtractPublicKey() ic.PubKey
- func (id ID) Loggable() map[string]interface{}
- func (id ID) MatchesPrivateKey(sk ic.PrivKey) bool
- func (id ID) MatchesPublicKey(pk ic.PubKey) bool
- func (id ID) Pretty() string
- func (id ID) String() string
- type IDSlice
Constants ¶
This section is empty.
Variables ¶
var CodePrefixErr = errors.New("unexpected code prefix")
var MultihashCodecErr = errors.New("unexpected multihash codec")
var MultihashDecodeErr = errors.New("unable to decode multihash")
var MultihashLengthErr = errors.New("unexpected multihash length")
Functions ¶
Types ¶
type ID ¶
type ID string
func IDFromBytes ¶
IDFromBytes cast a string to ID type, and validate the id to make sure it is a multihash.
func IDFromEd25519PublicKey ¶
IDFromEd25519PublicKey returns the Peer ID corresponding to Id25519 pk
func IDFromPrivateKey ¶
IDFromPrivateKey returns the Peer ID corresponding to sk
func IDFromPublicKey ¶
IDFromPublicKey returns the Peer ID corresponding to pk
func IDFromString ¶
IDFromString cast a string to ID type, and validate the id to make sure it is a multihash.
func (ID) ExtractPublicKey ¶
ExtractPublicKey attempts to extract the public key from an ID
func (ID) MatchesPrivateKey ¶
MatchesPrivateKey tests whether this ID was derived from sk
func (ID) MatchesPublicKey ¶
MatchesPublicKey tests whether this ID was derived from pk
Source Files
Directories