org.jenkinsci.plugins

Class GithubSecurityRealm

java.lang.Object

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

hudson.security.SecurityRealm

org.jenkinsci.plugins.GithubSecurityRealm

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.security.SecurityRealm>, org.acegisecurity.userdetails.UserDetailsService

public class GithubSecurityRealm
extends hudson.security.SecurityRealm
implements org.acegisecurity.userdetails.UserDetailsService

Implementation of the AbstractPasswordBasedSecurityRealm that uses github oauth to verify the user can login. This is based on the MySQLSecurityRealm from the mysql-auth-plugin written by Alex Ackerman.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GithubSecurityRealm.ConverterImpl
static class	GithubSecurityRealm.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
GithubSecurityRealm(String githubWebUri, String githubApiUri, String clientID, String clientSecret, String oauthScopes)

Method Summary

Methods

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)
org.kohsuke.stapler.HttpResponse	doFinishLogin(org.kohsuke.stapler.StaplerRequest request) This is where the user comes back to at the end of the OAuth redirect ping-pong.
boolean	equals(Object object) Compare an object against this instance for equivalence.
String	getClientID()
hudson.util.Secret	getClientSecret()
GithubSecurityRealm.DescriptorImpl	getDescriptor()
String	getGithubApiUri()
String	getGithubUri() Deprecated. use getGithubWebUri() instead.
String	getGithubWebUri()
String	getLoginUrl()
String	getOauthScopes()
protected String	getPostLogOutUrl(org.kohsuke.stapler.StaplerRequest req, org.acegisecurity.Authentication auth)
int	hashCode()
boolean	hasScope(String scope) Checks the security realm for a GitHub OAuth scope.
hudson.security.GroupDetails	loadGroupByGroupname(String groupName)
org.acegisecurity.userdetails.UserDetails	loadUserByUsername(String username)

Methods inherited from class hudson.security.SecurityRealm

all, canLogOut, commenceSignup, createCliAuthenticator, createFilter, doCaptcha, doLogout, findBean, getAuthenticationGatewayUrl, getCaptchaSupport, getCaptchaSupportDescriptors, getFrom, getGroupIdStrategy, getSecurityComponents, getUserIdStrategy, loadGroupByGroupname, setCaptchaSupport, validateCaptcha

Methods inherited from class java.lang.Object

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

Constructor Detail

GithubSecurityRealm

@DataBoundConstructor
public GithubSecurityRealm(String githubWebUri,
                                        String githubApiUri,
                                        String clientID,
                                        String clientSecret,
                                        String oauthScopes)

Parameters:

githubWebUri - The URI to the root of the web UI for GitHub or GitHub Enterprise, including the protocol (e.g. https).

githubApiUri - The URI to the root of the API for GitHub or GitHub Enterprise, including the protocol (e.g. https).

clientID - The client ID for the created OAuth Application.

clientSecret - The client secret for the created GitHub OAuth Application.

oauthScopes - A comma separated list of OAuth Scopes to request access to.

Method Detail

hasScope

public boolean hasScope(String scope)

Checks the security realm for a GitHub OAuth scope.

Parameters:

scope - A scope to check for in the security realm.

Returns:

true if security realm has the scope or false if it does not.

getGithubApiUri

public String getGithubApiUri()

Returns:

the URI to the API root of GitHub or GitHub Enterprise.

getGithubWebUri

public String getGithubWebUri()

Returns:

the uri to the web root of Github (varies for Github Enterprise Edition)

getGithubUri

@Deprecated
public String getGithubUri()

Deprecated. use getGithubWebUri() instead.

Returns:

the uri to the web root of Github (varies for Github Enterprise Edition)

getClientID

public String getClientID()

Returns:

the clientID

getClientSecret

public hudson.util.Secret getClientSecret()

Returns:

the clientSecret

getOauthScopes

public String getOauthScopes()

Returns:

the oauthScopes

doCommenceLogin

public org.kohsuke.stapler.HttpResponse doCommenceLogin(org.kohsuke.stapler.StaplerRequest request,
                                               @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 OAuth redirect ping-pong.

Throws:

IOException

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

getPostLogOutUrl

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

Overrides:

getPostLogOutUrl in class hudson.security.SecurityRealm

getDescriptor

public GithubSecurityRealm.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.security.SecurityRealm>

Overrides:

getDescriptor in class hudson.security.SecurityRealm

loadUserByUsername

public org.acegisecurity.userdetails.UserDetails loadUserByUsername(String username)
                                                             throws org.acegisecurity.userdetails.UsernameNotFoundException,
                                                                    org.springframework.dao.DataAccessException

Specified by:

loadUserByUsername in interface org.acegisecurity.userdetails.UserDetailsService

Overrides:

loadUserByUsername in class hudson.security.SecurityRealm

Parameters:

username - username to lookup

Returns:

userDetails

Throws:

hudson.security.UserMayOrMayNotExistException

org.acegisecurity.userdetails.UsernameNotFoundException

org.springframework.dao.DataAccessException

equals

public boolean equals(Object object)

Compare an object against this instance for equivalence.

Overrides:

equals in class Object

Parameters:

object - An object to campare this instance to.

Returns:

true if the objects are the same instance and configuration.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

loadGroupByGroupname

public hudson.security.GroupDetails loadGroupByGroupname(String groupName)
                                                  throws org.acegisecurity.userdetails.UsernameNotFoundException,
                                                         org.springframework.dao.DataAccessException

Overrides:

loadGroupByGroupname in class hudson.security.SecurityRealm

Parameters:

groupName - groupName to look up

Returns:

groupDetails

Throws:

org.acegisecurity.userdetails.UsernameNotFoundException

org.springframework.dao.DataAccessException