[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!

 

On my server peoples items in their chests are disappearing and the signs are going blank. Started happening since 1.7. I guess it is to do with Lockette.

 

Lockette isn't capable of changing signs without player interaction and it can't change the contents of a chest at all
Are you sure you have no other plugins installed that are capable of this, checking the signs would be your best bet as the missing items would likely be theft

 

Defiantly not theft lol. It just seems like a bug, I guess it has to do with the new 1.7 update.

 

im only having one issue a player on my servers name is to long to put in one line so what do i do? lol

 

I think Lockette will trim the name to the max length it can read from the sign and go from there

 

Will this plugin ever be updated to support locking of trapdoors?

 

Getting a error for normal players,

When a player tries to make a sign in a friends name the following happens depending on if friend is on-line.

Code:

[Private]
Lynxdragon
Thathia

Would turn to the following as soon as Thathia logs on, or if she is already on-line.

Code:

[Private]
Lynxdragon
Lynxdragon

Bukkit 953, No errors, Chests still lock ok, No sign editors.

 

There is a slight bug. Let's say I have user "John", he is able to create private signs for "John" or "john" or "JoHn", it doesn't appear to be case sensitive. However, accessing the protected containers IS case sensitive, so when my user mistypes their name, they are no longer able to do anything with the container, and I or one of moderators is required to break the sign.
I'm using permissions and users only have 'lockette.user.create.* '

 

please make it to with an trapdoor.

 

Hello. You can add SupplySign to the list of compatible mods.

I have a suggestion that would REALLY REALLY HELP out with my server. It's quite simple.

Can you add a tag in the properties file that allows chests to be destroyed with explosions? Like canExplode= true/false? I know it currently by default disables any explosions that would damage it. We run a towny server with RPG and pirates who can't destroy buildings with locked chests. Thanks!

EDIT: Maybe I'm doing things wrong ...
explosion-protection-all: false
this is in my properties and yet and I still cant blow up a chest that is affected by Lockette. Any one else getting this problem?

 

Explosive protection all just protects all containers with and without Lockette signs
Give your users the ability to break signs, it's your only option at this point without editing Lockette

 

Ah! Thank you so much for clearing that up for me. Yeah, they can break them just fine (via a pickaxe or what not). It's just that if we fire TNT at someone's home (via AimCannon), the explosion effect is nullified if said someone decides to reinforce their home with Lockette chests. Rather than restrict the amount of chests someone is able to have, I would like to see them blow up.

 

You can't restrict the chests with Lockette as it would require a database to track the existing chest count (which won't be added by Acru, at all) or a dedicated admin/mod team to lock and track all the chests for your users
And ya, not much you can do really as Lockette doesn't have a no explosive protection state

 

Argh. I'd hate to go down to just LWC as so many people love Lockette's ease of use. We will see what Acru does here.

 

Just wandering - am I the only one who has problems with Lockette that some tables get purget and go with no text at them from time to time?

My users have these issues, on several days some signs got no txt, no edit from the user, and the chest gets opened.

Or is there any known hack / mod that can overpass the lockette?

 

Have the same issue, not necessarily lockette that's causing it, but it seems to be the logical choice

 

Considering that Lockette doesn't use tables of any sort, I'd look for any other plugins that deal with signs. I use very few plugins on my server, and aside from lockette, none of them have anything to do with signs, and I've never seen anything like this happen. I'm not saying that it's not happening , but from what I have seen, I highly doubt the problem is lockette.

 

Any dev help?

Hmmmm.. I got your point.
I have craftbook t hat use signs to teleport up and down, also Sortal to teleport to coods.

 

Hi,
Please can you add a Source link to the thread? I would like to look at how you wrote this plugin. It's awesome.
thanks

 

On my server anyone can break the signs, moderators and admins etc, how can i make it that ONLY the person who set the sign can remove it without any ops, admins or mods that can break it?

 

Turn off break and remove the admin break permission from everyone

 

How do i turn off break?

 

You have permissions installed, yes?

Open the first post and read the section on Advanced Setup. It's in there.

 

Disregard my earlier post (now deleted) about the sign text disappearance being related to hacked clients
http://leaky.bukkit.org/issues/1052

 

I love this plugin! By the way, I made a Dutch strings.yml...

<Edit by Moderator: Redacted mediafire url>

 

Hey any chance of getting Lockette listed in CraftBukkitUpToDate? Very handy plugin that assists in keeping plugins updated. See http://forums.bukkit.org/threads/ad...keep-your-server-plugins-up-to-date-935.5026/ for information on how to get setup - a static jar to the latest version is usually the quickest, but other methods work too.

 

@Acru Just as a heads up, I've just released a plugin which allows you to buy and sell the rights to Lockette containers!
http://forums.bukkit.org/threads/ec...-the-rights-to-lockette-containers-953.25494/

 

Ah, gawd, a month can pass by so fast when rl is keeping ya busy~
Now to reply to some posts in no particular order, before I put it off any longer... >.>

Interesting~ I hope you accounted for security issues. :3

It has been listed since way back, or should be anyway? I sent them a static url long ago. *shrugs*

Ah, thanks~ Once more for the list.

Thanks again for minding the thread while I've been up to mischief~

Okay.
Not yet.
Okay.
Not yet.
Can-do.
Yes.
Okay.

Just no promise on when version 1.4, the one with hatch support, will be released...

 

It's Minecraft bug and very annoying too.

 

Well.. ? This f*cks things up, doesnt it?
People got rabed and I can't do sh*t about that, becouse I don't know whos the villen :/