nodogsplash/files/etc/config/nodogsplash

   1
   2 # The options available here are an adaptation of the settings used in nodogsplash.conf.
   3 # See https://github.com/nodogsplash/nodogsplash/blob/master/resources/nodogsplash.conf
   4
   5 config nodogsplash
   6   # Set to 0 to disable nodogsplash
   7   option enabled 1
   8
   9   # Set to 0 to disable hook that makes nodogsplash restart when the firewall restarts.
  10   # This hook is needed as a restart of Firewall overwrites nodogsplash iptables entries.
  11   option fwhook_enabled '1'
  12
  13   # Serve the file splash.html from this directory
  14   option webroot '/etc/nodogsplash/htdocs'
  15
  16   # Use plain configuration file
  17   #option config '/etc/nodogsplash/nodogsplash.conf'
  18
  19   # Use this option to set the device nogogsplash will bind to.
  20   # The value may be an interface section in /etc/config/network or a device name such as br-lan.
  21   option gatewayinterface 'br-lan'
  22
  23   option gatewayname 'OpenWrt Nodogsplash'
  24   option maxclients '250'
  25
  26   # Enables debug output (0-7)
  27   #option debuglevel '7'
  28
  29   # Client timeouts in minutes
  30   option preauthidletimeout '10'
  31   option authidletimeout '120'
  32
  33   # Enable BinAuth Support.
  34   # If set, a program is called with several parameters on authentication (request) and deauthentication.
  35   # Request for authentication:
  36   # $<BinAuth> auth_client <client_mac> '<username>' '<password>'
  37   #
  38   # The username and password values may be empty strings and are URL encoded.
  39   # The program is expected to output the number of seconds the client
  40   # is to be authenticated. Zero or negative seconds will cause the authentification request
  41   # to be rejected. The same goes for an exit code that is not 0.
  42   # The output may contain a user specific download and upload limit in KBit/s:
  43   # <seconds> <upload> <download>
  44   #
  45   # Called on authentication or deauthentication:
  46   # $<BinAuth> <*auth|*deauth> <incoming_bytes> <outgoing_bytes> <session_start> <session_end>
  47   #
  48   # "client_auth": Client authenticated via this script.
  49   # "client_deauth": Client deauthenticated by the client via splash page.
  50   # "idle_deauth": Client was deauthenticated because of inactivity.
  51   # "timeout_deauth": Client was deauthenticated because the session timed out.
  52   # "ndsctl_auth": Client was authenticated manually by the ndsctl tool.
  53   # "ndsctl_deauth": Client was deauthenticated by the ndsctl tool.
  54   # "shutdown_deauth": Client was deauthenticated by Nodogsplash terminating.
  55   #
  56   # Values session_start and session_start are in seconds since 1970 or 0 for unknown/unlimited.
  57   #
  58   #option binauth '/bin/myauth.sh'
  59
  60   # Enable Forwarding Authentication Service (FAS)
  61   # If set redirection is changed from splash.html to a FAS (provided by the system administrator)
  62   # The value is the IP port number of the FAS
  63   #option fasport '80'
  64
  65   # Option: fasremoteip
  66   # Default: GatewayAddress (the IP of NDS)
  67   # If set, this is the remote ip address of the FAS.
  68   #option fasremoteip '46.32.240.41'
  69
  70   # Option: faspath
  71   # Default: /
  72   # This is the path from the FAS Web Root to the FAS login page
  73   # (not the file system root).
  74   #option faspath '/onboard-wifi.net/nodog/fas.php'
  75
  76   # Option: fas_secure_enabled
  77   # Default: 1
  78   # If set to "1", authaction and the client token are not revealed and it is the responsibility
  79   # of the FAS to request the token from NDSCTL.
  80   # If set to "0", the client token is sent to the FAS in clear text in the query string of the
  81   # redirect along with authaction and redir.
  82   #option fas_secure_enabled '0'
  83
  84   # Your router may have several interfaces, and you
  85   # probably want to keep them private from the network/gatewayinterface.
  86   # If so, you should block the entire subnets on those interfaces, e.g.:
  87   #list authenticated_users 'block to 192.168.0.0/16'
  88   #list authenticated_users 'block to 10.0.0.0/8'
  89
  90   # Typical ports you will probably want to open up.
  91   #list authenticated_users 'allow tcp port 22'
  92   #list authenticated_users 'allow tcp port 53'
  93   #list authenticated_users 'allow udp port 53'
  94   #list authenticated_users 'allow tcp port 80'
  95   #list authenticated_users 'allow tcp port 443'
  96   # Or for happy customers allow all
  97   list authenticated_users 'allow all'
  98
  99   # For preauthenticated users to resolve IP addresses in their
 100   # initial request not using the router itself as a DNS server,
 101   # Leave commented to help prevent DNS tunnelling
 102   #list preauthenticated_users 'allow tcp port 53'
 103   #list preauthenticated_users 'allow udp port 53'
 104
 105   # Allow ports for SSH/Telnet/DNS/DHCP/HTTP/HTTPS
 106   list users_to_router 'allow tcp port 22'
 107   list users_to_router 'allow tcp port 23'
 108   list users_to_router 'allow tcp port 53'
 109   list users_to_router 'allow udp port 53'
 110   list users_to_router 'allow udp port 67'
 111   list users_to_router 'allow tcp port 80'
 112
 113   # MAC addresses that are / are not allowed to access the splash page
 114   # Value is either 'allow' or 'block'. The allowedmac or blockedmac list is used.
 115   #option macmechanism 'allow'
 116   #list allowedmac '00:00:C0:01:D0:0D'
 117   #list allowedmac '00:00:C0:01:D0:1D'
 118   #list blockedmac '00:00:C0:01:D0:2D'
 119
 120   # MAC addresses that do not need to authenticate
 121   #list trustedmac '00:00:C0:01:D0:1D'
 122
 123   # Nodogsplash uses specific HEXADECIMAL values to mark packets used by iptables as a bitwise mask.
 124   # This mask can conflict with the requirements of other packages such as mwan3, sqm etc
 125   # Any values set here are interpreted as in hex format.
 126   #
 127   # List: fw_mark_authenticated
 128   # Default: 30000 (0011|0000|0000|0000|0000 binary)
 129   #
 130   # List: fw_mark_trusted
 131   # Default: 20000 (0010|0000|0000|0000|0000 binary)
 132   #
 133   # List: fw_mark_blocked
 134   # Default: 10000 (0001|0000|0000|0000|0000 binary)
 135   #
 136   #list fw_mark_authenticated '30000'
 137   #list fw_mark_trusted '20000'
 138   #list fw_mark_blocked '10000'
 139