Configuring an htpasswd identity provider

To define an htpasswd identity provider, perform the following tasks:

Create an htpasswd file to store the user and password information.
to represent the htpasswd file.
Define an htpasswd identity provider resource that references the secret.
to the default OAuth configuration to add the identity provider.

By default, only a kubeadmin user exists on your cluster. To specify an identity provider, you must create a custom resource (CR) that describes that identity provider and add it to the cluster.

About htpasswd authentication

Using htpasswd authentication in OKD allows you to identify users based on an htpasswd file. An htpasswd file is a flat file that contains the user name and hashed password for each user. You can use the htpasswd utility to create this file.

See one of the following sections for instructions about how to create the htpasswd file:

Creating an htpasswd file using Windows

To use the htpasswd identity provider, you must generate a flat file that contains the user names and passwords for your cluster by using htpasswd.

Prerequisites

Have access to the htpasswd utility. On Red Hat Enterprise Linux this is available by installing the httpd-tools package.

Procedure

Create or update your flat file with a user name and hashed password:

The command generates a hashed version of the password.

For example:
```
$ htpasswd -c -B -b users.htpasswd user1 MyPassword!
```
Example output
```
Adding password for user user1
```

Continue to add or update credentials to the file:

$ htpasswd -B -b </path/to/users.htpasswd> <user_name> <password>

Creating an htpasswd file using Windows

To use the htpasswd identity provider, you must generate a flat file that contains the user names and passwords for your cluster by using htpasswd.

Prerequisites

Have access to htpasswd.exe. This file is included in the \bin directory of many Apache httpd distributions.

Procedure

Create or update your flat file with a user name and hashed password:

> htpasswd.exe -c -B -b <\path\to\users.htpasswd> <user_name> <password>

For example:

> htpasswd.exe -c -B -b users.htpasswd user1 MyPassword!

Example output

Adding password for user user1

Continue to add or update credentials to the file:

> htpasswd.exe -b <\path\to\users.htpasswd> <user_name> <password>

Creating the htpasswd secret

To use the htpasswd identity provider, you must define a secret that contains the htpasswd user file.

Prerequisites

Create an htpasswd file.

Procedure

The following custom resource (CR) shows the parameters and acceptable values for an htpasswd identity provider.

htpasswd CR

apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
  name: cluster
spec:
  identityProviders:
  - name: my_htpasswd_provider (1)
    mappingMethod: claim (2)
    type: HTPasswd
    htpasswd:
      fileData:
        name: htpass-secret (3)

Additional resources

See for information on parameters, such as mappingMethod, that are common to all identity providers.

Adding an identity provider to your cluster

After you install your cluster, add an identity provider to it so your users can authenticate.

Prerequisites

Create an OKD cluster.
Create the custom resource (CR) for your identity providers.
You must be logged in as an administrator.

Procedure

Apply the defined CR:
```
$ oc apply -f </path/to/CR>
```
Log in to the cluster as a user from your identity provider, entering the password when prompted.
```
$ oc login -u <username>
```
Confirm that the user logged in successfully, and display the user name.
```
$ oc whoami
```

You can add or remove users from an existing htpasswd identity provider.

Prerequisites

You have configured an htpasswd identity provider. This procedure assumes that it is named .
You have access to the htpasswd utility. On Red Hat Enterprise Linux this is available by installing the httpd-tools package.
You have cluster administrator privileges.

Procedure

Retrieve the htpasswd file from the htpass-secret Secret object and save the file to your file system:

$ oc get secret htpass-secret -ojsonpath={.data.htpasswd} -n openshift-config | base64 --decode > users.htpasswd

Add or remove users from the users.htpasswd file.

To add a new user:

$ htpasswd -bB users.htpasswd <username> <password>

Example output

To remove an existing user:

$ htpasswd -D users.htpasswd <username>

Example output

Deleting password for user <username>

Replace the htpass-secret Secret object with the updated users in the users.htpasswd file:

$ oc create secret generic htpass-secret --from-file=htpasswd=users.htpasswd --dry-run=client -o yaml -n openshift-config | oc replace -f -

If you removed one or more users, you must additionally remove existing resources for each user.
1. Delete the User object:
```
$ oc delete user <username>
```
  Example output
```
user.user.openshift.io "<username>" deleted
```
  Be sure to remove the user, otherwise the user can continue using their token as long as it has not expired.
2. Delete the object for the user:
```
$ oc delete identity my_htpasswd_provider:<username>
```
  Example output

Configuring identity providers using the web console

Configure your identity provider (IDP) through the web console instead of the CLI.

Prerequisites

You must be logged in to the web console as a cluster administrator.

Procedure

Navigate to Administration → Cluster Settings.
Under the Configuration tab, click OAuth.