plugins

Documentation

Index

• type AdminUIPlugin
  • func (p *AdminUIPlugin) ID() string
  • func (p *AdminUIPlugin) Init(s *bramble.ExecutableSchema)
  • func (p *AdminUIPlugin) SetupPrivateMux(mux *http.ServeMux)
• type Claims
• type CorsPlugin
  • func NewCorsPlugin(options CorsPluginConfig) *CorsPlugin
  • func (p *CorsPlugin) ApplyMiddlewarePrivateMux(h http.Handler) http.Handler
  • func (p *CorsPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler
  • func (p *CorsPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error
  • func (p *CorsPlugin) ID() string
• type CorsPluginConfig
• type JWTPlugin
  • func NewJWTPlugin(keyProviders []SigningKeyProvider, ...) *JWTPlugin
  • func (p *JWTPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler
  • func (p *JWTPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error
  • func (p *JWTPlugin) ID() string
• type JWTPluginConfig
• type LimitsPlugin
  • func NewLimitsPlugin(options LimitsPluginConfig) *LimitsPlugin
  • func (p *LimitsPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler
  • func (p *LimitsPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error
  • func (p *LimitsPlugin) ID() string
  • func (p *LimitsPlugin) Init(es *bramble.ExecutableSchema)
• type LimitsPluginConfig
• type ManualSigningKeysProvider
  • func NewManualSigningKeysProvider(keys map[string]string) (*ManualSigningKeysProvider, error)
  • func (m *ManualSigningKeysProvider) Keys() (map[string]*rsa.PublicKey, error)
  • func (m *ManualSigningKeysProvider) Name() string
• type MetaPlugin
  • func NewMetaPlugin() *MetaPlugin
  • func (i *MetaPlugin) GraphqlQueryPath() (bool, string)
  • func (i *MetaPlugin) ID() string
  • func (p *MetaPlugin) Init(s *bramble.ExecutableSchema)
  • func (i *MetaPlugin) SetupPrivateMux(mux *http.ServeMux)
• type PlaygroundPlugin
  • func (p *PlaygroundPlugin) ID() string
  • func (p *PlaygroundPlugin) SetupPublicMux(mux *http.ServeMux)
• type SigningKeyProvider
• type WellKnownKeyProvider
  • func NewWellKnownKeyProvider(url string) *WellKnownKeyProvider
  • func (w *WellKnownKeyProvider) Keys() (map[string]*rsa.PublicKey, error)
  • func (w *WellKnownKeyProvider) MarshalJSON() ([]byte, error)
  • func (w *WellKnownKeyProvider) Name() string
  • func (w *WellKnownKeyProvider) UnmarshalJSON(data []byte) error

Types

type AdminUIPlugin

type AdminUIPlugin struct {
	bramble.BasePlugin
	// contains filtered or unexported fields
}

AdminUIPlugin serves a minimal administration interface.

func (*AdminUIPlugin) ID

func (p *AdminUIPlugin) ID() string

func (*AdminUIPlugin) Init

func (p *AdminUIPlugin) Init(s *bramble.ExecutableSchema)

func (*AdminUIPlugin) SetupPrivateMux

func (p *AdminUIPlugin) SetupPrivateMux(mux *http.ServeMux)

type Claims

type Claims struct {
	jwt.StandardClaims
	Role string
}

type CorsPlugin

type CorsPlugin struct {
	bramble.BasePlugin
	// contains filtered or unexported fields
}

func NewCorsPlugin

func NewCorsPlugin(options CorsPluginConfig) *CorsPlugin

func (*CorsPlugin) ApplyMiddlewarePrivateMux

func (p *CorsPlugin) ApplyMiddlewarePrivateMux(h http.Handler) http.Handler

func (*CorsPlugin) ApplyMiddlewarePublicMux

func (p *CorsPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler

func (*CorsPlugin) Configure

func (p *CorsPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error

func (*CorsPlugin) ID

func (p *CorsPlugin) ID() string

type CorsPluginConfig

type CorsPluginConfig struct {
	AllowedOrigins   []string `json:"allowed-origins"`
	AllowedHeaders   []string `json:"allowed-headers"`
	AllowCredentials bool     `json:"allow-credentials"`
	MaxAge           int      `json:"max-age"`
	Debug            bool     `json:"debug"`
}

type JWTPlugin

type JWTPlugin struct {
	bramble.BasePlugin
	// contains filtered or unexported fields
}

JWTPlugin validates that requests contains a valid JWT access token and add the necessary permissions and information to the context

func NewJWTPlugin

func NewJWTPlugin(keyProviders []SigningKeyProvider, roles map[string]bramble.OperationPermissions) *JWTPlugin

func (*JWTPlugin) ApplyMiddlewarePublicMux

func (p *JWTPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler

func (*JWTPlugin) Configure

func (p *JWTPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error

func (*JWTPlugin) ID

func (p *JWTPlugin) ID() string

type JWTPluginConfig

type JWTPluginConfig struct {
	// List of JWKS endpoints
	JWKS []WellKnownKeyProvider `json:"jwks"`
	// Map of kid -> public key (RSA, PEM format)
	PublicKeys map[string]string                       `json:"public-keys"`
	Roles      map[string]bramble.OperationPermissions `json:"roles"`
}

type LimitsPlugin

type LimitsPlugin struct {
	bramble.BasePlugin
	// contains filtered or unexported fields
}

func NewLimitsPlugin

func NewLimitsPlugin(options LimitsPluginConfig) *LimitsPlugin

func (*LimitsPlugin) ApplyMiddlewarePublicMux

func (p *LimitsPlugin) ApplyMiddlewarePublicMux(h http.Handler) http.Handler

func (*LimitsPlugin) Configure

func (p *LimitsPlugin) Configure(cfg *bramble.Config, data json.RawMessage) error

func (*LimitsPlugin) ID

func (p *LimitsPlugin) ID() string

func (*LimitsPlugin) Init

func (p *LimitsPlugin) Init(es *bramble.ExecutableSchema)

type LimitsPluginConfig

type LimitsPluginConfig struct {
	MaxRequestBytes int64  `json:"max-request-bytes"`
	MaxResponeTime  string `json:"max-response-time"`
	// contains filtered or unexported fields
}

type ManualSigningKeysProvider

type ManualSigningKeysProvider struct {
	// contains filtered or unexported fields
}

func NewManualSigningKeysProvider

func NewManualSigningKeysProvider(keys map[string]string) (*ManualSigningKeysProvider, error)

func (*ManualSigningKeysProvider) Keys

func (m *ManualSigningKeysProvider) Keys() (map[string]*rsa.PublicKey, error)

func (*ManualSigningKeysProvider) Name

func (m *ManualSigningKeysProvider) Name() string

type MetaPlugin

type MetaPlugin struct {
	*bramble.BasePlugin
	// contains filtered or unexported fields
}

func NewMetaPlugin

func NewMetaPlugin() *MetaPlugin

func (*MetaPlugin) GraphqlQueryPath

func (i *MetaPlugin) GraphqlQueryPath() (bool, string)

func (*MetaPlugin) ID

func (i *MetaPlugin) ID() string

func (*MetaPlugin) Init

func (p *MetaPlugin) Init(s *bramble.ExecutableSchema)

func (*MetaPlugin) SetupPrivateMux

func (i *MetaPlugin) SetupPrivateMux(mux *http.ServeMux)

type PlaygroundPlugin

type PlaygroundPlugin struct {
	*bramble.BasePlugin
}

func (*PlaygroundPlugin) ID

func (p *PlaygroundPlugin) ID() string

func (*PlaygroundPlugin) SetupPublicMux

func (p *PlaygroundPlugin) SetupPublicMux(mux *http.ServeMux)

type SigningKeyProvider

type SigningKeyProvider interface {
	Name() string
	Keys() (map[string]*rsa.PublicKey, error)
}

type WellKnownKeyProvider

type WellKnownKeyProvider struct {
	// contains filtered or unexported fields
}

func NewWellKnownKeyProvider

func NewWellKnownKeyProvider(url string) *WellKnownKeyProvider

func (*WellKnownKeyProvider) Keys

func (w *WellKnownKeyProvider) Keys() (map[string]*rsa.PublicKey, error)

func (*WellKnownKeyProvider) MarshalJSON

func (w *WellKnownKeyProvider) MarshalJSON() ([]byte, error)

func (*WellKnownKeyProvider) Name

func (w *WellKnownKeyProvider) Name() string

func (*WellKnownKeyProvider) UnmarshalJSON

func (w *WellKnownKeyProvider) UnmarshalJSON(data []byte) error