protocol

type CallerType ¶

type CallerType uint8

const (
	UserType CallerType = iota
	NodeType
)

type EncryptedMessage ¶

type EncryptedMessage struct {
	Header     Header
	SessionKey []byte
	IV         []byte
	CipherText []byte
}

EncryptedMessage - this will be the "wrapper" to add encryption to the messages. The transport will pack the existing request/response into this encrypted message

func (em *EncryptedMessage) Validate() error

type Handler ¶

type Handler = func(ctx context.Context, r *Request) Response

Handler - This is what a server handler signature should be

type Header ¶

type Header struct {
	Key          models.Identifier
	From         models.Identifier
	FromAddr     string
	Type         CallerType
	PubKey       *rsa.PublicKey
	SignedBy     models.Identifier
	Signature    []byte
	DataLength   uint64
	ResourceName string
	Log          bool
	Clock        uint64
	Secret       []byte
	SharedWith   []SharedSecret
}

Header - protocol header, used in every message, contains the peerstore version, the key (if applicable), from and to nodes and the length of the data in the data section of the message.

func (h *Header) Validate() error

type NodeRegistrationResponse ¶

type NodeRegistrationResponse struct {
	Signature []byte
	SignedBy  models.Identifier
	Nodes     []models.Node
}

type Request ¶

type Request struct {
	Header Header
	Method RequestMethod
	Data   []byte
}

Request - the standard request, includes a header, method and data. The resource is defined in the header and the data length is defined in the header as well.

func (r *Request) Validate() error

type RequestMethod ¶

type RequestMethod uint64

RequestMethod - this is the indication of what request is to be performed.

const (
	// GetFileMethod - Get File Method to be used when getting files
	GetFileMethod RequestMethod = 1 << iota
	// PostFileMethod - Post File Method to be used when inserting or updating
	PostFileMethod
	// DeleteFileMethod - Delete File Method to be used when deleting files
	DeleteFileMethod
	// GetSuccessorMethod - Chord Method to get the successor
	GetSuccessorMethod
	// SetPredecessorMethod - Chord Method to set the predecessor
	SetPredecessorMethod
	// GetPredecessorMethod - Chord Method to get the predecessor
	GetPredecessorMethod
	// GetFingerTableMethod - Chord Method to get the finger table
	GetFingerTableMethod
	// UserRegistrationMethod - user registration methos
	UserRegistrationMethod
	// NodeRegistrationMethod - user registration methos
	NodeRegistrationMethod
	// NodeTrustMethod - user registration methos
	NodeTrustMethod
	GetPublicKeyMethod
	PostPublicKeyMethod
)

type Response ¶

type Response struct {
	Header Header
	Status ResponseStatus
	Data   []byte
}

Response - the response structure for any given request

func (r *Response) Validate() error

type ResponseStatus ¶

type ResponseStatus int64

ResponseStatus - the type which indicates the response status for a request

const (
	// Success - the message request was successful
	Success ResponseStatus = 1 << iota
	// Error - the message request was not successful
	Error
)

type RoundTripper ¶

type RoundTripper interface {
	RoundTrip(*Request) (Response, error)
}

RoundTripper - interface which will perform the request, and return the Response

type Server ¶

type Server struct {
	PrivateKey *rsa.PrivateKey
	// contains filtered or unexported fields
}

Server - base server type, contains a listener to listen for sockets

func NewServer(key *rsa.PrivateKey, peer models.Node, address, dataPath string, bufferSize, numWorkers uint) (*Server, error)

func (s *Server) Handle(method RequestMethod, fn Handler)

func (s *Server) NodeRegistrationHandler(ctx context.Context, r *Request) Response

func (s *Server) NodeTrustHandler(ctx context.Context, r *Request) Response

func (s *Server) Serve(q chan bool, done chan bool)

func (s *Server) UserRegistrationHandler(ctx context.Context, r *Request) Response

type SharedSecret ¶

type SharedSecret struct {
	ID     models.Identifier
	Secret []byte
}

type Transport ¶

type Transport struct {
	Type CallerType
	// contains filtered or unexported fields
}

Transport - a transport structure that will implement RoundTripper transport will also handle all encryption/decryption of the messages

func NewTransport(proto, addr string, t CallerType, id models.Identifier, peerKey *rsa.PublicKey, selfKey *rsa.PrivateKey) (*Transport, error)

func (t *Transport) Close()

func (t *Transport) RoundTrip(request *Request) (Response, error)