package noise

Import Path
	github.com/libp2p/go-libp2p/p2p/security/noise (on go.dev)

Dependency Relation
	imports 25 packages, and imported by 3 packages

Involved Source Files

	    crypto.go
	    handshake.go
	    rw.go
	    session.go
	    session_transport.go
	    transport.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type EarlyDataHandler (interface)
		EarlyDataHandler defines what the application payload is for either the second
		(if responder) or third (if initiator) handshake message, and defines the
		logic for handling the other side's early data. Note the early data in the
		second handshake message is encrypted, but the peer is not authenticated at that point.

		Methods (total 2)
			( EarlyDataHandler) Received(context.Context, net.Conn, *pb.NoiseExtensions) error
				Received for the initiator is called when the second handshake message
				from the responder is received.
				Received for the responder is called when the third handshake message
				from the initiator is received.

			( EarlyDataHandler) Send(context.Context, net.Conn, peer.ID) *pb.NoiseExtensions
				Send for the initiator is called for the client before sending the third
				handshake message. Defines the application payload for the third message.
				Send for the responder is called before sending the second handshake message.

		As Inputs Of (at least one exported)
			func EarlyData(initiator, responder EarlyDataHandler) SessionOption

	 type SessionOption = (func)
	 type SessionTransport (struct)
		SessionTransport can be used
		to provide per-connection options

		Methods (total 3)
			(*SessionTransport) ID() protocol.ID
			(*SessionTransport) SecureInbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureInbound runs the Noise handshake as the responder.
				If p is empty, connections from any peer are accepted.

			(*SessionTransport) SecureOutbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureOutbound runs the Noise handshake as the initiator.

		Implements (at least one exported)
			*SessionTransport : github.com/libp2p/go-libp2p/core/sec.SecureTransport
		As Outputs Of (at least one exported)
			func (*Transport).WithSessionOptions(opts ...SessionOption) (*SessionTransport, error)

	 type Transport (struct)

		Methods (total 4)
			(*Transport) ID() protocol.ID
			(*Transport) SecureInbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureInbound runs the Noise handshake as the responder.
				If p is empty, connections from any peer are accepted.

			(*Transport) SecureOutbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureOutbound runs the Noise handshake as the initiator.

			(*Transport) WithSessionOptions(opts ...SessionOption) (*SessionTransport, error)
		Implements (at least one exported)
			*Transport : github.com/libp2p/go-libp2p/core/sec.SecureTransport
		As Outputs Of (at least one exported)
			func New(id protocol.ID, privkey crypto.PrivKey, muxers []tptu.StreamMuxer) (*Transport, error)


Package-Level Functions (total 5)

	 func DisablePeerIDCheck() SessionOption
		DisablePeerIDCheck disables checking the remote peer ID for a noise connection.
		For outbound connections, this is the equivalent of calling `SecureInbound` with an empty
		peer ID. This is susceptible to MITM attacks since we do not verify the identity of the remote
		peer.

	 func EarlyData(initiator, responder EarlyDataHandler) SessionOption
		EarlyData sets the `EarlyDataHandler` for the initiator and responder roles.
		See `EarlyDataHandler` for more details.

	 func New(id protocol.ID, privkey crypto.PrivKey, muxers []tptu.StreamMuxer) (*Transport, error)
		New creates a new Noise transport using the given private key as its
		libp2p identity key.

	 func Prologue(prologue []byte) SessionOption
		Prologue sets a prologue for the Noise session.
		The handshake will only complete successfully if both parties set the same prologue.
		See https://noiseprotocol.org/noise.html#prologue for details.

	 func SessionWithConnState(s *secureSession, muxer protocol.ID) *secureSession
Package-Level Constants (total 4)

	const ID = "/noise"
		ID is the protocol ID for noise

	const LengthPrefixLength = 2
		LengthPrefixLength is the length of the length prefix itself, which precedes
		all transport messages in order to delimit them. In bytes.

	const MaxPlaintextLength = 65519
		MaxPlaintextLength is the maximum payload size. It is MaxTransportMsgLength
		minus the MAC size. Payloads over this size will be automatically chunked.

	const MaxTransportMsgLength = 65535
		MaxTransportMsgLength is the Noise-imposed maximum transport message length,
		inclusive of the MAC size (16 bytes, Poly1305 for noise-libp2p).

The pages are generated with Golds v0.8.2. (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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.