001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (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
030import java.util.Locale;
031
032/**
033 * Password handler implementing this interface allow the password security to be evaluated.<p>
034 */
035public interface I_CmsPasswordSecurityEvaluator {
036
037    /** Password security levels. */
038    public enum SecurityLevel {
039        /** Invalid. */
040        invalid,
041
042        /** Strong. */
043        strong,
044
045        /** Weak. */
046        weak
047    }
048
049    /**
050     * Evaluates the given password security.<p>
051     *
052     * @param password the password
053     *
054     * @return the security level as a number between 0 and 1, 0 meaning a low security and 1 a strong security
055     */
056    SecurityLevel evaluatePasswordSecurity(String password);
057
058    /**
059     * Returns a hint describing how to set a secure password.<p>
060     *
061     * @param locale the locale
062     *
063     * @return the password security hint
064     */
065    String getPasswordSecurityHint(Locale locale);
066}