Apache Tomcat 10

Tomcat は現在、JKS、PKCS11、または PKCS12 形式のキーストアでのみ動作します。JKS 形式は Java の標準「Java キーストア」形式であり、keytool コマンドラインユーティリティによって作成される形式です。このツールは JDK に含まれています。PKCS12 形式はインターネット標準であり、(特に) OpenSSL および Microsoft の Key-Manager を介して操作できます。

キーストア内の各エントリは、エイリアス文字列によって識別されます。多くのキーストア実装ではエイリアスが大文字と小文字を区別しない方法で処理されますが、大文字と小文字を区別する実装も利用可能です。たとえば、PKCS11 仕様では、エイリアスが大文字と小文字を区別する必要があります。エイリアスの大文字と小文字の区別に関連する問題を回避するには、大文字と小文字のみが異なるエイリアスを使用しないことをお勧めします。

既存の証明書を JKS キーストアにインポートするには、keytool に関するドキュメント（JDK ドキュメントパッケージ内）をお読みください。OpenSSL はキーの前に読み取り可能なコメントを追加することがよくありますが、keytool はそれをサポートしていないことに注意してください。したがって、証明書にキーデータの前にコメントがある場合は、keytool で証明書をインポートする前に削除してください。

OpenSSL を使用して、独自の CA によって署名された既存の証明書を PKCS12 キーストアにインポートするには、次のようなコマンドを実行します。

openssl pkcs12 -export -in mycert.crt -inkey mykey.key
                       -out mycert.p12 -name tomcat -CAfile myCA.crt
                       -caname root -chain

より高度なケースについては、OpenSSL ドキュメントを参照してください。

単一の自己署名証明書を含む新しい JKS キーストアを最初から作成するには、ターミナルのコマンドラインから以下を実行します。

Windows

"%JAVA_HOME%\bin\keytool" -genkey -alias tomcat -keyalg RSA

Unix

$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA

（RSA アルゴリズムは安全なアルゴリズムとして推奨される必要があり、これにより他のサーバーやコンポーネントとの一般的な互換性も確保されます。）

このコマンドは、コマンドを実行したユーザーのホームディレクトリに、「.keystore」という名前の新しいファイルを作成します。別の場所またはファイル名を指定するには、上記の keytool コマンドに -keystore パラメーターを追加し、その後にキーストアファイルへの完全なパス名を指定します。後述するように、この新しい場所を server.xml 構成ファイルにも反映する必要があります。たとえば、

Windows

"%JAVA_HOME%\bin\keytool" -genkey -alias tomcat -keyalg RSA
  -keystore \path\to\my\keystore

Unix

$JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA
  -keystore /path/to/my/keystore

このコマンドを実行すると、最初にキーストアパスワードの入力を求められます。Tomcat が使用するデフォルトのパスワードは「changeit」（すべて小文字）ですが、必要に応じてカスタムパスワードを指定することもできます。後述するように、server.xml 構成ファイルでカスタムパスワードを指定する必要もあります。

次に、会社、連絡先名など、この証明書に関する一般的な情報の入力を求められます。この情報は、アプリケーションの安全なページにアクセスしようとするユーザーに表示されるため、ここで提供される情報がユーザーの期待と一致するようにしてください。

最後に、キーパスワードの入力を求められます。これは、(同じキーストアファイルに格納されている他の証明書とは対照的に) この証明書専用のパスワードです。keytool プロンプトには、ENTER キーを押すと、キーのパスワードとしてキーストアと同じパスワードが自動的に使用されることが示されます。同じパスワードを使用することも、カスタムパスワードを選択することもできます。キーストアパスワードとは異なるパスワードを選択した場合は、後述するように server.xml 構成ファイルでカスタムパスワードを指定する必要があります。

すべてが成功すれば、サーバーで使用できる証明書付きのキーストアファイルが作成されます。

Tomcatは、SSLの2つの異なる実装を使用できます。

• Javaランタイムの一部として提供されるJSSE実装
• OpenSSLを使用するJSSE実装

具体的な構成の詳細は、どちらの実装を使用しているかによって異なります。汎用的なprotocol="HTTP/1.1"を指定してConnectorを構成した場合、Tomcatで使用される実装は自動的に選択されます。インストールでAPRを使用している場合（つまり、Tomcatネイティブライブラリをインストールしている場合）、JSSE OpenSSL実装が使用され、それ以外の場合はJava JSSE実装が使用されます。

必要に応じて、実装の自動選択を回避できます。これは、Connectorのprotocol属性にクラス名を指定することで行われます。

APRライブラリがロードされているかどうかに関係なく、Java（JSSE）コネクタを定義するには、次のいずれかを使用します。

<!-- Define an HTTP/1.1 Connector on port 8443, JSSE NIO implementation -->
<Connector protocol="org.apache.coyote.http11.Http11NioProtocol"
           sslImplementationName="org.apache.tomcat.util.net.jsse.JSSEImplementation"
           port="8443" .../>

<!-- Define an HTTP/1.1 Connector on port 8443, JSSE NIO2 implementation -->
<Connector protocol="org.apache.coyote.http11.Http11Nio2Protocol"
           sslImplementationName="org.apache.tomcat.util.net.jsse.JSSEImplementation"
           port="8443" .../>

OpenSSL JSSE実装も、必要に応じて明示的に構成できます。APRライブラリがインストールされている場合、sslImplementationName属性を使用すると有効にできます。OpenSSL JSSE実装を使用する場合、構成ではJSSE属性またはOpenSSL属性のいずれかを使用できますが、同じSSLHostConfigまたはConnector要素内で両方のタイプの属性を混在させてはなりません。

<!-- Define an HTTP/1.1 Connector on port 8443, JSSE NIO implementation and OpenSSL -->
<Connector protocol="org.apache.coyote.http11.Http11NioProtocol" port="8443"
           sslImplementationName="org.apache.tomcat.util.net.openssl.OpenSSLImplementation"
           .../>

JSSE OpenSSLを使用している場合は、OpenSSLの代替エンジンを構成するオプションがあります。

<Listener className="org.apache.catalina.core.AprLifecycleListener"
          SSLEngine="someengine" SSLRandomSeed="somedevice" />

デフォルト値は次のとおりです。

<Listener className="org.apache.catalina.core.AprLifecycleListener"
          SSLEngine="on" SSLRandomSeed="builtin" />

したがって、OpenSSLを有効にするには、SSLEngine属性がoff以外の値に設定されていることを確認してください。デフォルト値はonで、別の値を指定する場合は、有効なOpenSSLエンジン名である必要があります。

SSLRandomSeedを使用すると、エントロピーのソースを指定できます。本番システムには信頼できるエントロピーのソースが必要ですが、エントロピーを収集するには多くの時間が必要になる可能性があるため、テストシステムでは、Tomcatの起動を高速化するために"/dev/urandom"のようなブロッキングしないエントロピーソースを使用できます。

最後のステップは、$CATALINA_BASE/conf/server.xmlファイルでConnectorを構成することです。ここで、$CATALINA_BASEはTomcatインスタンスのベースディレクトリを表します。SSLコネクタの<Connector>要素の例は、Tomcatとともにインストールされるデフォルトのserver.xmlファイルに含まれています。JSSE構成スタイルでJSSEを使用するSSLコネクタを構成するには、コメントを削除し、次のように編集する必要があります。

<!-- Define an SSL Coyote HTTP/1.1 Connector on port 8443 -->
<Connector
    protocol="org.apache.coyote.http11.Http11NioProtocol"
    port="8443"
    maxThreads="150"
    SSLEnabled="true"
    maxParameterCount="1000"
    >
  <SSLHostConfig>
    <Certificate
      certificateKeystoreFile="${user.home}/.keystore"
      certificateKeystorePassword="changeit"
      type="RSA"
      />
    </SSLHostConfig>
</Connector>

注：tomcat-nativeがインストールされている場合、構成ではOpenSSL実装を備えたJSSEが使用されます。

APR構成スタイルでは、特にキーと証明書について、多くのSSL設定に異なる属性を使用します。APR構成スタイルの例を次に示します。

<!-- Define an SSL Coyote HTTP/1.1 Connector on port 8443 -->
<Connector
    protocol="org.apache.coyote.http11.Http11NioProtocol"
    port="8443"
    maxThreads="150"
    SSLEnabled="true"
    maxParameterCount="1000"
    >
  <SSLHostConfig>
    <Certificate
        certificateKeyFile="conf/localhost-rsa-key.pem"
        certificateFile="conf/localhost-rsa-cert.pem"
        certificateChainFile="conf/localhost-rsa-chain.pem"
        type="RSA"
        />
  </SSLHostConfig>
</Connector>

構成オプションと、どの属性が必須であるかについての情報は、HTTPコネクタ構成リファレンスのSSLサポートセクションに記載されています。Tomcatは、すべてのTLSコネクタでいずれかの構成スタイル（JSSEまたはOpenSSL）をサポートしています。

port属性は、Tomcatがセキュアな接続をリッスンするTCP/IPポート番号です。これを任意のポート番号（たとえば、https通信のデフォルトポートである443など）に変更できます。ただし、多くのオペレーティングシステムでは、1024未満のポート番号でTomcatを実行するには、特別な設定（このドキュメントの範囲外）が必要です。

ここでポート番号を変更する場合は、非SSLコネクタのredirectPort属性に指定された値も変更する必要があります。これにより、サーブレット仕様で要求されているように、SSLが必要であることを指定するセキュリティ制約のあるページにアクセスしようとするユーザーをTomcatが自動的にリダイレクトできます。

これらの構成変更が完了したら、通常どおりにTomcatを再起動すると、すべてが正常に動作するはずです。SSLを介してTomcatでサポートされている任意のWebアプリケーションにアクセスできるはずです。たとえば、試してみてください。

https://localhost:8443/

そして、通常のTomcatスプラッシュページが表示されるはずです（ROOT Webアプリケーションを変更していない場合）。これが機能しない場合は、次のセクションにトラブルシューティングのヒントが記載されています。

選択した認証局から証明書を取得するには、証明書署名要求（CSR）を作成する必要があります。このCSRは、認証局がWebサイトを「安全」として識別する証明書を作成するために使用されます。CSRを作成するには、次の手順に従います。

• ローカルの自己署名証明書を作成します（前のセクションで説明したとおり）。

  keytool -genkey -alias tomcat -keyalg RSA
      -keystore <your_keystore_filename>

  注：場合によっては、動作する証明書を作成するために、「名と姓」フィールドにWebサイトのドメイン（つまり、www.myside.org）を入力する必要があります。
• 次に、CSRは次のように作成されます。

  keytool -certreq -keyalg RSA -alias tomcat -file certreq.csr
      -keystore <your_keystore_filename>

これで、certreq.csrというファイルが作成されました。これを認証局に送信できます（これを行う方法については、認証局のWebサイトのドキュメントを参照してください）。代わりに、証明書を取得します。

証明書を入手したので、ローカルのキーストアにインポートできます。まず、いわゆるチェーン証明書またはルート証明書をキーストアにインポートする必要があります。その後、証明書のインポートに進むことができます。

• 証明書を取得した認証局からチェーン証明書をダウンロードします。
  Verisign.comの商用証明書の場合は、http://www.verisign.com/support/install/intermediate.htmlにアクセスしてください。
  Verisign.comのトライアル証明書の場合は、http://www.verisign.com/support/verisign-intermediate-ca/Trial_Secure_Server_Root/index.htmlにアクセスしてください。
  Trustcenter.deの場合は、http://www.trustcenter.de/certservices/cacerts/en/en.htm#serverにアクセスしてください。
  Thawte.comの場合は、http://www.thawte.com/certs/trustmap.htmlにアクセスしてください。
  
• チェーン証明書をキーストアにインポートします。

  keytool -import -alias root -keystore <your_keystore_filename>
      -trustcacerts -file <filename_of_the_chain_certificate>

• そして最後に、新しい証明書をインポートします。

  keytool -import -alias tomcat -keystore <your_keystore_filename>
      -file <your_certificate_filename>

各認証局は、他の認証局とは少し異なる傾向があります。わずかに異なる情報が必要になったり、証明書と関連付けられた証明書チェーンを異なる形式で提供したりする場合があります。さらに、認証局が証明書を発行するために使用するルールは、時間の経過とともに変化します。その結果、上記のコマンドを変更する必要がある場合があります。支援が必要な場合は、Apache Tomcatユーザーメーリングリストから支援を受けることができます。

Apache Tomcatでは、証明書にOCSPレスポンダーの場所がエンコードされているOCSP対応証明書が必要です。openssl.cnfファイルの基本的なOCSP関連の認証局設定は、次のようになります。

#... omitted for brevity

[x509]
x509_extensions = v3_issued

[v3_issued]
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid,issuer
# The address of your responder
authorityInfoAccess = OCSP;URI:http://127.0.0.1:8088
keyUsage = critical,digitalSignature,nonRepudiation,keyEncipherment,dataEncipherment,keyAgreement,keyCertSign,cRLSign,encipherOnly,decipherOnly
basicConstraints=critical,CA:FALSE
nsComment="Testing OCSP Certificate"

#... omitted for brevity

上記の設定では、OCSPレスポンダーのアドレス127.0.0.1:8088が証明書にエンコードされます。次の手順では、openssl.cnfとCAのその他の構成を準備しておく必要があることに注意してください。OCSP対応証明書を生成するには、次の手順を実行します。

• 秘密鍵を作成します。

  openssl genrsa -aes256 -out ocsp-cert.key 4096

• 署名要求（CSR）を作成します。

  openssl req -config openssl.cnf -new -sha256 \
    -key ocsp-cert.key -out ocsp-cert.csr

• CSRに署名します。

  openssl ca -openssl.cnf -extensions ocsp -days 375 -notext \
    -md sha256 -in ocsp-cert.csr -out ocsp-cert.crt

• 証明書を確認できます。

  openssl x509 -noout -text -in ocsp-cert.crt