[SEC] Lockette - Simple chest and door lock, no databases! [Moved to BukkitDev]

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:

• French by Misa
• German by Efstajas
• Polish by Kamild1996
• Dutch by Tofun
• Danish by Dumle29
• Slovenian by LiqouRiiCe
• Spanish by Agubelu
• Norwegian by Tio1999
• Swedish by TheMineKraftor
• Italian by Nikkolo_DTU

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.



Overview:

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.


Features:

• 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 (Permissions) (close)

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 (close)

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 (close)

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!

 

Permissions system upgrade won't be in this build, though it won't be the final one either.

I haven't heard of the Superperm Bridge though, have any details?
If it is a small change to support it, I might be able to slip it in tonight.
Edit: If it is supposed to emulate Permissions, it should work as-is? Or does it give an error?

 

The Superperm Bridge is an 'add on' plugin for PermissionsBukkit to allow non compatible plugins which were compatible with older permissions systems be used. However, Lockette doesn't recognise the groups from PermissionsBukkit so using things like [Council] would not allow people in the 'Council' group to make use of items.

Kind of a shame you're not planning on adding PermissionsBukkit support since it's the intended replacement for all the others and they're really trying to get everyone to update.

 

It is planned, but in a later release, and I found out why the superperm bridge isn't working for groups...

According to:
https://github.com/SpaceManiac/Perm...muus/bukkit/permcompat/PermissionHandler.java
the inGroup functions are not implemented.

I'll fire off a message to @SpaceManiac to ask if he can add the support easily, for the short term.

 

I wouldn't hold your breathe. I asked about adding support just to allow better functionality during the switch over for people and got into a rant about how it's the dev's who refuse to update causing the problems and not them, etc etc. That wasn't SpaceManiac though, was one of the collaborators on the project, so perhaps he'll be less narky about it haha.

 

Well, I did donate some code to Space for his Nether plugin, some time ago, so... He might do it if it is a small change. I could possibly figure it out and submit the change myself, but I'd be better off doing the change in Lockette directly. :3

 

Well I shall keep my fingers crossed. I've waited this long another few days wont kill me. Though if it's not going to happen I would be best switching to LWC I think as they've already added support for PermissionsBukkit.

 

@Acru can you add SimpleClan support ?

 

@8Keep
It already works with 1060.

 

It does? Cool, downloading it now!
I thought it was months out of date.

 

Yeah it's not been updated for months, but nothing has changed in Bukkit to break it's current functionality.

 

You said a new version was coming a few days ago...am I stupid and missing the DL link or has it not come yet?

 

I'd have to look into it.

It would make it easier, but not much better than 1.3.8 with 1060.
In either case I'm working on pushing out an update before Monday.

It is still coming in that I am still working on it at this very moment.
I got side tracked a bit on some of the tasks, but it is nearly ready now.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Awesome, looking forward to it.

P.S. Love the avatar!

 

Working on it now~

PS: Thanks.

 

Pro tip, don't say days... because then it never happens and everyone expects it.

 

Hee, yeah. I tried but I didn't quite make it.
On the plus side, only some small details to clean up so won't be long now, everything else is correct and security tested.

 

That's a much less 'binding' answer...
Regardless, people should have more respect for plugin developers, like yourself, who dedicate their time to creating plugins, for no compensation. Instead, all you get are people complaining among other things...
But that's probably a rant that belongs in another thread, so I'll suppress it :X

I digress;
Can't wait for the release and I'm extremely to see Lockette being maintained, or at least updated, again.
Hopefully 1.8 doesn't break too much in the next update - otherwise it might make more sense to wait for 1.8 before releasing another update, if it could potentially require a large rewrite.
Then again, I'm going to get crap from certain people (as described above) for that post...

Do whatever you want ,
And thanks for such a great plugin!

 

I would agree. I put in preliminary support code for fence gates already and with luck it will work as intended, but it may not. Though most of the 1.8 update work will be on the Bukkit team's hands, to apply the needed hooks~

 

Good to hear!

Very nice idea, fingers crossed it all goes smoothly, I feel bad for the Bukkit dev's since it's such a major update this time they're probably going to get a lot of angry/impatient people ranting at them.

I agree, and hope you don't think that was my intention, my comment was made in jest because I know myself when I say a day and don't get my stuff released on that day, I get nothing but complaints.

 

@khamseen_air, @Aaron Mullins(CoWs), @8Keep, @Retricide, @generilisk;

To those who have shown interest recently, this is a heads up that 1.4 has been released to the wild.
Let me know if you find any issues with it.

 

Thank you for updating this Acru! Trapdoor support is something that my users have been wanting for a long time.

My only 'complaint' would be the very few permissions plugins supported. Of the ones you list, only group manager is still active. I would suggest adding support for the bukkit 'superperms' and/or PermissionsEX.

Myself, I recently moved from Permissions 3.x to PEX, and this was one of the affected plugins (the PEX bridge never worked right for me, so I had to go full PEX/SPerm).

 

I would agree completely on this point, permissions have come a long way in the last 2-3 months.

I wanted to first get everything else out of the way first, as the support for superperms will require building against a new Bukkit jar, instead of the old BukkitMulti used for backwards compatibility. (This means officially dropping support for builds 556-850, and perhaps up to 999.)

I haven't looked into PermissionsEX though, so I'll take a peek tomorrow.

 

Ok, after testing the new version, the only thing I can think of that would improve the plugin (aside from the permissions support I mentioned earlier) would be trapdoor handling.

As the plugin works now, trapdoors can be locked by placing the sign either on the door itself (which looks weird having a sign floating in air) or on the back of the 'hinge' block. Being able to lock a hatch by placing the sign above the hinge block would be great.

I mention this as many of my players (and myself for that matter), will place a hatch against the outside wall of a building, which blocks two of the sides of the hinge block. So the only choice to lock a hatch would be to have the sign float in air or be placed on the back of the hinge block (which would be outside of the building).

Am I being clear, or am I just being confusing?

 

An easy fix might just be to hinge the trapdoor on a block just inside the room, so the trapdoor has blocks on 3 sides if it is in a corner? :3

By above, do you mean a wall sign just above the trapdoor itself?

 

But having the block just inside the room would mess up the ascetics and cause bad feng shui!

And yes, I meant just above the hatch. Think of an open hatch and how it takes up most of the face of a block. Put the sign right above it, similar to how a door looks. Right now, the hatch locking method reminds me more of locking a container vs a door.

 

@Acru
Everything works perfectly so far. No incompatibilities.
Thank you for your time and effort, good sir. Check your paypal

 

I can see how that might work well, yeah. I'll have a look at extending the protection to include that case.

Oh, thanks~ :3

I just downloaded and played the 1.8 beta, it looks interesting and I found myself an abandoned mine shaft too~

Though I am a little saddened about the change to chests, they no longer fill their bounding boxes.

This means attached signs will look to be floating up close, and that you can see the formerly hidden or missing blocks behind/under the chest.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

good thing you updated Lockette
does it still have the same permission nodes?

 

Awesome! Thanks alot arcu!

PS: I have always used PermissionsEX with this plugin, works fine
So no problems there?

P.S.S: Everything works fine!!!!! Thanks alot arcu, great job.