package libp2ptls

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

Dependency Relation
	imports 25 packages, and imported by 2 packages

Involved Source Files

	    conn.go
	    crypto.go
	    extension.go
	    transport.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Identity (struct)
		Identity is used to secure connections

		Methods (only one)
			(*Identity) ConfigForPeer(remote peer.ID) (*tls.Config, <-chan ic.PubKey)
				ConfigForPeer creates a new single-use tls.Config that verifies the peer's
				certificate chain and returns the peer's public key via the channel. If the
				peer ID is empty, the returned config will accept any peer.
				
				It should be used to create a new tls.Config before securing either an
				incoming or outgoing connection.

		As Outputs Of (at least one exported)
			func NewIdentity(privKey ic.PrivKey, opts ...IdentityOption) (*Identity, error)

	 type IdentityConfig (struct)
		IdentityConfig is used to configure an Identity

		Fields (total 2)
			CertTemplate *x509.Certificate
			KeyLogWriter io.Writer

	 type IdentityOption (func)
		IdentityOption transforms an IdentityConfig to apply optional settings.

		As Outputs Of (at least 2)
			func WithCertTemplate(template *x509.Certificate) IdentityOption
			func WithKeyLogWriter(w io.Writer) IdentityOption
		As Inputs Of (at least one exported)
			func NewIdentity(privKey ic.PrivKey, opts ...IdentityOption) (*Identity, error)

	 type Transport (struct)
		Transport constructs secure communication sessions for a peer.

		Methods (total 3)
			(*Transport) ID() protocol.ID
			(*Transport) SecureInbound(ctx context.Context, insecure net.Conn, p peer.ID) (sec.SecureConn, error)
				SecureInbound runs the TLS handshake as a server.
				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 TLS handshake as a client.
				Note that SecureOutbound will not return an error if the server doesn't
				accept the certificate. This is due to the fact that in TLS 1.3, the client
				sends its certificate and the ClientFinished in the same flight, and can send
				application data immediately afterwards.
				If the handshake fails, the server will close the connection. The client will
				notice this after 1 RTT when calling Read.

		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, key ci.PrivKey, muxers []tptu.StreamMuxer) (*Transport, error)


Package-Level Functions (total 6)

	 func GenerateSignedExtension(sk ic.PrivKey, pubKey crypto.PublicKey) (pkix.Extension, error)
		GenerateSignedExtension uses the provided private key to sign the public key, and returns the
		signature within a pkix.Extension.
		This extension is included in a certificate to cryptographically tie it to the libp2p private key.

	 func New(id protocol.ID, key ci.PrivKey, muxers []tptu.StreamMuxer) (*Transport, error)
		New creates a TLS encrypted transport

	 func NewIdentity(privKey ic.PrivKey, opts ...IdentityOption) (*Identity, error)
		NewIdentity creates a new identity

	 func PubKeyFromCertChain(chain []*x509.Certificate) (ic.PubKey, error)
		PubKeyFromCertChain verifies the certificate chain and extract the remote's public key.

	 func WithCertTemplate(template *x509.Certificate) IdentityOption
		WithCertTemplate specifies the template to use when generating a new certificate.

	 func WithKeyLogWriter(w io.Writer) IdentityOption
		WithKeyLogWriter optionally specifies a destination for TLS master secrets
		in NSS key log format that can be used to allow external programs
		such as Wireshark to decrypt TLS connections.
		See https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format.
		Use of KeyLogWriter compromises security and should only be
		used for debugging.


Package-Level Constants (only one)

	const ID = "/tls/1.0.0"
		ID is the protocol ID (used when negotiating with multistream)

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.