This article describes how to run Jira applications over SSL or HTTPS by configuring Apache Tomcat with HTTPS. This procedure only covers the common installation types of Jira. It's not a definitive or comprehensive guide to configurу HTTPS and may not apply to your environment.

このテーマの詳細は、次の記事をご参照ください。

• Personal Information Exchange (PFX) 証明書を使用して HTTPS 経由で Jira を実行する方法

• SSL を利用して Jira と Apache を統合する方法

• JVM にパブリック SSL 証明書をインポートする方法

なぜ、Jira を SSL または HTTPS 上で実行する必要があるのでしょうか?インターネットを経由して Web アプリケーションにアクセスする際は、お客様のコンピューターと企業の ISP (インターネット サービス プロバイダー) 間の中継点でユーザー名やパスワードが傍受される可能性が常にあります。このため、一般的にアクセスを HTTPS (HTTP over SSL) 経由して、パスワードを送信するページにおいてはこれを必須とすることが推奨されます。ただし、HTTPS の利用でパフォーマンスの低下を招く場合があることにご注意ください。

はじめる前に

サポート

アトラシアンのサポートは、SSL のサポートについては証明書を発行する認証局 (CA) に委ねます。このページにおける SSL 関連の説明は参考情報としてのみ提供されます。

Windows インストーラー

Windows インストーラーは、Tomcat を実行するために独自の JRE (Java ランタイム環境) Java プラットフォームをインストールします。SSL 証明書のアップデート時は、JRE のインストールする際に実行してください。

関連バグ

Jira 7.3 以降は、server.xml ファイルのプロトコルを誤って設定するバグ 2 つの影響を受けます。プロトコルを手動で設定することでこの課題を回避できます。

protocol="org.apache.coyote.http11.Http11NioProtocol"

リバースプロキシの背後にある Jira

Jira が Apache のようなリバースプロキシの背後にホストされている場合の詳細については「SSL によって Jira と Apache を統合する」をご参照ください。

新しい接続の追加

When you add a new connection, like an SSL one, the Jira configuration tool saves an entry with connection details in the server.xml file. This entry doesn't include properties that handle special characters, so you'll need to add them manually. This is required, as Jira won't work properly without it. We've described the required steps below, but you can read more about the issue here.

安全性が低い BKS-V1 キーストア形式

Java キーストアの生成

Learn how to create a Java KeyStore (JKS) that will hold your SSL certificates. The SSL certificates are required for SSL to work in Jira. In the SSL world, certificates fall into two major categories:

Digital Certificates that are issued by trusted third-party CAs provide verification that your website indeed represents your company, thereby verifying your company's identity. Many CAs simply verify the domain name and issue the certificate. Other CAs, such as VeriSign, verify the existence of your business, the ownership of your domain name, and your authority to apply for the certificate, providing a higher standard of authentication.

CA の一覧は、ここをご覧ください。よく知られた認証局の例を次に示します:

• Verisign
• Thawte
• CAcert (a relatively new CA, providing free CA certificates)

当社としては、CA で署名された証明書の利用を推奨いたします。

1. Portecle アプリをダウンロードして、Jira を実行するサーバーにインストールします。

    このアプリケーションはサードパーティー製であり、アトラシアンではサポート対象外です。

2. Run the app as an Administrator, so it'll have appropriate permissions. Also, ensure the <JAVA_HOME> variable is pointing to the same version of Java that Jira uses. See Setting JAVA_HOME for further information on this.

   If running on a Linux/UNIX server, X11 should be forwarded when connecting to the server so that you can use the GUI, as follows: 

   ssh -X user@server

3. Select Create a new Keystore.
   
4. Select the JKS type and select OK.
   
5. Select Generate Key Pair.
   
6. Select the RSA algorithm and the key size of 2048.
   
7. Make sure the Signature Algorithm is "SHA256withRSA" and refer to Security tools report the default SSL Ciphers are too weak.
   
   

8.  Edit the certificate details as shown in the following example. Select OK.
   

   The Common Name must match the server's URL. Otherwise errors will be displayed in the browser.

9. Choose an alias for the certificate. For example, jira.
10. Enter a password for the keystore. The default password used is typically changeit.
11. The Key Pair Generation will report as successful.
    

12. Save the keystore in <Jira_HOME>/jira.jks, ensuring that the same password as in the previous step is used. Do it by selecting File > Save Keystore.

    If using a self-signed certificate certificate, proceed to Configuring your web server using the Jira configuration tool. Otherwise, go on.

13. You should generate a Certificate Signing Request for the CA to sign and confirm the identity of the certificate. To do so, right-click the certificate and choose Generate CSR. Save it in <Jira_HOME>/jira.csr.
    
14. Submit the CSR to the CA for signing. They'll provide a signed certificate (CA reply) and a set of root or intermediate CA certificates.
15. Import the root or intermediate CA certificates with Import Trusted Certificate, repeating this step for each certificate.
    
16. Import the signed certificate by right-clicking the jira certificate and selecting Import CA Reply.
    
17. Select the certificate provided by the CA. It should be jira.crt. You should receive the notification about the successful CA reply import.
18. 結果を [ツール] > [キーストア レポート] で確認します。証明書はルート証明書の子ノードとして表示されます。
19. キーストアを保存し、次のセクションに進みます :

Jira 設定ツールを利用した web サーバーの設定

Learn how to finish setting up the SSL encryption for Jira by configuring your web server with the Jira configuration tool. For more information on the Jira configuration tool, see Using the Jira configuration tool.

1. 次のように Jira 設定ツールを実行します。
   
   • Windows: コマンド プロンプトを開いて、Jira インストール ディレクトリの bin サブディレクトリにある config.bat を実行します。

   • Linux/Unix: コンソールを開いて、Jira インストール ディレクトリの bin サブディレクトリにある config.sh を実行します。

     このコマンドは「No X11 DISPLAY 変数が原因で Jira アプリケーション設定ツールを起動できなかったのは、設定エラーによるもの」に記載のエラーで失敗する場合があります。その場合は、この記事の回避策をご参照ください。

2. Select Web Server.
   Screenshot: Jira configuration tool—Web Server tab
   

3. 各フィールドに次のように入力します :

   フィールド	値
   ポートの制御	Leave as default. You can change the port number if you want. For more information, see Changing Jira's TCP ports.
   プロフィール	A profile is a pre-set web server configuration. You can choose from the four following values: 無効 HTTP のみ  HTTP および HTTPS (HTTP を HTTPS へリダイレクト) HTTPS のみ To run Jira over HTTPS, you should select either HTTP & HTTPS or HTTPS. Select HTTP & HTTPS if you want to run Jira over HTTPS but have users that access Jira via HTTP. In this case, users who try to access Jira via HTTP will be redirected to the HTTPS address.
   HTTP ポート	Leave as default: 8080. You can change the port number if you want. For more information, see Changing Jira's TCP ports. This field will be disabled if you set the Profile to HTTPS only.
   HTTPS ポート	Leave as default: 8443. You can change the port number if you want. For more information, see Changing Jira's TCP ports.
   Keystore パス	Specify the location of the keystore of your certificate. The location was generated when you saved the KeyStore and should be <Jira_HOME>/jira.jks.
   Keystore パスワード	Specify the password for your keystore. If you generated a self-signed certificate, this is the password you specified for the key and KeyStore when you generated and saved the certificate.
   Keystore エイリアス	Each entry in the keystore is identified by an alias. We recommend using jira for the certificate.

4. Select Check Certificate in Key Store to validate the following:
   
   • キーストア内に証明書が存在すること。
   • Test whether the keystore password works.
   • Test whether the key can be found by using the key alias.
5. 変更を保存します。

高度な設定

同一ホストにおける複数のインスタンスの実行

When running more than one instance on the same host, you should specify the address attribute in the <Jira_INSTALLATION>/conf/server.xml file. By default, the connector listens on all available network interfaces, so specifying the address will prevent conflicts with connectors running on the same default port. See more information on setting the address attribute in The HTTP Connector Apache Tomcat docs.

コマンド ラインを使用したインストール

ステップ 1.キーストアを作成します

1. Generate the Java KeyStore.

   <JAVA_HOME>/keytool -genkey -alias jira -keyalg RSA -keystore <Jira_HOME>/jira.jks

   Instead of the first and last names, enter the server URL, excluding https://. For example: jira.atlassian.com.

2. パスワードを入力します。

3. Create the CSR for signing and the password from the step 2.

   <JAVA_HOME>/keytool -certreq -alias jira -file /output/directory/csr.txt -keystore <Jira_HOME>/jira.jks

4. Submit the CSR to the CA for signing. They'll provide a signed certificate and a root or intermediate CA.
   

   If the certificate ins't signed, move to the step 6.

5. Import the root or intermediate CA.

   <JAVA_HOME>/keytool -import -alias rootCA -keystore <Jira_HOME>/jira.jks -trustcacerts -file root.crt

6. Import the signed certificate provided by the CA.

   <JAVA_HOME>/keytool -import -alias jira -keystore <Jira_HOME>/jira.jks -file jira.crt

7. Verify if the certificate exists within the keystore.

   <JAVA_HOME>/keytool -list -alias jira -keystore <Jira_HOME>/jira.jks

   This must be a PrivateKeyEntry. If it isn't, the certificate setup hasn't been completed successfully. For example:

   jira, Jan 1, 1970, PrivateKeyEntry,
   Certificate fingerprint (MD5): 73:68:CF:90:A8:1D:90:5B:CE:2A:2F:29:21:C6:B8:25

ステップ 2.Keystore で Tomcat を更新する

1. 編集する前に、<Jira_INSTALL>/conf/server.xml のバックアップを作成します。

2. HTTPS コネクタを編集し、キーストアを示すパラメーターを含めます。

   <Connector relaxedPathChars="[]|" relaxedQueryChars="[]|{}^\`"<>" port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
                 maxHttpHeaderSize="8192" SSLEnabled="true"
                 maxThreads="150" minSpareThreads="25"
                 enableLookups="false" disableUploadTimeout="true"
                 acceptCount="100" scheme="https" secure="true"
                 sslEnabledProtocols="TLSv1.2,TLSv1.3"
                 clientAuth="false" useBodyEncodingForURI="true"
                 keyAlias="jira" keystoreFile="<Jira_HOME>/jira.jks" keystorePass="changeit" keystoreType="JKS"/>

   適切なパスを <Jira_HOME> に入力して、必要に応じてポートを変更します。

   If your organization doesn't support the latest TLS version, you can fall back to an earlier version. To do this, change:

   sslEnabledProtocols="TLSv1.2,TLSv1.3"

   to

   sslEnabledProtocols="TLSv1,TLSv1.1,TLSv1.2,TLSv1.3"

3. HTTP コネクタを編集し、HTTPS コネクタへリダイレクトするようにします。

   <Connector relaxedPathChars="[]|" relaxedQueryChars="[]|{}^\`"<>" acceptCount="100" connectionTimeout="20000" disableUploadTimeout="true" enableLookups="false" maxHttpHeaderSize="8192" maxThreads="150" minSpareThreads="25" port="8080" protocol="HTTP/1.1" redirectPort="<PORT_FROM_STEP_1>" useBodyEncodingForURI="true"/>

   Ensure that the <PORT_FROM_STEP_1> is changed to the appropriate value. In this example, it's 8443.

4. 変更を server.xml に保存します。

5. If redirection to HTTPS is used, which is recommended, edit the <Jira_INSTALL>/WEB-INF/web.xml file and add the following section at the end of the file, before the closing </web-app>. In this example, all URLs except attachments are redirected from HTTP to HTTPS:

   <security-constraint>
   	<web-resource-collection>
   		<web-resource-name>all-except-attachments</web-resource-name>
   		<url-pattern>*.jsp</url-pattern>
   		<url-pattern>*.jspa</url-pattern>
   		<url-pattern>/browse/*</url-pattern>
   		<url-pattern>/issues/*</url-pattern>
   	</web-resource-collection>
   	<user-data-constraint>
   		<transport-guarantee>CONFIDENTIAL</transport-guarantee>
   	</user-data-constraint>
   </security-constraint>

6. Save your changes and restart Jira.

You can also redirect users from HTTP URLs to HTTPS URLs by choosing the HTTP & HTTPS profile in the Jira configuration tool. 

If you want to only redirect certain pages to HTTPS, you should this manually.

1. Select the HTTPS only profile in the Jira configuration tool and save the configuration.
2. Create an htaccess file on your web server that will redirect the HTTP URLs to the corresponding HTTPS URLs.

トラブルシューティング

上記にある通り Portecle を用いて生成した自己署名キーを使用する場合の、トラブルシューティングの TIPS をいくつか紹介します。

When you enter https://localhost:<port number> in your browser and get a message like "Cannot establish a connection to the server at localhost:8443", look for error messages in your logs/catalina.out log file. Here are some possible errors with explanations.