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

src/main/java/fr/xephi/authme/security/crypts/BCRYPT.java

@@ -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;

src/main/java/fr/xephi/authme/security/crypts/CRAZYCRYPT1.java

@@ -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 =

src/main/java/fr/xephi/authme/security/crypts/IPB3.java

@@ -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 {
 

src/main/java/fr/xephi/authme/security/crypts/MYBB.java

@@ -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

src/main/java/fr/xephi/authme/security/crypts/WBB3.java

@@ -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

src/main/java/fr/xephi/authme/security/crypts/WHIRLPOOL.java

@@ -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) {

src/main/java/fr/xephi/authme/security/crypts/description/AsciiRestricted.java

@@ -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)

src/main/java/fr/xephi/authme/security/crypts/description/HasSalt.java

@@ -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;
 
 }

src/main/java/fr/xephi/authme/security/crypts/description/Recommendation.java

@@ -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();
 
 }

src/main/java/fr/xephi/authme/security/crypts/description/SaltType.java

@@ -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. */

src/main/java/fr/xephi/authme/security/crypts/description/Usage.java

@@ -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 {