Apache Tomcat 9

These steps assume that the server has already been configured to act as a domain controller. Configuration of a Windows server as a domain controller is outside the scope of this how-to. The steps to configure the domain controller to enable Tomcat to support Windows authentication are as follows:

• Create a domain user that will be mapped to the service name used by the Tomcat server. In this how-to, this user is called tc01 and has a password of tc01pass.
• Map the service principal name (SPN) to the user account. SPNs take the form <service class>/<host>:<port>/<service name>. The SPN used in this how-to is HTTP/win-tc01.dev.local. To map the user to the SPN, run the following:

  setspn -A HTTP/win-tc01.dev.local tc01

• Generate the keytab file that the Tomcat server will use to authenticate itself to the domain controller. This file contains the Tomcat private key for the service provider account and should be protected accordingly. To generate the file, run the following command (all on a single line):

  ktpass /out c:\tomcat.keytab /mapuser [email protected]
            /princ HTTP/[email protected]
            /pass tc01pass /kvno 0

• Create a domain user to be used on the client. In this how-to the domain user is test with a password of testpass.

The above steps have been tested on a domain controller running Windows Server 2019 Standard using the Windows Server 2016 functional level for both the forest and the domain.

These steps assume that Tomcat and an appropriate Java JDK/JRE have already been installed and configured and that Tomcat is running as the [email protected] user. The steps to configure the Tomcat instance for Windows authentication are as follows:

• Copy the tomcat.keytab file created on the domain controller to $CATALINA_BASE/conf/tomcat.keytab.
• Create the kerberos configuration file $CATALINA_BASE/conf/krb5.ini. The file used in this how-to contained:

  [libdefaults]
  default_realm = DEV.LOCAL
  default_keytab_name = FILE:c:\apache-tomcat-9.0.x\conf\tomcat.keytab
  default_tkt_enctypes = rc4-hmac,aes256-cts-hmac-sha1-96,aes128-cts-hmac-sha1-96
  default_tgs_enctypes = rc4-hmac,aes256-cts-hmac-sha1-96,aes128-cts-hmac-sha1-96
  forwardable=true
  
  [realms]
  DEV.LOCAL = {
          kdc = win-dc01.dev.local:88
  }
  
  [domain_realm]
  dev.local= DEV.LOCAL
  .dev.local= DEV.LOCAL

  The location of this file can be changed by setting the java.security.krb5.conf system property.
• Create the JAAS login configuration file $CATALINA_BASE/conf/jaas.conf. The file used in this how-to contained:

  com.sun.security.jgss.krb5.initiate {
      com.sun.security.auth.module.Krb5LoginModule required
      doNotPrompt=true
      principal="HTTP/[email protected]"
      useKeyTab=true
      keyTab="c:/apache-tomcat-9.0.x/conf/tomcat.keytab"
      storeKey=true;
  };
  
  com.sun.security.jgss.krb5.accept {
      com.sun.security.auth.module.Krb5LoginModule required
      doNotPrompt=true
      principal="HTTP/[email protected]"
      useKeyTab=true
      keyTab="c:/apache-tomcat-9.0.x/conf/tomcat.keytab"
      storeKey=true;
  };

  The location of this file can be changed by setting the java.security.auth.login.config system property. The LoginModule used is a JVM specific one so ensure that the LoginModule specified matches the JVM being used. The name of the login configuration must match the value used by the authentication valve.

The SPNEGO authenticator will work with any Realm but if used with the JNDI Realm, by default the JNDI Realm will use the user's delegated credentials to connect to the Active Directory. If only the authenticated user name is required then the AuthenticatedUserRealm may be used that will simply return a Principal based on the authenticated user name that does not have any roles.

The above steps have been tested on a Tomcat server running Windows Server 2019 Standard with AdoptOpenJDK 8u232-b09 (64-bit).

This was tested with:

• Java 1.7.0, update 45, 64-bit
• Ubuntu Server 12.04.3 LTS 64-bit
• Tomcat 8.0.x (r1546570)

It should work with any Tomcat release although it is recommended that the latest stable release is used.

The configuration is the same as for Windows but with the following changes:

• The Linux server does not have to be part of the Windows domain.
• The path to the keytab file in krb5.ini and jaas.conf should be updated to reflect the path to the keytab file on the Linux server using Linux style file paths (e.g. /usr/local/tomcat/...).

The web application needs to be configured to the use Tomcat specific authentication method of SPNEGO (rather than BASIC etc.) in web.xml. As with the other authenticators, behaviour can be customised by explicitly configuring the authentication valve and setting attributes on the Valve.

The client must be configured to use Kerberos authentication. For Internet Explorer this means making sure that the Tomcat instance is in the "Local intranet" security domain and that it is configured (Tools > Internet Options > Advanced) with integrated Windows authentication enabled. Note that this will not work if you use the same machine for the client and the Tomcat instance as Internet Explorer will use the unsupported NTLM protocol.

Correctly configuring Kerberos authentication can be tricky. The following references may prove helpful. Advice is also always available from the Tomcat users mailing list.

1. IIS and Kerberos
2. SPNEGO project at SourceForge
3. Oracle Java GSS-API tutorial (Java 7)
4. Oracle Java GSS-API tutorial - Troubleshooting (Java 7)
5. Geronimo configuration for Windows authentication
6. Encryption Selection in Kerberos Exchanges
7. Supported Kerberos Cipher Suites

Full details of this solution can be found through the Waffle web site. The key features are:

• Drop-in solution
• Simple configuration (no JAAS or Kerberos keytab configuration required)
• Uses a native library

Full details of this solution can be found through the Kerberos extension web site. The key features are:

• Extension to Spring Security
• Requires a Kerberos keytab file to be generated
• Pure Java solution

Full details of this solution can be found through the project web site. The key features are:

• Pure Java solution
• Advanced Active Directory integration

Full details of this solution can be found through the project site. The key features are:

• Pure Java solution
• SPNEGO/Kerberos Authenticator
• Active Directory Realm

There are three steps to configuring IIS to provide Windows authentication. They are:

1. Configure IIS as a reverse proxy for Tomcat (see the IIS Web Server How-To).
2. Configure IIS to use Windows authentication
3. Configure Tomcat to use the authentication user information from IIS by setting the tomcatAuthentication attribute on the AJP connector to false. Alternatively, set the tomcatAuthorization attribute to true to allow IIS to authenticate, while Tomcat performs the authorization.

Apache httpd does not support Windows authentication out of the box but there are a number of third-party modules that can be used. These include:

1. mod_auth_sspi for use on Windows platforms.
2. mod_auth_ntlm_winbind for non-Windows platforms. Known to work with httpd 2.0.x on 32-bit platforms. Some users have reported stability issues with both httpd 2.2.x builds and 64-bit Linux builds.

There are three steps to configuring httpd to provide Windows authentication. They are:

1. Configure httpd as a reverse proxy for Tomcat (see the Apache httpd Web Server How-To).
2. Configure httpd to use Windows authentication
3. Configure Tomcat to use the authentication user information from httpd by setting the tomcatAuthentication attribute on the AJP connector to false.