]>
Commit | Line | Data |
---|---|---|
3c8533f2 | 1 | ifdef::manvolnum[] |
b2f242ab DM |
2 | pveum(1) |
3 | ======== | |
38fd0958 | 4 | include::attributes.txt[] |
5f09af76 DM |
5 | :pve-toplevel: |
6 | ||
3c8533f2 DM |
7 | NAME |
8 | ---- | |
9 | ||
10 | pveum - Proxmox VE User Manager | |
11 | ||
12 | ||
49a5e11c | 13 | SYNOPSIS |
3c8533f2 DM |
14 | -------- |
15 | ||
16 | include::pveum.1-synopsis.adoc[] | |
17 | ||
18 | ||
19 | DESCRIPTION | |
20 | ----------- | |
21 | endif::manvolnum[] | |
22 | ||
23 | ifndef::manvolnum[] | |
24 | User Management | |
25 | =============== | |
38fd0958 | 26 | include::attributes.txt[] |
3c8533f2 | 27 | endif::manvolnum[] |
5f09af76 DM |
28 | ifdef::wiki[] |
29 | :pve-toplevel: | |
30 | endif::wiki[] | |
31 | ||
3c8533f2 DM |
32 | // Copied from pve wiki: Revision as of 16:10, 27 October 2015 |
33 | ||
5462c161 WB |
34 | Proxmox VE supports multiple authentication sources, e.g. Linux PAM, |
35 | an integrated Proxmox VE authentication server, LDAP, Microsoft Active | |
36 | Directory. | |
3c8533f2 DM |
37 | |
38 | By using the role based user- and permission management for all | |
5eba0743 FG |
39 | objects (VMs, storages, nodes, etc.) granular access can be defined. |
40 | ||
3c8533f2 | 41 | |
c80b9ee6 WB |
42 | Users |
43 | ----- | |
44 | ||
45 | {pve} stores user attributes in `/etc/pve/user.cfg`. | |
46 | Passwords are not stored here, users are instead associated with | |
47 | <<authentication-realms,authentication realms>> described below. | |
48 | Therefore a user is internally often identified by its name and | |
49 | realm in the form `<userid>@<realm>`. | |
50 | ||
51 | Each user entry in this file contains the following information: | |
52 | ||
53 | * First name | |
54 | * Last name | |
55 | * E-mail address | |
56 | * Group memberships | |
57 | * An optional Expiration date | |
58 | * A comment or note about this user | |
59 | * Whether this user is enabled or disabled | |
60 | * Optional two factor authentication keys | |
61 | ||
62 | ||
63 | System administrator | |
64 | ~~~~~~~~~~~~~~~~~~~~ | |
65 | ||
66 | The system's root user can always log in via the Linux PAM realm and is an | |
67 | unconfined administrator. This user cannot be deleted, but attributes can | |
68 | still be changed and system mails will be sent to the email address | |
69 | assigned to this user. | |
70 | ||
71 | ||
72 | Groups | |
73 | ~~~~~~ | |
74 | ||
75 | Each user can be member of several groups. Groups are the preferred | |
76 | way to organize access permissions. You should always grant permission | |
77 | to groups instead of using individual users. That way you will get a | |
78 | much shorter access control list which is easier to handle. | |
79 | ||
80 | ||
d6614202 | 81 | [[authentication-realms]] |
3c8533f2 DM |
82 | Authentication Realms |
83 | --------------------- | |
84 | ||
d6614202 WB |
85 | As {pve} users are just counterparts for users existing on some external |
86 | realm, the realms have to be configured in `/etc/pve/domains.cfg`. | |
87 | The following realms (authentication methods) are available: | |
3c8533f2 DM |
88 | |
89 | Linux PAM standard authentication:: | |
d6614202 WB |
90 | In this case a system user has to exist (eg. created via the `adduser` |
91 | command) on all nodes the user is allowed to login, and the user | |
92 | authenticates with their usual system password. | |
93 | + | |
3c8533f2 DM |
94 | [source,bash] |
95 | ---- | |
96 | useradd heinz | |
97 | passwd heinz | |
98 | groupadd watchman | |
99 | usermod -a -G watchman heinz | |
100 | ---- | |
101 | ||
102 | Proxmox VE authentication server:: | |
d6614202 WB |
103 | This is a unix like password store (`/etc/pve/priv/shadow.cfg`). |
104 | Password are encrypted using the SHA-256 hash method. | |
105 | This is the most convenient method for for small (or even medium) | |
106 | installations where users do not need access to anything outside of | |
107 | {pve}. In this case users are fully managed by {pve} and are able to | |
108 | change their own passwords via the GUI. | |
109 | ||
110 | LDAP:: | |
111 | It is possible to authenticate users via an LDAP server (eq. | |
112 | openldap). The server and an optional fallback server can be | |
113 | configured and the connection can be encrypted via SSL. | |
114 | + | |
115 | Users are searched under a 'Base Domain Name' (`base_dn`), with the | |
116 | user name found in the attribute specified in the 'User Attribute Name' | |
117 | (`user_attr`) field. | |
118 | + | |
119 | For instance, if a user is represented via the | |
120 | following ldif dataset: | |
121 | + | |
122 | ---- | |
123 | # user1 of People at ldap-test.com | |
124 | dn: uid=user1,ou=People,dc=ldap-test,dc=com | |
125 | objectClass: top | |
126 | objectClass: person | |
127 | objectClass: organizationalPerson | |
128 | objectClass: inetOrgPerson | |
129 | uid: user1 | |
130 | cn: Test User 1 | |
131 | sn: Testers | |
132 | description: This is the first test user. | |
133 | ---- | |
134 | + | |
135 | The 'Base Domain Name' would be `ou=People,dc=ldap-test,dc=com` and the user | |
136 | attribute would be `uid`. | |
137 | + | |
138 | If {pve} needs to authenticate (bind) to the ldap server before being | |
139 | able to query and authenticate users, a bind domain name can be | |
140 | configured via the `bind_dn` property in `/etc/pve/domains.cfg`. Its | |
141 | password then has to be stored in `/etc/pve/priv/ldap/<realmname>.pw` | |
142 | (eg. `/etc/pve/priv/ldap/my-ldap.pw`). This file should contain a | |
143 | single line containing the raw password. | |
144 | ||
145 | Microsoft Active Directory:: | |
3c8533f2 | 146 | |
d6614202 WB |
147 | A server and authentication domain need to be specified. Like with |
148 | ldap an optional fallback server, optional port, and SSL | |
149 | encryption can be configured. | |
3c8533f2 | 150 | |
5eba0743 | 151 | |
9e8f2770 WB |
152 | Two factor authentication |
153 | ------------------------- | |
154 | ||
155 | Each realm can optionally be secured additionally by two factor | |
156 | authentication. This can be done by selecting one of the available methods | |
157 | via the 'TFA' dropdown box when adding or editing an Authentication Realm. | |
158 | When a realm has TFA enabled it becomes a requirement and only users with | |
159 | configured TFA will be able to login. | |
160 | ||
161 | Currently there are two methods available: | |
162 | ||
163 | Time based OATH (TOTP):: | |
164 | This uses the standard HMAC-SHA1 algorithm where the current time is hashed | |
165 | with the user's configured key. The time step and password length | |
166 | parameters are configured. | |
167 | + | |
168 | A user can have multiple keys configured (separated by spaces), and the | |
169 | keys can be specified in Base32 (RFC3548) or hexadecimal notation. | |
170 | + | |
171 | {pve} provides a key generation tool (`oathkeygen`) which prints out a | |
172 | random key in Base32 notation which can be used directly with various OTP | |
173 | tools, such as the `oathtool` command line tool, the Google authenticator | |
174 | or FreeOTP Android apps. | |
175 | ||
176 | YubiKey OTP:: | |
177 | For authenticating via a YubiKey a Yubico API ID, API KEY and validation | |
178 | server URL must be configured, and users must have a YubiKey available. In | |
179 | order to get the key ID from a YubiKey, you can trigger the YubiKey once | |
180 | after connecting it to USB and copy the first 12 characters of the typed | |
181 | password into the user's 'Key IDs' field. | |
182 | + | |
183 | Please refer to the | |
184 | https://developers.yubico.com/OTP/[YubiKey OTP] documentation for how to use the | |
185 | https://www.yubico.com/products/services-software/yubicloud/[YubiCloud] or | |
186 | https://developers.yubico.com/Software_Projects/YubiKey_OTP/YubiCloud_Validation_Servers/[ | |
187 | host your own verification server]. | |
188 | ||
189 | ||
04f44730 | 190 | Permission Management |
3c8533f2 DM |
191 | --------------------- |
192 | ||
04f44730 WB |
193 | In order for a user to perform an action (such as listing, modifying or |
194 | deleting a parts of a VM configuration), the user needs to have the | |
195 | appropriate permissions. | |
196 | ||
197 | {pve} uses a role and path based permission management system. An entry in | |
198 | the permissions table allows a user or group to take on a specific role | |
199 | when accessing an 'object' or 'path'. This means an such an access rule can | |
200 | be represented as a triple of '(path, user, role)' or '(path, group, | |
201 | role)', with the role containing a set of allowed actions, and the path | |
202 | representing the target of these actions. | |
203 | ||
5eba0743 | 204 | |
853d288b WB |
205 | Roles |
206 | ~~~~~ | |
207 | ||
208 | A role is simply a list of privileges. Proxmox VE comes with a number | |
209 | of predefined roles which satisfies most needs. | |
210 | ||
211 | * `Administrator`: has all privileges | |
212 | * `NoAccess`: has no privileges (used to forbid access) | |
213 | * `PVEAdmin`: can do most things, but miss rights to modify system settings (`Sys.PowerMgmt`, `Sys.Modify`, `Realm.Allocate`). | |
214 | * `PVEAuditor`: read only access | |
215 | * `PVEDatastoreAdmin`: create and allocate backup space and templates | |
216 | * `PVEDatastoreUser`: allocate backup space and view storage | |
217 | * `PVEPoolAdmin`: allocate pools | |
218 | * `PVESysAdmin`: User ACLs, audit, system console and system logs | |
219 | * `PVETemplateUser`: view and clone templates | |
220 | * `PVEUserAdmin`: user administration | |
221 | * `PVEVMAdmin`: fully administer VMs | |
222 | * `PVEVMUser`: view, backup, config CDROM, VM console, VM power management | |
223 | ||
224 | You can see the whole set of predefined roles on the GUI. | |
225 | ||
226 | Adding new roles can currently only be done from the command line, like | |
227 | this: | |
228 | ||
229 | [source,bash] | |
230 | ---- | |
231 | pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console" | |
232 | pveum roleadd Sys_Power-only -privs "Sys.PowerMgmt Sys.Console" | |
233 | ---- | |
234 | ||
235 | ||
3c8533f2 DM |
236 | Privileges |
237 | ~~~~~~~~~~ | |
238 | ||
239 | A privilege is the right to perform a specific action. To simplify | |
240 | management, lists of privileges are grouped into roles, which can then | |
0e1fda70 WB |
241 | be used in the permission table. Note that privileges cannot directly be |
242 | assigned to users and paths without being part of a role. | |
3c8533f2 DM |
243 | |
244 | We currently use the following privileges: | |
245 | ||
246 | Node / System related privileges:: | |
247 | ||
248 | * `Permissions.Modify`: modify access permissions | |
249 | * `Sys.PowerMgmt`: Node power management (start, stop, reset, shutdown, ...) | |
250 | * `Sys.Console`: console access to Node | |
251 | * `Sys.Syslog`: view Syslog | |
252 | * `Sys.Audit`: view node status/config | |
253 | * `Sys.Modify`: create/remove/modify node network parameters | |
254 | * `Group.Allocate`: create/remove/modify groups | |
255 | * `Pool.Allocate`: create/remove/modify a pool | |
256 | * `Realm.Allocate`: create/remove/modify authentication realms | |
257 | * `Realm.AllocateUser`: assign user to a realm | |
258 | * `User.Modify`: create/remove/modify user access and details. | |
259 | ||
260 | Virtual machine related privileges:: | |
261 | ||
262 | * `VM.Allocate`: create/remove new VM to server inventory | |
263 | * `VM.Migrate`: migrate VM to alternate server on cluster | |
264 | * `VM.PowerMgmt`: power management (start, stop, reset, shutdown, ...) | |
265 | * `VM.Console`: console access to VM | |
266 | * `VM.Monitor`: access to VM monitor (kvm) | |
267 | * `VM.Backup`: backup/restore VMs | |
268 | * `VM.Audit`: view VM config | |
269 | * `VM.Clone`: clone/copy a VM | |
270 | * `VM.Config.Disk`: add/modify/delete Disks | |
271 | * `VM.Config.CDROM`: eject/change CDROM | |
272 | * `VM.Config.CPU`: modify CPU settings | |
273 | * `VM.Config.Memory`: modify Memory settings | |
274 | * `VM.Config.Network`: add/modify/delete Network devices | |
275 | * `VM.Config.HWType`: modify emulated HW type | |
276 | * `VM.Config.Options`: modify any other VM configuration | |
277 | * `VM.Snapshot`: create/remove VM snapshots | |
278 | ||
279 | Storage related privileges:: | |
280 | ||
281 | * `Datastore.Allocate`: create/remove/modify a data store, delete volumes | |
282 | * `Datastore.AllocateSpace`: allocate space on a datastore | |
283 | * `Datastore.AllocateTemplate`: allocate/upload templates and iso images | |
284 | * `Datastore.Audit`: view/browse a datastore | |
285 | ||
5eba0743 | 286 | |
b8eeec52 WB |
287 | Objects and Paths |
288 | ~~~~~~~~~~~~~~~~~ | |
289 | ||
290 | Access permissions are assigned to objects, such as a virtual machines, | |
291 | storages or pools of resources. | |
292 | We use file system like paths to address these objects. These paths form a | |
293 | natural tree, and permissions of higher levels (shorter path) can | |
294 | optionally be propagated down within this hierarchy. | |
295 | ||
296 | [[templated-paths]] | |
297 | Paths can be templated. When an API call requires permissions on a | |
298 | templated path, the path may contain references to parameters of the API | |
299 | call. These references are specified in curly braces. Some parameters are | |
300 | implicitly taken from the API call's URI. For instance the permission path | |
301 | `/nodes/{node}` when calling '/nodes/mynode/status' requires permissions on | |
302 | `/nodes/mynode`, while the path `{path}` in a PUT request to `/access/acl` | |
303 | refers to the method's `path` parameter. | |
304 | ||
305 | Some examples are: | |
306 | ||
307 | * `/nodes/{node}`: Access to {pve} server machines | |
308 | * `/vms`: Covers all VMs | |
309 | * `/vms/{vmid}`: Access to specific VMs | |
310 | * `/storage/{storeid}`: Access to a storages | |
311 | * `/pool/{poolname}`: Access to VMs part of a <<resource-pools,pool> | |
312 | * `/access/groups`: Group administration | |
313 | * `/access/realms/{realmid}`: Administrative access to realms | |
314 | ||
315 | ||
3c8533f2 DM |
316 | Inheritance |
317 | ^^^^^^^^^^^ | |
318 | ||
5eba0743 | 319 | As mentioned earlier, object paths form a file system like tree, and |
3c8533f2 DM |
320 | permissions can be inherited down that tree (the propagate flag is set |
321 | by default). We use the following inheritance rules: | |
322 | ||
74936daf WB |
323 | * Permissions for individual users always replace group permissions. |
324 | * Permissions for groups apply when the user is member of that group. | |
325 | * Permissions replace the ones inherited from an upper level. | |
3c8533f2 | 326 | |
5eba0743 | 327 | |
3c8533f2 DM |
328 | Pools |
329 | ~~~~~ | |
330 | ||
331 | Pools can be used to group a set of virtual machines and data | |
8c1189b6 | 332 | stores. You can then simply set permissions on pools (`/pool/{poolid}`), |
3c8533f2 DM |
333 | which are inherited to all pool members. This is a great way simplify |
334 | access control. | |
335 | ||
74936daf WB |
336 | |
337 | What permission do I need? | |
338 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
339 | ||
340 | The required API permissions are documented for each individual | |
341 | method, and can be found at http://pve.proxmox.com/pve-docs/api-viewer/ | |
342 | ||
343 | The permissions are specified as a list which can be interpreted as a | |
344 | tree of logic and access-check functions: | |
345 | ||
346 | `["and", <subtests>...]` and `["or", <subtests>...]`:: | |
347 | Each(`and`) or any(`or`) further element in the current list has to be true. | |
348 | ||
349 | `["perm", <path>, [ <privileges>... ], <options>...]`:: | |
350 | The `path` is a templated parameter (see <<templated-paths,Objects and | |
351 | Paths>>). All (or , if the `any` option is used, any) of the listed | |
352 | privileges must be allowed on the specified path. If a `require-param` | |
353 | option is specified, then its specified parameter is required even if the | |
354 | API call's schema otherwise lists it as being optional. | |
355 | ||
356 | `["userid-group", [ <privileges>... ], <options>...]`:: | |
357 | The callermust have any of the listed privileges on `/access/groups`. In | |
358 | addition there are two possible checks depending on whether the | |
359 | `groups_param` option is set: | |
360 | + | |
361 | * `groups_param` is set: The API call has a non-optional `groups` parameter | |
362 | and the caller must have any of the listed privileges on all of the listed | |
363 | groups. | |
364 | * `groups_param` is not set: The user passed via the `userid` parameter | |
365 | must exist and be part of a group on which the caller has any of the listed | |
366 | privileges (via the `/access/groups/<group>` path). | |
367 | ||
368 | `["userid-param", "self"]`:: | |
369 | The value provided for the API call's `userid` parameter must refer to the | |
370 | user performing the action. (Usually in conjunction with `or`, to allow | |
371 | users to perform an action on themselves even if they don't have elevated | |
372 | privileges.) | |
373 | ||
374 | `["userid-param", "Realm.AllocateUser"]`:: | |
375 | The user needs `Realm.AllocateUser` access to `/access/realm/<realm>`, with | |
376 | `<realm>` refering to the realm of the user passed via the `userid` | |
377 | parameter. Note that the user does not need to exist in order to be | |
378 | associated with a realm, since user IDs are passed in the form of | |
379 | `<username>@<realm>`. | |
380 | ||
381 | `["perm-modify", <path>]`:: | |
382 | The `path` is a templated parameter (see <<templated-paths,Objects and | |
383 | Paths>>). The user needs either the `Permissions.Modify` privilege, or, | |
384 | depending on the path, the following privileges as a possible substitute: | |
385 | + | |
386 | * `/storage/...`: additionally requires 'Datastore.Allocate` | |
387 | * `/vms/...`: additionally requires 'VM.Allocate` | |
388 | * `/pool/...`: additionally requires 'Pool.Allocate` | |
389 | + | |
390 | If the path is empty, `Permission.Modify` on `/access` is required. | |
391 | ||
3c8533f2 DM |
392 | Command Line Tool |
393 | ----------------- | |
394 | ||
395 | Most users will simply use the GUI to manage users. But there is also | |
8c1189b6 | 396 | a full featured command line tool called `pveum` (short for ``**P**roxmox |
4f6e7e05 WB |
397 | **VE** **U**ser **M**anager''). Please note that all Proxmox VE command |
398 | line tools are wrappers around the API, so you can also access those | |
399 | function through the REST API. | |
3c8533f2 DM |
400 | |
401 | Here are some simple usage examples. To show help type: | |
402 | ||
403 | [source,bash] | |
404 | pveum | |
405 | ||
406 | or (to show detailed help about a specific command) | |
407 | ||
408 | [source,bash] | |
409 | pveum help useradd | |
410 | ||
411 | Create a new user: | |
412 | ||
413 | [source,bash] | |
414 | pveum useradd testuser@pve -comment "Just a test" | |
415 | ||
416 | Set or Change the password (not all realms support that): | |
417 | ||
418 | [source,bash] | |
419 | pveum passwd testuser@pve | |
420 | ||
421 | Disable a user: | |
422 | ||
423 | [source,bash] | |
424 | pveum usermod testuser@pve -enable 0 | |
425 | ||
426 | Create a new group: | |
427 | ||
428 | [source,bash] | |
429 | pveum groupadd testgroup | |
430 | ||
431 | Create a new role: | |
432 | ||
433 | [source,bash] | |
434 | pveum roleadd PVE_Power-only -privs "VM.PowerMgmt VM.Console" | |
435 | ||
436 | ||
437 | Real World Examples | |
438 | ------------------- | |
439 | ||
5eba0743 | 440 | |
3c8533f2 DM |
441 | Administrator Group |
442 | ~~~~~~~~~~~~~~~~~~~ | |
443 | ||
444 | One of the most wanted features was the ability to define a group of | |
5eba0743 | 445 | users with full administrator rights (without using the root account). |
3c8533f2 DM |
446 | |
447 | Define the group: | |
448 | ||
449 | [source,bash] | |
450 | pveum groupadd admin -comment "System Administrators" | |
451 | ||
452 | Then add the permission: | |
453 | ||
454 | [source,bash] | |
455 | pveum aclmod / -group admin -role Administrator | |
456 | ||
457 | You can finally add users to the new 'admin' group: | |
458 | ||
459 | [source,bash] | |
460 | pveum usermod testuser@pve -group admin | |
461 | ||
462 | ||
463 | Auditors | |
464 | ~~~~~~~~ | |
465 | ||
466 | You can give read only access to users by assigning the `PVEAuditor` | |
467 | role to users or groups. | |
468 | ||
8c1189b6 | 469 | Example1: Allow user `joe@pve` to see everything |
3c8533f2 DM |
470 | |
471 | [source,bash] | |
472 | pveum aclmod / -user joe@pve -role PVEAuditor | |
473 | ||
8c1189b6 | 474 | Example1: Allow user `joe@pve` to see all virtual machines |
3c8533f2 DM |
475 | |
476 | [source,bash] | |
477 | pveum aclmod /vms -user joe@pve -role PVEAuditor | |
478 | ||
5eba0743 | 479 | |
3c8533f2 DM |
480 | Delegate User Management |
481 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
482 | ||
8c1189b6 | 483 | If you want to delegate user managenent to user `joe@pve` you can do |
3c8533f2 DM |
484 | that with: |
485 | ||
486 | [source,bash] | |
487 | pveum aclmod /access -user joe@pve -role PVEUserAdmin | |
488 | ||
8c1189b6 | 489 | User `joe@pve` can now add and remove users, change passwords and |
3c8533f2 DM |
490 | other user attributes. This is a very powerful role, and you most |
491 | likely want to limit that to selected realms and groups. The following | |
8c1189b6 FG |
492 | example allows `joe@pve` to modify users within realm `pve` if they |
493 | are members of group `customers`: | |
3c8533f2 DM |
494 | |
495 | [source,bash] | |
496 | pveum aclmod /access/realm/pve -user joe@pve -role PVEUserAdmin | |
497 | pveum aclmod /access/groups/customers -user joe@pve -role PVEUserAdmin | |
498 | ||
0abc65b0 | 499 | NOTE: The user is able to add other users, but only if they are |
8c1189b6 FG |
500 | members of group `customers` and within realm `pve`. |
501 | ||
3c8533f2 DM |
502 | |
503 | Pools | |
504 | ~~~~~ | |
505 | ||
506 | An enterprise is usually structured into several smaller departments, | |
507 | and it is common that you want to assign resources to them and | |
508 | delegate management tasks. A pool is simply a set of virtual machines | |
509 | and data stores. You can create pools on the GUI. After that you can | |
510 | add resources to the pool (VMs, Storage). | |
511 | ||
512 | You can also assign permissions to the pool. Those permissions are | |
513 | inherited to all pool members. | |
514 | ||
515 | Lets assume you have a software development department, so we first | |
516 | create a group | |
517 | ||
518 | [source,bash] | |
519 | pveum groupadd developers -comment "Our software developers" | |
520 | ||
521 | Now we create a new user which is a member of that group | |
522 | ||
523 | [source,bash] | |
524 | pveum useradd developer1@pve -group developers -password | |
525 | ||
0abc65b0 | 526 | NOTE: The -password parameter will prompt you for a password |
3c8533f2 | 527 | |
8c1189b6 | 528 | I assume we already created a pool called ``dev-pool'' on the GUI. So we can now assign permission to that pool: |
3c8533f2 DM |
529 | |
530 | [source,bash] | |
531 | pveum aclmod /pool/dev-pool/ -group developers -role PVEAdmin | |
532 | ||
533 | Our software developers can now administrate the resources assigned to | |
534 | that pool. | |
535 | ||
536 | ||
537 | ifdef::manvolnum[] | |
538 | include::pve-copyright.adoc[] | |
539 | endif::manvolnum[] | |
540 |