client

Sep 13, 2023

Changes in this version

type Opt

+ func WithStreamInterceptors(interceptors ...grpc.StreamClientInterceptor) Opt

+ func WithUnaryInterceptors(interceptors ...grpc.UnaryClientInterceptor) Opt

Jul 18, 2023

Changes in this version

type DerivedRoles

+ func (dr *DerivedRoles) WithVariable(name, expr string) *DerivedRoles

+ func (dr *DerivedRoles) WithVariablesImports(name ...string) *DerivedRoles

+ type ExportVariables struct

+ func NewExportVariables(name string) *ExportVariables

+ func (ev *ExportVariables) AddVariable(name, expr string) *ExportVariables

+ func (ev *ExportVariables) Err() error

+ func (ev *ExportVariables) Validate() error

type ListPoliciesOption

+ func WithNameRegexp(re string) ListPoliciesOption

+ func WithScopeRegexp(re string) ListPoliciesOption

+ func WithVersionRegexp(v string) ListPoliciesOption

type PolicySet

+ func (ps *PolicySet) AddExportVariables(policies ...*ExportVariables) *PolicySet

type Principal

+ func (p *Principal) ID() string

+ func (p *Principal) Proto() *enginev1.Principal

+ func (p *Principal) Roles() []string

type PrincipalPolicy

+ func (pp *PrincipalPolicy) WithVariable(name, expr string) *PrincipalPolicy

+ func (pp *PrincipalPolicy) WithVariablesImports(name ...string) *PrincipalPolicy

type Resource

+ func (r *Resource) ID() string

+ func (r *Resource) Kind() string

+ func (r *Resource) Proto() *enginev1.Resource

type ResourcePolicy

+ func (rp *ResourcePolicy) WithVariable(name, expr string) *ResourcePolicy

+ func (rp *ResourcePolicy) WithVariablesImports(name ...string) *ResourcePolicy

Jun 7, 2023

Changes in this version

type ResourceResult

+ func (rr *ResourceResult) Output(key string) *structpb.Value

Apr 17, 2023

Changes in this version

+ const MaxIDPerReq

+ func BatchAdminClientCall(ctx context.Context, ...) (uint32, error)

+ func BatchAdminClientCall2(ctx context.Context, retrieveFn func(context.Context, ...string) (T, error), ...) error

+ func MinInt(a, b int) int

type AdminClient

+ EnablePolicy func(ctx context.Context, ids ...string) (uint32, error)

type GrpcAdminClient

+ func (c *GrpcAdminClient) EnablePolicy(ctx context.Context, ids ...string) (uint32, error)

+ type ListPoliciesOption func(*requestv1.ListPoliciesRequest)

+ func WithIncludeDisabled() ListPoliciesOption

Feb 13, 2023

Changes in this version

type AdminClient

+ DeleteSchema func(ctx context.Context, ids ...string) (uint32, error)

+ DisablePolicy func(ctx context.Context, ids ...string) (uint32, error)

type GrpcAdminClient

+ func (c *GrpcAdminClient) DeleteSchema(ctx context.Context, ids ...string) (uint32, error)

+ func (c *GrpcAdminClient) DisablePolicy(ctx context.Context, ids ...string) (uint32, error)

Nov 7, 2022

Changes in this version

type PrincipalPolicy

+ func (pp *PrincipalPolicy) WithScope(scope string) *PrincipalPolicy

+ func (pp *PrincipalPolicy) WithVersion(version string) *PrincipalPolicy

type ResourcePolicy

+ func (rp *ResourcePolicy) WithPrincipalSchema(principalSchema *Schema) *ResourcePolicy

+ func (rp *ResourcePolicy) WithResourceSchema(resourceSchema *Schema) *ResourcePolicy

+ func (rp *ResourcePolicy) WithScope(scope string) *ResourcePolicy

type ResourceRule

+ func (rr *ResourceRule) WithName(name string) *ResourceRule

+ type Schema struct

+ func NewSchema(ref string) *Schema

+ func (s *Schema) AddIgnoredActions(actions ...string) *Schema

+ func (s *Schema) Validate() error

+ func (s *Schema) WithRef(ref string) *Schema

Aug 12, 2022

Changes in this version

type Principal

+ func (p *Principal) WithScope(scope string) *Principal

type Resource

+ func (r *Resource) WithScope(scope string) *Resource

Jun 16, 2022

Changes in this version

type SchemaSet

+ func (ss *SchemaSet) AddSchemaFromFileWithIDAndErr(file, id string) (*SchemaSet, error)

May 2, 2022

Changes in this version

+ type CheckResourcesResponse struct

+ func (crr *CheckResourcesResponse) Errors() error

+ func (crr *CheckResourcesResponse) GetResource(resourceID string, match ...MatchResource) *ResourceResult

+ func (crr *CheckResourcesResponse) MarshalJSON() ([]byte, error)

+ func (crr *CheckResourcesResponse) String() string

type Client

+ CheckResources func(ctx context.Context, principal *Principal, resources *ResourceBatch) (*CheckResourcesResponse, error)

+ PlanResources func(ctx context.Context, principal *Principal, resource *Resource, action string) (*PlanResourcesResponse, error)

+ WithPrincipal func(principal *Principal) PrincipalContext

+ type MatchResource func(*responsev1.CheckResourcesResponse_ResultEntry_Resource) bool

+ func MatchResourceKind(kind string) MatchResource

+ func MatchResourcePolicyKindScopeVersion(kind, version, scope string) MatchResource

+ func MatchResourcePolicyVersion(version string) MatchResource

+ func MatchResourceScope(scope string) MatchResource

+ type PlanResourcesResponse struct

+ type PrincipalContext interface

+ CheckResources func(ctx context.Context, resources *ResourceBatch) (*CheckResourcesResponse, error)

+ IsAllowed func(ctx context.Context, resource *Resource, action string) (bool, error)

+ PlanResources func(ctx context.Context, resource *Resource, action string) (*PlanResourcesResponse, error)

+ Principal func() *Principal

+ type ResourceResult struct

+ func (rr *ResourceResult) Err() error

+ func (rr *ResourceResult) IsAllowed(action string) bool

Apr 4, 2022

Changes in this version

type AdminClient

+ ReloadStore func(ctx context.Context, wait bool) error

type GrpcAdminClient

+ func (c *GrpcAdminClient) ReloadStore(ctx context.Context, wait bool) error

Mar 8, 2022

Changes in this version

type AdminClient

+ AddOrUpdateSchema func(ctx context.Context, schemas *SchemaSet) error

type GrpcAdminClient

+ func (c *GrpcAdminClient) AddOrUpdateSchema(ctx context.Context, schemas *SchemaSet) error

type PolicySet

+ func (ps *PolicySet) AddPolicyFromFileWithErr(file string) (*PolicySet, error)

+ type SchemaSet struct

+ func NewSchemaSet() *SchemaSet

+ func (ss *SchemaSet) AddSchemaFromFile(file string, ignorePathInID bool) *SchemaSet

+ func (ss *SchemaSet) AddSchemaFromFileWithErr(file string, ignorePathInID bool) (*SchemaSet, error)

+ func (ss *SchemaSet) AddSchemaFromReader(r io.Reader, id string) *SchemaSet

+ func (ss *SchemaSet) AddSchemas(schemas ...*schemav1.Schema) *SchemaSet

+ func (ss *SchemaSet) Err() error

+ func (ss *SchemaSet) GetSchemas() []*schemav1.Schema

+ func (ss *SchemaSet) Size() int

Feb 23, 2022

Changes in this version

type PolicySet

+ func (ps *PolicySet) Size() int

Jan 18, 2022

Changes in this version

type AdminClient

+ GetPolicy func(ctx context.Context, ids ...string) ([]*policyv1.Policy, error)

+ GetSchema func(ctx context.Context, ids ...string) ([]*schemav1.Schema, error)

+ ListSchemas func(ctx context.Context) ([]string, error)

type Client

+ ResourcesQueryPlan func(ctx context.Context, principal *Principal, resource *Resource, action string) (*ResourcesQueryPlanResponse, error)

type GrpcAdminClient

+ func (c *GrpcAdminClient) GetPolicy(ctx context.Context, ids ...string) ([]*policyv1.Policy, error)

+ func (c *GrpcAdminClient) GetSchema(ctx context.Context, ids ...string) ([]*schemav1.Schema, error)

+ func (c *GrpcAdminClient) ListSchemas(ctx context.Context) ([]string, error)

type PolicySet

+ func (ps *PolicySet) AddPolicies(policies ...*policyv1.Policy) *PolicySet

+ func (ps *PolicySet) GetPolicies() []*policyv1.Policy

type RequestOpt

+ func IncludeMeta(f bool) RequestOpt

+ type ResourcesQueryPlanResponse struct

Dec 15, 2021

Changes in this version

type CheckResourceBatchResponse

+ func (crbr *CheckResourceBatchResponse) Errors() error

+ func (crbr *CheckResourceBatchResponse) MarshalJSON() ([]byte, error)

type CheckResourceSetResponse

+ func (crsr *CheckResourceSetResponse) Errors() error

+ func (crsr *CheckResourceSetResponse) MarshalJSON() ([]byte, error)

type ServerInfo

+ func (si *ServerInfo) MarshalJSON() ([]byte, error)

+ func (si *ServerInfo) String() string

Oct 25, 2021

Changes in this version

type Client

+ With func(opts ...RequestOpt) Client

+ type ListOpt func(*policyListOptions)

+ func FieldEqualsFilter(path, value string) ListOpt

+ func FieldMatchesFilter(path, value string) ListOpt

+ func SortAscending(field ListPoliciesSortingType) ListOpt

+ func SortDescending(field ListPoliciesSortingType) ListOpt

+ type ListPoliciesSortingType uint8

+ const SortByName

+ const SortByVersion

+ type RequestOpt func(*reqOpt)

+ func AuxDataJWT(token, keySetID string) RequestOpt

Oct 1, 2021

Changes in this version

+ type FilterOpt func(*policyFilter)

+ func FieldEquals(path, value string) FilterOpt

+ func FieldMatches(path, value string) FilterOpt

Sep 22, 2021

Changes in this version

type AdminClient

+ ListPolicies func(ctx context.Context) ([]*policyv1.Policy, error)

type GrpcAdminClient

+ func (c *GrpcAdminClient) ListPolicies(ctx context.Context) ([]*policyv1.Policy, error)

Sep 1, 2021

Changes in this version

type Opt

+ func WithPlaygroundInstance(instance string) Opt

Aug 23, 2021

Changes in this version

type AdminClient

+ AuditLogs func(ctx context.Context, opts AuditLogOptions) (<-chan *AuditLogEntry, error)

+ type AuditLogEntry struct

+ func (e *AuditLogEntry) AccessLog() (*auditv1.AccessLogEntry, error)

+ func (e *AuditLogEntry) DecisionLog() (*auditv1.DecisionLogEntry, error)

+ type AuditLogOptions struct

+ EndTime time.Time

+ Lookup string

+ StartTime time.Time

+ Tail uint32

+ Type AuditLogType

+ type AuditLogType uint8

+ const AccessLogs

+ const DecisionLogs

type Client

+ ServerInfo func(context.Context) (*ServerInfo, error)

+ type GrpcAdminClient struct

+ func (c *GrpcAdminClient) AddOrUpdatePolicy(ctx context.Context, policies *PolicySet) error

+ func (c *GrpcAdminClient) AuditLogs(ctx context.Context, opts AuditLogOptions) (<-chan *AuditLogEntry, error)

+ type ServerInfo struct

Aug 3, 2021

Changes in this version

+ func MatchAllOf(m ...match) match

+ func MatchAnyOf(m ...match) match

+ func MatchExpr(expr string) match

+ func MatchNoneOf(m ...match) match

+ type AdminClient interface

+ AddOrUpdatePolicy func(context.Context, *PolicySet) error

+ func NewAdminClient(address string, opts ...Opt) (AdminClient, error)

+ func NewAdminClientWithCredentials(address, username, password string, opts ...Opt) (AdminClient, error)

+ type CheckResourceBatchResponse struct

+ func (crbr *CheckResourceBatchResponse) IsAllowed(resourceID, action string) bool

+ func (crbr *CheckResourceBatchResponse) String() string

+ type CheckResourceSetResponse struct

+ func (crsr *CheckResourceSetResponse) IsAllowed(resourceID, action string) bool

+ func (crsr *CheckResourceSetResponse) String() string

+ type Client interface

+ CheckResourceBatch func(context.Context, *Principal, *ResourceBatch) (*CheckResourceBatchResponse, error)

+ CheckResourceSet func(context.Context, *Principal, *ResourceSet, ...string) (*CheckResourceSetResponse, error)

+ IsAllowed func(context.Context, *Principal, *Resource, string) (bool, error)

+ func New(address string, opts ...Opt) (Client, error)

+ type DerivedRoles struct

+ func NewDerivedRoles(name string) *DerivedRoles

+ func (dr *DerivedRoles) AddRole(name string, parentRoles []string) *DerivedRoles

+ func (dr *DerivedRoles) AddRoleWithCondition(name string, parentRoles []string, m match) *DerivedRoles

+ func (dr *DerivedRoles) Err() error

+ func (dr *DerivedRoles) Validate() error

+ type Opt func(*config)

+ func WithConnectTimeout(timeout time.Duration) Opt

+ func WithMaxRetries(retries uint) Opt

+ func WithPlaintext() Opt

+ func WithRetryTimeout(timeout time.Duration) Opt

+ func WithTLSAuthority(authority string) Opt

+ func WithTLSCACert(certPath string) Opt

+ func WithTLSClientCert(cert, key string) Opt

+ func WithTLSInsecure() Opt

+ func WithUserAgent(ua string) Opt

+ type PolicySet struct

+ func NewPolicySet() *PolicySet

+ func (ps *PolicySet) AddDerivedRoles(policies ...*DerivedRoles) *PolicySet

+ func (ps *PolicySet) AddPolicyFromFile(file string) *PolicySet

+ func (ps *PolicySet) AddPolicyFromReader(r io.Reader) *PolicySet

+ func (ps *PolicySet) AddPrincipalPolicies(policies ...*PrincipalPolicy) *PolicySet

+ func (ps *PolicySet) AddResourcePolicies(policies ...*ResourcePolicy) *PolicySet

+ func (ps *PolicySet) Err() error

+ func (ps *PolicySet) Validate() error

+ type Principal struct

+ func NewPrincipal(id string, roles ...string) *Principal

+ func (p *Principal) Err() error

+ func (p *Principal) Validate() error

+ func (p *Principal) WithAttr(key string, value interface{}) *Principal

+ func (p *Principal) WithAttributes(attr map[string]interface{}) *Principal

+ func (p *Principal) WithPolicyVersion(policyVersion string) *Principal

+ func (p *Principal) WithRoles(roles ...string) *Principal

+ type PrincipalPolicy struct

+ func NewPrincipalPolicy(principal, version string) *PrincipalPolicy

+ func (pp *PrincipalPolicy) AddPrincipalRules(rules ...*PrincipalRule) *PrincipalPolicy

+ func (pp *PrincipalPolicy) Err() error

+ func (pp *PrincipalPolicy) Validate() error

+ type PrincipalRule struct

+ func NewPrincipalRule(resource string) *PrincipalRule

+ func (pr *PrincipalRule) AllowAction(action string) *PrincipalRule

+ func (pr *PrincipalRule) AllowActionOnCondition(action string, m match) *PrincipalRule

+ func (pr *PrincipalRule) DenyAction(action string) *PrincipalRule

+ func (pr *PrincipalRule) DenyActionOnCondition(action string, m match) *PrincipalRule

+ func (pr *PrincipalRule) Err() error

+ func (pr *PrincipalRule) Validate() error

+ type Resource struct

+ func NewResource(kind, id string) *Resource

+ func (r *Resource) Err() error

+ func (r *Resource) Validate() error

+ func (r *Resource) WithAttr(key string, value interface{}) *Resource

+ func (r *Resource) WithAttributes(attr map[string]interface{}) *Resource

+ func (r *Resource) WithPolicyVersion(policyVersion string) *Resource

+ type ResourceBatch struct

+ func NewResourceBatch() *ResourceBatch

+ func (rb *ResourceBatch) Add(resource *Resource, actions ...string) *ResourceBatch

+ func (rb *ResourceBatch) Err() error

+ func (rb *ResourceBatch) Validate() error

+ type ResourcePolicy struct

+ func NewResourcePolicy(resource, version string) *ResourcePolicy

+ func (rp *ResourcePolicy) AddResourceRules(rules ...*ResourceRule) *ResourcePolicy

+ func (rp *ResourcePolicy) Err() error

+ func (rp *ResourcePolicy) Validate() error

+ func (rp *ResourcePolicy) WithDerivedRolesImports(imp ...string) *ResourcePolicy

+ type ResourceRule struct

+ func NewAllowResourceRule(actions ...string) *ResourceRule

+ func NewDenyResourceRule(actions ...string) *ResourceRule

+ func (rr *ResourceRule) Err() error

+ func (rr *ResourceRule) Validate() error

+ func (rr *ResourceRule) WithCondition(m match) *ResourceRule

+ func (rr *ResourceRule) WithDerivedRoles(roles ...string) *ResourceRule

+ func (rr *ResourceRule) WithRoles(roles ...string) *ResourceRule

+ type ResourceSet struct

+ func NewResourceSet(kind string) *ResourceSet

+ func (rs *ResourceSet) AddResourceInstance(id string, attr map[string]interface{}) *ResourceSet

+ func (rs *ResourceSet) Err() error

+ func (rs *ResourceSet) Validate() error

+ func (rs *ResourceSet) WithPolicyVersion(policyVersion string) *ResourceSet