docs/DEFCON

   1 X3 DefCon
   2 ------------
   3
   4 1) Introduction
   5 2) Installation
   6 3) Configuration
   7 4) Usage
   8 5) Usage Example
   9
  10 1) Introduction
  11
  12     X3 supports a unique protection mechanism based on the military "Defense
  13     Readiness Condition" (DefCon) system. It is based on 5 levels of defense
  14     readiness defined as:
  15
  16     DEFCON5 Normal peacetime readiness
  17     DEFCON4 Increased intelligence and security readiness
  18     DEFCON3 Increase in force readiness
  19     DEFCON2 Further increase in force readiness
  20     DEFCON1 Maximum force readiness.
  21
  22     These are configurable levels that mandates what actions X3 should
  23     take in case of emergency and change in readiness status.
  24
  25     It is used to prevent abuse to both Services, and the ircd on which they
  26     are running. Also to protect the users, primarily in the event of Clones
  27     and/or FloodBOT attacks.
  28
  29 2) Installation
  30
  31     The DefCon system is part of O3,
  32
  33     The DefCon system has to be configured on your x3.conf file to
  34     be enabled.
  35
  36     Make sure you restart X3 after changing the DefCon configuration
  37     directives.
  38
  39 3) Configuration
  40
  41     Pre-defined DefCon actions:
  42
  43     No new channel registrations                       1
  44     No New Nick Registrations                          2
  45     No channel Mode changes                            4
  46     Force Chan Mode                                    8
  47     Use Reduced Session Limit                         16
  48     KILL any new clients trying to connect            32
  49     Services will ignore everyone but opers           64
  50     Services will silently ignore everyone but opers 128
  51     GLINE all new clients trying to connect          256
  52     No new memos sent to block MemoServ attacks      512
  53     SHUN all new clients trying to connect          1024
  54
  55     These are the values used to determine each defcon setting, are set via:
  56
  57     "DefCon1 "XX";
  58     "DefCon2 "XX";
  59     "DefCon3 "XX";
  60     "DefCon4 "XX";
  61
  62     To set the desired value, you simply add the value of the numbers together
  63     and place that as your DefCon# setting. For instance:
  64
  65     Say you wish to set:
  66
  67     No Channel Registrations, No Nickname Registrations and Services Ignoring
  68     everyone except for Operators. You would do this by:
  69
  70     1 + 2 + 128 (Each value listed above is added together)
  71     Giving: 131
  72
  73     You would then place this as which ever Defcon setting you want:
  74
  75     "DefCon1" "131";
  76
  77     The recommended default values are safe to use on any network.
  78
  79 4) Usage
  80
  81     X3 starts up in DEFCON5 (normal readiness) by default, this is configurable.
  82     To change the Defcon level in action use:
  83
  84     /msg O3 DEFCON 1|2|3|4|5
  85
  86 5) Usage Example
  87
  88     Place the network on DEFCON3:
  89
  90     /msg O3 DEFCON 3
  91
  92     <O3> DefCon is at level 3 and enforcing:
  93     <O3> No Channel Registrations
  94     <O3> No Nickname/Account Registrations
  95     <O3> No ChanServ SET MODE Changes
  96     <O3> Forcing Channel Mode(s): +r
  97     <O3> Forcing Reduced Session: 2
  98     <O3> Allowing Services Communication With Opers Only AND Silently Ignoring Regular Users
  99     <Global> Network DefCon level has changed to level 3
 100     <Global> SiRVulcaN is changing the DefCon level to 3
 101
 102     Note that the last message is sent to Opers only.
 103
 104     Restore normal readiness:
 105
 106     /msg O3 DEFCON 5
 107
 108     <O3> DefCon is at level 5 and allowing everything
 109     <Global> Network DefCon level has changed to level 5
 110     <Global> SiRVulcaN is changing the DefCon level to 5
 111
 112     Note that the last message is sent to Opers only.
 113
 114     Listing The Currently Set DefCon Settings:
 115
 116     /msg O3 DEFCON
 117
 118     <O3> DefCon is at level 3 and enforcing:
 119     <O3> No Channel Registrations
 120     <O3> No Nickname/Account Registrations
 121     <O3> No ChanServ SET MODE Changes
 122     <O3> Forcing Channel Mode(s): +r
 123     <O3> Forcing Reduced Session: 2
 124     <O3> Allowing Services Communication With Opers Only AND Silently Ignoring Regular Users
 125