org.jenkinsci.plugins

Class KeycloakSecurityRealm

java.lang.Object

hudson.model.AbstractDescribableImpl<hudson.security.SecurityRealm>

hudson.security.SecurityRealm

org.jenkinsci.plugins.KeycloakSecurityRealm

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.security.SecurityRealm>

public class KeycloakSecurityRealm
extends hudson.security.SecurityRealm

Implementation of the AbstractPasswordBasedSecurityRealm that uses keycloak oauth for sso. This is based on the MySQLSecurityRealm from the mysql-auth-plugin written by Alex Ackerman.

Author:

Mohammad Nadeem, devlauer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeycloakSecurityRealm.DescriptorImpl Descriptor definition for Jenkins
static class	KeycloakSecurityRealm.ServletFacade

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

hudson.security.SecurityRealm.SecurityComponents

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_REQUESTED This constant is used to save the state of an authenticated session.
static String	JENKINS_FINISH_LOGIN_URL The default URL to finish the login process of this plugin

Fields inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
KeycloakSecurityRealm() Constructor

Method Summary

Modifier and Type	Method and Description
boolean	allowsSignup()
boolean	checkKeycloakOnEachRequest() Returns true if authentication should be checked on each response
hudson.security.SecurityRealm.SecurityComponents	createSecurityComponents()
org.kohsuke.stapler.HttpResponse	doCommenceLogin(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response, String referer)
org.kohsuke.stapler.HttpResponse	doFinishLogin(org.kohsuke.stapler.StaplerRequest request) This is where the user comes back to at the end of the OpenID redirect ping-pong.
void	doLogout(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
KeycloakSecurityRealm.DescriptorImpl	getDescriptor()
org.keycloak.adapters.KeycloakDeployment	getKeycloakDeployment() Returns the current KeycloakDeployment configuration.
String	getKeycloakJson() Returns the keycloak json configuration
String	getLoginUrl()
boolean	respectAccessTokenTimeout() Returns true if the access token should be only refreshed after its timeout

Methods inherited from class hudson.security.SecurityRealm

all, canLogOut, commenceSignup, createCliAuthenticator, createFilter, doCaptcha, findBean, getAuthenticationGatewayUrl, getCaptchaSupport, getCaptchaSupportDescriptors, getGroupIdStrategy, getPostLogOutUrl, getSecurityComponents, getUserIdStrategy, loadGroupByGroupname, loadGroupByGroupname, loadUserByUsername, setCaptchaSupport, validateCaptcha

Methods inherited from class java.lang.Object

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

Field Detail

JENKINS_FINISH_LOGIN_URL

public static final String JENKINS_FINISH_LOGIN_URL

The default URL to finish the login process of this plugin

See Also:

Constant Field Values

AUTH_REQUESTED

public static final String AUTH_REQUESTED

This constant is used to save the state of an authenticated session. If the login process starts it is set to true, if a logout process is initiated it is set to false.

See Also:

Constant Field Values

Constructor Detail

KeycloakSecurityRealm

@DataBoundConstructor
public KeycloakSecurityRealm()
                                             throws IOException

Constructor

Throws:

IOException - -

Method Detail

doCommenceLogin

public org.kohsuke.stapler.HttpResponse doCommenceLogin(org.kohsuke.stapler.StaplerRequest request,
                                                        org.kohsuke.stapler.StaplerResponse response,
                                                        @Header(value="Referer")
                                                        String referer)
                                                 throws IOException

Parameters:

request - the Jenkins request

response - the Jenkins response

referer - the referrer

Returns:

HttpResponse the response

Throws:

IOException

doFinishLogin

public org.kohsuke.stapler.HttpResponse doFinishLogin(org.kohsuke.stapler.StaplerRequest request)
                                               throws IOException

This is where the user comes back to at the end of the OpenID redirect ping-pong.

Parameters:

request - the Jenkins request

Returns:

HttpResponse the response

Throws:

IOException

allowsSignup

public boolean allowsSignup()

Overrides:

allowsSignup in class hudson.security.SecurityRealm

createSecurityComponents

public hudson.security.SecurityRealm.SecurityComponents createSecurityComponents()

Specified by:

createSecurityComponents in class hudson.security.SecurityRealm

getLoginUrl

public String getLoginUrl()

Overrides:

getLoginUrl in class hudson.security.SecurityRealm

doLogout

public void doLogout(org.kohsuke.stapler.StaplerRequest req,
                     org.kohsuke.stapler.StaplerResponse rsp)
              throws IOException,
                     javax.servlet.ServletException

Overrides:

doLogout in class hudson.security.SecurityRealm

Throws:

IOException

javax.servlet.ServletException

getDescriptor

public KeycloakSecurityRealm.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.security.SecurityRealm>

Overrides:

getDescriptor in class hudson.security.SecurityRealm

getKeycloakJson

public String getKeycloakJson()

Returns the keycloak json configuration

Returns:

String the json configuration

checkKeycloakOnEachRequest

public boolean checkKeycloakOnEachRequest()

Returns true if authentication should be checked on each response

Returns:

Boolean

respectAccessTokenTimeout

public boolean respectAccessTokenTimeout()

Returns true if the access token should be only refreshed after its timeout

Returns:

Boolean

getKeycloakDeployment

public org.keycloak.adapters.KeycloakDeployment getKeycloakDeployment()
                                                               throws IOException

Returns the current KeycloakDeployment configuration.

Returns:

KeycloakDeployment the keycloak configuration

Throws:

IOException