package extension

Import Path
	github.com/pion/dtls/v3/pkg/protocol/extension (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 2 packages

Involved Source Files

	    alpn.go
	    connection_id.go
	    errors.go
	  d extension.go
		Package extension implements the extension values in the ClientHello/ServerHello

	    renegotiation_info.go
	    server_name.go
	    srtp_protection_profile.go
	    supported_elliptic_curves.go
	    supported_point_formats.go
	    supported_signature_algorithms.go
	    use_master_secret.go
	    use_srtp.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type ALPN (struct)
		ALPN is a TLS extension for application-layer protocol negotiation within
		the TLS handshake.
		
		https://tools.ietf.org/html/rfc7301

		Fields (only one)
			ProtocolNameList []string
		Methods (total 3)
			(*ALPN) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( ALPN) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*ALPN) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*ALPN : Extension
			*ALPN : github.com/pion/rtcp.PacketStatusChunk
			*ALPN : github.com/gogo/protobuf/proto.Marshaler
			*ALPN : github.com/gogo/protobuf/proto.Unmarshaler
			*ALPN : github.com/golang/protobuf/proto.Marshaler
			*ALPN : github.com/golang/protobuf/proto.Unmarshaler

	 type ConnectionID (struct)
		ConnectionID is a DTLS extension that provides an alternative to IP address
		and port for session association.
		
		https://tools.ietf.org/html/rfc9146

		Fields (only one)
			CID []byte
				A zero-length connection ID indicates for a client or server that
				negotiated connection IDs from the peer will be sent but there is no need
				to respond with one
				// variable length

		Methods (total 3)
			(*ConnectionID) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( ConnectionID) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*ConnectionID) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*ConnectionID : Extension
			*ConnectionID : github.com/pion/rtcp.PacketStatusChunk
			*ConnectionID : github.com/gogo/protobuf/proto.Marshaler
			*ConnectionID : github.com/gogo/protobuf/proto.Unmarshaler
			*ConnectionID : github.com/golang/protobuf/proto.Marshaler
			*ConnectionID : github.com/golang/protobuf/proto.Unmarshaler

	 type Extension (interface)
		Extension represents a single TLS extension.

		Methods (total 3)
			( Extension) Marshal() ([]byte, error)
			( Extension) TypeValue() TypeValue
			( Extension) Unmarshal(data []byte) error
		Implemented By (at least 9)
			*ALPN
			*ConnectionID
			*RenegotiationInfo
			*ServerName
			*SupportedEllipticCurves
			*SupportedPointFormats
			*SupportedSignatureAlgorithms
			*UseExtendedMasterSecret
			*UseSRTP
		Implements (at least 5)
			 Extension : github.com/pion/rtcp.PacketStatusChunk
			 Extension : github.com/gogo/protobuf/proto.Marshaler
			 Extension : github.com/gogo/protobuf/proto.Unmarshaler
			 Extension : github.com/golang/protobuf/proto.Marshaler
			 Extension : github.com/golang/protobuf/proto.Unmarshaler
		As Outputs Of (at least one exported)
			func Unmarshal(buf []byte) ([]Extension, error)
		As Inputs Of (at least one exported)
			func Marshal(e []Extension) ([]byte, error)

	 type RenegotiationInfo (struct)
		RenegotiationInfo allows a Client/Server to
		communicate their renegotation support
		
		https://tools.ietf.org/html/rfc5746

		Fields (only one)
			RenegotiatedConnection uint8
		Methods (total 3)
			(*RenegotiationInfo) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( RenegotiationInfo) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*RenegotiationInfo) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*RenegotiationInfo : Extension
			*RenegotiationInfo : github.com/pion/rtcp.PacketStatusChunk
			*RenegotiationInfo : github.com/gogo/protobuf/proto.Marshaler
			*RenegotiationInfo : github.com/gogo/protobuf/proto.Unmarshaler
			*RenegotiationInfo : github.com/golang/protobuf/proto.Marshaler
			*RenegotiationInfo : github.com/golang/protobuf/proto.Unmarshaler

	 type ServerName (struct)
		ServerName allows the client to inform the server the specific
		name it wishes to contact. Useful if multiple DNS names resolve
		to one IP
		
		https://tools.ietf.org/html/rfc6066#section-3

		Fields (only one)
			ServerName string
		Methods (total 3)
			(*ServerName) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( ServerName) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*ServerName) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*ServerName : Extension
			*ServerName : github.com/pion/rtcp.PacketStatusChunk
			*ServerName : github.com/gogo/protobuf/proto.Marshaler
			*ServerName : github.com/gogo/protobuf/proto.Unmarshaler
			*ServerName : github.com/golang/protobuf/proto.Marshaler
			*ServerName : github.com/golang/protobuf/proto.Unmarshaler

	 type SRTPProtectionProfile uint16 (basic type)
		SRTPProtectionProfile defines the parameters and options that are in effect for the SRTP processing
		https://tools.ietf.org/html/rfc5764#section-4.1.2

		As Types Of (total 16)
			const SRTP_AEAD_AES_128_GCM
			const SRTP_AEAD_AES_256_GCM
			const SRTP_AES128_CM_HMAC_SHA1_32
			const SRTP_AES128_CM_HMAC_SHA1_80
			const SRTP_AES256_CM_SHA1_32
			const SRTP_AES256_CM_SHA1_80
			const SRTP_NULL_HMAC_SHA1_32
			const SRTP_NULL_HMAC_SHA1_80
			const github.com/pion/dtls/v3.SRTP_AEAD_AES_128_GCM
			const github.com/pion/dtls/v3.SRTP_AEAD_AES_256_GCM
			const github.com/pion/dtls/v3.SRTP_AES128_CM_HMAC_SHA1_32
			const github.com/pion/dtls/v3.SRTP_AES128_CM_HMAC_SHA1_80
			const github.com/pion/dtls/v3.SRTP_AES256_CM_SHA1_32
			const github.com/pion/dtls/v3.SRTP_AES256_CM_SHA1_80
			const github.com/pion/dtls/v3.SRTP_NULL_HMAC_SHA1_32
			const github.com/pion/dtls/v3.SRTP_NULL_HMAC_SHA1_80

	 type SupportedEllipticCurves (struct)
		SupportedEllipticCurves allows a Client/Server to communicate
		what curves they both support
		
		https://tools.ietf.org/html/rfc8422#section-5.1.1

		Fields (only one)
			EllipticCurves []elliptic.Curve
		Methods (total 3)
			(*SupportedEllipticCurves) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( SupportedEllipticCurves) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*SupportedEllipticCurves) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*SupportedEllipticCurves : Extension
			*SupportedEllipticCurves : github.com/pion/rtcp.PacketStatusChunk
			*SupportedEllipticCurves : github.com/gogo/protobuf/proto.Marshaler
			*SupportedEllipticCurves : github.com/gogo/protobuf/proto.Unmarshaler
			*SupportedEllipticCurves : github.com/golang/protobuf/proto.Marshaler
			*SupportedEllipticCurves : github.com/golang/protobuf/proto.Unmarshaler

	 type SupportedPointFormats (struct)
		SupportedPointFormats allows a Client/Server to negotiate
		the EllipticCurvePointFormats
		
		https://tools.ietf.org/html/rfc4492#section-5.1.2

		Fields (only one)
			PointFormats []elliptic.CurvePointFormat
		Methods (total 3)
			(*SupportedPointFormats) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( SupportedPointFormats) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*SupportedPointFormats) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*SupportedPointFormats : Extension
			*SupportedPointFormats : github.com/pion/rtcp.PacketStatusChunk
			*SupportedPointFormats : github.com/gogo/protobuf/proto.Marshaler
			*SupportedPointFormats : github.com/gogo/protobuf/proto.Unmarshaler
			*SupportedPointFormats : github.com/golang/protobuf/proto.Marshaler
			*SupportedPointFormats : github.com/golang/protobuf/proto.Unmarshaler

	 type SupportedSignatureAlgorithms (struct)
		SupportedSignatureAlgorithms allows a Client/Server to
		negotiate what SignatureHash Algorithms they both support
		
		https://tools.ietf.org/html/rfc5246#section-7.4.1.4.1

		Fields (only one)
			SignatureHashAlgorithms []signaturehash.Algorithm
		Methods (total 3)
			(*SupportedSignatureAlgorithms) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( SupportedSignatureAlgorithms) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*SupportedSignatureAlgorithms) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*SupportedSignatureAlgorithms : Extension
			*SupportedSignatureAlgorithms : github.com/pion/rtcp.PacketStatusChunk
			*SupportedSignatureAlgorithms : github.com/gogo/protobuf/proto.Marshaler
			*SupportedSignatureAlgorithms : github.com/gogo/protobuf/proto.Unmarshaler
			*SupportedSignatureAlgorithms : github.com/golang/protobuf/proto.Marshaler
			*SupportedSignatureAlgorithms : github.com/golang/protobuf/proto.Unmarshaler

	 type TypeValue uint16 (basic type)
		TypeValue is the 2 byte value for a TLS Extension as registered in the IANA
		
		https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml

		As Outputs Of (at least 10)
			func ALPN.TypeValue() TypeValue
			func ConnectionID.TypeValue() TypeValue
			func Extension.TypeValue() TypeValue
			func RenegotiationInfo.TypeValue() TypeValue
			func ServerName.TypeValue() TypeValue
			func SupportedEllipticCurves.TypeValue() TypeValue
			func SupportedPointFormats.TypeValue() TypeValue
			func SupportedSignatureAlgorithms.TypeValue() TypeValue
			func UseExtendedMasterSecret.TypeValue() TypeValue
			func UseSRTP.TypeValue() TypeValue
		As Types Of (total 9)
			const ALPNTypeValue
			const ConnectionIDTypeValue
			const RenegotiationInfoTypeValue
			const ServerNameTypeValue
			const SupportedEllipticCurvesTypeValue
			const SupportedPointFormatsTypeValue
			const SupportedSignatureAlgorithmsTypeValue
			const UseExtendedMasterSecretTypeValue
			const UseSRTPTypeValue

	 type UseExtendedMasterSecret (struct)
		UseExtendedMasterSecret defines a TLS extension that contextually binds the
		master secret to a log of the full handshake that computes it, thus
		preventing MITM attacks.

		Fields (only one)
			Supported bool
		Methods (total 3)
			(*UseExtendedMasterSecret) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( UseExtendedMasterSecret) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*UseExtendedMasterSecret) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*UseExtendedMasterSecret : Extension
			*UseExtendedMasterSecret : github.com/pion/rtcp.PacketStatusChunk
			*UseExtendedMasterSecret : github.com/gogo/protobuf/proto.Marshaler
			*UseExtendedMasterSecret : github.com/gogo/protobuf/proto.Unmarshaler
			*UseExtendedMasterSecret : github.com/golang/protobuf/proto.Marshaler
			*UseExtendedMasterSecret : github.com/golang/protobuf/proto.Unmarshaler

	 type UseSRTP (struct)
		UseSRTP allows a Client/Server to negotiate what SRTPProtectionProfiles
		they both support
		
		https://tools.ietf.org/html/rfc8422

		Fields (total 2)
			MasterKeyIdentifier []byte
			ProtectionProfiles []SRTPProtectionProfile
		Methods (total 3)
			(*UseSRTP) Marshal() ([]byte, error)
				Marshal encodes the extension.

			( UseSRTP) TypeValue() TypeValue
				TypeValue returns the extension TypeValue.

			(*UseSRTP) Unmarshal(data []byte) error
				Unmarshal populates the extension from encoded data.

		Implements (at least 6)
			*UseSRTP : Extension
			*UseSRTP : github.com/pion/rtcp.PacketStatusChunk
			*UseSRTP : github.com/gogo/protobuf/proto.Marshaler
			*UseSRTP : github.com/gogo/protobuf/proto.Unmarshaler
			*UseSRTP : github.com/golang/protobuf/proto.Marshaler
			*UseSRTP : github.com/golang/protobuf/proto.Unmarshaler


Package-Level Functions (total 3)

	 func ALPNProtocolSelection(supportedProtocols, peerSupportedProtocols []string) (string, error)
		ALPNProtocolSelection negotiates a shared protocol according to #3.2 of rfc7301.

	 func Marshal(e []Extension) ([]byte, error)
		Marshal many extensions at once.

	 func Unmarshal(buf []byte) ([]Extension, error)
		Unmarshal many extensions at once.


Package-Level Variables (only one)

	  var ErrALPNInvalidFormat *protocol.FatalError
		ErrALPNInvalidFormat is raised when the ALPN format is invalid.


Package-Level Constants (total 17)

	const ALPNTypeValue TypeValue = 16
		TypeValue constants.

	const ConnectionIDTypeValue TypeValue = 54
		TypeValue constants.

	const RenegotiationInfoTypeValue TypeValue = 65281
		TypeValue constants.

	const ServerNameTypeValue TypeValue = 0
		TypeValue constants.

	const SRTP_AEAD_AES_128_GCM SRTPProtectionProfile = 7 // nolint
	const SRTP_AEAD_AES_256_GCM SRTPProtectionProfile = 8 // nolint
	const SRTP_AES128_CM_HMAC_SHA1_32 SRTPProtectionProfile = 2 // nolint
	const SRTP_AES128_CM_HMAC_SHA1_80 SRTPProtectionProfile = 1 // nolint
	const SRTP_AES256_CM_SHA1_32 SRTPProtectionProfile = 4 // nolint
	const SRTP_AES256_CM_SHA1_80 SRTPProtectionProfile = 3 // nolint
	const SRTP_NULL_HMAC_SHA1_32 SRTPProtectionProfile = 6 // nolint
	const SRTP_NULL_HMAC_SHA1_80 SRTPProtectionProfile = 5 // nolint
	const SupportedEllipticCurvesTypeValue TypeValue = 10
		TypeValue constants.

	const SupportedPointFormatsTypeValue TypeValue = 11
		TypeValue constants.

	const SupportedSignatureAlgorithmsTypeValue TypeValue = 13
		TypeValue constants.

	const UseExtendedMasterSecretTypeValue TypeValue = 23
		TypeValue constants.

	const UseSRTPTypeValue TypeValue = 14
		TypeValue constants.

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.