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