The encryption style to use
- * @param playerThe player encrypting the book
- * @param keyThe encryption key to use
- * @param groupThe group to encrypt for
+ * @param encryptionStyleThe encryption style to use
+ * @param playerThe player encrypting the book
+ * @param keyThe encryption key to use
+ * @param groupThe group to encrypt for
+ * @param preventAdminDecryptionWhether to prevent storage of a key that can be used for admin decryption
* @returnTrue if the book was encrypted successfully
*/ protected boolean encryptBook(@NotNull EncryptionStyle encryptionStyle, @NotNull Player player, @NotNull String key, - @NotNull String group) { + @NotNull String group, boolean preventAdminDecryption) { ItemSlot heldSlot = InventoryHelper.getHeldSlotBook(player, false, false, true, true); - ItemStack encryptedBook = EncryptionHelper.encryptBook(player, heldSlot == ItemSlot.MAIN_HAND, key, encryptionStyle, group); + ItemStack encryptedBook = EncryptionHelper.encryptBook(player, heldSlot == ItemSlot.MAIN_HAND, key, + encryptionStyle, group, preventAdminDecryption); if (encryptedBook != null) { InventoryHelper.setHeldWrittenBook(player, encryptedBook); @@ -119,19 +128,20 @@ public class CommandEncrypt implements TabExecutor { @NotNull public ListThe arguments given
+ * @param senderThe command sender executing this command
+ * @param argumentsThe arguments given
* @param groupEncryptWhether to auto-complete for group encryption
* @returnThe strings to auto-complete
*/ @NotNull - protected ListTrue if admin decrypt removal is allowed
+ */ + public boolean allowPreventAdminDecryption() { + return this.allowPreventAdminDecryption; + } + /** * Gets the path used to store encrypted books * @@ -316,6 +326,7 @@ public class BwBConfig { config.set(ConfigOption.AUTHOR_ONLY_UNSIGN.getConfigNode(), this.authorOnlyUnsign); config.set(ConfigOption.AUTHOR_ONLY_SAVE.getConfigNode(), this.authorOnlySave); config.set(ConfigOption.CHANGE_GENERATION_ON_COPY.getConfigNode(), this.changeGenerationOnCopy); + config.set(ConfigOption.ALLOW_PREVENT_ADMIN_DECRYPTION.getConfigNode(), this.allowPreventAdminDecryption); BooksWithoutBorders.getInstance().saveConfig(); } @@ -343,6 +354,7 @@ public class BwBConfig { this.changeGenerationOnCopy = getBoolean(config, ConfigOption.CHANGE_GENERATION_ON_COPY); this.enableBookshelfPeeking = getBoolean(config, ConfigOption.ENABLE_BOOKSHELF_PEEKING); this.useRealEncryption = getBoolean(config, ConfigOption.USE_REAL_ENCRYPTION); + this.allowPreventAdminDecryption = getBoolean(config, ConfigOption.ALLOW_PREVENT_ADMIN_DECRYPTION); String language = config.getString("language", "en"); this.translator.loadLanguages(BooksWithoutBorders.getInstance().getDataFolder(), "en", language); diff --git a/src/main/java/net/knarcraft/bookswithoutborders/config/ConfigOption.java b/src/main/java/net/knarcraft/bookswithoutborders/config/ConfigOption.java index 1f79a5b..4e9b368 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/config/ConfigOption.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/config/ConfigOption.java @@ -81,6 +81,11 @@ public enum ConfigOption { * Whether to use real AES encryption instead of storing garbled book text, while the full plaintext is stored in a file */ USE_REAL_ENCRYPTION("Options.Use_Real_Encryption", false), + + /** + * Whether to allow disabling admin encryption for a real encrypted book + */ + ALLOW_PREVENT_ADMIN_DECRYPTION("Options.Allow_Prevent_Admin_Decryption", false), ; private final String configNode; diff --git a/src/main/java/net/knarcraft/bookswithoutborders/config/Permission.java b/src/main/java/net/knarcraft/bookswithoutborders/config/Permission.java index dadb981..1b73e37 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/config/Permission.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/config/Permission.java @@ -50,7 +50,13 @@ public enum Permission { /** * The permission for using special signs */ - SIGNS("signs"); + SIGNS("signs"), + + /** + * The permission for preventing a real encrypted book to be decrypted by an admin + */ + PREVENT_ADMIN_DECRYPTION("preventAdminDecryption"), + ; private final @NotNull String node; diff --git a/src/main/java/net/knarcraft/bookswithoutborders/container/EncryptedBook.java b/src/main/java/net/knarcraft/bookswithoutborders/container/EncryptedBook.java index b38a01c..85ba1d1 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/container/EncryptedBook.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/container/EncryptedBook.java @@ -11,13 +11,14 @@ import java.util.List; /** * A representation of an encrypted book * - * @param bookMetaThe book's book meta
- * @param encryptionStyleThe book's encryption style
- * @param encryptionKeyThe book's encryption key, or null if admin decrypt is forbidden
- * @param dataThe encrypted pages of the book
- * @param aesConfigurationThe AES configuration for the book, or null if not AES encrypted
+ * @param bookMetaThe book's book meta
+ * @param encryptionStyleThe book's encryption style
+ * @param encryptionKeyThe book's encryption key, or null if admin decrypt is forbidden
+ * @param dataThe encrypted pages of the book
+ * @param aesConfigurationThe AES configuration for the book, or null if not AES encrypted
+ * @param preventAdminDecryptWhether this book should not support admin decryption
*/ public record EncryptedBook(@NotNull BookMeta bookMeta, @NotNull EncryptionStyle encryptionStyle, @NotNull String encryptionKey, @NotNull ListThe player encrypting the book
- * @param mainHandWhether the player is holding the book in its main hand
- * @param keyThe key/password to use for encryption
- * @param styleThe encryption style to use
+ * @param playerThe player encrypting the book
+ * @param mainHandWhether the player is holding the book in its main hand
+ * @param keyThe key/password to use for encryption
+ * @param styleThe encryption style to use
+ * @param preventAdminDecryptWhether to prevent storage of a key that can be used for admin decryption
* @returnAn encrypted version of the book
*/ @Nullable public static ItemStack encryptBook(@NotNull Player player, boolean mainHand, @NotNull String key, - @NotNull EncryptionStyle style) { - return encryptBook(player, mainHand, key, style, ""); + @NotNull EncryptionStyle style, boolean preventAdminDecrypt) { + return encryptBook(player, mainHand, key, style, "", preventAdminDecrypt); } /** * Encrypts a book * - * @param playerThe player encrypting the book
- * @param mainHandWhether the player is holding the book in its main hand
- * @param keyThe key/password to use for encryption
- * @param styleThe encryption style to use
- * @param groupNameThe name of the group to encrypt for, or "" otherwise
+ * @param playerThe player encrypting the book
+ * @param mainHandWhether the player is holding the book in its main hand
+ * @param keyThe key/password to use for encryption
+ * @param styleThe encryption style to use
+ * @param groupNameThe name of the group to encrypt for, or "" otherwise
+ * @param preventAdminDecryptWhether to prevent storage of a key that can be used for admin decryption
* @returnAn encrypted version of the book
*/ @Nullable public static ItemStack encryptBook(Player player, boolean mainHand, @NotNull String key, - @NotNull EncryptionStyle style, @NotNull String groupName) { + @NotNull EncryptionStyle style, @NotNull String groupName, + boolean preventAdminDecrypt) { BookMeta book = InventoryHelper.getHeldBookMetadata(player, mainHand); if (book == null) { BooksWithoutBorders.sendErrorMessage(player, "Unable to get metadata from the held book!"); @@ -167,7 +170,8 @@ public final class EncryptionHelper { AESConfiguration configuration = AESConfiguration.getNewConfiguration(hashedKey); //Save the book's un-encrypted contents to a file - BookMeta newMetadata = saveBookPlaintext(groupName, player, book, style, hashedKey, configuration); + BookMeta newMetadata = saveEncryptedBook(groupName, player, + new EncryptedBook(book, style, hashedKey, new ArrayList<>(), configuration, preventAdminDecrypt)); if (newMetadata == null) { return null; } @@ -216,26 +220,22 @@ public final class EncryptionHelper { } /** - * Saves a book's plain text to a file + * Saves an encrypted book to a file * - * @param groupNameThe group who's allowed to decrypt the book, or ""
- * @param playerThe player trying to encrypt the book
- * @param bookThe book to encrypt
- * @param encryptionStyleThe encryption style used for the book
- * @param keyThe key used to encrypt the book
- * @param aesConfigurationThe AES configuration to use, if encrypting using AES
+ * @param groupNameThe group who's allowed to decrypt the book, or ""
+ * @param playerThe player trying to encrypt the book
+ * @param encryptedBookThe book to encrypt
* @returnThe new metadata for the book, or null if it could not be saved
*/ @Nullable - private static BookMeta saveBookPlaintext(@NotNull String groupName, @NotNull Player player, - @NotNull BookMeta book, @NotNull EncryptionStyle encryptionStyle, - @NotNull String key, @NotNull AESConfiguration aesConfiguration) { - BookMeta newMetadata = book; + private static BookMeta saveEncryptedBook(@NotNull String groupName, @NotNull Player player, + @NotNull EncryptedBook encryptedBook) { + BookMeta newMetadata = encryptedBook.bookMeta(); boolean wasSaved; if (groupName.trim().isEmpty()) { - wasSaved = saveEncryptedBook(player, book, encryptionStyle, key, aesConfiguration); + wasSaved = saveEncryptedBook(player, encryptedBook); } else { - newMetadata = saveEncryptedBookForGroup(player, book, groupName); + newMetadata = saveEncryptedBookForGroup(player, encryptedBook.bookMeta(), groupName); wasSaved = newMetadata != null; } if (wasSaved) { @@ -327,7 +327,6 @@ public final class EncryptionHelper { File file = new File(path + fileName + ".yml"); if (!file.isFile()) { file = new File(path + fileName + ".txt"); - if (!file.isFile()) { BooksWithoutBorders.sendErrorMessage(player, "Incorrect decryption key!"); return null; @@ -476,20 +475,15 @@ public final class EncryptionHelper { /** * Saves an encrypted book to be decryptable for the given user * - * @param playerThe player encrypting the book
- * @param bookMetaDataMetadata for the book to encrypt
- * @param encryptionStyleThe style of encryption used
- * @param keyThe key to use for encryption
- * @param aesConfigurationThe AES configuration to use if encrypting with AES
+ * @param playerThe player encrypting the book
+ * @param encryptedBookThe book to save
* @returnThe new encrypted metadata for the book, or null if encryption failed
*/ @NotNull - private static Boolean saveEncryptedBook(@NotNull Player player, @NotNull BookMeta bookMetaData, - @NotNull EncryptionStyle encryptionStyle, @NotNull String key, - @Nullable AESConfiguration aesConfiguration) { + private static Boolean saveEncryptedBook(@NotNull Player player, @NotNull EncryptedBook encryptedBook) { String path = BooksWithoutBorders.getConfiguration().getEncryptedBookPath(); - String fileName = BookHelper.getBookFile(bookMetaData, player, true); + String fileName = BookHelper.getBookFile(encryptedBook.bookMeta(), player, true); fileName = cleanString(fileName); //cancels saving if file is already encrypted @@ -500,8 +494,7 @@ public final class EncryptionHelper { } try { - BookToFromTextHelper.encryptedBookToYml(path, fileName, - new EncryptedBook(bookMetaData, encryptionStyle, key, new ArrayList<>(), aesConfiguration)); + BookToFromTextHelper.encryptedBookToYml(path, fileName, encryptedBook); } catch (IOException exception) { BooksWithoutBorders.sendErrorMessage(player, "Encryption failed!"); return false; diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 5eeb612..71cf0d4 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -38,4 +38,8 @@ Options: # peek at books, if an admin gets a hold of a book with the same title and author, but only the encrypted AES cypher text is stored in the book. # Note that real encryption might alter, corrupt or lose a book's contents, so don't use real encryption with books # that have no backup in in-game book form or saved book form. - Use_Real_Encryption: false \ No newline at end of file + Use_Real_Encryption: false + # Whether to allow players to specifically disable admin decryption for a real encrypted book. This is only available + # when real encryption is enabled. It allows a player to prevent the storage of the encryption key in the plugin + # folder, meaning that the only way to decrypt the book is to provide the correct key. THIS IS A DANGEROUS OPTION! + Allow_Prevent_Admin_Decryption: false \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 441e472..ac2b36e 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -102,9 +102,11 @@ commands: Encrypts the book the player is holding. "key" is required and can be any phrase or number excluding spaces. "style" is not required. Possible values are "dna", "substitution", "aes", "onetimepad" and "magic". If real encryption is enabled, possible methods are restricted. + If real encryption and prevent admin decryption are enabled, the third argument prevents the key from being + stored in the server files, preventing admin decryption. If the password is lost, decryption is impossible. aliases: - bwbencrypt - usage: /