restapi

package
v0.3.25 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 22, 2020 License: AGPL-3.0 Imports: 78 Imported by: 0

Documentation

Overview

Package restapi MinIO Console Server 

Schemes:
  http
  ws
Host: localhost
BasePath: /api/v1
Version: 0.1.0

Consumes:
  - application/json

Produces:
  - application/octet-stream
  - application/json

swagger:meta

Index

Constants

View Source 
const (
	// consts for common configuration
	ConsoleVersion               = `0.1.0`
	ConsoleAccessKey             = "CONSOLE_ACCESS_KEY"
	ConsoleSecretKey             = "CONSOLE_SECRET_KEY"
	ConsoleMinIOServer           = "CONSOLE_MINIO_SERVER"
	ConsoleMinIOServerTLSRootCAs = "CONSOLE_MINIO_SERVER_TLS_ROOT_CAS"
	ConsoleProductionMode        = "CONSOLE_PRODUCTION_MODE"
	ConsoleHostname              = "CONSOLE_HOSTNAME"
	ConsolePort                  = "CONSOLE_PORT"
	ConsoleTLSHostname           = "CONSOLE_TLS_HOSTNAME"
	ConsoleTLSPort               = "CONSOLE_TLS_PORT"

	// consts for Secure middleware
	ConsoleSecureAllowedHosts                    = "CONSOLE_SECURE_ALLOWED_HOSTS"
	ConsoleSecureAllowedHostsAreRegex            = "CONSOLE_SECURE_ALLOWED_HOSTS_ARE_REGEX"
	ConsoleSecureFrameDeny                       = "CONSOLE_SECURE_FRAME_DENY"
	ConsoleSecureContentTypeNoSniff              = "CONSOLE_SECURE_CONTENT_TYPE_NO_SNIFF"
	ConsoleSecureBrowserXSSFilter                = "CONSOLE_SECURE_BROWSER_XSS_FILTER"
	ConsoleSecureContentSecurityPolicy           = "CONSOLE_SECURE_CONTENT_SECURITY_POLICY"
	ConsoleSecureContentSecurityPolicyReportOnly = "CONSOLE_SECURE_CONTENT_SECURITY_POLICY_REPORT_ONLY"
	ConsoleSecureHostsProxyHeaders               = "CONSOLE_SECURE_HOSTS_PROXY_HEADERS"
	ConsoleSecureSTSSeconds                      = "CONSOLE_SECURE_STS_SECONDS"
	ConsoleSecureSTSIncludeSubdomains            = "CONSOLE_SECURE_STS_INCLUDE_SUB_DOMAINS"
	ConsoleSecureSTSPreload                      = "CONSOLE_SECURE_STS_PRELOAD"
	ConsoleSecureTLSRedirect                     = "CONSOLE_SECURE_TLS_REDIRECT"
	ConsoleSecureTLSHost                         = "CONSOLE_SECURE_TLS_HOST"
	ConsoleSecureTLSTemporaryRedirect            = "CONSOLE_SECURE_TLS_TEMPORARY_REDIRECT"
	ConsoleSecureForceSTSHeader                  = "CONSOLE_SECURE_FORCE_STS_HEADER"
	ConsoleSecurePublicKey                       = "CONSOLE_SECURE_PUBLIC_KEY"
	ConsoleSecureReferrerPolicy                  = "CONSOLE_SECURE_REFERRER_POLICY"
	ConsoleSecureFeaturePolicy                   = "CONSOLE_SECURE_FEATURE_POLICY"
	ConsoleSecureExpectCTHeader                  = "CONSOLE_SECURE_EXPECT_CT_HEADER"
)

Variables

View Source 
var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage
)
View Source 
var Hostname = "0.0.0.0"

Hostname console hostname

View Source 
var (
	MinioEndpoint = getMinIOServer()
)

STSClient contains http.client configuration need it by STSAssumeRole

View Source 
var Port = "9090"

Port console default port

View Source 
var TLSHostname = "0.0.0.0"

TLSHostname console tls hostname

View Source 
var TLSPort = "9443"

TLSPort console tls port

View Source 
var TLSRedirect = "off"

TLSRedirect console tls redirect rule

Functions

func DifferenceArrays 

func DifferenceArrays(a, b []string) []string

DifferenceArrays returns the elements in `a` that aren't in `b`.

func FileExists 

func FileExists(filename string) bool

FileExists verifies if a file exist on the desired location and its not a folder

func FileServerMiddleware 

func FileServerMiddleware(next http.Handler) http.Handler

FileServerMiddleware serves files from the static folder

func GetClaimsFromJWT 

func GetClaimsFromJWT(jwt string) (*auth.DecryptedClaims, error)

GetClaimsFromJWT decrypt and returns the claims associated to a provided jwt

func GetHostname 

func GetHostname() string

GetHostname gets console hostname set on env variable, default one or defined on run command

func GetPort 

func GetPort() int

GetPort gets console por set on env variable or default one

func GetTLSHostname added in v0.3.11 

func GetTLSHostname() string

GetTLSHostname gets console tls hostname set on env variable or default one

func GetTLSPort added in v0.3.11 

func GetTLSPort() int

GetTLSPort gets console tls port set on env variable or default one

func GetTenantServiceURL added in v0.3.25 

func GetTenantServiceURL(mi *operator.Tenant) (svcURL string)

GetTenantServiceURL gets tenant's service url with the proper scheme and port

func IsElementInArray 

func IsElementInArray(a []string, b string) bool

IsElementInArray returns true if the string belongs to the slice

func NewAdminClient 

func NewAdminClient(url, accessKey, secretKey string) (*madmin.AdminClient, *probe.Error)

NewAdminClient gives a new madmin client interface

func NewAdminClientWithInsecure added in v0.3.5 

func NewAdminClientWithInsecure(url, accessKey, secretKey string, insecure bool) (*madmin.AdminClient, *probe.Error)

NewAdminClientWithInsecure gives a new madmin client interface either secure or insecure based on parameter

func PrepareSTSClient 

func PrepareSTSClient(insecure bool) *http.Client

PrepareSTSClient returns an http.Client with custom configurations need it by *credentials.STSAssumeRole custom configurations include the use of CA certificates

func RandomCharString 

func RandomCharString(n int) string

func RandomCharStringWithAlphabet 

func RandomCharStringWithAlphabet(n int, alphabet string) string

func UniqueKeys 

func UniqueKeys(a []string) []string

UniqueKeys returns an array without duplicated keys

Types

type ConsoleCredentials 

type ConsoleCredentials interface {
	Get() (credentials.Value, error)
	Expire()
}

ConsoleCredentials interface with all functions to be implemented by mock when testing, it should include all needed consoleCredentials.Login api calls that are used within this project.

type ConsoleWebsocket 

type ConsoleWebsocket interface {
	// contains filtered or unexported methods
}

ConsoleWebsocket interface of a Websocket Client

type ConsoleWebsocketAdmin 

type ConsoleWebsocketAdmin interface {
	// contains filtered or unexported methods
}

ConsoleWebsocketAdmin interface of a Websocket Client

type K8sClientI added in v0.3.19 

type K8sClientI interface {
	// contains filtered or unexported methods
}

K8sClientI interface with all functions to be implemented by mock when testing, it should include all K8sClientI respective api calls that are used within this project.

type MCClient added in v0.3.1 

type MCClient interface {
	// contains filtered or unexported methods
}

MCClient interface with all functions to be implemented by mock when testing, it should include all mc/S3Client respective api calls that are used within this project.

type MinioAdmin 

type MinioAdmin interface {
	// contains filtered or unexported methods
}

MinioAdmin interface with all functions to be implemented by mock when testing, it should include all MinioAdmin respective api calls that are used within this project.

type MinioClient 

type MinioClient interface {
	// contains filtered or unexported methods
}

MinioClient interface with all functions to be implemented by mock when testing, it should include all MinioClient respective api calls that are used within this project.

type OperatorClientI added in v0.3.19 

type OperatorClientI interface {
	TenantDelete(ctx context.Context, namespace string, instanceName string, options metav1.DeleteOptions) error
	TenantGet(ctx context.Context, namespace string, instanceName string, options metav1.GetOptions) (*v1.Tenant, error)
	TenantPatch(ctx context.Context, namespace string, instanceName string, pt types.PatchType, data []byte, options metav1.PatchOptions) (*v1.Tenant, error)
	TenantList(ctx context.Context, namespace string, opts metav1.ListOptions) (*v1.TenantList, error)
}

OperatorClientI interface with all functions to be implemented by mock when testing, it should include all OperatorClientI respective api calls that are used within this project.

type Server 

type Server struct {
	EnabledListeners []string         `long:"scheme" description:"the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec"`
	CleanupTimeout   time.Duration    `long:"cleanup-timeout" description:"grace period for which to wait before killing idle connections" default:"10s"`
	GracefulTimeout  time.Duration    `long:"graceful-timeout" description:"grace period for which to wait before shutting down the server" default:"15s"`
	MaxHeaderSize    flagext.ByteSize `` /* 231-byte string literal not displayed */

	SocketPath flags.Filename `long:"socket-path" description:"the unix socket to listen on" default:"/var/run/console.sock"`

	Host         string        `long:"host" description:"the IP to listen on" default:"localhost" env:"HOST"`
	Port         int           `long:"port" description:"the port to listen on for insecure connections, defaults to a random value" env:"PORT"`
	ListenLimit  int           `long:"listen-limit" description:"limit the number of outstanding requests"`
	KeepAlive    time.Duration `` /* 169-byte string literal not displayed */
	ReadTimeout  time.Duration `long:"read-timeout" description:"maximum duration before timing out read of the request" default:"30s"`
	WriteTimeout time.Duration `long:"write-timeout" description:"maximum duration before timing out write of the response" default:"60s"`

	TLSHost           string         `long:"tls-host" description:"the IP to listen on for tls, when not specified it's the same as --host" env:"TLS_HOST"`
	TLSPort           int            `long:"tls-port" description:"the port to listen on for secure connections, defaults to a random value" env:"TLS_PORT"`
	TLSCertificate    flags.Filename `long:"tls-certificate" description:"the certificate to use for secure connections" env:"TLS_CERTIFICATE"`
	TLSCertificateKey flags.Filename `long:"tls-key" description:"the private key to use for secure connections" env:"TLS_PRIVATE_KEY"`
	TLSCACertificate  flags.Filename `long:"tls-ca" description:"the certificate authority file to be used with mutual tls auth" env:"TLS_CA_CERTIFICATE"`
	TLSListenLimit    int            `long:"tls-listen-limit" description:"limit the number of outstanding requests"`
	TLSKeepAlive      time.Duration  `` /* 160-byte string literal not displayed */
	TLSReadTimeout    time.Duration  `long:"tls-read-timeout" description:"maximum duration before timing out read of the request"`
	TLSWriteTimeout   time.Duration  `long:"tls-write-timeout" description:"maximum duration before timing out write of the response"`
	// contains filtered or unexported fields
}

Server for the console API

func NewServer 

func NewServer(api *operations.ConsoleAPI) *Server

NewServer creates a new api console server but does not configure it

func (*Server) ConfigureAPI 

func (s *Server) ConfigureAPI()

ConfigureAPI configures the API and handlers.

func (*Server) ConfigureFlags 

func (s *Server) ConfigureFlags()

ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse

func (*Server) Fatalf 

func (s *Server) Fatalf(f string, args ...interface{})

Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing

func (*Server) GetHandler 

func (s *Server) GetHandler() http.Handler

GetHandler returns a handler useful for testing

func (*Server) HTTPListener 

func (s *Server) HTTPListener() (net.Listener, error)

HTTPListener returns the http listener

func (*Server) Listen 

func (s *Server) Listen() error

Listen creates the listeners for the server

func (*Server) Logf 

func (s *Server) Logf(f string, args ...interface{})

Logf logs message either via defined user logger or via system one if no user logger is defined.

func (*Server) Serve 

func (s *Server) Serve() (err error)

Serve the api

func (*Server) SetAPI 

func (s *Server) SetAPI(api *operations.ConsoleAPI)

SetAPI configures the server with the specified API. Needs to be called before Serve

func (*Server) SetHandler 

func (s *Server) SetHandler(handler http.Handler)

SetHandler allows for setting a http handler on this server

func (*Server) Shutdown 

func (s *Server) Shutdown() error

Shutdown server and clean up resources

func (*Server) TLSListener 

func (s *Server) TLSListener() (net.Listener, error)

TLSListener returns the https listener

func (*Server) UnixListener 

func (s *Server) UnixListener() (net.Listener, error)

UnixListener returns the domain socket listener

type WSConn 

type WSConn interface {
	// contains filtered or unexported methods
}

WSConn interface with all functions to be implemented by mock when testing, it should include all websocket.Conn respective api calls that are used within this project.

Source Files

View all Source files

Directories

Path Synopsis
admin_api
user_api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.