docs/conf/opers.conf.example

   1 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
   2 #                                                                     #
   3 #   Classes are a group of commands which are grouped together and    #
   4 #   given a unique name. They're used to define which commands        #
   5 #   are available to certain types of Operators.                      #
   6 #                                                                     #
   7 #                                                                     #
   8 #  Note: It is possible to make a class which covers all available    #
   9 #  commands. To do this, specify commands="*". This is not really     #
  10 #  recommended, as it negates the whole purpose of the class system,  #
  11 #  however it is provided for fast configuration (e.g. in test nets). #
  12 #                                                                     #
  13
  14 <class
  15      name="Shutdown"
  16
  17      # commands: Oper-only commands that opers of this class can run.
  18      commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOADMODULE GLOADMODULE GUNLOADMODULE GRELOADMODULE"
  19
  20      # privs: Special privileges that users with this class may utilise.
  21      #  VIEWING:
  22      #   - channels/auspex: allows opers with this priv to see more detail about channels than normal users.
  23      #   - users/auspex: allows opers with this priv to view more details about users than normal users, e.g. real host and IP.
  24      #   - servers/auspex: allows opers with this priv to see more detail about server information than normal users.
  25      # ACTIONS:
  26      #   - users/mass-message: allows opers with this priv to PRIVMSG and NOTICE to a server mask (e.g. NOTICE $*)
  27      #   - users/samode-usermodes: allows opers with this priv to change the user modes of any other user using /SAMODE
  28      # PERMISSIONS:
  29      #   - users/flood/no-fakelag: prevents opers from being penalized with fake lag for flooding (*NOTE)
  30      #   - users/flood/no-throttle: allows opers with this priv to send commands without being throttled (*NOTE)
  31      #   - users/flood/increased-buffers: allows opers with this priv to send and receive data without worrying about being disconnected for exceeding limits (*NOTE)
  32      #
  33      # *NOTE: These privs are potentially dangerous, as they grant users with them the ability to hammer your server's CPU/RAM as much as they want, essentially.
  34      privs="users/auspex channels/auspex servers/auspex users/mass-message users/flood/no-throttle users/flood/increased-buffers"
  35
  36      # usermodes: Oper-only usermodes that opers with this class can use.
  37      usermodes="*"
  38
  39      # chanmodes: Oper-only channel modes that opers with this class can use.
  40      chanmodes="*">
  41
  42 <class name="SACommands" commands="SAJOIN SAPART SANICK SAQUIT SATOPIC SAKICK SAMODE OJOIN">
  43 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT RSQUIT MKPASSWD ALLTIME SWHOIS JUMPSERVER LOCKSERV UNLOCKSERV" usermodes="*" chanmodes="*" privs="servers/auspex">
  44 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE TLINE RLINE CHECK NICKLOCK NICKUNLOCK SHUN CLONES CBAN CLOSE" usermodes="*" chanmodes="*">
  45 <class name="OperChat" commands="WALLOPS GLOBOPS" usermodes="*" chanmodes="*" privs="users/mass-message">
  46 <class name="HostCloak" commands="SETHOST SETIDENT SETIDLE CHGNAME CHGHOST CHGIDENT" usermodes="*" chanmodes="*" privs="users/auspex">
  47
  48
  49 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
  50 #                                                                     #
  51 #   This is where you specify which types of operators you have on    #
  52 #   your server, as well as the commands they are allowed to use.     #
  53 #   This works alongside with the classes specified above.            #
  54 #                                                                     #
  55
  56 <type
  57     # name: Name of type. Used in actual server operator accounts below.
  58     name="NetAdmin"
  59
  60     # classes: Classes (blocks above) that this type belongs to.
  61     classes="SACommands OperChat BanControl HostCloak Shutdown ServerLink"
  62
  63     # vhost: Host opers of this type get when they log in (oper up). This is optional.
  64     vhost="netadmin.omega.example.org"
  65
  66     # maxchans: Maximum number of channels opers of this type can be in at once.
  67     maxchans="60"
  68
  69     # modes: User modes besides +o that are set on an oper of this type
  70     # when they oper up. Used for snomasks and other things.
  71     # Requires the opermodes module be loaded.
  72     modes="+s +cCqQ">
  73
  74 <type name="GlobalOp" classes="SACommands OperChat BanControl HostCloak ServerLink" vhost="ircop.omega.example.org">
  75 <type name="Helper" classes="HostCloak" vhost="helper.omega.example.org">
  76
  77
  78 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
  79 #                                                                     #
  80 #   Opers are defined here. This is a very important section.         #
  81 #   Remember to only make operators out of trustworthy people.        #
  82 #                                                                     #
  83
  84 # Operator account with a plain-text password.
  85 <oper
  86       # name: Oper login that is used to oper up (/oper name password).
  87       # Remember: This is case sensitive.
  88       name="Attila"
  89
  90       # password: Case-sensitive, unhashed (plaintext).
  91       password="s3cret"
  92
  93       # host: What hostnames and IPs are allowed to use this operator account.
  94       # Multiple options can be separated by spaces and CIDRs are allowed.
  95       # You can use just * or *@* for this section, but it is not recommended
  96       # for security reasons.
  97       host="attila@inspircd.org *@2001:db8::/32"
  98
  99       # ** ADVANCED ** This option is disabled by default.
 100       # fingerprint: When using the sslinfo module, you may specify
 101       # a key fingerprint here. This can be obtained by using the /sslinfo
 102       # command while the module is loaded, and is also noticed on connect.
 103       # This enhances security by verifying that the person opering up has
 104       # a matching SSL client certificate, which is very difficult to
 105       # forge (impossible unless preimage attacks on the hash exist).
 106       # If the sslinfo module isn't loaded, this option will be ignored.
 107       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
 108
 109       # autologin: If an SSL certificate fingerprint for this oper is specified,
 110       # you can have the oper block automatically log in. This moves all security
 111       # of the oper block to the protection of the client certificate, so be sure
 112       # that the private key is well-protected! Requires the sslinfo module.
 113       #autologin="on"
 114
 115       # sslonly: If on, this oper can only oper up if they're using a SSL connection.
 116       # Setting this option adds a decent bit of security. Highly recommended
 117       # if the oper is on wifi, or specifically, unsecured wifi. Note that it
 118       # is redundant to specify this option if you specify a fingerprint.
 119       # This setting only takes effect if the sslinfo module is loaded.
 120       #sslonly="yes"
 121
 122       # vhost: Overrides the vhost in the type block. Class and modes may also
 123       # be overridden.
 124       vhost="attila.example.org"
 125
 126       # type: Which type of operator this person is; see the block
 127       # above for the list of types. NOTE: This is case-sensitive as well.
 128       type="NetAdmin">
 129
 130 # Operator with a plaintext password and no comments, for easy copy & paste.
 131 <oper
 132       name="Brain"
 133       password="youshouldhashthis"
 134       host="brain@dialup15.isp.test.com *@localhost *@example.com *@2001:db8::/32"
 135       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
 136       type="NetAdmin">
 137
 138 # Operator with a hashed password. It is highly recommended to use hashed passwords.
 139 <oper
 140       # name: Oper login that is used to oper up (/oper name password).
 141       # Remember: This is case sensitive.
 142       name="Adam"
 143
 144       # hash: What hash this password is hashed with.
 145       # Requires the module for selected hash (md5, sha256 or ripemd160)
 146       # be loaded and the password hashing module (password_hash) loaded.
 147       # Options here are: "md5", "sha256" and "ripemd160", or one of
 148       # these prefixed with "hmac-", e.g.: "hmac-sha256".
 149       # Create hashed passwords with: /mkpasswd <hash> <password>
 150       hash="hmac-sha256"
 151
 152       # password: A hash of the password (see above option) hashed
 153       # with /mkpasswd <hash> <password>. See the password_hash module
 154       # in modules.conf for more information about password hashing.
 155       password="qQmv3LcF$Qh63wzmtUqWp9OXnLwe7yv1GcBwHpq59k2a0UrY8xe0"
 156
 157       # host: What hostnames and IPs are allowed to use this operator account.
 158       # Multiple options can be separated by spaces and CIDRs are allowed.
 159       # You can use just * or *@* for this section, but it is not recommended
 160       # for security reasons.
 161       host="*@127.0.0.1 *@192.0.2.40 *@198.51.100.4"
 162
 163       # type: Which type of operator this person is; see the block
 164       # above for the list of types. NOTE: This is case-sensitive as well.
 165       type="Helper">