[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


    ah... I get it. A demonstration of how you'll be able to put a lock on any custom block by specifying an ID. Sweet. People have been asking for that for awhile.
  3. Offline


    The very Lockette thanks for this plugin really usefull i dont have anything bad to say about this

    EDIT BY SILENTSPY: Please don't quote the main post.
  4. How is this incompatible with ChestShop ?

    Is it just that people might protect other peoples chest shops creating deadlocked chests ?
  5. Offline


    Can you make it so Zombies cant break down protected doors? :)
  6. Offline


    So in theory this would allow you to protect buttons/levers/other mechanisms, correct?
  7. Offline


    Thats awesome, the custom blocks is an great idea!
  8. Offline


    Chestshop is full of security holes at the moment, I had a look along with Darq and found I could break into a chestshop with chestshop too.

    You can use chestshop to get past LWC protections as well, by clicking the sign.

    Currently there is no previsions for zombie interaction with locked doors, either they break in or they don't, I haven't tested. When we get an RB for 1.2.3, it'll be alot easier to control. (Would need the proper events working.)

    Please edit your post and remove the long quote, lol.

    In theory, but don't count on it protecting in that way and it wouldn't look nice with the attached-sign method. (A future update may allow other custom lock arrangements.) Redstone circuits can be hacked by putting a redstone torch in the right place, in any case.

    I recommend you put important buttons and such in a locked room instead, assuming you have a cuboid plugin to stop people breaking through walls.

    Thanks, and incidentally Kane, you can use this for custom blocks too. Just it doesn't support sub-data values atm. And if the special chests are double chests, you will have to protect both halfs.

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


    how do you install? just drag in folder and jar or more stuff?
  10. Offline


    CTMgames just like any other plugin, really.
    • place the .jar file in the plugins folder
    • run the server once to create the plugin's folder and config file(s)
    • stop server
    • modify the config to suit your situation (see config info, above)
    • add permissions nodes (see permissions info, above)
    • start server
    • lock things.
  11. Offline


    Are you a developer? Do you want to help with Lockette? Sign up NOW!

    Just wondering if anyone is interested...

    I forgot to ask, can you check yourself if the added LWC compatibility is working as expected?

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  12. I will test it later today.

    Edit: Seems to work fine, thanks.
  13. Offline


    Thank you Acru!

    I still stand by the thought if someone has an Admin - they do not trust - that server owner is an idiot and I think it would be a nice addition to see if a player tries to snoop in a chest instead =)
  14. Offline


    Searching doesn't seem to be working for me (server error), so apologies up front if I've missed this in the few pages of posts I have read through...
    I have Lockette1.6 running fine, works great on chests, but I have yet to be able to get a sign attached to a door. I am the op, so presumably I should able to run this with permissions false, but no go. I turned on permissions and added what I presume to be the appropriate nodes, but still no luck with doors.

    Any suggestions on what I should be looking at here? I am running croxis' Lift mod which uses signage for elevators and DeathTP, but from my minimal understanding of the behind the scenes I would think they wouldn't be interfering with each other. Thanks for the help and a great mod!
  15. Offline


    TheTiGuR It works just like locking a container, except that you can also place the sign above or below the door. You should check that you've given yourself permission for lockette.create.door or lockette.create.*

    If you think you've got everything config'd properly, you might try turning off any sign-related plugins and see if the problem goes away.
  16. Offline


    Greylocke Placing the sign above/below the door works great, thanks for the info

    Am I incorrect in thinking that the sign should attach itself to a door like it does with chests?
  17. so i went into permissions under my admin group and put in the permissions - -lockette.admin.snoop
    and they were still able to snoop in a container. what's wrong?
  18. Offline


    How works the mcmmo towny groups part?
  19. Offline


    You can attach directly to a door too, just you have to place a sign post beside it instead and it will turn into a wall sign on its own when made [Private]

    Check that you have permissions enabled in the config.yml

    You specify a group instead of a user by putting it in square brackets, like [Group].

    Other plugins like factions, mcmmo, and towny provide different kinds of groups, unique to the plugin, but you can use them the same way.

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


    So, i just put [Townyname] and/or [Partyname] and done?
  21. Offline


  22. Offline


    really use full i prefer it to any of the othor chest lock plugins
  23. Offline


    how do i (owner) open others chest that are protected?
  24. Offline


    Could you help me, I use bperms 2 and all the permissions work fine but if I put the ranks on a sign the people who are in that rank can't access the sign chest/door unlike the other permissions plugin I used before. Will that be fixed?

    I use Lockette v1.6
    CB Build: 2060 beta
    bpermissions 2
  25. Offline


    painisgod instead of re-posting the entire original post, read it. In the advanced setup you will see that you need to set "allow-admin-bypass" and "allow-admin-snoop" to true. Then look at the two paragraphs that start with"If a permission plugin... " to decide if you also need to set any permissions nodes. (the permissions are also conveniently documented in Advanced Setup.)

    Colm Make sure you're using the latest version (currently 2.9.1) and at least Lockette 1.6. There was an issue with bPerms groups and Lockette 1.5. I know that bPermissions groups do work with Lockette .
  26. Offline


    I use
    bperms 2.9.1
    lockette 1.6
    CB 2060 beta

    Is their a permission to let someone use their rank? Everyone can make private signs though so that's fine.
  27. Offline


    Colm no, there is no permission node to control if a player can put a group/rank on a Lockette sign
  28. Offline


    Could this be possible in the near future?

  29. Offline


    BoorMachine that would be very difficult to do, and even if you could make a workable algorthm for the sign protection, it could easily be circumvented by placing a redstone torch.

    Repeatedly Acru has advised to place buttons that you'd like to protect behind a locked door.
  30. Offline


    Please edit your post to remove the long reply.

    Did you put the group name in square brackets, such as [Group]?

    As Greylocke said, I have been suggesting putting controls behind locked doors if they are important, as most circuits can be hacked by placing a redstone torch in the right place.

    The actual layout of signs like that may be possible in the future, via more custom protection types other than single block, but currently the feature is only planned, and would go along with careful generalization of the protection search routines.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
    Last edited by a moderator: Jul 18, 2016
  31. it's set to yes... it still lets him

Share This Page