Site Tools


access_restrictions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
access_restrictions [2021/05/26 15:34] t3chwizardaccess_restrictions [2023/10/26 17:20] (current) – [Scripting Access Restrictions] -format hogwild
Line 1: Line 1:
-====== Access Restrictions ======+====== Scripting Access Restrictions ======
  
-Access Restriction rules are coded as pipe (|) separated strings and stored in nvram variables named rrule0, rrule1, rrule2 etcTo see what is in the first rule we can issue the following command at the shell prompt in Tomato:+Access Restriction rules are coded as strings separated by pipe ( | ) symbols. These are stored in NVRAM as variables named //rrule0////rrule1////rrule2// and so on.
  
-<code>nvram get rrule0</code>+ \\
  
-The returned string might look something like:+To see what's in the first rule, we can issue the following command at a FreshTomato shell prompt:
  
-<code>1|540|1140|62|||block-site.com$|0|New Rule 1</code>+ \\
  
-Let us take a closer look at what each of these nine fields separated by pipe (|) means.+<code -> 
 +nvram get rrule0 
 +</code>
  
-The first field shows whether the rule is currently enabled or disabled – 1 means enabled, 0 means disabled.+\\
  
-The second field gives the start time, i.e. the time to start applying this rule, in minutes elapsed since midnight. In the above example start time is 540 meaning the router should enforce this rule starting at 9am.  The third field is the end time, i.e. the time to stop applying this rule, again coded the same way as the start time. Both the second and third fields will be -1 if you select the option ‘All Day’ in the control panel.+The returned string might look something like this:
  
-The fourth field is the days of week on which the rule should be applied and is coded in binary – 1 for Sunday, 2 for Monday, 4 for Tuesday and so on. For multiple days, add the corresponding numbers for each day. In the above example the fourth field is 62 which is equal to 2+4+8+16+32 – meaning the rule should be active on Mon, Tue, Wed, Thu, and Fri i.e. only on week days. If you had checked the option Everyday this value would be 127.+ \\
  
-The fifth field shows the ip or mac address range in your network for which the rule should be applied – in case you don’t want all the computers on the network to be affected by this ruleThe sixth field has the Port/Application information coded in it i.e. which ports numbers, protocols, layer 7 and p2p applications should be blocked by this rule.+<code -> 
 +1|540|1140|62|||block-site.com$|0|New Rule 1 
 +</code>
  
-The seventh field contains the domains or URLs you want to block and it partially supports regular expressions. In the above example, domain names ending in block-site.com are blocked. The eighth field stores as a binary coded value if ActiveX, Flash or Java need to  be blocked – 1 for ActiveX, 2 for Flash and 4 for Java. And finally the ninth field stores the name that you gave to this rule.+\\
  
-Now with this basic understanding about how the Access Restriction rules in Tomato work, we can write shell scripts to control the rules. Below is the script I wrote to enable or disable rule. Two values are passed on the command line – the rule number and either a 0 or a 1 to disable or enable the service respectively. If you have jffs enabled in control panel you can copy the script under jffs directory and schedule it to run, if you want, as a cron job.+Let's look more closely at what each of these fields separated by pipe ( | ) symbol means.
  
-<code>+**Field 1:** indicates whether the rule is currently enabled (1) or disabled (0). 
 + 
 +**Field 2:** specifies the start time, (time to start applying this rule), in minutes elapsed since midnight. 
 + 
 +In this case, start time is 5:40 AM, so the router should enforce this rule starting at 9:00 AM. 
 + 
 +**Field 3:**  is the end time, (time to stop applying this rule). This is coded similarly to the start time. 
 + 
 +Both the second and third fields will be -1 if you select the //‘All Day’// option in the Access Restrictions menu. 
 + 
 +**Field 4:** specifies on which days the rule will be applied. 
 + 
 +It is coded in binary: 
 + 
 +  * 1 = Sunday 
 +  * 2 = Monday 
 +  * 4 = Tuesday 
 +  * 8 = Wednesday 
 +  * 16 = Thursday 
 +  * 32 = Friday 
 +  * 64 = Saturday 
 + 
 + \\ 
 + 
 +For multiple days, simply add together the corresponding numbers for each day. 
 + 
 +In the above example, the fourth field is 62, which is equal to 2 + 4 + 8 + 16 + 32 . This means the rule should be active on Mon, Tue, Wed, Thu, and Fri. That is, only on weekdays. If you had checked the //Everyday// option, the value would have been 127. 
 + 
 +**Field 5:** shows the IP or MAC Address range on your network for which the rule should be applied. 
 + 
 +**Field 6:** has the //Port/Application// information coded in it. In other words, which port numbers and protocols. This rule should block Layer 7 and p2p applications. 
 + 
 +**Field 7:**  contains the Domains/URLs to block. It partially supports regular expressions. 
 + 
 +In the example above, domain names ending with "block-site.com" are blocked. 
 + 
 +**Field 8:**  stores a binary coded value if ActiveX, Flash or Java are set to be blocked. 
 + 
 +  * A "1" will block ActiveX.  
 +  * A "2" will block Flash. 
 +  * A "4" will block Java. 
 + 
 + \\ 
 + 
 +**Field 9:**  stores the name that you gave to the rule being edited. 
 + 
 + \\ Now that we have a basic sense of how Access Restriction rules work, we can write shell scripts to control the rules. The script below will enable or disable a rule. Two values are passed on the command line – the rule number and either a "0" or "1" to disable or enable the service. 
 + 
 +\\ 
 + 
 +<code ->
 #!/bin/sh #!/bin/sh
  
Line 62: Line 116:
 </code> </code>
  
-===== Credits =====+\\
  
 +If you have JFFS enabled in FreshTomato, you can copy the script under the jffs directory and schedule it to run as a cron job, if you wish.
 +
 + \\
 +
 + \\
 +
 +
 +===== Credits =====
  
-[[http://web.archive.org/web/20160321090715/http://infinilogix.com/wordpress/network-programming/routers/how-to-control-access-restriction-rules-in-tomato-by-a-shell-script|Credit to Justin from "infinilogix.com"]]+[[http://web.archive.org/web/20160321090715/http://infinilogix.com/wordpress/network-programming/routers/how-to-control-access-restriction-rules-in-tomato-by-a-shell-script|CreditJustin from "infinilogix.com" - original page which is now only accessible via archive.org]]
  
  
access_restrictions.1622039649.txt.gz · Last modified: 2021/05/26 15:34 by t3chwizard