Java tutorial
/* * This library is part of OpenCms - * the Open Source Content Management System * * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com) * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * For further information about Alkacon Software GmbH, please see the * company website: http://www.alkacon.com * * For further information about OpenCms, please see the * project website: http://www.opencms.org * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ package org.opencms.security; import org.opencms.configuration.CmsConfigurationException; import org.opencms.configuration.CmsParameterConfiguration; import org.opencms.i18n.CmsEncoder; import org.opencms.i18n.CmsMessageContainer; import org.opencms.main.CmsLog; import java.io.UnsupportedEncodingException; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.SecureRandom; import org.apache.commons.codec.binary.Base64; import org.apache.commons.logging.Log; /** * Default implementation for OpenCms password validation, * just checks if a password is at last 4 characters long.<p> * * @since 6.0.0 */ public class CmsDefaultPasswordHandler implements I_CmsPasswordHandler { /** The minimum length of a password. */ public static final int PASSWORD_MIN_LENGTH = 4; /** The log object for this class. */ private static final Log LOG = CmsLog.getLog(CmsDefaultPasswordHandler.class); /** The secure random number generator. */ private static SecureRandom m_secureRandom; /** The configuration of the password handler. */ private CmsParameterConfiguration m_configuration; /** The digest type used. */ private String m_digestType = DIGEST_TYPE_MD5; /** The encoding the encoding used for translating the input string to bytes. */ private String m_inputEncoding = CmsEncoder.ENCODING_UTF_8; /** * The constructor does not perform any operation.<p> */ public CmsDefaultPasswordHandler() { m_configuration = new CmsParameterConfiguration(); } /** * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#addConfigurationParameter(java.lang.String, java.lang.String) */ public void addConfigurationParameter(String paramName, String paramValue) { m_configuration.put(paramName, paramValue); } /** * @see org.opencms.security.I_CmsPasswordHandler#digest(java.lang.String) */ public String digest(String password) throws CmsPasswordEncryptionException { return digest(password, m_digestType, m_inputEncoding); } /** * @see org.opencms.security.I_CmsPasswordHandler#digest(java.lang.String, java.lang.String, java.lang.String) */ public String digest(String password, String digestType, String inputEncoding) throws CmsPasswordEncryptionException { MessageDigest md; String result; try { if (DIGEST_TYPE_PLAIN.equals(digestType.toLowerCase())) { result = password; } else if (DIGEST_TYPE_SSHA.equals(digestType.toLowerCase())) { byte[] salt = new byte[4]; byte[] digest; byte[] total; if (m_secureRandom == null) { m_secureRandom = SecureRandom.getInstance("SHA1PRNG"); } m_secureRandom.nextBytes(salt); md = MessageDigest.getInstance(DIGEST_TYPE_SHA); md.reset(); md.update(password.getBytes(inputEncoding)); md.update(salt); digest = md.digest(); total = new byte[digest.length + salt.length]; System.arraycopy(digest, 0, total, 0, digest.length); System.arraycopy(salt, 0, total, digest.length, salt.length); result = new String(Base64.encodeBase64(total)); } else { md = MessageDigest.getInstance(digestType); md.reset(); md.update(password.getBytes(inputEncoding)); result = new String(Base64.encodeBase64(md.digest())); } } catch (NoSuchAlgorithmException e) { CmsMessageContainer message = Messages.get().container(Messages.ERR_UNSUPPORTED_ALGORITHM_1, digestType); if (LOG.isErrorEnabled()) { LOG.error(message.key(), e); } throw new CmsPasswordEncryptionException(message, e); } catch (UnsupportedEncodingException e) { CmsMessageContainer message = Messages.get().container(Messages.ERR_UNSUPPORTED_PASSWORD_ENCODING_1, inputEncoding); if (LOG.isErrorEnabled()) { LOG.error(message.key(), e); } throw new CmsPasswordEncryptionException(message, e); } return result; } /** * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#getConfiguration() */ public CmsParameterConfiguration getConfiguration() { return m_configuration; } /** * Returns the digestType.<p> * * @return the digestType */ public String getDigestType() { return m_digestType; } /** * Returns the input encoding.<p> * * @return the input encoding */ public String getInputEncoding() { return m_inputEncoding; } /** * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#initConfiguration() */ public void initConfiguration() throws CmsConfigurationException { // simple default configuration does not need to be initialized if (LOG.isDebugEnabled()) { CmsMessageContainer message = Messages.get().container(Messages.LOG_INIT_CONFIG_CALLED_1, this); LOG.debug(message.key()); LOG.debug(Messages.get().getBundle().key(Messages.LOG_INIT_CONFIG_CALLED_1, this)); // suppress compiler warning, this is never true if (this == null) { throw new CmsConfigurationException(message); } } m_configuration = CmsParameterConfiguration.unmodifiableVersion(m_configuration); } /** * Sets the digestType.<p> * * @param digestType the digestType to set */ public void setDigestType(String digestType) { m_digestType = digestType; } /** * Sets the input encoding.<p> * * @param inputEncoding the input encoding to set */ public void setInputEncoding(String inputEncoding) { m_inputEncoding = inputEncoding; } /** * @see org.opencms.security.I_CmsPasswordHandler#validatePassword(java.lang.String) */ public void validatePassword(String password) throws CmsSecurityException { if ((password == null) || (password.length() < PASSWORD_MIN_LENGTH)) { throw new CmsSecurityException( Messages.get().container(Messages.ERR_PASSWORD_TOO_SHORT_1, new Integer(PASSWORD_MIN_LENGTH))); } } }