[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


    Lockette 1.4.3 might fix?

    If you like you can just disable Lockette using permissions for now, in the plugins/Lockette/config.yml file.
    When enable-permissions is set to false, it will use ops instead.

    So yeah, I think I got the major things sorted out in 1.4.3, but you'll have to let me know if everything else works as expected... I just hope so. >.<

    And the aforementioned bug as a report, if yer interested: http://leaky.bukkit.org/issues/1531

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


    Woot! I've just ran a quick test of it (I'm about to go to bed or it would have been more extensive), everything seems to be working as it should now. I was able to use all of the Permissions commands that I should have been and I was also able to make use of a group name for the allowed list again and somebody in that group was able to access both a protected door and chest! Thank you very much for the update!

    Also thanks for the link, I shall keep track of the report. :)
  4. Offline


    Folks are telling me that they can freely bypass chest protections. I'm trying to verify.

    Seems to be the case. This is with or without the new permission assigned. Doors and furnaces DO seem to work.

    This is without Towny installed. I will try to test with Towny on the main server.

    I also don't see any bypass/snoop messages in console.
  5. Offline


    Is this with the latest version (1.4.3 right now) or one of the previous?

    Anyway, yeah, let me know more details about your setup. Recent changes made it so you can use multiple permissions plugins at the same time, and if any one gives permission you have permission. (If permissions are enabled in the config, otherwise it will just use groups.)
  6. Offline


    I'm using dev PermissionsEX (to be compatible with the current CB SuperPerms) with CB 1183 and Lockette 1.4.3. Server currently does not have Towny due to bug a with the iCo 6 Towny dev version. People have the same permissions they have always had with older Lockette versions where it was all working.

    Config for reference:

    enable-messages-help: true
    broadcast-snoop-target: '[Regents]'
    broadcast-reload-target: '[Overlord]'
    broadcast-break-target: '[Regents]'
    enable-messages-error: true
    enable-quick-protect: true
    enable-messages-user: true
    enable-messages-owner: false
    enable-messages-admin: true
    enable-protection-doors: true
    default-door-timer: 10
    explosion-protection-all: false
    enable-permissions: true
    enable-protection-trapdoors: true
    strings-file-name: strings.yml
    allow-admin-bypass: true
    allow-admin-snoop: true
    As I just added to my last post, I do not see any messages about snoops or bypasses (even when I open other locked chests/doors). I was also wondering if there was a way to have messages send to multiple groups.
  7. Offline


    Hold on, people can bypass chests but not furnaces, and there is no message? It sounds like another plugin is interfering with Lockette protection, as chests/furnaces/dispensers should always react the same.

    I checked build 1183 and all seems normal on that front, so yeah, try disabling chest related plugins and see which might be the cause?

    Last, multiple group broadcasts are not supported in Lockette, but you could make a new single group with the other groups as children, perhaps?
  8. Offline


    It works for fence gates :3
  9. Offline


    Well, the plugin works perfectly normal under 1.4, and I don't think there is any other new plugin since I updated Lockette. I did put in the .jar for the economy loader API by Nik, but I have no idea how that would be interfering with Lockette. Let me run 1.4 to make sure that it is still working normally...


    1.4 is working normally. Remember, this is running with no Towny on the new recommended build.
  10. Offline


    I'm not really sure what to do anymore, so i'll try to show you the configurations im using:

    this is my permissions file:

            default: true
            - modifyworld.chat
            prefix: '&7[Guest]'
            default: false
            - lockette.admin.create.*
            - lockette.admin.break
            - lockette.admin.bypass
            - lockette.admin.snoop
            - lockette.admin.reload
            - lockette.user.create.*
            - '*'
            default: false
            - mcmmo.skills.*
            - mcmmo.motd
            - mcmmo.ability.*
            - towny.town.resident
            - towny.wild*
            - modifyworld.*
            - ashtheking.multicurrency.info
            - ashtheking.multicurrency.pay
            - ashtheking.multicurrency.obtain.*
            - lockette.user.create.*
        Ban: {}
            - admin
            - User
            - User
            - User
            - User
            - User
            - User
    And this is my lockette config file:
    enable-messages-help: true
    broadcast-snoop-target: '[Everyone]'
    broadcast-reload-target: '[Operator]'
    broadcast-break-target: '[Everyone]'
    enable-messages-error: true
    enable-quick-protect: true
    enable-messages-user: true
    enable-messages-owner: false
    enable-messages-admin: true
    enable-protection-doors: true
    default-door-timer: 0
    explosion-protection-all: false
    enable-permissions: true
    enable-protection-trapdoors: true
    strings-file-name: strings.yml
    allow-admin-bypass: true
    allow-admin-snoop: false
    When I try to lock stuff it says I dont have the right permissions. :x? ??

    My players make the server go through an unexpected crash whenever they put in stacks of anything into a chest. This didn't happen before I installed lockette. Even after removing the plugin this error is still happening though. I'm not really sure what to do now.
  11. Offline


    Now that recommended build 1185 is out, I'll have to do some more thorough testing myself.

    Well, 1.4.1 added more sources for permissions as well, so it could be an old permission plugin giving everyone '*'?
    I'll need more details on the problem though, if I am going to help. Perhaps you can show me the server or something.
    Since it is just you with this particular problem, it must be something to do with your setup.

    First, Lockette has nothing to do with actual chest contents so it must be some other plugin. Second, did you look at the console log? Last I tried permissionsEx, it was throwing an exception on load, in MC 1.8. You can send it to me in a conversation if it is long and full of exceptions, and I'll have a look.
  12. Offline


    Well I just went ahead and merged my test and live servers now that there is an official RB. The live server uses Towny. When I have the players on to test it, I will get back to you. Here is a link to the server wiki main which parses the server and displays all running plugins. The only permissions-related plugins that should be running are PEX and its bridge (Permissions). There should be no conflicts. I am the only op and I do not have any additional permissions set up in the permissions.yml. There should be absolutely no permissions conflicts.

    Again, we'll see if the problem persists with Towny running.
  13. Offline


    Lockette runs fine on #1185 for me. I'm only running Log atm.
  14. Offline


    Works fine with 1185, but how i can change language, you said german is possible, but how :-D
  15. Offline


    Its hard hard because i want users to be able to place signs in my bank storage area to claim chest but the area is protected cuz griefers try to grief it :/ so no one can place signs to claim there chest is there any possiable way to make it people can some how claim a chest with out placeing or sumthink :S please help or add a new feature Thanks :)
  16. Offline


    @Acru Well, things seem to have flip-flopped. With Towny installed, I think chest protection (and snoop/bypass notifications) is working. However, now I seem unable to lock chests within my own town (even with admin privs). In addition, doing a -perm for wilderness building doesn't seem to work. But this is probably a PEX problem. (And it only matters because I was trying to -perm myself since I have *).

    On the other hand, wilderness locking permission with/without the permission seems to work fine.


    Note: This is with Towny running. I have no reason to believe running 1.4.3 without Towny isn't still broken. I have only essentially added more plugins and worlds by merging with my main server. Permissions setup is identical. All of the temp server plugins are installed on the main server.
  17. Same towny with pex issue here.
  18. Offline


    In the config, change strings.yml to strings-de.yml

    An admin can assign a bank chest to someone by specifying their name on line 2.

    Is the lockette.towny.wilds perm effecting locking in town rather than in wilds, perhaps?

    In any case, I think the checks need to be refined a bit but I don't have a server with towny setup to test with right now.

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


    @Acru Would you be willing give the chest orientation a go to try to fix them from pre 1.8 worlds converted to 1.8 its game breaking.

    More info:

    I know you prob would not want to touch it but it would make you into God.
  20. Offline


    Acru join the #towny-dev IRC channel if you need help getting the towny support working.
  21. Offline


    My name is Kane but thanks for the honor <3
  22. Offline


    wooops there I go looking like a nub
  23. Offline


    Yer but we will have alot of people coming in and out and my admins dont have much time can you please try figure sometink out like they write a command and hit the door and a sign pops up on it lol i dunno but plz think of somethink
  24. Offline


    I tested that.. that's why I went on about wilderness permissions for a bit. Anyway, I tried with and without wilderness perms. In either case, I couldn't lock something in my own town (though I haven't tested against OTHER towns). However, wilderness worked correctly. I was able to place in wild with the perm and not able to without the perm.
  25. Offline


    I'm having similar issues to Silarn, but I do not have Towny. The issue must lie elsewhere.
  26. Offline


    Is your issue that chests will not lock, even if the sign takes, but everything else seems to lock properly? This was my issue when running without Towny.

    With Towny, the issue seems to be that signs simply can not be placed inside of towns (regardless of ownership), while 'wild' permissions DO work.
  27. Offline


    Yea, I noticed that too, it might be due to different data codes on the two halfs.

    It might be possible to fix it on the fly, when anyone rightclicks the chest block?

    What is the plugin that is protecting the area around your bank? If I were to add that in general, people could just go into other's protected spaces and lock them out of any unlocked chests. What you ought to do is allow block placing of type wall sign as a specific rule in your protection plugin, for your bank space. I know some plugins can do that.

    Oh, I see, so the wilderness part is right anyway. I guess the check to see if it is your town has an error in it.

    Actually, since I have you here, should you be able to lock things in just your town/nation or in anyone's? Does towny prevent building in other's towns already? Should you be able to lock things only if you are allowed to build there too?

    Let me know and I'll try to fix the behavior so it is right.

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


    That would be nice. If you checked the leaky report it was fixed tagh temp but he removed it after he tried do it automaticly. Also this bugs in 1.9 and @Grum said this on IRC:

    <@Grum> notch said he didn't care
    <@Grum> they only autofix themselves in sp
  29. Offline


    Please explain the issue you are having. (I just found the root cause of Silarn's current issue, though it only exists if a Towny plugin is linked.)

    Does that mean it'll be fixed if you load your world in sp, or would you still have to go touch all the chests?

    I'll have a look to see what is going on, though I'm not sure if I'll have a fix for that to go along with a towny fix in the next minor version.

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


    oh ok i use regios protection but with only sign place i only want to allow them to place on the doors btw i have lil storage rooms lil 4X4 rooms and i want the door locked xD hopfully u configure somethink out Thanks alot :D
  31. Offline


    @Acru It appears that literally any Towny claimed area prevents objects from being locked. Also, the - permission started working so you can basically ignore that. Wilderness areas work correctly. (People should be able to bypass old 'illegal' locks in wilderness areas, correct? Because I think that is the case.)

    I will try to have a Town resident (not owner) see if they can lock now.



    Nope. Nobody can lock inside of a town.

Share This Page