配置 HTTPS

Play can be configured to serve HTTPS. To enable this, simply tell Play which port to listen to using the https.port system property. For example:

./start -Dhttps.port=9443

提供配置

HTTPS configuration can either be supplied using system properties or in application.conf. For more details see the configuration and production configuration pages.

SSL 证书

来自keystore的SSL 证书

By default, Play will generate itself a self-signed certificate, however typically this will not be suitable for serving a website. Play uses Java key stores to configure SSL certificates and keys.

Signing authorities often provide instructions on how to create a Java keystore (typically with reference to Tomcat configuration). The official Oracle documentation on how to generate keystores using the JDK keytool utility can be found here. There is also an example in the Generating X.509 Certificates section.

Having created your keystore, the following configuration properties can be used to configure Play to use it:

• play.server.https.keyStore.path - The path to the keystore containing the private key and certificate, if not provided generates a keystore for you
• play.server.https.keyStore.type - The key store type, defaults to JKS
• play.server.https.keyStore.password - The password, defaults to a blank password
• play.server.https.keyStore.algorithm - The key store algorithm, defaults to the platforms default algorithm

来自自定义SSL引擎的SSL 证书

Another alternative to configure the SSL certificates is to provide a custom SSLEngine. This is also useful in cases where a customized SSLEngine is required, such as in the case of client authentication.

在 Java, 必须为play.server.SSLEngineProvider提供实现

import play.server.ApplicationProvider;
import play.server.SSLEngineProvider;

import javax.net.ssl.*;
import java.security.NoSuchAlgorithmException;

public class CustomSSLEngineProvider implements SSLEngineProvider {
    private ApplicationProvider applicationProvider;

    public CustomSSLEngineProvider(ApplicationProvider applicationProvider) {
        this.applicationProvider = applicationProvider;    
    }

    @Override
    public SSLEngine createSSLEngine() {
        try {
            // change it to your custom implementation
            return SSLContext.getDefault().createSSLEngine();
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException(e);
        }
    }
}

在 Scala, 必须为play.server.api.SSLEngineProvider提供实现

import javax.net.ssl._
import play.core.ApplicationProvider
import play.server.api._

class CustomSSLEngineProvider(appProvider: ApplicationProvider) extends SSLEngineProvider {

  override def createSSLEngine(): SSLEngine = {
    // change it to your custom implementation
    SSLContext.getDefault.createSSLEngine
  }

}

Having created an implementation for play.server.SSLEngineProvider or play.server.api.SSLEngineProvider, the following system property configures Play to use it:

• play.server.https.engineProvider - The path to the class implementing play.server.SSLEngineProvider or play.server.api.SSLEngineProvider: Example:

./start -Dhttps.port=9443 -Dplay.server.https.engineProvider=mypackage.CustomSSLEngineProvider

关闭 HTTP

To disable binding on the HTTP port, set the http.port system property to be disabled, eg:

./start -Dhttp.port=disabled -Dhttps.port=9443 -Dplay.server.https.keyStore.path=/path/to/keystore -Dplay.server.https.keyStore.password=changeme

HTTPS生产用例

If Play is serving HTTPS in production, it should be running JDK 1.8. JDK 1.8 provides a number of new features that make JSSE feasible as a TLS termination layer. If not using JDK 1.8, using a reverse proxy in front of Play will give better control and security of HTTPS.

If you intend to use Play for TLS termination layer, please note the following settings:

• SSLParameters.setUseCipherSuiteorder() - Reorders cipher suite order to the server’s preference.
• -Djdk.tls.ephemeralDHKeySize=2048 - Increases the key size in a DH key exchange.
• -Djdk.tls.rejectClientInitiatedRenegotiation=true - Rejects client renegotiation.