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
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 inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
KeycloakSecurityRealm()

Method Summary

Modifier and Type	Method and Description
boolean	allowsSignup()
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()
String	getKeycloakJson()
String	getLoginUrl()

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

Constructor Detail

KeycloakSecurityRealm

@DataBoundConstructor
public KeycloakSecurityRealm()
                                             throws IOException

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

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.

Throws:

IOException

org.keycloak.adapters.ServerRequest.HttpFailure

org.keycloak.common.VerificationException

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()