001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.security;
029
030/**
031 * This interface can be used to override or replace user names or passwords which occur in the OpenCms configuration,
032 * for example to hide passwords from users who can read the configuration files.
033 */
034public interface I_CmsCredentialsResolver {
035
036    /** Credential type for database pool passwords. */
037    String DB_PASSWORD = "db_password";
038
039    /** Credential type for database pool user names. */
040    String DB_USER = "db_user";
041
042    /** Credential type for LDAP passwords. */
043    String LDAP_PASSWORD = "ldap_password";
044
045    /** Credential type for LDAP users. */
046    String LDAP_USER = "ldap_user";
047
048    /**
049     * Translates user names or passwords for authentication.<p>
050     *
051     * @param credentialType the type of credential to resolve (this is equal to one of the constants defined in this interface)
052     * @param valueFromConfiguration the original value which was read from the configuration file (may be null)
053     *
054     * @return the credential value that should be used for authentication
055     */
056    String resolveCredential(String credentialType, String valueFromConfiguration);
057}