[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

Discussion in 'Inactive/Unsupported Plugins' started by Acru, Feb 14, 2011.

  1. Offline

    Acru

    Lockette - The sign-based container and door lock for Bukkit! - by Acru Jovian

    ElgarL has been assigned as the current maintainer of this project, please forward any important issues to him as well. This post is abandoned, but proceed to BukkitDev for updates.

    Download it at BukkitDev! (Alternate) (JAR) (Source), also view the Change Log on BukkitDev.



    Supported external plugins:
    • Permissions - Permissions/Groups
    • GroupManager - Permissions/Groups
    • PermissionsBukkit - SuperPerms/Groups
    • PermissionsEx - SuperPerms/Groups
    • bPermissions- SuperPerms/Groups
    • Towny - Groups/Zones
    • SimpleClans - Groups
    • mcMMO - Groups (Disabled by default now, due to issues.)
    • Factions - Groups
    • LWC - Zones
    • Register - Economy
    Alternate languages included:
    Confirmed compatible plugins: ColorSign, SpeedSign.
    Conflicting plugins: ChestShop, Most sign editors!


    The active Lockette information page will commute to BukkitDev soon, but the forum thread is still the best place for discussion.



    Overview:

    The purpose of this plugin is to restrict access to the contents of chests, dispensers, furnaces, and doors without the use of a database to track containers.

    To use, simply place a signpost on the floor directly beside a chest or other container to be locked. Enter [Private] as the first line. Your own name will automatically be entered on line 2 as the chest owner. Optionally type in the full names of two other users allowed to access the chest's inventory on lines 3 and 4.

    When done correctly, the sign will automatically fix itself to the side the target chest, protecting it from unauthorized access! Only the chest's owner can then break the sign or chest. (Warning: Anyone with permission to use WorldEdit commands or similar can circumvent the protection by removing the sign.)

    [​IMG]

    Additionally, you can enter [Everyone] on lines 3 or 4 instead of a user name to allow everyone access to the contents of a private container, or [Operators] to allow ops access. If a Permissions plugin is available, you can use groups like [Moderator] or [Admins] or others as defined in the Permissions settings files.

    The owner of a container can add more users by placing additional signs beside the container with the heading [More Users], where lines 2-4 specify the names of the additional users. You can edit the users on previously placed signs by right clicking the sign, and using the command '/lockette <line number> <text>' to change it.


    Working with Doors:

    To protect a door, you can use the same method as protecting a container, the sign will attach to the door automatically. In addition, you can attach a [Private] wall sign to any side of the blocks just above or just below a door. For double doors only one side needs a sign. Door support is enabled by default in the config file.

    Once a door is protected it will only open for someone listed as a user, and will not respond to redstone power or switches unless [Everyone] is listed as a user. Iron doors which usually won't open from clicking will work just as wooden doors. In addition, double doors will open together automatically!

    You can also use [More Users] signs as with containers, with the caveat that the sign cannot be placed on the block above the door if the [Private] sign is not above the door as well! (This is done to prevent a security uncertainty issue.)

    Protected doors will be closed automatically if a timer is set. A timer can be set globally with a configuration option, or individually for each door by using the tag [Timer: #] on line 3 or 4 of the [Private] sign, where # is the number of seconds that the door should remain open. If the timer is set to 0, this means the door will never automatically close. If no timer is specified, protected doors will use a global timer set in the configuration file. If the server is shut down cleanly any open doors will be closed, but in the event of a server crash while a door is open, it may remain so. Note that the initial state of a door is assumed to be closed.

    Care must me taken to place protected doors on a stable block. Building a door on sand, gravel, leaves, TNT and et cetera are allowed by the plugin, but cannot be secured fully. :3 Additionally, it should be noted that most status messages still refer to locked blocks as containers, so for the purpose of simplicity, doors should be considered as a type of container.


    Features:
    • No passwords or databases needed!
    • Permission checks run in constant time, no matter how many protected containers.
      • One owner and up to 11 additional users supported. (17 for double chests!)
      • Allows access to [Everyone] while still protecting the container from vandalism.
      • Allows group names in conjunction with many other plugins.
    • Special powers for ops or admins, configurable with permissions.
      • Reports when an admin does something naughty.
    • Protects single and double chests, dispensers, and furnaces.
      • Explosion and block-break protection for the protected container and sign.
        • Option to protect all containers from explosions.
    • Full support for doors, both wooden and iron!
      • Double doors are handled automatically, with no redstone.
      • Doors can be set to close automatically, via a timer setting.
      • Redstone hacking is disabled for protected doors.
    • Prevents creation of chests larger than 2 blocks.
    • Informative or helpful messages when interacting with containers.
      • The first time a chest is placed, a help message will be shown.
      • Types of messages shown are configurable in settings.
      • Additional language support.

    Advanced Setup (Permissions) (open)

    Advanced Setup:
    There are a few things you can now customize in the configuration files for the plugin, found in the plugins/Lockette folder. After running the plugin for the first time, two files will be created, config.yml and strings.yml. The first holds the following settings:
    • enable-permissions - Allows the use of permission nodes to specify who can do what. If this is disabled, groups will still be used but admin status is taken from the ops file. Defaults to false.
    • enable-messages-* - Enables or disables groups of messages listed in the strings.yml file. Not counting the broadcast ones.
    • broadcast-*-target - Sets the group or player that specific broadcast messages should be sent to. This can be set to "" for no one.
    • explosion-protection-all - Enabling this extends explosion protection to all containers on the server, not just [Private] ones. Default is disabled.
    • allow-admin-bypass - Allows admins to go though any protected door. Default is true.
    • allow-admin-snoop - Allows admins to peek into chests owned by other people. Default is false, and this setting is recommended! A broadcast message will be sent each time an admin snoops in a protected container where the admin doesn't have permission to. The message will be sent to a player or group as specified in another option. Admins can still break protection on chests if this is disabled, however.
    • enable-protection-doors - Enables support for private doors, defaults to true.
    • default-door-timer - Sets the door closing timer for all protected doors on the server, unless overridden by a specific sign. Defaults to 0, which disables the door closing timer.
    In the strings.yml file, you can set alternate language tags for [Private] and such, in ANSI format. If you need characters not in ANSI then you might try UTF-8 format, though it seems bugged tight now. The default alternate tags are in French, but server ops are free to translate the whole file into the language of their choice. If you do this, please share it back to me~ :3 If you want to disable only a specific message, you can set it to "", the empty string. Admins can use the command '/lockette reload' after editing the configuration files, to reload them.

    If a Permissions plugin is not available or the enable-permissions option is set to false, Lockette will use the ops file to determine who are admins. Admins can break the protection on any chest, and look inside protected chests (only if the related option is set), as well as reload the plugins configuration files. All non-ops will be able to create protected containers for themselves.

    If a Permissions plugin is available and the enable-permissions option is set to true, the following nodes will be used instead of the ops file and are included by default in the '*' node:
    • lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door. (The permission lockette.create.all is still supported, but obsolete.)
    • lockette.admin.create.* - Allows admins to create containers and doors for other users. Possible sub-nodes include chest, dispenser, furnace, and door. Leave line 2 blank for the default behavior or enter the name of your choice. Capitalization matters.
    • lockette.admin.break - Allows breaking protection on containers.
    • lockette.admin.bypass - Allows opening of any locked door.
    • lockette.admin.snoop - Allows peeking in protected containers. (The setting allow-admin-snoop must be true.)
    • lockette.admin.reload - Allows use of the reload command.

    Technical Information (open)

    Technical Information:

    This plugin has been tested and shown to be working for many builds of CraftBucket though a number of the more recent builds had a serious issue, so I'm suggesting a minimum build of 561 now. If you update past what is listed in the post's title and the plugin seems to break, it is probably not my fault. Post a note anyway and I'll see about fixing. I'll try and keep up with the new recommended build system, but for latest builds that break things, you should expect some time to pass before I take care of the issue, as this plugin is now mature. :3

    If there are multiple containers by the placed sign, the plugin will use the NESW rule to choose the first container that is not yet private. To elaborate, the plugin will check to the north of the sign first, and if no container or door is available to the north, it will continue checking clockwise around the sign.

    Due to the current implementation of the explosion event, this plugin will cancel all explosions that would damage the container or sign, rather than just remove the container and sign from the blocks to be damaged. Canceled explosions still knock signs off the walls. Canceled explosions leave signs looking blank, but this is just a graphic glitch, reconnect to fix.

    Bonus: This plugin will prevent chests bigger than 2 blocks from being created via glitches. (Again, this could be circumvented using WorldEdit commands, so take care who has access to such a plugin.)

    This plugin was inspired by the old hmod plugins Lock by Roman "kingseta" Pramberger and ChestCapsule by Fernando "Fergo".

    Hooking into Lockette (open)

    Hooking into Lockette:

    If you are a plugin author and want to connect to Lockette, you can use a public static function to get information about the protected status of a block.

    More info later, perhaps, but if you need the details now then go poke through the source~

    Future Possibilities:

    There are a number of things that have been suggested, and they tend to be added to the list below if I think they might be a good idea. However, some sort of locked container limit is requested often but this is not possible without a database to track the number of locked containers someone has. All things considered, this will not be supported. On the up side, without a database you can have literally millions of locked containers without any sort of lag, and there are permissions to restrict who can create locked chests. Perhaps only allow Moderators to create locked chests for other users, if you don't want to allow infinite locked chests.

    Aside what has already been implemented, the following may or may not appear in future versions:
    • Furnace/dispenser clusters, protected by a single sign.
    • [Log] sign to list recent users of a container or door.
    • iConomy fee for protecting containers/doors.
    • Worldguard connection.
    • [Protected] tag for viewing only.
    • Specific time range that doors can be opened.
    • DataLog plugin support.
    • More types of protected blocks, such as brewing stands.
    If you want any of the above features sooner than never, let me know! However, I currently see Lockette as functionally complete, for the most part, in that it already has all the functionality it needs. Future updates will mostly be to account for changes in Minecraft and Bukkit.


    Final Note:

    Please leave a reply if there are any bugs or suggestions, and if you like this plugin you can click the like button at the bottom of this post~ Thanks to those few that have donated! [​IMG]
     
  2. Offline

    LlmDl

    Pastebin.com the full startup sequence in your server.log, pastebin.com the config.yml and pastebin.com your permission file.
     
  3. Offline

    Zerophis

    No errors anywhere. TNT now blows up locked chests. Definitely needs to be updated as one of the players on my server had a lot of fun griefing and getting through locked chests. Console reads something about "<player> tried to change non-editable sign (bukkit bug, or plugin conflict)" or something along those lines. It also shows "<player> has released a locked sign" or something like that. Nothing useful though.
     
  4. Offline

    LlmDl

    Make sure that explosion protection is on in the lockette config.
     
  5. Offline

    Zerophis

    Protecting all containers from explosions seems to have fixed it for now. I'd rather not have all containers blastproof though, only locked ones, but it will serve for now.
     
  6. Offline

    LordKitsuna

    I dont see what its going to accomplish since it works fine without 1.6 with the exact same config but here you go.
    http://pastebin.com/RUS2TdTP
    permissions file is irrelevant since i have permissions off.
     
  7. Offline

    LlmDl

    "[Lockette] Loading Lockette v1.7.4"

    Go update Lockette to 1.7.12, you're 8 builds out of date.
     
  8. Offline

    Steam Engines

    There is currently an exploit where a user can put a hopper beneath a chest to drain items. Hope there's a way to fix this :3
     
  9. Offline

    LlmDl

    This is working as intended. You should have a protection plugin in place so that players cannot put the hopper below the chest.

    If lockette blocked hoppers then all the hopper-machines people have built would cease to work.
     
  10. Offline

    Zerophis

    Is it possible to make it so that unlocked hoppers work with unlocked chests and locked hoppers work with locked chests? nvm, took a look at ticket tracker.
     
  11. Offline

    Steam Engines

    If you say so :3
    Seems a bit tedious I need lockette AND another protection plugin just to lock chests.
     
  12. Offline

    LordKitsuna

    Updating the plugin had not worked however i then updated my build of bukkit since a few newer ones were out and that appears to have fixed it so apparently it was just the very specific build i had at the time.
     
  13. Offline

    Semirotta

    Is this plugin 1.5.2 or does it work in 1.6.2?
     
  14. Offline

    LlmDl

    Both.
     
  15. Offline

    Jakedavvy

    Hey Acru, my friend and I own a server and we were wondering if there was a way to stop "(Admin) **** has snooped around in a container owned by ****" appearing in chat? Thanks.
     
  16. Offline

    Martin1704

    I had the same problem, turned out to be a problem with ChatChannels. So, try it with just the Lockette-plugin and see if that works :) Hope it helps....
     
  17. Offline

    Jorodpismyname

    I find a bug here, when we lock Iron Door, we cannot open it with pressure plate, we need to open it with right-click. I found this bug on crazygame.cz server, Minecraft version : 1.5.2
     
  18. Offline

    LlmDl

    Works fine for me...
     
  19. Offline

    lCollide

    Is there anyway you can make it so other ranks can't use the plugin but other can at the same time and whats the permission node for it?
     
  20. Offline

    LlmDl

    In the config.yml set enable-permissions: true,

    then use the nodes:
    Code:
    - lockette.user.create.* - Permission required to create a protected container or door. Possible sub-nodes include chest, dispenser, furnace, and door. (The permission lockette.create.all is still supported, but obsolete.)
    
     
  21. Offline

    jar_g11

    How can i make a sign that only allows people of a group to enter? I made one like the image below but it did not work.

    [​IMG]
     
  22. Offline

    Darkmoon22

    Is it possible to enable lockette in one world and disable it in another? if yes how? pls reply pls and if you do thx a lot:)
     
  23. Offline

    Timbucktu

    This plugin had blocked hoppers from being placed on another person's chest while still allowing the owner of the lockette'd chest to place a hopper on it. With the most recent updates of Bukkit this feature has been broken and hoppers may be placed by users on other peoples' chests again. Will there be a fix for this?
     
  24. Offline

    MrBlueWolf

    He, i got a big problem with Lockette.
    I am using the latest Lockette version.

    When i or someone else at my server locks his/her chest.
    Everyone can still get in. But they do get the message: [Lockette] You don't have permission to open this container!
    Help me!
     
  25. Offline

    MarioG1

    Can someone please fix the problem with hopper minecrats and chests??
     
  26. Offline

    LlmDl

    It was decided it would not be fixed. It would require stopping all hoppers/hoppercarts from working on locked chests, you can see where that would be a problem.

    If the area is protected by a plugin (towny, worldguard, etc.) then the player wouldn't be able to place the hopper/hoppercart.
     
  27. Offline

    MarioG1

    No it dosen't simply destroy the minecart if it drives under an locked chest, furnace,...
     
  28. Offline

    LlmDl

    Wouldn't that break all the machines that people want to make? Your idea would mean that all the chests in machines would have to be unlocked to work.
     
  29. Offline

    MarioG1

    Yes but now i have to block all hopper minecarts because people are using them to get stuff out of locked chests.
     
  30. Offline

    LlmDl

    Chests shouldn't be locked in unprotected areas anyway.
     
  31. Offline

    MarioG1


    So I have to protect the locked chest with another protection plugin like WorldGuard?
    But why should i use Lockette then if the chest and the area around the chest is already protected??
     

Share This Page