package insecure

Import Path
	github.com/libp2p/go-libp2p/core/sec/insecure (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	  d insecure.go
		Package insecure provides an insecure, unencrypted implementation of the SecureConn and SecureTransport interfaces.
		
		Recommended only for testing and other non-production usage.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Conn (struct)
		Conn is the connection type returned by the insecure transport.

		Fields (only one)
			Conn net.Conn
		Methods (total 12)
			( Conn) Close() error
				Close closes the connection.
				Any blocked Read or Write operations will be unblocked and return errors.
				Close may or may not block until any buffered data is sent;
				for TCP connections see [*TCPConn.SetLinger].

			(*Conn) ConnState() network.ConnectionState
				ConnState returns the security connection's state information.

			( Conn) LocalAddr() net.Addr
				LocalAddr returns the local network address, if known.

			(*Conn) LocalPeer() peer.ID
				LocalPeer returns the local peer ID.

			( Conn) Read(b []byte) (n int, err error)
				Read reads data from the connection.
				Read can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetReadDeadline.

			( Conn) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address, if known.

			(*Conn) RemotePeer() peer.ID
				RemotePeer returns the remote peer ID if we initiated the dial. Otherwise, it
				returns "" (because this connection isn't actually secure).

			(*Conn) RemotePublicKey() ci.PubKey
				RemotePublicKey returns whatever public key was given by the remote peer.
				Note that no verification of ownership is done, as this connection is not secure.

			( Conn) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.
				
				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.
				
				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.
				
				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.
				
				A zero value for t means I/O operations will not time out.

			( Conn) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( Conn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			( Conn) Write(b []byte) (n int, err error)
				Write writes data to the connection.
				Write can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetWriteDeadline.

		Implements (at least 17)
			*Conn : github.com/libp2p/go-libp2p/core/sec.SecureConn
			*Conn : github.com/libp2p/go-libp2p/core/network.ConnSecurity
			 Conn : github.com/miekg/dns.Writer
			 Conn : github.com/pion/datachannel.ReadDeadliner
			 Conn : github.com/pion/datachannel.WriteDeadliner
			 Conn : github.com/pion/stun.Connection
			 Conn : github.com/pion/stun/v3.Connection
			 Conn : github.com/prometheus/common/expfmt.Closer
			 Conn : internal/bisect.Writer
			 Conn : io.Closer
			 Conn : io.ReadCloser
			 Conn : io.Reader
			 Conn : io.ReadWriteCloser
			 Conn : io.ReadWriter
			 Conn : io.WriteCloser
			 Conn : io.Writer
			 Conn : net.Conn

	 type Transport (struct)
		Transport is a no-op stream security transport. It provides no
		security and simply mocks the security methods. Identity methods
		return the local peer's ID and private key, and whatever the remote
		peer presents as their ID and public key.
		No authentication of the remote identity is performed.

		Methods (total 4)
			(*Transport) ID() protocol.ID
			(*Transport) LocalPeer() peer.ID
				LocalPeer returns the transport's local peer ID.

			(*Transport) SecureInbound(_ context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureInbound *pretends to secure* an inbound connection to the given peer.
				It sends the local peer's ID and public key, and receives the same from the remote peer.
				No validation is performed as to the authenticity or ownership of the provided public key,
				and the key exchange provides no security.
				
				SecureInbound may fail if the remote peer sends an ID and public key that are inconsistent
				with each other, or if a network error occurs during the ID exchange.

			(*Transport) SecureOutbound(_ context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureOutbound *pretends to secure* an outbound connection to the given peer.
				It sends the local peer's ID and public key, and receives the same from the remote peer.
				No validation is performed as to the authenticity or ownership of the provided public key,
				and the key exchange provides no security.
				
				SecureOutbound may fail if the remote peer sends an ID and public key that are inconsistent
				with each other, or if the ID sent by the remote peer does not match the one dialed. It may
				also fail if a network error occurs during the ID exchange.

		Implements (at least one exported)
			*Transport : github.com/libp2p/go-libp2p/core/sec.SecureTransport
		As Outputs Of (at least one exported)
			func NewWithIdentity(protocolID protocol.ID, id peer.ID, key ci.PrivKey) *Transport


Package-Level Functions (only one)

	 func NewWithIdentity(protocolID protocol.ID, id peer.ID, key ci.PrivKey) *Transport
		NewWithIdentity constructs a new insecure transport. The public key is sent to
		remote peers. No security is provided.


Package-Level Constants (only one)

	const ID = "/plaintext/2.0.0"
		ID is the multistream-select protocol ID that should be used when identifying
		this security transport.

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.