package
1.72.0-dev
Repository: https://github.com/grpc/grpc-go.git
Documentation: pkg.go.dev

# Packages

Package alts implements the ALTS credential support by gRPC library, which encapsulates all the state needed by a client to authenticate with a server using ALTS and make various assertions, e.g., about the client's identity, role, or whether it is authorized to make a particular call.
Package google defines credentials for google cloud services.
Package insecure provides an implementation of the credentials.TransportCredentials interface which disables transport security.
Package local implements local transport credentials.
Package oauth implements gRPC credentials using OAuth.
Package sts implements call credentials using STS (Security Token Service) as defined in https://tools.ietf.org/html/rfc8693.
No description provided by the author
Package xds provides a transport credentials implementation where the security configuration is pushed by a management server using xDS APIs.

# Functions

CheckSecurityLevel checks if a connection's security level is greater than or equal to the specified one.
ClientHandshakeInfoFromContext returns the ClientHandshakeInfo struct stored in ctx.
NewClientTLSFromCert constructs TLS credentials from the provided root certificate authority certificate(s) to validate server connections.
NewClientTLSFromFile constructs TLS credentials from the provided root certificate authority certificate file(s) to validate server connections.
NewServerTLSFromCert constructs TLS credentials from the input certificate for server.
NewServerTLSFromFile constructs TLS credentials from the input certificate file and key file for server.
NewTLS uses c to construct a TransportCredentials based on TLS.
RequestInfoFromContext extracts the RequestInfo from the context if it exists.

# Constants

IntegrityOnly indicates a connection only provides integrity protection.
InvalidSecurityLevel indicates an invalid security level.
NoSecurity indicates a connection is insecure.
PrivacyAndIntegrity indicates a connection provides both privacy and integrity protection.

# Variables

ErrConnDispatched indicates that rawConn has been dispatched out of gRPC and the caller should not close rawConn.

# Structs

ClientHandshakeInfo holds data to be passed to ClientHandshake.
CommonAuthInfo contains authenticated information common to AuthInfo implementations.
OtherChannelzSecurityValue defines the struct that non-TLS protocol should return from GetSecurityValue(), which contains protocol specific security info.
ProtocolInfo provides information regarding the gRPC wire protocol version, security protocol, security protocol version in use, server name, etc.
RequestInfo contains request data attached to the context passed to GetRequestMetadata calls.
TLSChannelzSecurityValue defines the struct that TLS protocol should return from GetSecurityValue(), containing security info like cipher and certificate used.
TLSInfo contains the auth information for a TLS authenticated connection.

# Interfaces

AuthInfo defines the common interface for the auth information the users are interested in.
Bundle is a combination of TransportCredentials and PerRPCCredentials.
ChannelzSecurityInfo defines the interface that security protocols should implement in order to provide security info to channelz.
ChannelzSecurityValue defines the interface that GetSecurityValue() return value should satisfy.
PerRPCCredentials defines the common interface for the credentials which need to attach security information to every RPC (e.g., oauth2).
TransportCredentials defines the common interface for all the live gRPC wire protocols and supported transport security protocols (e.g., TLS, SSL).

# Type aliases

SecurityLevel defines the protection level on an established connection.