client

Documentation

Index

• Variables
• func FieldByName(fieldName string) (fieldNumber int32, err error)
• func GetProfileField(profile *Profile, field int32) ([]byte, error)
• func MakeOperation(name string, profile *Profile) *SignedProfileOperation
• func NewProfile(rnd io.Reader, expirationTime *time.Time) (profile *Profile, sk *[ed25519.PrivateKeySize]byte, err error)
• func NewSign(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) *SignedProfileOperation
• func OldSign(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) *SignedProfileOperation
• func SetProfileField(profile *Profile, field int32, value []byte) error
• func TransferProposal(sk *[ed25519.PrivateKeySize]byte, name string, profile *Profile) *SignedProfileOperation
• func VerifyResolveAgainstRoot(rootHash []byte, name string, resolve []*ClientReply_MerklemapNode, ...) (profile []byte, err error)
• type Client
  • func NewClient(cfg *Config, dialer proxy.Dialer, tlsConfig *tls.Config) (c *Client, err error)
  • func (c *Client) AcceptTransfer(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) error
  • func (c *Client) Enact(op *SignedProfileOperation, invite []byte) (err error)
  • func (c *Client) Lookup(name string) (profile *Profile, err error)
  • func (c *Client) Modify(sk *[ed25519.PrivateKeySize]byte, name string, profile *Profile) error
  • func (c *Client) Register(sk *[ed25519.PrivateKeySize]byte, name string, profile *Profile, invite []byte) error
  • func (c *Client) VerifyConsensus(signedHashOfStateMsgs []*SignedServerMessage) (rootHash []byte, err error)
• type Config
• type Freshness
• type Server

Variables

var (
	ErrRegistrationDisabled = fmt.Errorf("registration disabled")
	ErrInviteInvalid        = fmt.Errorf("invite not valid")
	ErrInviteUsed           = fmt.Errorf("invite already used")
	ErrNotAuthorized        = fmt.Errorf("not authorized")
	ErrCouldntVerify        = fmt.Errorf("could not verify the correctness of the response")
)

var (
	DefaultServers   = map[string]*Server{"dename.mit.edu:8899": &Server{PublicKey: "CiCheFqDmJ0Pg+j+lypkmmiHrFmRn50rlDi5X0l4+lJRFA=="}}
	DefaultTimeout   = "10s"
	DefaultFreshness = Freshness{"60s", len(DefaultServers)}
	DefaultConfig    = Config{DefaultFreshness, DefaultServers}
	DefaultDialer    = proxy.FromEnvironment()
)

Functions

func FieldByName

func FieldByName(fieldName string) (fieldNumber int32, err error)

func GetProfileField

func GetProfileField(profile *Profile, field int32) ([]byte, error)

func MakeOperation

func MakeOperation(name string, profile *Profile) *SignedProfileOperation

Low-level convenience function to create a SignedProfileOperation with no signatures. You probably want to use Register, Modify or Transfer instead.

func NewProfile

func NewProfile(rnd io.Reader, expirationTime *time.Time) (profile *Profile,
	sk *[ed25519.PrivateKeySize]byte, err error)

func NewSign

func NewSign(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) *SignedProfileOperation

Gives the new owner's signature for op using sk

func OldSign

func OldSign(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) *SignedProfileOperation

Gives the old owner's signature for op using sk

func SetProfileField

func SetProfileField(profile *Profile, field int32, value []byte) error

func TransferProposal

func TransferProposal(sk *[ed25519.PrivateKeySize]byte, name string,
	profile *Profile) *SignedProfileOperation

Creates a signed operation structure to transfer name to profile. To make this change take effect, the recipient has to call AcceptTransfer with the secret key whose public counterpart is in profile.

func VerifyResolveAgainstRoot

func VerifyResolveAgainstRoot(rootHash []byte, name string, resolve []*ClientReply_MerklemapNode, testing ...testing.TB) (
	profile []byte, err error)

VerifyResolveAgainstRoot decodes a profile from a resolve structure and verifies that it is indeed a part of a mrklemap with rootHash. resolve contains nodes of a binary trie, except that each pointer has been replaced with a cryptographic hash of its target. As a binary trie lookup only uses nodes on one branch of the tree, all other nodes are omitted. Furthermore, hashes of nodes that /are/ present are implicit: if a node's child hash is nil, we can find it by hashing the next given node. This function assumes that the hash of the root has been authenticated externally and verifies that 1) all provided nodes indeed lie in their claimed positions in the trie by recomputing the hash of the root from the provided nodes and 2) that the parts of the trie contained in resolve unambiguously determine the result of the lookup of name by running the binary trie tree lookup algorithm on these nodes.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *Config, dialer proxy.Dialer, tlsConfig *tls.Config) (c *Client, err error)

func (*Client) AcceptTransfer

func (c *Client) AcceptTransfer(sk *[ed25519.PrivateKeySize]byte, op *SignedProfileOperation) error

AcceptTransfer uses the new secret key and the transfer operation generated using the old secret key to associate the op.Name with op.NewProfile.

func (*Client) Enact

func (c *Client) Enact(op *SignedProfileOperation, invite []byte) (err error)

Enact is a low-level function that completes an already complete profile operation at any known server. You probably want to use Register, Modify or Transfer instead.

func (*Client) Lookup

func (c *Client) Lookup(name string) (profile *Profile, err error)

Lookup retrieves the profile that corresponds to name from any server in the client's config. It is guaranteed that at least NumConfirmations of the servers have confirmed the correctness of the (name, profile) mapping and that Freshness.NumConfirmations have done this within Freshness.Threshold.

func (*Client) Modify

func (c *Client) Modify(sk *[ed25519.PrivateKeySize]byte, name string, profile *Profile) error

Modify uses a secret key to associate name with profile. The caller must ensure that profile.Version is strictly greater than the version of the currently registered profile; it is usually good practice to increase the version by exactly one.

func (*Client) Register

func (c *Client) Register(sk *[ed25519.PrivateKeySize]byte, name string, profile *Profile, invite []byte) error

Register associates a profile with a name. The invite is used to convince the server that we are indeed allowed a new name, it is not associated with the profile in any way. If profile.Version is set, it must be 0.

func (*Client) VerifyConsensus

func (c *Client) VerifyConsensus(signedHashOfStateMsgs []*SignedServerMessage) (
	rootHash []byte, err error)

VerifiyConsensus performs the low-level checks to see whether a set of statements made by the servers is sufficient to consider the state contained by them to be canonical.

type Config

type Config struct {
	Freshness Freshness
	Server    map[string]*Server
}

type Freshness

type Freshness struct {
	Threshold        string
	NumConfirmations int
}

type Server

type Server struct {
	PublicKey   string
	Timeout     string
	TLSCertFile string
}