Difference between revisions of "User Management"

From Proxmox VE
Jump to navigation Jump to search
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{#pvedocs:chapter-pveum-plain.html}}
+
<!--PVE_IMPORT_START_MARKER-->
 
+
<!-- Do not edit - this is autogenerated content -->
== Introduction ==
+
{{#pvedocs:pveum-plain.html}}
Proxmox VE supports multiple authentication sources, e.g. Microsoft Active Directory, LDAP, Linux PAM or the integrated Proxmox VE authentication server.
+
[[Category:Reference Documentation]]
 
+
<pvehide>
By using the role based user- and permission management for all objects (VM´s, storages, nodes, etc.) granular access can be defined.
+
Proxmox VE supports multiple authentication sources, e.g. Linux PAM,
 
+
an integrated Proxmox VE authentication server, LDAP, Microsoft Active
== Authentication Realms ==
+
Directory and OpenId Connect.
 
+
By using the role based user- and permission management for all
Proxmox VE stores all user attributes in /etc/pve/user.cfg. So there must be an entry for each user in that file. The password is not stored, instead you can use configure several realms to verify passwords.
+
objects (VMs, storages, nodes, etc.) granular access can be defined.
 
+
Users
=== Microsoft Active Directory ===
+
Proxmox VE stores user attributes in /etc/pve/user.cfg.
 
+
Passwords are not stored here, users are instead associated with
[[Image:Screen-Add-ADS.png|Add-ADS]]
+
authentication realms described below.
 
+
Therefore a user is internally often identified by its name and
=== LDAP ===
+
realm in the form &lt;userid&gt;@&lt;realm&gt;.
=== Linux PAM standard authentication ===
+
Each user entry in this file contains the following information:
 
+
First name
You need to create the system users first with '''adduser''' (e.g. adduser heinz) and possibly the group as well. After that you can create the user on the GUI!
+
Last name
<source lang="bash">
+
E-mail address
 +
Group memberships
 +
An optional Expiration date
 +
A comment or note about this user
 +
Whether this user is enabled or disabled
 +
Optional two-factor authentication keys
 +
When you disabled or delete a user, or the expiry date got set and is
 +
in the past, this user will not be able to log in to new sessions or start new
 +
tasks. All tasks which already have been started by this user (for example
 +
terminal sessions) will not be terminated automatically by any such event.
 +
System administrator
 +
The system&#8217;s root user can always log in via the Linux PAM realm and is an
 +
unconfined administrator. This user cannot be deleted, but attributes can
 +
still be changed and system mails will be sent to the email address
 +
assigned to this user.
 +
Groups
 +
Each user can be member of several groups. Groups are the preferred
 +
way to organize access permissions. You should always grant permission
 +
to groups instead of using individual users. That way you will get a
 +
much shorter access control list which is easier to handle.
 +
API Tokens
 +
API tokens allow stateless access to most parts of the REST API by another
 +
system, software or API client. Tokens can be generated for individual users
 +
and can be given separate permissions and expiration dates to limit the scope
 +
and duration of the access. Should the API token get compromised it can be
 +
revoked without disabling the user itself.
 +
API tokens come in two basic types:
 +
separated privileges: the token needs to be given explicit access with ACLs,
 +
  its effective permissions are calculated by intersecting user and token
 +
  permissions.
 +
full privileges: the token permissions are identical to that of the
 +
  associated user.
 +
The token value is only displayed/returned once when the token is
 +
generated. It cannot be retrieved again over the API at a later time!
 +
To use an API token, set the HTTP header Authorization to the displayed value
 +
of the form PVEAPIToken=USER@REALM!TOKENID=UUID when making API requests, or
 +
refer to your API client documentation.
 +
Resource Pools
 +
A resource pool is a set of virtual machines, containers, and storage
 +
devices. It is useful for permission handling in cases where certain users
 +
should have controlled access to a specific set of resources, as it allows for a
 +
single permission to be applied to a set of elements, rather than having to
 +
manage this on a per resource basis. Resource pools are often used in tandem
 +
with groups so that the members of a group have permissions on a set of machines
 +
and storage.
 +
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.
 
useradd heinz
 
useradd heinz
 
passwd heinz
 
passwd heinz
groupadd Watchman
+
groupadd watchman
usermod -a -G Watchman heinz
+
usermod -a -G watchman heinz
</source>
+
Proxmox VE authentication server
 
+
This is a unix like password store (/etc/pve/priv/shadow.cfg).
=== Proxmox VE authentication server ===
+
Password are encrypted using the SHA-256 hash method.
 
+
This is the most convenient method for small (or even medium)
This is a unix like password store (/etc/pve/priv/shadow.cfg). Password are encrypted using the SHA-256 hash method. Users are allowed to change passwords.
+
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
== Terms and Definitions ==
+
change their own passwords via the GUI.
 
+
LDAP
=== Users ===
+
It is possible to authenticate users via an LDAP server (e.g.
 
+
openldap). The server and an optional fallback server can be
A Proxmox VE user name consists of 2 parts: <userid>@<realm>. The login screen on the GUI shows them a separate items, but it is internally used as single string.  
+
configured and the connection can be encrypted via SSL.
 
+
Users are searched under a Base Domain Name (base_dn), with the
We store the following attribute for users (/etc/pve/user.cfg):
+
user name found in the attribute specified in the User Attribute Name
 
+
(user_attr) field.
* first name
+
For instance, if a user is represented via the
* last name
+
following ldif dataset:
* email address
+
# user1 of People at ldap-test.com
* expiration date
+
dn: uid=user1,ou=People,dc=ldap-test,dc=com
* flag to enable/disable account
+
objectClass: top
* comment
+
objectClass: person
 
+
objectClass: organizationalPerson
==== Superuser ====
+
objectClass: inetOrgPerson
 
+
uid: user1
The traditional unix superuser account is called 'root@pam'. All system mails are forwarded to the email assigned to that account.
+
cn: Test User 1
 
+
sn: Testers
=== Groups ===
+
description: This is the first test user.
 
+
The Base Domain Name would be ou=People,dc=ldap-test,dc=com and the user
Each user can be member of several groups. Groups are the preferred way to organize access permissions. You should always grant permission to groups instead of using individual users. That way you will get a much shorter access control list which is easier to handle.
+
attribute would be uid.
 
+
If Proxmox VE needs to authenticate (bind) to the LDAP server before being
=== Objects and Paths ===
+
able to query and authenticate users, a bind domain name can be
 
+
configured via the bind_dn property in /etc/pve/domains.cfg. Its
Access permissions are assigned to objects, such as a virtual machines (/vms/{vmid}) or a storage (/storage/{storeid}) or a pool of resources (/pool/{poolname}). We use filesystem like paths to address those objects. Those paths form a natural tree, and permissions can be inherited down that hierarchy.
+
password then has to be stored in /etc/pve/priv/ldap/&lt;realmname&gt;.pw
 
+
(e.g. /etc/pve/priv/ldap/my-ldap.pw). This file should contain a
=== Privileges ===
+
single line containing the raw password.
 
+
To verify certificates, you need to to set capath. You can set it either
A privilege is the right to perform a specific action. To simplify management, lists of privileges are grouped into roles, which can then be uses to set permissions.
+
directly to the CA certificate of your LDAP server, or to the system path
 
+
containing all trusted CA certificates (/etc/ssl/certs).
We currently use the following privileges:
+
Additionally, you need to set the verify option, which can also be done over
 
+
the web interface.
==== Node / System related privileges ====
+
Microsoft Active Directory
* Permissions.Modify: modify access permissions
+
A server and authentication domain need to be specified. Like with LDAP, an
* Sys.PowerMgmt: Node power management (start, stop, reset, shutdown, ...)
+
optional fallback server, port, and SSL encryption can be configured.
* Sys.Console: console access to Node
+
OpenId Connect
* Sys.Syslog: view Syslog
+
OpenID Connect allows clients to verify the identity of the user based
* Sys.Audit: view node status/config
+
on the authentication performed by an external authorization
* Sys.Modify: create/remove/modify system
+
server.
* Group.Allocate: create/remove/modify groups
+
OpenId Connect
* Pool.Allocate: create/remove/modify a pool
+
The main OpenID Connect configuration options are:
* Realm.Allocate: create/remove/modify authentication realms
+
issuer-url: This is the Url to the authorization server. Proxmox
* Realm.AllocateUser: assign user to a realm
+
uses the OpenID Connect Discovery protocol to automatiocally configure
* User.Modify: create/remove/modify user access and details.
+
further details.
 
+
While it is possible to use unencrypted http:// Urls, we strongly recommend to
==== Virtual machine related privileges ====
+
use encrypted https:// connections.
 
+
client-id:  OpenID Client ID.
* VM.Allocate: create/remove new VM to server inventory
+
client-key: Optional OpenID Client Key.
* VM.Migrate: migrate VM to alternate server on cluster
+
autocreate: Automatically create users if they do not exist. While
* VM.PowerMgmt: power management (start, stop, reset, shutdown, ...)
+
authentication is done at the OpenID server, all users still need an
* VM.Console: console access to VM
+
entry in the Proxmox VE user configuration. You can either add them
* VM.Monitor: access to VM monitor (kvm)
+
manually, or use the autocreate option to automatically add new
* VM.Backup: backup/restore VMs
+
users.
* VM.Audit: view VM config
+
username-claim: OpenID claim used to generate the unique username
* VM.Clone: clone/copy a VM
+
  (subject, username or email).
* VM.Config.Disk: add/modify/delete Disks
+
Username mapping
* VM.Config.CDROM: eject/change CDROM
+
The Openid Connect specification defines a single unique attribute
* VM.Config.CPU: modify CPU settings
+
(claim in OpenId terms) named subject. By default, we use the
* VM.Config.Memory: modify Memory settings
+
value of this attribute to generate Proxmox VE usernames, by simple adding
* VM.Config.Network: add/modify/delete Network devices
+
@ and the realm name: ${subject}@${realm}.
* VM.Config.HWType: modify emulated HW type
+
Unfortunately, most OpenID server use random strings for subject, like
* VM.Config.Options: modify any other VM configuration
+
DGH76OKH34BNG3245SB, so a typical username would look like
* VM.Snapshot: create/remove VM snapshots
+
DGH76OKH34BNG3245SB@yourrealm. While unique, it is really hard for
 
+
humans to remember such random strings, making it quite impossible to
==== Storage related privileges ====
+
associate real users with that.
 
+
The username-claim setting allows you to use other attributes for
* Datastore.Allocate: create/remove/modify a data store, delete volumes
+
the username mapping. Setting it to username is preferred, if the
* Datastore.AllocateSpace: allocate space on a datastore
+
OpenId Connect server provides that attribute and guarantee its
* Datastore.AllocateTemplate: allocate/upload templates and iso images
+
uniqueness.
* Datastore.Audit: view/browse a datastore
+
Another option is to use email, which also yields to human readable
 
+
usernames. Again, only use this setting if the server guarantees the
=== Roles ===
+
uniqueness of this attribute.
 
+
Examples
A role is simply a list of privileges. Proxmox VE comes with a number of predefined roles which satisfies most needs.
+
Here is an example to create an OpenId realm using Google. You need to
 
+
replace --client-id and --client-key with the values
* Administrator: has all privileges
+
from your Google OpenId settings.
* NoAccess: has no privileges (used to forbid access)
+
pveum realm add myrealm1 --type openid --issuer-url  https://accounts.google.com --client-id XXXX --client-key YYYY --username-claim email
* PVEAdmin: can do most things, but miss rights to modify system settings (Sys.PowerMgmt, Sys.Modify, Realm.Allocate).
+
Above setup uses --username-claim email, so the usernames at the
* PVEAuditor: read only access
+
Proxmox VE side looks like example.user@google.com@myrealm1.
* PVEDatastoreAdmin: create and allocate backup space and templates
+
KeyCloak (https://www.keycloak.org/) is a popular Open Source Identity
* PVEDatastoreUser: allocate backup space and view storage
+
and Access Management supporting OpenId Connect. In the following
* PVEPoolAdmin: allocate pools
+
example, you need to replace the --issuer-url and --client-id with
* PVESysAdmin: User ACLs, audit, system console and system logs
+
your setting:
* PVETemplateUser: view and clone templates
+
pveum realm add myrealm2 --type openid --issuer-url  https://your.server:8080/auth/realms/your-realm --client-id XXX --username-claim username
* PVEUserAdmin: user administration
+
Using --username-claim username yields to simple usernames on the
* PVEVMAdmin: fully administer VMs
+
Proxmox VE side, like example.user@myrealm2.
* PVEVMUser: view, backup, config CDROM, VM console, VM power management
+
You need to make sure that the user is not allowed to edit
 
+
the username setting himself (on the Keycloak server).
 +
Syncing LDAP-based realms
 +
It is possible to sync users and groups for LDAP based realms. You can use the
 +
CLI command
 +
  pveum realm sync &lt;realm&gt;
 +
or in the Authentication panel of the GUI. Users and groups are synced to the
 +
cluster-wide user configuration file /etc/pve/user.cfg.
 +
Requirements and limitations
 +
The bind_dn is used to query the users and groups. This account needs access
 +
to all desired entries.
 +
The fields which represent the names of the users and groups can be configured
 +
via the user_attr and group_name_attr respectively. Only entries which
 +
adhere to the usual character limitations of the user.cfg are synced.
 +
Groups are synced with -$realm attached to the name, to avoid naming
 +
conflicts. Please make sure that a sync does not overwrite manually created
 +
groups.
 +
Options
 +
The main options for syncing are:
 +
dry-run: No data is written to the config. This is useful if you want to
 +
  see which users and groups would get synced to the user.cfg. This is set
 +
  when you click Preview in the GUI.
 +
enable-new: If set, the newly synced users are enabled and can login.
 +
  The default is true.
 +
full: If set, the sync uses the LDAP Directory as a source of truth,
 +
  overwriting information set manually in the user.cfg and deletes users
 +
  and groups which are not present in the LDAP directory. If not set,
 +
  only new data is written to the config, and no stale users are deleted.
 +
purge: If set, sync removes all corresponding ACLs when removing users
 +
  and groups. This is only useful with the option full.
 +
scope: The scope of what to sync. It can be either users, groups or
 +
  both.
 +
These options are either set as parameters or as defaults, via the
 +
realm option sync-defaults-options.
 +
Two-factor authentication
 +
There are two ways to use two-factor authentication:
 +
It can be required by the authentication realm, either via TOTP
 +
(Time-based One-Time Password) or YubiKey OTP. In this case a newly
 +
created user needs their keys added immediately as there is no way to
 +
log in without the second factor. In the case of TOTP, users can
 +
also change the TOTP later on, provided they can log in first.
 +
Alternatively, users can choose to opt in to two-factor authentication
 +
via TOTP later on, even if the realm does not enforce it. As another
 +
option, if the server has an AppId configured, a user can opt into
 +
U2F authentication, provided the realm does not enforce any other
 +
second factor.
 +
Realm enforced 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.
 +
Currently there are two methods available:
 +
Time-based OATH (TOTP)
 +
This uses the standard HMAC-SHA1 algorithm
 +
where the current time is hashed with the user&#8217;s configured key. The
 +
time step and password length parameters are configured.
 +
A user can have multiple keys configured (separated by spaces), and the keys
 +
can be specified in Base32 (RFC3548) or hexadecimal notation.
 +
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, or on Android Google Authenticator,
 +
FreeOTP, andOTP or similar applications.
 +
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&#8217;s Key IDs field.
 +
+
 +
Please refer to the YubiKey OTP
 +
documentation for how to use the
 +
YubiCloud or
 +
host
 +
your own verification server.
 +
User configured TOTP authentication
 +
Users can choose to enable TOTP as a second factor on login via the TFA
 +
button in the user list (unless the realm enforces YubiKey OTP).
 +
After opening the TFA window, the user is presented with a dialog to setup
 +
TOTP authentication. The Secret field contains the key, which can simply be
 +
generated randomly via the Randomize button. An optional Issuer Name can be
 +
added to provide information to the TOTP app what the key belongs to.
 +
Most TOTP apps will show the issuer name together with the corresponding
 +
OTP values. The user name is also included in the QR code for the TOTP app.
 +
After generating a key, a QR code will be displayed which can be used with most
 +
OTP apps such as FreeOTP. Now the user needs to verify both the current user
 +
password (unless logged in as root), as well as the ability to correctly use
 +
the TOTP key by typing the current OTP value into the Verification Code
 +
field before pressing the Apply button.
 +
Server side U2F configuration
 +
To allow users to use U2F authentication, it may be necessary to use a valid
 +
domain with a valid https certificate, otherwise some browsers may print
 +
a warning or reject U2F usage altogether. Initially an AppId
 +
[AppId https://developers.yubico.com/U2F/App_ID.html]
 +
needs to be configured.
 +
Changing the AppId will render all existing U2F registrations
 +
unusable!
 +
This is done via /etc/pve/datacenter.cfg, for instance:
 +
u2f: appid=https://mypve.example.com:8006
 +
For a single node, the AppId can simply be the web UI address exactly as it
 +
is used in the browser, including the https:// and the port as shown above.
 +
Please note that some browsers may be more strict than others when matching
 +
AppIds.
 +
When using multiple nodes, it is best to have a separate https server
 +
providing an appid.json
 +
[Multi-facet apps: https://developers.yubico.com/U2F/App_ID.html]
 +
file, as it seems to be compatible with most
 +
browsers. If all nodes use subdomains of the same top level domain, it may be
 +
enough to use the TLD as AppId, but note that some browsers may not accept
 +
this.
 +
A bad AppId will usually produce an error, but we have encountered
 +
situation where this does not happen, particularly when using a top level domain
 +
AppId for a node accessed via a subdomain in Chromium. For this reason it is
 +
recommended to test the configuration with multiple browsers, as changing the
 +
AppId later will render existing U2F registrations unusable.
 +
Activating U2F as a user
 +
To enable U2F authentication, open the TFA window&#8217;s U2F tab, type in the
 +
current password (unless logged in as root), and press the Register button.
 +
If the server is setup correctly and the browser accepted the server&#8217;s provided
 +
AppId, a message will appear prompting the user to press the button on the
 +
U2F device (if it is a YubiKey the button light should be toggling off and
 +
on steadily around twice per second).
 +
Firefox users may need to enable security.webauth.u2f via about:config
 +
before they can use a U2F token.
 +
Permission Management
 +
In order for a user to perform an action (such as listing, modifying or
 +
deleting a parts of a VM configuration), the user needs to have the
 +
appropriate permissions.
 +
Proxmox VE uses a role and path based permission management system. An entry in
 +
the permissions table allows a user, group or token 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), (path, group,
 +
role) or (path, token, role), with the role containing a set of allowed
 +
actions, and the path representing the target of these actions.
 +
Roles
 +
A role is simply a list of privileges. Proxmox VE comes with a number
 +
of predefined roles which satisfies most needs.
 +
Administrator: has all privileges
 +
NoAccess: has no privileges (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: fully administer VMs
 +
PVEVMUser: view, backup, config CD-ROM, VM console, VM power management
 
You can see the whole set of predefined roles on the GUI.
 
You can see the whole set of predefined roles on the GUI.
 
+
Adding new roles can be done via both GUI and the command line.
Adding new roles using the CLI:
+
For the GUI just navigate to Permissions &#8594; User Tab from Datacenter and
<source lang="bash">
+
click on the Create button, there you can set a name and select all desired
 +
roles from the Privileges dropdown box.
 +
To add a role through the command line you can use the pveum CLI tool, like
 +
this:
 
pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console"
 
pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console"
 
pveum roleadd Sys_Power-only -privs "Sys.PowerMgmt Sys.Console"
 
pveum roleadd Sys_Power-only -privs "Sys.PowerMgmt Sys.Console"
</source>
+
Privileges
 
+
A privilege is the right to perform a specific action. To simplify
=== Permissions ===
+
management, lists of privileges are grouped into roles, which can then
 
+
be used in the permission table. Note that privileges cannot directly be
Permissions are the way we control access to objects. In technical terms they are simply a triple containing <path,user,role>. This concept is also known as access control lists. Each permission specifies a subject (user or group) and a role (set of privileges) on a specific path.
+
assigned to users and paths without being part of a role.
 
+
We currently use the following privileges:
When a subject requests an action on an object, the framework looks up the roles assigned to that subject (using the object path). The set of roles defines the granted privileges.
+
Node / System related privileges
 
+
Permissions.Modify: modify access permissions
==== Inheritance ====
+
Sys.PowerMgmt: Node power management (start, stop, reset, shutdown, &#8230;)
 
+
Sys.Console: console access to Node
As mentioned earlier, object paths forms a filesystem like tree, and permissions can be inherited down that tree (the propagate flag is set by default). We use the following inheritance rules:
+
Sys.Syslog: view Syslog
 
+
Sys.Audit: view node status/config, Corosync cluster config and HA config
* permission for individual users always overwrite group permission.
+
Sys.Modify: create/remove/modify node network parameters
* permission for groups apply when the user is member of that group.
+
Group.Allocate: create/remove/modify groups
* permission set at higher level always overwrites inherited permissions.
+
Pool.Allocate: create/remove/modify a pool
 
+
Pool.Audit: view a pool
==== What permission do I need? ====
+
Realm.Allocate: create/remove/modify authentication realms
 
+
Realm.AllocateUser: assign user to a realm
The required API permissions are documented for each individual method, and can be found here: http://pve.proxmox.com/pve2-api-doc/
+
User.Modify: create/remove/modify user access and details.
 
+
Virtual machine related privileges
=== Pools ===
+
VM.Allocate: create/remove new VM to server inventory
 
+
VM.Migrate: migrate VM to alternate server on cluster
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.
+
VM.PowerMgmt: power management (start, stop, reset, shutdown, &#8230;)
 
+
VM.Console: console access to VM
== Command Line Tool ==
+
VM.Monitor: access to VM monitor (kvm)
 
+
VM.Backup: backup/restore VMs
Most users will simply use the GUI to manage users. But there is also a full featured command line tool called 'pveum' (short for 'Proxmox VE User Manager'). I will use that tool in the following examples. Please note that all Proxmox VE command line tools are wrappers around the API, so you can also access those function through the REST API.
+
VM.Audit: view VM config
 
+
VM.Clone: clone/copy a VM
 +
VM.Config.Disk: add/modify/delete Disks
 +
VM.Config.CDROM: eject/change CD-ROM
 +
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
 +
Access permissions are assigned to objects, such as a virtual machines,
 +
storages or pools of resources.
 +
We use file system like paths to address these objects. These paths form a
 +
natural tree, and permissions of higher levels (shorter path) can
 +
optionally be propagated down within this hierarchy.
 +
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&#8217;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&#8217;s path parameter.
 +
Some examples are:
 +
/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
 +
Inheritance
 +
As mentioned earlier, object paths form a file system like tree, and
 +
permissions can be inherited down that tree (the propagate flag is set
 +
by default). We use the following inheritance rules:
 +
Permissions for individual users always replace group permissions.
 +
Permissions for groups apply when the user is member of that group.
 +
Permissions replace the ones inherited from an upper level.
 +
Additionally, privilege separated tokens can never have a permission on any
 +
given path that their associated user does not have.
 +
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 https://pve.proxmox.com/pve-docs/api-viewer/
 +
The permissions are specified as a list which can be interpreted as a
 +
tree of logic and access-check functions:
 +
["and", &lt;subtests&gt;...] and ["or", &lt;subtests&gt;...]
 +
Each(and) or any(or) further element in the current list has to be true.
 +
["perm", &lt;path&gt;, [ &lt;privileges&gt;... ], &lt;options&gt;...]
 +
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&#8217;s schema otherwise lists it as being optional.
 +
["userid-group", [ &lt;privileges&gt;... ], &lt;options&gt;...]
 +
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/&lt;group&gt; path).
 +
["userid-param", "self"]
 +
The value provided for the API call&#8217;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&#8217;t have elevated
 +
privileges.)
 +
["userid-param", "Realm.AllocateUser"]
 +
The user needs Realm.AllocateUser access to /access/realm/&lt;realm&gt;, with
 +
&lt;realm&gt; 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
 +
&lt;username&gt;@&lt;realm&gt;.
 +
["perm-modify", &lt;path&gt;]
 +
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
 +
Most users will simply use the GUI to manage users. But there is also
 +
a fully featured command line tool called pveum (short for &#8220;Proxmox
 +
VE User Manager&#8221;). Please note that all Proxmox VE command
 +
line tools are wrappers around the API, so you can also access those
 +
functions through the REST API.
 
Here are some simple usage examples. To show help type:
 
Here are some simple usage examples. To show help type:
 
+
pveum
pveum
 
 
 
 
or (to show detailed help about a specific command)
 
or (to show detailed help about a specific command)
 
+
pveum help user add
pveum help useradd
 
 
 
 
Create a new user:
 
Create a new user:
 
+
pveum user add testuser@pve -comment "Just a test"
pveum useradd testuser@pve -comment 'Just a test'
 
 
 
 
Set or Change the password (not all realms support that):
 
Set or Change the password (not all realms support that):
 
+
pveum passwd testuser@pve
pveum passwd testuser@pve
 
 
 
 
Disable a user:
 
Disable a user:
 
+
pveum user modify testuser@pve -enable 0
pveum usermod testuser@pve -enable 0
 
 
 
 
Create a new group:
 
Create a new group:
 
+
pveum group add testgroup
pveum groupadd testgroup
+
Create a new role:
 
+
pveum role add PVE_Power-only -privs "VM.PowerMgmt VM.Console"
Create a new role ([http://forum.proxmox.com/threads/12529-New-Role-for-quot-VM-PowerMgmt-quot-only?p=68015#post68015 Forum bug]):
+
Real World Examples
 
+
Administrator Group
pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console"
+
One of the most wanted features was the ability to define a group of
 
+
users with full administrator rights (without using the root account).
== Real World Examples ==
 
 
 
=== Administrator Group ===
 
 
 
One of the most wanted features was the ability to define a group of users with full administartor rights (without using the root account).
 
 
 
 
Define the group:
 
Define the group:
 
+
pveum group add admin -comment "System Administrators"
pveum groupadd admin -comment "System Administrators"
 
 
 
 
Then add the permission:
 
Then add the permission:
 
+
pveum acl modify / -group admin -role Administrator
pveum aclmod / -group admin -role Administrator
+
You can finally add users to the new admin group:
 
+
pveum user modify testuser@pve -group admin
You can finally add users to the new 'admin' group:
+
Auditors
 
+
You can give read only access to users by assigning the PVEAuditor
pveum usermod testuser@pve -group admin
+
role to users or groups.
 
+
Example1: Allow user joe@pve to see everything
=== Auditors ===
+
pveum acl modify / -user joe@pve -role PVEAuditor
 
+
Example1: Allow user joe@pve to see all virtual machines
You can give read only access to users by assigning the 'PVEAuditor' role to users or groups.
+
pveum acl modify /vms -user joe@pve -role PVEAuditor
 
+
Delegate User Management
Example1: Allow user 'joe@pve' to see everything
+
If you want to delegate user management to user joe@pve you can do
 
+
that with:
pveum aclmod / -user joe@pve -role PVEAuditor
+
pveum acl modify /access -user joe@pve -role PVEUserAdmin
 
+
User joe@pve can now add and remove users, change passwords and
Example1: Allow user 'joe@pve' to see all virtual machines
+
other user attributes. This is a very powerful role, and you most
 
+
likely want to limit that to selected realms and groups. The following
pveum aclmod /vms -user joe@pve -role PVEAuditor
+
example allows joe@pve to modify users within realm pve if they
 
+
are members of group customers:
=== Delegate User Management ===
+
pveum acl modify /access/realm/pve -user joe@pve -role PVEUserAdmin
 
+
pveum acl modify /access/groups/customers -user joe@pve -role PVEUserAdmin
If you want to delegate user managenent to user 'joe@pve' you can do that with:
+
The user is able to add other users, but only if they are
 
+
members of group customers and within realm pve.
pveum aclmod /access -user joe@pve -role PVEUserAdmin
+
Limited API token for monitoring
 
+
Given a user joe@pve with the PVEVMAdmin role on all VMs:
User 'joe@pve' can now add and remove users, change passwords and other user attributes. This is a very powerful role, and you most likely want to limit that to selected realms and groups. The following example allows 'joe@pve' to modify users within realm 'pve' if they are members of group 'customers':
+
pveum acl modify /vms -user joe@pve -role PVEVMAdmin
 
+
Add a new API token with separate privileges, which is only allowed to view VM
pveum aclmod /access/realm/pve -user joe@pve -role PVEUserAdmin
+
information (e.g., for monitoring purposes):
pveum aclmod /access/groups/customers -user joe@pve -role PVEUserAdmin
+
pveum user token add joe@pve monitoring -privsep 1
 
+
pveum acl modify /vms -token 'joe@pve!monitoring' -role PVEAuditor
Note: The user is able to add other users, but only if they are members of group 'customers' and within realm 'pve'.
+
Verify the permissions of the user and token:
 
+
pveum user permissions joe@pve
=== Pools ===
+
pveum user token permissions joe@pve monitoring
 
+
Resource Pools
An enterprise is usually structured into several smaller departments, and it is common that you want to assign resources to them and delegate management tasks. A pool is simply a set of virtual machines and data stores. You can create pools on the GUI. After that you can add resources to the pool (VMs, Storage).
+
An enterprise is usually structured into several smaller departments, and it is
 
+
common that you want to assign resources and delegate management tasks to each
You can also assign permissions to the pool. Those permissions are inherited to all pool members.
+
of these. Let&#8217;s assume that you want to set up a pool for a software development
 
+
department. First, create a group
Lets assume you have a software development department, so we first create a group
+
pveum group add developers -comment "Our software developers"
 
 
pveum groupadd developers -comment "Our software developers"
 
 
 
 
Now we create a new user which is a member of that group
 
Now we create a new user which is a member of that group
 +
pveum user add developer1@pve -group developers -password
 +
The -password parameter will prompt you for a password
 +
Then we create a resource pool for our development department to use
 +
pveum pool add dev-pool --comment "IT development pool"
 +
Finally, we can assign permissions to that pool
 +
pveum acl modify /pool/dev-pool/ -group developers -role PVEAdmin
 +
Our software developers can now administrate the resources assigned to
 +
that pool.
 +
</pvehide>
 +
<!--PVE_IMPORT_END_MARKER-->
  
pveum useradd developer1@pve -group developers -password
 
 
Note: The -password parameter will prompt you for a password
 
 
I assume we already created a pool called 'dev-pool' on the GUI. So we can now assign permission to that pool:
 
 
pveum aclmod /pool/dev-pool/ -group developers -role PVEAdmin
 
 
Our software developers can now administrate the resources assigned to that pool.
 
 
==== Resource Limits ====
 
 
Future versions will allow you to specify resource limits for pools (currently not implemented).
 
 
== Video Tutorials ==
 
tbd: [http://www.youtube.com/user/ProxmoxVE Proxmox VE Youtube channel]
 
  
 
[[Category: HOWTO]]
 
[[Category: HOWTO]]
[[Category:Reference Documentation]]
 

Latest revision as of 12:56, 6 July 2021

Proxmox VE supports multiple authentication sources, e.g. Linux PAM, an integrated Proxmox VE authentication server, LDAP, Microsoft Active Directory and OpenId Connect.

By using the role based user- and permission management for all objects (VMs, storages, nodes, etc.) granular access can be defined.

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>.

Each user entry in this file contains the following information:

  • First name

  • Last name

  • E-mail address

  • Group memberships

  • An optional Expiration date

  • A comment or note about this user

  • Whether this user is enabled or disabled

  • Optional two-factor authentication keys

Caution When you disabled or delete a user, or the expiry date got set and is in the past, this user will not be able to log in to new sessions or start new tasks. All tasks which already have been started by this user (for example terminal sessions) will not be terminated automatically by any such event.

System administrator

The system’s root user can always log in via the Linux PAM realm and is an unconfined administrator. This user cannot be deleted, but attributes can still be changed and system mails will be sent to the email address assigned to this user.

Groups

Each user can be member of several groups. Groups are the preferred way to organize access permissions. You should always grant permission to groups instead of using individual users. That way you will get a much shorter access control list which is easier to handle.

API Tokens

API tokens allow stateless access to most parts of the REST API by another system, software or API client. Tokens can be generated for individual users and can be given separate permissions and expiration dates to limit the scope and duration of the access. Should the API token get compromised it can be revoked without disabling the user itself.

API tokens come in two basic types:

  • separated privileges: the token needs to be given explicit access with ACLs, its effective permissions are calculated by intersecting user and token permissions.

  • full privileges: the token permissions are identical to that of the associated user.

Caution The token value is only displayed/returned once when the token is generated. It cannot be retrieved again over the API at a later time!

To use an API token, set the HTTP header Authorization to the displayed value of the form PVEAPIToken=USER@REALM!TOKENID=UUID when making API requests, or refer to your API client documentation.

Resource Pools

screenshot/gui-datacenter-pool-window.png

A resource pool is a set of virtual machines, containers, and storage devices. It is useful for permission handling in cases where certain users should have controlled access to a specific set of resources, as it allows for a single permission to be applied to a set of elements, rather than having to manage this on a per resource basis. Resource pools are often used in tandem with groups so that the members of a group have permissions on a set of machines and storage.

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.

useradd heinz
passwd heinz
groupadd watchman
usermod -a -G watchman heinz
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

It is possible to authenticate users via an LDAP server (e.g. openldap). The server and an optional fallback server can be configured and the connection can be encrypted via SSL.

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.

For instance, if a user is represented via the following ldif dataset:

# user1 of People at ldap-test.com
dn: uid=user1,ou=People,dc=ldap-test,dc=com
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
uid: user1
cn: Test User 1
sn: Testers
description: This is the first test user.

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.

To verify certificates, you need to to set capath. You can set it either directly to the CA certificate of your LDAP server, or to the system path containing all trusted CA certificates (/etc/ssl/certs). Additionally, you need to set the verify option, which can also be done over the web interface.

Microsoft Active Directory

A server and authentication domain need to be specified. Like with LDAP, an optional fallback server, port, and SSL encryption can be configured.

OpenId Connect

OpenID Connect allows clients to verify the identity of the user based on the authentication performed by an external authorization server.

OpenId Connect

The main OpenID Connect configuration options are:

  • issuer-url: This is the Url to the authorization server. Proxmox uses the OpenID Connect Discovery protocol to automatiocally configure further details.

    While it is possible to use unencrypted http:// Urls, we strongly recommend to use encrypted https:// connections.

  • client-id: OpenID Client ID.

  • client-key: Optional OpenID Client Key.

  • autocreate: Automatically create users if they do not exist. While authentication is done at the OpenID server, all users still need an entry in the Proxmox VE user configuration. You can either add them manually, or use the autocreate option to automatically add new users.

  • username-claim: OpenID claim used to generate the unique username (subject, username or email).

Username mapping

The Openid Connect specification defines a single unique attribute (claim in OpenId terms) named subject. By default, we use the value of this attribute to generate Proxmox VE usernames, by simple adding @ and the realm name: ${subject}@${realm}.

Unfortunately, most OpenID server use random strings for subject, like DGH76OKH34BNG3245SB, so a typical username would look like DGH76OKH34BNG3245SB@yourrealm. While unique, it is really hard for humans to remember such random strings, making it quite impossible to associate real users with that.

The username-claim setting allows you to use other attributes for the username mapping. Setting it to username is preferred, if the OpenId Connect server provides that attribute and guarantee its uniqueness.

Another option is to use email, which also yields to human readable usernames. Again, only use this setting if the server guarantees the uniqueness of this attribute.

Examples

Here is an example to create an OpenId realm using Google. You need to replace --client-id and --client-key with the values from your Google OpenId settings.

pveum realm add myrealm1 --type openid --issuer-url  https://accounts.google.com --client-id XXXX --client-key YYYY --username-claim email

Above setup uses --username-claim email, so the usernames at the Proxmox VE side looks like example.user@google.com@myrealm1.

KeyCloak (https://www.keycloak.org/) is a popular Open Source Identity and Access Management supporting OpenId Connect. In the following example, you need to replace the --issuer-url and --client-id with your setting:

pveum realm add myrealm2 --type openid --issuer-url  https://your.server:8080/auth/realms/your-realm --client-id XXX --username-claim username

Using --username-claim username yields to simple usernames on the Proxmox VE side, like example.user@myrealm2.

Warning You need to make sure that the user is not allowed to edit the username setting himself (on the Keycloak server).

Syncing LDAP-based realms

screenshot/gui-datacenter-realm-add-ldap.png

It is possible to sync users and groups for LDAP based realms. You can use the CLI command

  pveum realm sync <realm>

or in the Authentication panel of the GUI. Users and groups are synced to the cluster-wide user configuration file /etc/pve/user.cfg.

Requirements and limitations

The bind_dn is used to query the users and groups. This account needs access to all desired entries.

The fields which represent the names of the users and groups can be configured via the user_attr and group_name_attr respectively. Only entries which adhere to the usual character limitations of the user.cfg are synced.

Groups are synced with -$realm attached to the name, to avoid naming conflicts. Please make sure that a sync does not overwrite manually created groups.

Options

screenshot/gui-datacenter-realm-add-ldap-sync-options.png

The main options for syncing are:

  • dry-run: No data is written to the config. This is useful if you want to see which users and groups would get synced to the user.cfg. This is set when you click Preview in the GUI.

  • enable-new: If set, the newly synced users are enabled and can login. The default is true.

  • full: If set, the sync uses the LDAP Directory as a source of truth, overwriting information set manually in the user.cfg and deletes users and groups which are not present in the LDAP directory. If not set, only new data is written to the config, and no stale users are deleted.

  • purge: If set, sync removes all corresponding ACLs when removing users and groups. This is only useful with the option full.

  • scope: The scope of what to sync. It can be either users, groups or both.

These options are either set as parameters or as defaults, via the realm option sync-defaults-options.

Two-factor authentication

There are two ways to use two-factor authentication:

It can be required by the authentication realm, either via TOTP (Time-based One-Time Password) or YubiKey OTP. In this case a newly created user needs their keys added immediately as there is no way to log in without the second factor. In the case of TOTP, users can also change the TOTP later on, provided they can log in first.

Alternatively, users can choose to opt in to two-factor authentication via TOTP later on, even if the realm does not enforce it. As another option, if the server has an AppId configured, a user can opt into U2F authentication, provided the realm does not enforce any other second factor.

Realm enforced 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.

Currently there are two methods available:

Time-based OATH (TOTP)

This uses the standard HMAC-SHA1 algorithm where the current time is hashed with the user’s configured key. The time step and password length parameters are configured.

A user can have multiple keys configured (separated by spaces), and the keys can be specified in Base32 (RFC3548) or hexadecimal notation.

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, or on Android Google Authenticator, FreeOTP, andOTP or similar applications.

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.

+ Please refer to the YubiKey OTP documentation for how to use the YubiCloud or host your own verification server.

User configured TOTP authentication

Users can choose to enable TOTP as a second factor on login via the TFA button in the user list (unless the realm enforces YubiKey OTP).

screenshot/gui-datacenter-users-tfa.png

After opening the TFA window, the user is presented with a dialog to setup TOTP authentication. The Secret field contains the key, which can simply be generated randomly via the Randomize button. An optional Issuer Name can be added to provide information to the TOTP app what the key belongs to. Most TOTP apps will show the issuer name together with the corresponding OTP values. The user name is also included in the QR code for the TOTP app.

After generating a key, a QR code will be displayed which can be used with most OTP apps such as FreeOTP. Now the user needs to verify both the current user password (unless logged in as root), as well as the ability to correctly use the TOTP key by typing the current OTP value into the Verification Code field before pressing the Apply button.

Server side U2F configuration

To allow users to use U2F authentication, it may be necessary to use a valid domain with a valid https certificate, otherwise some browsers may print a warning or reject U2F usage altogether. Initially an AppId
[AppId https://developers.yubico.com/U2F/App_ID.html]
needs to be configured.

Note Changing the AppId will render all existing U2F registrations unusable!

This is done via /etc/pve/datacenter.cfg, for instance:

u2f: appid=https://mypve.example.com:8006

For a single node, the AppId can simply be the web UI address exactly as it is used in the browser, including the https:// and the port as shown above. Please note that some browsers may be more strict than others when matching AppIds.

When using multiple nodes, it is best to have a separate https server providing an appid.json
[Multi-facet apps: https://developers.yubico.com/U2F/App_ID.html]
file, as it seems to be compatible with most browsers. If all nodes use subdomains of the same top level domain, it may be enough to use the TLD as AppId, but note that some browsers may not accept this.

Note A bad AppId will usually produce an error, but we have encountered situation where this does not happen, particularly when using a top level domain AppId for a node accessed via a subdomain in Chromium. For this reason it is recommended to test the configuration with multiple browsers, as changing the AppId later will render existing U2F registrations unusable.

Activating U2F as a user

To enable U2F authentication, open the TFA window’s U2F tab, type in the current password (unless logged in as root), and press the Register button. If the server is setup correctly and the browser accepted the server’s provided AppId, a message will appear prompting the user to press the button on the U2F device (if it is a YubiKey the button light should be toggling off and on steadily around twice per second).

Firefox users may need to enable security.webauth.u2f via about:config before they can use a U2F token.

Permission Management

In order for a user to perform an action (such as listing, modifying or deleting a parts of a VM configuration), the user needs to have the appropriate permissions.

Proxmox VE uses a role and path based permission management system. An entry in the permissions table allows a user, group or token 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), (path, group, role) or (path, token, role), with the role containing a set of allowed actions, and the path representing the target of these actions.

Roles

A role is simply a list of privileges. Proxmox VE comes with a number of predefined roles which satisfies most needs.

  • Administrator: has all privileges

  • NoAccess: has no privileges (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: fully administer VMs

  • PVEVMUser: view, backup, config CD-ROM, VM console, VM power management

You can see the whole set of predefined roles on the GUI.

Adding new roles can be done via both GUI and the command line.

screenshot/gui-datacenter-role-add.png

For the GUI just navigate to Permissions → User Tab from Datacenter and click on the Create button, there you can set a name and select all desired roles from the Privileges dropdown box.

To add a role through the command line you can use the pveum CLI tool, like this:

pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console"
pveum roleadd Sys_Power-only -privs "Sys.PowerMgmt Sys.Console"

Privileges

A privilege is the right to perform a specific action. To simplify management, lists of privileges are grouped into roles, which can then be used in the permission table. Note that privileges cannot directly be assigned to users and paths without being part of a role.

We currently use the following 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

  • Pool.Audit: view 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 CD-ROM

  • 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

Access permissions are assigned to objects, such as a virtual machines, storages or pools of resources. We use file system like paths to address these objects. These paths form a natural tree, and permissions of higher levels (shorter path) can optionally be propagated down within this hierarchy.

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.

Some examples are:

  • /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

Inheritance

As mentioned earlier, object paths form a file system like tree, and permissions can be inherited down that tree (the propagate flag is set by default). We use the following inheritance rules:

  • Permissions for individual users always replace group permissions.

  • Permissions for groups apply when the user is member of that group.

  • Permissions replace the ones inherited from an upper level.

Additionally, privilege separated tokens can never have a permission on any given path that their associated user does not have.

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 https://pve.proxmox.com/pve-docs/api-viewer/

The permissions are specified as a list which can be interpreted as a tree of logic and access-check functions:

["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

Most users will simply use the GUI to manage users. But there is also a fully featured command line tool called pveum (short for “Proxmox VE User Manager”). Please note that all Proxmox VE command line tools are wrappers around the API, so you can also access those functions through the REST API.

Here are some simple usage examples. To show help type:

pveum

or (to show detailed help about a specific command)

pveum help user add

Create a new user:

pveum user add testuser@pve -comment "Just a test"

Set or Change the password (not all realms support that):

pveum passwd testuser@pve

Disable a user:

pveum user modify testuser@pve -enable 0

Create a new group:

pveum group add testgroup

Create a new role:

pveum role add PVE_Power-only -privs "VM.PowerMgmt VM.Console"

Real World Examples

Administrator Group

One of the most wanted features was the ability to define a group of users with full administrator rights (without using the root account).

Define the group:

pveum group add admin -comment "System Administrators"

Then add the permission:

pveum acl modify / -group admin -role Administrator

You can finally add users to the new admin group:

pveum user modify testuser@pve -group admin

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

pveum acl modify / -user joe@pve -role PVEAuditor

Example1: Allow user joe@pve to see all virtual machines

pveum acl modify /vms -user joe@pve -role PVEAuditor

Delegate User Management

If you want to delegate user management to user joe@pve you can do that with:

pveum acl modify /access -user joe@pve -role PVEUserAdmin

User joe@pve can now add and remove users, change passwords and other user attributes. This is a very powerful role, and you most likely want to limit that to selected realms and groups. The following example allows joe@pve to modify users within realm pve if they are members of group customers:

pveum acl modify /access/realm/pve -user joe@pve -role PVEUserAdmin
pveum acl modify /access/groups/customers -user joe@pve -role PVEUserAdmin
Note The user is able to add other users, but only if they are members of group customers and within realm pve.

Limited API token for monitoring

Given a user joe@pve with the PVEVMAdmin role on all VMs:

pveum acl modify /vms -user joe@pve -role PVEVMAdmin

Add a new API token with separate privileges, which is only allowed to view VM information (e.g., for monitoring purposes):

pveum user token add joe@pve monitoring -privsep 1
pveum acl modify /vms -token 'joe@pve!monitoring' -role PVEAuditor

Verify the permissions of the user and token:

pveum user permissions joe@pve
pveum user token permissions joe@pve monitoring

Resource Pools

An enterprise is usually structured into several smaller departments, and it is common that you want to assign resources and delegate management tasks to each of these. Let’s assume that you want to set up a pool for a software development department. First, create a group

pveum group add developers -comment "Our software developers"

Now we create a new user which is a member of that group

pveum user add developer1@pve -group developers -password
Note The -password parameter will prompt you for a password

Then we create a resource pool for our development department to use

pveum pool add dev-pool --comment "IT development pool"

Finally, we can assign permissions to that pool

pveum acl modify /pool/dev-pool/ -group developers -role PVEAdmin

Our software developers can now administrate the resources assigned to that pool.