org.eclipse.jetty.ee8.security.DefaultAuthenticatorFactory Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.ee8.security;
import java.util.Collection;
import javax.servlet.ServletContext;
import org.eclipse.jetty.ee8.security.Authenticator.AuthConfiguration;
import org.eclipse.jetty.ee8.security.authentication.BasicAuthenticator;
import org.eclipse.jetty.ee8.security.authentication.ConfigurableSpnegoAuthenticator;
import org.eclipse.jetty.ee8.security.authentication.DeferredAuthentication;
import org.eclipse.jetty.ee8.security.authentication.DigestAuthenticator;
import org.eclipse.jetty.ee8.security.authentication.FormAuthenticator;
import org.eclipse.jetty.ee8.security.authentication.LoginAuthenticator;
import org.eclipse.jetty.ee8.security.authentication.SessionAuthentication;
import org.eclipse.jetty.ee8.security.authentication.SslClientCertAuthenticator;
import org.eclipse.jetty.security.IdentityService;
import org.eclipse.jetty.security.LoginService;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.util.ssl.SslContextFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The Default Authenticator Factory.
* Uses the {@link AuthConfiguration#getAuthMethod()} to select an {@link Authenticator} from:
* - {@link BasicAuthenticator}
* - {@link DigestAuthenticator}
* - {@link FormAuthenticator}
* - {@link SslClientCertAuthenticator}
*
* All authenticators derived from {@link LoginAuthenticator} are
* wrapped with a {@link DeferredAuthentication}
* instance, which is used if authentication is not mandatory.
*
* The Authentications from the {@link FormAuthenticator} are always wrapped in a
* {@link SessionAuthentication}
*
* If a {@link LoginService} has not been set on this factory, then
* the service is selected by searching the {@link Server#getBeans(Class)} results for
* a service that matches the realm name, else the first LoginService found is used.
*/
public class DefaultAuthenticatorFactory implements Authenticator.Factory {
private static final Logger LOG = LoggerFactory.getLogger(DefaultAuthenticatorFactory.class);
private LoginService _loginService;
@Override
public Authenticator getAuthenticator(Server server, ServletContext context, AuthConfiguration configuration, IdentityService identityService, LoginService loginService) {
String auth = configuration.getAuthMethod();
Authenticator authenticator = null;
if (Authenticator.BASIC_AUTH.equalsIgnoreCase(auth))
authenticator = new BasicAuthenticator();
else if (Authenticator.DIGEST_AUTH.equalsIgnoreCase(auth))
authenticator = new DigestAuthenticator();
else if (Authenticator.FORM_AUTH.equalsIgnoreCase(auth))
authenticator = new FormAuthenticator();
else if (Authenticator.SPNEGO_AUTH.equalsIgnoreCase(auth))
authenticator = new ConfigurableSpnegoAuthenticator();
else if (// see Bug #377076
Authenticator.NEGOTIATE_AUTH.equalsIgnoreCase(auth))
authenticator = new ConfigurableSpnegoAuthenticator(Authenticator.NEGOTIATE_AUTH);
if (Authenticator.CERT_AUTH.equalsIgnoreCase(auth) || Authenticator.CERT_AUTH2.equalsIgnoreCase(auth)) {
Collection sslContextFactories = server.getBeans(SslContextFactory.Server.class);
if (sslContextFactories.size() != 1) {
if (sslContextFactories.size() > 1)
LOG.info("Multiple SslContextFactory.Server instances discovered. Directly configure a SslClientCertAuthenticator to use one.");
else
LOG.debug("No SslContextFactory.Server instances discovered. Directly configure a SslClientCertAuthenticator to use one.");
} else {
authenticator = new SslClientCertAuthenticator(sslContextFactories.iterator().next());
}
}
return authenticator;
}
/**
* Get the loginService.
* @return the loginService
*/
public LoginService getLoginService() {
return _loginService;
}
/**
* Set the loginService to set.
* @param loginService the loginService to set
*/
public void setLoginService(LoginService loginService) {
_loginService = loginService;
}
}