webapp/src/main/java/org/apache/atlas/web/security/AtlasLdapAuthenticationProvider.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.atlas.web.security;

import java.util.List;
import javax.annotation.PostConstruct;
import org.apache.atlas.ApplicationProperties;
import org.apache.atlas.web.model.User;
import org.apache.commons.configuration.Configuration;
import org.apache.log4j.Logger;
import org.springframework.ldap.core.support.LdapContextSource;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.ldap.DefaultSpringSecurityContextSource;
import org.springframework.security.ldap.authentication.BindAuthenticator;
import org.springframework.security.ldap.authentication.LdapAuthenticationProvider;
import org.springframework.security.ldap.search.FilterBasedLdapUserSearch;
import org.springframework.security.ldap.userdetails.DefaultLdapAuthoritiesPopulator;
import org.springframework.stereotype.Component;

@Component
public class AtlasLdapAuthenticationProvider extends
        AtlasAbstractAuthenticationProvider {
    private static Logger LOG = Logger
            .getLogger(AtlasLdapAuthenticationProvider.class);

    private String ldapURL;
    private String ldapUserDNPattern;
    private String ldapGroupSearchBase;
    private String ldapGroupSearchFilter;
    private String ldapGroupRoleAttribute;
    private String ldapBindDN;
    private String ldapBindPassword;
    private String ldapDefaultRole;
    private String ldapUserSearchFilter;
    private String ldapReferral;
    private String ldapBase;
    private boolean groupsFromUGI;

    @PostConstruct
    public void setup() {
        setLdapProperties();
    }

    @Override
    public Authentication authenticate(Authentication authentication)
            throws AuthenticationException {
        try {
            return getLdapBindAuthentication(authentication);
        } catch (Exception e) {
            throw new AtlasAuthenticationException(e.getMessage(), e.getCause());
        }
    }

    private Authentication getLdapBindAuthentication(
            Authentication authentication) throws Exception {
        try {
            String userName = authentication.getName();
            String userPassword = "";
            if (authentication.getCredentials() != null) {
                userPassword = authentication.getCredentials().toString();
            }

            LdapContextSource ldapContextSource = getLdapContextSource();

            DefaultLdapAuthoritiesPopulator defaultLdapAuthoritiesPopulator = getDefaultLdapAuthoritiesPopulator(ldapContextSource);

            if (ldapUserSearchFilter == null
                    || ldapUserSearchFilter.trim().isEmpty()) {
                ldapUserSearchFilter = "(uid={0})";
            }

            FilterBasedLdapUserSearch userSearch = new FilterBasedLdapUserSearch(
                    ldapBase, ldapUserSearchFilter, ldapContextSource);
            userSearch.setSearchSubtree(true);

            BindAuthenticator bindAuthenticator = getBindAuthenticator(
                    userSearch, ldapContextSource);

            LdapAuthenticationProvider ldapAuthenticationProvider = new LdapAuthenticationProvider(
                    bindAuthenticator, defaultLdapAuthoritiesPopulator);

            if (userName != null && userPassword != null
                    && !userName.trim().isEmpty()
                    && !userPassword.trim().isEmpty()) {
                final List<GrantedAuthority> grantedAuths = getAuthorities(userName);
                final UserDetails principal = new User(userName, userPassword,
                        grantedAuths);
                final Authentication finalAuthentication = new UsernamePasswordAuthenticationToken(
                        principal, userPassword, grantedAuths);
                authentication = ldapAuthenticationProvider.authenticate(finalAuthentication);
                if(groupsFromUGI) {
                    authentication = getAuthenticationWithGrantedAuthorityFromUGI(authentication);
                }
                return authentication;
            } else {
                throw new AtlasAuthenticationException(
                        "LDAP Authentication::userName or userPassword is null or empty for userName "
                                + userName);
            }
        } catch (Exception e) {
            LOG.error("LDAP Authentication Failed:", e);
            throw new AtlasAuthenticationException(
                    "LDAP Authentication Failed", e);
        }
    }

    private void setLdapProperties() {
        try {
            Configuration configuration = ApplicationProperties.get();

            ldapURL = configuration.getString("atlas.authentication.method.ldap.url");
            ldapUserDNPattern = configuration.getString(
                    "atlas.authentication.method.ldap.userDNpattern");
            ldapGroupSearchBase = configuration.getString(
                    "atlas.authentication.method.ldap.groupSearchBase");
            ldapGroupSearchFilter = configuration.getString(
                    "atlas.authentication.method.ldap.groupSearchFilter");
            ldapGroupRoleAttribute = configuration.getString(
                    "atlas.authentication.method.ldap.groupRoleAttribute");
            ldapBindDN = configuration.getString("atlas.authentication.method.ldap.bind.dn");
            ldapBindPassword = configuration.getString(
                    "atlas.authentication.method.ldap.bind.password");
            ldapDefaultRole = configuration.getString("atlas.authentication.method.ldap.default.role");
            ldapUserSearchFilter = configuration.getString(
                    "atlas.authentication.method.ldap.user.searchfilter");
            ldapReferral = configuration.getString("atlas.authentication.method.ldap.ad.referral");
            ldapBase = configuration.getString("atlas.authentication.method.ldap.base.dn");
            groupsFromUGI = configuration.getBoolean("atlas.authentication.method.ldap.ugi-groups", true);

        } catch (Exception e) {
            LOG.error("Exception while setLdapProperties", e);
        }

    }

    private LdapContextSource getLdapContextSource() throws Exception {
        LdapContextSource ldapContextSource = new DefaultSpringSecurityContextSource(
                ldapURL);
        ldapContextSource.setUserDn(ldapBindDN);
        ldapContextSource.setPassword(ldapBindPassword);
        ldapContextSource.setReferral(ldapReferral);
        ldapContextSource.setCacheEnvironmentProperties(false);
        ldapContextSource.setAnonymousReadOnly(false);
        ldapContextSource.setPooled(true);
        ldapContextSource.afterPropertiesSet();
        return ldapContextSource;
    }

    private DefaultLdapAuthoritiesPopulator getDefaultLdapAuthoritiesPopulator(
            LdapContextSource ldapContextSource) {
        DefaultLdapAuthoritiesPopulator defaultLdapAuthoritiesPopulator = new DefaultLdapAuthoritiesPopulator(
                ldapContextSource, ldapGroupSearchBase);
        defaultLdapAuthoritiesPopulator
                .setGroupRoleAttribute(ldapGroupRoleAttribute);
        defaultLdapAuthoritiesPopulator
                .setGroupSearchFilter(ldapGroupSearchFilter);
        defaultLdapAuthoritiesPopulator.setIgnorePartialResultException(true);
        return defaultLdapAuthoritiesPopulator;
    }

    private BindAuthenticator getBindAuthenticator(
            FilterBasedLdapUserSearch userSearch,
            LdapContextSource ldapContextSource) throws Exception {
        BindAuthenticator bindAuthenticator = new BindAuthenticator(
                ldapContextSource);
        bindAuthenticator.setUserSearch(userSearch);
        String[] userDnPatterns = new String[] { ldapUserDNPattern };
        bindAuthenticator.setUserDnPatterns(userDnPatterns);
        bindAuthenticator.afterPropertiesSet();
        return bindAuthenticator;
    }
}