[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

    Acru

    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.



    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.)

    [​IMG]

    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:
    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

    Euron

    I run a survival world on my server (along with a peaceful/creative one); I love having Lockette for the building world, but it kind of breaks immersion for the survival world. The use would be, essentially, to be able to have a container locked but either at a price, or at the risk of it eventually becoming unlocked.

    Does it necessarily have to be managed by a database? I don't know Java at all, so forgive me if I'm talking out of my ass; would it be possible to do something like "every time the sun comes up, if a sign has [Private], and if the player whose name is listed above it has x iconomy $, remove x $, and do nothing. If false, destroy sign."

    If that is at all within the scope of java/bukkit capabilities, I think it would be a great way to introduce iconomy support for Lockette.
     
  3. Offline

    Acru

    It sounds like a configuration issue? First thing to do is figure out what permissions mod and version Lockette is loading. Look at the console on server startup.

    There have been a couple instances where someone is changing config for Permissions, and it is actually loading GroupManager as both are present.

    Okay, I'll include this in the next update.

    The database comes in when you need to know where in the infinite world all the [Private] signs are. In memory it might be a rather long list, but the data would have to be saved/reloaded when the server is shut down or restarted, and the list would need to be searched when doing something global like that, consuming more time the more locks there are. Something I am trying to avoid at all costs.

    A simpler database would just keep track of players and not of chests, but you would have to be damn careful that all chest creations/destructions are accounted for, otherwise the the accounting for a player may become out of sync and permanently un-fixable. (I already know that I'm missing some ways of removing doors, due to unstable foundations, and worldedit would just make things worse.) And this still adds processing time for each player in the list.

    I assume you have separate permissions for each world? You could just have lockette.create.* enabled for building world, but not for survival world?

    As for iConomy however, you could feasibly charge fees on creation or on use of the locked container. Just not at set intervals.

    I've started moving code out of Lockette and into a common class for multiple plugins...
    Hopefully this doesn't break anything. o3o

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
     
    Last edited by a moderator: May 8, 2016
  4. Offline

    nullkid

    Did not think of this :D Perfect idea, thank you. This is exactly what I was looking for then. Kudos!
     
  5. Offline

    Cookies326

    I'm running version 1.3.4 and bukkit 670. and I have not mess with the config or anything aside from putting permission to the admin group.
     
  6. Offline

    Acru

    Do you have Permissions.jar or GroupManager.jar, though? (Or both?)
    What does your permissions file look like? (It might help if you post it in full.)
     
  7. Offline

    nicholaslimck

    Strangely, Lockette only warns the people who trespass my doors to close the door behind them... Am I doing something wrong?
     
  8. Offline

    Acru

    The lockette.admin.bypass permission allows admins to go through locked doors. Don't give this permission to people who you don't want to bypass doors. :3

    Or if you aren't using a permissions plugin, anyone who is op'd.
     
  9. Offline

    Chekkaa

    Wow, brilliant plugin! I LOVE that there are no commands! It just makes things easy. :)

    The doors also are really nice. Beautiful.
     
  10. Offline

    Donxpro

    My members cant use lockette, When they try to use it they get this on there sign [?]. Here is my permissions file.

    Code:
    Member:
            default: false
            info:
                prefix: '&a'
                suffix: '&3'
                build: true
            inheritance:
            - Default
            permissions:
            - lockette.create.*
            - commandbook.who
            - commandbook.motd
            - commandbook.rules
            - commandbook.say
            - commandbook.say.me
            - commandbook.msg
            - commandbook.clear
            - SpawnControl.sethome.basic
            - SpawnControl.home.basic
            - SpawnControl.spawn.use
            - mcdocs./help
     
  11. Offline

    Phil3004

    Please Please add iConomy Fees !
    Thanks in advice
     
  12. Offline

    Cookies326

    I use group manager, cause I was having problem with permission even though the config was same. In the end, my friend helped me with group manager so I just sticked with it.

    PS. Nothing was changed except the Groups file and the users file

    I never put any permission in my users file instead in my groups file so here's my group:
    Code:
    groups:
      Trustee:
        default: false
        permissions:
        - enable-messages-*
        - FD.admin
        - griefalertr.view
        - TentThis.commands.setLimit
        - tpp.others.*
        - tpp.tp.*
        - warp.create.*
        - warp.to.*
        - woolswitch
        inheritance:
        - peasant
        info:
          prefix: '&c'
          roles-category: faction
          build: true
          suffix: Trustee
      SemiAdmin:
        default: false
        permissions:
        - +groupmanager.mandemote
        - +groupmanager.manpromote
        - -groupmanager.*
        - '*'
        - delayedstop.cancel
        - delayedstop.start
        - godPowers.die
        - godPowers.godmode
        - godPowers.godmodeOnLogin
        - godPowers.heal
        - godPowers.inferno
        - godPowers.jesus
        - godPowers.maim
        - godPowers.slay
        - godPowers.superjump
        - lwc.mod
        - vanish.vanish
        - vanish.vanish.list
        inheritance:
        - moderator
        info:
          prefix: '&c'
          build: true
          suffix: Co-Admin
      RedFaction:
        default: false
        permissions: []
        inheritance:
        - peasant
        info:
          prefix: '&c'
          roles-category: faction
          build: true
          suffix: Red
      Farmer:
        default: false
        permissions:
        - essentials.kit
        - essentials.kit.farmer
        - essentials.spawnmob
        inheritance: []
        info:
          roles-requirement:
          - BlueFaction
          - RedFaction
          prefix: ''
          roles-category: job
          build: false
          suffix: ''
      Healer:
        default: false
        permissions:
        - essentials.kit
        - essentials.kit.healer
        - essentials.heal
        inheritance: []
        info:
          roles-requirement:
          - BlueFaction
          - RedFaction
          prefix: ''
          roles-category: job
          build: false
          suffix: ''
      Fighter:
        default: false
        permissions:
        - essentials.kit
        - essentials.kit.fighter
        inheritance: []
        info:
          prefix: ''
          roles-category: skill
          build: false
          suffix: ''
      Admin:
        default: false
        permissions:
        - allow-admin-snoop
        - griefalertr.ignore
        - griefalertr.stick
        - griefalertr.use
        - lockette.admin.bypass
        - lockette.admin.reload
        - lwc.admin
        - TentThis.general.destroyAnyTent
        - tpp.admin.*
        - vanish.dont.hide
        - warp.admin.*
        - backup.canbackup
        inheritance:
        - semiadmin
        info:
          prefix: '&4'
          build: true
          suffix:
          - Admin
      Miner:
        default: false
        permissions:
        - essentials.kit
        - essentials.kit.miner
        - flashlight.regular
        inheritance: []
        info:
          roles-requirement:
          - BlueFaction
          - RedFaction
          prefix: ''
          roles-category: job
          build: false
          suffix: ''
      Guest:
        default: true
        permissions:
        - enable-protection-doors
        - essentials.help
        - essentials.home
        - essentials.motd
        - essentials.sethome
        - essentials.spawn
        - explosion-protection-all
        - falsebook.*
        - HomeX.*
        - lockette.create.*
        - lwc.protect
        - SignOwner.getMessage
        - TentThis.commands.setOwnSchema
        - tombstone.large
        - tombstone.lwc
        - tombstone.quickloot
        - tombstone.sign
        - tombstone.use
        - tpp.jump.*
        - tpp.request
        - wolfnames.set
        - wolfnames.show
        inheritance: []
        info:
          prefix: ''
          build: true
          suffix: ''
      FlyingMan:
        default: false
        permissions:
        - nocheat.moving
        inheritance: []
        info:
          roles-requirement: Fighter&SuperCart
          prefix: ''
          roles-category: skill
          build: false
          suffix: ''
      Peasant:
        default: false
        permissions:
        - roles.joinrole
        - roles.leaverole
        - roles.myroles
        inheritance: []
        info:
          prefix: '&e'
          build: true
          suffix: Peasant
      BlueFaction:
        default: false
        permissions: []
        inheritance:
        - peasant
        info:
          prefix: '&d'
          roles-category: faction
          build: true
          suffix: Blue
      Railer:
        default: false
        permissions:
        - essentials.kit
        - essentials.kit.railer
        inheritance: []
        info:
          roles-requirement: Miner
          prefix: ''
          roles-category: subjob
          build: false
          suffix: ''
      SuperCart:
        default: false
        permissions:
        - minecartmania.*
        inheritance: []
        info:
          roles-requirement: Railer
          prefix: ''
          roles-category: skill
          build: false
          suffix: ''
      Moderator:
        default: false
        permissions:
        - admincmd.item.add
        - admincmd.item.color
        - admincmd.item.more
        - admincmd.item.repair
        - admincmd.player.list
        - admincmd.player.loc
        - admincmd.player.msg
        - admincmd.time.day
        - admincmd.time.set
        - admincmd.tp.from
        - admincmd.tp.players
        - admincmd.tp.to
        - essentials.give
        - essentials.item
        - essentials.list
        - essentials.tp
        - essentials.tphere
        - jail.command.jail
        - jail.command.jailbackup
        - jail.command.jailcheck
        - jail.command.jailclear
        - jail.command.jailclearforce
        - jail.command.jailcreate
        - jail.command.jaildelete
        - jail.command.jaillist
        - jail.command.jailtelein
        - jail.command.jailteleout
        - jail.command.jailtransfer
        - jail.command.jailtransferall
        - jail.command.unjail
        - jail.command.unjailforce
        - lockette.admin.break
        - TentThis.commands.setLimit
        - tombstone.*
        - tpp.mod.*
        inheritance:
        - trustee
        info:
          prefix: '&c'
          build: true
          suffix: Mod
    
    For some reasons it allows even the Guest group to bypass. Did I do something wrong? I have yet to change the config files for Lockette.
     
  13. Offline

    nicholaslimck

    Oh... How can I make it so there isn't that op bypass? My server's private for me and my friends so almost all of us are op :p Should I use permissions?
     
  14. Offline

    Chekkaa

    Can you maybe allow the admin snooping message to be disabled? :p
     
  15. Offline

    Incendia

    How does this handle people with retardedly long names? (I forget what the limit is on an online mode server, but I was pretty sure it's longer than a line on a sign)
     
  16. Offline

    dunem

    hi everyone, I have a problem since the latest update :( please help!

    thanks Acru for your plugin its a real valuble asset to our server but its kinda broken :(

    Just updated our server from Bukkit 617 to the New 670 build, also updated your plugin to latest also.

    Now, admins and anyone with build permisissions can open a protected door which is an anoyance we like to solve with your help.
    Before, the door was locked and protected against everyone so it was completly safe, now it just overrides.

    Is this normal? not sure if i need an extra parameter on the sign to stop this?

    any responses appreciated,
    thanks
    dunem
     
  17. Offline

    Acru

    Thanks :3

    Do you have both GroupsManager and Permissions installed too? Working on a fix but currently GM overrides Permissions.

    I'm afraid this will have to wait, due to some sort of permissions issue going around.

    It handles by comparing the first 15 characters only, the length of one line of a sign.

    I am adding a config option, but use this method for now:
    http://forums.bukkit.org/threads/4336/page-17#post-194979

    I could easily add a config option for this too, like the snoop one?
    Edit: I added this just now, but trying to take care of some other issues before release.

    Edit: See later replies! :3

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

    LatestLeech

    I added this permissions: lockette.create to my users but they still cant use the signs?
     
  19. Offline

    Acru

    Use lockette.create.* (the .* is needed)
     
  20. Offline

    LatestLeech

    oh ok thanx abunch!
     
  21. Offline

    Acru

    I think I found your problem!

    Remove the following permissions lines from your groups.yml:
    - enable-messages-*
    - allow-admin-snoop
    - enable-protection-doors
    - explosion-protection-all

    These are not permissions!
    The dashes are breaking all your permissions..., and everything will work once they are removed.
    They are settings in plugins/Lockette/config.yml
     
  22. Offline

    dunem

  23. Offline

    Acru

    Oh, do you know about the addition of the permission lockette.admin.bypass?
    Everyone with this permission can bypass doors, and is included in '*'.

    I've added a config file option for the next version to disable all bypassing, but I've not released the update yet as there is more to do first.
     
  24. Offline

    dunem

    i do know about it but no one has this permission, and still they can access doors. If i added the permission it makes no difference. Still accessable by admins and all with build:true

    oh ok, i might try again later date when u got the update released. thanks for your work.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
     
    Last edited by a moderator: May 8, 2016
  25. Offline

    connor yates

  26. Offline

    Acru

    Since you are using EssentialsGroupManager.jar, a permissions system, you need to give people the permission:
    lockette.create.*

    Either edit your GroupManager permissions, or remove the plugin.

    If you post your permissions config file in full, I could help better? Otherwise watch for version 1.3.5. :3

    From the screenshot though, UKWF has the permission '*', so anyone in that group can bypass doors.

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
     
    Last edited by a moderator: May 8, 2016
  27. Offline

    Donxpro

    I do not have GroupsManager installed.
     
  28. Offline

    G1R Productions

    When i place a sign on a chest and lock it then sign onto my other account and smash the sign it moves to the wall next to the chest and then that account is able to open the chest.
     
  29. Offline

    Cookies326

    OMG thanks a lot. I appreciate it, THANKS A MILLION.

    PS. This plugin is AWWWEEESOME
     
  30. Offline

    Acru

    I'll need more information, as this is not normal.

    Eg, bukkit build, other plugins used and versions, any messages in console, how you are placing the sign, etc.

    Wait, are you using craftbukkit build 605-612?
    Look at the console log on server startup to see what Lockette says.
    If you are, that one is broken and the cause. Try 617 or 670.
    If not, what is the error message exactly?

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
     
    Last edited by a moderator: May 8, 2016
  31. Offline

    Donxpro

    well all of a sudden it works thanks for your help anyway.
     

Share This Page