session

package

Go to main page

Versions in this module

v0

v0.5.0

Oct 11, 2026

Changes in this version

type PeerHandshakeMessage

+ Cipher string

type Session

+ OwnNoQUIC bool

+ PeerDeclaredCipher bool

+ func (s *Session) PeerFingerprint() string

+ func (s *Session) SetExpectedPeerFingerprint(fp string)

v0.4.8

Sep 15, 2026

v0.4.7

Sep 10, 2026

Changes in this version

+ var ErrNoMixedAck = errors.New("peer did not take the direct leg")

type PeerHandshakeMessage

+ InboundBlocked bool

+ MixedLegs bool

type ReconnectManager

+ MixedLegs func() bool

+ func (r *ReconnectManager) LastTransport() string

type Session

+ OwnInboundBlocked bool

+ OwnMixedLegs bool

+ PeerInboundBlocked bool

+ PeerMixedLegs bool

v0.4.6

Sep 8, 2026

v0.4.5

Sep 6, 2026

v0.4.4

Sep 5, 2026

Changes in this version

+ const DirectDialTimeout

v0.4.3

Sep 4, 2026

v0.4.2

Aug 25, 2026

Changes in this version

+ func PerformInboundHandshakeWait(session *Session, conn net.Conn, firstByte time.Duration) error

type Session

+ func (s *Session) WireTotals() (bytesSent, bytesRecv uint64)

v0.4.1

Aug 16, 2026

Changes in this version

type ReconnectManager

+ PreferDirect func() bool

v0.4.0

Aug 6, 2026

Changes in this version

+ var ErrFoldNoClient = errors.New("no grpc client to initiate entropy fold")

+ var ErrFoldNotReady = errors.New("session not ready for entropy fold")

+ var ErrFoldWrongRole = errors.New("entropy fold: this peer initiates, it does not respond")

+ var RekeyTimeCadence = 60 * time.Second

+ func ApplyRekeyThresholdOverride(bytes, msgs uint64) (uint64, uint64)

+ func SetKeyUpdateEnabled(on bool)

type HealthMonitor

+ ExtraEpoch func() uint16

+ OnRekeyNeeded func() bool

+ RekeyEnabled bool

+ func (m *HealthMonitor) MaxWriterEpoch() uint16

type PeerHandshakeMessage

+ KeyUpdate bool

type SecureConn

+ func (s *SecureConn) SetKeyUpdate(on bool)

+ func (s *SecureConn) SetWriterEpochForTest(e uint16)

+ func (s *SecureConn) StageEntropyFold(secret []byte, isInitiator bool)

+ func (s *SecureConn) UsesKeyUpdate() bool

+ func (s *SecureConn) WriterEpoch() uint16

type Session

+ ExtraFoldConns func() []*SecureConn

+ PeerSupportsKeyUpdate bool

+ SEKInboundQUIC []byte

+ SEKOutboundQUIC []byte

+ func (s *Session) AdoptFoldCustody(c *SecureConn)

+ func (s *Session) ApplyKeyUpdateNegotiation()

+ func (s *Session) BothConns() (inbound, outbound *SecureConn)

+ func (s *Session) FoldSalt() ([]byte, error)

+ func (s *Session) InboundConn() *SecureConn

+ func (s *Session) InitiateFold(ctx context.Context) error

+ func (s *Session) InitiateFoldVia(ctx context.Context, client bindings.KeibiServiceClient) error

+ func (s *Session) IsFoldInitiator() bool

+ func (s *Session) NearEpochWrap() bool

+ func (s *Session) NegotiatedSuite() kbc.CipherSuite

+ func (s *Session) OutboundConn() *SecureConn

+ func (s *Session) RespondToFold(req *bindings.RekeyRequest) (*bindings.RekeyResponse, error)

+ func (s *Session) SetInboundConn(c *SecureConn)

+ func (s *Session) SetOutboundConn(c *SecureConn)

+ func (s *Session) UseKeyUpdate() bool

v0.3.6

Jun 28, 2026

v0.3.5

Jun 17, 2026

v0.3.4

Jun 7, 2026

v0.3.3

Jun 6, 2026

Changes in this version

type Session

+ func (s *Session) ResetInboundCrypto()

+ func (s *Session) ResetOutboundCrypto()

v0.3.2

May 31, 2026

v0.3.0

May 23, 2026

Changes in this version

+ const MaxSecureMessageSize

type HealthMonitor

+ func (m *HealthMonitor) TransferEnded()

+ func (m *HealthMonitor) TransferStarted()

v0.2.0

May 3, 2026

Changes in this version

type PeerHandshakeMessage

+ Persistent bool

type Session

+ OwnIsPersistent bool

+ PeerIsPersistent bool

+ func InitSessionWithKeys(logger *slog.Logger, keys *kbc.OwnKeys, defaultOutboundPort int, ...) (*Session, error)

v0.1.1

Apr 27, 2026

v0.1.0

Apr 25, 2026

Changes in this version

+ const NoncePrefixInbound

+ const NoncePrefixOutbound

+ const RekeyBytesThreshold

+ const RekeyMsgsThreshold

+ func ComputeFingerprintFromBase64Keys(pubKeys map[string]string) (string, error)

+ func CreateRekeyRequest(ownKeys *kbc.OwnKeys, peerKeys *kbc.PeerKeys, epoch uint64, ...) (*bindings.RekeyRequest, []byte, error)

+ func DialWithStableAddr(network, addr string, timeout time.Duration, logger *slog.Logger) (net.Conn, error)

+ func ExchangePublicKeysLocal(session *Session, conn net.Conn, isInitiator bool) error

+ func FinalizeInboundSession(session *Session, conn net.Conn, encSeeds map[string]string) error

+ func PerformInboundHandshake(session *Session, conn net.Conn) error

+ func PerformOutboundHandshake(session *Session, remoteAddr string) error

+ func PerformOutboundHandshakeOnConn(session *Session, conn net.Conn) error

+ func ProcessRekeyRequest(req *bindings.RekeyRequest, ownKeys *kbc.OwnKeys, peerKeys *kbc.PeerKeys, ...) (*bindings.RekeyResponse, []byte, error)

+ func ProcessRekeyResponse(resp *bindings.RekeyResponse, ownKeys *kbc.OwnKeys, peerKeys *kbc.PeerKeys, ...) ([]byte, error)

+ func StartListener(session *Session, port int) error

+ type ConnectionHealth int32

+ const HealthDegraded

+ const HealthDisconnected

+ const HealthHealthy

+ const HealthUnknown

+ func (h ConnectionHealth) String() string

+ type HealthMonitor struct

+ DegradedRTT time.Duration

+ Interval time.Duration

+ MaxFailures int

+ OnDisconnect func()

+ OnHealthChange func(old, new ConnectionHealth)

+ Timeout time.Duration

+ func NewHealthMonitor(session *Session, client bindings.KeibiServiceClient, logger *slog.Logger) *HealthMonitor

+ func (m *HealthMonitor) AvgRTT() time.Duration

+ func (m *HealthMonitor) Health() ConnectionHealth

+ func (m *HealthMonitor) LastRTT() time.Duration

+ func (m *HealthMonitor) Start()

+ func (m *HealthMonitor) Stop()

+ type PeerHandshakeMessage struct

+ EncSeeds map[string]string

+ Fingerprint string

+ OutboundPort int

+ PublicKeys map[string]string

+ SupportedCiphers []string

+ type ReconnectManager struct

+ AcceptConn func(timeout time.Duration) (net.Conn, error)

+ Backoff []time.Duration

+ BridgeAddr string

+ CachedPeerIP string

+ CachedPeerPort int

+ DialBridge func() (net.Conn, error)

+ MaxAttempts int

+ OnGaveUp func()

+ OnReconnected func()

+ OnReconnecting func()

+ RelayLookup func(fingerprint string) (ip string, port int, err error)

+ RelayRefresh func() error

+ func NewReconnectManager(session *Session, logger *slog.Logger) *ReconnectManager

+ func (r *ReconnectManager) Attempts() int

+ func (r *ReconnectManager) IsReconnectInitiator() bool

+ func (r *ReconnectManager) OnDisconnect()

+ func (r *ReconnectManager) Reset()

+ func (r *ReconnectManager) State() ReconnectState

+ func (r *ReconnectManager) Stop()

+ type ReconnectState int32

+ const ReconnectStateConnected

+ const ReconnectStateGaveUp

+ const ReconnectStateReconnecting

+ const ReconnectStateWaitingPeer

+ func (s ReconnectState) String() string

+ type SecureConn struct

+ func NewSecureConn(conn net.Conn, kek []byte, suite kbc.CipherSuite) *SecureConn

+ func (l *SecureConn) Addr() net.Addr

+ func (s *SecureConn) Accept() (net.Conn, error)

+ func (s *SecureConn) Close() error

+ func (s *SecureConn) GetEpoch() uint64

+ func (s *SecureConn) GetStats() (bytesSent, bytesRecv, msgsSent, msgsRecv uint64)

+ func (s *SecureConn) LocalAddr() net.Addr

+ func (s *SecureConn) Read(p []byte) (int, error)

+ func (s *SecureConn) ReadMessage() ([]byte, error)

+ func (s *SecureConn) RemoteAddr() net.Addr

+ func (s *SecureConn) ResetStats()

+ func (s *SecureConn) SetDeadline(t time.Time) error

+ func (s *SecureConn) SetReadDeadline(t time.Time) error

+ func (s *SecureConn) SetWriteDeadline(t time.Time) error

+ func (s *SecureConn) ShouldRekey() bool

+ func (s *SecureConn) UpdateKey(newKek []byte)

+ func (s *SecureConn) Write(p []byte) (int, error)

+ func (s *SecureConn) WriteMessage(msg []byte) error

+ type SecureReader struct

+ func NewSecureReader(r io.Reader, kek []byte, suite kbc.CipherSuite) *SecureReader

+ func (s *SecureReader) Read() ([]byte, error)

+ type SecureWriter struct

+ func NewSecureWriter(w io.Writer, kek []byte, suite kbc.CipherSuite) *SecureWriter

+ func NewSecureWriterWithPrefix(w io.Writer, kek []byte, suite kbc.CipherSuite, prefix uint32) *SecureWriter

+ func (s *SecureWriter) Write(p []byte) (int, error)

+ type Session struct

+ CipherMu sync.Mutex

+ CipherSuite kbc.CipherSuite

+ CurrentEpoch uint64

+ Deadline time.Time

+ DefaultInboundPort int

+ DefaultOutboundPort int

+ Err error

+ Established time.Time

+ ExpectedPeerFingerprint string

+ GRPCClient bindings.KeibiServiceClient

+ GRPCListener net.Listener

+ LastRekeyAt time.Time

+ OwnFingerprint string

+ OwnKeys *kbc.OwnKeys

+ PeerPort int

+ PeerPubKeys *kbc.PeerKeys

+ PendingNewKey []byte

+ RekeyMu sync.Mutex

+ RekeyPending bool

+ SEKInbound []byte

+ SEKOutbound []byte

+ Session *SessionSockets

+ State SessionState

+ func InitSession(logger *slog.Logger, defaultOutboundPort int, defaultInboundPort int) (*Session, error)

+ func NewSession(logger *slog.Logger, expectedFingerprint string, timeout time.Duration) *Session

+ func (s *Session) GetFingerPrint() string

+ func (s *Session) GetRekeyEpoch() uint64

+ func (s *Session) HandleRekeyRequest(req *bindings.RekeyRequest) (*bindings.RekeyResponse, error)

+ func (s *Session) HandleRekeyResponse(resp *bindings.RekeyResponse) error

+ func (s *Session) IsExpired() bool

+ func (s *Session) IsVerified() bool

+ func (s *Session) MarkError(err error)

+ func (s *Session) ReadyForEncryption() bool

+ func (s *Session) ShouldRekey() bool

+ func (s *Session) Transition(next SessionState) error

+ func (s *Session) ValidateExpired()

+ func (s *Session) ValidatePeer() error

+ func (s *Session) ValidateReady() error

+ type SessionSockets struct

+ Inbound *SecureConn

+ Outbound *SecureConn

+ func NewSessionSockets(connIn, connOut net.Conn, sekIn, sekOut []byte, suite kbc.CipherSuite) *SessionSockets

+ type SessionState string

+ const SessionInit

+ const SessionStateConnected

+ const SessionStateError

+ const SessionStateExpired

+ const SessionStatePending

+ const SessionStateVerified

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