Package io.jenkins.plugins.jwt_auth

Class JwtAuthSecurityRealm

java.lang.Object

hudson.model.AbstractDescribableImpl<SecurityRealm>

hudson.security.SecurityRealm

io.jenkins.plugins.jwt_auth.JwtAuthSecurityRealm

All Implemented Interfaces:

ExtensionPoint, Describable<SecurityRealm>

public class JwtAuthSecurityRealm
extends SecurityRealm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwtAuthSecurityRealm.DescriptorImpl	Descriptor for help and so on..

Nested classes/interfaces inherited from class hudson.security.SecurityRealm

SecurityRealm.SecurityComponents

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
org.jose4j.keys.resolvers.HttpsJwksVerificationKeyResolver	jwksResolver	jwks resolver
Hashtable<String,List<org.springframework.security.core.GrantedAuthority>>	userToGroupsCache	map from username to groups

Fields inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, AUTHENTICATED_AUTHORITY2, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor	Description
JwtAuthSecurityRealm(String headerName, String userClaimName, String groupsClaimName, String groupsClaimSeparator, String acceptedIssuer, String acceptedAudience, String jwksUrl, int leewaySeconds, boolean allowVerificationFailures, String emailClaimName, String fullNameClaim)

Method Summary

Modifier and Type	Method	Description
boolean	allowsSignup()
boolean	canLogOut()
javax.servlet.Filter	createFilter(javax.servlet.FilterConfig filterConfig)	Our filter
SecurityRealm.SecurityComponents	createSecurityComponents()	this does not actually do anything as we only use the filter based auth
String	getAcceptedAudience()
String	getAcceptedIssuer()
JwtAuthSecurityRealm.DescriptorImpl	getDescriptor()
String	getEmailClaimName()
String	getFullNameClaim()
String	getGroupsClaimName()
String	getGroupsClaimSeparator()
String	getHeaderName()	getters
String	getJwksUrl()
int	getLeewaySeconds()
String	getUserClaimName()
boolean	isAllowVerificationFailures()
org.springframework.security.core.userdetails.UserDetails	loadUserByUsername2(String username)

Methods inherited from class hudson.security.SecurityRealm

all, commenceSignup, commonFilters, createCliAuthenticator, doCaptcha, doLogout, getAuthenticationGatewayUrl, getCaptchaSupport, getCaptchaSupportDescriptors, getFrom, getGroupIdStrategy, getLoginUrl, getPostLogOutUrl, getPostLogOutUrl2, getSecurityComponents, getUserIdStrategy, loadGroupByGroupname, loadGroupByGroupname, loadGroupByGroupname2, loadUserByUsername, setCaptchaSupport, validateCaptcha

Methods inherited from class java.lang.Object

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

Field Detail

userToGroupsCache

public transient Hashtable<String,List<org.springframework.security.core.GrantedAuthority>> userToGroupsCache

map from username to groups

jwksResolver

public transient org.jose4j.keys.resolvers.HttpsJwksVerificationKeyResolver jwksResolver

jwks resolver

Constructor Detail

JwtAuthSecurityRealm

@DataBoundConstructor
public JwtAuthSecurityRealm(String headerName,
                            String userClaimName,
                            String groupsClaimName,
                            String groupsClaimSeparator,
                            String acceptedIssuer,
                            String acceptedAudience,
                            String jwksUrl,
                            int leewaySeconds,
                            boolean allowVerificationFailures,
                            String emailClaimName,
                            String fullNameClaim)

Method Detail

createSecurityComponents

public SecurityRealm.SecurityComponents createSecurityComponents()

this does not actually do anything as we only use the filter based auth

Specified by:

createSecurityComponents in class SecurityRealm

Returns:

default component

loadUserByUsername2

public org.springframework.security.core.userdetails.UserDetails loadUserByUsername2(String username)
                                                                              throws org.springframework.security.core.userdetails.UsernameNotFoundException

Overrides:

loadUserByUsername2 in class SecurityRealm

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException

allowsSignup

public boolean allowsSignup()

Overrides:

allowsSignup in class SecurityRealm

canLogOut

public boolean canLogOut()

Overrides:

canLogOut in class SecurityRealm

createFilter

public javax.servlet.Filter createFilter(javax.servlet.FilterConfig filterConfig)

Our filter

Overrides:

createFilter in class SecurityRealm

getDescriptor

public JwtAuthSecurityRealm.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<SecurityRealm>

Overrides:

getDescriptor in class SecurityRealm

getHeaderName

public String getHeaderName()

getters

getUserClaimName

public String getUserClaimName()

getGroupsClaimName

public String getGroupsClaimName()

getGroupsClaimSeparator

public String getGroupsClaimSeparator()

getAcceptedIssuer

public String getAcceptedIssuer()

getAcceptedAudience

public String getAcceptedAudience()

getJwksUrl

public String getJwksUrl()

getLeewaySeconds

public int getLeewaySeconds()

isAllowVerificationFailures

public boolean isAllowVerificationFailures()

getEmailClaimName

public String getEmailClaimName()

getFullNameClaim

public String getFullNameClaim()