Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-01 05:27:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Allows more configurable extensibility and addresses PR change requests.

Browse source
This commit is contained in:
Johnny 2018-09-04 21:48:03 +00:00
parent 15d263cf3b
commit da60d1ed45
4 changed files with 157 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

21
evennia/contrib/auditing/example.py
View file

@ -1,21 +0,0 @@
from evennia.utils.logger import log_file
import json
def output(data, *args, **kwargs):
"""
Writes dictionaries of data generated by an AuditedServerSession to files
in JSON format, bucketed by date.
Uses Evennia's native logger and writes to the default
log directory (~/yourgame/server/logs/ or settings.LOG_DIR)
Args:
data (dict): Parsed session transmission data.
"""
# Bucket logs by day
bucket = data.pop('objects')['time'].strftime('%Y-%m-%d')
# Write it
log_file(json.dumps(data), filename="auditing_%s.log" % bucket)

58
evennia/contrib/auditing/outputs.py Normal file
View file

@ -0,0 +1,58 @@
"""
Auditable Server Sessions - Example Outputs
Example methods demonstrating output destinations for logs generated by
audited server sessions.
This is designed to be a single source of events for developers to customize
and add any additional enhancements before events are written out-- i.e. if you
want to keep a running list of what IPs a user logs in from on account/character
objects, or if you want to perform geoip or ASN lookups on IPs before committing,
or tag certain events with the results of a reputational lookup, this should be
the easiest place to do it. Write a method and invoke it via
`settings.AUDIT_CALLBACK` to have log data objects passed to it.
Evennia contribution - Johnny 2017
"""
from evennia.utils.logger import log_file
import json
import syslog
def to_file(data):
"""
Writes dictionaries of data generated by an AuditedServerSession to files
in JSON format, bucketed by date.
Uses Evennia's native logger and writes to the default
log directory (~/yourgame/server/logs/ or settings.LOG_DIR)
Args:
data (dict): Parsed session transmission data.
"""
# Bucket logs by day and remove objects before serialization
bucket = data.pop('objects')['time'].strftime('%Y-%m-%d')
# Write it
log_file(json.dumps(data), filename="audit_%s.log" % bucket)
def to_syslog(data):
"""
Writes dictionaries of data generated by an AuditedServerSession to syslog.
Takes advantage of your system's native logger and writes to wherever
you have it configured, which is independent of Evennia.
Linux systems tend to write to /var/log/syslog.
If you're running rsyslog, you can configure it to dump and/or forward logs
to disk and/or an external data warehouse (recommended-- if your server is
compromised or taken down, losing your logs along with it is no help!).
Args:
data (dict): Parsed session transmission data.
"""
# Remove objects before serialization
data.pop('objects')
# Write it out
syslog.syslog(json.dumps(data))

136
evennia/contrib/auditing/server.py
View file

@ -1,7 +1,7 @@
"""
Auditable Server Sessions:
Extension of the stock ServerSession that yields objects representing
all user input and all system output.
user inputs and system outputs.
Evennia contribution - Johnny 2017
"""
@ -19,39 +19,27 @@ from evennia.server.serversession import ServerSession
AUDIT_CALLBACK = getattr(ev_settings, 'AUDIT_CALLBACK', None)
AUDIT_IN = getattr(ev_settings, 'AUDIT_IN', False)
AUDIT_OUT = getattr(ev_settings, 'AUDIT_OUT', False)
AUDIT_MASK_IGNORE = set(['@ccreate', '@create'] + getattr(ev_settings, 'AUDIT_IGNORE', []))
AUDIT_MASK_KEEP_BIGRAM = set(['create', 'connect', '@userpassword'] + getattr(ev_settings, 'AUDIT_MASK_KEEP_BIGRAM', []))
AUDIT_MASKS = [
{'connect': r"^[@\s]*[connect]{5,8}\s+(\".+?\"|[^\s]+)\s+(?P<secret>.+)"},
{'connect': r"^[@\s]*[connect]{5,8}\s+(?P<secret>[\w\\]+)"},
{'create': r"^[^@]?[create]{5,7}\s+(\w+|\".+?\")\s+(?P<secret>[\w\\]+)"},
{'create': r"^[^@]?[create]{5,7}\s+(?P<secret>[\w\\]+)"},
{'userpassword': r"^[@\s]*[userpassword]{11,14}\s+(\w+|\".+?\")\s+=*\s*(?P<secret>[\w\\]+)"},
{'password': r"^[@\s]*[password]{6,9}\s+(?P<secret>.*)"},
] + getattr(ev_settings, 'AUDIT_MASKS', [])
if AUDIT_CALLBACK:
try:
AUDIT_CALLBACK = mod_import(AUDIT_CALLBACK).output
AUDIT_CALLBACK = getattr(mod_import('.'.join(AUDIT_CALLBACK.split('.')[:-1])), AUDIT_CALLBACK.split('.')[-1])
logger.log_info("Auditing module online.")
logger.log_info("Recording user input = %s." % AUDIT_IN)
logger.log_info("Recording server output = %s." % AUDIT_OUT)
logger.log_info("Recording user input: %s" % AUDIT_IN)
logger.log_info("Recording server output: %s" % AUDIT_OUT)
logger.log_info("Log destination: %s" % AUDIT_CALLBACK)
except Exception as e:
logger.log_err("Failed to activate Auditing module. %s" % e)
class AuditedServerSession(ServerSession):
"""
This class represents a player's session and is a template for
both portal- and server-side sessions.
Each connection will see two session instances created:
1. A Portal session. This is customized for the respective connection
protocols that Evennia supports, like Telnet, SSH etc. The Portal
session must call init_session() as part of its initialization. The
respective hook methods should be connected to the methods unique
for the respective protocol so that there is a unified interface
to Evennia.
2. A Server session. This is the same for all connected accounts,
regardless of how they connect.
The Portal and Server have their own respective sessionhandlers. These
are synced whenever new connections happen or the Server restarts etc,
which means much of the same information must be stored in both places
e.g. the portal can re-sync with the server when the server reboots.
This particular implementation parses all server inputs and/or outputs and
passes a dict containing the parsed metadata to a callback method of your
creation. This is useful for recording player activity where necessary for
@ -75,7 +63,7 @@ class AuditedServerSession(ServerSession):
# called 'output()' you've written that accepts a dict object as its sole
# argument. From that function you can store/forward the message received
# as you please. An example file-logger is below:
AUDIT_CALLBACK = 'evennia.contrib.auditing.examples'
AUDIT_CALLBACK = 'evennia.contrib.auditing.outputs.to_file'
# Log all user input? Be ethical about this; it will log all private and
# public communications between players and/or admins.
@ -86,12 +74,17 @@ class AuditedServerSession(ServerSession):
# will be very voluminous!
AUDIT_OUT = True/False
# What commands do you NOT want masked for sensitivity?
AUDIT_MASK_IGNORE = ['@ccreate', '@create']
# Any custom regexes to detect and mask sensitive information, to be used
# to detect and mask any sensitive custom commands you may develop.
# Takes the form of a list of dictionaries, one k:v pair per dictionary
# where the key name is the canonical name of a command and gets displayed
# at the tail end of the message so you can tell which regex masked it.
# The sensitive data itself must be captured in a named group with a
# label of 'secret'.
AUDIT_MASKS = [
{'authentication': r"^@auth\s+(?P<secret>[\w]+)"},
]
# What commands do you want to keep the first two terms of, masking the rest?
# This only triggers if there are more than two terms in the message.
AUDIT_MASK_KEEP_BIGRAM = ['create', 'connect', '@userpassword']
"""
def audit(self, **kwargs):
"""
@ -100,8 +93,8 @@ class AuditedServerSession(ServerSession):
Kwargs:
src (str): Source of data; 'client' or 'server'. Indicates direction.
text (list): Message sent from client to server.
text (str): Message from server back to client.
text (str or list): Client sends messages to server in the form of
lists. Server sends messages to client as string.
Returns:
log (dict): Dictionary object containing parsed system and user data
@ -115,7 +108,7 @@ class AuditedServerSession(ServerSession):
# Sanitize user input
session = self
src = kwargs.pop('src', '?')
bytes = 0
bytecount = 0
if src == 'client':
try:
@ -125,19 +118,9 @@ class AuditedServerSession(ServerSession):
return False
elif src == 'server':
# Server outputs can be unpredictable-- sometimes tuples, sometimes
# plain strings. Try to parse both.
try:
if isinstance(kwargs.get('text', ''), (tuple,list)):
data = kwargs['text'][0]
elif not 'text' in kwargs and len(kwargs.keys()) == 1:
data = kwargs.keys()[0]
else:
data = str(kwargs['text'])
except: data = str(kwargs)
data = str(kwargs)
bytes = len(data.encode('utf-8'))
bytecount = len(data.encode('utf-8'))
data = data.strip()
@ -167,7 +150,7 @@ class AuditedServerSession(ServerSession):
room_token = '%s%s' % (room.key, room.dbref)
# Mask any PII in message, where possible
data = self.mask(data, **kwargs)
data = self.mask(data)
# Compile the IP, Account, Character, Room, and the message.
log = {
@ -184,7 +167,7 @@ class AuditedServerSession(ServerSession):
'character': char_token,
'room': room_token,
'msg': '%s' % data,
'bytes': bytes,
'bytes': bytecount,
'objects': {
'time': time_obj,
'session': self,
@ -196,7 +179,7 @@ class AuditedServerSession(ServerSession):
return log
def mask(self, msg, **kwargs):
def mask(self, msg):
"""
Masks potentially sensitive user information within messages before
writing to log. Recording cleartext password attempts is bad policy.
@ -208,27 +191,38 @@ class AuditedServerSession(ServerSession):
msg (str): Text string with sensitive information masked out.
"""
# Get command based on fuzzy match
command = next((x for x in re.findall('^(?:Command\s\')*[\s]*([create]{5,6}|[connect]{6,7}|[@userpassword]{6,13}).*', msg, flags=re.IGNORECASE)), None)
if not command or command in AUDIT_MASK_IGNORE:
return msg
# Break msg into terms
terms = [x.strip() for x in re.split('[\s\=]+', msg) if x]
num_terms = len(terms)
# Check to see if the command is embedded within server output
_msg = msg
is_embedded = False
match = re.match(".*Command.*'(.+)'.*is not available.*", msg, flags=re.IGNORECASE)
if match:
msg = match.group(1).replace('\\', '')
submsg = msg
is_embedded = True
# If the first term was typed correctly, grab the appropriate number
# of subsequent terms and mask the remainder
if command in AUDIT_MASK_KEEP_BIGRAM and num_terms >= 3:
terms = terms[:2] + ['*' * sum([len(x.zfill(8)) for x in terms[2:]])]
else:
# If the first term was not typed correctly, doesn't have the right
# number of terms or is clearly password-related,
# only grab the first term (minimizes chances of capturing passwords
# conjoined with username i.e. 'conect johnnypassword1234!').
terms = [terms[0]] + ['*' * sum([len(x.zfill(8)) for x in terms[1:]])]
msg = ' '.join(terms)
for mask in AUDIT_MASKS:
for command, regex in mask.iteritems():
try:
match = re.match(regex, msg, flags=re.IGNORECASE)
except Exception as e:
logger.log_err(modified_regex)
logger.log_err(e)
continue
if match:
term = match.group('secret')
try:
masked = re.sub(term, '*' * len(term.zfill(8)), msg)
except Exception as e:
print(msg, regex, term)
quit()
if is_embedded:
msg = re.sub(submsg, masked, _msg, flags=re.IGNORECASE)
else: msg = masked
return '%s <Masked: %s>' % (msg, command)
return msg
def data_out(self, **kwargs):
@ -242,7 +236,7 @@ class AuditedServerSession(ServerSession):
if AUDIT_CALLBACK and AUDIT_OUT:
try:
log = self.audit(src='server', **kwargs)
if log: AUDIT_CALLBACK(log, **kwargs)
if log: AUDIT_CALLBACK(log)
except Exception as e:
logger.log_err(e)
@ -259,7 +253,7 @@ class AuditedServerSession(ServerSession):
if AUDIT_CALLBACK and AUDIT_IN:
try:
log = self.audit(src='client', **kwargs)
if log: AUDIT_CALLBACK(log, **kwargs)
if log: AUDIT_CALLBACK(log)
except Exception as e:
logger.log_err(e)

42
evennia/contrib/auditing/tests.py
View file

@ -5,9 +5,10 @@ Module containing the test cases for the Audit system.
from django.conf import settings
from evennia.contrib.auditing.server import AuditedServerSession
from evennia.utils.test_resources import EvenniaTest
import re
# Configure session auditing settings
settings.AUDIT_CALLBACK = "evennia.contrib.auditing.examples"
settings.AUDIT_CALLBACK = "evennia.contrib.auditing.outputs.to_syslog"
settings.AUDIT_IN = True
settings.AUDIT_OUT = True
@ -22,11 +23,19 @@ class AuditingTest(EvenniaTest):
information from strings.
"""
safe_cmds = (
'say hello to my little friend',
'/say hello to my little friend',
'@ccreate channel = for channeling',
'@create/drop some stuff',
'@create rock',
'@create a pretty shirt : evennia.contrib.clothing.Clothing',
'@charcreate johnnyefhiwuhefwhef',
'Command "@logout" is not available. Maybe you meant "@color" or "@cboot"?',
'/me says, "what is the password?"',
'say the password is plugh',
# Unfortunately given the syntax, there is no way to discern the
# latter of these as sensitive
'@create pretty sunset'
'@create johnny password123',
)
for cmd in safe_cmds:
@ -34,15 +43,32 @@ class AuditingTest(EvenniaTest):
unsafe_cmds = (
('connect johnny password123', 'connect johnny ***********'),
('concnct johnny password123', 'concnct *******************'),
('concnct johnny password123', 'concnct johnny ***********'),
('concnct johnnypassword123', 'concnct *****************'),
('connect "johnny five" "password 123"', 'connect "johnny five" **************'),
('connect johnny "password 123"', 'connect johnny **************'),
('create johnny password123', 'create johnny ***********'),
('@userpassword johnny = password234', '@userpassword johnny ***********'),
('@password password1234 = password2345', '@password ***************************'),
('@password password1234 password2345', '@password *************************'),
('@passwd password1234 = password2345', '@passwd ***************************'),
('@userpassword johnny = password234', '@userpassword johnny = ***********'),
('craete johnnypassword123', 'craete *****************'),
("Command 'conncect teddy teddy' is not available. Maybe you meant \"@encode\"?", 'Command *************************************************************************************')
("Command 'conncect teddy teddy' is not available. Maybe you meant \"@encode\"?", 'Command \'conncect ***** *****\' is not available. Maybe you meant "@encode"?'),
("{'text': u'Command \\'conncect jsis dfiidf\\' is not available. Type \"help\" for help.'}", "{'text': u'Command \\'conncect jsis ******\\' is not available. Type \"help\" for help.'}")
)
for unsafe, safe in unsafe_cmds:
self.assertEqual(self.session.mask(unsafe), safe)
for index, (unsafe, safe) in enumerate(unsafe_cmds):
self.assertEqual(re.sub('<Masked: .+>', '', self.session.mask(unsafe)).strip(), safe)
# Make sure scrubbing is not being abused to evade monitoring
secrets = [
'say password password password; ive got a secret that i cant explain',
'whisper johnny = password let\'s lynch the landlord',
'say connect johnny password1234 secret life of arabia',
"@password;eval(\"__import__('os').system('clear')\", {'__builtins__':{}})"
]
for secret in secrets:
self.assertEqual(self.session.mask(secret), secret)
def test_audit(self):
"""
@ -60,5 +86,5 @@ class AuditingTest(EvenniaTest):
# Make sure auditor is breaking down responses without actual text
log = self.session.audit(**{'logged_in': {}, 'src': 'server'})
self.assertEqual(log['msg'], 'logged_in')
self.assertEqual(log['msg'], "{'logged_in': {}}")