001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.authc.credential;
020    
021    import org.apache.shiro.crypto.hash.AbstractHash;
022    import org.apache.shiro.crypto.hash.Hash;
023    import org.apache.shiro.crypto.hash.Sha1Hash;
024    
025    
026    /**
027     * <tt>HashedCredentialsMatcher</tt> implementation that expects the stored <tt>AuthenticationInfo</tt> credentials to be
028     * SHA hashed.
029     *
030     * <p><b>Note:</b> <a href="http://en.wikipedia.org/wiki/MD5">MD5</a> and
031     * <a href="http://en.wikipedia.org/wiki/SHA_hash_functions">SHA-1</a> algorithms are now known to be vulnerable to
032     * compromise and/or collisions (read the linked pages for more).  While most applications are ok with either of these
033     * two, if your application mandates high security, use the SHA-256 (or higher) hashing algorithms and their
034     * supporting <code>CredentialsMatcher</code> implementations.</p>
035     *
036     * @author Les Hazlewood
037     * @since 0.9
038     */
039    public class Sha1CredentialsMatcher extends HashedCredentialsMatcher {
040    
041        /**
042         * Creates a new <em>uninitialized</em> {@link Sha1Hash Sha1Hash} instance, without it's byte array set.
043         *
044         * @return a new <em>uninitialized</em> {@link Sha1Hash Sha1Hash} instance, without it's byte array set.
045         */
046        protected AbstractHash newHashInstance() {
047            return new Sha1Hash();
048        }
049    
050        /**
051         * This implementation merely returns
052         * <code>new {@link Sha1Hash#Sha1Hash(Object, Object, int) Sha1Hash(credentials,salt,hashIterations)}</code>.
053         */
054        protected Hash hashProvidedCredentials(Object credentials, Object salt, int hashIterations) {
055            return new Sha1Hash(credentials, salt, hashIterations);
056        }
057    }