Documentation
¶
Index ¶
Constants ¶
const ( // From IANA Service Name and Transport Protocol Port Number Registry. See // https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=cockroachdb DefaultPort = "26257" // The default port for HTTP-for-humans. DefaultHTTPPort = "8080" // NetworkTimeout is the timeout used for network operations. NetworkTimeout = 3 * time.Second )
Base context defaults.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context struct {
// Insecure specifies whether to use SSL or not.
// This is really not recommended.
Insecure bool
// SSLCA and others contain the paths to the ssl certificates and keys.
SSLCA string // CA certificate
SSLCAKey string // CA key (to sign only)
SSLCert string // Client/server certificate
SSLCertKey string // Client/server key
// User running this process. It could be the user under which
// the server is running or the user passed in client calls.
User string
// contains filtered or unexported fields
}
Context is embedded by server.Context. A base context is not meant to be used directly, but embedding contexts should call ctx.InitDefaults().
func (*Context) GetClientTLSConfig ¶
GetClientTLSConfig returns the context client TLS config, initializing it if needed. If Insecure is true, return a nil config, otherwise load a config based on the SSLCert file. If SSLCert is empty, use a very permissive config. TODO(marc): empty SSLCert should fail when client certificates are required.
func (*Context) GetHTTPClient ¶
GetHTTPClient returns the context http client, initializing it if needed. It uses the context client TLS config.
func (*Context) GetServerTLSConfig ¶
GetServerTLSConfig returns the context server TLS config, initializing it if needed. If Insecure is true, return a nil config, otherwise load a config based on the SSLCert file. Fails if Insecure=false and SSLCert="".
func (*Context) HTTPRequestScheme ¶
HTTPRequestScheme returns "http" or "https" based on the value of Insecure.
func (*Context) InitDefaults ¶
func (ctx *Context) InitDefaults()
InitDefaults sets up the default values for a context.
Source Files