authz

type Authorizer ¶

type Authorizer interface {
	CheckPermission(ctx context.Context, details *RequestDetails, object Object, entitlement Entitlement) error
}

Authorizer is the primary external API for this package.

type Entitlement ¶

type Entitlement string

Entitlement is a type representation of a permission as it applies to a particular ObjectType.

const (
	// Entitlements that apply to all resources.
	EntitlementCanCreate Entitlement = "can_create"
	EntitlementCanDelete Entitlement = "can_delete"
	EntitlementCanEdit   Entitlement = "can_edit"
	EntitlementCanView   Entitlement = "can_view"
)

func (e Entitlement) String() string

type Object ¶

type Object string

Object is a string alias that represents an authorization object. These are formatted strings that uniquely identify an API resource, and can be constructed/deconstructed reliably. An Object is always of the form <ObjectType>:<identifier> where the identifier is a "/" delimited path containing elements that uniquely identify a resource. If the resource is defined at the project level, the first element of this path is always the project. Some example objects would be:

• `instance:default/c1`: Instance object in project "default" and name "c1".
• `storage_pool:local`: Storage pool object with name "local".
• `storage_volume:default/local/custom/vol1`: Storage volume object in project "default", storage pool "local", type "custom", and name "vol1".

func NewObject(objectType ObjectType, identifierElements ...string) (Object, error)

func ObjectFromRequest(r *http.Request, objectType ObjectType, muxVars ...string) (Object, error)

func ObjectServer() Object

func ObjectUser(userName string) Object

func (o Object) Elements() []string

func (o Object) String() string

func (o Object) Type() ObjectType

type ObjectType ¶

type ObjectType string

ObjectType is a type of resource within the operations center.

const (
	// ObjectTypeUser represents a user.
	ObjectTypeUser ObjectType = "user"

	// ObjectTypeServer represents a server.
	ObjectTypeServer ObjectType = "server"
)

func (o ObjectType) String() string

type RequestDetails ¶

type RequestDetails struct {
	Username string
	Protocol string
	URL      *url.URL
	Method   string
}

RequestDetails is a type representing an authorization request.

func ExtractRequestDetails(r *http.Request) (*RequestDetails, error)