2-2-5-1 proxmox ve 使用者權限管理功能
Users
Proxmox VE stores user attributes in /etc/pve/user.cfg. Passwords are not stored here, users are instead associated with authentication realms described below. Therefore a user is internally often identified by its name and realm in the form <userid>@<realm>.
Authentication Realms
As Proxmox VE users are just counterparts for users existing on some external realm, the realms have to be configured in /etc/pve/domains.cfg. The following realms (authentication methods) are available:
- Linux PAM standard authentication
-
In this case a system user has to exist (e.g. created via the adduser command) on all nodes the user is allowed to login, and the user authenticates with their usual system password.
- Proxmox VE authentication server
-
This is a unix like password store (/etc/pve/priv/shadow.cfg). Password are encrypted using the SHA-256 hash method. This is the most convenient method for small (or even medium) installations where users do not need access to anything outside of Proxmox VE. In this case users are fully managed by Proxmox VE and are able to change their own passwords via the GUI.
- LDAP
-
Users are searched under a Base Domain Name (base_dn), with the user name found in the attribute specified in the User Attribute Name (user_attr) field.
The Base Domain Name would be ou=People,dc=ldap-test,dc=com and the user attribute would be uid.
If Proxmox VE needs to authenticate (bind) to the ldap server before being able to query and authenticate users, a bind domain name can be configured via the bind_dn property in /etc/pve/domains.cfg. Its password then has to be stored in /etc/pve/priv/ldap/<realmname>.pw (e.g. /etc/pve/priv/ldap/my-ldap.pw). This file should contain a single line containing the raw password.
- Microsoft Active Directory
Two factor authentication
Each realm can optionally be secured additionally by two factor authentication. This can be done by selecting one of the available methods via the TFA dropdown box when adding or editing an Authentication Realm. When a realm has TFA enabled it becomes a requirement and only users with configured TFA will be able to login.
- Time based OATH (TOTP)
-
Proxmox VE provides a key generation tool (oathkeygen) which prints out a random key in Base32 notation which can be used directly with various OTP tools, such as the oathtool command line tool, the Google authenticator or FreeOTP Android apps.
- YubiKey OTP
-
For authenticating via a YubiKey a Yubico API ID, API KEY and validation server URL must be configured, and users must have a YubiKey available. In order to get the key ID from a YubiKey, you can trigger the YubiKey once after connecting it to USB and copy the first 12 characters of the typed password into the user’s Key IDs field.
Permission Management
Proxmox VE uses a role and path based permission management system. An entry in the permissions table allows a user or group to take on a specific role when accessing an object or path. This means an such an access rule can be represented as a triple of (path, user, role) or (path, group, role), with the role containing a set of allowed actions, and the path representing the target of these actions.
Roles
-
Administrator: 擁有所有特權
-
NoAccess: 沒有特權 (used to forbid access)
-
PVEAdmin: can do most things, but miss rights to modify system settings (Sys.PowerMgmt, Sys.Modify, Realm.Allocate).
-
PVEAuditor: read only access
-
PVEDatastoreAdmin: create and allocate backup space and templates
-
PVEDatastoreUser: allocate backup space and view storage
-
PVEPoolAdmin: allocate pools
-
PVESysAdmin: User ACLs, audit, system console and system logs
-
PVETemplateUser: view and clone templates
-
PVEUserAdmin: user administration
-
PVEVMAdmin: 完全管理 VM
-
PVEVMUser: view, backup, config CDROM, VM console, VM power management
Privileges
- Node / System related privileges
-
-
Permissions.Modify: modify access permissions
-
Sys.PowerMgmt: Node power management (start, stop, reset, shutdown, …)
-
Sys.Console: console access to Node
-
Sys.Syslog: view Syslog
-
Sys.Audit: view node status/config, Corosync cluster config and HA config
-
Sys.Modify: create/remove/modify node network parameters
-
Group.Allocate: create/remove/modify groups
-
Pool.Allocate: create/remove/modify a pool
-
Realm.Allocate: create/remove/modify authentication realms
-
Realm.AllocateUser: assign user to a realm
-
User.Modify: create/remove/modify user access and details.
-
- Virtual machine related privileges
-
-
VM.Allocate: create/remove new VM to server inventory
-
VM.Migrate: migrate VM to alternate server on cluster
-
VM.PowerMgmt: power management (start, stop, reset, shutdown, …)
-
VM.Console: console access to VM
-
VM.Monitor: access to VM monitor (kvm)
-
VM.Backup: backup/restore VMs
-
VM.Audit: view VM config
-
VM.Clone: clone/copy a VM
-
VM.Config.Disk: add/modify/delete Disks
-
VM.Config.CDROM: eject/change CDROM
-
VM.Config.CPU: modify CPU settings
-
VM.Config.Memory: modify Memory settings
-
VM.Config.Network: add/modify/delete Network devices
-
VM.Config.HWType: modify emulated HW type
-
VM.Config.Options: modify any other VM configuration
-
VM.Snapshot: create/remove VM snapshots
-
- Storage related privileges
-
-
Datastore.Allocate: create/remove/modify a data store, delete volumes
-
Datastore.AllocateSpace: allocate space on a datastore
-
Datastore.AllocateTemplate: allocate/upload templates and iso images
-
Datastore.Audit: view/browse a datastore
-
Objects and Paths
Paths can be templated. When an API call requires permissions on a templated path, the path may contain references to parameters of the API call. These references are specified in curly braces. Some parameters are implicitly taken from the API call’s URI. For instance the permission path /nodes/{node} when calling /nodes/mynode/status requires permissions on /nodes/mynode, while the path {path} in a PUT request to /access/acl refers to the method’s path parameter.
-
/nodes/{node}: Access to Proxmox VE server machines
-
/vms: Covers all VMs
-
/vms/{vmid}: Access to specific VMs
-
/storage/{storeid}: Access to a storages
-
/pool/{poolname}: Access to VMs part of a pool
-
/access/groups: Group administration
-
/access/realms/{realmid}: Administrative access to realms
Pools
Pools can be used to group a set of virtual machines and data stores. You can then simply set permissions on pools (/pool/{poolid}), which are inherited to all pool members. This is a great way simplify access control.
What permission do I need?
The required API permissions are documented for each individual method, and can be found at http://pve.proxmox.com/pve-docs/api-viewer/
- ["and", <subtests>...] and ["or", <subtests>...]
-
Each(and) or any(or) further element in the current list has to be true.
- ["perm", <path>, [ <privileges>... ], <options>...]
-
The path is a templated parameter (see Objects and Paths). All (or , if the any option is used, any) of the listed privileges must be allowed on the specified path. If a require-param option is specified, then its specified parameter is required even if the API call’s schema otherwise lists it as being optional.
- ["userid-group", [ <privileges>... ], <options>...]
-
The caller must have any of the listed privileges on /access/groups. In addition there are two possible checks depending on whether the groups_param option is set:
-
groups_param is set: The API call has a non-optional groups parameter and the caller must have any of the listed privileges on all of the listed groups.
-
groups_param is not set: The user passed via the userid parameter must exist and be part of a group on which the caller has any of the listed privileges (via the /access/groups/<group> path).
-
- ["userid-param", "self"]
-
The value provided for the API call’s userid parameter must refer to the user performing the action. (Usually in conjunction with or, to allow users to perform an action on themselves even if they don’t have elevated privileges.)
- ["userid-param", "Realm.AllocateUser"]
-
The user needs Realm.AllocateUser access to /access/realm/<realm>, with <realm> referring to the realm of the user passed via the userid parameter. Note that the user does not need to exist in order to be associated with a realm, since user IDs are passed in the form of <username>@<realm>.
- ["perm-modify", <path>]
-
The path is a templated parameter (see Objects and Paths). The user needs either the Permissions.Modify privilege, or, depending on the path, the following privileges as a possible substitute:
-
/storage/...: additionally requires 'Datastore.Allocate`
-
/vms/...: additionally requires 'VM.Allocate`
-
/pool/...: additionally requires 'Pool.Allocate`
If the path is empty, Permission.Modify on /access is required.
-
Command Line Tool
Real World Examples
Auditors
You can give read only access to users by assigning the PVEAuditor role to users or groups.
Example1: Allow user joe@pve to see everything
Example1: Allow user joe@pve to see all virtual machines
Delegate User Management
If you want to delegate user management to user joe@pve you can do that with:
