All posts

Traefik v1.7 で Let's Encrypt のワイルドカード証明書を使う

Docker Swarm 環境で Traefik v1.7 を使い、Let's Encrypt のワイルドカード証明書を設定したときのメモです。

DNS には Linode の DNS サーバーを使用しています。証明書の取得には DNS-01 チャレンジを使い、DNS レコードの操作を Traefik から Linode API 経由で行います。

この記事の設定は Traefik v1.7 向けです。新しいバージョンでは設定方法が異なるため、利用するバージョンのドキュメントを確認してください。

ワイルドカード証明書には DNS-01 チャレンジが必要

ワイルドカード証明書を使うように設定したところ、DNS チャレンジが必要というエラーログが出力されました。

DNS-01 チャレンジは、DNS の TXT レコードに認証用の値を設定し、ドメインの管理権限を確認する方法です。Let's Encrypt のワイルドカード証明書は、この方法で認証します。[Let's Encrypt のチャレンジ方式]

証明書の取得や更新を Traefik に自動で行わせるには、利用している DNS のレコードを API 経由で操作できる必要があります。

今回利用している Linode の DNS は API に対応しており、Traefik v1.7 の DNS プロバイダーとしても指定できます。対応プロバイダーと必要な環境変数は、公式ドキュメントにまとめられています。[Traefik v1.7 の ACME 設定]

Linode の API トークンを用意する

Linode の管理画面で、DNS 情報の読み書きができる API トークンを発行します。

発行したトークンは、Traefik コンテナの環境変数 LINODE_TOKEN に設定します。トークンは DNS を操作できる認証情報なので、設定ファイルや Git リポジトリに実際の値を直接保存しないようにします。

Traefik を設定する

Docker Swarm で使用した設定は次のとおりです。

version: '3.4'

services:
  traefik:
    image: traefik:1.7-alpine
    command:
      - "--logLevel=error"
      - "--entryPoints=Name:http Address::80 Redirect.EntryPoint:https"
      - "--entryPoints=Name:https Address::443 TLS TLS.minVersion:VersionTLS12 TLS.cipherSuites:TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA Compress:true"
      - "--defaultentrypoints=http,https"
      - "--web"
      - "--web.address=:8080"
      - "--acme"
      - "--acme.storage=certs.json"
      - "--acme.email=あなたのメールアドレス"
      - "--acme.entrypoint=https"
      - "--acme.httpchallenge=true"
      - "--acme.httpchallenge.entrypoint=http"
      - "--acme.tlsChallenge=true"
      - "--acme.dnschallenge=true"

      # DNS プロバイダー
      - "--acme.dnschallenge.provider=linodev4"

      # ワイルドカードとルートドメイン
      - "--acme.domains=*.hogehoge.com,hogehoge.com"

      - "--docker"
      - "--docker.endpoint=unix:///var/run/docker.sock"

      # Docker Swarm のオーバーレイネットワーク
      - "--docker.network=overlay"
      - "--docker.swarmMode"
      - "--docker.watch"

    ports:
      - mode: host
        protocol: tcp
        published: 80
        target: 80
      - mode: host
        protocol: tcp
        published: 443
        target: 443

    networks:
      - overlay

    environment:
      LINODE_TOKEN: << Linode の API トークン >>

    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /home/web/traefik/certs.json:/certs.json

    deploy:
      restart_policy:
        condition: on-failure

networks:
  overlay:
    external: true

acme.dnschallenge.provider には linodev4 を指定します。acme.domains には、ワイルドカードの *.hogehoge.com と、ルートドメインの hogehoge.com を指定しました。

この例は、実際に使った Traefik v1.7 の設定を基にしています。API トークンの管理方法や TLS の設定は、利用する環境に合わせて確認してください。

ワイルドカードで受けるコンテナを設定する

次に、ワイルドカードで受けるリクエストの転送先となるコンテナを設定します。

version: '3.4'

services:
  sample:
    image: tutum/hello-world
    networks:
      - overlay

    deploy:
      labels:
        - traefik.enable=true
        - traefik.backend=sample
        - traefik.frontend.rule=HostRegexp:{catchall:.*}
        - traefik.frontend.priority=1
        - traefik.frontend.entryPoints=https
        - traefik.port=80
        - traefik.protocol=http

networks:
  overlay:
    external: true

traefik.frontend.rule には、ホスト名を受けるルールを指定します。

HostRegexp:{catchall:.*}

この例は幅広いホスト名に一致するキャッチオールです。対象ドメインのサブドメインに絞りたい場合は、次のようにも指定できます。

HostRegexp:{subdomain:[a-z0-9]+}.hogehoge.com

ルーティングの優先順位を指定する

キャッチオールのルールには、次のように priority を指定しました。

- traefik.frontend.priority=1

Traefik v1.7 では、デフォルトの優先順位はルールの長さを基に決まります。キャッチオールが、サブドメインを明示したほかのルールより先に評価されると、意図しないコンテナにリクエストが転送される可能性があります。[Traefik v1.7 のルーティング優先順位]

今回はキャッチオール側の優先順位を 1 に設定しました。ほかのルールにも優先順位を指定している場合は、それぞれの値を比較して、意図した順番で評価されることを確認します。

これで、Linode の DNS を使ったワイルドカード証明書の取得と、対象コンテナへのルーティングを設定できました。

Discussion