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 */
019package org.apache.shiro.crypto.hash.format;
020
021/**
022 * A {@code HashFormat} that supports
023 * <a href="http://packages.python.org/passlib/modular_crypt_format.html">Modular Crypt Format</a> token rules.
024 *
025 * @see <a href="http://en.wikipedia.org/wiki/Crypt_(Unix)">Crypt (unix)</a>
026 * @see <a href="http://www.tummy.com/journals/entries/jafo_20110117_054918">MCF Journal Entry</a>
027 * @since 1.2
028 */
029public interface ModularCryptFormat extends HashFormat {
030
031    public static final String TOKEN_DELIMITER = "$";
032
033    /**
034     * Returns the Modular Crypt Format identifier that indicates how the formatted String should be parsed.  This id
035     * is always in the MCF-formatted string's first token.
036     * <p/>
037     * Example values are {@code md5}, {@code 1}, {@code 2}, {@code apr1}, etc.
038     *
039     * @return the Modular Crypt Format identifier that indicates how the formatted String should be parsed.
040     */
041    String getId();
042}