namer

Documentation

Index

• Constants
• func DerivedRolesFQN(roleSetName string) string
• func ExportVariablesFQN(variablesName string) string
• func FQN(p *policyv1.Policy) string
• func FQNFromPolicyKey(s string) string
• func FQNTree(p *policyv1.Policy) []string
• func PolicyKey(p *policyv1.Policy) string
• func PolicyKeyFromFQN(m string) string
• func PrincipalPolicyFQN(principal, version, scope string) string
• func PrincipalResourceActionRuleName(rule *policyv1.PrincipalRule_Action, resource string, idx int) string
• func ResourcePolicyFQN(resource, version, scope string) string
• func ResourceRuleName(rule *policyv1.ResourceRule, idx int) string
• func RuleFQN(rpsMeta any, scope, ruleName string) string
• func SimpleName(fqn string) string
• type ModuleID
  • func DerivedRolesModuleID(roleSetName string) ModuleID
  • func ExportVariablesModuleID(variablesName string) ModuleID
  • func GenModuleID(p *policyv1.Policy) ModuleID
  • func GenModuleIDFromFQN(name string) ModuleID
  • func PrincipalPolicyModuleID(principal, version, scope string) ModuleID
  • func ResourcePolicyModuleID(resource, version, scope string) ModuleID
  • func ScopedPrincipalPolicyModuleIDs(principal, version, scope string, genTree bool) []ModuleID
  • func ScopedResourcePolicyModuleIDs(resource, version, scope string, genTree bool) []ModuleID
  • func (m *ModuleID) HexStr() string
  • func (m *ModuleID) Scan(src any) error
  • func (m *ModuleID) String() string
  • func (m ModuleID) Value() (driver.Value, error)
• type PolicyCoords
  • func (pc PolicyCoords) FQN() string
  • func (pc PolicyCoords) PolicyKey() string

Constants

const (
	DerivedRolesPrefix      = fqnPrefix + "derived_roles"
	ExportVariablesPrefix   = fqnPrefix + "export_variables"
	PrincipalPoliciesPrefix = fqnPrefix + "principal"
	ResourcePoliciesPrefix  = fqnPrefix + "resource"

	DefaultVersion = "default"
)

Functions

func DerivedRolesFQN

func DerivedRolesFQN(roleSetName string) string

DerivedRolesFQN returns the fully-qualified module name for the given derived roles set.

func ExportVariablesFQN

func ExportVariablesFQN(variablesName string) string

ExportVariablesFQN returns the fully-qualified module name for the given exported variable definitions.

func FQN

func FQN(p *policyv1.Policy) string

FQN returns the fully-qualified name of the policy.

func FQNFromPolicyKey

func FQNFromPolicyKey(s string) string

FQNFromPolicyKey returns FQN from the policy key.

func FQNTree

func FQNTree(p *policyv1.Policy) []string

FQNTree returns the tree of FQNs that are ancestors of the given policy (including itself) sorted by most recent to oldest. For example, if the policy has scope a.b.c, the returned tree will contain the FQNs in the following order: - a.b.c - a.b - a - "" (empty scope).

func PolicyKey

func PolicyKey(p *policyv1.Policy) string

PolicyKey returns a human-friendly identifier that can be used to refer to the policy in logs and other outputs.

func PolicyKeyFromFQN

func PolicyKeyFromFQN(m string) string

PolicyKeyFromFQN returns a policy key from the module name.

func PrincipalPolicyFQN

func PrincipalPolicyFQN(principal, version, scope string) string

PrincipalPolicyFQN returns the fully-qualified module name for the principal policy with given principal, version and scope.

func PrincipalResourceActionRuleName

func PrincipalResourceActionRuleName(rule *policyv1.PrincipalRule_Action, resource string, idx int) string

PrincipalResourceActionRuleName returns the name for an action rule defined for a particular resource.

func ResourcePolicyFQN

func ResourcePolicyFQN(resource, version, scope string) string

ResourcePolicyFQN returns the fully-qualified name for the resource policy with given resource, version and scope.

func ResourceRuleName

func ResourceRuleName(rule *policyv1.ResourceRule, idx int) string

ResourceRuleName returns the name of the given resource rule.

func RuleFQN

func RuleFQN(rpsMeta any, scope, ruleName string) string

RuleFQN returns the FQN for the resource rule or principal resource action rule with scope granularity.

func SimpleName

func SimpleName(fqn string) string

SimpleName extracts the simple name from a derived roles or exported variables FQN.

Types

type ModuleID

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

ModuleID is a unique identifier for modules.

func DerivedRolesModuleID

func DerivedRolesModuleID(roleSetName string) ModuleID

DerivedRolesModuleID returns the module ID for the given derived roles set.

func ExportVariablesModuleID

func ExportVariablesModuleID(variablesName string) ModuleID

ExportVariablesModuleID returns the module ID for the given exported variable definitions.

func GenModuleID

func GenModuleID(p *policyv1.Policy) ModuleID

GenModuleID generates a short ID for the module.

func GenModuleIDFromFQN

func GenModuleIDFromFQN(name string) ModuleID

GenModuleIDFromFQN generates a short ID for the given module name.

func PrincipalPolicyModuleID

func PrincipalPolicyModuleID(principal, version, scope string) ModuleID

PrincipalPolicyModuleID returns the module ID for the principal policy with given principal and version.

func ResourcePolicyModuleID

func ResourcePolicyModuleID(resource, version, scope string) ModuleID

ResourcePolicyModuleID returns the module ID for the resource policy with given resource, version and scope.

func ScopedPrincipalPolicyModuleIDs

func ScopedPrincipalPolicyModuleIDs(principal, version, scope string, genTree bool) []ModuleID

ScopedPrincipalPolicyModuleIDs returns a list of module IDs for each scope segment if `strict` is false. For example, if the scope is `a.b.c`, the list will contain the module IDs for scopes `a.b.c`, `a.b`, `a` and `""` in that order.

func ScopedResourcePolicyModuleIDs

func ScopedResourcePolicyModuleIDs(resource, version, scope string, genTree bool) []ModuleID

ScopedResourcePolicyModuleIDs returns a list of module IDs for each scope segment if `strict` is false. For example, if the scope is `a.b.c`, the list will contain the module IDs for scopes `a.b.c`, `a.b`, `a` and `""` in that order.

func (*ModuleID) HexStr

func (m *ModuleID) HexStr() string

func (*ModuleID) Scan

func (m *ModuleID) Scan(src any) error

func (*ModuleID) String

func (m *ModuleID) String() string

func (ModuleID) Value

func (m ModuleID) Value() (driver.Value, error)

type PolicyCoords

type PolicyCoords struct {
	Kind    string
	Name    string
	Version string
	Scope   string
}

func (PolicyCoords) FQN

func (pc PolicyCoords) FQN() string

func (PolicyCoords) PolicyKey

func (pc PolicyCoords) PolicyKey() string