access

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2024 License: MIT Imports: 18 Imported by: 3

README

access

Overview

The access repository is designed to handle authorization by implementing role-based access control (RBAC). It manages the storage and organization of user permissions and roles, enabling precise control over access rights within various domains or tenants.

Features

  • RBAC Implementation: Manage user roles and permissions efficiently.
  • Domain/Tenant Specific: Assign permissions specific to different domains or tenants.
  • User Permission Checks: Verify user permissions against specified domains or tenants.
Created and maintained by the CCC team.

Documentation

Overview

package access implements tools to manage access to resources. It is a wrapper around casbin using an rbac model.

Package access is a generated GoMock package.

Index

Constants

View Source 
const GlobalDomain = Domain("global")

GlobalDomain is the domain used when a permission is applied at the Global level instead of to a specific domain.

View Source 
const NoopUser = "noop"

NoopUser is the user assigned to an empty role in casbin to ensure the role can be enumerated if no one else is assigned

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client is the users client

func New 

func New(domains Domains, connConfig *pgx.ConnConfig) (*Client, error)

New creates a new user client

func (*Client) Handlers 

func (c *Client) Handlers(validate *validator.Validate, logHandler LogHandler) Handlers

func (*Client) RequireAll 

func (c *Client) RequireAll(ctx context.Context, username User, domain Domain, perms ...Permission) error

func (*Client) UserManager 

func (c *Client) UserManager() UserManager

type Controller added in v0.1.1 

type Controller interface {
	// CheckPermissions checks if a user has the given permissions in a domain
	RequireAll(ctx context.Context, user User, domain Domain, permissions ...Permission) error

	// UserManager returns the UserManager interface for managing users, roles, and permissions
	UserManager() UserManager

	// Handlers returns the http.HandlerFunc for the access package
	Handlers(validate *validator.Validate, handler LogHandler) Handlers
}

type Domain 

type Domain string

func (Domain) IsValid 

func (d Domain) IsValid() bool

func (Domain) Marshal 

func (d Domain) Marshal() string

type Domains 

type Domains interface {
	DomainIDs(ctx context.Context) ([]string, error)

	DomainExists(ctx context.Context, guarantorID string) (bool, error)
}

type HandlerClient 

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

func (*HandlerClient) AddRole 

func (a *HandlerClient) AddRole() http.HandlerFunc

AddRole is the handler to add a new role to the system

Permissions Required: AddRole

func (*HandlerClient) AddRolePermissions 

func (a *HandlerClient) AddRolePermissions() http.HandlerFunc

AddRolePermissions is the handler to assign permissions to a given role

Permissions Required: AddRolePermissions

func (*HandlerClient) AddRoleUsers 

func (a *HandlerClient) AddRoleUsers() http.HandlerFunc

AddRoleUsers is the handler to assign a role to a list of users

Permissions Required: AddRoleUsers

func (*HandlerClient) DeleteRole 

func (a *HandlerClient) DeleteRole() http.HandlerFunc

DeleteRole is the handler to delete a role

Permissions Required: DeleteRole

func (*HandlerClient) DeleteRolePermissions 

func (a *HandlerClient) DeleteRolePermissions() http.HandlerFunc

DeleteRolePermissions is the handler to remove permissions from a role

Permissions Required: DeleteRolePermissions

func (*HandlerClient) DeleteRoleUsers 

func (a *HandlerClient) DeleteRoleUsers() http.HandlerFunc

DeleteRoleUsers is the handler to delete a list of users from a given role

Permissions Required: DeleteRoleUsers

func (*HandlerClient) NewDecoder 

func (a *HandlerClient) NewDecoder(req *http.Request) *httpio.Decoder

NewDecoder returns an httpio.Decoder to simplify the validator call to a single location

func (*HandlerClient) RolePermissions 

func (a *HandlerClient) RolePermissions() http.HandlerFunc

RolePermissions is the handler to the list of permissions for a given role

Permissions Required: ListRolePermissions

func (*HandlerClient) RoleUsers 

func (a *HandlerClient) RoleUsers() http.HandlerFunc

RoleUsers is the handler to the list of users for a given role

Permissions Required: ListRoleUsers

func (*HandlerClient) Roles 

func (a *HandlerClient) Roles() http.HandlerFunc

Roles is the handler to get the list of roles in the system for a given domain

Permissions Required: ListRoles

func (*HandlerClient) User 

func (a *HandlerClient) User() http.HandlerFunc

User is the handler to get a user

Permissions Required: ViewUsers

func (*HandlerClient) Users 

func (a *HandlerClient) Users() http.HandlerFunc

Users is the handler to get the list of users in the system

Permissions Required: ViewUsers

type Handlers 

type Handlers interface {
	AddRole() http.HandlerFunc
	AddRolePermissions() http.HandlerFunc
	AddRoleUsers() http.HandlerFunc
	DeleteRole() http.HandlerFunc
	DeleteRolePermissions() http.HandlerFunc
	DeleteRoleUsers() http.HandlerFunc
	RolePermissions() http.HandlerFunc
	Roles() http.HandlerFunc
	RoleUsers() http.HandlerFunc
	User() http.HandlerFunc
	Users() http.HandlerFunc
}

type LogHandler 

type LogHandler func(handler func(w http.ResponseWriter, r *http.Request) error) http.HandlerFunc

type MockController added in v0.1.1 

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

MockController is a mock of Controller interface.

func NewMockController added in v0.1.1 

func NewMockController(ctrl *gomock.Controller) *MockController

NewMockController creates a new mock instance.

func (*MockController) EXPECT added in v0.1.1 

func (m *MockController) EXPECT() *MockControllerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockController) Handlers added in v0.1.1 

func (m *MockController) Handlers(validate *validator.Validate, handler LogHandler) Handlers

Handlers mocks base method.

func (*MockController) RequireAll added in v0.1.1 

func (m *MockController) RequireAll(ctx context.Context, user User, domain Domain, permissions ...Permission) error

RequireAll mocks base method.

func (*MockController) UserManager added in v0.1.1 

func (m *MockController) UserManager() UserManager

UserManager mocks base method.

type MockControllerMockRecorder added in v0.1.1 

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

MockControllerMockRecorder is the mock recorder for MockController.

func (*MockControllerMockRecorder) Handlers added in v0.1.1 

func (mr *MockControllerMockRecorder) Handlers(validate, handler any) *gomock.Call

Handlers indicates an expected call of Handlers.

func (*MockControllerMockRecorder) RequireAll added in v0.1.1 

func (mr *MockControllerMockRecorder) RequireAll(ctx, user, domain any, permissions ...any) *gomock.Call

RequireAll indicates an expected call of RequireAll.

func (*MockControllerMockRecorder) UserManager added in v0.1.1 

func (mr *MockControllerMockRecorder) UserManager() *gomock.Call

UserManager indicates an expected call of UserManager.

type MockDomains 

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

MockDomains is a mock of Domains interface.

func NewMockDomains 

func NewMockDomains(ctrl *gomock.Controller) *MockDomains

NewMockDomains creates a new mock instance.

func (*MockDomains) DomainExists 

func (m *MockDomains) DomainExists(ctx context.Context, guarantorID string) (bool, error)

DomainExists mocks base method.

func (*MockDomains) DomainIDs 

func (m *MockDomains) DomainIDs(ctx context.Context) ([]string, error)

DomainIDs mocks base method.

func (*MockDomains) EXPECT 

func (m *MockDomains) EXPECT() *MockDomainsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockDomainsMockRecorder 

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

MockDomainsMockRecorder is the mock recorder for MockDomains.

func (*MockDomainsMockRecorder) DomainExists 

func (mr *MockDomainsMockRecorder) DomainExists(ctx, guarantorID any) *gomock.Call

DomainExists indicates an expected call of DomainExists.

func (*MockDomainsMockRecorder) DomainIDs 

func (mr *MockDomainsMockRecorder) DomainIDs(ctx any) *gomock.Call

DomainIDs indicates an expected call of DomainIDs.

type MockUserManager 

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

MockUserManager is a mock of UserManager interface.

func NewMockUserManager 

func NewMockUserManager(ctrl *gomock.Controller) *MockUserManager

NewMockUserManager creates a new mock instance.

func (*MockUserManager) AddRole 

func (m *MockUserManager) AddRole(ctx context.Context, domain Domain, role Role) error

AddRole mocks base method.

func (*MockUserManager) AddRolePermissions 

func (m *MockUserManager) AddRolePermissions(ctx context.Context, permissions []Permission, role Role, domain Domain) error

AddRolePermissions mocks base method.

func (*MockUserManager) AddRoleUsers 

func (m *MockUserManager) AddRoleUsers(ctx context.Context, users []User, role Role, domain Domain) error

AddRoleUsers mocks base method.

func (*MockUserManager) AddUserRoles 

func (m *MockUserManager) AddUserRoles(ctx context.Context, user User, roles []Role, domain Domain) error

AddUserRoles mocks base method.

func (*MockUserManager) DeleteAllRolePermissions 

func (m *MockUserManager) DeleteAllRolePermissions(ctx context.Context, role Role, domain Domain) error

DeleteAllRolePermissions mocks base method.

func (*MockUserManager) DeleteRole 

func (m *MockUserManager) DeleteRole(ctx context.Context, role Role, domain Domain) (bool, error)

DeleteRole mocks base method.

func (*MockUserManager) DeleteRolePermissions 

func (m *MockUserManager) DeleteRolePermissions(ctx context.Context, permissions []Permission, role Role, domain Domain) error

DeleteRolePermissions mocks base method.

func (*MockUserManager) DeleteRoleUsers 

func (m *MockUserManager) DeleteRoleUsers(ctx context.Context, users []User, role Role, domain Domain) error

DeleteRoleUsers mocks base method.

func (*MockUserManager) DeleteUserRole 

func (m *MockUserManager) DeleteUserRole(ctx context.Context, username User, role Role, domain Domain) error

DeleteUserRole mocks base method.

func (*MockUserManager) DomainExists 

func (m *MockUserManager) DomainExists(ctx context.Context, domain Domain) (bool, error)

DomainExists mocks base method.

func (*MockUserManager) Domains 

func (m *MockUserManager) Domains(ctx context.Context) ([]Domain, error)

Domains mocks base method.

func (*MockUserManager) EXPECT 

func (m *MockUserManager) EXPECT() *MockUserManagerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockUserManager) RoleExists 

func (m *MockUserManager) RoleExists(ctx context.Context, role Role, domain Domain) bool

RoleExists mocks base method.

func (*MockUserManager) RolePermissions 

func (m *MockUserManager) RolePermissions(ctx context.Context, role Role, domain Domain) ([]Permission, error)

RolePermissions mocks base method.

func (*MockUserManager) RoleUsers 

func (m *MockUserManager) RoleUsers(ctx context.Context, role Role, domain Domain) ([]User, error)

RoleUsers mocks base method.

func (*MockUserManager) Roles 

func (m *MockUserManager) Roles(ctx context.Context, domain Domain) ([]Role, error)

Roles mocks base method.

func (*MockUserManager) User 

func (m *MockUserManager) User(ctx context.Context, username User, domain ...Domain) (*UserAccess, error)

User mocks base method.

func (*MockUserManager) UserPermissions 

func (m *MockUserManager) UserPermissions(ctx context.Context, username User, domain ...Domain) (map[Domain][]Permission, error)

UserPermissions mocks base method.

func (*MockUserManager) UserRoles 

func (m *MockUserManager) UserRoles(ctx context.Context, username User, domain ...Domain) (map[Domain][]Role, error)

UserRoles mocks base method.

func (*MockUserManager) Users 

func (m *MockUserManager) Users(ctx context.Context, domain ...Domain) ([]*UserAccess, error)

Users mocks base method.

type MockUserManagerMockRecorder 

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

MockUserManagerMockRecorder is the mock recorder for MockUserManager.

func (*MockUserManagerMockRecorder) AddRole 

func (mr *MockUserManagerMockRecorder) AddRole(ctx, domain, role any) *gomock.Call

AddRole indicates an expected call of AddRole.

func (*MockUserManagerMockRecorder) AddRolePermissions 

func (mr *MockUserManagerMockRecorder) AddRolePermissions(ctx, permissions, role, domain any) *gomock.Call

AddRolePermissions indicates an expected call of AddRolePermissions.

func (*MockUserManagerMockRecorder) AddRoleUsers 

func (mr *MockUserManagerMockRecorder) AddRoleUsers(ctx, users, role, domain any) *gomock.Call

AddRoleUsers indicates an expected call of AddRoleUsers.

func (*MockUserManagerMockRecorder) AddUserRoles 

func (mr *MockUserManagerMockRecorder) AddUserRoles(ctx, user, roles, domain any) *gomock.Call

AddUserRoles indicates an expected call of AddUserRoles.

func (*MockUserManagerMockRecorder) DeleteAllRolePermissions 

func (mr *MockUserManagerMockRecorder) DeleteAllRolePermissions(ctx, role, domain any) *gomock.Call

DeleteAllRolePermissions indicates an expected call of DeleteAllRolePermissions.

func (*MockUserManagerMockRecorder) DeleteRole 

func (mr *MockUserManagerMockRecorder) DeleteRole(ctx, role, domain any) *gomock.Call

DeleteRole indicates an expected call of DeleteRole.

func (*MockUserManagerMockRecorder) DeleteRolePermissions 

func (mr *MockUserManagerMockRecorder) DeleteRolePermissions(ctx, permissions, role, domain any) *gomock.Call

DeleteRolePermissions indicates an expected call of DeleteRolePermissions.

func (*MockUserManagerMockRecorder) DeleteRoleUsers 

func (mr *MockUserManagerMockRecorder) DeleteRoleUsers(ctx, users, role, domain any) *gomock.Call

DeleteRoleUsers indicates an expected call of DeleteRoleUsers.

func (*MockUserManagerMockRecorder) DeleteUserRole 

func (mr *MockUserManagerMockRecorder) DeleteUserRole(ctx, username, role, domain any) *gomock.Call

DeleteUserRole indicates an expected call of DeleteUserRole.

func (*MockUserManagerMockRecorder) DomainExists 

func (mr *MockUserManagerMockRecorder) DomainExists(ctx, domain any) *gomock.Call

DomainExists indicates an expected call of DomainExists.

func (*MockUserManagerMockRecorder) Domains 

func (mr *MockUserManagerMockRecorder) Domains(ctx any) *gomock.Call

Domains indicates an expected call of Domains.

func (*MockUserManagerMockRecorder) RoleExists 

func (mr *MockUserManagerMockRecorder) RoleExists(ctx, role, domain any) *gomock.Call

RoleExists indicates an expected call of RoleExists.

func (*MockUserManagerMockRecorder) RolePermissions 

func (mr *MockUserManagerMockRecorder) RolePermissions(ctx, role, domain any) *gomock.Call

RolePermissions indicates an expected call of RolePermissions.

func (*MockUserManagerMockRecorder) RoleUsers 

func (mr *MockUserManagerMockRecorder) RoleUsers(ctx, role, domain any) *gomock.Call

RoleUsers indicates an expected call of RoleUsers.

func (*MockUserManagerMockRecorder) Roles 

func (mr *MockUserManagerMockRecorder) Roles(ctx, domain any) *gomock.Call

Roles indicates an expected call of Roles.

func (*MockUserManagerMockRecorder) User 

func (mr *MockUserManagerMockRecorder) User(ctx, username any, domain ...any) *gomock.Call

User indicates an expected call of User.

func (*MockUserManagerMockRecorder) UserPermissions 

func (mr *MockUserManagerMockRecorder) UserPermissions(ctx, username any, domain ...any) *gomock.Call

UserPermissions indicates an expected call of UserPermissions.

func (*MockUserManagerMockRecorder) UserRoles 

func (mr *MockUserManagerMockRecorder) UserRoles(ctx, username any, domain ...any) *gomock.Call

UserRoles indicates an expected call of UserRoles.

func (*MockUserManagerMockRecorder) Users 

func (mr *MockUserManagerMockRecorder) Users(ctx any, domain ...any) *gomock.Call

Users indicates an expected call of Users.

type Permission 

type Permission string

func (Permission) IsValid 

func (p Permission) IsValid() bool

func (Permission) Marshal 

func (p Permission) Marshal() string

type PermissionDetail 

type PermissionDetail struct {
	Description string
	Scope       PermissionScope
}

type PermissionScope 

type PermissionScope string
const (
	GlobalPermissionScope PermissionScope = "global"
	DomainPermissionScope PermissionScope = "domain"
)

type PermissionsListFunc 

type PermissionsListFunc func() []Permission

PermissionsListFunc is a function that provides the list of app permissions for the users client

type Role 

type Role string

func (Role) IsValid 

func (r Role) IsValid() bool

func (Role) Marshal 

func (r Role) Marshal() string

type User 

type User string

User represents a user in the authorization system

func (User) IsValid 

func (u User) IsValid() bool

func (User) Marshal 

func (u User) Marshal() string

type UserAccess 

type UserAccess struct {
	Name        string
	Roles       map[Domain][]Role
	Permissions map[Domain][]Permission
}

UserAccess struct contains the name and role mappings for a user

type UserManager 

type UserManager interface {
	// AddRoleUsers assigns a given role to a slice of users if the role exists
	AddRoleUsers(ctx context.Context, users []User, role Role, domain Domain) error

	// AddUserRoles assigns a list of roles to a user if the role exists
	AddUserRoles(ctx context.Context, user User, roles []Role, domain Domain) error

	// DeleteRoleUsers removes users from a given role
	DeleteRoleUsers(ctx context.Context, users []User, role Role, domain Domain) error

	// DeleteUserRole deletes the role assignment for a user in a specific domain.
	// Behavior is the same whether or not the role exists for the user.
	DeleteUserRole(ctx context.Context, username User, role Role, domain Domain) error

	// User returns a User by the given username with the roles that have been assigned.
	User(ctx context.Context, username User, domain ...Domain) (*UserAccess, error)

	// Users gets a list of users with their assigned roles
	Users(ctx context.Context, domain ...Domain) ([]*UserAccess, error)

	// UserRoles returns a map of the domain
	UserRoles(ctx context.Context, username User, domain ...Domain) (map[Domain][]Role, error)

	// UserPermissions returns a map of domains with a slice of permissions for each
	UserPermissions(ctx context.Context, username User, domain ...Domain) (map[Domain][]Permission, error)

	// AddRole adds a new role to a domain without assigning it to a user
	//
	// Note: due to the design of casbin, we must add a "noop" user to the role to enumerate it without permissions.
	AddRole(ctx context.Context, domain Domain, role Role) error

	// RoleExists determines if the given Role exists for Domain
	RoleExists(ctx context.Context, role Role, domain Domain) bool

	// Roles returns the full list of roles for a given domain
	Roles(ctx context.Context, domain Domain) ([]Role, error)

	// DeleteRole deletes a role from the system.
	// If there are users assigned, it will not be deleted.
	DeleteRole(ctx context.Context, role Role, domain Domain) (bool, error)

	// AddRolePermissions adds a list of permissions to a role in a given domain
	AddRolePermissions(ctx context.Context, permissions []Permission, role Role, domain Domain) error

	// DeleteRolePermissions removes a list of permissions to a role in a given domain
	DeleteRolePermissions(ctx context.Context, permissions []Permission, role Role, domain Domain) error

	// DeleteAllRolePermissions removes all permissions for a given role in a domain
	DeleteAllRolePermissions(ctx context.Context, role Role, domain Domain) error

	// RoleUsers returns the list of users attached to a role in a given domain
	RoleUsers(ctx context.Context, role Role, domain Domain) ([]User, error)

	// RolePermissions returns the list of permissions attached to a role in a given domain
	RolePermissions(ctx context.Context, role Role, domain Domain) ([]Permission, error)

	// Domains returns the full list of domains
	Domains(ctx context.Context) ([]Domain, error)

	// DomainExists returns true if the domain provided is a valid
	DomainExists(ctx context.Context, domain Domain) (bool, error)
}

UserManager is the interface for managing RBAC including the management of roles and permissions for users

Source Files

View all Source files

Directories

Path Synopsis
package accesstypes provides types for permissions, roles, and domains types for the access package
 package accesstypes provides types for permissions, roles, and domains types for the access package
package mock contains the generated mocks for the project.
 package mock contains the generated mocks for the project.
mock_access
Package mock_access is a generated GoMock package.
 Package mock_access is a generated GoMock package.
package resourceset is a set of resources that provides a way to map permissions to fields in a struct.
 package resourceset is a set of resources that provides a way to map permissions to fields in a struct.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.