View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.crypto.hash.format;
20  
21  /**
22   * A {@code HashFormat} that supports
23   * <a href="http://packages.python.org/passlib/modular_crypt_format.html">Modular Crypt Format</a> token rules.
24   *
25   * @see <a href="http://en.wikipedia.org/wiki/Crypt_(Unix)">Crypt (unix)</a>
26   * @see <a href="http://www.tummy.com/journals/entries/jafo_20110117_054918">MCF Journal Entry</a>
27   * @since 1.2
28   */
29  public interface ModularCryptFormat extends HashFormat {
30  
31      public static final String TOKEN_DELIMITER = "$";
32  
33      /**
34       * Returns the Modular Crypt Format identifier that indicates how the formatted String should be parsed.  This id
35       * is always in the MCF-formatted string's first token.
36       * <p/>
37       * Example values are {@code md5}, {@code 1}, {@code 2}, {@code apr1}, etc.
38       *
39       * @return the Modular Crypt Format identifier that indicates how the formatted String should be parsed.
40       */
41      String getId();
42  }