protocol

package

Go to main page

Versions in this module

v0

v0.3.0

Jul 13, 2026

v0.2.9

Jun 28, 2026

v0.2.8

Jun 3, 2026

v0.2.7

May 30, 2026

v0.2.6

May 24, 2026

v0.2.5

May 18, 2026

v0.2.4

May 17, 2026

Changes in this version

+ const MagicMailboxFrame

+ const MsgDHTPush

+ const MsgDHTPushACK

+ func EncodeSignedRecord(sr SignedRecord) ([]byte, error)

+ func ReadMailboxFrameBody(r io.Reader) ([32]byte, []byte, error)

+ func WriteMailboxFrame(w io.Writer, msgID [32]byte, recordCBOR []byte) error

+ type BodyDHTPush struct

+ Key []byte

+ Record SignedRecord

+ type BodyDHTPushACK struct

+ Key []byte

+ MsgID []byte

+ OneShotSubscribe bool

type BodyFindValue

+ OneShotSubscribe bool

+ type MailboxFrame struct

+ MsgID [32]byte

+ Record SignedRecord

type SignedRecord

+ func DecodeSignedRecord(data []byte) (SignedRecord, error)

v0.2.3

May 16, 2026

v0.2.2

May 12, 2026

v0.2.1

May 10, 2026

v0.2.0

May 7, 2026

Changes in this version

+ const AgentProfilePayloadMaxSize

+ const AgentProfilePayloadWarnSize

+ const RecTypeAgentProfile

+ var ErrPayloadApproachingLimit = errors.New("a2al/protocol: payload approaching size limit")

+ func MarshalAgentProfilePayload(p AgentProfilePayload) ([]byte, error)

+ type AgentProfilePayload struct

+ Brief string

+ CardHash []byte

+ Meta map[string]any

+ Modalities []string

+ Name string

+ Protocols []string

+ Skills []string

+ Version uint8

+ func ParseAgentProfilePayload(sr SignedRecord) (AgentProfilePayload, error)

v0.1.9

May 3, 2026

v0.1.8

May 2, 2026

Changes in this version

type BodyStoreResp

+ AlreadyHad bool

+ Reason StoreReason

+ type StoreReason uint8

+ const StoreReasonOK

+ const StoreReasonPolicy

+ const StoreReasonRecordInvalid

v0.1.7

Apr 23, 2026

v0.1.6

Apr 19, 2026

Changes in this version

type MailboxMessage

+ SenderPubkey ed25519.PublicKey

v0.1.5

Apr 18, 2026

v0.1.4

Apr 17, 2026

Changes in this version

+ const MaxSignalURLs

+ const MsgNATProbeEcho

+ const MsgNATProbeReq

+ func IsPublicIP(ip net.IP) bool

+ type BodyNATProbeEcho struct

+ Token []byte

+ type BodyNATProbeReq struct

+ ClaimedAddr []byte

+ Token []byte

type EndpointPayload

+ Signals []string

type EndpointRecord

+ Signals []string

v0.1.3

Apr 15, 2026

v0.1.2

Apr 6, 2026

Changes in this version

+ const CategoryMailbox

+ const CategorySovereign

+ const CategoryTopic

+ const CategoryUnknown

+ const DefaultMailboxTTL

+ const MailboxMsgCandidates

+ const MailboxMsgConnectRequest

+ const MailboxMsgText

+ const MaxEndpointSignalURLLen

+ const MaxMailboxPayloadCBOR

+ const MaxTopicBriefRunes

+ const MaxTopicPayloadCBOR

+ const MaxTurnURLEntryLen

+ const MaxTurnURLs

+ const MsgFindNode

+ const MsgFindNodeResp

+ const MsgFindValue

+ const MsgFindValueResp

+ const MsgPing

+ const MsgPong

+ const MsgStore

+ const MsgStoreResp

+ const NATFullCone

+ const NATPortRestricted

+ const NATRestricted

+ const NATSymmetric

+ const NATUnknown

+ const ProtocolVersion

+ const RecTypeEndpoint

+ const RecTypeMailbox

+ const RecTypeTopic

+ var ErrInvalidMessage = errors.New("a2al/protocol: invalid message")

+ var ErrInvalidRecord = errors.New("a2al/protocol: invalid record")

+ var ErrRecordExpired = errors.New("a2al/protocol: record expired")

+ var ErrUnknownMsgType = errors.New("a2al/protocol: unknown msg_type")

+ func EncodeMailboxPayload(senderAddr, recipientAddr a2al.Address, recipientPub ed25519.PublicKey, ...) ([]byte, error)

+ func FindNodeResponseWireSize(resp *BodyFindNodeResp) (int, error)

+ func FindValueResponseWireSize(resp *BodyFindValueResp) (int, error)

+ func FormatObservedUDP(ip net.IP, port uint16) ([]byte, error)

+ func MarshalSignedMessage(hdr Header, body any, priv ed25519.PrivateKey) ([]byte, error)

+ func MarshalSignedMessageKeyStore(hdr Header, body any, ks acrypto.KeyStore, addr a2al.Address) ([]byte, error)

+ func MarshalTopicPayload(p TopicPayload) ([]byte, error)

+ func ParseObservedUDP(b []byte) (host string, port uint16, ok bool)

+ func RecordCategory(recType uint8) uint8

+ func RecordIsNewer(a, b SignedRecord) bool

+ func TopicNodeID(topic string) a2al.NodeID

+ func VerifySignedRecord(sr SignedRecord, now time.Time) error

+ type BodyFindNode struct

+ Target []byte

+ type BodyFindNodeResp struct

+ Nodes []NodeInfo

+ ObservedAddr []byte

+ type BodyFindValue struct

+ RecType uint8

+ Target []byte

+ type BodyFindValueResp struct

+ Nodes []NodeInfo

+ ObservedAddr []byte

+ Record *SignedRecord

+ Records []SignedRecord

+ type BodyPing struct

+ Address []byte

+ type BodyPong struct

+ Address []byte

+ ObservedAddr []byte

+ type BodyStore struct

+ Key []byte

+ Record SignedRecord

+ type BodyStoreResp struct

+ Stored bool

+ type DecodedMessage struct

+ Body any

+ Header Header

+ SenderAddr a2al.Address

+ SenderPubkey ed25519.PublicKey

+ func VerifyAndDecode(raw []byte) (*DecodedMessage, error)

+ type DiscoverFilter struct

+ Protocols []string

+ Tags []string

+ type EndpointPayload struct

+ Endpoints []string

+ NatType uint8

+ Signal string

+ Turns []string

+ type EndpointRecord struct

+ Address a2al.Address

+ Endpoints []string

+ NatType uint8

+ Seq uint64

+ Signal string

+ TTL uint32

+ Timestamp uint64

+ Turns []string

+ func ParseEndpointRecord(sr SignedRecord) (EndpointRecord, error)

+ type Header struct

+ Features uint16

+ MsgType uint8

+ TxID []byte

+ Version uint8

+ type MailboxMessage struct

+ Body []byte

+ MsgType uint8

+ Sender a2al.Address

+ Seq uint64

+ func OpenMailboxRecord(recipientPriv ed25519.PrivateKey, recipientAddr a2al.Address, sr SignedRecord) (MailboxMessage, error)

+ type MailboxPayload struct

+ Ciphertext []byte

+ EphemeralPK []byte

+ Nonce []byte

+ Recipient []byte

+ SenderAddr []byte

+ type NodeInfo struct

+ Address []byte

+ IP []byte

+ NodeID []byte

+ Port uint16

+ type SignedRecord struct

+ Address []byte

+ Delegation []byte

+ Payload []byte

+ Pubkey []byte

+ RecType uint8

+ Seq uint64

+ Signature []byte

+ TTL uint32

+ Timestamp uint64

+ func SignEndpointRecord(priv ed25519.PrivateKey, addr a2al.Address, ep EndpointPayload, ...) (SignedRecord, error)

+ func SignEndpointRecordDelegated(opPriv ed25519.PrivateKey, delegationCBOR []byte, addr a2al.Address, ...) (SignedRecord, error)

+ func SignRecord(priv ed25519.PrivateKey, addr a2al.Address, recType uint8, payload []byte, ...) (SignedRecord, error)

+ func SignRecordDelegated(opPriv ed25519.PrivateKey, delegationCBOR []byte, addr a2al.Address, ...) (SignedRecord, error)

+ type TopicEntry struct

+ Address a2al.Address

+ Brief string

+ Meta map[string]any

+ Name string

+ Protocols []string

+ Seq uint64

+ TTL uint32

+ Tags []string

+ Timestamp uint64

+ Topic string

+ Version uint8

+ func FilterTopicEntries(in []TopicEntry, f *DiscoverFilter) []TopicEntry

+ func TopicEntryFromSignedRecord(sr SignedRecord) (TopicEntry, error)

+ type TopicPayload struct

+ Brief string

+ Meta map[string]any

+ Name string

+ Protocols []string

+ Tags []string

+ Topic string

+ Version uint8

+ func ParseTopicRecord(sr SignedRecord) (TopicPayload, error)

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