org.springframework.ldap.authentication.AcegiAuthenticationSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-ldap

Spring LDAP is a Java library for simplifying LDAP operations, based on the pattern of Spring's JdbcTemplate. The framework relieves the user of common chores, such as looking up and closing contexts, looping through results, encoding/decoding values and filters, and more. The LdapTemplate class encapsulates all the plumbing work involved in traditional LDAP programming, such as creating a DirContext, looping through NamingEnumerations, handling exceptions and cleaning up resources. This leaves the programmer to handle the important stuff - where to find data (DNs and Filters) and what do do with it (map to and from domain objects, bind, modify, unbind, etc.), in the same way that JdbcTemplate relieves the programmer of all but the actual SQL and how the data maps to the domain model. In addition to this, Spring LDAP provides transaction support, a pooling library, exception translation from NamingExceptions to a mirrored unchecked Exception hierarchy, as well as several utilities for working with filters, LDAP paths and Attributes.

There is a newer version: 1.3.1.RELEASE

Show newest version

/*
 * Copyright 2005-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.ldap.authentication;

import org.acegisecurity.Authentication;
import org.acegisecurity.context.SecurityContextHolder;
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.acegisecurity.userdetails.ldap.LdapUserDetails;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.ldap.core.AuthenticationSource;

/**
 * An AuthenticationSource to retrieve authentication information stored in
 * Acegi's SecurityContextHolder. Use Acegi's LdapAuthenticationProvider have a
 * LdapUserDetails object placed in the authentication.
 * 
 * @author Mattias Arthursson
 * 
 */
public class AcegiAuthenticationSource implements AuthenticationSource {
    private static final Log log = LogFactory
            .getLog(AcegiAuthenticationSource.class);

    /**
     * Get the principals of the logged in user, in this case the distinguished
     * name.
     * 
     * @return the distinguished name of the logged in user.
     */
    public String getPrincipal() {
        Authentication authentication = SecurityContextHolder.getContext()
                .getAuthentication();
        if (authentication != null) {
            Object principal = authentication.getPrincipal();
            if (principal instanceof LdapUserDetails) {
                LdapUserDetails details = (LdapUserDetails) principal;
                return details.getDn();
            } else if (authentication instanceof AnonymousAuthenticationToken) {
                if (log.isDebugEnabled()) {
                    log
                            .debug("Anonymous Authentication, returning empty String as Principal");
                }
                return "";
            } else {
                throw new IllegalArgumentException(
                        "The principal property of the authentication object -"
                                + "needs to be a LdapUserDetails.");
            }
        } else {
            log.warn("No Authentication object set in SecurityContext - "
                    + "returning empty String as Principal");
            return "";
        }
    }

    /*
     * @see org.springframework.ldap.core.AuthenticationSource#getCredentials()
     */
    public String getCredentials() {
        Authentication authentication = SecurityContextHolder.getContext()
                .getAuthentication();

        if (authentication != null) {
            return (String) authentication.getCredentials();
        } else {
            log.warn("No Authentication object set in SecurityContext - "
                    + "returning empty String as Credentials");
            return "";
        }
    }

}