Skip to content

Add htpasswd doc #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adellape merged 1 commit into from
Feb 24, 2015
Merged

Add htpasswd doc #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion architecture/authentication.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,18 @@ To configure how usernames and passwords are validated, set the `OPENSHIFT_OAUTH

* `anypassword`
** Any non-empty username and password combination is accepted
* `htpasswd`
** Validates usernames and passwords against a flat-file generated using http://httpd.apache.org/docs/2.4/programs/htpasswd.html[htpasswd]
** Only MD5 and SHA encryption types are supported. MD5 encryption is recommended, and is the default for htpasswd. Plaintext, crypt, and bcrypt hashes are not currently supported.
** Requires the environment variable `OPENSHIFT_OAUTH_HTPASSWD_FILE` be set to the path of an htpasswd-generated file
** The file is re-read if its modification time changes, without requiring a server restart
* `basicauthurl`
** The username and password are validated against a protected JSON-returning remote URL, using basic auth:
*** A 401 response indicates failed auth.
*** A non-200 status or the presence of an "error" key with a non-empty value indicates an error: `{"error":"Error message"}`
*** A 200 status with an "id" key indicates success: `{"id":"userid"}`
*** A successful response may also include name and/or email: `{"id":"userid", "name": "User Name", "email":"[email protected]"}`
** Requires the environment variable `OPENSHIFT_OAUTH_BASIC_AUTH_URL` to be set to the remote URL
** Requires the environment variable `OPENSHIFT_OAUTH_BASIC_AUTH_URL` be set to the remote URL
* `deny`
** Any username and password combination is denied

Expand Down Expand Up @@ -264,6 +269,21 @@ OPENSHIFT_OAUTH_SESSION_MAX_AGE_SECONDS=300 <6>
<5> Name of the cookie to save the session in
<6> Let sessions last up to 5 minutes

==== htpasswd-generated file
To validate usernames/passwords against a file generated by http://httpd.apache.org/docs/2.4/programs/htpasswd.html[htpasswd]:
```
OPENSHIFT_OAUTH_REQUEST_HANDLERS=session,basicauth
OPENSHIFT_OAUTH_HANDLER=login
OPENSHIFT_OAUTH_PASSWORD_AUTH=htpasswd
OPENSHIFT_OAUTH_HTPASSWD_FILE=path/to/users.htpasswd
```

To create the file: `htpasswd -c <path/to/users.htpasswd> <username>`

To add or update a user to the file: `htpasswd <path/to/users.htpasswd> <username>`

To remove a user from the file: `htpasswd <path/to/users.htpasswd> -D <username>`

==== External basic auth
To validate usernames/passwords against an external URL using basic auth:
```
Expand Down