org.jenkinsci.plugins.saml

Class SamlSecurityRealm

java.lang.Object

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

hudson.security.SecurityRealm

org.jenkinsci.plugins.saml.SamlSecurityRealm

All Implemented Interfaces:

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

public class SamlSecurityRealm
extends hudson.security.SecurityRealm

Authenticates the user via SAML. This class is the main entry point to the plugin. Uses Stapler (stapler.kohsuke.org) to bind methods to URLs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SamlSecurityRealm.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

Modifier and Type	Field and Description
static String	CONSUMER_SERVICE_URL_PATH

Fields inherited from class hudson.security.SecurityRealm

AUTHENTICATED_AUTHORITY, LIST, NO_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
SamlSecurityRealm(String signOnUrl, String idpMetadata, String displayNameAttributeName, String groupsAttributeName, Integer maximumAuthenticationLifetime, String usernameAttributeName, SamlEncryptionData encryptionData)
SamlSecurityRealm(String signOnUrl, String idpMetadata, String displayNameAttributeName, String groupsAttributeName, Integer maximumAuthenticationLifetime, String usernameAttributeName, SamlEncryptionData encryptionData, String usernameCaseConversion) Jenkins passes these parameters in when you update the settings.

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, String referer) /securityRealm/commenceLogin
org.kohsuke.stapler.HttpResponse	doFinishLogin(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) /securityRealm/finishLogin
org.kohsuke.stapler.HttpResponse	doMetadata(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) /securityRealm/metadata URL request service method to expose the SP metadata to the user so that they can configure their IdP.
String	getDisplayNameAttributeName()
SamlEncryptionData	getEncryptionData()
String	getGroupsAttributeName()
String	getIdpMetadata()
String	getKeystorePassword()
String	getKeystorePath()
String	getLoginUrl()
Integer	getMaximumAuthenticationLifetime()
String	getPrivateKeyPassword()
String	getSpMetadata()
String	getUsernameAttributeName()
String	getUsernameCaseConversion()
void	setIdpMetadata(String idpMetadata)
void	setUsernameAttributeName(String attribute)
void	setUsernameCaseConversion(String usernameCaseConversion)

Methods inherited from class hudson.security.SecurityRealm

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

CONSUMER_SERVICE_URL_PATH

public static final String CONSUMER_SERVICE_URL_PATH

See Also:

Constant Field Values

Constructor Detail

SamlSecurityRealm

@DataBoundConstructor
public SamlSecurityRealm(String signOnUrl,
                                               String idpMetadata,
                                               String displayNameAttributeName,
                                               String groupsAttributeName,
                                               Integer maximumAuthenticationLifetime,
                                               String usernameAttributeName,
                                               SamlEncryptionData encryptionData,
                                               String usernameCaseConversion)

Jenkins passes these parameters in when you update the settings. It does this because of the @DataBoundConstructor

SamlSecurityRealm

public SamlSecurityRealm(String signOnUrl,
                         String idpMetadata,
                         String displayNameAttributeName,
                         String groupsAttributeName,
                         Integer maximumAuthenticationLifetime,
                         String usernameAttributeName,
                         SamlEncryptionData encryptionData)

Method Detail

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

doCommenceLogin

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

/securityRealm/commenceLogin

doFinishLogin

public org.kohsuke.stapler.HttpResponse doFinishLogin(org.kohsuke.stapler.StaplerRequest request,
                                                      org.kohsuke.stapler.StaplerResponse response)

/securityRealm/finishLogin

doMetadata

public org.kohsuke.stapler.HttpResponse doMetadata(org.kohsuke.stapler.StaplerRequest request,
                                                   org.kohsuke.stapler.StaplerResponse response)

/securityRealm/metadata URL request service method to expose the SP metadata to the user so that they can configure their IdP.

getIdpMetadata

public String getIdpMetadata()

setIdpMetadata

public void setIdpMetadata(String idpMetadata)

getUsernameAttributeName

public String getUsernameAttributeName()

setUsernameAttributeName

public void setUsernameAttributeName(String attribute)

getSpMetadata

public String getSpMetadata()

getDisplayNameAttributeName

public String getDisplayNameAttributeName()

getGroupsAttributeName

public String getGroupsAttributeName()

getMaximumAuthenticationLifetime

public Integer getMaximumAuthenticationLifetime()

getEncryptionData

public SamlEncryptionData getEncryptionData()

getKeystorePath

public String getKeystorePath()

getKeystorePassword

public String getKeystorePassword()

getPrivateKeyPassword

public String getPrivateKeyPassword()

getUsernameCaseConversion

public String getUsernameCaseConversion()

setUsernameCaseConversion

public void setUsernameCaseConversion(String usernameCaseConversion)