authorizer

Documentation

Index

• Constants
• type Authorizer
• type ContextKey
• type Instancer
• type MetadataBasedAuthorizer
  • func (s *MetadataBasedAuthorizer) Configure(tableName string, roleMapping map[string]dbrole.DbRole)
  • func (s *MetadataBasedAuthorizer) GetAuthContext(orgId string, roles ...string) context.Context
  • func (s *MetadataBasedAuthorizer) GetDefaultOrgAdminContext() context.Context
  • func (s *MetadataBasedAuthorizer) GetMatchingDbRole(ctx context.Context, tableNames ...string) (dbrole.DbRole, error)
  • func (s *MetadataBasedAuthorizer) GetOrgFromContext(ctx context.Context) (string, error)
• type SimpleInstancer
  • func (s *SimpleInstancer) GetInstanceId(ctx context.Context) (string, error)
  • func (s *SimpleInstancer) WithInstanceId(ctx context.Context, instanceId string) context.Context
• type SimpleTransactionFetcher
  • func (s SimpleTransactionFetcher) GetTransactionCtx(ctx context.Context) *gorm.DB
  • func (s SimpleTransactionFetcher) IsTransactionCtx(ctx context.Context) bool
  • func (s SimpleTransactionFetcher) WithTransactionCtx(ctx context.Context, tx *gorm.DB) context.Context
• type Tenancer
• type TransactionContextKey
• type TransactionFetcher

Constants

const (
	GLOBAL_DEFAULT_ORG_ID = "_GlobalDefaultOrg"

	METADATA_KEY_ORGID            = "orgid"
	METADATA_KEY_ROLE             = "role"
	METADATA_ROLE_SERVICE_ADMIN   = "service_admin"
	METADATA_ROLE_SERVICE_AUDITOR = "service_auditor"
	METADATA_ROLE_ADMIN           = "admin"   // can be tenant_admin, *_admin
	METADATA_ROLE_AUDITOR         = "auditor" // can be tenant_auditor, *_auditor
)

const (
	INSTANCE_ID = ContextKey("multiinstance.id")
)

const (
	TransactionCtx = TransactionContextKey("DB_TRANSACTION")
)

Types

type Authorizer

type Authorizer interface {
	Tenancer
	Configure(tableName string, roleMapping map[string]dbrole.DbRole)
	GetAuthContext(orgId string, roles ...string) context.Context
	GetDefaultOrgAdminContext() context.Context
	GetMatchingDbRole(ctx context.Context, tableNames ...string) (dbrole.DbRole, error)
}

Authorizer Interface defines the methods required for datastore to restrict access based on roles configured in context.

type ContextKey

type ContextKey string

type Instancer

type Instancer interface {
	GetInstanceId(ctx context.Context) (string, error)
	WithInstanceId(ctx context.Context, instanceId string) context.Context
}

type MetadataBasedAuthorizer

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

func (*MetadataBasedAuthorizer) Configure

func (s *MetadataBasedAuthorizer) Configure(tableName string, roleMapping map[string]dbrole.DbRole)

func (*MetadataBasedAuthorizer) GetAuthContext

func (s *MetadataBasedAuthorizer) GetAuthContext(orgId string, roles ...string) context.Context

func (*MetadataBasedAuthorizer) GetDefaultOrgAdminContext

func (s *MetadataBasedAuthorizer) GetDefaultOrgAdminContext() context.Context

func (*MetadataBasedAuthorizer) GetMatchingDbRole

func (s *MetadataBasedAuthorizer) GetMatchingDbRole(ctx context.Context, tableNames ...string) (dbrole.DbRole, error)

func (*MetadataBasedAuthorizer) GetOrgFromContext

func (s *MetadataBasedAuthorizer) GetOrgFromContext(ctx context.Context) (string, error)

type SimpleInstancer

type SimpleInstancer struct{}

func (*SimpleInstancer) GetInstanceId

func (s *SimpleInstancer) GetInstanceId(ctx context.Context) (string, error)

func (*SimpleInstancer) WithInstanceId

func (s *SimpleInstancer) WithInstanceId(ctx context.Context, instanceId string) context.Context

type SimpleTransactionFetcher

type SimpleTransactionFetcher struct{}

func (SimpleTransactionFetcher) GetTransactionCtx

func (s SimpleTransactionFetcher) GetTransactionCtx(ctx context.Context) *gorm.DB

func (SimpleTransactionFetcher) IsTransactionCtx

func (s SimpleTransactionFetcher) IsTransactionCtx(ctx context.Context) bool

func (SimpleTransactionFetcher) WithTransactionCtx

func (s SimpleTransactionFetcher) WithTransactionCtx(ctx context.Context, tx *gorm.DB) context.Context

type Tenancer

type Tenancer interface {
	GetOrgFromContext(ctx context.Context) (string, error)
}

type TransactionContextKey

type TransactionContextKey string

type TransactionFetcher

type TransactionFetcher interface {
	IsTransactionCtx(ctx context.Context) bool
	GetTransactionCtx(ctx context.Context) *gorm.DB
	WithTransactionCtx(ctx context.Context, tx *gorm.DB) context.Context
}