blob: 791cbf0305806ff2e4a883f80c7e1d3c386950a8 [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
Nick Gordond5c1a372016-10-31 13:56:23 -050014 ; router-dead-interval is the time in seconds after which an inactive routers
Vince Lehmanfc7d5b62014-12-05 15:02:47 -060015 ; LSAs are removed
16 ;router-dead-interval 3600 ; default value: 2*lsa-refresh-time. Value must be larger
17 ; than lsa-refresh-time
18
Alexander Afanasyev411ee4b2014-08-16 23:17:03 -070019 ; InterestLifetime (in seconds) for LSA fetching
20 lsa-interest-lifetime 4 ; default value 4. Valid values 1-60
21
Ashlesh Gawande32ec3fd2018-07-18 13:42:32 -050022 ; select sync protocol: chronosync or psync
23 sync-protocol psync
24
25 ; sync interest lifetime of ChronoSync/PSync in milliseconds
Ashlesh Gawandef7da9c52018-02-06 17:36:46 -060026 sync-interest-lifetime 60000 ; default value 60000. Valid values 1000-120,000
27
dulalsaurab82a34c22019-02-04 17:31:21 +000028 state-dir /var/lib/nlsr ; path for intermediate state files including sequence directory (Absolute path)
akmhoque157b0a42014-05-13 00:26:37 -050029}
30
Nick Gordond5c1a372016-10-31 13:56:23 -050031; the neighbor's section contains the configuration for router's neighbors and hellos behavior
akmhoque157b0a42014-05-13 00:26:37 -050032
33neighbors
34{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070035 ; in case hello interest timed out, router will try 'hello-retries' times at 'hello-timeout'
36 ; seconds interval before giving up for any neighbors (deciding link is down)
akmhoque157b0a42014-05-13 00:26:37 -050037
38 hello-retries 3 ; interest retries number in integer. Default value 3
39 ; valid values 1-10
40
41 hello-timeout 1 ; interest time out value in integer. Default value 1
42 ; Valid values 1-15
43
44 hello-interval 60 ; interest sending interval in seconds. Default value 60
45 ; valid values 30-90
akmhoque157b0a42014-05-13 00:26:37 -050046
Vince Lehman7b616582014-10-17 16:25:39 -050047 ; adj-lsa-build-interval is the time to wait in seconds after an Adjacency LSA build is scheduled
48 ; before actually building the Adjacency LSA
49
50 adj-lsa-build-interval 5 ; default value 5. Valid values 0-5. It is recommended that
51 ; adj-lsa-build-interval have a lower value than routing-calc-interval
52
53 ; first-hello-interval is the time to wait in seconds before sending the first Hello Interest
54
55 first-hello-interval 10 ; Default value 10. Valid values 0-10
56
Nick Gordond5c1a372016-10-31 13:56:23 -050057 face-dataset-fetch-tries 3 ; default is 3. Valid values 1-10. The FaceDataset is
58 ; gotten from NFD, and is needed to configure NLSR
59 ; correctly. It is recommended not to set this
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -050060 ; variable too high, because it could cause
Nick Gordond5c1a372016-10-31 13:56:23 -050061 ; congestion for NFD.
62
63 face-dataset-fetch-interval 3600 ; default is 3600. Valid values 1800-5400.
64 ; This controls how often (in seconds) NLSR will attempt to
65 ; fetch a FaceStatus dataset from NFD.
66
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070067 ; neighbor command is used to configure router's neighbor. Each neighbor will need
68 ; one block of neighbor command
69
70 neighbor
71 {
72 name /ndn/edu/memphis/%C1.Router/cs/castor ; name prefix of the neighbor router consists
73 ; of network, site-name and router-name
74
75 face-uri udp://castor.cs.memphis.edu ; face uri of the face connected to the neighbor
76 link-cost 25 ; cost of the connecting link to neighbor
77 }
78
79 neighbor
80 {
81 name /ndn/edu/memphis/%C1.Router/cs/mira ; name prefix of the neighbor router consists
akmhoque157b0a42014-05-13 00:26:37 -050082 ; of network, site-name and router-name
83
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070084 face-uri udp://mira.cs.memphis.edu ; face uri of the face connected to the neighbor
85 link-cost 30 ; cost of the connecting link to neighbor
86 }
akmhoque157b0a42014-05-13 00:26:37 -050087}
88
89; the hyperbolic section contains the configuration settings of enabling a router to calculate
90; routing table using [hyperbolic routing table calculation](http://arxiv.org/abs/0805.1266) method
91
92hyperbolic
93{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070094 ; commands in this section follows a strict order
95 ; the switch is used to set hyperbolic routing calculation in NLSR
akmhoque157b0a42014-05-13 00:26:37 -050096
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070097 state off ; default value 'off', set value 'on' to enable hyperbolic routing table
Junxiao Shif09e2632015-01-02 18:15:01 -070098 ; calculation which turns link state routing 'off'. set value to 'dry-run'
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070099 ; to test hyperbolic routing and compare with link state routing.
akmhoqueba094742014-02-28 11:47:21 -0600100
101
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700102 radius 123.456 ; radius of the router in hyperbolic coordinate system
Muktadir R Chowdhuryb00dc2a2016-11-05 10:48:58 -0600103 angle 1.45,2.36 ; angle of the router in hyperbolic coordinate system
akmhoque157b0a42014-05-13 00:26:37 -0500104}
105
106
Nick Gordond5c1a372016-10-31 13:56:23 -0500107; the fib section is used to configure fib entrys type to ndn FIB updated by NLSR
akmhoque157b0a42014-05-13 00:26:37 -0500108
109fib
110{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700111 ; the max-faces-per-prefix is used to limit the number of faces for each name prefixes
112 ; by NLSR in ndn FIB
akmhoque157b0a42014-05-13 00:26:37 -0500113
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700114 max-faces-per-prefix 3 ; default value 0. Valid value 0-60. By default (value 0) NLSR adds
115 ; all available faces for each reachable name prefixes in NDN FIB
Vince Lehman7b616582014-10-17 16:25:39 -0500116
117 ; routing-calc-interval is the time to wait in seconds after a routing table calculation is
118 ; scheduled before actually performing the routing table calculation
119
120 routing-calc-interval 15 ; default value 15. Valid values 0-15. It is recommended that
121 ; routing-calc-interval have a higher value than adj-lsa-build-interval
akmhoque157b0a42014-05-13 00:26:37 -0500122}
123
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700124; the advertising section contains the configuration settings of the name prefixes
akmhoque157b0a42014-05-13 00:26:37 -0500125; hosted by this router
126
127advertising
128{
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700129 ; the ndnname is used to advertised name from the router. To advertise each name prefix
130 ; configure one block of ndnname configuration command for every name prefix.
akmhoque157b0a42014-05-13 00:26:37 -0500131
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700132 prefix /ndn/edu/memphis/cs/netlab ; name in ndn URI format
133 prefix /ndn/edu/memphis/sports/basketball
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700134}
135
136security
137{
138 validator
139 {
140 rule
141 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000142 id "NLSR Hello Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700143 for data
144 filter
145 {
146 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500147 regex ^[^<nlsr><INFO>]*<nlsr><INFO><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700148 }
149 checker
150 {
151 type customized
152 sig-type rsa-sha256
153 key-locator
154 {
155 type name
156 hyper-relation
157 {
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500158 k-regex ^([^<KEY><nlsr>]*)<nlsr><KEY><>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700159 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700160 h-relation equal
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500161 p-regex ^([^<nlsr><INFO>]*)<nlsr><INFO><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700162 p-expand \\1
163 }
164 }
165 }
166 }
167
168 rule
169 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000170 id "NLSR LSA Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700171 for data
172 filter
173 {
174 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500175 regex ^[^<nlsr><LSA>]*<nlsr><LSA>
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700176 }
177 checker
178 {
179 type customized
180 sig-type rsa-sha256
181 key-locator
182 {
183 type name
184 hyper-relation
185 {
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500186 k-regex ^([^<KEY><nlsr>]*)<nlsr><KEY><>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700187 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700188 h-relation equal
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -0500189 ; the last four components in the prefix should be <lsaType><seqNo><version><segmentNo>
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500190 p-regex ^<localhop>([^<nlsr><LSA>]*)<nlsr><LSA>(<>*)<><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700191 p-expand \\1\\2
192 }
193 }
194 }
195 }
196
197 rule
198 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000199 id "NLSR Hierarchy Exception Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700200 for data
201 filter
202 {
203 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500204 regex ^[^<KEY><%C1.Router>]*<%C1.Router>[^<KEY><nlsr>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700205 }
206 checker
207 {
208 type customized
209 sig-type rsa-sha256
210 key-locator
211 {
212 type name
213 hyper-relation
214 {
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500215 k-regex ^([^<KEY><%C1.Operator>]*)<%C1.Operator>[^<KEY>]*<KEY><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700216 k-expand \\1
217 h-relation equal
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500218 p-regex ^([^<KEY><%C1.Router>]*)<%C1.Router>[^<KEY>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700219 p-expand \\1
220 }
221 }
222 }
223 }
224
225 rule
226 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000227 id "NLSR Hierarchical Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700228 for data
229 filter
230 {
231 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500232 regex ^[^<KEY>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700233 }
234 checker
235 {
236 type hierarchical
237 sig-type rsa-sha256
238 }
239 }
240
241 trust-anchor
242 {
243 type file
244 file-name "root.cert"
245 }
246 }
alvy297f4162015-03-03 17:15:33 -0600247
248 prefix-update-validator
249 {
250 rule
251 {
252 id "NLSR ControlCommand Rule"
253 for interest
254 filter
255 {
256 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500257 ; /<prefix>/<management-module>/<command-verb>/<control-parameters>
258 ; /<timestamp>/<random-value>/<signed-interests-components>
259 regex ^<localhost><nlsr><prefix-update>[<advertise><withdraw>]<><><>$
alvy297f4162015-03-03 17:15:33 -0600260 }
261 checker
262 {
263 type customized
264 sig-type rsa-sha256
265 key-locator
266 {
267 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500268 regex ^([^<KEY><%C1.Operator>]*)<%C1.Operator>[^<KEY>]*<KEY><>$
alvy297f4162015-03-03 17:15:33 -0600269 }
270 }
271 }
272
273 rule
274 {
275 id "NLSR Hierarchy Rule"
276 for data
277 filter
278 {
279 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500280 regex ^[^<KEY>]*<KEY><><><>$
alvy297f4162015-03-03 17:15:33 -0600281 }
282 checker
283 {
284 type hierarchical
285 sig-type rsa-sha256
286 }
287 }
288
289 trust-anchor
290 {
291 type file
292 file-name "site.cert"
293 }
294 }
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500295
Vince Lehman9f51efd2014-09-18 14:46:01 -0500296 ; cert-to-publish "root.cert" ; optional, a file containing the root certificate
297 ; Only the router that is designated to publish the root cert
298 ; needs to specify this
299
300 ; cert-to-publish "site.cert" ; optional, a file containing the site certificate
301 ; Only the router that is designated to publish the site cert
302 ; needs to specify this
303
304 ; cert-to-publish "operator.cert" ; optional, a file containing the operator certificate
305 ; Only the router that is designated to publish the operator
306 ; cert needs to specify this
307
akmhoque50125a92014-06-30 08:54:17 -0500308 cert-to-publish "router.cert" ; required, a file containing the router certificate.
akmhoque157b0a42014-05-13 00:26:37 -0500309}