package mtproto

Import Path
	github.com/gotd/td/internal/mtproto (on go.dev)

Dependency Relation
	imports 27 packages, and imported by 3 packages

Involved Source Files

	    ack.go
	    conn.go
	    connect.go
	  d doc.go
		Package mtproto implements MTProto connection.

	    handle_ack.go
	    handle_bad_msg.go
	    handle_container.go
	    handle_future_salts.go
	    handle_gzip.go
	    handle_message.go
	    handle_result.go
	    handle_session_created.go
	    message_id.go
	    new_encrypted_msg.go
	    options.go
	    ping.go
	    read.go
	    rpc.go
	    salt.go
	    session.go
	    vendored_keys.go
	    write.go
	    zap.go
Package-Level Type Names (total 11, in which 8 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Cipher (interface)
		Cipher handles message encryption and decryption.

		Methods (total 2, both are exported)
			( Cipher) DecryptFromBuffer(k crypto.AuthKey, buf *bin.Buffer) (*crypto.EncryptedMessageData, error)
			( Cipher) Encrypt(key crypto.AuthKey, data crypto.EncryptedMessageData, b *bin.Buffer) error
		Implemented By (at least one exported)
			 github.com/gotd/td/internal/crypto.Cipher

	 type Conn (struct)
		Conn represents a MTProto client to Telegram.

		Fields (total 35, none are exported)
			/* 35 unexporteds ... *//* 35 unexporteds: */
			ackBatchSize int
			ackInterval time.Duration
			ackSendChan chan int64
				ackSendChan is queue for outgoing message id's that require waiting for
				ack from server.

			authKey crypto.AuthKey
			cipher Cipher
			clock clock.Clock
				Wrappers for external world, like current time, logs or PRNG.
				Should be immutable.

			compressThreshold int
				compressThreshold is a threshold in bytes to determine that message
				is large enough to be compressed using gzip.

			conn transport.Conn
			dcID int
			dialTimeout time.Duration
			dialer Dialer
			exchangeLock sync.RWMutex
				exchangeLock locks write calls during key exchange.

			exchangeTimeout time.Duration
			getTimeout func(req uint32) time.Duration
			gotSession *tdsync.Ready
				gotSession is a signal channel for wait for handleSessionCreated message.

			handler Handler
			log *zap.Logger
			messageID MessageIDSource
			messageIDBuf MessageBuf
				// replay attack protection

			ping map[int64]chan struct{}
				callbacks for ping results.
				Key is ping id.

			pingInterval time.Duration
				pingInterval is duration between ping_delay_disconnect request.

			pingMux sync.Mutex
			pingTimeout time.Duration
				pingTimeout sets ping_delay_disconnect delay.

			ran atomic.Bool
				Ensure Run once.

			rand io.Reader
			reqMux sync.Mutex
			rpc *rpc.Engine
			rsaPublicKeys []exchange.PublicKey
			salt int64
			saltFetchInterval time.Duration
			salts salts.Salts
				server salts fetched by getSalts.

			sentContentMessages int32
				sentContentMessages is count of created content messages, used to
				compute sequence number within session.

			sessionID int64
			sessionMux sync.RWMutex
				use session() to access authKey, salt or sessionID.

			types *tmap.Map
		Methods (total 42, in which 3 are exported)
			(*Conn) Invoke(ctx context.Context, input bin.Encoder, output bin.Decoder) error
				Invoke sends input and decodes result into output.
				
				NOTE: Assuming that call contains content message (seqno increment).

			(*Conn) Ping(ctx context.Context) error
				Ping sends ping request to server and waits until pong is received or
				context is canceled.

			(*Conn) Run(ctx context.Context, f func(ctx context.Context) error) error
				Run initializes MTProto connection to server and blocks until disconnection.
				
				When connection is ready, Handler.OnSession is called.

			/* 39 unexporteds ... *//* 39 unexporteds: */
			(*Conn) ackLoop(ctx context.Context) error
			(*Conn) connect(ctx context.Context) (rErr error)
				connect establishes connection using configured transport, creating
				new auth key if needed.

			(*Conn) consumeMessage(ctx context.Context, buf *bin.Buffer) error
			(*Conn) createAuthKey(ctx context.Context) error
				createAuthKey generates new authorization key.

			(*Conn) decryptMessage(b *bin.Buffer) (*crypto.EncryptedMessageData, error)
			(*Conn) dropRPC(req rpc.Request) error
			(*Conn) getSalts(ctx context.Context) error
			(*Conn) handleAck(b *bin.Buffer) error
			(*Conn) handleAuthKeyNotFound(ctx context.Context) error
			(*Conn) handleBadMsg(b *bin.Buffer) error
			(*Conn) handleClose(ctx context.Context) error
				handleClose closes rpc engine and underlying connection on context done.

			(*Conn) handleContainer(msgID int64, b *bin.Buffer) error
			(*Conn) handleFutureSalts(b *bin.Buffer) error
			(*Conn) handleGZIP(msgID int64, b *bin.Buffer) error
			(*Conn) handleMessage(msgID int64, b *bin.Buffer) error
			(*Conn) handlePong(b *bin.Buffer) error
			(*Conn) handleResult(b *bin.Buffer) error
			(*Conn) handleSessionCreated(b *bin.Buffer) error
			(*Conn) logWithBuffer(b *bin.Buffer) *zap.Logger
			(*Conn) logWithType(b *bin.Buffer) *zap.Logger
			(*Conn) logWithTypeID(id uint32) *zap.Logger
			(*Conn) newEncryptedMessage(id int64, seq int32, payload bin.Encoder, b *bin.Buffer) error
			(*Conn) newMessageID() int64
			(*Conn) newSessionID() error
				newSessionID sets session id to random value.

			(*Conn) nextMsgSeq(content bool) (msgID int64, seqNo int32)
			(*Conn) noUpdates(err error) bool
			(*Conn) pingDelayDisconnect(ctx context.Context, delay int) error
			(*Conn) pingLoop(ctx context.Context) error
			(*Conn) pong(pingID int64) chan struct{}
			(*Conn) processContainerMessage(msgID int64, msg proto.Message) error
			(*Conn) readLoop(ctx context.Context) (err error)
			(*Conn) removePong(pingID int64)
			(*Conn) saltLoop(ctx context.Context) error
			(*Conn) session() Session
				Session returns current connection session info.

			(*Conn) storeSalt(salt int64)
			(*Conn) updateSalt()
			(*Conn) write(ctx context.Context, msgID int64, seqNo int32, message bin.Encoder) error
			(*Conn) writeContentMessage(ctx context.Context, msgID int64, seqNo int32, message bin.Encoder) error
			(*Conn) writeServiceMessage(ctx context.Context, message bin.Encoder) error
		Implements (at least 2, in which 1 is exported)
			*Conn : github.com/gotd/td/tg.Invoker
			/* at least one unexported ... *//* at least one unexported: */
			*Conn : github.com/gotd/td/telegram/internal/manager.protoConn
		As Outputs Of (at least one exported)
			func New(dialer Dialer, opt Options) *Conn

	 type Dialer (func)
		Dialer is an abstraction for MTProto transport connection creator.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/telegram.(*Client).primaryDC(dc int) Dialer
		As Inputs Of (at least 3, in which 2 are exported)
			func New(dialer Dialer, opt Options) *Conn
			func github.com/gotd/td/telegram/internal/manager.CreateConn(create Dialer, mode manager.ConnMode, appID int, opts Options, connOpts manager.ConnOptions) *manager.Conn
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/gotd/td/telegram.(*Client).dc(ctx context.Context, dcID int, max int64, dialer Dialer) (*pool.DC, error)

	 type Handler (interface)
		Handler will be called on received message from Telegram.

		Methods (total 2, both are exported)
			( Handler) OnMessage(b *bin.Buffer) error
			( Handler) OnSession(session Session) error
		Implemented By (at least 2, in which 1 is exported)
			*github.com/gotd/td/telegram/internal/manager.Conn
			/* at least one unexported ... *//* at least one unexported: */
			 nopHandler

	 type MessageBuf (interface)
		MessageBuf is message id buffer.

		Methods (only one, which is exported)
			( MessageBuf) Consume(id int64) bool
		Implemented By (at least one exported)
			*github.com/gotd/td/internal/proto.MessageIDBuf

	 type MessageIDSource (interface)
		MessageIDSource is message id generator.

		Methods (only one, which is exported)
			( MessageIDSource) New(t proto.MessageType) int64
		Implemented By (at least one exported)
			*github.com/gotd/td/internal/proto.MessageIDGen

	 type Options (struct)
		Options of Conn.

		Fields (total 24, in which 23 are exported)
			AckBatchSize int
				AckBatchSize is maximum ack-s to buffer.

			AckInterval time.Duration
				AckInterval is maximum time to buffer ack.

			Cipher Cipher
				Cipher defines message crypto.

			Clock clock.Clock
				Clock is current time source. Defaults to system time.

			CompressThreshold int
				CompressThreshold is a threshold in bytes to determine that message
				is large enough to be compressed using GZIP.
				If < 0, compression will be disabled.
				If == 0, default value will be used.

			DC int
				DC is datacenter ID for key exchange.
				Defaults to 2.

			DialTimeout time.Duration
				DialTimeout is timeout of creating connection.

			ExchangeTimeout time.Duration
				ExchangeTimeout is timeout of every key exchange request.

			Handler Handler
				Handler will be called on received message.

			Key crypto.AuthKey
				Key that can be used to restore previous connection.

			Logger *zap.Logger
				Logger is instance of zap.Logger. No logs by default.

			MaxRetries int
				MaxRetries is max retry count until rpc request failure.

			MessageID MessageIDSource
				MessageID is message id source. Share source between connection to
				reduce collision probability.

			PingInterval time.Duration
				PingInterval is duration between ping_delay_disconnect request.

			PingTimeout time.Duration
				PingTimeout sets ping_delay_disconnect timeout.

			PublicKeys []exchange.PublicKey
				PublicKeys of telegram.
				
				If not provided, embedded public keys will be used.

			Random io.Reader
				Random is random source. Defaults to crypto.

			RequestTimeout func(req uint32) time.Duration
				RequestTimeout is function which returns request timeout for given type ID.

			RetryInterval time.Duration
				RetryInterval is duration between retries.

			Salt int64
				Salt from server that can be used to restore previous connection.

			SaltFetchInterval time.Duration
				SaltFetchInterval is duration between get_future_salts request.

			Tracer trace.Tracer
				Tracer for OTEL.

			Types *tmap.Map
				Types map, used in verbose logging of incoming message.

			/* one unexported ... *//* one unexported: */
			engine *rpc.Engine
				engine for replacing RPC engine.

		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*Options) setDefaultPublicKeys()
			(*Options) setDefaults()
		As Outputs Of (at least one exported)
			func github.com/gotd/td/internal/pool.(*SyncSession).Options(opts Options) (Options, pool.Session)
		As Inputs Of (at least 3, all are exported)
			func New(dialer Dialer, opt Options) *Conn
			func github.com/gotd/td/internal/pool.(*SyncSession).Options(opts Options) (Options, pool.Session)
			func github.com/gotd/td/telegram/internal/manager.CreateConn(create Dialer, mode manager.ConnMode, appID int, opts Options, connOpts manager.ConnOptions) *manager.Conn

	 type Session (struct)
		Session represents connection state.

		Fields (total 3, all are exported)
			ID int64
			Key crypto.AuthKey
			Salt int64
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func (*Conn).session() Session
		As Inputs Of (at least 6, in which 4 are exported)
			func Handler.OnSession(session Session) error
			func github.com/gotd/td/telegram/internal/manager.(*Conn).OnSession(session Session) error
			func github.com/gotd/td/telegram/internal/manager.Handler.OnSession(cfg tg.Config, s Session) error
			func github.com/gotd/td/telegram/internal/manager.NoopHandler.OnSession(cfg tg.Config, s Session) error
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/gotd/td/telegram.(*Client).onSession(cfg tg.Config, s Session) error
			func github.com/gotd/td/telegram.(*Client).saveSession(cfg tg.Config, s Session) error

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type badMessageError (struct)

		Fields (total 2, both are exported)
			Code int
			NewSalt int64
		Methods (only one, which is exported)
			( badMessageError) Error() string
		Implements (at least one exported)
			 badMessageError : error

	 type logType (struct)

		Fields (total 2, both are exported)
			ID uint32
			Name string
		Methods (only one, which is exported)
			( logType) MarshalLogObject(e zapcore.ObjectEncoder) error
		Implements (at least 2, in which 4 are exported)
			 logType : go.uber.org/zap.ObjectMarshalerPtr[...]
			 logType : go.uber.org/zap/zapcore.ObjectMarshaler[T]

	 type nopHandler (struct)

		Methods (total 2, both are exported)
			( nopHandler) OnMessage(b *bin.Buffer) error
			( nopHandler) OnSession(session Session) error
		Implements (at least one exported)
			 nopHandler : Handler


Package-Level Functions (total 5, in which 1 is exported)

	 func New(dialer Dialer, opt Options) *Conn
		New creates new unstarted connection.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 func checkMessageID(now time.Time, rawID int64) error
	 func gzip(b *bin.Buffer) (*bin.Buffer, error)
	 func init()
	 func vendoredKeys() []exchange.PublicKey
		vendoredKeys parses vendored file _data/public_keys.pem as list of
		PEM-encoded public RSA keys.
		
		Most recent key list can be found on https://my.telegram.org/apps.


Package-Level Variables (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	  var bufPool *bin.Pool
	  var errRejected error
		errRejected is returned on invalid message that should not be processed.

	  var parsedKeys struct{Keys []exchange.PublicKey; Once sync.Once}
	  var publicKeys []byte
		publicKeys is byte blob of new keys added for PQInnerData encryption (key exchange).
		
		See https://github.com/telegramdesktop/tdesktop/commit/95a7ce4622dc24717dc5b95fc99599dddfd4ff6c.
		
		See https://github.com/tdlib/td/commit/e9e24282378fcdb3a3ce020bee4253b65ac98213.


Package-Level Constants (total 6, none are exported)

	/* 6 unexporteds ... *//* 6 unexporteds: */
	const codeIncorrectServerSalt = 48
	const codeMessageIDTooHigh = 17
	const codeMessageIDTooLow = 16
	const defaultSaltsNum = 4
	const maxFuture time.Duration = 30000000000
		https://core.telegram.org/mtproto/description#message-identifier-msg-id
		A message is rejected over 300 seconds after it is created or 30 seconds
		before it is created (this is needed to protect from replay attacks).

	const maxPast time.Duration = 300000000000
		https://core.telegram.org/mtproto/description#message-identifier-msg-id
		A message is rejected over 300 seconds after it is created or 30 seconds
		before it is created (this is needed to protect from replay attacks).

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.