Package de.theit.jenkins.crowd

Class CrowdSecurityRealm

java.lang.Object

hudson.model.AbstractDescribableImpl<SecurityRealm>

hudson.security.SecurityRealm

hudson.security.AbstractPasswordBasedSecurityRealm

de.theit.jenkins.crowd.CrowdSecurityRealm

All Implemented Interfaces:

ExtensionPoint, Describable<SecurityRealm>

public class CrowdSecurityRealm
extends AbstractPasswordBasedSecurityRealm

This class provides the security realm for authenticating users against a remote Crowd server.

Since:

06.09.2011

Version:

$Id$

Author:

Thorsten Heit (theit@gmx.de)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrowdSecurityRealm.CacheConfiguration
static final class	CrowdSecurityRealm.DescriptorImpl	Descriptor for CrowdSecurityRealm.

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
final String	applicationName	Contains the application name to access Crowd.
final String	cookieDomain	A domain to use when setting cookies, overriding the SSO Domain set in Crowd (since Crowd 2.5.2).
final String	cookieTokenkey	SSO cookie name for application.
final String	group	Contains the Crowd group to which a user must belong to.
final String	httpMaxConnections
final String	httpProxyHost
final Secret	httpProxyPassword
final String	httpProxyPort
final String	httpProxyUsername
final String	httpTimeout
final boolean	nestedGroups	Specifies whether nested groups can be used.
final Secret	password	Contains the application password to access Crowd.
final int	sessionValidationInterval	The number of minutes to cache authentication validation in the session.
final String	socketTimeout
final String	url	Contains the Crowd server URL.
final Boolean	useProxy
final boolean	useSSO	Don't use SSO, only REST API authentication.

Fields inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, AUTHENTICATED_AUTHORITY2, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor	Description
CrowdSecurityRealm(String url, String applicationName, Secret password, String group, boolean nestedGroups, int sessionValidationInterval, boolean useSSO, String cookieDomain, String cookieTokenkey, Boolean useProxy, String httpProxyHost, String httpProxyPort, String httpProxyUsername, Secret httpProxyPassword, String socketTimeout, String httpTimeout, String httpMaxConnections, CrowdSecurityRealm.CacheConfiguration cache)	Default constructor.
CrowdSecurityRealm(String url, String applicationName, String password, String group, boolean nestedGroups, int sessionValidationInterval, boolean useSSO, String cookieDomain, String cookieTokenkey, Boolean useProxy, String httpProxyHost, String httpProxyPort, String httpProxyUsername, String httpProxyPassword, String socketTimeout, String httpTimeout, String httpMaxConnections)	Deprecated. retained for backwards binary compatibility.
CrowdSecurityRealm(String url, String applicationName, String password, String group, boolean nestedGroups, int sessionValidationInterval, boolean useSSO, String cookieDomain, String cookieTokenkey, Boolean useProxy, String httpProxyHost, String httpProxyPort, String httpProxyUsername, String httpProxyPassword, String socketTimeout, String httpTimeout, String httpMaxConnections, CrowdSecurityRealm.CacheConfiguration cache)	Deprecated. retained for backwards binary compatibility.

Method Summary

Modifier and Type	Method	Description
protected org.springframework.security.core.userdetails.UserDetails	authenticate2(String pUsername, String pPassword)
javax.servlet.Filter	createFilter(javax.servlet.FilterConfig filterConfig)
SecurityRealm.SecurityComponents	createSecurityComponents()
void	doLogout(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)
CrowdSecurityRealm.CacheConfiguration	getCache()
Integer	getCacheSize()
Integer	getCacheTTL()
GroupDetails	loadGroupByGroupname(String groupname)	Deprecated. use AbstractPasswordBasedSecurityRealm.loadGroupByGroupname2(java.lang.String, boolean)
GroupDetails	loadGroupByGroupname(String groupname, boolean fetchMembers)	Deprecated. use AbstractPasswordBasedSecurityRealm.loadGroupByGroupname2(java.lang.String, boolean)
UserDetails	loadUserByUsername(String username)	Deprecated. use loadUserByUsername2(java.lang.String)
org.springframework.security.core.userdetails.UserDetails	loadUserByUsername2(String username)

Methods inherited from class hudson.security.AbstractPasswordBasedSecurityRealm

authenticate, loadGroupByGroupname2

Methods inherited from class hudson.security.SecurityRealm

all, allowsSignup, canLogOut, commenceSignup, commonFilters, createCliAuthenticator, doCaptcha, getAuthenticationGatewayUrl, getCaptchaSupport, getCaptchaSupportDescriptors, getDescriptor, getFrom, getGroupIdStrategy, getLoginUrl, getPostLogOutUrl, getPostLogOutUrl2, getSecurityComponents, getUserIdStrategy, setCaptchaSupport, validateCaptcha

Methods inherited from class java.lang.Object

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

Field Details

url

public final String url

Contains the Crowd server URL.

applicationName

public final String applicationName

Contains the application name to access Crowd.

password

public final Secret password

Contains the application password to access Crowd.

group

public final String group

Contains the Crowd group to which a user must belong to.

nestedGroups

public final boolean nestedGroups

Specifies whether nested groups can be used.

useSSO

public final boolean useSSO

Don't use SSO, only REST API authentication.

sessionValidationInterval

public final int sessionValidationInterval

The number of minutes to cache authentication validation in the session. If this value is set to 0, each HTTP request will be authenticated with the Crowd server.

cookieDomain

public final String cookieDomain

A domain to use when setting cookies, overriding the SSO Domain set in Crowd (since Crowd 2.5.2). cookie.domain details

cookieTokenkey

public final String cookieTokenkey

SSO cookie name for application. cookie.tokenkey details

useProxy

public final Boolean useProxy

httpProxyHost

public final String httpProxyHost

httpProxyPort

public final String httpProxyPort

httpProxyUsername

public final String httpProxyUsername

httpProxyPassword

public final Secret httpProxyPassword

socketTimeout

public final String socketTimeout

httpTimeout

public final String httpTimeout

httpMaxConnections

public final String httpMaxConnections

Constructor Details

CrowdSecurityRealm

@DataBoundConstructor
public CrowdSecurityRealm(String url,
 String applicationName,
 Secret password,
 String group,
 boolean nestedGroups,
 int sessionValidationInterval,
 boolean useSSO,
 String cookieDomain,
 String cookieTokenkey,
 Boolean useProxy,
 String httpProxyHost,
 String httpProxyPort,
 String httpProxyUsername,
 Secret httpProxyPassword,
 String socketTimeout,
 String httpTimeout,
 String httpMaxConnections,
 CrowdSecurityRealm.CacheConfiguration cache)

Default constructor. Fields in config.jelly must match the parameter names in the "DataBoundConstructor".

Parameters:

url - The URL for Crowd.

applicationName - The application name.

password - The application password.

group - The group to which users must belong to. If this parameter is not specified, a users group membership will not be checked.

nestedGroups - true when nested groups may be used. false else.

sessionValidationInterval - The number of minutes to cache authentication validation in the session. If this value is set to 0, each HTTP request will be authenticated with the Crowd server.

useSSO - Enable SSO authentication.

cookieDomain - The cookie domain

cookieTokenkey - The cookie token key

useProxy - Specifies if a proxy should be used

httpProxyHost - The http proxy host

httpProxyPort - The http proxy port

httpProxyUsername - The http proxy username

httpProxyPassword - The http proxy password

socketTimeout - The socket timeout

httpTimeout - The http timeout

httpMaxConnections - The http max connections

cache - The cache configuration

CrowdSecurityRealm

@Deprecated
public CrowdSecurityRealm(String url,
 String applicationName,
 String password,
 String group,
 boolean nestedGroups,
 int sessionValidationInterval,
 boolean useSSO,
 String cookieDomain,
 String cookieTokenkey,
 Boolean useProxy,
 String httpProxyHost,
 String httpProxyPort,
 String httpProxyUsername,
 String httpProxyPassword,
 String socketTimeout,
 String httpTimeout,
 String httpMaxConnections,
 CrowdSecurityRealm.CacheConfiguration cache)

Deprecated.

retained for backwards binary compatibility.

Default constructor. Fields in config.jelly must match the parameter names in the "DataBoundConstructor".

Parameters:

url - The URL for Crowd.

applicationName - The application name.

password - The application password.

group - The group to which users must belong to. If this parameter is not specified, a users group membership will not be checked.

nestedGroups - true when nested groups may be used. false else.

sessionValidationInterval - The number of minutes to cache authentication validation in the session. If this value is set to 0, each HTTP request will be authenticated with the Crowd server.

useSSO - Enable SSO authentication.

cookieDomain - The cookie domain

cookieTokenkey - The cookie token key

useProxy - Specifies if a proxy should be used

httpProxyHost - The http proxy host

httpProxyPort - The http proxy port

httpProxyUsername - The http proxy username

httpProxyPassword - The http proxy password

socketTimeout - The socket timeout

httpTimeout - The http timeout

httpMaxConnections - The http max connections

cache - The cache configuration

CrowdSecurityRealm

@Deprecated
public CrowdSecurityRealm(String url,
 String applicationName,
 String password,
 String group,
 boolean nestedGroups,
 int sessionValidationInterval,
 boolean useSSO,
 String cookieDomain,
 String cookieTokenkey,
 Boolean useProxy,
 String httpProxyHost,
 String httpProxyPort,
 String httpProxyUsername,
 String httpProxyPassword,
 String socketTimeout,
 String httpTimeout,
 String httpMaxConnections)

Deprecated.

retained for backwards binary compatibility.

Fields in config.jelly must match the parameter names in the "DataBoundConstructor".

Parameters:

url - The URL for Crowd.

applicationName - The application name.

password - The application password.

group - The group to which users must belong to. If this parameter is not specified, a users group membership will not be checked.

nestedGroups - true when nested groups may be used. false else.

sessionValidationInterval - The number of minutes to cache authentication validation in the session. If this value is set to 0, each HTTP request will be authenticated with the Crowd server.

useSSO - Enable SSO authentication.

cookieDomain - The cookie domain

cookieTokenkey - The cookie token key

useProxy - Specifies if a proxy should be used

httpProxyHost - The http proxy host

httpProxyPort - The http proxy port

httpProxyUsername - The http proxy username

httpProxyPassword - The http proxy password

socketTimeout - The socket timeout

httpTimeout - The http timeout

httpMaxConnections - The http max connections

Method Details

getCache

public CrowdSecurityRealm.CacheConfiguration getCache()

getCacheSize

public Integer getCacheSize()

getCacheTTL

public Integer getCacheTTL()

createSecurityComponents

public SecurityRealm.SecurityComponents createSecurityComponents()

Overrides:

createSecurityComponents in class AbstractPasswordBasedSecurityRealm

See Also:

• AbstractPasswordBasedSecurityRealm.createSecurityComponents()

doLogout

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

Overrides:

doLogout in class SecurityRealm

Throws:

IOException

javax.servlet.ServletException

See Also:

• SecurityRealm.doLogout(org.kohsuke.stapler.StaplerRequest, org.kohsuke.stapler.StaplerResponse)

createFilter

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

Overrides:

createFilter in class SecurityRealm

See Also:

• SecurityRealm.createFilter(javax.servlet.FilterConfig)

loadUserByUsername

@Deprecated
public UserDetails loadUserByUsername(String username)
                               throws UsernameNotFoundException,
DataAccessException

Deprecated.

use loadUserByUsername2(java.lang.String)

Overrides:

loadUserByUsername in class AbstractPasswordBasedSecurityRealm

Throws:

UsernameNotFoundException

DataAccessException

See Also:

• AbstractPasswordBasedSecurityRealm.loadUserByUsername(java.lang.String)

loadUserByUsername2

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

Overrides:

loadUserByUsername2 in class AbstractPasswordBasedSecurityRealm

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException

See Also:

• AbstractPasswordBasedSecurityRealm.loadUserByUsername2(java.lang.String)

loadGroupByGroupname

@Deprecated
public GroupDetails loadGroupByGroupname(String groupname,
 boolean fetchMembers)
                                  throws UsernameNotFoundException,
DataAccessException

Deprecated.

use AbstractPasswordBasedSecurityRealm.loadGroupByGroupname2(java.lang.String, boolean)

Overrides:

loadGroupByGroupname in class SecurityRealm

Throws:

UsernameNotFoundException

DataAccessException

Since:

1.549

See Also:

• SecurityRealm.loadGroupByGroupname(java.lang.String)

loadGroupByGroupname

@Deprecated
public GroupDetails loadGroupByGroupname(String groupname)
                                  throws UsernameNotFoundException,
DataAccessException

Deprecated.

use AbstractPasswordBasedSecurityRealm.loadGroupByGroupname2(java.lang.String, boolean)

Overrides:

loadGroupByGroupname in class AbstractPasswordBasedSecurityRealm

Throws:

UsernameNotFoundException

DataAccessException

See Also:

• AbstractPasswordBasedSecurityRealm.loadGroupByGroupname(java.lang.String)

authenticate2

protected org.springframework.security.core.userdetails.UserDetails authenticate2(String pUsername,
 String pPassword)
                                                                           throws org.springframework.security.core.AuthenticationException

Overrides:

authenticate2 in class AbstractPasswordBasedSecurityRealm

Throws:

org.springframework.security.core.AuthenticationException

See Also:

• AbstractPasswordBasedSecurityRealm.authenticate2(java.lang.String, java.lang.String)