org.jenkinsci.plugins.oic

Class OicSecurityRealm

java.lang.Object

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

hudson.security.SecurityRealm

org.jenkinsci.plugins.oic.OicSecurityRealm

All Implemented Interfaces:

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

public class OicSecurityRealm
extends hudson.security.SecurityRealm

Login with OpenID Connect / OAuth 2

Author:

Michael Bischoff

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OicSecurityRealm.DescriptorImpl

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

OicSecurityRealm(String clientId, String clientSecret, String tokenServerUrl, String authorizationServerUrl, String userInfoServerUrl, String userNameField, String tokenFieldToCheckKey, String tokenFieldToCheckValue, String fullNameFieldName, String emailFieldName, String scopes, String groupsFieldName, boolean disableSslVerification, boolean logoutFromOpenidProvider, String endSessionUrl, String postLogoutRedirectUrl, boolean escapeHatchEnabled, String escapeHatchUsername, String escapeHatchSecret, String escapeHatchGroup)

Method Summary

Modifier and Type	Method and Description
hudson.security.SecurityRealm.SecurityComponents	createSecurityComponents()
org.kohsuke.stapler.HttpResponse	doCommenceLogin(String from, String referer) handles the the securityRealm/commenceLogin resource
org.kohsuke.stapler.HttpResponse	doEscapeHatch(String username, String password)
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)
String	getAuthenticationGatewayUrl()
String	getAuthorizationServerUrl()
String	getClientId()
hudson.util.Secret	getClientSecret()
String	getEmailFieldName()
String	getEndSessionUrl()
String	getEscapeHatchGroup()
hudson.util.Secret	getEscapeHatchSecret()
String	getEscapeHatchUsername()
String	getFullNameFieldName()
String	getGroupsFieldName()
String	getLoginUrl() Login begins with our doCommenceLogin(String,String) method.
String	getPostLogoutRedirectUrl()
String	getPostLogOutUrl(org.kohsuke.stapler.StaplerRequest req, org.acegisecurity.Authentication auth)
String	getScopes()
String	getTokenFieldToCheckKey()
String	getTokenFieldToCheckValue()
String	getTokenServerUrl()
String	getUserInfoServerUrl()
String	getUserNameField()
boolean	isDisableSslVerification()
boolean	isEscapeHatchEnabled()
boolean	isLogoutFromOpenidProvider()

Methods inherited from class hudson.security.SecurityRealm

all, allowsSignup, canLogOut, commenceSignup, createCliAuthenticator, createFilter, doCaptcha, findBean, getCaptchaSupport, getCaptchaSupportDescriptors, getDescriptor, getGroupIdStrategy, 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

OicSecurityRealm

@DataBoundConstructor
public OicSecurityRealm(String clientId,
                                              String clientSecret,
                                              String tokenServerUrl,
                                              String authorizationServerUrl,
                                              String userInfoServerUrl,
                                              String userNameField,
                                              String tokenFieldToCheckKey,
                                              String tokenFieldToCheckValue,
                                              String fullNameFieldName,
                                              String emailFieldName,
                                              String scopes,
                                              String groupsFieldName,
                                              boolean disableSslVerification,
                                              boolean logoutFromOpenidProvider,
                                              String endSessionUrl,
                                              String postLogoutRedirectUrl,
                                              boolean escapeHatchEnabled,
                                              String escapeHatchUsername,
                                              String escapeHatchSecret,
                                              String escapeHatchGroup)
                                       throws IOException

Throws:

IOException

Method Detail

getClientId

public String getClientId()

getClientSecret

public hudson.util.Secret getClientSecret()

getTokenServerUrl

public String getTokenServerUrl()

getAuthorizationServerUrl

public String getAuthorizationServerUrl()

getUserInfoServerUrl

public String getUserInfoServerUrl()

getUserNameField

public String getUserNameField()

getTokenFieldToCheckKey

public String getTokenFieldToCheckKey()

getTokenFieldToCheckValue

public String getTokenFieldToCheckValue()

getFullNameFieldName

public String getFullNameFieldName()

getEmailFieldName

public String getEmailFieldName()

getGroupsFieldName

public String getGroupsFieldName()

getScopes

public String getScopes()

isDisableSslVerification

public boolean isDisableSslVerification()

isLogoutFromOpenidProvider

public boolean isLogoutFromOpenidProvider()

getEndSessionUrl

public String getEndSessionUrl()

getPostLogoutRedirectUrl

public String getPostLogoutRedirectUrl()

isEscapeHatchEnabled

public boolean isEscapeHatchEnabled()

getEscapeHatchUsername

public String getEscapeHatchUsername()

getEscapeHatchSecret

public hudson.util.Secret getEscapeHatchSecret()

getEscapeHatchGroup

public String getEscapeHatchGroup()

getLoginUrl

public String getLoginUrl()

Login begins with our doCommenceLogin(String,String) method.

Overrides:

getLoginUrl in class hudson.security.SecurityRealm

getAuthenticationGatewayUrl

public String getAuthenticationGatewayUrl()

Overrides:

getAuthenticationGatewayUrl in class hudson.security.SecurityRealm

createSecurityComponents

public hudson.security.SecurityRealm.SecurityComponents createSecurityComponents()

Specified by:

createSecurityComponents in class hudson.security.SecurityRealm

doCommenceLogin

public org.kohsuke.stapler.HttpResponse doCommenceLogin(@QueryParameter
                                                        String from,
                                                        @Header(value="Referer")
                                                        String referer)
                                                 throws IOException

handles the the securityRealm/commenceLogin resource

Throws:

IOException

doEscapeHatch

public org.kohsuke.stapler.HttpResponse doEscapeHatch(@QueryParameter(value="j_username")
                                                      String username,
                                                      @QueryParameter(value="j_password")
                                                      String password)

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

getPostLogOutUrl

public String getPostLogOutUrl(org.kohsuke.stapler.StaplerRequest req,
                               org.acegisecurity.Authentication auth)

Overrides:

getPostLogOutUrl in class hudson.security.SecurityRealm

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