Skip to main content

BigBrother

Project description

PyPI - Version PyPI - Downloads PyPI - Format python versions django versions license

[!CAUTION] Because this repository is public, anyone can read the detection logic for skills, cyno activity, injected SP, suspicious transactions, hostile assets and clones, and other monitored behaviors. Hostile groups may use this information to avoid detection. Operate with discretion.

BigBrother

BigBrother is an Alliance Auth plugin, originally written by Andrew Xadi, that performs continuous pilot auditing, compliance monitoring, intelligence gathering, and behavioral analysis. It monitors activity such as skills, cyno capabilities, SP injections, corporation movement, assets, clones, and more, then delivers structured leadership-focused reports.

All while invisible to the general membership unless you choose to expose it to them. No "adding chars" to it, it pulls relevant information from CorpTools.

Index

Core Requirements

The following AllianceAuth plugins are required:

allianceauth >= 4.3.1
allianceauth-corptools >= 2.12.0
django-esi >= 8.2.0
django-eveuniverse >= 1.5.9

Recommended plugins

allianceauth-discordbot >= 4.1.0   # Required for Discord notifications and ticket system
aa-charlink >= 1.11.1              # Required for corp compliance filter checks

Optional plugins

allianceauth-afat >= 4.1.1         # Required for PAP/Fleet participation compliance
allianceauth-blacklist >= 0.1.1    # Add / check for blacklisted characters
aa-contacts >= 0.10.2              # Automatic hostile/friendly contact syncing

Install Instructions

After making sure to add the above prerequisite applications.

source /home/allianceserver/venv/auth/bin/activate && cd /home/allianceserver/myauth/
pip install aa-bb==3.2.6
vi myauth/settings/local.py

Add aa_bb to your INSTALLED_APPS. Ensure that the prerequisite applications listed above are also present in INSTALLED_APPS.

python manage.py migrate && python manage.py collectstatic --noinput

restart the things exit your venv

sudo supervisorctl restart myauth:

[!IMPORTANT] It is recommended to use a threaded worker setup with memmon for this application. Also note that threaded workers are provided by default with allianceauth, this serves as a reminder that these values can be adjusted to suit your needs. The following is an example

In your supervisor.conf

[program:worker]
command=/home/allianceserver/venv/auth/bin/celery -A myauth worker -P threads -c 10 -l INFO -n %(program_name)s_%(process_num)02d
directory=/home/allianceserver/myauth
user=allianceserver
numprocs=2
process_name=%(program_name)s_%(process_num)02d
stdout_logfile=/home/allianceserver/myauth/log/worker.log
stderr_logfile=/home/allianceserver/myauth/log/worker.log
autostart=true
autorestart=true
startsecs=10
stopwaitsecs = 600
killasgroup=true
priority=998

[eventlistener:memmon]
command=/home/allianceserver/venv/auth/bin/memmon -p worker_00=512MB -p worker_01=512MB -p gunicorn=512MB
directory=/home/allianceserver/myauth
events=TICK_60
stdout_logfile=/home/allianceserver/myauth/log/memmon.log
stderr_logfile=/home/allianceserver/myauth/log/memmon.log

It is also recommended to disable gunicorn timeout, an example can be seen here:

[program:gunicorn]
user = allianceserver
directory=/home/allianceserver/myauth
command=/home/allianceserver/venv/auth/bin/gunicorn myauth.wsgi --workers=3 --timeout 0
stdout_logfile=/home/allianceserver/myauth/log/gunicorn.log
stderr_logfile=/home/allianceserver/myauth/log/gunicorn.log
autostart=true
autorestart=true
stopsignal=INT

then reload supervisor and restart auth

sudo supervisorctl reload
sudo supervisorctl restart myauth:

[!IMPORTANT] Failure to follow the next steps before running the initial tasks can cause an undesired result

In your AA Admin navigate to AA_BB

  • Navigate to Big Brother Config
    • Under Core Activation
      • Make sure Warmer Is Active is enabled
        • Disabling this may decrease server load, however, if you do not disable the gunicorn timeout, the Dashboards may never load.
      • Enable any features you plan to use
        • PAPs/AFAT
        • LOA
        • Daily Messages (messages that repeat every 24 hours)
        • Recurring Stats
        • Optional Messages 1-5
        • Set the number of days for an LOA
    • Under Notifications
      • Select if you would like to opt out of any notifications sent to the main Discord Webhook for user changes
      • By default, the app will not send a notification when a new user adds their audit; however, this can be enabled.
        • When enabled, it will treat non-existent data as old data and send a notification to discord on all the user's stats (assuming you have those stats notifications enabled), treating them as if they are changes.
    • Under Ping / Messaging Rules
      • Enter in your desired role ID that you wish to be pinged and select the conditions under which those roles will be pinged.
      • Select any @here conditions
      • Select any @everyone conditions
    • Under Webhooks
    • Don't forget you can send it to a thread by using https://discordapp.com/api/webhooks/<url>/<url>?thread_id=<threadid>
      The thread must be in the same channel that the webhook is configured to.

      • The main "Webhook" This is used to send notifications of user and corp changes to Discord
      • LOA Webhook
      • Daily Webhook
      • Recurring Stats
      • Optional Message Webhooks 1-5
    • Under Schedules
      • Configure specific schedules for daily messages, optional messages, and recurring stats.
    • Under User State and Membership
    • [!WARNING]

    • Failure to configure this will result in AA_BB not working

      • Configure what states you consider "members" you will receive updates on these in discord
      • Configure what states you consider "guest" these will be preloaded into cache, but not notified in discord.
      • Configure what corporations you consider to be members, these are friendly entities.
        • You do not need to configure a corporation if your corporation is inside an alliance that is set as member
      • Configure what alliances you consider to be members.
      • Configure ignore corporations, such as alt corps, that will be ignored when checks are run
    • Under Hostile / Whitelist Rules
      • Configure Alliances you consider hostile
        • Coming Soon(tm) the ability to consider anyone who isn't a member /ignored as hostile
      • Configure Corporations you consider hostile
      • Configure Whitelisted Alliance and Corporations, these act the same as ignored and are... ignored
      • Configure if you consider all null sec, minus what you ignore/whitelist/member, as hostile.
      • Configure if all player structures are hostile, minus what you ignore/whitelist/member.
      • Configure if all npc stations are hostile, minus what you ignore/whitelist/member.
      • Configure Excluded systems and stations, these will be ignored and can be considered the same as "member" "ignored" or "whitelisted"

Once you are satisfied with the configuration, you may explore the other configurations available, such as ticket tool configuration, recurring stats, and daily and optional messages.

Okay, but now you want it to actually do the things, go to Periodic Tasks and Run BB run regular updates

Once the task has run for the first time, it will post in the discord webhook when it has completed (about an hour) and will inform you to go back and enable the tasks, you must enable BB run regular updates but the other tasks are based on your needs.

Features

Dashboard

Screenshot of Dashboard Screenshot of Dashboard2

The BigBrother dashboard provides a unified view of any pilot in your organization.

Selecting a user displays a set of analytical cards that summarize compliance, risk factors, and suspicious activity signals.

Tracked metrics include:

  • Blacklist Status

    • Whether the pilot or any linked character appears on the blacklist, and you can add the user to blacklist. Screenshot of Add BL Screenshot of Check BL
  • Audit Completion

    • Whether all characters and corporations associated with the user have been fully audited. Screenshot of Audit
  • Corporation Stability

    • Detection of short or erratic corporation history (“corp hopping”) that may indicate instability or intent to evade tracking. Screenshot of Corp History
  • AWOX Activity

    • Identification of kills against friendly entities that may indicate internal security risks. Screenshot of AWOX
  • Account State

    • Whether individual characters are Omega or Alpha, useful for evaluating cyno capability, skill progression, and account investment. Screenshot of Account State
  • Hostile Jump Clone Placement

    • Detection of jump clones located in regions or structures considered hostile. Screenshot of Clones
  • Hostile Asset Placement

    • Identification of assets located in hostile regions, including breakdown by character and location. Screenshot of Assets
  • Hostile Contacts

    • Checks for contacts marked as hostile, which may indicate ties to enemy groups. Screenshot of Contacts
  • Hostile Contracts

    • Detection of contracts sent to or received from hostile entities, helping highlight supply-chain leaks or suspicious ISK movement. Screenshot of Contracts
  • Suspicious Mails

    • Detection of in-game mail to or from entities that are considered hostile. Screenshot of Mails
  • Suspicious Transactions

    • Checks for transactions, such as player donations and trades, that may be related to hostile entity activity. Screenshot of Transactions
  • Cyno Check

    • Provides a breakdown of what each character belonging to the user is capable of when it comes to cynos.
    • This includes owning and being able to fly potentially interesting ships Screenshot of Cyno

  • Skill Check A breakdown of potentially interesting skills Screenshot of Skills

Corp Dashboard

[!WARNING] Corp Dashboard has not yet received much love

  • Suspicious Transactions

    • Checks for transactions, such as corporation donations, that may be related to hostile entity activity.
  • Hostile Contracts

    • Detection of contracts sent to or received from hostile entities, helping highlight supply-chain leaks or suspicious ISK movement.
  • Hostile Asset Placement

    • Identification of assets located in hostile regions or structures.

Discord Notifications

All outbound Discord notifications are serialized through a dedicated task to ensure messages never overlap and always arrive in chronological order.

  • Get instant notifications about any corp or user changes that have been listed above under their respective categories, each part of a user's discord notification is adjustable in the settings. Screenshot of Asset Discord Notification

Screenshot of Skills Discord Notification

Screenshot of Hostile Asset Discord Notification

Screenshot of Account Status Discord Notification

Screenshot of Hostile Clone Discord Notification

Ticket System

BigBrother can automatically generate tickets to notify leadership when pilots violate compliance or operational rules.

  • Triggers include:
    • Charlink Compliance Filters
      • Detects when users have not added required applications or connections via aa-charlink.
    • PAP Compliance
      • Flags users who fall below configured PAP or activity thresholds.
    • Character Removal From Auth
      • Creates a ticket when a user removes a character from AllianceAuth, potentially hiding assets or behavior.
    • AWOX Activity
      • Generates a ticket when a pilot AWOXs a friendly character.
    • Missing Corporation Audit (Director Role)
      • Detects directors who have not enabled or completed corporation audits.
    • AFK Detection
      • Flags users who go AFK without registering an LOA in Auth.
    • Missing Discord Link
      • Generates a ticket when a user has not connected their Discord account to Auth.

Non Specific Ticket Configuration

  • Ping Targets
    • Choose which roles to notify when a ticket is created.
  • Ticket Category
    • Tickets are created as new channels inside a category, deleting the channel will close the ticket
  • Exemptions
    • Users can be marked as exempt from specific checks to avoid ticket spam where it is unnecessary.

Automated Discord Messages

  • Configure an unlimited number of messages to be sent to up to five different discord webhooks, each with their own individual schedules.

Recurring stats

  • Send stats to a webhook that covers interesting statistics from AA

Screenshot of recurring stats

aa-contacts Integration

BigBrother integrates directly with aa-contacts to provide continuous hostile contact monitoring.

What it does

  • Periodically syncs contact data from aa-contacts
    • Contacts below 0 status are added to hostile
      • Both Corp and Alliances
    • Contacts above 0 are added to members
      • Both Corp and Alliances
    • Contacts at 0 (neutral)
      • You are presented with 3 choices
        • Ignore, do nothing.
        • Add them to ignore list.
        • Add them to hostile list.

What it does NOT do

  • It does not delete or create contacts in game
  • It does not overwrite manually-added BigBrother contacts

Permissions

Below is the full list of permissions exposed by the application:

Permission Description
basic_access Can access Big Brother
full_access Can view all main characters in Big Brother
recruiter_access Can view main characters in Guest state only in Big Brother
basic_access_cb Can access Corp Brother
full_access_cb Can view all corps in Corp Brother
recruiter_access_cb Can view guest’s corps only in Corp Brother (Guest State Configurable)
can_blacklist_characters Can add characters to blacklist
can_access_loa Can access and submit a Leave Of Absence request
can_view_all_loa Can view all Leave Of Absence requests
can_manage_loa Can manage Leave Of Absence requests
can_access_paps Can access PAP Stats
can_generate_paps Can generate PAP Stats

[!IMPORTANT] Users who used this tool while it was private can safely upgrade but may run into a rare but serious complication where duplicate tasks are generated preventing the auth from starting.

To correct the above, see instructions here

Fix Duplicated Tasks error

Find the duplicate

SELECT
  minute,
  hour,
  day_of_week,
  day_of_month,
  month_of_year,
  timezone,
  COUNT(*) AS cnt
FROM django_celery_beat_crontabschedule
GROUP BY
  minute,
  hour,
  day_of_week,
  day_of_month,
  month_of_year,
  timezone
HAVING COUNT(*) > 1;

Get the ID, replace the cron with the duplicate values

SELECT
  id,
  minute,
  hour,
  day_of_week,
  day_of_month,
  month_of_year,
  timezone
FROM django_celery_beat_crontabschedule
WHERE
  minute = '0'
  AND hour = '12'
  AND day_of_week = '0'
  AND day_of_month = '*'
  AND month_of_year = '*'
  AND timezone = 'UTC';

Find out if any tasks are using the schedules, replace the numbers with the proper IDs

SELECT id, name, crontab_id
FROM django_celery_beat_periodictask
WHERE crontab_id IN (5, 12);

If some tasks are using both, reassign one of them

UPDATE django_celery_beat_periodictask
SET crontab_id = 5
WHERE crontab_id = 12;

Finally delete the duplicate

DELETE FROM django_celery_beat_crontabschedule
WHERE id IN (12);

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_bb-3.2.7b1.tar.gz (232.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_bb-3.2.7b1-py3-none-any.whl (337.3 kB view details)

Uploaded Python 3

File details

Details for the file aa_bb-3.2.7b1.tar.gz.

File metadata

  • Download URL: aa_bb-3.2.7b1.tar.gz
  • Upload date:
  • Size: 232.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for aa_bb-3.2.7b1.tar.gz
Algorithm Hash digest
SHA256 3e311b6e0e92bf48d10d9a239742f2b2b5c3ad79d6062d88c024b4f912defc5c
MD5 55d879688d82ae8061a7ac01f1bab75f
BLAKE2b-256 d514629805b47c9d3c185539c048d94b8422526d6553a517b8986d33528d5f40

See more details on using hashes here.

File details

Details for the file aa_bb-3.2.7b1-py3-none-any.whl.

File metadata

  • Download URL: aa_bb-3.2.7b1-py3-none-any.whl
  • Upload date:
  • Size: 337.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for aa_bb-3.2.7b1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0ae4e7a4f33ee3cb415fa8bf69add05a153c5b1377ddbe383edba9e43da0585
MD5 df5669ab877476de880ed29411d96dee
BLAKE2b-256 f1c05d68e2a22ca949736a8be02bafac13752298d757b198e7966880ea4e85da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page