extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/LDAPAuthenticatedUser.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.guacamole.auth.ldap.user;

import com.google.inject.Inject;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import org.apache.directory.api.ldap.model.name.Dn;
import org.apache.guacamole.net.auth.AbstractAuthenticatedUser;
import org.apache.guacamole.net.auth.AuthenticationProvider;
import org.apache.guacamole.net.auth.Credentials;

/**
 * An LDAP-specific implementation of AuthenticatedUser, associating a
 * particular set of credentials with the LDAP authentication provider.
 */
public class LDAPAuthenticatedUser extends AbstractAuthenticatedUser {

    /**
     * Reference to the authentication provider associated with this
     * authenticated user.
     */
    @Inject
    private AuthenticationProvider authProvider;

    /**
     * The credentials provided when this user was authenticated.
     */
    private Credentials credentials;

    /**
     * Name/value pairs to be applied as parameter tokens when connections
     * are established using this AuthenticatedUser.
     */
    private Map<String, String> tokens;

    /**
     * The unique identifiers of all user groups which affect the permissions
     * available to this user.
     */
    private Set<String> effectiveGroups;
    
    /**
     * The LDAP DN used to bind this user.
     */
    private Dn bindDn;

    /**
     * Initializes this AuthenticatedUser with the given credentials,
     * connection parameter tokens. and set of effective user groups.
     *
     * @param credentials
     *     The credentials provided when this user was authenticated.
     *
     * @param tokens
     *     A Map of all name/value pairs that should be applied as parameter
     *     tokens when connections are established using the AuthenticatedUser.
     *
     * @param effectiveGroups
     *     The unique identifiers of all user groups which affect the
     *     permissions available to this user.
     * 
     * @param bindDn
     *     The LDAP DN used to bind this user.
     */
    public void init(Credentials credentials, Map<String, String> tokens,
            Set<String> effectiveGroups, Dn bindDn) {
        this.credentials = credentials;
        this.tokens = Collections.unmodifiableMap(tokens);
        this.effectiveGroups = effectiveGroups;
        this.bindDn = bindDn;
        setIdentifier(credentials.getUsername());
    }
    
    /**
     * Returns a Map of all name/value pairs that should be applied as
     * parameter tokens when connections are established using this
     * AuthenticatedUser.
     *
     * @return
     *     A Map of all name/value pairs that should be applied as parameter
     *     tokens when connections are established using this
     *     AuthenticatedUser.
     */
    public Map<String, String> getTokens() {
        return tokens;
    }
    
    /**
     * Returns the LDAP DN used to bind this user.
     * 
     * @return 
     *     The LDAP DN used to bind this user.
     */
    public Dn getBindDn() {
        return bindDn;
    }

    @Override
    public AuthenticationProvider getAuthenticationProvider() {
        return authProvider;
    }

    @Override
    public Credentials getCredentials() {
        return credentials;
    }

    @Override
    public Set<String> getEffectiveUserGroups() {
        return effectiveGroups;
    }

}