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

 

What version of that plugin was it? If you can check, I can find a copy and see what the trouble is with it.

 

hi! firstly, i would like to say i love your plugin, works great. very smart. ive been running it on my server for a while now... and recently added permissions to the server. after some trial and error, i realized i needed to put 'lockette.create.*' into the groups i wanted to be able to create locks...

here is the error, and my permissions file:
http://i54.tinypic.com/vwwjg2.jpg
http://i56.tinypic.com/2cculqs.jpg (oops... this is before i changed both instances of 'lockette.create' to 'lockette.create.*'

and i think the solution must be very simple.... but im a completely uninitiated noob at these things.

 

you placed one of them in the "inheritance" of mod instead of permissions...

 

it was version [670]

 

Hmm thats clever!

 

could you update the plugin? My version of bukkit says it is out of date.

I get this error...
14:18:43 [SEVERE] com/nijiko/permissions/PermissionHandler loading Lockette v1.3
.4 (Is it up to date?)
java.lang.NoClassDefFoundError: com/nijiko/permissions/PermissionHandler
at org.yi.acru.bukkit.Lockette.Lockette.setupPermissions(Lockette.java:7
42)
at org.yi.acru.bukkit.Lockette.Lockette.onEnable(Lockette.java:145)
at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:127)
at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader

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

 

Right, erm, well, yeah. Having major issues 3:
No matter what I do, I always get told "Lockette: Permission to lock containers denied"

-I'm running a server with brohoster
-I have the latest version of Permissions and Lockette
-I've tried putting both "- lockette.create.*" and "- 'lockette.create.*'" in the permissions file, in case the apostrophes matter.
-I've tried uninstalling -every other plugin- to check if it's an incompatibility issue. It made no difference.
-I've tried as an op, and as a non-opped user
-I've had other people try
-I've triple checked my permissions configuration notecard

I cannot work out why it's coming back with permission denied v.=.v
Here's my permissions configuration txt --

Code:

plugin:
    permissions:
        system: default


groups:
    Default:
        default: true
        info:
            prefix: (guest)
            suffix:
            build: true
        inheritance:
        permissions:
            - 'general.spawn'
            - 'myhome.home.*'
            - 'varietree.random'
            - 'nethrar.use'
            - 'lockette.create.*'
    Moderator:
        default: false
        info:
            prefix:
            suffix:
            build: true
        inheritance:
            - Default
        permissions:
            - 'general.time'
            - 'general.teleport'
            - 'general.teleport.here'
            - 'general.player-info'
            - 'lockette.create.*'
    Admins:
        default: false
        info:
            prefix: ~
            suffix:
            build: true
        inheritance:
        permissions:
            - '*'

users:
    salrith:
        group: Admins
        permissions:
    dopy:
        group: Admins
        permissions:

I have to say though, I've used your lockette plugin for ages now, and it's amazing. I just changed over to brohoster, and I can't get it to work after reinstalling.. But before now, it's always been one of my favourites, hehe.
But yes.. Any help would be sorely appreciated -- I miss it 3:

 

Same as Salrith, no user can use Lockette anymore. Did the config files change with the update?

I'm with Multiplay (bad investment). I tried everything, my Groupmanager 2.1 files are the same as before. The lockette 1.3.4 update broke the plugin for me...

When someone tries it, it gives :




Any more information needed?

 

My feature request: make doors close automatically in a number of seconds (would help a ton when you have more than 20 doors around/in your creation). Other than that the plugin is awesome!

 

Cool plugin but we have a problem with chest protection, if the sign is destroyed, it is replaced in the second but not on the container if there a bloc near the chest.
edit: and of course this disable the protection :/

2 screens are better then explanations :



and the worst : it is a protected area, but the signs still destroyables.

 

omg. im an idiot. tyvm!

::edit::
okay... i changed it around:
http://i52.tinypic.com/1z3m6fo.jpg

and im still getting pretty much the same error.

 

Haha i have the same request.

Edit: This happened to me, i cant remeber exactly what i did, but i remember i updated something, so update your groupmanager/permissions your bukkit and your lockette.

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

 

There is another plugin out there which auto closes wood doors, try that

 

How can I make it so that Ops /cant/ go in everyones doors and chests? I'm not using permissions, by the way, it doesn't agree with me.

 

You need permissions or Acru needs to add a config option for it

 

I'm getting a strange problem that I have tried to find the solution for, with no luck.



This does not happen when I restart the server and place a new sign, but when I disconnect from the server and log back in later the double-door function does not work, and when I remove the sign and try and place a new one it gives me the above. It is fixed only by restarting the server, which I do not wish to do everytime I log out and in.

I am using build 677. Any help would be great; I'm a huge fan of this plugin and would be saddened if I had to deny the people in my server the great functionality Lockette offers by deleting if from my server!

 

Oh dear, I'm off for the weekend and when I come back there are many messages~ I'll try to catch up in a bit.

Your problem is the /t (tab character) in your permissions config file. Tabs are not allowed apparently, only spaces.

No-no, I mean what version of EssentialsGroupManager was it?

You are apparently using an old permissions plugin... Or perhaps FakePermissions without GroupManager active?

I'll have to get back to this one a bit later, but in the mean time could you fill me in about what versions of bukkit and Permissions exactly you are using? Actually, just send me your console log, it will have the info I need...

The 1.3.4 update added the lockette.create.* permission, needed if you are using a permissions plugin.

I'll add this as soon as I can figure out if the troubles people are having with permissions are ones of bad configs and old plugin versions, or an actual issue... >.<

Another person reported this, but I was unable to do anything about it as the person was unable to help me track it down. From the pic, what is happening is that the subdata is being set to 0, likely by another plugin. (What version of craftbukkit too?) I can tell this is happening by the 'highlight' box is now the whole block that the sign is in, rather than just around the sign itself.

What I need from you is to find out which plugin is interfering with Lockette's operation, by disabling a few at a time.
Can you do this?

There is a config option to disable snooping, but not for doors. Unfortunately, the only way to tell an admin from a regular user is if they are op'd, so you should only op people who should be allowed to do such things. The reason for Permissions/GroupManager in the first place is to better distinguish who on the server can do what...

This is a strange problem, and the fact that it goes away when the server is restarted suggests it is an issue with the craftbukkit build 677 itself.

It seems to be a variation on the chunk ghosting bug, but why it would be effected by you logging out and back in I have no idea. However, you can be sure it is not only my plugin that will have issues, in Lockette it is just more obvious as it depends on the server to pass it correct data...

Is it just this specific door pair that is bugged, or does it do the same to a door in a different location? It is possible your door is straddling a chunk border, which should not be a problem, but may indicate where an issue lies.

What you might try for me is rolling back to build 670 and see if the problem still exists. If so, perhaps try some of 617-669?

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

 

I have tried rolling back the server to previous builds but the same situation occurs. Strangely enough, I have done some experimenting, and I have found out that I cannot place new locks on not only doors, but chests and furnaces as well. The really weird thing is, though, is that I cannot do this on my own possessions; I have gone to other peoples' homes and tried placing locks on their double doors/chests/furnaces, which works, and when I disconnect and reconnect, it still works, even without a server restart. So it seems this problem exists only with stuff that I create.

This problem also started to occur when I installed and first starting using the Essentials plugin; have you heard of any reports that Essentials conflicts with Lockette?

Thanks again for the prompt response

 

You could check for a plugin conflict by disabling all other plugins and seeing if the problem persists. There was an issue with an out of date EssentialsGroupManager, though that would cause permissions errors. In any case, we need to try narrowing down the potential sources of the problem.

Is this on a computer you own, or a network server? If so, do you have a second computer you could try running the server on?

A plugin conflict is a possibility of course, but many other things could be happening too. If not the build of craftbukkit, it could be something exotic like bad computer memory for instance, or something to do with the version of java runtime installed. (You could try a manual java update.) An issue constrained to a single area might indicate a bad chunk, if not a bad database for an area protection plugin.

Mind you, most serious issues would end up dumping exceptions into the console log file. Are there any traces of errors in there?

 

The permissions were set in GroupManager. Here's what it looks like.

http://pastie.org/1805789

 

Well i was on 670 but i just updated on 677, same problem.
i found the plugin which is interfering with Lockette, it's MCmmo, i hope you'll find a solution.
if you have any other question, just ask.
thank you.

 

Hey just wanted to say on 677 this is working great for us! The hardest part is getting my users over to the website to watch the video on how to use it.

Really appreciate your hard work, and do you have a very large beard yet?

 

No-no, I mean what version of EssentialsGroupManager was it?[/quote]

It was version 2.1

excuse my stupidness xD

 

It turned out that the plugin "WolfPound" was conflicting with the signs across all my other plugins. Getting rid of it has fixed all issues for me.

Thanks for all the assistance, and may Lockette prosper!

 

Which version of MCmmo were you using, just so I know?

I'll start tests with the current version to see if I can find a workaround.
I'll also try conferring with that plugin's author for a fix, once I can reproduce the issue.

Edit: The most recent version of MCmmo is just throwing a null pointer exception, lol. But yeah, I confirmed that the second newest version has the problem.

Ah, it is good to know you found the issue! I've been worried about some of the issue reports lately~
I'm not sure what the plugin might be doing to cause sign problems, but I'll have to look into it.

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

 

Ive installed this but the when i type on the sign [Private] it has a question mark and says permission to lock containers denied could you help?

 

You need to give yourself the lockette.create.* permission, or else disable your GroupsManager/Permissions plugin.

Thank you for the encouragement, and yes, it is white too~

Hum, that looks ok. I'm guessing it was intentional to not let guests use the plugin, anyway?
The people in groups Member, Moderator, and Admins should have permission, but not Guest.

Reading back though, you mentioned you have GroupManager 2.1?
The newest version of it is currently 1.0a5, perhaps you have an old Essentials version of the plugin?

Try replacing it with the one here.

I can't seem to find any old versions of the plugin to download and test with, only the most recent one.
I don't suppose you saved a copy of it?

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

 

i'm on the 0.9.29, the lastest (0.9.30) is a bit buggy.
thank you for your efforts

 

I started a convorsation with the mcMMO author, but I added a workaround in the mean time.

It seems it is only breaking wall signs that face south, so I added a check to watch for breaking signs with bad block data, and re-face them south.

I'll put an update out tonight, after I try to get some features stuffed in as well.

Update: Make that tonight as in the 19th, I got a good ways into self closing doors though it is not finished yet, and I am tired. :3

 

is there any way i can turn off those server wide messages when i open some ones door or chest?