[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


    I don't know if others have discovered this, with MC 1.0 (CB1502) using Permissionsbukkit ( I don't know which part causes this) the permission node lockette.user.create.* no longer works. You have to specify lockette.user.create.chest etc. One line for each. Just did some crash tesing of this issue to find that!
  3. That's not a bug. Bukkit superperms doesn't support the old standby of using *.
  4. Offline


    SuperPerms doesn't support the * permission, anyway I think with PermissionsBukkit you can use "superpermbridge.lockette.user.create.*" so it works, just search a little on PermissionsBukkit page and you will find about that "superpermbridge" that you can use.
  5. Offline


    Don't get me wrong Acru great dev its just sometimes his RL gets in the way from here and we have had him mia for 2 months before. I just prefer to plan for the worst and 1.0.0 very playable now. I expect a RB this weekend or early next week :)
  6. Offline


    Ok thnx for the answer. :)
    Im not very good at what it takes and what programs used to fix things so i apreciate your help!
  7. Offline


    Good plugin. But maybe it needs a upgrade. IS it possible that Lockette can Lock the ENTIRE building and people who destroy a block from a building will come out a sentence saying the person broke into the building (Like Destroying the sign)
  8. Offline


    I miss lockette :(
  9. Offline


    Okay folks so Im having some issues.

    Since some of the newer bukkit releases lockette has acted weird with double doors. I found the following:

    When placing double doors I have to place the LEFT door first, put my sign up then put the RIGHT door. Private signs work fine, but signs with [EVERYONE] did not work. When using the EVERYONE tag, the doors would make the opening sound but wouldnt open, and would get stuck sometimes. Im using the following



    Now, i know theres some new EVERYBODY command so when i do this:



    The door works fine, for me. Im an admin. Its not working for my regular players. Soo im not sure what to do. I verified essentials sign stuff is DISABLED. If i revert back to an earlier release of bukkit, the doors work fine with EVERYONE, but with later bukkit releases, the doors are flaky, UNLESS i use EVERYBODY, but again, its only letting ME open them.

    So not sure what to do here.

    Im using Essentials 2.6.5 and lockette 1.4.8 (same thing with 1.4.4 i just tried 1.4.8). Bukkit is at 2nd to latest, i forget exact #

    UPDATED: I just realized [EVERYBODY] was not a proper command, just tried it with another user. I was creating private signs the entire time because EVERYBODY is not real... so that was one issue... so now i guess i need to know how to get signs to work properly with the EVERYONE command
  10. Offline


    old news.
  11. Offline


    With what permission node i can look in anothers chests?
  12. Offline


    Yes but don't bother this mod is totally broken in 1.0.0
  13. Offline


    If by totally broken you mean still working? The only issue is that double-doors can be a bit iffy. Everything else still functions.
  14. Offline


    It seems like Lockette features are working, but permissions checks aren't being made correctly. So locks work, but things that need a permissions check like creating locks, snoop permissions, bypass permissions, etc. are not working. (Op / non-op checks are not permissions checks, so Op-related functions work)

    The double door issue is probably connected to the MC double door bug.

    Don't lock an open door. Close it first, otherwise it'll split.

    @psvunited lockette.admin.snoop would normally work, but not right now. If you set the config to allow-admin-snoop: true, then Ops will be able to snoop
  15. Offline


    v1.4.8 Beta
    Some how your alias of /l seems hard coded.
    I removed the "l" alias out of plugin.yml and that normally removes the alias.
    I even tried renaming the "l" alias to "lk", and to no avail.
    This is really bad because /l is the alias for local chat on our server (via HeroChat)

    Any ideas?
  16. Offline


    This is a great plugin, but I have a slight problem with my version of it... My sister can simply break into my house when I have the doors locked, this really annoys me and I was wondering if you could help me with this problem
  17. You would need to look at a block protection plugin for this. There are more than a few, I'd search the get plugins link for one you like.
  18. Offline


    do you know any that work without a database, because I tried one called Quick Save that didn't work.
  19. Offline


    Hmm. Well.
    CB #1499
    Lockette 1.4.8 beta
    bPermissions 1.9.1

    Everything works perfectly.

    Oh. And I have a very strong feeling that Acru will update this shortly after an RB comes out. ;3
  20. Offline


    @Kane et al... I bring good news. Craftbukkit dev build 1529 seems to have fixed the problems Lockette 1.4.8 had
    with doors (I just tested it :D) (It does say theres a fix for doors somewhere in the CB changelog).
    No probs with chests either. [Caveat: I am running Spout dev build 554, and logged in using Spoutcraft dev build 806.]
  21. Offline


    Mhmm. That's the prob with non-rb builds, things get broke then fixed all the time~
  22. Offline


    @Inscrutable thanks for the tip! I'll check that out.
  23. Offline


    Fail Dinnerbone said... Yeah my mistake for listening to him haha :p
  24. Offline


    im making a dutch tutorial of your plugin :)
  25. Offline


    I'm not sure how will this will work since PermissionsBukkit can't use the "*" node, well thats what I've heard...
  26. Offline


    use SuperPermsBridge with Lockette. It will allow you to use nodes like .create.* by setting: superpermbridge.lockette.user.create.*: true
    [qwerty] likes this.
  27. Offline


    Oh, yea thanks for reminding me. I even have that done on a lot of them, must have forgot lol.

    I added the permissions and still everyone that is trying to protect a chest is getting a [?]....
  28. Offline


    Straight off my server, here's the node I use to give players the ability to create locks:
                superpermbridge.lockette.user.create.*: true
    Were you putting an extra S in 'superpermbridge'? Because even though the plugin is SuperPermsBridge, the node is superpermbridge
  29. Offline


    This can be exploited so easily...

    My players got raided so hard by one bastard.

    He told me how it works though. Can you please fix it?

    - snip -

    Exploit details removed, I'll send you a PM.
  30. Offline


    my favorite protection plugin! just awesome :p! is my idea or "/lockette line text" in 1.0.0 is not working?
  31. Offline


    Eeek. I confirm the first exploit mentioned by DylanP, I just tested it. [I couldn't reproduce the other exploit]
    [Note: Edited to remove exploit details, which seems a reasonable approach].
    Lockette 1.4.8, Craftbukkit 1532, MC 1.0.0

Share This Page