psm

Documentation

Index

• Constants
• Variables
• func AddPSM(p *PSM) (err error)
• func AddRawPL(addr *endp.Addr, data []byte) (err error)
• func AddRep(p Rep) (err error)
• func Open(filename string) (err error)
• func RmPSM(p *PSM) (err error)
• func RmRawPL(addr *endp.Addr) (err error)
• type CreatorFunc
• type Factor
  • func (f *Factor) Add(t byte, factor CreatorFunc)
• type PSM
  • func FindPSM(k StateKey) (m *PSM, err error)
  • func GetPSM(k StateKey) (m *PSM, err error)
  • func NewPSM(d []byte) *PSM
  • func (p *PSM) Accept(state SubState) (yes bool)
  • func (p *PSM) Data() []byte
  • func (p *PSM) FirstState() *State
  • func (p *PSM) IsReady() bool
  • func (p *PSM) LastState() *State
  • func (p *PSM) Next() string
  • func (p *PSM) PendingUserAction() bool
  • func (p *PSM) PresentTask() (t comm.Task)
  • func (p *PSM) Protocol() string
  • func (p *PSM) Timestamp() int64
• type PayloadInfo
• type Rep
  • func GetRep(repType byte, k StateKey) (m Rep, err error)
• type State
• type StateKey
  • func NewStateKey(agent comm.Receiver, nonce string) StateKey
  • func (key StateKey) Data() []byte
  • func (key StateKey) String() string
• type SubState
  • func (ss SubState) IsReady() bool
  • func (ss SubState) Pure() SubState
  • func (ss SubState) String() string

Constants

const (
	BucketPSM byte = 0 + iota
	BucketRawPL
	BucketPairwise
	BucketBasicMessage
	BucketIssueCred
	BucketPresentProof
)

Variables

var Creator = &Factor{factors: make(map[byte]CreatorFunc)}

Functions

func AddPSM

func AddPSM(p *PSM) (err error)

func AddRawPL

func AddRawPL(addr *endp.Addr, data []byte) (err error)

func AddRep

func AddRep(p Rep) (err error)

func Open

func Open(filename string) (err error)

Open opens the database by name of the file. If it is already open it returns it, but it doesn't check the database name it isn't thread safe!

func RmPSM

func RmPSM(p *PSM) (err error)

func RmRawPL

func RmRawPL(addr *endp.Addr) (err error)

Types

type CreatorFunc

type CreatorFunc func(d []byte) (rep Rep)

type Factor

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

func (*Factor) Add

func (f *Factor) Add(t byte, factor CreatorFunc)

type PSM

type PSM struct {
	// Key is the primary key of the protocol state machine: it's pointed by
	// CA's DID and the current connection ID
	Key StateKey

	// StartedByUs tells if Our CA is the one who sent the first protocol msg.
	// It' false if we are the receving part. Please note that Role is a
	// protocol specific and not directly correlate with StartedByUs flag.
	StartedByUs bool

	// Role is a protocol role in the current DID protocol
	Role pb.Protocol_Role

	// ConnID stores connection ID.
	ConnID string

	// States has all ouf the state history of this PSM in timestamp order
	States []State
}

PSM is Protocol State Machine that works in event sourcing principle, i.e. every state transition is saved to its State field. Other fields are calculated ASAP and kept that way until to the end.

func FindPSM

func FindPSM(k StateKey) (m *PSM, err error)

FindPSM doesn't return error if the PSM doesn't exist. Instead the returned PSM is nil.

func GetPSM

func GetPSM(k StateKey) (m *PSM, err error)

GetPSM get existing PSM from DB. If the PSM doesn't exist it returns error. See FindPSM for version which doesn't return error if the PSM doesn't exist.

func NewPSM

func NewPSM(d []byte) *PSM

func (*PSM) Accept

func (p *PSM) Accept(state SubState) (yes bool)

Accept checks that state transition rules are followed.

func (*PSM) Data

func (p *PSM) Data() []byte

func (*PSM) FirstState

func (p *PSM) FirstState() *State

func (*PSM) IsReady

func (p *PSM) IsReady() bool

func (*PSM) LastState

func (p *PSM) LastState() *State

func (*PSM) Next

func (p *PSM) Next() string

Next is for getting the upcoming protocol message type. For example, if we are waiting a certain message from other end, we can check the message type with this function.

func (*PSM) PendingUserAction

func (p *PSM) PendingUserAction() bool

PendingUserAction returns true if we the PSM is waiting an user action msg.

func (*PSM) PresentTask

func (p *PSM) PresentTask() (t comm.Task)

PresentTask returns latest state's Task of the PSM.

func (*PSM) Protocol

func (p *PSM) Protocol() string

func (*PSM) Timestamp

func (p *PSM) Timestamp() int64

type PayloadInfo

type PayloadInfo struct {
	Type string
}

type Rep

type Rep interface {
	Key() StateKey
	Data() []byte
	Type() byte
}

func GetRep

func GetRep(repType byte, k StateKey) (m Rep, err error)

type State

type State struct {
	Timestamp int64
	T         comm.Task
	PLInfo    PayloadInfo
	Sub       SubState
}

todo: new idea StateEvent, rename atleast T

type StateKey

type StateKey struct {
	DID   string
	Nonce string
}

func NewStateKey

func NewStateKey(agent comm.Receiver, nonce string) StateKey

func (StateKey) Data

func (key StateKey) Data() []byte

func (StateKey) String

func (key StateKey) String() string

type SubState

type SubState uint // TODO: rename State or StateType

SubState is enumeration for the state transitions PSM will have during its execution. The above PUML diagram illustrates what transitions are currently recognized. The Ready state should have 2 internal states: ACK/NACK

const (
	ACK  SubState = 0x01 << iota // Sub sub state of Ready
	NACK                         // Sub sub state of Ready
	Waiting
	Received
	Decrypted
	Sending
	Ready
	Failure
	Archiving
	Archived
)

States of the PSM`s individual state can be.

const (
	ReadyACK  SubState = Ready | ACK
	ReadyNACK SubState = Ready | NACK
)

func (SubState) IsReady

func (ss SubState) IsReady() bool

func (SubState) Pure

func (ss SubState) Pure() SubState

func (SubState) String

func (ss SubState) String() string