io.jenkins.plugin.auth.jwt

Class JwtTokenVerifier

java.lang.Object

io.jenkins.plugin.auth.jwt.JwtTokenVerifier

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

JwtTokenVerifierImpl

public abstract class JwtTokenVerifier
extends Object
implements hudson.ExtensionPoint

If an incoming HTTP request contains JWT token, pick that up, verifies the integrity, then convert that into JwtTokenVerifierImpl.JwtAuthentication so that the rest of Jenkins can process this request with proper identity of the caller.

Author:

Vivek Pandey

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
JwtTokenVerifier()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<JwtTokenVerifier>	all()
abstract Optional<org.acegisecurity.Authentication>	getAuthenticationFromToken(String jwt)

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtTokenVerifier

public JwtTokenVerifier()

Method Detail

getAuthenticationFromToken

public abstract Optional<org.acegisecurity.Authentication> getAuthenticationFromToken(String jwt)
                                                                               throws ServiceException

Parameters:

jwt - Incoming JWT that we are trying to process

Returns:

The Authentication object for the user, or Optional.empty() if no user could be found or the JWT could not be verified. Optional.empty() should also be thrown if this JWT could not be verified (as it may be verified by a subsequent verifier)

Throws:

ServiceException - If the request should be explicitly denied for whatever reason. Throwing this exception will prevent all subsequent filters in the chain from executing and deny the web request, so only use this if you are certain that the JWT is not valid.

all

public static hudson.ExtensionList<JwtTokenVerifier> all()