Move audit contrib into security subfolder

evennia/contrib/README.md

@@ -51,6 +51,7 @@ things you want from here into your game folder and change them there.
   speaking unfamiliar languages. Also obfuscates whispers.
 * RPSystem (Griatch 2015) - Full director-style emoting system
   replacing names with sdescs/recogs. Supports wearing masks.
+* Security/Auditing (Johhny 2018) - Log server input/output for debug/security.
 * Simple Door - Example of an exit that can be opened and closed.
 * Slow exit (Griatch 2014) - Custom Exit class that takes different
   time to pass depending on if you are walking/running etc.

evennia/contrib/security/README.md

@@ -0,0 +1,5 @@
+# Security
+
+This directory contains security-related contribs
+
+- Auditing (Johnny 2018) - Allow for optional security logging of user input/output.

evennia/contrib/security/auditing/README.md

@@ -33,14 +33,14 @@ Installation/Configuration:
 Deployment is completed by configuring a few settings in server.conf. This line
 is required:
 
-    SERVER_SESSION_CLASS = 'evennia.contrib.auditing.server.AuditedServerSession'
+    SERVER_SESSION_CLASS = 'evennia.contrib.security.auditing.server.AuditedServerSession'
 
 This tells Evennia to use this ServerSession instead of its own. Below are the
 other possible options along with the default value that will be used if unset.
 
     # Where to send logs? Define the path to a module containing your callback
     # function. It should take a single dict argument as input
-    AUDIT_CALLBACK = 'evennia.contrib.auditing.outputs.to_file'
+    AUDIT_CALLBACK = 'evennia.contrib.security.auditing.outputs.to_file'
 
     # Log user input? Be ethical about this; it will log all private and
     # public communications between players and/or admins (default: False).

evennia/contrib/security/auditing/server.py

@@ -16,7 +16,7 @@ from evennia.server.serversession import ServerSession
 
 # Attributes governing auditing of commands and where to send log objects
 AUDIT_CALLBACK = getattr(ev_settings, 'AUDIT_CALLBACK',
-                         'evennia.contrib.auditing.outputs.to_file')
+                         'evennia.contrib.security.auditing.outputs.to_file')
 AUDIT_IN = getattr(ev_settings, 'AUDIT_IN', False)
 AUDIT_OUT = getattr(ev_settings, 'AUDIT_OUT', False)
 AUDIT_ALLOW_SPARSE = getattr(ev_settings, 'AUDIT_ALLOW_SPARSE', False)

evennia/contrib/security/auditing/tests.py

@@ -7,13 +7,13 @@ from evennia.utils.test_resources import EvenniaTest
 import re
 
 # Configure session auditing settings
-settings.AUDIT_CALLBACK = "evennia.contrib.auditing.outputs.to_syslog"
+settings.AUDIT_CALLBACK = "evennia.security.contrib.auditing.outputs.to_syslog"
 settings.AUDIT_IN = True
 settings.AUDIT_OUT = True
 settings.AUDIT_ALLOW_SPARSE = True
 
 # Configure settings to use custom session
-settings.SERVER_SESSION_CLASS = "evennia.contrib.auditing.server.AuditedServerSession"
+settings.SERVER_SESSION_CLASS = "evennia.contrib.security.auditing.server.AuditedServerSession"
 
 
 class AuditingTest(EvenniaTest):