Documentation
¶
Overview ¶
Package gopherpolicy provides integration between goslo.policy and Gophercloud for services that need to validate OpenStack tokens and check permissions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Enforcer ¶
Enforcer contains the Enforce method that struct Token requires to check access permissions. This interface is satisfied by struct Enforcer from goslo.policy.
type Token ¶
type Token struct {
//The enforcer that checks access permissions for this client token. Usually
//an instance of struct Enforcer from goslo.policy. Usually inherited from
//struct TokenValidator.
Enforcer Enforcer
//When AuthN succeeds, contains information about the client token which can
//be used to check access permissions.
Context policy.Context
//When AuthN fails, contains the deferred AuthN error.
Err error
}
Token represents a validated Keystone v3 token. It is returned from Validator.CheckToken().
func (*Token) Require ¶
func (t *Token) Require(w http.ResponseWriter, rule string) bool
Require checks if the given token has the given permission according to the policy.json that is in effect. If not, an error response is written and false is returned.
type TokenValidator ¶
type TokenValidator struct {
IdentityV3 *gophercloud.ServiceClient
//Enforcer can also be initialized with the LoadPolicyFile method.
Enforcer Enforcer
}
TokenValidator combines an Identity v3 client to validate tokens (AuthN), and a policy.Enforcer to check access permissions (AuthZ).
func (*TokenValidator) CheckToken ¶
func (v *TokenValidator) CheckToken(r *http.Request) *Token
CheckToken checks the validity of the request's X-Auth-Token in Keystone, and returns a Token instance for checking authorization. Any errors that occur during this function are deferred until Require() is called.
func (*TokenValidator) LoadPolicyFile ¶
func (v *TokenValidator) LoadPolicyFile(path string) error
LoadPolicyFile creates v.Enforcer from the given policy file.
type Validator ¶
type Validator interface {
//CheckToken checks the validity of the request's X-Auth-Token in Keystone, and
//returns a Token instance for checking authorization. Any errors that occur
//during this function are deferred until Token.Require() is called.
CheckToken(r *http.Request) *Token
}
Validator is the interface provided by TokenValidator. Application code should prefer to reference this interface to allow for substituation by a test double.
Source Files