Documentation
¶
Index ¶
- Variables
- func NewClientTLSFromCert(cp *cmx509.CertPool, serverNameOverride string) credentials.TransportCredentials
- func NewClientTLSFromFile(certFile, serverNameOverride string) (credentials.TransportCredentials, error)
- func NewServerTLSFromCert(cert *cmtls.Certificate) credentials.TransportCredentials
- func NewServerTLSFromFile(certFile, keyFile string) (credentials.TransportCredentials, error)
- func NewTLS(c *cmtls.Config) credentials.TransportCredentials
- type AuthInfo
- type PerRPCCredentials
- type ProtocolInfo
- type TLSInfo
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func NewClientTLSFromCert ¶
func NewClientTLSFromCert(cp *cmx509.CertPool, serverNameOverride string) credentials.TransportCredentials
NewClientTLSFromCert constructs TLS credentials from the input certificate for client. serverNameOverride is for testing only. If set to a non empty string, it will override the virtual host name of authority (e.g. :authority header field) in requests.
func NewClientTLSFromFile ¶
func NewClientTLSFromFile(certFile, serverNameOverride string) (credentials.TransportCredentials, error)
NewClientTLSFromFile constructs TLS credentials from the input certificate file for client. serverNameOverride is for testing only. If set to a non empty string, it will override the virtual host name of authority (e.g. :authority header field) in requests.
func NewServerTLSFromCert ¶
func NewServerTLSFromCert(cert *cmtls.Certificate) credentials.TransportCredentials
NewServerTLSFromCert constructs TLS credentials from the input certificate for server.
func NewServerTLSFromFile ¶
func NewServerTLSFromFile(certFile, keyFile string) (credentials.TransportCredentials, error)
NewServerTLSFromFile constructs TLS credentials from the input certificate file and key file for server.
func NewTLS ¶
func NewTLS(c *cmtls.Config) credentials.TransportCredentials
NewTLS uses c to construct a TransportCredentials based on TLS.
Types ¶
type AuthInfo ¶
type AuthInfo interface {
AuthType() string
}
AuthInfo defines the common interface for the auth information the users are interested in.
type PerRPCCredentials ¶
type PerRPCCredentials interface {
// GetRequestMetadata gets the current request metadata, refreshing
// tokens if required. This should be called by the transport layer on
// each request, and the data should be populated in headers or other
// context. uri is the URI of the entry point for the request. When
// supported by the underlying implementation, ctx can be used for
// timeout and cancellation.
// TODO(zhaoq): Define the set of the qualified keys instead of leaving
// it as an arbitrary string.
GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
// RequireTransportSecurity indicates whether the credentials requires
// transport security.
RequireTransportSecurity() bool
}
PerRPCCredentials defines the common interface for the credentials which need to attach security information to every RPC (e.g., oauth2).
type ProtocolInfo ¶
type ProtocolInfo struct {
// ProtocolVersion is the gRPC wire protocol version.
ProtocolVersion string
// SecurityProtocol is the security protocol in use.
SecurityProtocol string
// SecurityVersion is the security protocol version.
SecurityVersion string
// ServerName is the user-configured server name.
ServerName string
}
ProtocolInfo provides information regarding the gRPC wire protocol version, security protocol, security protocol version in use, server name, etc.
Source Files
¶
- credentials.go
- credentials_util_go18.go