Top Description Fields Constructors Methods
org.eclipse.jetty.security.authentication

public Class SslClientCertAuthenticator

extends LoginAuthenticator
Class Inheritance
Imports
java.security.Principal, java.security.cert.X509Certificate, java.util.Base64, .Objects, org.eclipse.jetty.http.HttpStatus, org.eclipse.jetty.io.EndPoint, org.eclipse.jetty.security.AuthenticationState, .Authenticator, .ServerAuthException, .UserIdentity, org.eclipse.jetty.server.Request, .Response, org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.ssl.SslContextFactory
CLIENT-CERT authenticator.

This Authenticator implements client certificate authentication. The client certificates available in the request will be verified against the configured SslContextFactory instance

Field Summary

Modifier and TypeField and Description
private final SslContextFactory
sslContextFactory

private boolean
validateCerts

Inherited from org.eclipse.jetty.security.authentication.LoginAuthenticator:
_identityService_loginService

Constructor Summary

AccessConstructor and Description
public
SslClientCertAuthenticator(SslContextFactory sslContextFactory)

Method Summary

Modifier and TypeMethod and Description
public String
getAuthenticationType()

Implements org.eclipse.jetty.security.Authenticator.getAuthenticationType.

public boolean

Returns:

true if SSL certificate has to be validated.
isValidateCerts()

public void
setValidateCerts(boolean
true if SSL certificates have to be validated.
validateCerts)

Set true if SSL certificates have to be validated..

public AuthenticationState
validateRequest(Request
The request
req, Response
The response
res, Callback
the callback to use for writing a response
callback)

Implements org.eclipse.jetty.security.Authenticator.validateRequest.

Validate a request
Inherited from org.eclipse.jetty.security.authentication.LoginAuthenticator:
getLoginServiceloginlogoutsetConfigurationupdateSession

Field Detail

sslContextFactoryback to summary
private final SslContextFactory sslContextFactory
validateCertsback to summary
private boolean validateCerts

Constructor Detail

SslClientCertAuthenticatorback to summary
public SslClientCertAuthenticator(SslContextFactory sslContextFactory)

Method Detail

getAuthenticationTypeback to summary
public String getAuthenticationType()

Implements org.eclipse.jetty.security.Authenticator.getAuthenticationType.

Returns:String

Doc from org.eclipse.jetty.security.Authenticator.getAuthenticationType.

The name of the authentication type

Annotations
@Override
isValidateCertsback to summary
public boolean isValidateCerts()
Returns:boolean

true if SSL certificate has to be validated.

setValidateCertsback to summary
public void setValidateCerts(boolean validateCerts)

Set true if SSL certificates have to be validated..

Parameters
validateCerts:boolean

true if SSL certificates have to be validated.

validateRequestback to summary
public AuthenticationState validateRequest(Request req, Response res, Callback callback) throws ServerAuthException

Implements org.eclipse.jetty.security.Authenticator.validateRequest.

Doc from org.eclipse.jetty.security.Authenticator.validateRequest.

Validate a request

Parameters
req:Request

The request

res:Response

The response

callback:Callback

the callback to use for writing a response

Returns:AuthenticationState

An Authentication. If Authentication is successful, this will be a Succeeded. If a response has been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will implement AuthenticationState.ResponseSent.

Annotations
@Override
Exceptions
ServerAuthException:
if unable to validate request