Entity Security

The SecureServe Entity Security system helps protect your server by managing the creation of suspicious entities

Configuration Options

Entity Lockdown Mode

The SecureServe.Module.Entity.LockDownModesetting determines the level of entity creation restriction:

  • inactive: No restrictions are applied.

  • relaxed: Only script-owned entities created by clients are blocked.

  • strict: Only server-side scripts can create entities.

Example:

SecureServe.Module.Entity.LockDownMode = "inactive"

Choose the appropriate mode based on your server's security needs.


Entity Security Whitelist

The SecureServe.Module.Entity.SecurityWhitelisttable allows you to whitelist specific scripts that are known to create entities but are not malicious. This prevents false bans caused by legitimate scripts.

Example Configuration:

SecurityWhitelist = { -- Resource exceptions allowing entity creation without triggering security measures.
    { resource = "bob74_ipl", whitelist = true },
    { resource = "6x_houserobbery", whitelist = true },
},
  • resource: The name of the script resource (in lowercase) that is causing false bans.

  • whitelist: Set to true to allow the script to create entities without triggering security measures.


Handling False Bans

If a player gets banned with a message like ( and the bans is a false ban ):

Created Suspicious Entity [Entity Type] at script: "<script_name>"

Follow these steps to whitelist the script:

  1. Identify the Script:

    • Check the log for the script name that triggered the ban.

    • Example log message:

      Created Suspicious Entity [Object] at script: "bob74_ipl"
  2. Add the Script to the Whitelist:

    • Open the configuration file.

    • Add the script to the SecureServe.Module.Entity.SecurityWhitelisttable.

    • Example:

      SecurityWhitelist = { -- Resource exceptions allowing entity creation without triggering security measures.
          { resource = "bob74_ipl", whitelist = true },
      },
  3. Save and Restart:

    • Save the configuration file.

    • Restart the server to apply the changes.


Best Practices

  1. Start with Relaxed Mode:

    • Begin with relaxed mode to avoid unnecessary bans while monitoring potential threats.

  2. Regular Updates:

    • Continuously review logs and update the whitelist as needed to avoid banning legitimate scripts.

  3. Use Detailed Notes:

    • Add comments in the configuration file to track changes and reasons for adding scripts to the whitelist.

Last updated