Package jenkins.security

Class BasicHeaderAuthenticator

java.lang.Object

jenkins.security.BasicHeaderAuthenticator

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

BasicHeaderApiTokenAuthenticator, BasicHeaderRealPasswordAuthenticator

public abstract class BasicHeaderAuthenticator
extends Object
implements ExtensionPoint

When Jenkins receives HTTP basic authentication, this hook will validate the username/password pair.

Since:

1.576

Author:

Kohsuke Kawaguchi

See Also:

• BasicHeaderProcessor

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BasicHeaderAuthenticator()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<BasicHeaderAuthenticator>	all()
Authentication	authenticate(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp, String username, String password)	Deprecated. use authenticate2(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)
org.springframework.security.core.Authentication	authenticate2(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse rsp, String username, String password)	Given the parsed username and password field from the basic authentication header, determine the effective security credential to process the request with.
org.springframework.security.core.Authentication	authenticate2(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse rsp, String username, String password)	Deprecated. use authenticate2(HttpServletRequest, HttpServletResponse, String, String)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicHeaderAuthenticator

public BasicHeaderAuthenticator()

Method Details

authenticate2

@CheckForNull
public org.springframework.security.core.Authentication authenticate2(jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse rsp,
 String username,
 String password)
                                                               throws IOException,
jakarta.servlet.ServletException

Given the parsed username and password field from the basic authentication header, determine the effective security credential to process the request with.

The method must return null if the password or username didn't match what's expected. When null is returned, other authenticators will get a chance to process the request. This is necessary because Jenkins accepts both real password as well as API tokens for the password.

In contrast, when an exception is thrown the request processing will fail immediately without providing a chance for other authenticators to process the request.

When no processor can validate the username/password pair, caller will make the request processing fail.

Throws:

IOException

jakarta.servlet.ServletException

Since:

2.475

authenticate2

@CheckForNull
@Deprecated
public org.springframework.security.core.Authentication authenticate2(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse rsp,
 String username,
 String password)
                                                               throws IOException,
javax.servlet.ServletException

Deprecated.

use authenticate2(HttpServletRequest, HttpServletResponse, String, String)

Throws:

IOException

javax.servlet.ServletException

Since:

2.266

authenticate

@Deprecated
@CheckForNull
public Authentication authenticate(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse rsp,
 String username,
 String password)
                            throws IOException,
javax.servlet.ServletException

Deprecated.

use authenticate2(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.lang.String, java.lang.String)

Throws:

IOException

javax.servlet.ServletException

all

public static ExtensionList<BasicHeaderAuthenticator> all()