keto

Documentation

Index

• Constants
• func KetoConn(ctx context.Context, remote string, cd *KetoConnectionDetails) (*grpc.ClientConn, error)
• type KetoConnectionDetails
  • func NewKetoConnectionDetailsFromEnv() KetoConnectionDetails
  • func (cd *KetoConnectionDetails) ReadConn(ctx context.Context) (*grpc.ClientConn, error)
  • func (cd *KetoConnectionDetails) WriteConn(ctx context.Context) (*grpc.ClientConn, error)
• type KetoGrpcClient
  • func NewKetoGrpcClient(ctx Context, cd KetoConnectionDetails) (*KetoGrpcClient, error)
  • func (g *KetoGrpcClient) Check(ctx Context, r *rts.RelationTuple) (bool, error)
  • func (g *KetoGrpcClient) CreateObservabilityTenantInKeto(ctx context.Context, name string) error
  • func (g *KetoGrpcClient) CreateObservabilityTenantInKetoIfNotExists(ctx context.Context, name string) error
  • func (g *KetoGrpcClient) CreateTuple(ctx Context, r *rts.RelationTuple) error
  • func (g *KetoGrpcClient) CreateTuples(ctx Context, r []*rts.RelationTuple) error
  • func (g *KetoGrpcClient) DeleteAllTuples(ctx Context, q *rts.RelationQuery) error
  • func (g *KetoGrpcClient) DeleteObservabilityTenantInKeto(ctx context.Context, name string) error
  • func (g *KetoGrpcClient) DeleteTuple(ctx Context, r *rts.RelationTuple) error
  • func (g *KetoGrpcClient) DeleteTuples(ctx Context, r []*rts.RelationTuple) error
  • func (g *KetoGrpcClient) Expand(ctx Context, ss *rts.Subject, depth int) (*rts.SubjectTree, error)
  • func (g *KetoGrpcClient) ObservabilityTenantExistsInKeto(ctx context.Context, name string) (bool, error)
  • func (g *KetoGrpcClient) QueryAllTuples(ctx Context, q *rts.RelationQuery, pagesize int) ([]*rts.RelationTuple, error)
  • func (g *KetoGrpcClient) QueryTuple(ctx Context, q *rts.RelationQuery, opts ...PaginationOptionSetter) (*rts.ListRelationTuplesResponse, error)
  • func (g *KetoGrpcClient) TransactTuples(ctx Context, ins []*rts.RelationTuple, del []*rts.RelationTuple) error
  • func (g *KetoGrpcClient) WaitUntilLive(ctx Context) error
• type PaginationOptionSetter
  • func KetoWithSize(size int) PaginationOptionSetter
  • func KetoWithToken(t string) PaginationOptionSetter
• type PaginationOptions
  • func GetPaginationOptions(modifiers ...PaginationOptionSetter) *PaginationOptions

Constants

const (
	KetoReadRemoteDefault  = "127.0.0.1:4466"
	KetoWriteRemoteDefault = "127.0.0.1:4467"
	KetoEnvReadRemote      = "KETO_READ_REMOTE"
	KetoEnvWriteRemote     = "KETO_WRITE_REMOTE"
	KetoEnvAuthToken       = "KETO_BEARER_TOKEN" // nosec G101 -- just the key, not the value
	KetoEnvAuthority       = "KETO_AUTHORITY"

	ContextKeyTimeout ketoContextKeys = "timeout"
)

Functions

func KetoConn

func KetoConn(ctx context.Context, remote string, cd *KetoConnectionDetails) (*grpc.ClientConn, error)

Types

type KetoConnectionDetails

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

func NewKetoConnectionDetailsFromEnv

func NewKetoConnectionDetailsFromEnv() KetoConnectionDetails

func (*KetoConnectionDetails) ReadConn

func (cd *KetoConnectionDetails) ReadConn(ctx context.Context) (*grpc.ClientConn, error)

func (*KetoConnectionDetails) WriteConn

func (cd *KetoConnectionDetails) WriteConn(ctx context.Context) (*grpc.ClientConn, error)

type KetoGrpcClient

type KetoGrpcClient struct {
	ConnDetails KetoConnectionDetails
	// contains filtered or unexported fields
}

func NewKetoGrpcClient

func NewKetoGrpcClient(ctx Context, cd KetoConnectionDetails) (*KetoGrpcClient, error)

func (*KetoGrpcClient) Check

func (g *KetoGrpcClient) Check(ctx Context, r *rts.RelationTuple) (bool, error)

func (*KetoGrpcClient) CreateObservabilityTenantInKeto

func (g *KetoGrpcClient) CreateObservabilityTenantInKeto(ctx context.Context, name string) error

function that creates an observability tenant in keto

func (*KetoGrpcClient) CreateObservabilityTenantInKetoIfNotExists

func (g *KetoGrpcClient) CreateObservabilityTenantInKetoIfNotExists(ctx context.Context, name string) error

function that create an obersevability tenant in keto if it doesn't exist

func (*KetoGrpcClient) CreateTuple

func (g *KetoGrpcClient) CreateTuple(ctx Context, r *rts.RelationTuple) error

func (*KetoGrpcClient) CreateTuples

func (g *KetoGrpcClient) CreateTuples(ctx Context, r []*rts.RelationTuple) error

func (*KetoGrpcClient) DeleteAllTuples

func (g *KetoGrpcClient) DeleteAllTuples(ctx Context, q *rts.RelationQuery) error

func (*KetoGrpcClient) DeleteObservabilityTenantInKeto

func (g *KetoGrpcClient) DeleteObservabilityTenantInKeto(ctx context.Context, name string) error

function that deletes an observability tenant from keto

func (*KetoGrpcClient) DeleteTuple

func (g *KetoGrpcClient) DeleteTuple(ctx Context, r *rts.RelationTuple) error

func (*KetoGrpcClient) DeleteTuples

func (g *KetoGrpcClient) DeleteTuples(ctx Context, r []*rts.RelationTuple) error

func (*KetoGrpcClient) Expand

func (g *KetoGrpcClient) Expand(ctx Context, ss *rts.Subject, depth int) (*rts.SubjectTree, error)

func (*KetoGrpcClient) ObservabilityTenantExistsInKeto

func (g *KetoGrpcClient) ObservabilityTenantExistsInKeto(ctx context.Context, name string) (bool, error)

function that checks if an observability tenant exists in keto

func (*KetoGrpcClient) QueryAllTuples

func (g *KetoGrpcClient) QueryAllTuples(ctx Context, q *rts.RelationQuery, pagesize int) ([]*rts.RelationTuple, error)

func (*KetoGrpcClient) QueryTuple

func (g *KetoGrpcClient) QueryTuple(ctx Context, q *rts.RelationQuery, opts ...PaginationOptionSetter) (*rts.ListRelationTuplesResponse, error)

func (*KetoGrpcClient) TransactTuples

func (g *KetoGrpcClient) TransactTuples(ctx Context, ins []*rts.RelationTuple, del []*rts.RelationTuple) error

func (*KetoGrpcClient) WaitUntilLive

func (g *KetoGrpcClient) WaitUntilLive(ctx Context) error

TODO: not sure if this is the correct thing to do

type PaginationOptionSetter

type PaginationOptionSetter func(*PaginationOptions) *PaginationOptions

func KetoWithSize

func KetoWithSize(size int) PaginationOptionSetter

func KetoWithToken

func KetoWithToken(t string) PaginationOptionSetter

type PaginationOptions

type PaginationOptions struct {
	Token string `json:"page_token"`
	Size  int    `json:"page_size"`
}

func GetPaginationOptions

func GetPaginationOptions(modifiers ...PaginationOptionSetter) *PaginationOptions