authorizer

package

v0.8.2-rc.6 Latest Latest Go to latest Published: Dec 20, 2021 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/shellhub-io/shellhub

Links

Open Source Insights

Documentation ¶

Overview ¶

Package authorizer is a hard coded package that contains the roles, actions, permissions and function related to ShellHub's API.

Index ¶

Constants
Variables
func CheckPermission(userRole string, action int) bool
func CheckRole(firstRole, secondRole string) bool
func GetRoleCode(role string) int
type Action
type Permissions

Constants ¶

View Source

const (
	MemberRoleObserver      = "observer"
	MemberRoleOperator      = "operator"
	MemberRoleAdministrator = "administrator"
	MemberRoleOwner         = "owner"
)

View Source

const (
	DeviceAccept = iota
	DeviceReject
	DeviceRemove
	DeviceConnect
	DeviceRename
	DeviceDetails

	SessionPlay
	SessionClose
	SessionRemove
	SessionDetails

	FirewallCreate
	FirewallEdit
	FirewallRemove

	PublicKeyCreate
	PublicKeyEdit
	PublicKeyRemove

	NamespaceRename
	NamespaceAddMember
	NamespaceRemoveMember
	NamespaceEditMember
	NamespaceEnableSessionRecord
	NamespaceDelete

	BillingChooseDevices
	BillingAddPaymentMethod
	BillingUpdatePaymentMethod
	BillingRemovePaymentMethod
	BillingCancelSubscription
	BillingCreateSubscription
	BillingGetPaymentMethod
	BillingGetSubscription
)

Variables ¶

View Source

var Actions = actions{
	Device: deviceActions{
		Accept:  DeviceAccept,
		Reject:  DeviceReject,
		Remove:  DeviceRemove,
		Connect: DeviceConnect,
		Rename:  DeviceRename,
	},
	Session: sessionActions{
		Play:    SessionPlay,
		Close:   SessionClose,
		Remove:  SessionRemove,
		Details: SessionDetails,
	},
	Firewall: firewallActions{
		Create: FirewallCreate,
		Edit:   FirewallEdit,
		Remove: FirewallRemove,
	},
	PublicKey: publicKeyActions{
		Create: PublicKeyCreate,
		Edit:   PublicKeyEdit,
		Remove: PublicKeyRemove,
	},
	Namespace: namespaceActions{
		Rename:              NamespaceRename,
		AddMember:           NamespaceAddMember,
		RemoveMember:        NamespaceRemoveMember,
		EditMember:          NamespaceEditMember,
		EnableSessionRecord: NamespaceEnableSessionRecord,
		Delete:              NamespaceDelete,
	},
	Billing: billingActions{
		ChooseDevices:       BillingChooseDevices,
		AddPaymentMethod:    BillingAddPaymentMethod,
		UpdatePaymentMethod: BillingUpdatePaymentMethod,
		RemovePaymentMethod: BillingRemovePaymentMethod,
		CancelSubscription:  BillingCancelSubscription,
		CreateSubscription:  BillingCreateSubscription,
		GetSubscription:     BillingGetSubscription,
	},
}

Actions has all available and allowed actions. You should use it to get the code's action.

Functions ¶

func CheckPermission ¶

func CheckPermission(userRole string, action int) bool

CheckPermission checks if the user's role has the permission to execute an action.

func CheckRole ¶

func CheckRole(firstRole, secondRole string) bool

CheckRole checks if the first role has a great value than second.

func GetRoleCode ¶

func GetRoleCode(role string) int

GetRoleCode converts a member's role to an int.

Types ¶

type Action ¶

type Action int

type Permissions ¶

type Permissions []int

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL