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