Merge branch 'master' into 137-xenforo-support

Conflicts: src/main/java/fr/xephi/authme/datasource/CacheDataSource.java src/main/java/fr/xephi/authme/datasource/DataSource.java src/main/java/fr/xephi/authme/datasource/SQLite.java src/main/java/fr/xephi/authme/security/crypts/BCRYPT.java
2016-01-06 12:15:27 +07:00
parent 0c305a6287 2081fd7e34
commit e0c3affa33
49 changed files with 1727 additions and 1577 deletions
@@ -3,9 +3,8 @@ package fr.xephi.authme.security;
 import fr.xephi.authme.security.crypts.EncryptionMethod;

 /**
- * The list of hash algorithms supported by AuthMe. The implementing class must define a public
- * constructor which takes either no arguments, or a DataSource object (when the salt is stored
- * separately, writes to the database are necessary).
+ * The list of hash algorithms supported by AuthMe. The linked {@link EncryptionMethod} implementation
+ * must be able to be instantiated with the default constructor.
 */
 public enum HashAlgorithm {

@@ -15,6 +15,7 @@ package fr.xephi.authme.security.crypts;

 import fr.xephi.authme.ConsoleLogger;
 import fr.xephi.authme.security.crypts.description.HasSalt;
+import fr.xephi.authme.security.crypts.description.Usage;
 import fr.xephi.authme.security.crypts.description.Recommendation;
 import fr.xephi.authme.security.crypts.description.SaltType;
 import fr.xephi.authme.security.crypts.description.Usage;
@@ -108,7 +109,6 @@ public class BCRYPT implements EncryptionMethod {
     *
     * @throws IllegalArgumentException if the length is invalid
     */
-
    private static String encode_base64(byte d[], int len)
        throws IllegalArgumentException {
        int off = 0;
@@ -10,8 +10,6 @@ import fr.xephi.authme.security.crypts.description.HasSalt;
 import java.nio.charset.Charset;
 import java.security.MessageDigest;

-@Recommendation(Usage.DO_NOT_USE)
-@HasSalt(SaltType.USERNAME)
 public class CRAZYCRYPT1 extends UsernameSaltMethod {

    private static final char[] CRYPTCHARS =
@@ -8,7 +8,7 @@ import fr.xephi.authme.security.crypts.description.Usage;

 import static fr.xephi.authme.security.HashUtils.md5;

-@Recommendation(Usage.DO_NOT_USE)
+@Recommendation(Usage.ACCEPTABLE)
@HasSalt(value = SaltType.TEXT, length = 5)
 public class IPB3 extends SeparateSaltMethod {

@@ -1,9 +1,15 @@
 package fr.xephi.authme.security.crypts;

 import fr.xephi.authme.security.RandomString;
+import fr.xephi.authme.security.crypts.description.HasSalt;
+import fr.xephi.authme.security.crypts.description.Recommendation;
+import fr.xephi.authme.security.crypts.description.SaltType;
+import fr.xephi.authme.security.crypts.description.Usage;

 import static fr.xephi.authme.security.HashUtils.md5;

+@Recommendation(Usage.ACCEPTABLE)
+@HasSalt(value = SaltType.TEXT, length = 8)
 public class MYBB extends SeparateSaltMethod {

    @Override
@@ -1,9 +1,15 @@
 package fr.xephi.authme.security.crypts;

 import fr.xephi.authme.security.RandomString;
+import fr.xephi.authme.security.crypts.description.HasSalt;
+import fr.xephi.authme.security.crypts.description.Recommendation;
+import fr.xephi.authme.security.crypts.description.SaltType;
+import fr.xephi.authme.security.crypts.description.Usage;

 import static fr.xephi.authme.security.HashUtils.sha1;

+@Recommendation(Usage.ACCEPTABLE)
+@HasSalt(value = SaltType.TEXT, length = 40)
 public class WBB3 extends SeparateSaltMethod {

    @Override
@@ -241,8 +241,9 @@ public class WHIRLPOOL extends UnsaltedMethod {
     *
     * @param source     plaintext data to hash.
     * @param sourceBits how many bits of plaintext to process.
-     *                   <p/>
-     *                   This method maintains the invariant: bufferBits < 512
+     *                   <p>
+     *                   This method maintains the invariant: bufferBits &lt; 512
+     *                   </p>
     */
    public void NESSIEadd(byte[] source, long sourceBits) {
        /*
@@ -322,10 +323,12 @@ public class WHIRLPOOL extends UnsaltedMethod {
    }

    /**
+     * <p>
     * Get the hash value from the hashing state.
-     * <p/>
-     * This method uses the invariant: bufferBits < 512
-     *
+     * </p>
+     * <p>
+     * This method uses the invariant: bufferBits &lt; 512
+     * </p>
     * @param digest byte[]
     */
    public void NESSIEfinalize(byte[] digest) {
@@ -367,7 +370,7 @@ public class WHIRLPOOL extends UnsaltedMethod {
     * Delivers string input data to the hashing algorithm.
     *
     * @param source plaintext data to hash (ASCII text string).
-     *               This method maintains the invariant: bufferBits < 512
+     *               This method maintains the invariant: bufferBits &lt; 512
     */
    public void NESSIEadd(String source) {
        if (source.length() > 0) {
@@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;

 /**
- * Denotes an encryption algorithm that is restricted to the ASCII charset.
+ * Denotes a hashing algorithm that is restricted to the ASCII charset.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@@ -13,10 +13,18 @@ import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
 public @interface HasSalt {

-    /** The type of the salt. */
+    /**
+     * The type of the salt.
+     *
+     * @return The salt type
+     */
    SaltType value();

-    /** For text salts, the length of the salt. */
+    /**
+     * For text salts, the length of the salt.
+     *
+     * @return The length of the salt the algorithm uses, or 0 if not defined or not applicable.
+     */
    int length() default 0;

 }
@@ -6,13 +6,19 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;

 /**
- * Annotation to mark a hash algorithm with the usage recommendation, see {@link Usage}.
+ * Annotation to mark a hash algorithm with the usage recommendation.
+ *
+ * @see Usage
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
 public @interface Recommendation {

-    /** The recommendation for using the hash algorithm. */
+    /**
+     * The recommendation for using the hash algorithm.
+     *
+     * @return The recommended usage
+     */
    Usage value();

 }
@@ -8,7 +8,7 @@ public enum SaltType {
    /** Random, newly generated text. */
    TEXT,

-    /** Salt is based on the username, including variations and repetitions. */
+    /** Salt is based on the username, including variations and repetitions thereof. */
    USERNAME,

    /** No salt. */
@@ -2,6 +2,12 @@ package fr.xephi.authme.security.crypts.description;

 /**
 * Usage recommendation that can be provided for a hash algorithm.
+ * <p>
+ * Use the following rules of thumb:
+ * <ul>
+ *     <li>Hashes using MD5 may be {@link #ACCEPTABLE} but never {@link #RECOMMENDED}.</li>
+ *     <li>Hashes using no salt or one based on the username should be {@link #DO_NOT_USE}.</li>
+ * </ul>
 */
 public enum Usage {

@@ -1,15 +1,16 @@
 package fr.xephi.authme.security.pbkdf2;

-import javax.crypto.Mac;
-import javax.crypto.spec.SecretKeySpec;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
 import java.security.NoSuchProviderException;

+import javax.crypto.Mac;
+import javax.crypto.spec.SecretKeySpec;
+
 /**
- * Default PRF implementation based on standard javax.crypt.Mac mechanisms.
 * <p>
- * <hr />
+ * Default PRF implementation based on standard javax.crypt.Mac mechanisms.
+ * </p>
 * <p>
 * A free Java implementation of Password Based Key Derivation Function 2 as
 * defined by RFC 2898. Copyright (c) 2007 Matthias G&auml;rtner
@@ -75,7 +75,7 @@ public interface PBKDF2 {
    /**
     * Allow setting of configured parameters.
     *
-     * @param parameters
+     * @param parameters PBKDF2Parameters
     */
    void setParameters(PBKDF2Parameters parameters);

@@ -8,20 +8,17 @@ import java.security.SecureRandom;
 /**
 * <p>
 * Request for Comments: 2898 PKCS #5: Password-Based Cryptography Specification
- * <p>
+ * </p><p>
 * Version 2.0
- * <p>
+ * </p>
 * <p>
 * PBKDF2 (P, S, c, dkLen)
- * <p>
- * <p>
+ * </p>
 * Options:
 * <ul>
 * <li>PRF underlying pseudorandom function (hLen denotes the length in octets
 * of the pseudorandom function output). PRF is pluggable.</li>
 * </ul>
- * <p>
- * <p>
 * Input:
 * <ul>
 * <li>P password, an octet string</li>
@@ -30,15 +27,11 @@ import java.security.SecureRandom;
 * <li>dkLen intended length in octets of the derived key, a positive integer,
 * at most (2^32 - 1) * hLen</li>
 * </ul>
- * <p>
- * <p>
 * Output:
 * <ul>
 * <li>DK derived key, a dkLen-octet string</li>
 * </ul>
 * <p>
- * <hr />
- * <p>
 * A free Java implementation of Password Based Key Derivation Function 2 as
 * defined by RFC 2898. Copyright (c) 2007 Matthias G&auml;rtner
 * </p>
@@ -115,13 +108,14 @@ public class PBKDF2Engine implements PBKDF2 {
     * ISO-8559-1 encoding. Output result as
     * &quot;Salt:iteration-count:PBKDF2&quot; with binary data in hexadecimal
     * encoding.
-     * <p/>
+     * <p>
     * Example: Password &quot;password&quot; (without the quotes) leads to
     * 48290A0B96C426C3:1000:973899B1D4AFEB3ED371060D0797E0EE0142BD04
-     *
+     * </p>
     * @param args Supply the password as argument.
     *
-     * @throws IOException * @throws NoSuchAlgorithmException * @throws NoSuchAlgorithmException
+     * @throws IOException an ioexception occured
+     * @throws NoSuchAlgorithmException a NoSuchAlgorithmException occured
     */
    public static void main(String[] args)
        throws IOException, NoSuchAlgorithmException {
@@ -266,8 +260,8 @@ public class PBKDF2Engine implements PBKDF2 {
    /**
     * Integer division with ceiling function.
     *
-     * @param a
-     * @param b
+     * @param a Integer
+     * @param b Integer
     *
     * @return ceil(a/b) * @see <a href="http://tools.ietf.org/html/rfc2898">RFC 2898 5.2 Step
     * 2.</a>
@@ -288,7 +282,7 @@ public class PBKDF2Engine implements PBKDF2 {
     * @param prf        Pseudo Random Function
     * @param S          Salt as array of bytes
     * @param c          Iteration count
-     * @param blockIndex
+     * @param blockIndex Integer
     *
     * @see <a href="http://tools.ietf.org/html/rfc2898">RFC 2898 5.2 Step
     * 3.</a>
@@ -314,8 +308,8 @@ public class PBKDF2Engine implements PBKDF2 {
     * Block-Xor. Xor source bytes into destination byte buffer. Destination
     * buffer must be same length or less than source buffer.
     *
-     * @param dest
-     * @param src
+     * @param dest byte array
+     * @param src byte array
     */
    protected void xor(byte[] dest, byte[] src) {
        for (int i = 0; i < dest.length; i++) {
@@ -326,9 +320,9 @@ public class PBKDF2Engine implements PBKDF2 {
    /**
     * Four-octet encoding of the integer i, most significant octet first.
     *
-     * @param dest
-     * @param offset
-     * @param i
+     * @param dest byte array
+     * @param offset Integer
+     * @param i Integer
     *
     * @see <a href="http://tools.ietf.org/html/rfc2898">RFC 2898 5.2 Step
     * 3.</a>
@@ -5,8 +5,6 @@ package fr.xephi.authme.security.pbkdf2;
 * Parameter data holder for PBKDF2 configuration.
 * </p>
 * <p>
- * <hr />
- * <p>
 * A free Java implementation of Password Based Key Derivation Function 2 as
 * defined by RFC 2898. Copyright (c) 2007 Matthias G&auml;rtner
 * </p>