accounts

Documentation

Index

• Variables
• type Access
• type AccessConfig
• type AuthConfig
• type Authenticate
• type BasicAuth
  • func (ba BasicAuth) Validate(md MetaData) (string, error)
• type BasicCredential
• type BulkWriteFilter
  • func (bw *BulkWriteFilter) Context() context.Context
  • func (bw *BulkWriteFilter) RecvMsg(m interface{}) error
  • func (bw *BulkWriteFilter) SendHeader(m metadata.MD) error
  • func (bw *BulkWriteFilter) SendMsg(m interface{}) error
  • func (bw *BulkWriteFilter) SetHeader(m metadata.MD) error
  • func (bw *BulkWriteFilter) SetTrailer(m metadata.MD)
• type CasbinAccess
  • func (ce *CasbinAccess) Enforce(user string, graph string, operation Operation) error
• type Config
  • func (c *Config) StreamInterceptor() grpc.StreamServerInterceptor
  • func (c *Config) UnaryInterceptor() grpc.UnaryServerInterceptor
• type MetaData
• type NullAccess
  • func (be NullAccess) Enforce(user string, graph string, operation Operation) error
• type NullAuth
  • func (na NullAuth) Validate(md MetaData) (string, error)
• type Operation
• type ProxyAuth
  • func (ba ProxyAuth) Validate(md MetaData) (string, error)
• type StreamOutWrapper
  • func NewStreamOutWrapper[X any](inSS grpc.ServerStream) (*StreamOutWrapper[X], error)
  • func (bw *StreamOutWrapper[X]) Context() context.Context
  • func (bw *StreamOutWrapper[X]) RecvMsg(m interface{}) error
  • func (bw *StreamOutWrapper[X]) SendHeader(m metadata.MD) error
  • func (bw *StreamOutWrapper[X]) SendMsg(m interface{}) error
  • func (bw *StreamOutWrapper[X]) SetHeader(m metadata.MD) error
  • func (bw *StreamOutWrapper[X]) SetTrailer(m metadata.MD)

Variables

var MethodMap = map[string]Operation{
	"/gripql.Query/Traversal":    Query,
	"/gripql.Query/GetVertex":    Read,
	"/gripql.Query/GetEdge":      Read,
	"/gripql.Query/GetTimestamp": Read,
	"/gripql.Query/GetSchema":    Read,
	"/gripql.Query/GetMapping":   Read,
	"/gripql.Query/ListGraphs":   Read,
	"/gripql.Query/ListIndices":  Read,
	"/gripql.Query/ListLabels":   Read,

	"/gripql.Job/Submit":     Exec,
	"/gripql.Job/ListJobs":   Read,
	"/gripql.Job/SearchJobs": Read,
	"/gripql.Job/DeleteJob":  Write,
	"/gripql.Job/GetJob":     Read,
	"/gripql.Job/ViewJob":    Read,
	"/gripql.Job/ResumeJob":  Exec,

	"/gripql.Edit/AddVertex":    Write,
	"/gripql.Edit/AddEdge":      Write,
	"/gripql.Edit/BulkAdd":      Write,
	"/gripql.Edit/AddGraph":     Write,
	"/gripql.Edit/DeleteGraph":  Write,
	"/gripql.Edit/DeleteVertex": Write,
	"/gripql.Edit/DeleteEdge":   Write,
	"/gripql.Edit/AddIndex":     Write,
	"/gripql.Edit/AddSchema":    Write,
	"/gripql.Edit/AddMapping":   Write,
	"/gripql.Edit/SampleSchema": Write,

	"/gripql.Configure/StartPlugin": Admin,
	"/gripql.Configure/ListPlugin":  Admin,
	"/gripql.Configure/ListDrivers": Admin,
}

Types

type Access

type Access interface {
	Enforce(user string, graph string, operation Operation) error
}

type AccessConfig

type AccessConfig struct {
	Null   *NullAccess
	Casbin *CasbinAccess
}

type AuthConfig

type AuthConfig struct {
	Basic *BasicAuth
	Proxy *ProxyAuth
}

type Authenticate

type Authenticate interface {
	Validate(md MetaData) (string, error)
}

type BasicAuth

type BasicAuth []BasicCredential

func (BasicAuth) Validate

func (ba BasicAuth) Validate(md MetaData) (string, error)

type BasicCredential

type BasicCredential struct {
	User     string
	Password string
}

BasicCredential describes a username and password for use with Funnel's basic auth.

type BulkWriteFilter

type BulkWriteFilter struct {
	SS     grpc.ServerStream
	User   string
	Access Access
}

func (*BulkWriteFilter) Context

func (bw *BulkWriteFilter) Context() context.Context

func (*BulkWriteFilter) RecvMsg

func (bw *BulkWriteFilter) RecvMsg(m interface{}) error

func (*BulkWriteFilter) SendHeader

func (bw *BulkWriteFilter) SendHeader(m metadata.MD) error

func (*BulkWriteFilter) SendMsg

func (bw *BulkWriteFilter) SendMsg(m interface{}) error

func (*BulkWriteFilter) SetHeader

func (bw *BulkWriteFilter) SetHeader(m metadata.MD) error

func (*BulkWriteFilter) SetTrailer

func (bw *BulkWriteFilter) SetTrailer(m metadata.MD)

type CasbinAccess

type CasbinAccess struct {
	Model  string
	Policy string
	// contains filtered or unexported fields
}

func (*CasbinAccess) Enforce

func (ce *CasbinAccess) Enforce(user string, graph string, operation Operation) error

type Config

type Config struct {
	Auth   *AuthConfig
	Access *AccessConfig
	// contains filtered or unexported fields
}

func (*Config) StreamInterceptor

func (c *Config) StreamInterceptor() grpc.StreamServerInterceptor

func (*Config) UnaryInterceptor

func (c *Config) UnaryInterceptor() grpc.UnaryServerInterceptor

type MetaData

type MetaData map[string][]string

type NullAccess

type NullAccess struct{}

func (NullAccess) Enforce

func (be NullAccess) Enforce(user string, graph string, operation Operation) error

type NullAuth

type NullAuth struct{}

func (NullAuth) Validate

func (na NullAuth) Validate(md MetaData) (string, error)

type Operation

type Operation string

const (
	Query       Operation = "query"
	Write       Operation = "write"
	Read        Operation = "read"
	Exec        Operation = "exec"
	Admin       Operation = "admin"
	QueryRepeat Operation = "query_repeat"
)

type ProxyAuth

type ProxyAuth struct {
	Field string
}

func (ProxyAuth) Validate

func (ba ProxyAuth) Validate(md MetaData) (string, error)

type StreamOutWrapper

type StreamOutWrapper[X any] struct {
	Request X
	SS      grpc.ServerStream
}

func NewStreamOutWrapper

func NewStreamOutWrapper[X any](inSS grpc.ServerStream) (*StreamOutWrapper[X], error)

func (*StreamOutWrapper[X]) Context

func (bw *StreamOutWrapper[X]) Context() context.Context

func (*StreamOutWrapper[X]) RecvMsg

func (bw *StreamOutWrapper[X]) RecvMsg(m interface{}) error

func (*StreamOutWrapper[X]) SendHeader

func (bw *StreamOutWrapper[X]) SendHeader(m metadata.MD) error

func (*StreamOutWrapper[X]) SendMsg

func (bw *StreamOutWrapper[X]) SendMsg(m interface{}) error

func (*StreamOutWrapper[X]) SetHeader

func (bw *StreamOutWrapper[X]) SetHeader(m metadata.MD) error

func (*StreamOutWrapper[X]) SetTrailer

func (bw *StreamOutWrapper[X]) SetTrailer(m metadata.MD)