Package jenkins.security

Class BasicHeaderApiTokenAuthenticator

java.lang.Object

jenkins.security.BasicHeaderAuthenticator

jenkins.security.BasicHeaderApiTokenAuthenticator

All Implemented Interfaces:

ExtensionPoint

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Extension
public class BasicHeaderApiTokenAuthenticator
extends BasicHeaderAuthenticator

Checks if the password given in the BASIC header matches the user's API token.

Since:

1.576

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
BasicHeaderApiTokenAuthenticator()

Method Summary

Modifier and Type	Method	Description
org.springframework.security.core.Authentication	authenticate2(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse rsp, String username, String password)	Note: if the token does not exist or does not match, we do not use SecurityListener.fireFailedToAuthenticate(String) because it will be done in the BasicHeaderRealPasswordAuthenticator in the case the password is not valid either

Methods inherited from class jenkins.security.BasicHeaderAuthenticator

all, authenticate, authenticate2

Methods inherited from class java.lang.Object

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

Constructor Details

BasicHeaderApiTokenAuthenticator

public BasicHeaderApiTokenAuthenticator()

Method Details

authenticate2

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

Note: if the token does not exist or does not match, we do not use SecurityListener.fireFailedToAuthenticate(String) because it will be done in the BasicHeaderRealPasswordAuthenticator in the case the password is not valid either

Overrides:

authenticate2 in class BasicHeaderAuthenticator

Throws:

jakarta.servlet.ServletException