[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


    The last openinv update which lets you open 'blocked' chests broke chest protection plugins. Even if you don't have the permission to be allowed to do that. It basically hijacks the chest opening code rather than merely intercepting it and passing it on. The most recent update may have fixed it. I don't know.
  3. Offline


    Thank you for finding the culprit, @Silarn!

    Indeed, OpenINV-1.4.4 is allowing one to open any chest while possibly bypassing a logging plugin, I've confirmed the first bit with a clean setup. I cannot yet say if OpenINV-1.4.5 fixes all security issues, as the code on github is out of date.
  4. so if i delete the plugin OpenInv, this plugin works fine with the Tombstone etc.?
  5. Offline


    It should yes.
  6. Offline


    Using OpenInv 1.4.5, chest protections seem to work again. It also fixed a bug that was keeping chests stuck in the open animation so the two are probably linked.
  7. Offline


    It seems to, but I want to look at the updated OpenINV source code first, to be sure. :3

    I take it everything works with Lockette+Towny too, now?
  8. Offline


    Seems to based on just a couple tests. Time will tell. Still might be nice to have an option that lets town owners break locks in their towns. (And maybe plot owners as well.) Or even allow breaking of locks in the wilderness if said lock owner doesn't have wild permissions. (And Towny is running.)

    Things to think about!
  9. Offline



    If you can play with it a bit and make up a succinct list of improvements you'd like to see for Towny-based support, I'll see what I can do.

    As in, exactly who should be able to break what, and anything else you think would mesh well, and if the things should be optional or not. The wilds bit is straightforward, but there may be trouble checking permission of an offline player, depending on the source of the permission.
  10. Offline

    Tim Andersen

    Hi. I got a really big problem on my server.

    People are able to private chests. But not doors.
    Every time a person tries to private a door, it tells them "You can´t" .
    Admins are able to private doors.
    Is this a bug?
    I have put the permissions in. have tried to disable permissions for the plugin, but nothing seems to work.
    Would really love if someone knows whats going on here.
  11. Offline


    To privatise a door you have to put the sign on the block above or below the door, not in front of it like a chest.
    I've never actually seen Lockette say 'you can't' before though, usually if it fails the sign gets a [?] on the top line and a message pops up in chat to say it couldn't find a door or chest in range.
  12. Offline

    Tim Andersen

    we have allways put the signs infront of the door. then it hooks into the door like it do on a chest. like this one. 2011-09-24_01.55.05.png
  13. Offline


    Wow, you learn something new every day. Honestly didn't think you could do that, not too sure why you would though either since it stays there when you open the door. I'm afraid I'm not too sure why you wouldn't be able to then, especially if you've set 'enable-permissions: false' in the config as I believe that natively allows all users to place protections.
  14. *blink* I have never seen that before as well, it's always been above the door. What other plugins are you using?
  15. Offline

    Tim Andersen


    All the plugins we are using.
    Tryed both permissions on and off.
  16. Offline


    "You can't" is not a message from Lockette, some other plugin is putting that text on the sign and stopping lockette from working there~ You'll have to figure out on your own which other plugin is generating the "you can't" message.

    And the on-door method was there since the start, I added the above door method a bit later since people wanted, and it has become the norm. Still both are valid, as well as a sign attached to the block under the door. :3
  17. Doh! I never noticed or used that method. Colour me sheepish. :)

    @Acru - I updated to the 1.4.4 plugin last night during my testing/upgrading of my server. Very nice work, thank you for keeping this plugin going, the right click to change the chest orientation is a very helpful function when working with pre-1.8 worlds!
  18. Offline


    Awesome! thanks guys!
  19. Offline


    ok i had tht happen to one on my players on my server and it moved the rest of the letters to the next line
  20. Offline


    Can't modify strings.yml: -
    alternate-private-tags (Private to Privé) in UTF-8. After that, Private and Privé don't work... In server.log, Locket successfully loaded . I'm French, sorry if my english is bad

    alternate-private-tag: Privé
    alternate-moreusers-tag: More Users
    alternate-everyone-tag: Everyone
    alternate-operators-tag: Operators
    alternate-timer-tag: Timer
    msg-user-conflict-door: Conflit de porte enlevé!
    msg-user-illegal: Coffre illégal enlevé.
    msg-user-resize-owned: Tu ne peux pas refaire un coffre appartenant à ***.
    msg-help-chest: Place un panneau avec écrit [Privé] devant un objet que tu veux pour le protéger (Liste disponible en dessous de la mairie).
    msg-owner-release: Tu as libéré un coffre!
    msg-admin-release: (Admin) @@@ a cassé une protection appartenant à ***!
    msg-user-release-owned: Tu ne peux pas libéré une protection appartenant à ***.
    msg-owner-remove: Tu as retiré un membre de cette protection!
    msg-user-remove-owned: Tu ne peux pas  retiré un membre de la protection appartenant à ***.
    msg-user-break-owned: Tu ne peux pas détruire une protection appartenant  ***.
    msg-user-denied-door: Tu ne peux pas ouvrir cette porte.
    msg-user-touch-owned: Cette protection appartient à ***.
    msg-help-select: Panneau sélectionné, utilise /lockette <Nombre de la ligne> <texte> pour l'éditer.
    msg-admin-bypass: Protection de la porte de *** contournée, referme là derrière toi.
    msg-admin-snoop: (Admin) @@@ a regardé dans un coffre de *** (Ouh le vilain)!
    msg-user-denied: Tu n'es pas permis d'utiliser ça! Pas touche!
    msg-error-permission: Permission de protéger ceci refusée.
    msg-error-claim: Il n'y a rien autour que l'on peut protéger
    msg-error-claim-conflict: Conflit avec une protection existante.
    msg-admin-claim-error: Le joueur *** n'est pas en ligne, sois sur d'avoir écris le bon pseudo.
    msg-admin-claim: Tu as protégé un objet pour ***.
    msg-owner-claim: Protection effectuée avec succès!
    msg-error-adduser-owned: Tu ne peux pas ajouter de joueur sur une protection appartenant à ***.
    msg-error-adduser: Pas d'objet possible à la protection disponible aux alentours!
    msg-owner-adduser: Tu as ajouté un joueur à la protection!
    msg-help-command1: /lockette <line number> <text> - Edits signs on locked containers. Right click on the sign to edit.
    msg-help-command2: /lockette fix - Fixes an automatic door that is in the wrong position. Look at the door to edit.
    msg-help-command3: /lockette reload - Reloads the configuration files.  Operators only.
    msg-help-command4: /lockette version - Reports Lockette version string.
    msg-admin-reload: Reloading plugin configuration files.
    msg-error-fix: Pas de porte disponible.
    msg-error-edit: Sélectionne un panneau en cliquant dessus.
    msg-owner-edit: Panneau édité avec succès.
  21. Offline


    Well, primarily what I said. In towns, the Mayor (and maybe any assistants?) should be able to break any sign. This helps clear out old buildings that have been long abandoned by their users. The same should apply to plots and plot owners. In addition, I feel like there should be some kind of toggle setting to ensure that signs will only lock if the user is a resident. There are cases when this could come up. If the town sets open build permissions, someone leaves the town, or even war events (looking to the future) where a block may be claimed.

    This relates to the wilderness as well. If towny is enabled and wilderness checks are enforced, any lock with an owner that does not have wilderness permissions should be subject to opening (with maybe another settings toggle). I realize this has potential conflicts? But if a user is not defined in the permissions, can't you assume they have default permissions? I'm not 100% on all the permissions options out there.

    I think you have current support for [TownName]? At least, I tried it and other town members were able to open the doors (and it seemed to open both doors and function as a Lockette door). But it also told me it didn't seem to be a player and I wasn't getting bypass messages.

    I can't think of any other features that feel useful at the moment, but I will think about it.
  22. Offline

    Costan Balgobin

    When I Use This On 1.8 Chests People Can Access Locked Chests But It Still Tells Then "You Dont Have Permission..." Help Plox?
  23. Offline


    Lol, why are you replying to posts from back in February?

    Lockette truncates all names to 15 characters, don't try and put extra characters on the next line as it will interpret it as a second name.

    This is intentional due to a change in function. (The alt tags are used for quick-locking.)
    To use french, use the following line in plugins/Lockette/config.yml:
    strings-file-name: strings-fr.yml

    Or get Lockette here:

    If you had read the last couple pages, you'd know this mess is all OpenINV's fault, lol.
    You are using OpenINV too, yes?

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

    Costan Balgobin

    Oops Ya Sorry And Thanks For The Help! Quickest Reply Ever! :D
  25. Offline


    I don't use openINV, but my users are having stuff stolen out of locked chests in locked rooms :-( I know that one method involves right clicking extremely fast on the chest for a while - Is this a known issue, and is there a solution?

    Thanks -

    [EDIT] So having read the previous past 3 pages maybe there's another plugin not playing nice with Lockette like openINV. Unfortunately my list is rather long -

    Here's what I do use: AutoMessage, HeroicDeath, AutoPlant, RedstoneMobSpawn, CommandBook, WorldGuard, Votifier, PortalLink, PermissionsEx, ChatManager, ColoredSigns, mxAntiPVPCheat, Modifyworld, MobBounty, BuyCraft, Minequery, nSpleef, SimpleReserve, NoCheat, iConomyChestShop, BorderGuard, VoxelPort, VoxelSniper, Dontkickme, GravelClay, NoGrief, HeroSpawn, iConomy, WorldEdit, MultiVerse, MCStats3, Help, mcbans, ThunderTower, HeroBounty, Lockette, NoLagg, Wieze, SpawnBed, AutoHelp, EnderNerf, Permissions, MoveCraft, NoGriefLava, dynmap, NoGriefTNT, SimpleJail, mcMMO, Factions
  26. Offline


    Great plugin iv used it since i made my server but with 1.8 the lock works but people can still access the chests same for LWC plugin im not sure if its my server or the plugins. I guess nvm then i am using OpenINV i just seen that after i posted this sorry.
  27. Offline


    We're having an ongoing issue with Lockette, where Lockette isn't detecting chests. You can't right-click with a sign (it opens the chest), and if you place a sign next to it, it says 'Lockette: No unclaimed nearby to make Private!'
    Using plugman to disable/enable lockette doesn't fix it. Stopping and starting bukkit DOES.
  28. Offline


    hello guys, I've checked a few pages, and can't find my answer so I'm posting here.

    My problem is, the plugin wont accept bukkitpermissions as a valid permissions plugin. Even though its the OFFICIAL permissions plugin? If I set it as true in the config, it still reverts back to "everyone can create, admins can remove etc.".

    Problem is, what I want to do is only allow certain people to create locked chests/doors etc. But when I set lockette.users.create.*: false, or lockette.users.create.chest: false on permissionsbukkit, it doesn't work...

    Any ideas?

  29. Offline


    Heh :3

    Just to see, I set up a macro that could right click perhaps hundreds of times a second. Using it I could glitch unlocked chests so they looked permanently open, but I couldn't break into someone's locked chest. So I could try the same on your server to see if it is different, and if so it is probably a plugin that you use. If I can't break in using the macro, it is due to some more complex interaction between plugins...

    I'm not sure I understand. Do you mean that after restarting the server Lockette will work for a while and at some point it will stop working entirely, or stop working in specific chunks perhaps? What bukkit version and other plugins do you use?

    Make sure you have SuperpermsBridge installed too, which is the compatibility bridge for PermissionsBukkit. At the moment Lockette gets groups directly from PermissionsBukkit, but needs the SuperpermsBridge to get permissions until I can rework Lockette for native super perms support.

    Edit: Incidentally, PermissionsBukkit is more of a group plugin with Bukkit SuperPerms support, and not a permissions plugin. :3

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


    Ahh, What do I need to do after installing SuperpermsBridge to make it work?
    Also, reworking it would be amazing xD
  31. Offline


    Add 'superpermbridge.' to the front of all the Lockette Permissions nodes. So they look like this;
    superpermbridge.lockette.user.create.*: true etc.

Share This Page