Authenticate proxy with nginx

Use-case

People already relying on a nginx proxy to authenticate their users to other services might want to leverage it and have Registry communications tunneled through the same pipeline.

Usually, that includes enterprise setups using LDAP/AD on the backend and a SSO mechanism fronting their internal http portal.

Alternatives

If you just want authentication for your registry, and are happy maintaining users access separately, you should really consider sticking with the native basic auth registry feature.

Solution

With the method presented here, you implement basic authentication for docker engines in a reverse proxy that sits in front of your registry.

While we use a simple htpasswd file as an example, any other nginx authentication backend should be fairly easy to implement once you are done with the example.

We also implement push restriction (to a limited user group) for the sake of the example. Again, you should modify this to fit your mileage.

Gotchas

While this model gives you the ability to use whatever authentication backend you want through the secondary authentication mechanism implemented inside your proxy, it also requires that you move TLS termination from the Registry to the proxy itself.

Note: It is not recommended to bind your registry to localhost:5000 without authentication. This creates a potential loophole in your registry security. As a result, anyone who can log on to the server where your registry is running can push images without authentication.

Furthermore, introducing an extra http layer in your communication pipeline makes it more complex to deploy, maintain, and debug. Make sure the extra complexity is required.

For instance, Amazon’s Elastic Load Balancer (ELB) in HTTPS mode already sets the following client header:

  1. X-Real-IP
  2. X-Forwarded-For
  3. X-Forwarded-Proto

So if you have an Nginx instance sitting behind it, remove these lines from the example config below:

  1. proxy_set_header  Host              $http_host;   # required for docker client's sake
  2. proxy_set_header  X-Real-IP         $remote_addr; # pass on real client's IP
  3. proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
  4. proxy_set_header  X-Forwarded-Proto $scheme;

Otherwise Nginx resets the ELB’s values, and the requests are not routed properly. For more information, see #970.

Setting things up

Review the requirements, then follow these steps.

  1. Create the required directories

    1. $ mkdir -p auth data

  2. Create the main nginx configuration. Paste this code block into a new file called auth/nginx.conf:

    1. events {
    2.     worker_connections  1024;
    3. }
    5. http {
    7.   upstream docker-registry {
    8.     server registry:5000;
    9.   }
    11.   ## Set a variable to help us decide if we need to add the
    12.   ## 'Docker-Distribution-Api-Version' header.
    13.   ## The registry always sets this header.
    14.   ## In the case of nginx performing auth, the header is unset
    15.   ## since nginx is auth-ing before proxying.
    16.   map $upstream_http_docker_distribution_api_version $docker_distribution_api_version {
    17.     '' 'registry/2.0';
    18.   }
    20.   server {
    21.     listen 443 ssl;
    22.     server_name myregistrydomain.com;
    24.     # SSL
    25.     ssl_certificate /etc/nginx/conf.d/domain.crt;
    26.     ssl_certificate_key /etc/nginx/conf.d/domain.key;
    28.     # Recommendations from https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html
    29.     ssl_protocols TLSv1.1 TLSv1.2;
    30.     ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH';
    31.     ssl_prefer_server_ciphers on;
    32.     ssl_session_cache shared:SSL:10m;
    34.     # disable any limits to avoid HTTP 413 for large image uploads
    35.     client_max_body_size 0;
    37.     # required to avoid HTTP 411: see Issue #1486 (https://github.com/moby/moby/issues/1486)
    38.     chunked_transfer_encoding on;
    40.     location /v2/ {
    41.       # Do not allow connections from docker 1.5 and earlier
    42.       # docker pre-1.6.0 did not properly set the user agent on ping, catch "Go *" user agents
    43.       if ($http_user_agent ~ "^(docker\/1\.(3|4|5(?!\.[0-9]-dev))|Go ).*$" ) {
    44.         return 404;
    45.       }
    47.       # To add basic authentication to v2 use auth_basic setting.
    48.       auth_basic "Registry realm";
    49.       auth_basic_user_file /etc/nginx/conf.d/nginx.htpasswd;
    51.       ## If $docker_distribution_api_version is empty, the header is not added.
    52.       ## See the map directive above where this variable is defined.
    53.       add_header 'Docker-Distribution-Api-Version' $docker_distribution_api_version always;
    55.       proxy_pass                          http://docker-registry;
    56.       proxy_set_header  Host              $http_host;   # required for docker client's sake
    57.       proxy_set_header  X-Real-IP         $remote_addr; # pass on real client's IP
    58.       proxy_set_header  X-Forwarded-For   $proxy_add_x_forwarded_for;
    59.       proxy_set_header  X-Forwarded-Proto $scheme;
    60.       proxy_read_timeout                  900;
    61.     }
    62.   }
    63. }

  3. Create a password file auth/nginx.htpasswd for “testuser” and “testpassword”.

    1. $ docker run --rm --entrypoint htpasswd httpd -Bbn testuser testpassword > auth/nginx.htpasswd

    Note: If you do not want to use bcrypt, you can omit the -B parameter.

  4. Copy your certificate files to the auth/ directory.

    1. $ cp domain.crt auth
    2. $ cp domain.key auth

  5. Create the compose file. Paste the following YAML into a new file called docker-compose.yml.

    1. version: "3"
    3. services:
    4.     nginx:
    5.       # Note : Only nginx:alpine supports bcrypt.
    6.       # If you don't need to use bcrypt, you can use a different tag.
    7.       # Ref. https://github.com/nginxinc/docker-nginx/issues/29
    8.       image: "nginx:alpine"
    9.       ports:
    10.         - 5043:443
    11.       depends_on:
    12.         - registry
    13.       volumes:
    14.         - ./auth:/etc/nginx/conf.d
    15.         - ./auth/nginx.conf:/etc/nginx/nginx.conf:ro
    17.     registry:
    18.       image: registry:2
    19.       volumes:
    20.         - ./data:/var/lib/registry

Starting and stopping

Now, start your stack:

  1. $ docker-compose up -d

Login with a “push” authorized user (using testuser and testpassword), then tag and push your first image:

  1. $ docker login -u=testuser -p=testpassword -e=root@example.ch myregistrydomain.com:5043
  2. $ docker tag ubuntu myregistrydomain.com:5043/test
  3. $ docker push myregistrydomain.com:5043/test
  4. $ docker pull myregistrydomain.com:5043/test