Pulp can be configured to use authentication provided in the webserver outside of Pulp. This allows for integration with ldap for example, through mod_ldap, or certificate based API access, etc.
Enable external authentication in two steps:
Accept external auth instead of checking the internal users database by enabling:
``AUTHENTICATION_BACKENDS = ['pulpcore.app.authentication.PulpNoCreateRemoteUserBackend']``.
This will cause Pulp to accept any username for each request and not create a user in the database
backend for them. To have any name accepted but create the username in the database backend, use the
django.contrib.auth.backends.RemoteUserBackend instead, which creates users by default.
Specify how to receive the username from the webserver. Do this by specifying to DRF an
AUTHENTICATION_CLASS. For example, use the
REST_FRAMEWORK['DEFAULT_AUTHENTICATION_CLASSES'] = ( 'rest_framework.authentication.SessionAuthentication', 'pulpcore.app.authentication.PulpRemoteUserAuthentication' )
Or, as a dynaconf environment variable (pay special attention to the double underscore separating the paramater name from the key):
PULP_REST_FRAMEWORK__DEFAULT_AUTHENTICATION_CLASSES="[ 'rest_framework.authentication.SessionAuthentication', 'pulpcore.app.authentication.PulpRemoteUserAuthentication' ]"
rest_framework.authentication.BasicAuthentication, but retains
rest_framework.authentication.SessionAuthentication and adds
PulpRemoteUserAuthentication. This accepts the username as WSGI environment variable
REMOTE_USER by default, but can be configured via the
REMOTE_USER_ENVIRON_NAME Pulp setting.
Webserver Auth in Same Webserver¶
If your webserver authentication is occurring in the same webserver that is serving the
pulpcore.app.wsgi application, you can pass the authenticated username to Pulp via the WSGI
REMOTE_USER WSGI environment is the default behavior of the
pulpcore.app.authentication.PulpRemoteUserAuthentication and the Django Rest Framework provided
rest_framework.authentication.RemoteUserAuthentication. The only difference in the Pulp provided
one is that the WSGI environment variable name can be configured from a Pulp provided WSGI
environment variable name.
See the REMOTE_USER_ENVIRON_NAME for configuring the WSGI provided
name, but if you are using the
REMOTE_USER WSGI environment name with “same webserver”
authentication, you likely want to leave REMOTE_USER_ENVIRON_NAME
unset and configure the webserver to set the
REMOTE_USER WSGI environment variable.
Webserver Auth with Reverse Proxy¶
For example purposes, assume you’re using Nginx with LDAP authentication required and after authenticating it reverse proxies your request to the gunicorn process running the pulpcore.app.wsgi application. That would look like this:
nginx <---http---> gunicorn <----WSGI----> pulpcore.app.wsgi application
With nginx providing authentication, all it can do is pass
REMOTE_USER (or similar name) to the
application webserver, i.e. gunicorn. You can pass the header as part of the proxy request in nginx
with a config line like:
proxy_set_header REMOTE_USER $remote_user;
Per the WSGI standard, any incoming
headers will be prepended with a
HTTP_. The above line would send the header named
REMOTE_USER to gunicorn, and the WSGI application would receive it as
default configuration of Pulp is expecting
REMOTE_USER in the WSGI environment not
HTTP_REMOTE_USER, so this won’t work with
pulpcore.app.authentication.PulpRemoteUserAuthentication or the Django Rest Framework provided
rest_framework.authentication.RemoteUserAuthentication as is.
Pulp provides a setting named REMOTE_USER_ENVIRON_NAME which allows you to specify another WSGI environment variable to read the authenticated username from.
Configuring this has serious security implications. See the Django warning at the end of this section in their docs for more details.