Package: github.com/gotd/td/internal/exchange

package exchange Import Path github.com/gotd/td/internal/exchange (on go.dev) Dependency Relation imports 16 packages, and imported by 2 packages

Involved Source Files client.go client_flow.go errors.go d flow.go Package exchange contains Telegram key exchange algorithm flows. See https://core.telegram.org/mtproto/auth_key. generator.go key.go proto.go server.go server_flow.go

Package-Level Type Names (total 13, in which 10 are exported)

/* sort exporteds by: alphabet | popularity */

type ClientExchange (struct) ClientExchange is a client-side key exchange flow. Fields (total 10, none are exported) /* 10 unexporteds ... *//* 10 unexporteds: */ dc int keys []PublicKey log *zap.Logger rand io.Reader unencryptedWriter unencryptedWriter unencryptedWriter.clock clock.Clock unencryptedWriter.conn transport.Conn unencryptedWriter.input proto.MessageType unencryptedWriter.output proto.MessageType unencryptedWriter.timeout time.Duration Methods (total 6, in which 1 is exported) ( ClientExchange) Run(ctx context.Context) (ClientExchangeResult, error) Run runs client-side flow. /* 5 unexporteds ... *//* 5 unexporteds: */ ( ClientExchange) checkMsgID(id int64) error ( ClientExchange) isClient() bool ( ClientExchange) readUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Decoder) error ( ClientExchange) tryRead(ctx context.Context, b *bin.Buffer) error ( ClientExchange) writeUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Encoder) error As Outputs Of (at least one exported) func Exchanger.Client(keys []PublicKey) ClientExchange

type ClientExchangeResult (struct) ClientExchangeResult contains client part of key exchange result. Fields (total 3, all are exported) AuthKey crypto.AuthKey ServerSalt int64 SessionID int64 As Outputs Of (at least one exported) func ClientExchange.Run(ctx context.Context) (ClientExchangeResult, error)

type Exchanger (struct) Exchanger is builder for key exchangers. Fields (total 6, none are exported) /* 6 unexporteds ... *//* 6 unexporteds: */ clock clock.Clock conn transport.Conn dc int log *zap.Logger rand io.Reader timeout time.Duration Methods (total 7, in which 6 are exported) ( Exchanger) Client(keys []PublicKey) ClientExchange Client creates new ClientExchange using parameters from Exchanger. ( Exchanger) Server(key PrivateKey) ServerExchange Server creates new ServerExchange using parameters from Exchanger. ( Exchanger) WithClock(c clock.Clock) Exchanger WithClock sets exchange flow clock. ( Exchanger) WithLogger(log *zap.Logger) Exchanger WithLogger sets exchange flow logger. ( Exchanger) WithRand(reader io.Reader) Exchanger WithRand sets exchange flow random source. ( Exchanger) WithTimeout(timeout time.Duration) Exchanger WithTimeout sets write/read deadline of every exchange request. /* one unexported ... *//* one unexported: */ ( Exchanger) unencryptedWriter(input, output proto.MessageType) unencryptedWriter As Outputs Of (at least 5, all are exported) func NewExchanger(conn transport.Conn, dc int) Exchanger func Exchanger.WithClock(c clock.Clock) Exchanger func Exchanger.WithLogger(log *zap.Logger) Exchanger func Exchanger.WithRand(reader io.Reader) Exchanger func Exchanger.WithTimeout(timeout time.Duration) Exchanger

type PrivateKey (struct) PrivateKey is a private Telegram server key. Fields (only one, which is exported) RSA *rsa.PrivateKey RSA private key. Methods (total 3, all are exported) ( PrivateKey) Fingerprint() int64 Fingerprint computes key fingerprint. ( PrivateKey) Public() PublicKey Public returns PublicKey of this PrivateKey pair. ( PrivateKey) Zero() bool Zero denotes that current PublicKey is zero value. As Inputs Of (at least one exported) func Exchanger.Server(key PrivateKey) ServerExchange

type PublicKey (struct) PublicKey is a public Telegram server key. Fields (only one, which is exported) RSA *rsa.PublicKey RSA public key. Methods (total 2, both are exported) ( PublicKey) Fingerprint() int64 Fingerprint computes key fingerprint. ( PublicKey) Zero() bool Zero denotes that current PublicKey is zero value. As Outputs Of (at least 2, in which 1 is exported) func PrivateKey.Public() PublicKey /* at least one unexported ... *//* at least one unexported: */ func github.com/gotd/td/internal/mtproto.vendoredKeys() []PublicKey As Inputs Of (at least one exported) func Exchanger.Client(keys []PublicKey) ClientExchange

type ServerExchange (struct) ServerExchange is a server-side key exchange flow. Fields (total 11, none are exported) /* 11 unexporteds ... *//* 11 unexporteds: */ dc int key PrivateKey log *zap.Logger rand io.Reader rng ServerRNG unencryptedWriter unencryptedWriter unencryptedWriter.clock clock.Clock unencryptedWriter.conn transport.Conn unencryptedWriter.input proto.MessageType unencryptedWriter.output proto.MessageType unencryptedWriter.timeout time.Duration Methods (total 6, in which 1 is exported) ( ServerExchange) Run(ctx context.Context) (ServerExchangeResult, error) Run runs server-side flow. If b parameter is not nil, it will be used as first read message. Otherwise, it will be read from connection. /* 5 unexporteds ... *//* 5 unexporteds: */ ( ServerExchange) checkMsgID(id int64) error ( ServerExchange) isClient() bool ( ServerExchange) readUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Decoder) error ( ServerExchange) tryRead(ctx context.Context, b *bin.Buffer) error ( ServerExchange) writeUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Encoder) error As Outputs Of (at least one exported) func Exchanger.Server(key PrivateKey) ServerExchange

type ServerExchangeError (struct) ServerExchangeError is returned when exchange fails due to some security or validation checks. Fields (total 2, both are exported) Code int32 Err error Methods (total 2, both are exported) (*ServerExchangeError) Error() string Error implements error. (*ServerExchangeError) Unwrap() error Unwrap implements error wrapper interface. Implements (at least 2, both are exported) *ServerExchangeError : github.com/go-faster/errors.Wrapper *ServerExchangeError : error

type ServerExchangeResult (struct) ServerExchangeResult contains server part of key exchange result. Fields (total 2, both are exported) Key crypto.AuthKey ServerSalt int64 As Outputs Of (at least one exported) func ServerExchange.Run(ctx context.Context) (ServerExchangeResult, error)

type ServerRNG (interface) ServerRNG is server-side random number generator. Methods (total 3, all are exported) ( ServerRNG) DhPrime() (p *big.Int, err error) ( ServerRNG) GA(g int, dhPrime *big.Int) (a, ga *big.Int, err error) ( ServerRNG) PQ() (pq *big.Int, err error) Implemented By (at least one exported) TestServerRNG

type TestServerRNG (struct) TestServerRNG implements testing-only ServerRNG. Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ rand io.Reader Methods (total 4, in which 3 are exported) ( TestServerRNG) DhPrime() (p *big.Int, err error) DhPrime always returns testing dh_prime. ( TestServerRNG) GA(g int, dhPrime *big.Int) (a, ga *big.Int, err error) GA returns testing a and g_a params. ( TestServerRNG) PQ() (pq *big.Int, err error) PQ always returns testing pq value. nolint:unparam /* one unexported ... *//* one unexported: */ ( TestServerRNG) bigFromHex(hexString string) (p *big.Int, err error) Implements (at least one exported) TestServerRNG : ServerRNG

/* 3 unexporteds ... *//* 3 unexporteds: */

type reqOrDH (struct) Fields (total 3, all are exported) DH mt.ReqDHParamsRequest Req reqPQ Type uint32 Methods (only one, which is exported) (*reqOrDH) Decode(b *bin.Buffer) error Implements (at least one exported) *reqOrDH : github.com/gotd/td/bin.Decoder

type reqPQ (struct) req_pq#60469778 or req_pq_multi#be7e8ef1 Fields (total 2, both are exported) Nonce bin.Int128 Type uint32 Methods (only one, which is exported) (*reqPQ) Decode(b *bin.Buffer) error Implements (at least one exported) *reqPQ : github.com/gotd/td/bin.Decoder

type unencryptedWriter (struct) Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ clock clock.Clock conn transport.Conn input proto.MessageType output proto.MessageType timeout time.Duration Methods (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ ( unencryptedWriter) checkMsgID(id int64) error ( unencryptedWriter) isClient() bool ( unencryptedWriter) readUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Decoder) error ( unencryptedWriter) tryRead(ctx context.Context, b *bin.Buffer) error ( unencryptedWriter) writeUnencrypted(ctx context.Context, b *bin.Buffer, data bin.Encoder) error As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func Exchanger.unencryptedWriter(input, output proto.MessageType) unencryptedWriter

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

func NewExchanger(conn transport.Conn, dc int) Exchanger NewExchanger creates new Exchanger.

/* one unexported ... *//* one unexported: */

func serverError(code int32, err error) error

Package-Level Variables (only one, which is exported)

var ErrKeyFingerprintNotFound error ErrKeyFingerprintNotFound is returned when client can't find keys by fingerprints provided by server during key exchange.

Package-Level Constants (only one, which is exported)

const DefaultTimeout time.Duration = 60000000000 DefaultTimeout is default WithTimeout parameter value.