README
¶
rbac
forkd from https://github.com/harranali/authority
Role Based Access Control (RBAC) Go package with database persistence
Features
- Create Roles/Permissions
- Assign Permissions to Roles/Multiple Roles to Users
- Check User's Roles/Permissions/Role's Permissions
- Revoke User's Roles/User's Permissions/ole's permissions
- List User's Roles/All Roles/All Permissions
- Delete Roles/Permissions
Test
docker run --name mysql -e MYSQL_ROOT_PASSWORD=root -p 3306:3306 -d mysql:5.7.34go test
Usage
// initiate the database (using mysql)
dsn := "dbuser:dbpassword@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
db, _ := gorm.Open(mysql.Open(dsn), &gorm.Config{})
// initiate authority
auth := authority.New(authority.Options{ TablesPrefix: "authority_", DB: db })
// create role
err := auth.CreateRole("role-1")
// create permissions
err := auth.NewPerm("permission-1")
err = auth.NewPerm("permission-2")
err = auth.NewPerm("permission-3")
// assign the permissions to the role
err := auth.AssignPerm("role-1", "permission-1", "permission-2", "permission-3")
// assign a role to user (user id = 1)
err = auth.AssignRole(1, "role-a")
// check if the user have a given role
ok, err := auth.CheckRole(1, "role-a")
// check if a user have a given permission
ok, err := auth.CheckPerm(1, "permission-d")
// check if a role have a given permission
ok, err := auth.CheckRolePerm("role-a", "permission-a")
Documentation
¶
Index ¶
- Variables
- type Options
- type Perm
- type Rbac
- func (a *Rbac) AssignPerms(roleName string, permNames ...string) error
- func (a *Rbac) AssignRole(userID uint, roleName string) error
- func (a *Rbac) CheckPerm(userID uint, permName string) (bool, error)
- func (a *Rbac) CheckRole(userID uint, roleName string) (bool, error)
- func (a *Rbac) CheckRolePerm(roleName string, permName string) (bool, error)
- func (a *Rbac) DeletePerm(permName string) error
- func (a *Rbac) DeleteRole(roleName string) error
- func (a *Rbac) GetPerms() ([]string, error)
- func (a *Rbac) GetRoles() ([]string, error)
- func (a *Rbac) GetUserRoles(userID uint) ([]string, error)
- func (a *Rbac) NewPerm(permName string) error
- func (a *Rbac) NewRole(roleName string) error
- func (a *Rbac) RevokePerm(userID uint, permName string) error
- func (a *Rbac) RevokeRole(userID uint, roleName string) error
- func (a *Rbac) RevokeRolePerm(roleName string, permName string) error
- type Role
- type RolePerm
- type UserRole
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Rbac ¶
Rbac helps deal with permissions
func (*Rbac) AssignPerms ¶
AssignPerms assigns a group of permissions to a given role it accepts in the first parameter the role name, it returns an error if there is not matching record of the role name in the database. the second parameter is a slice of strings which represents a group of permissions to be assigned to the role if any of these permissions doesn't have a matching record in the database the operations stops, changes reverted and error is returned in case of success nothing is returned
func (*Rbac) AssignRole ¶
AssignRole assigns a given role to a user the first parameter is the user id, the second parameter is the role name if the role name doesn't have a matching record in the data base an error is returned if the user have already a role assigned to him an error is returned
func (*Rbac) CheckPerm ¶
CheckPerm checks if a permission is assigned to the role that's assigned to the user. it accepts the user id as the first parameter the permission as the second parameter it returns an error if the permission is not present in the database
func (*Rbac) CheckRole ¶
CheckRole checks if a role is assigned to a user it accepts the user id as the first parameter the role as the second parameter it returns an error if the role is not present in database.
func (*Rbac) CheckRolePerm ¶
CheckRolePerm checks if a role has the permission assigned it accepts the role as the first parameter it accepts the permission as the second parameter it returns an error if the role is not present in database it returns an error if the permission is not present in database
func (*Rbac) DeletePerm ¶
DeletePerm deletes a given permission if the permission is assigned to a role it returns an error.
func (*Rbac) DeleteRole ¶
DeleteRole deletes a given role if the role is assigned to a user it returns an error
func (*Rbac) GetUserRoles ¶
GetUserRoles returns all user assigned roles
func (*Rbac) RevokePerm ¶
RevokePerm revokes a permission from the user's assigned role it returns an error in case of any
func (*Rbac) RevokeRole ¶
RevokeRole revokes a user's role it returns a error in case of any
Source Files