io.inkstand.security.LdapAuthConfiguration Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Gerald Muecke, [email protected]
 *
 * 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 io.inkstand.security;

import io.inkstand.config.LdapConfiguration;

/**
 * Configuration interface for an LDAP Server to be used for authentication purposes.
 *
 * @author Gerald Mücke
 */
public interface LdapAuthConfiguration extends LdapConfiguration {

    /**
     * LDAP Search Scopes Search scope
     *
     * @author Gerald Mücke
     */
    enum SearchScope {
        // TODO potential candidate for inkstand-ldap
        BASE(0, "base"),
        ONE_LEVEL(1, "one"),
        SUBTREE(2, "sub"), ;

        private final String name;
        private final int value;

        SearchScope(final int value, final String name) {
            this.value = value;
            this.name = name;
        }

        public String getName() {
            return name;
        }

        public int getValue() {
            return value;
        }

    }

    /**
     * The scope for user or group searches
     *
     * @return
     *  the scope for the ldap search
     */
    SearchScope getSearchScope();

    /**
     * The attribute that contains the role name. The role is used as role def in web applications.

     * Example: cn
     *
     * @return the attribute name for the role name.
     */
    String getRoleNameAttribute();

    /**
     * The filter for finding roles inside the role context and the search scope.

     * Example:(uniqueMember={1})
     *
     * @return the filter to search for roles
     */
    String getRoleFilter();

    /**
     * The DN containing the roles. 

     * Example: ou=groups,ou=system
     *
     * @return the role context dn
     */
    String getRoleContextDn();

    /**
     * The filter for finding users inside the user context and the search scope. For example:

     * ou=users,ou=system
     *
     * @return the filter to search for users
     */
    String getUserFilter();

    /**
     * The dn of the context to search for users. 

     * Example:ou=users,ou=system
     *
     * @return the dn of the user context
     */
    String getUserContextDn();

}