Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ClusterByAuthority ¶
func ClusterByAuthority[attrCluster Clusterable](attrs []attrCluster) map[string][]attrCluster
ClusterByAuthority takes a slice of Clusterables, and returns them as a map, where the map is keyed by each unique Authorities (e.g. 'https://myauthority.org') found in the slice of Clusterables
func ClusterByCanonicalName ¶
func ClusterByCanonicalName[attrCluster Clusterable](attrs []attrCluster) map[string][]attrCluster
ClusterByCanonicalName takes a slice of Clusterables (AttributeInstance OR AttributeDefinition), and returns them as a map, where the map is keyed by each unique CanonicalName (e.g. Authority+Name, 'https://myauthority.org/attr/<name>') found in the slice of Clusterables
Types ¶
type AttributeDefinition ¶
type AttributeDefinition struct {
Authority string `json:"authority"`
Name string `json:"name"`
Rule string `json:"rule"`
State string `json:"state,omitempty"`
// 'order' contains all the valid values an Instance of this Definition may
// have. If the `rule` is == hierarchy, then the ordering of these values implies
// their hierarchical position.
Order []string `json:"order"`
GroupBy *AttributeInstance `json:"group_by,omitempty"`
}
func (AttributeDefinition) GetAuthority ¶
func (attrdef AttributeDefinition) GetAuthority() string
func (AttributeDefinition) GetCanonicalName ¶
func (attrdef AttributeDefinition) GetCanonicalName() string
Returns the canonical URI representation of this attribute definition. <scheme>://<hostname>/attr/<name>
type AttributeInstance ¶
type AttributeInstance struct {
Authority string `json:"authority"`
Name string `json:"name"`
Value string `json:"value"`
}
An AttributeInstance is created by selecting the Authority, Name and a specific Value from an attributes.AttributeDefinition.
An AttributeInstance is a single, unique attribute, with a single value.
Applied to an entity, the AttributeInstance becomes an entity attribute Applied to data, the AttributeInstance becomes a data attribute
When making an access decisions, these two kinds of attribute instances are compared with each other.
Example AttributeInstance: https://derp.com/attr/Blob/value/Green -> Authority = https://derp.com Name = Blob Namespace = Authority + Name https://derp.com/attr/Blob Value = Green
func ParseInstanceFromParts ¶
func ParseInstanceFromParts(namespace, name, value string) (AttributeInstance, error)
Accepts attribute namespace, name and value strings, and returns an AttributeInstance
func ParseInstanceFromURI ¶
func ParseInstanceFromURI(attributeURI string) (AttributeInstance, error)
Accepts a valid attribute instance URI (authority + name + value in the canonical format 'https://example.org/attr/MyAttrName/value/MyAttrValue') and returns an AttributeInstance.
Strings that are not valid URLs will result in a parsing failure, and return an error.
func (AttributeInstance) GetAuthority ¶
func (attrdef AttributeInstance) GetAuthority() string
func (AttributeInstance) GetCanonicalName ¶
func (attr AttributeInstance) GetCanonicalName() string
For cases where just the canonical name of this AttributeInstance is required (e.g. <authority>/attr/<name> - the authority and name, but not the value) <authority>/attr/<name>
func (AttributeInstance) String ¶
func (attr AttributeInstance) String() string
Implement the standard "stringify" interface and return a string in the canonical attribute instance format of <authority>/attr/<name>/value/<value>
type Clusterable ¶
type Clusterable interface {
// Type constraint (generics)
// Both AttributeDefinitions and AttributeInstances are clusterable
AttributeInstance | AttributeDefinition
// Returns the canonical URI representation of this clusterable thing.
// <scheme>://<hostname>/attr/<name>
GetCanonicalName() string
// Returns the authority of this clusterable thing.
// <scheme>://<hostname>
GetAuthority() string
}
Source Files