Pho3niX90
Protects your gaming server against hackers, scripters, and more

Supported Games

Protect your gaming server against hackers, scripters, cheats and grievers!

The plugin allows you to auto kick known hackers and scripters, as well as cheaters, griefers, toxic playes, racist players etc, the list goes on and growing each day.

**Note: ** All auto kick features are configurable by server, so you can make use of the banDB or just use the features that are made available.

You can also auto kick users that are on VPN, PROXY or a BAD IP (See more at the bottom)

This tool is a combination of wealth of information regarding players, from their vac ban counts, economy bans, game bans and server bans. It also gives you the family share information, if they are lending, and whom they are lending from, as well if the lender is either vac banned or community banned.

Disclaimer:

  • If you are an abusive & biased admin, your server ip will be blacklisted from using this service.

Discord: nd54sKX

You can add the Server Armour bot to your discord by following this link:

Add the ServerArmour discord bot to your discord.

Permissions

/sa.ban - requires permission serverarmour.ban
/sa.unban - requires permission serverarmour.unban
/clanban - requires permission serverarmour.ban

Admin Permissions

serverarmour.website.admin
serverarmour.ban
serverarmour.unban

Whitelist Permissions

serverarmour.whitelist.recentvac
serverarmour.whitelist.badip
serverarmour.whitelist.keyword
serverarmour.whitelist.vacceiling
serverarmour.whitelist.banceiling
serverarmour.whitelist.gamebanceiling
serverarmour.whitelist.hardware.ownsbloody
serverarmour.whitelist.steamprofile
serverarmour.whitelist.twitterban
serverarmour.whitelist.familyshare

Commands

<optional>

/sa.cp username <force:boolean> - This will show you the ServerArmour report for a specific user, when the force true is added, it will skip checking local cache and update it from the server.
/sa.unban "username/id" - unbans a user

/sa.ban "username/id" "reason" - This will ban a player for 1 hour, please keep reason english for now (this helps with sentiment analysis.)
/clanban "username/id" "reason" - This will ban a player for 1 hour, please keep reason english for now (this helps with sentiment analysis.)
/sa.ban "username/id" "reason" 1h - This will ban a player for 1 hour, please keep reason english for now (this helps with sentiment analysis.)
/sa.ban "username/id" "reason" 1d - This will ban a player for 1 day, please keep reason english for now (this helps with sentiment analysis.)
/sa.ban "username/id" "reason" 1m - This will ban a player for 1 month, please keep reason english for now (this helps with sentiment analysis.)
/sa.ban "username/id" "reason" 1y - This will ban a player for 1 year, please keep reason english for now (this helps with sentiment analysis.)

Configuration

Default Configuration

{
  "Auto Kick": {
    "Bans on your network": true, // should SA auto kick bans create on any of your other servers you are admin on?
    "Enabled": true, // Is auto kick enabled?
    "Max allowed previous bans": 3, // max allowed bans on other servers, for a player
    "Steam": {
      "Min age of VAC ban allowed": 90, // Example: a player with a 89day vac should be kicked, 90+ wont.
      "When Steam Level Hidden": false, // Kicks a player that has a hidden steam level, this includes private accounts.
      "Family share accounts": false, // kick family share accounts?
      "Family share accounts that are dirty": false, // kick family share accounts that are considered dirty?
      "Max allowed Game bans": 2, 
      "Max allowed VAC bans": 1,
      "Min Allowed Steam Level (-1 disables)": -1, //
      "Private Steam Profiles": false,
      "Profiles that do no conform to the Steam64 IDs (Highly recommended)": true
    },
    "Users that have been banned on rusthackreport": true,
    "VPN": {
      "Enabled": true, // should vpn or proxy players be kicked?
      "Ignore nVidia Cloud Gaming": true, // should players on the nvidia network be ignored?
    }
  },
  "Better Chat: Tag for dirty users": "", //will prefix player names with this tag that are dirty
  "Broadcast": { // this will broadcast in chat by default
    "Kicks": false, // when a player gets kicked?
    "New bans": true, // when a player gets banned?
    "RCON": false, // should it all the above be broadcasted via RCON as well (usefull for battlemetrics player history)
    "Player Reports": true, //should their player report be broadcasted on connect
    "When VAC is younger than": 120 // goes together with the below
  },
  "Clan Ban": {
    "Ban Native Team Members": true, // this is the normal team members in vanilla rust, by default will ban members in a Clan in Clans or ClansReborn
    "Reason Prefix": "Assoc Ban -> {playerId}: {reason}" // will use this reason prefifx format.
  },
  "Discord": {
    "Webhook URL": "https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks", // webhook for connect reports, and kicks
    "Bans Webhook URL": "https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks", // webhook for bans, else it will default to above
    "Notify when a player has received a game ban": true,
    "Send Ban Report": true,
    "Send Kick Report": true,
    "Send Only Dirty Player Reports": true, //if only reports should be sent to discord when a player is dirty, if false, it will send a report for every player that connects
    "Show Quick Connect On report": true //this will embed a clickable link in the report to the server connect.
  },
  "General": {
    "Debug: Show additional debug console logs": false, // always false, unless you want to debug where an issue occurs for the developer.
    "Ignore Admins": true // this will ignore admins completely.
  },
  "io.serverarmour.com": {
    "Owner Email": "", // owner email, not required, but usefull for important communication (not spam)
    "Owner Real Name": "", // your name, the owner
    "Owner Steam64 ID": "", // the owners steam64id
    "Server Key": "", // THIS WILL AUTO GENERATE ON FIRST CONNECT, NEVER LOSE THIS KEY. NEVER SHARE IT. IT WONT GENERATE AGAIN ON THE SAME IP/PORT
    "Share details with other server owners": true, // For future use, so that other server admins can send you emails for evidence etc, or discuss a ban.
    "Submit Arkan Data": true // if arkan data can be submitted to the cloud server, for analysis. 
  },
  "Server Info": {
    "Game Port": "", // your normal port, that users connect to
    "Query Port": "", // if you havent changed this, the default is the same as gameport.
    "RCON Port": "", // not used now, for future management from io.serverarmour.com
    "Your Server IP": "" // your server IP ONLY, without : ports
  },
  "Show Protected MSG": true // shows that your server is protected by serverarmour, to a player that connects
}

Bad IP:

It refers any combination of crawlers / comment & email spammers / brute force attacks. IPs that are behaving "badly" in an automated manner. Networks that are infected with malware / trojans / botnet / etc are also considered "bad". It may be possible that the user is not aware that their systems are infected or they have received an IP by their ISP that was recently infected with malicious code. If you wish to skip this, see variations of implementation.

**Setting: **

"Auto Kick: VPN and Proxy": true

WIll automatically kick a player if they are either using a proxy, vpn or is a bad IP,

"Auto Kick: VPN and Proxy: Sensitivity": 1.0

Service used:

https://proxycheck.io/

API Hooks

	void OnSARecentVacKick(string steamId, int unixLastVax, int unixRemainingDays) {
	
	}
	void OnSAVPNKick(string steamId, double ipRating) {
	
	}
	void OnSAKeywordKick(string steamId) {
	
	}
	void OnSATooManyVacKick(string steamId, int numberOfVACBans) {
	
	}
	void OnSATooManyGameBansKick(string steamId, int numberOfGameBans) {
	
	}
	void OnSABloodyKick(string steamId) {
	
	}
	void OnSATooManyBans(string steamId) {
	
	}
	void OnSAProfilePrivate(string steamId, int communityvisibilitystate) {
	
	}
	void OnSAProfileLevelLow(string steamId, int minlevelallowed, int userlevel) {
	
	}

Methods

int API_GetServerBanCount(string steamid) // Get the count of servers this use has been banned on
bool API_GetIsVacBanned(string steamid) // Indicates whether or not the player has VAC bans on record.
bool API_GetIsCommunityBanned(string steamid) // Indicates whether or not the player is banned from Steam Community
int API_GetVacBanCount(string steamid) // Number of VAC bans on record.
int API_GetGameBanCount(string steamid) // Number of bans in games, this includes CS:GO Overwatch bans.
string API_GetEconomyBanStatus(string steamid) // The player's ban status in the economy. If the player has no bans on record the string will be "none", if the player is on probation it will say "probation", etc.
bool API_GetIsPlayerDirty(string steamid) // Indicates if the player has any bans at all, includes server, game and vac bans
bool API_GetIsPlayerDirty(string steamid) // Indicates if the game is a family shared game, true indicates the player doesnt own it but lending it. 
string API_GetFamilyShareLenderSteamId(string steamid) // Gets the steamid of the person lending the game. Returns "0" if there isn't a lender and it's not family share.
bool API_GetIsFamilyShareLenderDirty(string steamid) // Checks if the current users family share account is dirty.
int API_GetDaysSinceLastVacBan(string steamid) // Get amount of days since last vac ban. This will retun 0 if there is no vac ban.
bool API_GetIsProfilePrivate(string steamid) // Check if the players profile is private.
int API_GetProfileLevel(string steamid) // Gets the players steam level.

Example

[PluginReference]
Plugin ServerArmour;

private void OnUserConnected(IPlayer player) {
{
    Puts(ServerArmour.Call<bool>("API_GetIsPlayerDirty", player.Id));
}

The above is a universal example using the universal OnUserConnected hook for all Oxide supported games.

More Info

The plugin makes web calls to Server Armours api, which is a collection and aggregated database of multiple databases containing bans of steamid's.

Information sent to the api is as follows:

local server ban information

  • player steamid - only reliable way to track all information related to a player.
  • player username
  • player ip
  • reason - used to display reasons for a ban, and also for Sentiment analysis. (when users need to ban specific people (scripters, hackers, esp, aimbot, etc))
    • date and time

server information

  • server name - to identify your server name
  • server port - server port, not currently used by our services, but will be used in the future for server owners to manage their server from a web based management console.
  • server admin name - By default the admin needs to set this up, this is used to identify how trustworty a ban that is being submitted is. This will also be used for banned users to contact the relevant server admins, this information is NEVER made public or sold. This is only used to make the service fair for all involved and so that there is a dispute process. When not provided, your bans will have the lowest of trust scores.
  • server admin email - By default the admin needs to set this up, this is used to identify how trustworty a ban that is being submitted is. This will also be used for banned users to contact the relevant server admins, this information is NEVER made public or sold. This is only used to make the service fair for all involved and so that there is a dispute process. When not provided, your bans will have the lowest of trust scores.
  • steam game id - the steam game id, to identify what game the server is actually hosting.
  • game name - same as above, but just in readable format.

If more information is needed regarding any of the above, or any concerns, please open a thread so that I can provide more information.

Please consider supporting the project.

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2021 Pho3niX90

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.