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 details 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      #   - users/channel-spy: allows opers with this priv to view the private/secret channels that a user is on.
  25      #   - servers/auspex: allows opers with this priv to see more details about server information than normal users.
  26      #  ACTIONS:
  27      #   - users/mass-message: allows opers with this priv to PRIVMSG and NOTICE to a server mask (e.g. NOTICE $*).
  28      #   - users/samode-usermodes: allows opers with this priv to change the user modes of any other user using /SAMODE.
  29      #  PERMISSIONS:
  30      #   - channels/ignore-noctcp: allows opers with this priv to send a CTCP to a +C channel.
  31      #   - channels/ignore-nonicks: allows opers with this priv to change their nick when on a +N channel.
  32      #   - channels/restricted-create: allows opers with this priv to create channels if the restrictchans module is loaded.
  33      #   - users/flood/no-fakelag: prevents opers from being penalized with fake lag for flooding (*NOTE).
  34      #   - users/flood/no-throttle: allows opers with this priv to send commands without being throttled (*NOTE).
  35      #   - users/flood/increased-buffers: allows opers with this priv to send and receive data without worrying about being disconnected for exceeding limits (*NOTE).
  36      #   - users/callerid-override: allows opers with this priv to message people using callerid without being on their callerid list.
  37      #   - users/ignore-commonchans: allows opers with this priv to send a message to a +c user without sharing common channels.
  38      #   - users/ignore-noctcp: allows opers with this priv to send a CTCP to a +T user.
  39      #   - users/sajoin-others: allows opers with this priv to /SAJOIN users other than themselves.
  40      #   - servers/use-disabled-commands: allows opers with this priv to use disabled commands.
  41      #   - servers/use-disabled-modes: allows opers with this priv to use disabled modes.
  42      #
  43      # *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.
  44      privs="users/auspex channels/auspex servers/auspex users/mass-message users/flood/no-throttle users/flood/increased-buffers"
  45
  46      # usermodes: Oper-only usermodes that opers with this class can use.
  47      usermodes="*"
  48
  49      # chanmodes: Oper-only channel modes that opers with this class can use.
  50      chanmodes="*">
  51
  52 <class name="SACommands" commands="SAJOIN SAPART SANICK SAQUIT SATOPIC SAKICK SAMODE OJOIN">
  53 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT RSQUIT MKPASSWD ALLTIME SWHOIS LOCKSERV UNLOCKSERV" usermodes="*" chanmodes="*" privs="servers/auspex">
  54 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE TLINE RLINE CHECK NICKLOCK NICKUNLOCK SHUN CLONES CBAN" usermodes="*" chanmodes="*">
  55 <class name="OperChat" commands="WALLOPS GLOBOPS" usermodes="*" chanmodes="*" privs="users/mass-message">
  56 <class name="HostCloak" commands="SETHOST SETIDENT SETIDLE CHGNAME CHGHOST CHGIDENT" usermodes="*" chanmodes="*" privs="users/auspex">
  57
  58
  59 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
  60 #                                                                     #
  61 #   This is where you specify which types of operators you have on    #
  62 #   your server, as well as the commands they are allowed to use.     #
  63 #   This works alongside with the classes specified above.            #
  64 #                                                                     #
  65
  66 <type
  67     # name: Name of the type. Used in actual server operator accounts below.
  68     name="NetAdmin"
  69
  70     # classes: Classes (blocks above) that this type belongs to.
  71     classes="SACommands OperChat BanControl HostCloak Shutdown ServerLink"
  72
  73     # vhost: Host that opers of this type get when they log in (oper up). This is optional.
  74     vhost="netadmin.omega.example.org"
  75
  76     # maxchans: Maximum number of channels opers of this type can be in at once.
  77     maxchans="60"
  78
  79     # modes: User modes besides +o that are set on an oper of this type
  80     # when they oper up. Used for snomasks and other things.
  81     # Requires the opermodes module to be loaded.
  82     modes="+s +cCqQ">
  83
  84 <type name="GlobalOp" classes="SACommands OperChat BanControl HostCloak ServerLink" vhost="ircop.omega.example.org">
  85 <type name="Helper" classes="HostCloak" vhost="helper.omega.example.org">
  86
  87
  88 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
  89 #                                                                     #
  90 #   Opers are defined here. This is a very important section.         #
  91 #   Remember to only make operators out of trustworthy people.        #
  92 #                                                                     #
  93
  94 # Operator account with a plaintext password.
  95 <oper
  96       # name: Oper login that is used to oper up (/OPER <username> <password>).
  97       # Remember: This is case sensitive.
  98       name="Attila"
  99
 100       # password: Case-sensitive, unhashed (plaintext).
 101       password="s3cret"
 102
 103       # host: What hostnames and IPs are allowed to use this operator account.
 104       # Multiple options can be separated by spaces and CIDRs are allowed.
 105       # You can use just * or *@* for this section, but it is not recommended
 106       # for security reasons.
 107       host="attila@inspircd.org *@2001:db8::/32"
 108
 109       # ** ADVANCED ** This option is disabled by default.
 110       # fingerprint: When using the sslinfo module, you may specify
 111       # a key fingerprint here. This can be obtained by using the /SSLINFO
 112       # command while the module is loaded, and is also noticed on connect.
 113       # This enhances security by verifying that the person opering up has
 114       # a matching SSL client certificate, which is very difficult to
 115       # forge (impossible unless preimage attacks on the hash exist).
 116       # If the sslinfo module isn't loaded, this option will be ignored.
 117       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
 118
 119       # autologin: If an SSL certificate fingerprint for this oper is specified,
 120       # you can have the oper block automatically log in. This moves all security
 121       # of the oper block to the protection of the client certificate, so be sure
 122       # that the private key is well-protected! Requires the sslinfo module.
 123       #autologin="on"
 124
 125       # sslonly: If on, this oper can only oper up if they're using an SSL connection.
 126       # Setting this option adds a decent bit of security. Highly recommended
 127       # if the oper is on wifi, or specifically, unsecured wifi. Note that it
 128       # is redundant to specify this option if you specify a fingerprint.
 129       # This setting only takes effect if the sslinfo module is loaded.
 130       #sslonly="yes"
 131
 132       # vhost: Overrides the vhost in the type block. Class and modes may also
 133       # be overridden.
 134       vhost="attila.example.org"
 135
 136       # type: Which type of operator this person is; see the block
 137       # above for the list of types. NOTE: This is case-sensitive as well.
 138       type="NetAdmin">
 139
 140 # Operator with a plaintext password and no comments, for easy copy & paste.
 141 <oper
 142       name="Brain"
 143       password="youshouldhashthis"
 144       host="brain@dialup15.isp.test.com *@localhost *@example.com *@2001:db8::/32"
 145       #fingerprint="67cb9dc013248a829bb2171ed11becd4"
 146       type="NetAdmin">
 147
 148 # Operator with a hashed password. It is highly recommended to use hashed passwords.
 149 <oper
 150       # name: Oper login that is used to oper up (/OPER <username> <password>).
 151       # Remember: This is case sensitive.
 152       name="Adam"
 153
 154       # hash: The hash function this password is hashed with. Requires the
 155       # module for the selected function (bcrypt, md5, sha1, or sha256) and
 156       # the password hashing module (password_hash) to be loaded.
 157       #
 158       # You may also use any of the above other than bcrypt prefixed with
 159       # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
 160       # Create hashed passwords with: /MKPASSWD <hashtype> <plaintext>.
 161       hash="bcrypt"
 162
 163       # password: A hash of the password (see above option) hashed
 164       # with /MKPASSWD <hashtype> <plaintext>. See the password_hash module
 165       # in modules.conf for more information about password hashing.
 166       password="qQmv3LcF$Qh63wzmtUqWp9OXnLwe7yv1GcBwHpq59k2a0UrY8xe0"
 167
 168       # host: What hostnames and IPs are allowed to use this operator account.
 169       # Multiple options can be separated by spaces and CIDRs are allowed.
 170       # You can use just * or *@* for this section, but it is not recommended
 171       # for security reasons.
 172       host="*@127.0.0.1 *@192.0.2.40 *@198.51.100.4"
 173
 174       # type: Which type of operator this person is; see the block
 175       # above for the list of types. NOTE: This is case-sensitive as well.
 176       type="Helper">
 177
 178 # Once you have edited this file you can remove this line. This is just to
 179 # ensure that you don't hastily include the file without reading it.
 180 <die reason="Using opers.conf.example without editing it is a security risk">