reality

package module

Go to main page

Versions in this module

v0

v0.5.5

Jul 11, 2026

Changes in this version

+ const DefaultAmortizeMode

+ const MaxL2FailWindow

+ const MinL2Evidence

+ func CacheKeyV2(dest, serverName, alpn string, tlsVersion uint16, chClass string) string

+ func ClassifyClientHello(ch *clientHelloMsg) string

+ func EnsureServerHelloTemplateFromRecord(r0 []byte) []byte

+ func IsLegacyCacheKey(key string) bool

+ func ParseCacheKeyV2(key string) (dest, serverName, alpn string, tlsVersion uint16, chClass string, ok bool)

+ func WriteAll(w io.Writer, b []byte) error

+ type AmortizeMode int

+ const AmortizeAuto

+ const AmortizeDefault

+ const AmortizeL0

+ const AmortizeL1

+ const AmortizeL2

+ func ResolveAmortizeMode(mode AmortizeMode) AmortizeMode

+ type AmortizePath int

+ const PathL0

+ const PathL1

+ const PathL2

+ func (p AmortizePath) String() string

type CacheManager

+ func (m *CacheManager) InvalidateKey(key string)

+ func (m *CacheManager) LookupAmortize(mode AmortizeMode, dest, serverName, alpn string, tlsVersion uint16, ...) LookupResult

+ func (m *CacheManager) NoteHandshakeFailure(key string, path AmortizePath)

+ func (m *CacheManager) Quarantine(key, reason string)

+ func (m *CacheManager) StoreObservation(key string, obs *RealityProfile)

type CacheManagerStats

+ L1Hits atomic.Uint64

+ L2Fails atomic.Uint64

+ L2Hits atomic.Uint64

+ Quarantines atomic.Uint64

type Config

+ AmortizeMode AmortizeMode

+ type LookupResult struct

+ Key string

+ Path AmortizePath

+ Profile *RealityProfile

+ Stale bool

type ProfileState

+ const ProfileQuarantined

+ const ProfileSuspect

type RealityProfile

+ AcceptsHRR bool

+ CHClass string

+ Dest string

+ Evidence int

+ KeyShareGroup CurveID

+ ServerHelloTemplate []byte

+ ServerName string

+ ShapeHash uint64

+ Source string

+ Stability int

v0.5.1

Jul 7, 2026

Changes in this version

type CacheManager

+ func (m *CacheManager) FindFullCachedProfile(dest, serverName string, cipherSuites []uint16, alpn string) *RealityProfile

+ func (m *CacheManager) InvalidateAll()

v0.5.0

Jul 5, 2026

v0.4.4

Jul 4, 2026

Changes in this version

type RealityProfile

+ R0Hash uint64

v0.4.3

Jul 3, 2026

Changes in this version

type CacheManager

+ func (m *CacheManager) FindCachedProfile(serverName string, cipherSuite uint16, alpn string, tlsVersion uint16) (lens [7]int, foundTLSVersion uint16, ok bool)

+ func (m *CacheManager) InvalidateByServerName(serverName, dest, alpn string)

v0.4.2

Jul 1, 2026

v0.4.1

Jul 1, 2026

Changes in this version

type CacheManager

+ func (m *CacheManager) CheckConsistency() []string

+ func (m *CacheManager) GetOrProbeForHandshake(ctx context.Context, key, dest, serverName string, alpn int) (*RealityProfile, error)

+ func (m *CacheManager) InvalidateAndReprobe(dest, serverName, alpn string)

type CacheManagerStats

+ ProbeAttempts atomic.Uint64

+ ProbeSuccesses atomic.Uint64

+ type ProbeResult struct

+ CipherSuite uint16

+ RecordCount int

+ RecordLens [7]int

+ func ProbeTargetViaUTLS(ctx context.Context, dest, serverName string, alpn int, xver byte) (*ProbeResult, error)

+ type ReplayGuard struct

+ func NewReplayGuard(window time.Duration, maxEntries int) *ReplayGuard

+ func (g *ReplayGuard) CheckAndMark(randomPrefix [20]byte) bool

+ func (g *ReplayGuard) Stop()

v0.4.0

Jun 29, 2026

v0.3.0

Jun 29, 2026

Changes in this version

type CacheManager

+ func (m *CacheManager) InvalidateByDest(dest string)

v0.2.0

Jun 29, 2026

Changes in this version

+ const ProfileTTL

+ func CacheKey(dest, serverName, alpn string, tlsVersion uint16) string

+ func CacheKeyFromProfile(dest, serverName string, p *RealityProfile) string

+ func DefaultCacheDir() string

+ func DestFromKey(key string) string

+ func FormatRefreshStats() string

+ func ParseCacheKey(key string) (dest, serverName, alpn string, tlsVersion uint16)

+ func RegisterAllHandlers(show bool)

+ func RegisterCacheHandlers(bus *EventBus)

+ func RegisterDiagnosticsHandlers(bus *EventBus, show bool)

+ func RegisterPersistHandlers(bus *EventBus)

+ func RegisterRefreshHandlers(bus *EventBus)

+ func ResetGlobalRefreshManagerForTesting()

+ func StartBackgroundRefreshForProfile(dest, serverName, alpn string)

+ func StopBackgroundRefreshForProfile(dest, serverName, alpn string)

+ func ValidateRecordLens(lens [7]int) bool

+ func WarmupProfiles(dir string)

+ type CacheManager struct

+ func NewCacheManager() *CacheManager

+ func (m *CacheManager) CacheReport() string

+ func (m *CacheManager) ClearDirty()

+ func (m *CacheManager) DoProbe(key string, fn func() (*RealityProfile, error)) (*RealityProfile, error)

+ func (m *CacheManager) FindCachedProfileByDest(dest string, cipherSuite uint16, alpn string, tlsVersion uint16) (lens [7]int, foundTLSVersion uint16, ok bool)

+ func (m *CacheManager) GetProfile(key string) (*RealityProfile, bool)

+ func (m *CacheManager) GetProfileOrExpired(key string) *RealityProfile

+ func (m *CacheManager) HotSwapProfile(key string, newProfile *RealityProfile)

+ func (m *CacheManager) InvalidateFingerprint()

+ func (m *CacheManager) InvalidateProfile(key string)

+ func (m *CacheManager) IsDirty() bool

+ func (m *CacheManager) MarkNegative(key string)

+ func (m *CacheManager) MarkStale(key string)

+ func (m *CacheManager) Reset()

+ func (m *CacheManager) SnapshotProfiles() map[string]*RealityProfile

+ func (m *CacheManager) StoreFingerprint(key string, fp *targetFingerprintCache)

+ func (m *CacheManager) StoreProfile(key string, profile *RealityProfile) bool

+ type CacheManagerStats struct

+ FingerprintChanged atomic.Uint64

+ HotSwaps atomic.Uint64

+ NegativeHits atomic.Int64

+ ProfileEntries atomic.Int64

+ ProfileInvalidated atomic.Uint64

+ StaleServed atomic.Int64

type Config

+ CacheDir string

+ type Event struct

+ ALPN string

+ Dest string

+ Fingerprint *targetFingerprintCache

+ Profile *RealityProfile

+ ServerName string

+ TLSVersion uint16

+ Type EventType

+ type EventBus struct

+ func (b *EventBus) Emit(event Event)

+ func (b *EventBus) On(eventType EventType, handler EventHandler)

+ func (b *EventBus) Reset()

+ type EventHandler func(event Event)

+ type EventType int

+ const EventConnectionClosed

+ const EventHandshakeComplete

+ type PersistProfileEntry struct

+ ALPN string

+ CapturedAt int64

+ CipherSuite uint16

+ Fingerprint uint64

+ RecordCount int

+ RecordLens [7]int

+ TLSVersion uint16

+ type PersistentProfileStore struct

+ func InitPersistentStore(dir string) *PersistentProfileStore

+ func (s *PersistentProfileStore) Enabled() bool

+ func (s *PersistentProfileStore) GetFilePath() string

+ func (s *PersistentProfileStore) Save()

+ func (s *PersistentProfileStore) SaveOnShutdown()

+ func (s *PersistentProfileStore) StartPeriodicSave(interval time.Duration)

+ func (s *PersistentProfileStore) StopPeriodicSave()

+ type ProfileEntry struct

+ FailCount int

+ NextRetry time.Time

+ Profile *RealityProfile

+ StabilityScore int

+ State ProfileState

+ TTL time.Duration

+ type ProfileFile struct

+ Profiles map[string]*PersistProfileEntry

+ SavedAt time.Time

+ Version int

+ type ProfileState int

+ const ProfileNegative

+ const ProfileStale

+ const ProfileValid

+ type RealityProfile struct

+ ALPN string

+ CapturedAt time.Time

+ CipherSuite uint16

+ Fingerprint uint64

+ RecordCount int

+ RecordLens [7]int

+ TLSVersion uint16

+ func (p *RealityProfile) IsExpired() bool

+ type RefreshManager struct

+ func GetRefreshManager() *RefreshManager

+ func (m *RefreshManager) AddTarget(dest, serverName, alpn string)

+ func (m *RefreshManager) FormatStats() string

+ func (m *RefreshManager) GetStats() (activeTargets int)

+ func (m *RefreshManager) RemoveTarget(dest, serverName, alpn string)

+ func (m *RefreshManager) ResetForTesting()

+ func (m *RefreshManager) Start()

+ func (m *RefreshManager) Stop()

v0.1.1

Jun 24, 2026

Changes in this version

+ const QUICEncryptionLevelApplication

+ const QUICEncryptionLevelEarly

+ const QUICEncryptionLevelHandshake

+ const QUICEncryptionLevelInitial

+ const TLS_AES_128_GCM_SHA256

+ const TLS_AES_256_GCM_SHA384

+ const TLS_CHACHA20_POLY1305_SHA256

+ const TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA

+ const TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

+ const TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

+ const TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA

+ const TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

+ const TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305

+ const TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256

+ const TLS_ECDHE_ECDSA_WITH_RC4_128_SHA

+ const TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA

+ const TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

+ const TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

+ const TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

+ const TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

+ const TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

+ const TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305

+ const TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256

+ const TLS_ECDHE_RSA_WITH_RC4_128_SHA

+ const TLS_FALLBACK_SCSV

+ const TLS_RSA_WITH_3DES_EDE_CBC_SHA

+ const TLS_RSA_WITH_AES_128_CBC_SHA

+ const TLS_RSA_WITH_AES_128_CBC_SHA256

+ const TLS_RSA_WITH_AES_128_GCM_SHA256

+ const TLS_RSA_WITH_AES_256_CBC_SHA

+ const TLS_RSA_WITH_AES_256_GCM_SHA384

+ const TLS_RSA_WITH_RC4_128_SHA

+ const VersionSSL30

+ const VersionTLS10

+ const VersionTLS11

+ const VersionTLS12

+ const VersionTLS13

+ var CCSMsg = []byte

+ var GlobalMaxCSSMsgCount sync.Map

+ var GlobalPostHandshakeRecordsLens sync.Map

+ func CipherSuiteName(id uint16) string

+ func DetectPostHandshakeRecordsLens(config *Config)

+ func Listen(network, laddr string, config *Config) (net.Listener, error)

+ func NewListener(inner net.Listener, config *Config) net.Listener

+ func NewRatelimitedConn(conn net.Conn, limit *LimitFallback) net.Conn

+ func ProbeTarget(ctx context.Context, config *Config) error

+ func StopAutoProbe(dest string)

+ func Value(vals ...byte) (value int)

+ func VersionName(version uint16) string

+ type AlertError uint8

+ func (e AlertError) Error() string

+ type CCSDetectConn struct

+ Key string

+ func (c *CCSDetectConn) Write(b []byte) (n int, err error)

+ type Certificate struct

+ Certificate [][]byte

+ Leaf *x509.Certificate

+ OCSPStaple []byte

+ PrivateKey crypto.PrivateKey

+ SignedCertificateTimestamps [][]byte

+ SupportedSignatureAlgorithms []SignatureScheme

+ func LoadX509KeyPair(certFile, keyFile string) (Certificate, error)

+ func X509KeyPair(certPEMBlock, keyPEMBlock []byte) (Certificate, error)

+ type CertificateRequestInfo struct

+ AcceptableCAs [][]byte

+ SignatureSchemes []SignatureScheme

+ Version uint16

+ func (c *CertificateRequestInfo) Context() context.Context

+ func (cri *CertificateRequestInfo) SupportsCertificate(c *Certificate) error

+ type CertificateVerificationError struct

+ Err error

+ UnverifiedCertificates []*x509.Certificate

+ func (e *CertificateVerificationError) Error() string

+ func (e *CertificateVerificationError) Unwrap() error

+ type CipherSuite struct

+ ID uint16

+ Insecure bool

+ Name string

+ SupportedVersions []uint16

+ func CipherSuites() []*CipherSuite

+ func InsecureCipherSuites() []*CipherSuite

+ type ClientAuthType int

+ const NoClientCert

+ const RequestClientCert

+ const RequireAndVerifyClientCert

+ const RequireAnyClientCert

+ const VerifyClientCertIfGiven

+ func (i ClientAuthType) String() string

+ type ClientHelloInfo struct

+ CipherSuites []uint16

+ Conn net.Conn

+ Extensions []uint16

+ ServerName string

+ SignatureSchemes []SignatureScheme

+ SupportedCurves []CurveID

+ SupportedPoints []uint8

+ SupportedProtos []string

+ SupportedVersions []uint16

+ func (c *ClientHelloInfo) Context() context.Context

+ func (chi *ClientHelloInfo) SupportsCertificate(c *Certificate) error

+ type ClientSessionCache interface

+ Get func(sessionKey string) (session *ClientSessionState, ok bool)

+ Put func(sessionKey string, cs *ClientSessionState)

+ func NewLRUClientSessionCache(capacity int) ClientSessionCache

+ type ClientSessionState struct

+ func NewResumptionState(ticket []byte, state *SessionState) (*ClientSessionState, error)

+ func (cs *ClientSessionState) ResumptionState() (ticket []byte, state *SessionState, err error)

+ type CloseWriteConn interface

+ CloseWrite func() error

+ type Config struct

+ Certificates []Certificate

+ CipherSuites []uint16

+ ClientAuth ClientAuthType

+ ClientCAs *x509.CertPool

+ ClientSessionCache ClientSessionCache

+ CurvePreferences []CurveID

+ Dest string

+ DialContext func(ctx context.Context, network, address string) (net.Conn, error)

+ DynamicRecordSizingDisabled bool

+ EncryptedClientHelloConfigList []byte

+ EncryptedClientHelloKeys []EncryptedClientHelloKey

+ EncryptedClientHelloRejectionVerify func(ConnectionState) error

+ GetCertificate func(*ClientHelloInfo) (*Certificate, error)

+ GetClientCertificate func(*CertificateRequestInfo) (*Certificate, error)

+ GetConfigForClient func(*ClientHelloInfo) (*Config, error)

+ GetEncryptedClientHelloKeys func(*ClientHelloInfo) ([]EncryptedClientHelloKey, error)

+ InsecureSkipVerify bool

+ KeyLogWriter io.Writer

+ LimitFallbackDownload LimitFallback

+ LimitFallbackUpload LimitFallback

+ MaxClientVer []byte

+ MaxTimeDiff time.Duration

+ MaxVersion uint16

+ MinClientVer []byte

+ MinVersion uint16

+ Mldsa65Key []byte

+ NameToCertificate map[string]*Certificate

+ NextProtos []string

+ PreferServerCipherSuites bool

+ PrivateKey []byte

+ Rand io.Reader

+ Renegotiation RenegotiationSupport

+ RootCAs *x509.CertPool

+ ServerName string

+ ServerNames map[string]bool

+ SessionTicketKey [32]byte

+ SessionTicketsDisabled bool

+ ShortIds map[[8]byte]bool

+ Show bool

+ Time func() time.Time

+ Type string

+ UnwrapSession func(identity []byte, cs ConnectionState) (*SessionState, error)

+ VerifyConnection func(ConnectionState) error

+ VerifyPeerCertificate func(rawCerts [][]byte, verifiedChains [][]*x509.Certificate) error

+ WrapSession func(ConnectionState, *SessionState) ([]byte, error)

+ Xver byte

+ func (c *Config) BuildNameToCertificate()

+ func (c *Config) Clone() *Config

+ func (c *Config) DecryptTicket(identity []byte, cs ConnectionState) (*SessionState, error)

+ func (c *Config) EncryptTicket(cs ConnectionState, ss *SessionState) ([]byte, error)

+ func (c *Config) SetSessionTicketKeys(keys [][32]byte)

+ type Conn struct

+ AuthKey []byte

+ ClientShortId [8]byte

+ ClientTime time.Time

+ ClientVer [3]byte

+ MaxUselessRecords int

+ func Client(conn net.Conn, config *Config) *Conn

+ func Dial(network, addr string, config *Config) (*Conn, error)

+ func DialWithDialer(dialer *net.Dialer, network, addr string, config *Config) (*Conn, error)

+ func Server(ctx context.Context, conn net.Conn, config *Config) (*Conn, error)

+ func (c *Conn) Close() error

+ func (c *Conn) CloseWrite() error

+ func (c *Conn) ConnectionState() ConnectionState

+ func (c *Conn) Handshake() error

+ func (c *Conn) HandshakeContext(ctx context.Context) error

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) NetConn() net.Conn

+ func (c *Conn) OCSPResponse() []byte

+ func (c *Conn) Read(b []byte) (int, error)

+ func (c *Conn) RemoteAddr() net.Addr

+ func (c *Conn) SetDeadline(t time.Time) error

+ func (c *Conn) SetReadDeadline(t time.Time) error

+ func (c *Conn) SetWriteDeadline(t time.Time) error

+ func (c *Conn) VerifyHostname(host string) error

+ func (c *Conn) Write(b []byte) (int, error)

+ type ConnectionState struct

+ CipherSuite uint16

+ CurveID CurveID

+ DidResume bool

+ ECHAccepted bool

+ HandshakeComplete bool

+ NegotiatedProtocol string

+ NegotiatedProtocolIsMutual bool

+ OCSPResponse []byte

+ PeerCertificates []*x509.Certificate

+ ServerName string

+ SignedCertificateTimestamps [][]byte

+ TLSUnique []byte

+ VerifiedChains [][]*x509.Certificate

+ Version uint16

+ func (cs *ConnectionState) ExportKeyingMaterial(label string, context []byte, length int) ([]byte, error)

+ type CurveID uint16

+ const CurveP256

+ const CurveP384

+ const CurveP521

+ const X25519

+ const X25519MLKEM768

+ func (i CurveID) String() string

+ type Dialer struct

+ Config *Config

+ NetDialer *net.Dialer

+ func (d *Dialer) Dial(network, addr string) (net.Conn, error)

+ func (d *Dialer) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

+ type ECHRejectionError struct

+ RetryConfigList []byte

+ func (e *ECHRejectionError) Error() string

+ type EchCipher struct

+ AEADID uint16

+ KDFID uint16

+ type EchConfig struct

+ ConfigID uint8

+ Extensions []echExtension

+ KemID uint16

+ Length uint16

+ MaxNameLength uint8

+ PublicKey []byte

+ PublicName []byte

+ SymmetricCipherSuite []EchCipher

+ Version uint16

+ type EncryptedClientHelloKey struct

+ Config []byte

+ PrivateKey []byte

+ SendAsRetry bool

+ type LimitFallback struct

+ AfterBytes uint64

+ BurstBytesPerSec uint64

+ BytesPerSec uint64

+ type MirrorConn struct

+ Target net.Conn

+ func (c *MirrorConn) Close() error

+ func (c *MirrorConn) Read(b []byte) (int, error)

+ func (c *MirrorConn) SetDeadline(t time.Time) error

+ func (c *MirrorConn) SetReadDeadline(t time.Time) error

+ func (c *MirrorConn) SetWriteDeadline(t time.Time) error

+ func (c *MirrorConn) Write(b []byte) (int, error)

+ type PostHandshakeRecordDetectConn struct

+ CcsSent bool

+ Key string

+ func (c *PostHandshakeRecordDetectConn) Read(b []byte) (n int, err error)

+ func (c *PostHandshakeRecordDetectConn) Write(b []byte) (n int, err error)

+ type PrebuildCache struct

+ func NewPrebuildCache(ttl time.Duration, capacity int) *PrebuildCache

+ func (pc *PrebuildCache) Get(serverName string) *TargetProfile

+ func (pc *PrebuildCache) Len() int

+ func (pc *PrebuildCache) Store(serverName string, p *TargetProfile)

+ type QUICConfig struct

+ EnableSessionEvents bool

+ TLSConfig *Config

+ type QUICConn struct

+ func QUICClient(config *QUICConfig) *QUICConn

+ func QUICServer(config *QUICConfig) *QUICConn

+ func (q *QUICConn) Close() error

+ func (q *QUICConn) ConnectionState() ConnectionState

+ func (q *QUICConn) HandleData(level QUICEncryptionLevel, data []byte) error

+ func (q *QUICConn) NextEvent() QUICEvent

+ func (q *QUICConn) SendSessionTicket(opts QUICSessionTicketOptions) error

+ func (q *QUICConn) SetTransportParameters(params []byte)

+ func (q *QUICConn) Start(ctx context.Context) error

+ func (q *QUICConn) StoreSession(session *SessionState) error

+ type QUICEncryptionLevel int

+ func (l QUICEncryptionLevel) String() string

+ type QUICEvent struct

+ Data []byte

+ Kind QUICEventKind

+ Level QUICEncryptionLevel

+ SessionState *SessionState

+ Suite uint16

+ type QUICEventKind int

+ const QUICHandshakeDone

+ const QUICNoEvent

+ const QUICRejectedEarlyData

+ const QUICResumeSession

+ const QUICSetReadSecret

+ const QUICSetWriteSecret

+ const QUICStoreSession

+ const QUICTransportParameters

+ const QUICTransportParametersRequired

+ const QUICWriteData

+ type QUICSessionTicketOptions struct

+ EarlyData bool

+ Extra [][]byte

+ type RatelimitedConn struct

+ After int64

+ Bucket *ratelimit.Bucket

+ func (c *RatelimitedConn) Read(b []byte) (int, error)

+ type RecordHeaderError struct

+ Conn net.Conn

+ Msg string

+ RecordHeader [5]byte

+ func (e RecordHeaderError) Error() string

+ type RenegotiationSupport int

+ const RenegotiateFreelyAsClient

+ const RenegotiateNever

+ const RenegotiateOnceAsClient

+ type SessionState struct

+ EarlyData bool

+ Extra [][]byte

+ func ParseSessionState(data []byte) (*SessionState, error)

+ func (s *SessionState) Bytes() ([]byte, error)

+ type SignatureScheme uint16

+ const ECDSAWithP256AndSHA256

+ const ECDSAWithP384AndSHA384

+ const ECDSAWithP521AndSHA512

+ const ECDSAWithSHA1

+ const Ed25519

+ const PKCS1WithSHA1

+ const PKCS1WithSHA256

+ const PKCS1WithSHA384

+ const PKCS1WithSHA512

+ const PSSWithSHA256

+ const PSSWithSHA384

+ const PSSWithSHA512

+ func (i SignatureScheme) String() string

+ type TargetProfile struct

+ CapturedAt time.Time

+ CipherSuite uint16

+ HandshakeLen [7]int

+ KeyGroup CurveID

+ TTL time.Duration

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