jenkins.security

Class BasicHeaderApiTokenAuthenticator

java.lang.Object

jenkins.security.BasicHeaderAuthenticator

jenkins.security.BasicHeaderApiTokenAuthenticator

All Implemented Interfaces:

ExtensionPoint

@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 and Description
BasicHeaderApiTokenAuthenticator()

Method Summary

Modifier and Type	Method and Description
org.acegisecurity.Authentication	authenticate(javax.servlet.http.HttpServletRequest req, javax.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.

Methods inherited from class jenkins.security.BasicHeaderAuthenticator

all

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHeaderApiTokenAuthenticator

public BasicHeaderApiTokenAuthenticator()

Method Detail

authenticate

public org.acegisecurity.Authentication authenticate(javax.servlet.http.HttpServletRequest req,
                                                     javax.servlet.http.HttpServletResponse rsp,
                                                     String username,
                                                     String password)
                                              throws javax.servlet.ServletException

Description copied from class: BasicHeaderAuthenticator

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.

Specified by:

authenticate in class BasicHeaderAuthenticator

Throws:

javax.servlet.ServletException