Users and Identity Management Guide

Red Hat OpenStack Platform 10

Managing users and authentication mechanisms

OpenStack Documentation Team

rhos-docs@redhat.com

Abstract

The Users and Identity Management Guide provides the procedures to manage user roles, quotas, projects and project security, and the Identity service of a Red Hat OpenStack Platform environment.

Preface

As a cloud administrator, you can manage projects, users, and roles. Projects are organizational units in the cloud to which you can assign users. Projects are also known as tenants or accounts. Users can be members of one or more projects. Roles define the actions that users can perform.

Each OpenStack deployment must include at least one project, one user, and one role, linked together. As a cloud administrator, you can add, update, and delete projects and users, assign users to one or more projects, and change or remove these assignments. You can manage projects and users independently from each other.

You can also configure user authentication with the Keystone identity service to control access to services and endpoints. Keystone provides token-based authentication and can integrate with LDAP and Active Directory, so you can manage users and identities externally and synchronize the user data with Keystone.

Chapter 1. User Management

1.1. User Management

As a cloud administrator, you can add, modify, and delete users in the dashboard. Users can be members of one or more projects. You can manage projects and users independently from each other.

1.1.1. Create a User

Use this procedure to create users in the dashboard. You can assign a primary project and role to the user. Note that users created in the dashboard are Keystone users by default. To integrate Active Directory users, you can configure the LDAP provider included in the Red Hat OpenStack Platform Identity service.

As an admin user in the dashboard, select Identity > Users.
Click Create User.
Enter a user name, email, and preliminary password for the user.
Select a project from the Primary Project list.
Select a role for the user from the Role list (the default role is _member_).
Click Create User.

1.1.2. Edit a User

Use this procedure to update the user’s details, including the primary project.

As an admin user in the dashboard, select Identity > Users.
In the User’s Actions column, click Edit.
In the Update User window, you can update the User Name, Email, and Primary Project.
Click Update User.

1.1.3. Enable or Disable a User

Use this procedure to enable or disable a user. You can disable or enable only one user at a time. A disabled user cannot log in to the dashboard, and does not have access to any OpenStack services. Also, a disabled user’s primary project cannot be set as active. A disabled user can be enabled again, unlike deleting a user where the action cannot be reversed. A disabled user must be re-enabled for any user-project action in the dashboard.

As an admin user in the dashboard, select Identity > Users.
In the Actions column, click the arrow, and select Enable User or Disable User. In the Enabled column, the value then updates to either True or False.

1.1.4. Delete a User

As an admin user, use this procedure to delete a user using the dashboard. This action cannot be reversed, unlike disabling a user. Deleted users get delisted from a project’s members' list for projects it belongs to. All roles associated with the user-project pair are also lost.

As an admin user in the dashboard, select Identity > Users.
Select the users you want to delete.
Click Delete Users. The Confirm Delete Users window is displayed.
Click Delete Users to confirm the action.

Chapter 2. Role Management

2.1. Role Management

OpenStack uses a role-based access control (RBAC) mechanism to manage access to its resources. Roles define which actions users can perform. By default, there are two predefined roles: a member role that gets attached to a tenant, and an administrative role to enable non-admin users to administer the environment. Note that there are abstract levels of permission, and it is possible to create the roles the administrator needs, and configure services adequately.

2.1.1. View Roles

Use the following command to list the available predefined roles.

$ openstack role list
+----------------------------------+---------------+
| ID                               | Name          |
+----------------------------------+---------------+
| 4fd37c2c993a4acab8e1b5896afb8687 | SwiftOperator |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_      |
| a0f19c1381c54770ae068456c4411d82 | ResellerAdmin |
| ae49e2b796ea4820ac51637be27650d8 | admin         |
+----------------------------------+---------------+

To get details for a specified role, run:

$ openstack role show admin

Example

$ openstack role show admin
+-----------+----------------------------------+
| Field     | Value                            |
+-----------+----------------------------------+
| domain_id | None                             |
| id        | ae49e2b796ea4820ac51637be27650d8 |
| name      | admin                            |
+-----------+----------------------------------+

2.1.2. Create and Assign a Role

As a cloud administrator, you can create and manage roles on the Keystone client using the following set of commands. Each OpenStack deployment must include at least one project, one user, and one role, linked together. However, users can be members of multiple projects. To assign users to multiple projects, create a role and assign that role to a user-project pair. Note that you can create a user and assign a primary project and default role in the dashboard.

Note

Either the name or ID can be used to specify users, roles, or projects.

Create the new-role role:

$ openstack role create [ROLE_NAME]

Example

$ openstack role create new-role
+-----------+----------------------------------+
| Field     | Value                            |
+-----------+----------------------------------+
| domain_id | None                             |
| id        | 880c116b6a55464b99ca8d8d8fe26743 |
| name      | new-role                         |
+-----------+----------------------------------+

To assign a user to a project, you must assign the role to a user-project pair. To do this, obtain the user, role, and project names or IDs:
1. List users:
```
$ openstack user list
```
2. List roles:
```
$ openstack role list
```
3. List projects:
```
$ openstack project list
```

Assign a role to a user-project pair.

openstack role add --project [PROJECT_NAME] --user [USER_ID]  [ROLE_ID]

Example

In this example, you assign the admin role to the admin user in the demo project:

$ openstack role add --project demo --user 895e43465b9643b9aa29df0073572bb2  ae49e2b796ea4820ac51637be27650d8

Verify the role assignment for the user admin:

$ openstack role assignment list --user [USER_ID]  --project [PROJECT_ID]

Example

$ openstack role assignment list --user 895e43465b9643b9aa29df0073572bb2 --project demo
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| Role                             | User                             | Group | Project                          | Domain | Inherited |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| ae49e2b796ea4820ac51637be27650d8 | 895e43465b9643b9aa29df0073572bb2 |       | 7efbdc8b4ab448b8b5aeb9fa5898ce23 |        | False     |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+

Chapter 3. Group Management

3.1. Manage Keystone Groups

3.1.1. Using the Command-line

You can use Identity Service (keystone) groups to assign consistent permissions to multiple user accounts. This example creates a group and then assigns permissions to the group. As a result, members of the group will inherit the same permissions that were assigned to the group:

Note

The openstack group subcommands require keystone v3.

Create the group grp-Auditors:

$ openstack group create grp-Auditors
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| domain_id   | default                          |
| id          | 2a4856fc242142a4aa7c02d28edfdfff |
| name        | grp-Auditors                     |
+-------------+----------------------------------+

View a list of keystone groups:

$ openstack group list --long
+----------------------------------+--------------+-----------+-------------+
| ID                               | Name         | Domain ID | Description |
+----------------------------------+--------------+-----------+-------------+
| 2a4856fc242142a4aa7c02d28edfdfff | grp-Auditors | default   |             |
+----------------------------------+--------------+-----------+-------------+

Grant the grp-Auditors group permission to access the demo project, while using the _member_ role:
```
$ openstack role add _member_ --group grp-Auditors --project demo
```

Add the existing user user1 to the grp-Auditors group:

$ openstack group add user grp-Auditors user1
user1 added to group grp-Auditors

Confirm that user1 is a member of grp-Auditors:

$ openstack group contains user grp-Auditors user1
user1 in group grp-Auditors

Review the effective permissions that have been assigned to user1:

$ openstack role assignment list --effective --user user1
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| Role                             | User                             | Group | Project                          | Domain | Inherited |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| 9fe2ff9ee4384b1894a90878d3e92bab | 3fefe5b4f6c948e6959d1feaef4822f2 |       | 0ce36252e2fb4ea8983bed2a568fa832 |        | False     |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+

3.1.2. Using Dashboard

You can use the dashboard to manage the membership of keystone groups. You will need to use the command-line to assign role permissions to a group, as covered in the previous example.

3.1.2.1. Create a Group

As an admin user in the dashboard, select Identity > Groups.
Click +Create Group.
Enter a name and description for the group.
Click Create Group.

3.1.2.2. Manage Group Membership

You can use the dashboard to manage the membership of keystone groups.

As an admin user in the dashboard, select Identity > Groups.
Click Manage Members for the group you need to edit.
Use Add users to add a user to the group. If you need to remove a user, mark its checkbox and click or Remove users.

Chapter 4. Quota Management

4.1. Quota Management

As a cloud administrator, you can set and manage quotas for a project. Each project is allocated resources, and project users are granted access to consume these resources. This enables multiple projects to use a single cloud without interfering with each other’s permissions and resources. A set of resource quotas are preconfigured when a new tenant is created. The quotas include the amount of VCPUs, instances, RAM, floating IPs, that can be assigned to tenants. Quotas can be enforced at both the tenant (or project) and the tenant-user level. Note that you can set or modify Compute and Block Storage quotas for new and existing tenants using the dashboard. See Chapter 6, Project Management for the procedure on how to set and update project quotas within the dashboard.

4.1.1. View Compute Quotas for a User

Run the following command to list the currently set quota values for a user:

$ nova quota-show --user [USER] --tenant [TENANT]

Example

$ nova quota-show --user demoUser --tenant demo
+-----------------------------+-------+
| Quota                       | Limit |
+-----------------------------+-------+
| instances                   | 10    |
| cores                       | 20    |
| ram                         | 51200 |
| floating_ips                | 5     |
| fixed_ips                   | -1    |
| metadata_items              | 128   |
| injected_files              | 5     |
| injected_file_content_bytes | 10240 |
| injected_file_path_bytes    | 255   |
| key_pairs                   | 100   |
| security_groups             | 10    |
| security_group_rules        | 20    |
| server_groups               | 10    |
| server_group_members        | 10    |
+-----------------------------+-------+

4.1.2. Update Compute Quotas for a User

Run the following commands to update a particular quota value:

$ nova quota-update --user [USER] --[QUOTA_NAME] [QUOTA_VALUE] [TENANT]
$ nova quota-show --user [USER] --tenant [TENANT]

Example

$ nova quota-update --user demoUser --floating-ips 10 demo
$ nova quota-show --user demoUser --tenant demo
+-----------------------------+-------+
| Quota                       | Limit |
+-----------------------------+-------+
| instances                   | 10    |
| cores                       | 20    |
| ram                         | 51200 |
| floating_ips                | 10    |
| ...                         |       |
+-----------------------------+-------+

Note

To view a list of options for the quota-update command, run:

$ nova help quota-update

4.1.3. Set Object Storage Quotas for a User

Object Storage quotas can be classified under the following categories:

Container quotas - Limits the total size (in bytes) or number of objects that can be stored in a single container.
Account quotas - Limits the total size (in bytes) that a user has available in the Object Storage service.

To set either container quotas or the account quotas, the Object Storage proxy server must have the parameters container_quotas or account_quotas (or both) added to the [pipeline:main] section of the proxy-server.conf file:

[pipeline:main]
pipeline = catch_errors [...] tempauth container-quotas \
account-quotas slo dlo proxy-logging proxy-server

[filter:account_quotas]
use = egg:swift#account_quotas

[filter:container_quotas]
use = egg:swift#container_quotas

Use the following command to view and update the Object Storage quotas. All users included in a project can view the quotas placed on the project. To update the Object Storage quotas on a project, you must have the role of a ResellerAdmin in the project.

To view account quotas:

# swift stat

Account: AUTH_b36ed2d326034beba0a9dd1fb19b70f9
Containers: 0
Objects: 0
Bytes: 0
Meta Quota-Bytes: 214748364800
X-Timestamp: 1351050521.29419
Content-Type: text/plain; charset=utf-8
Accept-Ranges: bytes

To update quotas:

# swift post -m quota-bytes:<BYTES>

For example, to place a 5 GB quota on an account:

# swift post -m quota-bytes:5368709120

To verify the quota, run the swift stat command again:

# swift stat

Account: AUTH_b36ed2d326034beba0a9dd1fb19b70f9
Containers: 0
Objects: 0
Bytes: 0
Meta Quota-Bytes: 5368709120
X-Timestamp: 1351541410.38328
Content-Type: text/plain; charset=utf-8
Accept-Ranges: bytes

Chapter 5. Policy Management

5.1. Using policy files for access control

Each OpenStack service contains resources that are managed by access policies. A resource could include functions such as:

Permission to create and start instances.
The ability to attach a volume to an instance.

The default policies can be viewed by generating a report for each service:

$ oslopolicy-policy-generator --namespace nova

You can override the default rules by editing the policy.json file allocated to each OpenStack service. For example, the Compute service will have a policy.json in the nova directory (note that the exact file path might vary for containerized services). By modifying the service’s policy.json file, you are overriding the default policy in its entirety. This means that any required admin permissions must also be redefined.

Note

You will need to check that any changes to the access control policies do not unintentionally weaken the security of any resource. In addition, any changes to a policy.json file become effective immediately and do not require the service to be restarted.

5.1.1. Example: Create a Power User role

You can customize the permissions assigned to a keystone role by updating a service’s policy.json file. This allows them to more granularly define the permissions assigned to a class of users. This example creates a power user role for your deployment with the following privileges:

Start an instance.
Stop an instance.
Manage the volumes that are attached to instances.

The intention behind this role is to grant additional permissions to certain users, without needing to grant then admin access. To use these privileges, you will need to grant the following to a custom role:

Start an instance: "os_compute_api:servers:start": "role:PowerUsers"
Stop an instance: "os_compute_api:servers:stop": "role:PowerUsers"
Configure an instance to use a particular volume: "os_compute_api:servers:create:attach_volume": "role:PowerUsers"
List the volumes attached to an instance: "os_compute_api:os-volumes-attachments:index": "role:PowerUsers"
Attach a volume: "os_compute_api:os-volumes-attachments:create": "role:PowerUsers"
View the details of an attached volume: "os_compute_api:os-volumes-attachments:show": "role:PowerUsers"
Change the volume attached to an instance: "os_compute_api:os-volumes-attachments:update": "role:PowerUsers"
Delete a volume attached to an instance: "os_compute_api:os-volumes-attachments:delete": "role:PowerUsers"

Note

By modifying the policy.json file, you are overriding the default policy. As a result, members of PowerUsers will be the only users able to perform these actions. You can allow admin users to retain these permissions by creating a rules for admin_or_power_user. You can also use some basic conditional logic here to say role:PowerUsers or role:Admin.

Be sure that your command line session is using the keystone v3 API. This means sourcing a rc file with the v3 endpoint and settings defined. For example:

OS_AUTH_URL=http://controller-hostname.lab.local:5000/v3
OS_USERNAME=username
OS_PASSWORD=password
OS_USER_DOMAIN_NAME=Default
OS_PROJECT_DOMAIN_NAME=Default
OS_PROJECT_NAME=project-name
OS_IDENTITY_API_VERSION=3

Create the custom keystone role:

$ openstack role create PowerUsers
+-----------+----------------------------------+
| Field     | Value                            |
+-----------+----------------------------------+
| domain_id | None                             |
| id        | 7061a395af43455e9057ab631ad49449 |
| name      | PowerUsers                      |
+-----------+----------------------------------+

Add an existing user to the role, and assign the role to a project:
```
$ openstack role add --project [PROJECT_NAME] --user [USER_ID] [PowerUsers-ROLE_ID]
```
Note
A role assignment is paired exclusively with one project. This means that when you assign a role to a user, you will also define the target project at the same time. If you want the user to receive the same role but for a different project, you will need to assign the role to them again separately but targeting the different project.

View the default nova policy settings:

$ oslopolicy-policy-generator --namespace nova

Create custom permissions for the new PowerUsers role by adding these entries to /etc/nova/policy.json:

Note

You should test your policy changes before deployment. This will help you determine if they are working as expected.

{
"os_compute_api:servers:start": "role:PowerUsers",
"os_compute_api:servers:stop": "role:PowerUsers",
"os_compute_api:servers:create:attach_volume": "role:PowerUsers",
"os_compute_api:os-volumes-attachments:index": "role:PowerUsers",
"os_compute_api:os-volumes-attachments:create": "role:PowerUsers",
"os_compute_api:os-volumes-attachments:show": "role:PowerUsers",
"os_compute_api:os-volumes-attachments:update": "role:PowerUsers",
"os_compute_api:os-volumes-attachments:delete": "role:PowerUsers"
}

Once you save this file, the changes will take effect immediately. Any users added to the PowerUsers keystone role will receive these privileges.

For more information on the policy.json syntax options available, see the Policy syntax section below.

5.1.2. Review role assignment

You can generate a report of the role assignments:

$ openstack role assignment list --names
+---------------+--------------------+-------+----------------------+--------+-----------+
| Role          | User               | Group | Project              | Domain | Inherited |
+---------------+--------------------+-------+----------------------+--------+-----------+
| admin         | glance@Default     |       | services@Default     |        | False     |
| admin         | ceilometer@Default |       | services@Default     |        | False     |
| ResellerAdmin | ceilometer@Default |       | services@Default     |        | False     |
| PowerUsers    | demo-user@Default  |       | demo-project@Default |        | False     |
| admin         | swift@Default      |       | services@Default     |        | False     |
| admin         | aodh@Default       |       | services@Default     |        | False     |
| admin         | neutron@Default    |       | services@Default     |        | False     |
| admin         | nova@Default       |       | services@Default     |        | False     |
| _member_      | demo@Default       |       | demo@Default         |        | False     |
| admin         | cinder@Default     |       | services@Default     |        | False     |
| admin         | admin@Default      |       | admin@Default        |        | False     |
| admin         | gnocchi@Default    |       | services@Default     |        | False     |
+---------------+--------------------+-------+----------------------+--------+-----------+

You can also view the role assignment for a specific user:

$ openstack role assignment list --user demo-user --project demo-project --names
+-------------+----------------+-------+----------------------+--------+-----------+
| Role        | User           | Group | Project              | Domain | Inherited |
+-------------+----------------+-------+----------------------+--------+-----------+
| PowerUsers  | demo-user@Default |       | demo-project@Default |        | False  |
+-------------+----------------+-------+----------------------+--------+-----------+

5.1.3. Policy syntax

Policy.json files support certain operators that allow you to control the target scope of these settings. For example, this keystone setting holds that only admin users are allowed to create users:

"identity:create_user": "rule:admin_required"

The section to the left of the : character describes the privilege, and the section on the right governs who is allowed to use the privilege. You can also use operators on the right side to further control the scope:

! - No user (including admin) may perform this action.
@ and "" - Any user may perform this action.
not, and, or - Standard operator functions are available.
rule:admin_required or role:admin or rule:owner - Certain predefined rules are available that allow you to match a privilege to type of user.

For example, this setting would mean that no users are allowed to create new users:

"identity:create_user": "!"

Note

You should test your policy changes before deployment. This will help you determine if they are working as expected.

Chapter 6. Project Management

6.1. Project Management

As a cloud administrator, you can create and manage projects (tenants). A tenant describes a project with an assigned number of OpenStack users and resources. It is possible to set up quotas for each tenant. This enables multiple projects to use a single cloud without interfering with each other’s permissions and resources. The words project and tenant are used interchangeably. Users can be associated with more than one project. Each user-project pairing must have a role associated with it.

6.1.1. Create a Project

Use this procedure to create projects, add members to the project, and set resource limits for the project.

As an admin user in the dashboard, select Identity > Projects.
Click Create Project.
On the Project Information tab, enter a name and description for the project (the Enabled check box is selected by default).
On the Project Members tab, add members to the project from the All Users list.
On the Quotas tab, specify resource limits for the project.
Click Create Project.

6.1.2. Edit a Project

You can edit a project to change its name or description, enable or temporarily disable it, or update its members.

As an admin user in the dashboard, select Identity > Projects.
In the project’s Actions column, click the arrow, and click Edit Project.
In the Edit Project window, you can update a project to change its name or description, and enable or temporarily disable the project.
On the Project Members tab, add members to the project, or remove them as needed.
Click Save.

Note

The Enabled check box is selected by default. To temporarily disable the project, clear the Enabled check box. To enable a disabled project, select the Enabled check box.

6.1.3. Delete a Project

As an admin user in the dashboard, select Identity > Projects.
Select the project you want to delete.
Click Delete Projects. The Confirm Delete Projects window is displayed.
Click Delete Projects to confirm the action.

The project gets deleted and any user pairing will be disassociated.

6.1.4. Update Project Quotas

Quotas are operational limits that can be set per project to optimize cloud resources. You can set quotas to prevent project resources from being exhausted without notification. Quotas can be enforced at both the project and the project-user level.

As an admin user in the dashboard, select Identity > Projects.
In the project’s Actions column, click the arrow, and click Modify Quotas.
In the Quota tab, modify project quotas as needed.
Click Save.

6.1.5. Change Active Project

A user can set a project as the active project only of which they are a member. It is also necessary for the user to be a member of more than one project to have the Set as Active Project option be enabled. Setting a project as an active project enables you to access objects in the dashboard for the active project. Note that a disabled project cannot be set as active, unless it is re-enabled.

As an admin user in the dashboard, select Identity > Projects.
In the project’s Actions column, click the arrow, and click Set as Active Project.
Alternatively, as a non-admin user, in the project’s Actions column, click Set as Active Project which becomes the default action in the column.

6.2. Project Security Management

Security groups are sets of IP filter rules that can be assigned to project instances, and which define networking access to the instance. Security groups are project specific; project members can edit the default rules for their security group and add new rule sets.

All projects have a default security group that is applied to any instance that has no other defined security group. Unless you change the default values, this security group denies all incoming traffic and allows only outgoing traffic to your instance.

6.2.1. Create a Security Group

In the dashboard, select Project > Compute > Access & Security.
On the Security Groups tab, click Create Security Group.
Provide a name and description for the group, and click Create Security Group.

6.2.2. Add a Security Group Rule

By default, rules for a new group only provide outgoing access. You must add new rules to provide additional access.

In the dashboard, select Project > Compute > Access & Security.
On the Security Groups tab, click Manage Rules for the security group that you want to edit.
Click Add Rule to add a new rule.
Specify the rule values, and click Add.
The following rule fields are required:
Rule
Rule type. If you specify a rule template (for example, SSH), its fields are automatically filled in:
TCP: Typically used to exchange data between systems, and for end-user communication.
UDP: Typically used to exchange data between systems, particularly at the application level.
ICMP: Typically used by network devices, such as routers, to send error or monitoring messages.
Direction
Ingress (inbound) or Egress (outbound).
Open Port
For TCP or UDP rules, the Port or Port Range (single port or range of ports) to open:
For a range of ports, enter port values in the From Port and To Port fields.
For a single port, enter the port value in the Port field.
Type
The type for ICMP rules; must be in the range -1:255.
Code
The code for ICMP rules; must be in the range -1:255.
Remote
The traffic source for this rule:
CIDR (Classless Inter-Domain Routing): IP address block, which limits access to IPs within the block. Enter the CIDR in the Source field.
Security Group: Source group that enables any instance in the group to access any other group instance.

6.2.3. Delete a Security Group Rule

In the dashboard, select Project > Compute > Access & Security.
On the Security Groups tab, click Manage Rules for the security group.
Select the security group rule, and click Delete Rule.
Click Delete Rule again.

Note

You cannot undo the delete action.

6.2.4. Delete a Security Group

In the dashboard, select Project > Compute > Access & Security.
On the Security Groups tab, select the group, and click Delete Security Groups.
Click Delete Security Groups.

Note

You cannot undo the delete action.

6.3. Hierarchical Multitenancy (HMT) in Identity Service

Using keystone, you can use multitenancy to nest projects. This allows subprojects to inherit role assignments from a parent project.

6.3.1. Create the Project and Subprojects

You can implement Hierarchical Multitenancy (HMT) using keystone domains and projects. To do so, start by creating a new domain, then creating a project within that domain. This enables you to add subprojects to that project. You can also promote a user to administrator of a subproject by adding the user to the admin role for that subproject.

Note

The HMT structure used by keystone is not currently represented in the dashboard.

For example:

1. Create a new keystone domain called corp:

$ openstack domain create corp
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| enabled     | True                             |
| id          | 69436408fdcb44ab9e111691f8e9216d |
| name        | corp                             |
+-------------+----------------------------------+

2. Create the parent project (private-cloud) within the corp domain:

$ openstack project create private-cloud --domain corp
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| domain_id   | 69436408fdcb44ab9e111691f8e9216d |
| enabled     | True                             |
| id          | c50d5cf4fe2e4929b98af5abdec3fd64 |
| is_domain   | False                            |
| name        | private-cloud                    |
| parent_id   | 69436408fdcb44ab9e111691f8e9216d |
+-------------+----------------------------------+

3. Create a subproject (dev) within the private-cloud parent project, while also specifying the corp domain:

$ openstack project create dev --parent private-cloud --domain corp
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| domain_id   | 69436408fdcb44ab9e111691f8e9216d |
| enabled     | True                             |
| id          | 11fccd8369824baa9fc87cf01023fd87 |
| is_domain   | False                            |
| name        | dev                              |
| parent_id   | c50d5cf4fe2e4929b98af5abdec3fd64 |
+-------------+----------------------------------+

4. Create another subproject called qa:

$ openstack project create qa --parent private-cloud --domain corp
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| domain_id   | 69436408fdcb44ab9e111691f8e9216d |
| enabled     | True                             |
| id          | b4f1d6f59ddf413fa040f062a0234871 |
| is_domain   | False                            |
| name        | qa                               |
| parent_id   | c50d5cf4fe2e4929b98af5abdec3fd64 |
+-------------+----------------------------------+

Note

You can use the Identity API to view the project hierarchy. For more information, see https://developer.openstack.org/api-ref/identity/v3/index.html?expanded=show-project-details-detail

6.3.2. Granting Access

By default, a newly-created project has no assigned roles. When you assign role permissions to the parent project, you can include the --inherited flag to instruct subprojects to inherit the assigned permissions from the parent project. For example, a user with admin role access to the parent project will also have admin access to the subprojects.

1. View the existing permissions assigned to a project:

$ openstack role assignment list --project private-cloud

2. View the existing roles:

# openstack role list
+----------------------------------+---------------+
| ID                               | Name          |
+----------------------------------+---------------+
| 3a5137e4b620489791df1152ac013bfa | ResellerAdmin |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_      |
| cf4f87df933b455f957cf03b6d3784d2 | admin         |
| eef5cea6ff9549aa98cccc208c370d80 | SwiftOperator |
+----------------------------------+---------------+

3. Grant the user account user1 access to the private-cloud project:

$ openstack role add --user user1 --user-domain corp --project private-cloud _member_

Re-run the command above using the --inherited flag. As a result, user1 also has access to the private-cloud subprojects, which have inherited the role assignment:

$ openstack role add --user user1 --user-domain corp --project private-cloud _member_ --inherited

4. Review the result of the permissions update:

openstack role assignment list --effective --user user1 --user-domain corp
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| Role                             | User                             | Group | Project                          | Domain | Inherited |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| 9fe2ff9ee4384b1894a90878d3e92bab | 10b5b34df21d485ca044433818d134be |       | c50d5cf4fe2e4929b98af5abdec3fd64 |        | False     |
| 9fe2ff9ee4384b1894a90878d3e92bab | 10b5b34df21d485ca044433818d134be |       | 11fccd8369824baa9fc87cf01023fd87 |        | True      |
| 9fe2ff9ee4384b1894a90878d3e92bab | 10b5b34df21d485ca044433818d134be |       | b4f1d6f59ddf413fa040f062a0234871 |        | True      |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+

You will see in the results that user1 has inherited access to the qa and dev projects. In addition, because the --inherited flag was applied to the parent project, user1 will also automatically get access to any subprojects that are created later.

6.3.3. Removing access

Explicit and inherited permissions need to be removed separately. For example:

1. Remove a user from an explicitly assigned role:

$ openstack role remove --user user1 --project private-cloud _member_

2. Review the result of the change. Notice that the inherited permissions are still present:

$ openstack role assignment list --effective --user user1 --user-domain corp
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| Role                             | User                             | Group | Project                          | Domain | Inherited |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+
| 9fe2ff9ee4384b1894a90878d3e92bab | 10b5b34df21d485ca044433818d134be |       | 11fccd8369824baa9fc87cf01023fd87 |        | True      |
| 9fe2ff9ee4384b1894a90878d3e92bab | 10b5b34df21d485ca044433818d134be |       | b4f1d6f59ddf413fa040f062a0234871 |        | True      |
+----------------------------------+----------------------------------+-------+----------------------------------+--------+-----------+

3. Remove the inherited permissions:

$ openstack role remove --user user1 --project private-cloud _member_ --inherited

4. Review the result of the change. The inherited permissions have been removed, and the resulting output is now empty:

# openstack role assignment list --effective --user user1 --user-domain corp

6.3.4. Nested Quotas

At present, nested quotas are not yet supported. As such, you will need to manage quotas individually against projects and subprojects.

Chapter 7. Domain Management

Identity Service (keystone) domains are additional namespaces you can create in keystone. You would use keystone domains to partition users, groups, and projects. These separate domains can also be configured to authenticate users in different LDAP or Active Directory environments. For more information see Integrate with Identity Service.

Note

Identity Service includes a built-in domain called Default. It is suggested you reserve this domain only for service accounts, and create a separate domain for user accounts.

7.1. View a List of Domains

You can view a list of domains using openstack domain list. For example:

$ openstack domain list
+----------------------------------+------------------+---------+--------------------+
| ID                               | Name             | Enabled | Description        |
+----------------------------------+------------------+---------+--------------------+
| 3abefa6f32c14db9a9703bf5ce6863e1 | TestDomain       | True    |                    |
| 69436408fdcb44ab9e111691f8e9216d | corp             | True    |                    |
| a4f61a8feb8d4253b260054c6aa41adb | federated_domain | True    |                    |
| default                          | Default          | True    | The default domain |
+----------------------------------+------------------+---------+--------------------+

Note

If this command is not available, check you have enabled keystone v3 for your command line session.

7.2. Create a New Domain

You can create a new domain using openstack domain create. For example:

$ openstack domain create TestDomain
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| enabled     | True                             |
| id          | 3abefa6f32c14db9a9703bf5ce6863e1 |
| name        | TestDomain                       |
+-------------+----------------------------------+

7.3. View the Details of a Domain

You can view the details of a domain using openstack domain show. For example:

$ openstack domain show TestDomain
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| enabled     | True                             |
| id          | 3abefa6f32c14db9a9703bf5ce6863e1 |
| name        | TestDomain                       |
+-------------+----------------------------------+

7.4. Disable a Domain

You can disable a domain using --disable. For example:
```
$ openstack domain set TestDomain --disable
```

Confirm the domain has been disabled:

$ openstack domain show TestDomain
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description |                                  |
| enabled     | False                            |
| id          | 3abefa6f32c14db9a9703bf5ce6863e1 |
| name        | TestDomain                       |
+-------------+----------------------------------+

You can then re-enable the domain, if required:
```
$ openstack domain set TestDomain --enable
```

Chapter 8. Identity Management

8.1. Secure LDAP Communication

If you have configured the Identity service (keystone) to authenticate against or to retrieve identity information from an LDAP server, you can secure LDAP communication for the Identity service using a CA certificate.

This section outlines how to obtain the CA certificate from Active Directory, how to convert the CA certificate file into Privacy Enhanced Mail (PEM) file format, and the three methods for configuring secure LDAP communication for the Identity service. The procedure in each method must be performed depending on where and how the CA trust is configured.

8.1.1. Obtaining the CA Certificate from Active Directory

The following code shows an example of how to query Active Directory to obtain the CA certificate. The CA_NAME is the name of the certificate (you can see it in mmc.exe) and the rest of the parameters can be changed according to your setup:

CA_NAME="WIN2012DOM-WIN2012-CA"
AD_SUFFIX="dc=win2012dom,dc=com" LDAPURL="ldap://win2012.win2012dom.com"
ADMIN_DN="cn=Administrator,cn=Users,$AD_SUFFIX"
ADMINPASSWORD="MyPassword"

CA_CERT_DN="cn=latexmath:[$CA_NAME,cn=certification authorities,cn=public key services,cn=services,cn=configuration,$]AD_SUFFIX"

TMP_CACERT=/tmp/cacert.`date +'%Y%m%d%H%M%S'`.$$.pem

ldapsearch -xLLL -H
latexmath:[$LDAPURL -D `echo \"$]ADMIN_DN"`-W -s base -b`echo
"$CA_CERT_DN"` objectclass=* cACertificate

8.1.2. Converting the CA Certificate into PEM file format

Create a file called /path/cacert.pem and include the contents of the LDAP query — that obtained the CA certificate from Active Directory, within the header and footer, as shown in the example below:

-----BEGIN CERTIFICATE-----
MIIDbzCCAlegAwIBAgIQQD14hh1Yz7tPFLXCkKUOszANB... -----END
CERTIFICATE-----

For troubleshooting, you can execute the following query to check if LDAP is working, and to ensure the PEM certificate file was created correctly.

LDAPTLS_CACERT=/path/cacert.pem ldapsearch -xLLL -ZZ -H $LDAPURL -s base -b "" "objectclass=*" currenttime

The query should return a result similar to:

dn: currentTime:
20141022050611.0Z

You can run the following command to get a CA certificate if it was hosted by a web server.

Example

$HOST=redhat.com
$PORT=443

# echo Q | openssl s_client -connect $HOST:$PORT | sed -n -e '/BEGIN CERTIFICATE/,/END CERTIFICATE/ p'

8.1.3. Methods for Configuring Secure LDAP Communication for the Identity Service

8.1.3.1. Method 1

Use this method if the CA trust is configured at the LDAP level using a PEM file. Manually specify the location of a CA certificate file. The following procedure secures LDAP communication not only for the Identity service, but for all applications that use the OpenLDAP libraries.

Copy the file containing your CA certificate chain in PEM format to the /etc/openldap/certs directory.
Edit /etc/openldap/ldap.conf and add the following directive, replacing [CA_FILE] with the location and name of the CA certificate file:
```
TLS_CACERT /etc/openldap/certs/[CA_FILE]
```
Restart the httpd service:
```
# systemctl restart httpd.service
```

8.1.3.2. Method 2

Use this method if the CA trust is configured at the LDAP library level using a Network Security Services (NSS) database. Use the certutil command to import and trust a CA certificate into the NSS certificate database used by the OpenLDAP libraries. The following procedure secures LDAP communication not only for the Identity service, but for all applications that use the OpenLDAP libraries.

Import and trust the certificate, replacing [CA_FILE] with the location and name of the CA certificate file:

# certutil -d /etc/openldap/certs -A -n "My CA" -t CT,, -a -i [CA_FILE]
# certutil -d /etc/openldap/certs -A -n "My CA" -t CT,, -a -i [CA_FILE]

Confirm the CA certificate was imported correctly:
```
# certutil -d /etc/openldap/certs -L
```
Your CA certificate is listed, and the trust attributes are set to CT,,.
Restart the httpd service:
```
# systemctl restart httpd.service
```

8.1.3.3. Method 3

Use this method if the CA trust is configured at the Keystone level using a PEM file. The final method of securing communication between the Identity service and an LDAP server is to configure TLS for the Identity service.

However, unlike the two methods above, this method only secures LDAP communication for the Identity service and does not secure LDAP communication for other applications that use the OpenLDAP libraries.

The following procedure uses the openstack-config command to edit values in the /etc/keystone/keystone.conf file.

Enable TLS:

# openstack-config --set /etc/keystone/keystone.conf ldap use_tls True

Specify the location of the certificate, replacing [CA_FILE] with the name of the CA certificate:
```
# openstack-config --set /etc/keystone/keystone.conf ldap tls_cacertfile [CA_FILE]
```
Specify the client certificate checks performed on incoming TLS sessions from the LDAP server, replacing [CERT_BEHAVIOR] with one of the behaviors listed below:
demand
a certificate will always be requested from the LDAP server. The session will be terminated if no certificate is provided, or if the certificate provided cannot be verified against the existing certificate authorities file.
allow
a certificate will always be requested from the LDAP server. The session will proceed as normal even if a certificate is not provided. If a certificate is provided but it cannot be verified against the existing certificate authorities file, the certificate will be ignored and the session will proceed as normal.
never
a certificate will never be requested.
```
# openstack-config --set /etc/keystone/keystone.conf ldap tls_req_cert [CERT_BEHAVIOR]
```
Restart the httpd service:
```
# systemctl restart httpd.service
```

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Users and Identity Management Guide

Managing users and authentication mechanisms

OpenStack Documentation Team

Preface

Chapter 1. User Management

1.1. User Management

1.1.1. Create a User

1.1.2. Edit a User

1.1.3. Enable or Disable a User

1.1.4. Delete a User

Chapter 2. Role Management

2.1. Role Management

2.1.1. View Roles

2.1.2. Create and Assign a Role

Chapter 3. Group Management

3.1. Manage Keystone Groups

3.1.1. Using the Command-line

3.1.2. Using Dashboard

3.1.2.1. Create a Group

3.1.2.2. Manage Group Membership

Chapter 4. Quota Management

4.1. Quota Management

4.1.1. View Compute Quotas for a User

4.1.2. Update Compute Quotas for a User

4.1.3. Set Object Storage Quotas for a User

Chapter 5. Policy Management

5.1. Using policy files for access control

5.1.1. Example: Create a Power User role

5.1.2. Review role assignment

5.1.3. Policy syntax

Chapter 6. Project Management

6.1. Project Management

6.1.1. Create a Project

6.1.2. Edit a Project

6.1.3. Delete a Project

6.1.4. Update Project Quotas

6.1.5. Change Active Project

6.2. Project Security Management

6.2.1. Create a Security Group

6.2.2. Add a Security Group Rule

6.2.3. Delete a Security Group Rule

6.2.4. Delete a Security Group

6.3. Hierarchical Multitenancy (HMT) in Identity Service

6.3.1. Create the Project and Subprojects

6.3.2. Granting Access

6.3.3. Removing access

6.3.4. Nested Quotas

Chapter 7. Domain Management

7.1. View a List of Domains

7.2. Create a New Domain

7.3. View the Details of a Domain

7.4. Disable a Domain

Chapter 8. Identity Management

8.1. Secure LDAP Communication

8.1.1. Obtaining the CA Certificate from Active Directory

8.1.2. Converting the CA Certificate into PEM file format

8.1.3. Methods for Configuring Secure LDAP Communication for the Identity Service

8.1.3.1. Method 1

8.1.3.2. Method 2

8.1.3.3. Method 3

Legal Notice

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links