Examples of hudson.security.SecurityRealm

hudson.security.SecurityRealm

Pluggable security realm that connects external user database to Hudson.

If additional views/URLs need to be exposed, an active {@link SecurityRealm} is bound to CONTEXT_ROOT/securityRealm/through {@link jenkins.model.Jenkins#getSecurityRealm()}, so you can define additional pages and operations on your {@link SecurityRealm}.

How do I implement this class?

For compatibility reasons, there are two somewhat different ways to implement a custom SecurityRealm.

One is to override the {@link #createSecurityComponents()} and create key Acegi componentsthat control the authentication process. The default {@link SecurityRealm#createFilter(FilterConfig)} implementation then assembles theminto a chain of {@link Filter}s. All the incoming requests to Hudson go through this filter chain, and when the filter chain is done, {@link SecurityContext#getAuthentication()} would tell uswho the current user is.

If your {@link SecurityRealm} needs to touch the default {@link Filter} chain configuration(e.g., adding new ones), then you can also override {@link #createFilter(FilterConfig)} to do so.

This model is expected to fit most {@link SecurityRealm} implementations.

The other way of doing this is to ignore {@link #createSecurityComponents()} completely (by returning{@link SecurityComponents} created by the default constructor) and just concentrate on {@link #createFilter(FilterConfig)}. As long as the resulting filter chain properly sets up {@link Authentication} object at the end of the processing,Hudson doesn't really need you to fit the standard Acegi models like {@link AuthenticationManager} and{@link UserDetailsService}.

This model is for those "weird" implementations.

Views

loginLink.jelly: This view renders the login link on the top right corner of every page, when the user is anonymous. For {@link SecurityRealm}s that support user sign-up, this is a good place to show a "sign up" link. See {@link HudsonPrivateSecurityRealm} implementationfor an example of this.
config.jelly: This view is used to render the configuration page in the system config screen.

@author Kohsuke Kawaguchi @since 1.160 @see PluginServletFilter

     * Returns the constant that captures the three basic security modes
     * in Hudson.
     */
    public SecurityMode getSecurity() {
        // fix the variable so that this code works under concurrent modification to securityRealm.
        SecurityRealm realm = securityRealm;


        if(realm==SecurityRealm.NO_AUTHENTICATION)
            return SecurityMode.UNSECURED;
        if(realm instanceof LegacySecurityRealm)
            return SecurityMode.LEGACY;

    @Override
    public String getSearchUrl() {
        return getUrlName();
    }
    public boolean isSecurityConfigured(){
        SecurityRealm securityRealm = Jenkins.getInstance().getSecurityRealm();
        return securityRealm instanceof GithubSecurityRealm;
    }

     * Returns the constant that captures the three basic security modes
     * in Hudson.
     */
    public SecurityMode getSecurity() {
        // fix the variable so that this code works under concurrent modification to securityRealm.
        SecurityRealm realm = securityRealm;


        if (realm == SecurityRealm.NO_AUTHENTICATION) {
            return SecurityMode.UNSECURED;
        }
        if (realm instanceof LegacySecurityRealm) {