blob: 52ce87026cac574fa46b28dd1ceda6c64307872f [file] [log] [blame]
akmhoque157b0a42014-05-13 00:26:37 -05001; the general section contains all the general settings for router
akmhoqueba094742014-02-28 11:47:21 -06002
akmhoque157b0a42014-05-13 00:26:37 -05003general
4{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -07005 ; mandatory configuration command section network, site and router
akmhoqueba094742014-02-28 11:47:21 -06006
Alexander Afanasyev8388ec62014-08-16 18:38:57 -07007 network /ndn/ ; name of the network the router belongs to in ndn URI format
8 site /edu/memphis ; name of the site the router belongs to in ndn URI format
9 router /%C1.Router/cs/pollux ; name of the router in ndn URI format
akmhoque157b0a42014-05-13 00:26:37 -050010
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070011 ; lsa-refresh-time is the time in seconds, after which router will refresh its LSAs
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070012 lsa-refresh-time 1800 ; default value 1800. Valid values 240-7200
akmhoque157b0a42014-05-13 00:26:37 -050013
Alexander Afanasyev411ee4b2014-08-16 23:17:03 -070014 ; InterestLifetime (in seconds) for LSA fetching
15 lsa-interest-lifetime 4 ; default value 4. Valid values 1-60
16
Vince Lehmanf99b87f2014-08-26 15:54:27 -050017 ; log-level is used to set the logging level for NLSR.
18 ; All debugging levels listed above the selected value are enabled.
19 ;
20 ; Valid values:
21 ;
22 ; NONE ; no messages
23 ; ERROR ; error messages
24 ; WARN ; warning messages
25 ; INFO ; informational messages (default)
26 ; DEBUG ; debugging messages
27 ; TRACE ; trace messages (most verbose)
28 ; ALL ; all messages
akmhoque157b0a42014-05-13 00:26:37 -050029
Vince Lehmanf99b87f2014-08-26 15:54:27 -050030 log-level INFO
31
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070032 log-dir /var/log/nlsr/ ; path for log directory (Absolute path)
33 seq-dir /var/lib/nlsr/ ; path for sequence directory (Absolute path)
akmhoque157b0a42014-05-13 00:26:37 -050034}
35
36; the neighbors section contains the configuration for router's neighbors and hello's behavior
37
38neighbors
39{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070040 ; in case hello interest timed out, router will try 'hello-retries' times at 'hello-timeout'
41 ; seconds interval before giving up for any neighbors (deciding link is down)
akmhoque157b0a42014-05-13 00:26:37 -050042
43 hello-retries 3 ; interest retries number in integer. Default value 3
44 ; valid values 1-10
45
46 hello-timeout 1 ; interest time out value in integer. Default value 1
47 ; Valid values 1-15
48
49 hello-interval 60 ; interest sending interval in seconds. Default value 60
50 ; valid values 30-90
akmhoque157b0a42014-05-13 00:26:37 -050051
Vince Lehman7b616582014-10-17 16:25:39 -050052 ; adj-lsa-build-interval is the time to wait in seconds after an Adjacency LSA build is scheduled
53 ; before actually building the Adjacency LSA
54
55 adj-lsa-build-interval 5 ; default value 5. Valid values 0-5. It is recommended that
56 ; adj-lsa-build-interval have a lower value than routing-calc-interval
57
58 ; first-hello-interval is the time to wait in seconds before sending the first Hello Interest
59
60 first-hello-interval 10 ; Default value 10. Valid values 0-10
61
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070062 ; neighbor command is used to configure router's neighbor. Each neighbor will need
63 ; one block of neighbor command
64
65 neighbor
66 {
67 name /ndn/edu/memphis/%C1.Router/cs/castor ; name prefix of the neighbor router consists
68 ; of network, site-name and router-name
69
70 face-uri udp://castor.cs.memphis.edu ; face uri of the face connected to the neighbor
71 link-cost 25 ; cost of the connecting link to neighbor
72 }
73
74 neighbor
75 {
76 name /ndn/edu/memphis/%C1.Router/cs/mira ; name prefix of the neighbor router consists
akmhoque157b0a42014-05-13 00:26:37 -050077 ; of network, site-name and router-name
78
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070079 face-uri udp://mira.cs.memphis.edu ; face uri of the face connected to the neighbor
80 link-cost 30 ; cost of the connecting link to neighbor
81 }
akmhoque157b0a42014-05-13 00:26:37 -050082}
83
84; the hyperbolic section contains the configuration settings of enabling a router to calculate
85; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method
86
87hyperbolic
88{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070089 ; commands in this section follows a strict order
90 ; the switch is used to set hyperbolic routing calculation in NLSR
akmhoque157b0a42014-05-13 00:26:37 -050091
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070092 state off ; default value 'off', set value 'on' to enable hyperbolic routing table
93 ; calculation which turns link state routing 'off'. set value to 'dry-run"
94 ; to test hyperbolic routing and compare with link state routing.
akmhoqueba094742014-02-28 11:47:21 -060095
96
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070097 radius 123.456 ; radius of the router in hyperbolic coordinate system
98 angle 1.45 ; angle of the router in hyperbolic coordinate system
akmhoque157b0a42014-05-13 00:26:37 -050099}
100
101
102; the fib section is used to configure fib entry's type to ndn FIB updated by NLSR
103
104fib
105{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700106 ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes
107 ; by NLSR in ndn FIB
akmhoque157b0a42014-05-13 00:26:37 -0500108
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700109 max-faces-per-prefix 3 ; default value 0. Valid value 0-60. By default (value 0) NLSR adds
110 ; all available faces for each reachable name prefixes in NDN FIB
Vince Lehman7b616582014-10-17 16:25:39 -0500111
112 ; routing-calc-interval is the time to wait in seconds after a routing table calculation is
113 ; scheduled before actually performing the routing table calculation
114
115 routing-calc-interval 15 ; default value 15. Valid values 0-15. It is recommended that
116 ; routing-calc-interval have a higher value than adj-lsa-build-interval
akmhoque157b0a42014-05-13 00:26:37 -0500117}
118
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700119; the advertising section contains the configuration settings of the name prefixes
akmhoque157b0a42014-05-13 00:26:37 -0500120; hosted by this router
121
122advertising
123{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700124 ; the ndnname is used to advertised name from the router. To advertise each name prefix
125 ; configure one block of ndnname configuration command for every name prefix.
akmhoque157b0a42014-05-13 00:26:37 -0500126
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700127 prefix /ndn/edu/memphis/cs/netlab ; name in ndn URI format
128 prefix /ndn/edu/memphis/sports/basketball
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700129}
130
131security
132{
133 validator
134 {
135 rule
136 {
137 id "NSLR Hello Rule"
138 for data
139 filter
140 {
141 type name
akmhoque93f1a072014-06-19 16:24:28 -0500142 regex ^[^<NLSR><INFO>]*<NLSR><INFO><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700143 }
144 checker
145 {
146 type customized
147 sig-type rsa-sha256
148 key-locator
149 {
150 type name
151 hyper-relation
152 {
153 k-regex ^([^<KEY><NLSR>]*)<NLSR><KEY><ksk-.*><ID-CERT>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700154 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700155 h-relation equal
akmhoque93f1a072014-06-19 16:24:28 -0500156 p-regex ^([^<NLSR><INFO>]*)<NLSR><INFO><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700157 p-expand \\1
158 }
159 }
160 }
161 }
162
163 rule
164 {
165 id "NSLR LSA Rule"
166 for data
167 filter
168 {
169 type name
akmhoquea816bee2014-06-24 14:37:40 -0500170 regex ^[^<NLSR><LSA>]*<NLSR><LSA>
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700171 }
172 checker
173 {
174 type customized
175 sig-type rsa-sha256
176 key-locator
177 {
178 type name
179 hyper-relation
180 {
181 k-regex ^([^<KEY><NLSR>]*)<NLSR><KEY><ksk-.*><ID-CERT>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700182 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700183 h-relation equal
akmhoque50125a92014-06-30 08:54:17 -0500184 p-regex ^([^<NLSR><LSA>]*)<NLSR><LSA>(<>*)<><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700185 p-expand \\1\\2
186 }
187 }
188 }
189 }
190
191 rule
192 {
193 id "NSLR Hierarchy Exception Rule"
194 for data
195 filter
196 {
197 type name
akmhoquecc827532014-07-09 08:48:49 -0500198 regex ^[^<KEY><%C1.Router>]*<%C1.Router>[^<KEY><NLSR>]*<KEY><ksk-.*><ID-CERT><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700199 }
200 checker
201 {
202 type customized
203 sig-type rsa-sha256
204 key-locator
205 {
206 type name
207 hyper-relation
208 {
akmhoquecc827532014-07-09 08:48:49 -0500209 k-regex ^([^<KEY><%C1.Operator>]*)<%C1.Operator>[^<KEY>]*<KEY><ksk-.*><ID-CERT>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700210 k-expand \\1
211 h-relation equal
akmhoquecc827532014-07-09 08:48:49 -0500212 p-regex ^([^<KEY><%C1.Router>]*)<%C1.Router>[^<KEY>]*<KEY><ksk-.*><ID-CERT><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700213 p-expand \\1
214 }
215 }
216 }
217 }
218
219 rule
220 {
221 id "NSLR Hierarchical Rule"
222 for data
223 filter
224 {
225 type name
226 regex ^[^<KEY>]*<KEY><ksk-.*><ID-CERT><>$
227 }
228 checker
229 {
230 type hierarchical
231 sig-type rsa-sha256
232 }
233 }
234
235 trust-anchor
236 {
237 type file
238 file-name "root.cert"
239 }
240 }
Vince Lehman9f51efd2014-09-18 14:46:01 -0500241 ; cert-to-publish "root.cert" ; optional, a file containing the root certificate
242 ; Only the router that is designated to publish the root cert
243 ; needs to specify this
244
245 ; cert-to-publish "site.cert" ; optional, a file containing the site certificate
246 ; Only the router that is designated to publish the site cert
247 ; needs to specify this
248
249 ; cert-to-publish "operator.cert" ; optional, a file containing the operator certificate
250 ; Only the router that is designated to publish the operator
251 ; cert needs to specify this
252
akmhoque50125a92014-06-30 08:54:17 -0500253 cert-to-publish "router.cert" ; required, a file containing the router certificate.
akmhoque157b0a42014-05-13 00:26:37 -0500254}