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, Steve Arch

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 wellKnownOpenIDConfigurationUrl, 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 endSessionEndpoint, String postLogoutRedirectUrl, boolean escapeHatchEnabled, String escapeHatchUsername, String escapeHatchSecret, String escapeHatchGroup, String automanualconfigure)

Method Summary

Modifier and Type	Method and Description
boolean	containsField(com.google.api.client.json.GenericJson payload, String field)
hudson.security.SecurityRealm.SecurityComponents	createSecurityComponents()
org.kohsuke.stapler.HttpResponse	doCommenceLogin(String from, String referer) Handles the the securityRealm/commenceLogin resource and sends the user off to the IdP
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	getAutomanualconfigure()
String	getClientId()
hudson.util.Secret	getClientSecret()
String	getEmailFieldName()
String	getEndSessionEndpoint()
String	getEscapeHatchGroup()
hudson.util.Secret	getEscapeHatchSecret()
String	getEscapeHatchUsername()
Object	getField(com.google.api.client.json.GenericJson payload, String field) Looks up the value of a field by it's key based on some json.
String	getFullNameFieldName()
String	getGroupsFieldName()
String	getLoginUrl()
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()
String	getWellKnownOpenIDConfigurationUrl()
boolean	isDisableSslVerification()
boolean	isEscapeHatchEnabled()
boolean	isLogoutFromOpenidProvider()

Methods inherited from class hudson.security.SecurityRealm

all, allowsSignup, canLogOut, commenceSignup, createCliAuthenticator, createFilter, doCaptcha, findBean, getCaptchaSupport, getCaptchaSupportDescriptors, getDescriptor, getFrom, 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 wellKnownOpenIDConfigurationUrl,
                                              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 endSessionEndpoint,
                                              String postLogoutRedirectUrl,
                                              boolean escapeHatchEnabled,
                                              String escapeHatchUsername,
                                              String escapeHatchSecret,
                                              String escapeHatchGroup,
                                              String automanualconfigure)
                                       throws IOException

Throws:

IOException

Method Detail

getClientId

public String getClientId()

getClientSecret

public hudson.util.Secret getClientSecret()

getWellKnownOpenIDConfigurationUrl

public String getWellKnownOpenIDConfigurationUrl()

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

getEndSessionEndpoint

public String getEndSessionEndpoint()

getPostLogoutRedirectUrl

public String getPostLogoutRedirectUrl()

isEscapeHatchEnabled

public boolean isEscapeHatchEnabled()

getEscapeHatchUsername

public String getEscapeHatchUsername()

getEscapeHatchSecret

public hudson.util.Secret getEscapeHatchSecret()

getEscapeHatchGroup

public String getEscapeHatchGroup()

getAutomanualconfigure

public String getAutomanualconfigure()

getLoginUrl

public String getLoginUrl()

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)

Handles the the securityRealm/commenceLogin resource and sends the user off to the IdP

Parameters:

from - the relative URL to the page that the user has just come from

referer - the HTTP referer header (where to redirect the user back to after login has finished)

Returns:

an HttpResponse object

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)

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

Parameters:

request - The user's request

Returns:

an HttpResponse

getField

public Object getField(com.google.api.client.json.GenericJson payload,
                       String field)

Looks up the value of a field by it's key based on some json. keys with dot notation allow to denote nested structures. Keys containing dot's take precedence over nested values, by using " one can denote (partly) nested structures. dot notation feels more natural but '"' is the only illegal character in json strings given: { "do": { "re.mi": "a" }, "do": { "re": { "mi": "b" } }, "do.re": { "mi": "c" } "do.re.mi": "d", } 'do.re.mi' -&gt; 'd' 'do"re.mi' -> 'a' 'do"re"mi' -> 'b' 'do.re"mi' -> 'c'

Parameters:

payload - json payload to search

field - field key

Returns:

value or null

containsField

public boolean containsField(com.google.api.client.json.GenericJson payload,
                             String field)

Parameters:

payload - parsed json

field - to lookup a value

Returns:

true if there is a value associated with the field

See Also:

getField(GenericJson, String)