Merge branch 'master' of https://github.com/AuthMe/AuthMeReloaded into 1141-optional-additional-2fa-auth

This commit is contained in:
ljacqu 2018-05-01 22:49:23 +02:00
commit 6f2f7a73af
33 changed files with 195 additions and 92 deletions

View File

@ -150,7 +150,7 @@
<plugin> <plugin>
<groupId>org.jacoco</groupId> <groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId> <artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.0</version> <version>0.8.1</version>
<executions> <executions>
<execution> <execution>
<id>pre-unit-test</id> <id>pre-unit-test</id>

View File

@ -2,9 +2,7 @@ package fr.xephi.authme;
import ch.jalu.injector.Injector; import ch.jalu.injector.Injector;
import ch.jalu.injector.InjectorBuilder; import ch.jalu.injector.InjectorBuilder;
import com.google.common.annotations.VisibleForTesting; import com.google.common.annotations.VisibleForTesting;
import fr.xephi.authme.api.NewAPI; import fr.xephi.authme.api.NewAPI;
import fr.xephi.authme.command.CommandHandler; import fr.xephi.authme.command.CommandHandler;
import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.datasource.DataSource;
@ -35,9 +33,6 @@ import fr.xephi.authme.settings.properties.SecuritySettings;
import fr.xephi.authme.task.CleanupTask; import fr.xephi.authme.task.CleanupTask;
import fr.xephi.authme.task.purge.PurgeService; import fr.xephi.authme.task.purge.PurgeService;
import fr.xephi.authme.util.ExceptionUtils; import fr.xephi.authme.util.ExceptionUtils;
import java.io.File;
import org.apache.commons.lang.SystemUtils; import org.apache.commons.lang.SystemUtils;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.command.Command; import org.bukkit.command.Command;
@ -48,6 +43,8 @@ import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.plugin.java.JavaPluginLoader; import org.bukkit.plugin.java.JavaPluginLoader;
import org.bukkit.scheduler.BukkitScheduler; import org.bukkit.scheduler.BukkitScheduler;
import java.io.File;
import static fr.xephi.authme.service.BukkitService.TICKS_PER_MINUTE; import static fr.xephi.authme.service.BukkitService.TICKS_PER_MINUTE;
import static fr.xephi.authme.util.Utils.isClassLoaded; import static fr.xephi.authme.util.Utils.isClassLoaded;

View File

@ -5,7 +5,7 @@ import fr.xephi.authme.output.LogLevel;
import fr.xephi.authme.settings.Settings; import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.PluginSettings; import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.settings.properties.SecuritySettings; import fr.xephi.authme.settings.properties.SecuritySettings;
import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.ExceptionUtils;
import java.io.File; import java.io.File;
import java.io.FileWriter; import java.io.FileWriter;
@ -101,7 +101,7 @@ public final class ConsoleLogger {
* @param th The Throwable to log * @param th The Throwable to log
*/ */
public static void logException(String message, Throwable th) { public static void logException(String message, Throwable th) {
warning(message + " " + StringUtils.formatException(th)); warning(message + " " + ExceptionUtils.formatException(th));
writeLog(Throwables.getStackTraceAsString(th)); writeLog(Throwables.getStackTraceAsString(th));
} }

View File

@ -7,6 +7,7 @@ import fr.xephi.authme.service.HelpTranslationGenerator;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
import javax.inject.Inject; import javax.inject.Inject;
import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.util.List; import java.util.List;
@ -24,8 +25,8 @@ public class UpdateHelpMessagesCommand implements ExecutableCommand {
@Override @Override
public void executeCommand(CommandSender sender, List<String> arguments) { public void executeCommand(CommandSender sender, List<String> arguments) {
try { try {
helpTranslationGenerator.updateHelpFile(); File updatedFile = helpTranslationGenerator.updateHelpFile();
sender.sendMessage("Successfully updated the help file"); sender.sendMessage("Successfully updated the help file '" + updatedFile.getName() + "'");
helpMessagesService.reloadMessagesFile(); helpMessagesService.reloadMessagesFile();
} catch (IOException e) { } catch (IOException e) {
sender.sendMessage("Could not update help file: " + e.getMessage()); sender.sendMessage("Could not update help file: " + e.getMessage());

View File

@ -32,7 +32,7 @@ public enum AllowFlightRestoreType {
} }
}, },
/** Always set flight enabled to false. */ /** The user's flight handling is not modified. */
NOTHING { NOTHING {
@Override @Override
public void restoreAllowFlight(Player player, LimboPlayer limbo) { public void restoreAllowFlight(Player player, LimboPlayer limbo) {

View File

@ -14,7 +14,6 @@ import fr.xephi.authme.service.BukkitService;
import fr.xephi.authme.service.CommonService; import fr.xephi.authme.service.CommonService;
import fr.xephi.authme.service.bungeecord.BungeeSender; import fr.xephi.authme.service.bungeecord.BungeeSender;
import fr.xephi.authme.service.bungeecord.MessageType; import fr.xephi.authme.service.bungeecord.MessageType;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.settings.properties.RegistrationSettings; import fr.xephi.authme.settings.properties.RegistrationSettings;
import fr.xephi.authme.settings.properties.RestrictionSettings; import fr.xephi.authme.settings.properties.RestrictionSettings;
import fr.xephi.authme.util.PlayerUtils; import fr.xephi.authme.util.PlayerUtils;
@ -82,9 +81,8 @@ public class AsyncRegister implements AsynchronousProcess {
return false; return false;
} }
boolean isAsync = service.getProperty(PluginSettings.USE_ASYNC_TASKS); AuthMeAsyncPreRegisterEvent event = bukkitService.createAndCallEvent(
AuthMeAsyncPreRegisterEvent event = new AuthMeAsyncPreRegisterEvent(player, isAsync); isAsync -> new AuthMeAsyncPreRegisterEvent(player, isAsync));
bukkitService.callEvent(event);
if (!event.canRegister()) { if (!event.canRegister()) {
return false; return false;
} }

View File

@ -1,6 +1,7 @@
package fr.xephi.authme.security; package fr.xephi.authme.security;
import java.math.BigInteger; import java.math.BigInteger;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest; import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException; import java.security.NoSuchAlgorithmException;
@ -78,6 +79,20 @@ public final class HashUtils {
return hash.length() > 3 && hash.substring(0, 2).equals("$2"); return hash.length() > 3 && hash.substring(0, 2).equals("$2");
} }
/**
* Checks whether the two strings are equal to each other in a time-constant manner.
* This helps to avoid timing side channel attacks,
* cf. <a href="https://github.com/AuthMe/AuthMeReloaded/issues/1561">issue #1561</a>.
*
* @param string1 first string
* @param string2 second string
* @return true if the strings are equal to each other, false otherwise
*/
public static boolean isEqual(String string1, String string2) {
return MessageDigest.isEqual(
string1.getBytes(StandardCharsets.UTF_8), string2.getBytes(StandardCharsets.UTF_8));
}
/** /**
* Hash the message with the given algorithm and return the hash in its hexadecimal notation. * Hash the message with the given algorithm and return the hash in its hexadecimal notation.
* *

View File

@ -8,7 +8,7 @@ import fr.xephi.authme.security.crypts.description.SaltType;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import fr.xephi.authme.settings.Settings; import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.settings.properties.HooksSettings; import fr.xephi.authme.settings.properties.HooksSettings;
import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.ExceptionUtils;
import javax.inject.Inject; import javax.inject.Inject;
@ -39,7 +39,7 @@ public class BCrypt implements EncryptionMethod {
try { try {
return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash()); return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash());
} catch (IllegalArgumentException e) { } catch (IllegalArgumentException e) {
ConsoleLogger.warning("Bcrypt checkpw() returned " + StringUtils.formatException(e)); ConsoleLogger.warning("Bcrypt checkpw() returned " + ExceptionUtils.formatException(e));
} }
return false; return false;
} }

View File

@ -3,6 +3,8 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
@Recommendation(Usage.RECOMMENDED) @Recommendation(Usage.RECOMMENDED)
public class BCrypt2y extends HexSaltedMethod { public class BCrypt2y extends HexSaltedMethod {
@ -23,7 +25,7 @@ public class BCrypt2y extends HexSaltedMethod {
// The salt is the first 29 characters of the hash // The salt is the first 29 characters of the hash
String salt = hash.substring(0, 29); String salt = hash.substring(0, 29);
return hash.equals(computeHash(password, salt, null)); return isEqual(hash, computeHash(password, salt, null));
} }
@Override @Override

View File

@ -2,12 +2,12 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.security.HashUtils; import fr.xephi.authme.security.HashUtils;
import fr.xephi.authme.util.RandomStringUtils;
import fr.xephi.authme.security.crypts.description.HasSalt; import fr.xephi.authme.security.crypts.description.HasSalt;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.SaltType; import fr.xephi.authme.security.crypts.description.SaltType;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.ExceptionUtils;
import fr.xephi.authme.util.RandomStringUtils;
/** /**
@ -37,7 +37,7 @@ public class Ipb4 implements EncryptionMethod {
try { try {
return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash()); return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash());
} catch (IllegalArgumentException e) { } catch (IllegalArgumentException e) {
ConsoleLogger.warning("Bcrypt checkpw() returned " + StringUtils.formatException(e)); ConsoleLogger.warning("Bcrypt checkpw() returned " + ExceptionUtils.formatException(e));
} }
return false; return false;
} }

View File

@ -4,6 +4,8 @@ import fr.xephi.authme.security.HashUtils;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
@Recommendation(Usage.ACCEPTABLE) @Recommendation(Usage.ACCEPTABLE)
public class Joomla extends HexSaltedMethod { public class Joomla extends HexSaltedMethod {
@ -16,7 +18,7 @@ public class Joomla extends HexSaltedMethod {
public boolean comparePassword(String password, HashedPassword hashedPassword, String unusedName) { public boolean comparePassword(String password, HashedPassword hashedPassword, String unusedName) {
String hash = hashedPassword.getHash(); String hash = hashedPassword.getHash();
String[] hashParts = hash.split(":"); String[] hashParts = hash.split(":");
return hashParts.length == 2 && hash.equals(computeHash(password, hashParts[1], null)); return hashParts.length == 2 && isEqual(hash, computeHash(password, hashParts[1], null));
} }
@Override @Override

View File

@ -1,5 +1,6 @@
package fr.xephi.authme.security.crypts; package fr.xephi.authme.security.crypts;
import static fr.xephi.authme.security.HashUtils.isEqual;
import static fr.xephi.authme.security.HashUtils.md5; import static fr.xephi.authme.security.HashUtils.md5;
public class Md5vB extends HexSaltedMethod { public class Md5vB extends HexSaltedMethod {
@ -13,7 +14,7 @@ public class Md5vB extends HexSaltedMethod {
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
String hash = hashedPassword.getHash(); String hash = hashedPassword.getHash();
String[] line = hash.split("\\$"); String[] line = hash.split("\\$");
return line.length == 4 && hash.equals(computeHash(password, line[2], name)); return line.length == 4 && isEqual(hash, computeHash(password, line[2], name));
} }
@Override @Override

View File

@ -10,6 +10,8 @@ import fr.xephi.authme.security.crypts.description.Usage;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.security.MessageDigest; import java.security.MessageDigest;
import static fr.xephi.authme.security.HashUtils.isEqual;
/** /**
* Encryption method compatible with phpBB3. * Encryption method compatible with phpBB3.
* <p> * <p>
@ -43,7 +45,7 @@ public class PhpBB implements EncryptionMethod {
} else if (hash.length() == 34) { } else if (hash.length() == 34) {
return PhpassSaltedMd5.phpbb_check_hash(password, hash); return PhpassSaltedMd5.phpbb_check_hash(password, hash);
} else { } else {
return PhpassSaltedMd5.md5(password).equals(hash); return isEqual(hash, PhpassSaltedMd5.md5(password));
} }
} }
@ -153,7 +155,7 @@ public class PhpBB implements EncryptionMethod {
} }
private static boolean phpbb_check_hash(String password, String hash) { private static boolean phpbb_check_hash(String password, String hash) {
return _hash_crypt_private(password, hash).equals(hash); return isEqual(hash, _hash_crypt_private(password, hash)); // #1561: fix timing issue
} }
} }
} }

View File

@ -1,5 +1,7 @@
package fr.xephi.authme.security.crypts; package fr.xephi.authme.security.crypts;
import static fr.xephi.authme.security.HashUtils.isEqual;
/** /**
* Common supertype for encryption methods which store their salt separately from the hash. * Common supertype for encryption methods which store their salt separately from the hash.
*/ */
@ -19,7 +21,7 @@ public abstract class SeparateSaltMethod implements EncryptionMethod {
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
return hashedPassword.getHash().equals(computeHash(password, hashedPassword.getSalt(), null)); return isEqual(hashedPassword.getHash(), computeHash(password, hashedPassword.getSalt(), null));
} }
@Override @Override

View File

@ -3,6 +3,7 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
import static fr.xephi.authme.security.HashUtils.sha256; import static fr.xephi.authme.security.HashUtils.sha256;
@Recommendation(Usage.RECOMMENDED) @Recommendation(Usage.RECOMMENDED)
@ -14,10 +15,10 @@ public class Sha256 extends HexSaltedMethod {
} }
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String playerName) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
String hash = hashedPassword.getHash(); String hash = hashedPassword.getHash();
String[] line = hash.split("\\$"); String[] line = hash.split("\\$");
return line.length == 4 && hash.equals(computeHash(password, line[2], "")); return line.length == 4 && isEqual(hash, computeHash(password, line[2], name));
} }
@Override @Override

View File

@ -7,6 +7,8 @@ import fr.xephi.authme.security.crypts.description.SaltType;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import fr.xephi.authme.util.RandomStringUtils; import fr.xephi.authme.util.RandomStringUtils;
import static fr.xephi.authme.security.HashUtils.isEqual;
/** /**
* Hashing algorithm for SMF forums. * Hashing algorithm for SMF forums.
* <p> * <p>
@ -32,7 +34,7 @@ public class Smf implements EncryptionMethod {
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
return computeHash(password, null, name).equals(hashedPassword.getHash()); return isEqual(hashedPassword.getHash(), computeHash(password, null, name));
} }
@Override @Override

View File

@ -5,6 +5,8 @@ import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.SaltType; import fr.xephi.authme.security.crypts.description.SaltType;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
/** /**
* Common type for encryption methods which do not use any salt whatsoever. * Common type for encryption methods which do not use any salt whatsoever.
*/ */
@ -26,7 +28,7 @@ public abstract class UnsaltedMethod implements EncryptionMethod {
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
return hashedPassword.getHash().equals(computeHash(password)); return isEqual(hashedPassword.getHash(), computeHash(password));
} }
@Override @Override

View File

@ -5,6 +5,8 @@ import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.SaltType; import fr.xephi.authme.security.crypts.description.SaltType;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
/** /**
* Common supertype of encryption methods that use a player's username * Common supertype of encryption methods that use a player's username
* (or something based on it) as embedded salt. * (or something based on it) as embedded salt.
@ -23,7 +25,7 @@ public abstract class UsernameSaltMethod implements EncryptionMethod {
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
return hashedPassword.getHash().equals(computeHash(password, name).getHash()); return isEqual(hashedPassword.getHash(), computeHash(password, name).getHash());
} }
@Override @Override

View File

@ -3,6 +3,7 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
import static fr.xephi.authme.security.crypts.BCryptService.hashpw; import static fr.xephi.authme.security.crypts.BCryptService.hashpw;
@Recommendation(Usage.RECOMMENDED) @Recommendation(Usage.RECOMMENDED)
@ -14,12 +15,12 @@ public class Wbb4 extends HexSaltedMethod {
} }
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String playerName) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
if (hashedPassword.getHash().length() != 60) { if (hashedPassword.getHash().length() != 60) {
return false; return false;
} }
String salt = hashedPassword.getHash().substring(0, 29); String salt = hashedPassword.getHash().substring(0, 29);
return computeHash(password, salt, null).equals(hashedPassword.getHash()); return isEqual(hashedPassword.getHash(), computeHash(password, salt, name));
} }
@Override @Override

View File

@ -12,6 +12,8 @@ import java.security.MessageDigest;
import java.security.SecureRandom; import java.security.SecureRandom;
import java.util.Arrays; import java.util.Arrays;
import static fr.xephi.authme.security.HashUtils.isEqual;
@Recommendation(Usage.ACCEPTABLE) @Recommendation(Usage.ACCEPTABLE)
@HasSalt(value = SaltType.TEXT, length = 9) @HasSalt(value = SaltType.TEXT, length = 9)
// Note ljacqu 20151228: Wordpress is actually a salted algorithm but salt generation is handled internally // Note ljacqu 20151228: Wordpress is actually a salted algorithm but salt generation is handled internally
@ -115,7 +117,7 @@ public class Wordpress extends UnsaltedMethod {
public boolean comparePassword(String password, HashedPassword hashedPassword, String name) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
String hash = hashedPassword.getHash(); String hash = hashedPassword.getHash();
String comparedHash = crypt(password, hash); String comparedHash = crypt(password, hash);
return comparedHash.equals(hash); return isEqual(hash, comparedHash);
} }
} }

View File

@ -3,6 +3,8 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.security.crypts.description.Recommendation; import fr.xephi.authme.security.crypts.description.Recommendation;
import fr.xephi.authme.security.crypts.description.Usage; import fr.xephi.authme.security.crypts.description.Usage;
import static fr.xephi.authme.security.HashUtils.isEqual;
@Recommendation(Usage.RECOMMENDED) @Recommendation(Usage.RECOMMENDED)
public class XAuth extends HexSaltedMethod { public class XAuth extends HexSaltedMethod {
@ -23,14 +25,14 @@ public class XAuth extends HexSaltedMethod {
} }
@Override @Override
public boolean comparePassword(String password, HashedPassword hashedPassword, String playerName) { public boolean comparePassword(String password, HashedPassword hashedPassword, String name) {
String hash = hashedPassword.getHash(); String hash = hashedPassword.getHash();
int saltPos = password.length() >= hash.length() ? hash.length() - 1 : password.length(); int saltPos = password.length() >= hash.length() ? hash.length() - 1 : password.length();
if (saltPos + 12 > hash.length()) { if (saltPos + 12 > hash.length()) {
return false; return false;
} }
String salt = hash.substring(saltPos, saltPos + 12); String salt = hash.substring(saltPos, saltPos + 12);
return hash.equals(computeHash(password, salt, null)); return isEqual(hash, computeHash(password, salt, name));
} }
@Override @Override

View File

@ -2,7 +2,7 @@ package fr.xephi.authme.security.crypts;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.security.HashUtils; import fr.xephi.authme.security.HashUtils;
import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.ExceptionUtils;
import java.util.regex.Matcher; import java.util.regex.Matcher;
import java.util.regex.Pattern; import java.util.regex.Pattern;
@ -32,7 +32,7 @@ public class XfBCrypt implements EncryptionMethod {
try { try {
return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash()); return HashUtils.isValidBcryptHash(hash.getHash()) && BCryptService.checkpw(password, hash.getHash());
} catch (IllegalArgumentException e) { } catch (IllegalArgumentException e) {
ConsoleLogger.warning("XfBCrypt checkpw() returned " + StringUtils.formatException(e)); ConsoleLogger.warning("XfBCrypt checkpw() returned " + ExceptionUtils.formatException(e));
} }
return false; return false;
} }

View File

@ -44,15 +44,17 @@ public class HelpTranslationGenerator {
/** /**
* Updates the help file to contain entries for all commands. * Updates the help file to contain entries for all commands.
* *
* @return the help file that has been updated
* @throws IOException if the help file cannot be written to * @throws IOException if the help file cannot be written to
*/ */
public void updateHelpFile() throws IOException { public File updateHelpFile() throws IOException {
String languageCode = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE); String languageCode = settings.getProperty(PluginSettings.MESSAGES_LANGUAGE);
File helpFile = new File(dataFolder, "messages/help_" + languageCode + ".yml"); File helpFile = new File(dataFolder, "messages/help_" + languageCode + ".yml");
Map<String, Object> helpEntries = generateHelpMessageEntries(); Map<String, Object> helpEntries = generateHelpMessageEntries();
String helpEntriesYaml = exportToYaml(helpEntries); String helpEntriesYaml = exportToYaml(helpEntries);
Files.write(helpFile.toPath(), helpEntriesYaml.getBytes(), StandardOpenOption.TRUNCATE_EXISTING); Files.write(helpFile.toPath(), helpEntriesYaml.getBytes(), StandardOpenOption.TRUNCATE_EXISTING);
return helpFile;
} }
private static String exportToYaml(Map<String, Object> helpEntries) { private static String exportToYaml(Map<String, Object> helpEntries) {

View File

@ -33,4 +33,14 @@ public final class ExceptionUtils {
} }
return null; return null;
} }
/**
* Format the information from a Throwable as string, retaining the type and its message.
*
* @param th the throwable to process
* @return string with the type of the Throwable and its message, e.g. "[IOException]: Could not open stream"
*/
public static String formatException(Throwable th) {
return "[" + th.getClass().getSimpleName() + "]: " + th.getMessage();
}
} }

View File

@ -66,17 +66,6 @@ public final class StringUtils {
return str == null || str.trim().isEmpty(); return str == null || str.trim().isEmpty();
} }
/**
* Format the information from a Throwable as string, retaining the type and its message.
*
* @param th The throwable to process
*
* @return String with the type of the Throwable and its message, e.g. "[IOException]: Could not open stream"
*/
public static String formatException(Throwable th) {
return "[" + th.getClass().getSimpleName() + "]: " + th.getMessage();
}
/** /**
* Check that the given needle is in the middle of the haystack, i.e. that the haystack * Check that the given needle is in the middle of the haystack, i.e. that the haystack
* contains the needle and that it is not at the very start or end. * contains the needle and that it is not at the very start or end.

View File

@ -30,23 +30,11 @@ public class CodeClimateConfigTest {
assertThat(excludePaths, not(empty())); assertThat(excludePaths, not(empty()));
removeTestsExclusionOrThrow(excludePaths); removeTestsExclusionOrThrow(excludePaths);
for (String path : excludePaths) { for (String path : excludePaths) {
verifySourceFileExists(path);
}
}
private static void verifySourceFileExists(String path) {
// Note ljacqu 20170323: In the future, we could have legitimate exclusions that don't fulfill these checks,
// in which case this test needs to be adapted accordingly.
if (!path.startsWith(TestHelper.SOURCES_FOLDER)) {
fail("Unexpected path '" + path + "': expected to start with sources folder");
} else if (!path.endsWith(".java")) {
fail("Expected path '" + path + "' to end with '.java'");
}
if (!new File(path).exists()) { if (!new File(path).exists()) {
fail("Path '" + path + "' does not exist!"); fail("Path '" + path + "' does not exist!");
} }
} }
}
private static void removeTestsExclusionOrThrow(List<String> excludePaths) { private static void removeTestsExclusionOrThrow(List<String> excludePaths) {
boolean wasRemoved = excludePaths.removeIf("src/test/java/**/*Test.java"::equals); boolean wasRemoved = excludePaths.removeIf("src/test/java/**/*Test.java"::equals);

View File

@ -0,0 +1,70 @@
package fr.xephi.authme.command.executable.authme;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.command.help.HelpMessagesService;
import fr.xephi.authme.service.HelpTranslationGenerator;
import org.bukkit.command.CommandSender;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import java.io.File;
import java.io.IOException;
import java.util.Collections;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;
/**
* Test for {@link UpdateHelpMessagesCommand}.
*/
@RunWith(MockitoJUnitRunner.class)
public class UpdateHelpMessagesCommandTest {
@InjectMocks
private UpdateHelpMessagesCommand command;
@Mock
private HelpTranslationGenerator helpTranslationGenerator;
@Mock
private HelpMessagesService helpMessagesService;
@BeforeClass
public static void setUpLogger() {
TestHelper.setupLogger();
}
@Test
public void shouldUpdateHelpMessage() throws IOException {
// given
File updatedFile = new File("some/path/help_xx.yml");
given(helpTranslationGenerator.updateHelpFile()).willReturn(updatedFile);
CommandSender sender = mock(CommandSender.class);
// when
command.executeCommand(sender, Collections.emptyList());
// then
verify(helpMessagesService).reloadMessagesFile();
verify(sender).sendMessage("Successfully updated the help file 'help_xx.yml'");
}
@Test
public void shouldCatchAndReportException() throws IOException {
// given
given(helpTranslationGenerator.updateHelpFile()).willThrow(new IOException("Couldn't do the thing"));
CommandSender sender = mock(CommandSender.class);
// when
command.executeCommand(sender, Collections.emptyList());
// then
verify(sender).sendMessage("Could not update help file: Couldn't do the thing");
verifyZeroInteractions(helpMessagesService);
}
}

View File

@ -2,6 +2,7 @@ package fr.xephi.authme.message;
import fr.xephi.authme.TestHelper; import fr.xephi.authme.TestHelper;
import fr.xephi.authme.command.help.HelpSection; import fr.xephi.authme.command.help.HelpSection;
import fr.xephi.authme.util.ExceptionUtils;
import fr.xephi.authme.util.StringUtils; import fr.xephi.authme.util.StringUtils;
import org.bukkit.configuration.file.YamlConfiguration; import org.bukkit.configuration.file.YamlConfiguration;
import org.junit.BeforeClass; import org.junit.BeforeClass;
@ -85,7 +86,7 @@ public class YamlTextFileCheckerTest {
errors.add("Message for '" + mandatoryKey + "' is empty"); errors.add("Message for '" + mandatoryKey + "' is empty");
} }
} catch (Exception e) { } catch (Exception e) {
errors.add("Could not load file: " + StringUtils.formatException(e)); errors.add("Could not load file: " + ExceptionUtils.formatException(e));
} }
} }
} }

View File

@ -12,7 +12,6 @@ import fr.xephi.authme.process.register.executors.RegistrationMethod;
import fr.xephi.authme.process.register.executors.TwoFactorRegisterParams; import fr.xephi.authme.process.register.executors.TwoFactorRegisterParams;
import fr.xephi.authme.service.BukkitService; import fr.xephi.authme.service.BukkitService;
import fr.xephi.authme.service.CommonService; import fr.xephi.authme.service.CommonService;
import fr.xephi.authme.settings.properties.PluginSettings;
import fr.xephi.authme.settings.properties.RegistrationSettings; import fr.xephi.authme.settings.properties.RegistrationSettings;
import fr.xephi.authme.settings.properties.RestrictionSettings; import fr.xephi.authme.settings.properties.RestrictionSettings;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
@ -21,11 +20,11 @@ import org.junit.runner.RunWith;
import org.mockito.InjectMocks; import org.mockito.InjectMocks;
import org.mockito.Mock; import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner; import org.mockito.junit.MockitoJUnitRunner;
import org.mockito.stubbing.Answer;
import java.util.function.Function;
import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given; import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.only; import static org.mockito.Mockito.only;
import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verify;
@ -108,7 +107,7 @@ public class AsyncRegisterTest {
@Test @Test
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void shouldStopForFailedExecutorCheck() { public void shouldStopForCanceledEvent() {
// given // given
String name = "edbert"; String name = "edbert";
Player player = mockPlayerWithName(name); Player player = mockPlayerWithName(name);
@ -116,14 +115,13 @@ public class AsyncRegisterTest {
given(playerCache.isAuthenticated(name)).willReturn(false); given(playerCache.isAuthenticated(name)).willReturn(false);
given(commonService.getProperty(RegistrationSettings.IS_ENABLED)).willReturn(true); given(commonService.getProperty(RegistrationSettings.IS_ENABLED)).willReturn(true);
given(dataSource.isAuthAvailable(name)).willReturn(false); given(dataSource.isAuthAvailable(name)).willReturn(false);
given(commonService.getProperty(PluginSettings.USE_ASYNC_TASKS)).willReturn(true);
RegistrationExecutor executor = mock(RegistrationExecutor.class); RegistrationExecutor executor = mock(RegistrationExecutor.class);
TwoFactorRegisterParams params = TwoFactorRegisterParams.of(player); TwoFactorRegisterParams params = TwoFactorRegisterParams.of(player);
singletonStoreWillReturn(registrationExecutorStore, executor); singletonStoreWillReturn(registrationExecutorStore, executor);
doAnswer((Answer<Void>) invocation -> {
((AuthMeAsyncPreRegisterEvent) invocation.getArgument(0)).setCanRegister(false); AuthMeAsyncPreRegisterEvent canceledEvent = new AuthMeAsyncPreRegisterEvent(player, true);
return null; canceledEvent.setCanRegister(false);
}).when(bukkitService).callEvent(any(AuthMeAsyncPreRegisterEvent.class)); given(bukkitService.createAndCallEvent(any(Function.class))).willReturn(canceledEvent);
// when // when
asyncRegister.register(RegistrationMethod.TWO_FACTOR_REGISTRATION, params); asyncRegister.register(RegistrationMethod.TWO_FACTOR_REGISTRATION, params);
@ -134,7 +132,7 @@ public class AsyncRegisterTest {
@Test @Test
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public void shouldStopForCancelledEvent() { public void shouldStopForFailedExecutorCheck() {
// given // given
String name = "edbert"; String name = "edbert";
Player player = mockPlayerWithName(name); Player player = mockPlayerWithName(name);
@ -143,12 +141,14 @@ public class AsyncRegisterTest {
given(commonService.getProperty(RegistrationSettings.IS_ENABLED)).willReturn(true); given(commonService.getProperty(RegistrationSettings.IS_ENABLED)).willReturn(true);
given(commonService.getProperty(RestrictionSettings.MAX_REGISTRATION_PER_IP)).willReturn(0); given(commonService.getProperty(RestrictionSettings.MAX_REGISTRATION_PER_IP)).willReturn(0);
given(dataSource.isAuthAvailable(name)).willReturn(false); given(dataSource.isAuthAvailable(name)).willReturn(false);
given(commonService.getProperty(PluginSettings.USE_ASYNC_TASKS)).willReturn(true);
RegistrationExecutor executor = mock(RegistrationExecutor.class); RegistrationExecutor executor = mock(RegistrationExecutor.class);
TwoFactorRegisterParams params = TwoFactorRegisterParams.of(player); TwoFactorRegisterParams params = TwoFactorRegisterParams.of(player);
given(executor.isRegistrationAdmitted(params)).willReturn(false); given(executor.isRegistrationAdmitted(params)).willReturn(false);
singletonStoreWillReturn(registrationExecutorStore, executor); singletonStoreWillReturn(registrationExecutorStore, executor);
given(bukkitService.createAndCallEvent(any(Function.class)))
.willReturn(new AuthMeAsyncPreRegisterEvent(player, false));
// when // when
asyncRegister.register(RegistrationMethod.TWO_FACTOR_REGISTRATION, params); asyncRegister.register(RegistrationMethod.TWO_FACTOR_REGISTRATION, params);

View File

@ -2,6 +2,7 @@ package fr.xephi.authme.security;
import ch.jalu.injector.Injector; import ch.jalu.injector.Injector;
import ch.jalu.injector.InjectorBuilder; import ch.jalu.injector.InjectorBuilder;
import fr.xephi.authme.TestHelper;
import fr.xephi.authme.security.crypts.Argon2; import fr.xephi.authme.security.crypts.Argon2;
import fr.xephi.authme.security.crypts.EncryptionMethod; import fr.xephi.authme.security.crypts.EncryptionMethod;
import fr.xephi.authme.security.crypts.HashedPassword; import fr.xephi.authme.security.crypts.HashedPassword;
@ -40,6 +41,7 @@ public class HashAlgorithmIntegrationTest {
given(settings.getProperty(SecuritySettings.PBKDF2_NUMBER_OF_ROUNDS)).willReturn(10_000); given(settings.getProperty(SecuritySettings.PBKDF2_NUMBER_OF_ROUNDS)).willReturn(10_000);
injector = new InjectorBuilder().addDefaultHandlers("fr.xephi.authme").create(); injector = new InjectorBuilder().addDefaultHandlers("fr.xephi.authme").create();
injector.register(Settings.class, settings); injector.register(Settings.class, settings);
TestHelper.setupLogger();
} }
@Test @Test

View File

@ -123,4 +123,13 @@ public class HashUtilsTest {
assertThat(HashUtils.isValidBcryptHash("#2ae5fc78"), equalTo(false)); assertThat(HashUtils.isValidBcryptHash("#2ae5fc78"), equalTo(false));
} }
@Test
public void shouldCompareStrings() {
// given / when / then
assertThat(HashUtils.isEqual("test", "test"), equalTo(true));
assertThat(HashUtils.isEqual("test", "Test"), equalTo(false));
assertThat(HashUtils.isEqual("1234", "1234."), equalTo(false));
assertThat(HashUtils.isEqual("ພາສາຫວຽດນາມ", "ພາສາຫວຽດນາມ"), equalTo(true));
assertThat(HashUtils.isEqual("test", "tëst"), equalTo(false));
}
} }

View File

@ -4,8 +4,10 @@ import fr.xephi.authme.ReflectionTestUtils;
import fr.xephi.authme.TestHelper; import fr.xephi.authme.TestHelper;
import org.junit.Test; import org.junit.Test;
import java.net.MalformedURLException;
import java.util.ConcurrentModificationException; import java.util.ConcurrentModificationException;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.nullValue; import static org.hamcrest.Matchers.nullValue;
import static org.hamcrest.Matchers.sameInstance; import static org.hamcrest.Matchers.sameInstance;
import static org.junit.Assert.assertThat; import static org.junit.Assert.assertThat;
@ -58,4 +60,16 @@ public class ExceptionUtilsTest {
// given / when / then // given / when / then
TestHelper.validateHasOnlyPrivateEmptyConstructor(ExceptionUtils.class); TestHelper.validateHasOnlyPrivateEmptyConstructor(ExceptionUtils.class);
} }
@Test
public void shouldFormatException() {
// given
MalformedURLException ex = new MalformedURLException("Unrecognized URL format");
// when
String result = ExceptionUtils.formatException(ex);
// then
assertThat(result, equalTo("[MalformedURLException]: Unrecognized URL format"));
}
} }

View File

@ -3,8 +3,6 @@ package fr.xephi.authme.util;
import fr.xephi.authme.TestHelper; import fr.xephi.authme.TestHelper;
import org.junit.Test; import org.junit.Test;
import java.net.MalformedURLException;
import static java.util.Arrays.asList; import static java.util.Arrays.asList;
import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan; import static org.hamcrest.Matchers.greaterThan;
@ -63,18 +61,6 @@ public class StringUtilsTest {
assertFalse(StringUtils.isEmpty(" test")); assertFalse(StringUtils.isEmpty(" test"));
} }
@Test
public void shouldFormatException() {
// given
MalformedURLException ex = new MalformedURLException("Unrecognized URL format");
// when
String result = StringUtils.formatException(ex);
// then
assertThat(result, equalTo("[MalformedURLException]: Unrecognized URL format"));
}
@Test @Test
public void shouldGetDifferenceWithNullString() { public void shouldGetDifferenceWithNullString() {
// given/when/then // given/when/then