[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


    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.


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


    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.

    • 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


    Thanks for the quick response - I'll see if I can replicate what they're doing...
  3. Offline


    For some reason builders on my server can open locked chests, maybe even other groups. Admins can't though like they aren't supposed to be able to. It gives the message saying you can't open it, but it lets you anyway. Just some info: I have build 1185 and I use permissions.
  4. Offline


    It appears to be certain chunks. I've got a sneaking suspicion that it's actually a minecraft bug, or possibly bukkit. We also are having a /tp issue where you can't teleport to (some) users - it says 'Hole in the floor'.

    Running Bukkit 1188 - and obviously I missed a word there. No unclaimed CONTAINERS nearby..
  5. Offline


    You are using OpenINV too, yes? I'm going to have to make the plugin conflict list much bigger.. o3o

    Well, some plugins use bukkit's chunk interface/events, and doing so wrongly may mess things up. I've not yet seen any other reports of a chunk ghosting bug in vanilla 1185. And the only things added in 1188 are food related. Check your plugins? Some plugin page may have an update or warning about the problem you are having, if you've been having for a while.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  6. Offline


    I should really pay better attention. Anyway OpenINV was updated to 1.4.6 so now it works fine.
  7. Offline


    And that surprises me. It's happening quite often. I'm not running anything out of the ordinary - worldguard, pex, essentials, plus a couple of misc other small ones. The only one I can think of that MAY be causing the problems is borderguard - but I've tested and bounced off borders, and walked for ages, and I can't figure out the trigger.

    The 'hole in floor' error is from Essentials, when it thinks your tp destination isn't safe. I'm not sure it's related, but it _might_ be. Any chance of a debug build where, when it says 'no containers found', it also outputs the xyz locations it looked in?

    Which is why I'm running 1188.


    (Caveat - this is an insanely busy 64 player server. So edge cases tend to show up here first)
  8. Offline



    Well, you could always disable the ones you don't consider essential for a while, and see if it is any better.

    When a 'chunk ghost' occurs and a plugin looks at the teleport destination or searches for nearby containers, the plugin sees a different set of blocks than the players see. Eg, it sees you are teleporting into solid rock or no chest nearby when that is not the case for the player. In the past, this has been caused by bukkit giving plugins data from cached chunks, and different chunks from the right ones. The coordinates will be right, just the types of blocks plugins will see there will be wrong. In the end it is probably a bug in bukkit, but likely triggered by a plugin trying to load and unload chunks in a way that causes the cached chunks to be incorrect. If a lot of players are running around the map at the same time, well, it may do something like trying to load a chunk before it is finished unloading or something. The first thing to do would be to isolate which plugin(s) are playing with chunks.
  9. Offline


    Acru i don't know how to say it, but: I fucking hate you AND i really love you.

    Why?... I updated to Deadbolt. And now you come up with a better update D:

    *cires* back to Lockette <3
  10. Offline


    Any chance of making an option where another player have to pay for entering door?


  11. Offline


    I had considered the Idea for a while, however it needs to be fleshout more as you can hide the signs under walls with doors. There would have to be some sort of /acceptfee command. Otherwise people could get slammed for huge amounts of money without knowing it.
  12. Offline


    I don't think that's very safe, at least without some sort of prompt to the user. What's to stop a player from putting an exorbitant fee on the sign and hiding it so players don't see there's a fee?
  13. Offline


    Ok. Yeah, I agree, /accept command would be great. Anyways, thanks whatever you decide!

    True. Our server is quite small and nice, so that would not be a problem. :)
  14. Offline



    15:14:56 [INFO] This server is running Craftbukkit version git-Bukkit-0.0.0-1067
    -g6301507-b1185jnks (MC: 1.8.1)
    15:14:56 [SEVERE] Could not load 'plugins\Lockette.jar' in folder 'plugins':
    java.lang.UnsupportedClassVersionError: Bad version number in .class file
    at java.lang.ClassLoader.defineClass1(Native Method)
    at java.lang.ClassLoader.defineClass(Unknown Source)
    at java.security.SecureClassLoader.defineClass(Unknown Source)
    at java.net.URLClassLoader.defineClass(Unknown Source)
    at java.net.URLClassLoader.access$100(Unknown Source)
    at java.net.URLClassLoader$1.run(Unknown Source)
    at java.security.AccessController.doPrivileged(Native Method)
    at java.net.URLClassLoader.findClass(Unknown Source)
    at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.
    at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.
    at java.lang.ClassLoader.loadClass(Unknown Source)
    at java.lang.ClassLoader.loadClass(Unknown Source)
    at java.lang.ClassLoader.loadClassInternal(Unknown Source)
    at java.lang.Class.forName0(Native Method)
    at java.lang.Class.forName(Unknown Source)
    at org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(JavaPluginLoader.j
    at org.bukkit.plugin.SimplePluginManager.loadPlugin(SimplePluginManager.
    at org.bukkit.plugin.SimplePluginManager.loadPlugins(SimplePluginManager
    at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:138)
    at org.bukkit.craftbukkit.CraftServer.<init>(CraftServer.java:103)
    at net.minecraft.server.ServerConfigurationManager.<init>(ServerConfigur
    at net.minecraft.server.MinecraftServer.init(MinecraftServer.java:136)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:348)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:417)
    15:14:56 [INFO] Preparing level "world"
    15:14:56 [INFO] Default game type: 0
  15. Offline


    Could you please add bpermissions support, or atleast support for superperms?
  16. Offline


    Overall yay! then ^.^;
    Anything from deadbolt still missing in the new vers of Lockette? Heh.
    In any case, more to do on it yet~
  17. Offline


    I would like you to make the plugin support to PermissionsBukkit.
  18. Offline


    Wait, what? Try updating your java runtimes?

    Hmm, I've not even heard of bPermissions before. What does it have over GroupManager/PermissionsBukkit/PermissionsEx?

    Native superperms is on the to-do list, though.

    Lockette already fully supports PermissionsBukkit, though it needs the bridge too at the moment.

    Btw, @daemitus was talking about deadbolt and not Lockette. o3o

    An iConomy fee has been suggested in the past, but I'm still not sure if it is a good feature for Lockette to have, due to possible abuse.

    I would recommend a voluntary donation box setup, for many situations that you might have used a pay-door?

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  19. Offline


    i have the bridge, and it doesn't works.
  20. Offline


    It doesn't really have anything over it, it's just another very popular permissions plugin that is similar to PermissionsEx/PermissionsBukkit.
  21. Offline


    In your plugins/Lockette/config.yml, do you have permissions enabled?

    I see, I'll add it to the list-of-things.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  22. Offline


    Sure, I have.
  23. Offline


    Well, if you need help you'd better give me a lot more detail. 'Doesn't work' doesn't give me much to go by.
  24. Offline


    Will do.
  25. Offline

    Donald Scott

    Critical bug: Users with long names cannot access chests!
  26. Offline


    I migrated to Deadbolt when daemitus/md_5 added Coloured Signs. :D
    (I doubt Lockette will let them work, as Line 1 says &4[Private], so migrating back could be difficult)
    All the same, maybe the two plugins should differentiate.
    Maybe you can draw straws for who attempts a tollgate-style plugin?
    Lockable Levers/Buttons? Timed lockette expiry? Business hours (timed) access for [Everyone]?
    Just some ideas to chew on. I love both plugins, I've tried both th the last fortnight (I'm using the 1.8-1.9 lull
    in user activity to play with/test out a lot of plugins on a near-empty server). Keep on keepin' on!
  27. Offline


  28. Offline


    @Acru - Alright. When i try to put a sign on door or what ever, it says "Lockette: Permission to lock container denied"

    And here is what I have in my permissions.yml file.

                lockette.user.create.*: true
            default: user
                lockette.user.create.chest: true
                lockette.user.create.dispenser: true
                lockette.user.create.furnace: true
                lockette.user.create.door: true
            default: user
                lockette.admin.create.*: true
                lockette.user.create.*: true
                lockette.admin.create.chest: true
                lockette.admin.create.dispenser: true
                lockette.admin.create.furnace: true
                lockette.admin.create.door: true
            default: admin
    I have checked it with Online YAML Parser and everything is okay.
  29. Offline


    There is one thing i'd really like to see with this: Sign copy with like sticks (wood sticks). So you can setup one container and when you are done you do something like "/lockette copy" to activate the tool (or maybe even let it detect wether it is a [Private] sign). And then you can copy with left and paste with right (by hitting signs). This would save lots and lots and lots and lots of lines on Signs :)
    - Keeping the tool configurable would be a good idea.

    Also, consider adding "/l" as an alias for "/lockette". Since with "/lockette 3 someplayer" it's like write 2 new lines on the sign anyway D:

    Other than that <3

    If you mean the fils in your server root than that's wrong!

    First of the default can only be: true, false, op, notop (not sure about notop)
    Then the "permissions:" part should be "children:". What you call "user" would be "true" (for everyone) and "admin" would be "op" (ops only).

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  30. Offline


    Ow yea.. I forgot about children, thanks for the default thing, i will just delete it. :)

    Still ain't working.. Can someone give me their permissions nodes for lockette from PermissionsBukkit ? Please.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  31. Offline


    I will need for information, as it has worked fine for people with 16+ character names for a long time. If you are adding the person as an additional user, btw, you only enter the first 15 characters of their name.

    Lockette already strips color codes from signs before processing, and so is compatible with sign text colorers and already colored signs. (I never felt a need to put it in Lockette as other plugins already have this functionality and much more, though it is certainly possible to add.)

    I have already explained in the past why locking redstone circuits are either terribly complex or easily bypassed, why expiring locks aren't possible without a database, and why business hours are not useful in practice. daemitus/md_5 can do these things if they want but Lockette will remain compact and reliable as much as possible.

    Pay-doors I am considering, however, as I thought of a safe way to do it.

    Someone showed me that error before, but couldn't help me with finding why it is occurring in the first place. Either it is a bug within bukkit, or another plugin is interfering with Lockette's operation. (The event is passing a block which is not a piston by the time it gets to Lockette.)

    What version of bukkit, and what other plugins are you using?

    Edit: Perhaps too it is caused by pistons pushing blocks into where pistons used to be, and bukkit missing it? If you have a build that causes the error reliably, let me know.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016

Share This Page