blob: 752dc441bddd8c7aae1720171feb889a84882221 [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
Ashlesh Gawande30d96e42021-03-21 19:15:33 -070031; the neighbors section contains the configuration for router's neighbors and hello protocol 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
Ashlesh Gawande6b388fc2019-09-30 10:14:41 -050041 hello-timeout 1 ; interest time out value in seconds. Default value 1
akmhoque157b0a42014-05-13 00:26:37 -050042 ; 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
Ashlesh Gawande6b388fc2019-09-30 10:14:41 -050050 adj-lsa-build-interval 10 ; default value 10. Valid values 5-30.
Vince Lehman7b616582014-10-17 16:25:39 -050051
Nick Gordond5c1a372016-10-31 13:56:23 -050052 face-dataset-fetch-tries 3 ; default is 3. Valid values 1-10. The FaceDataset is
53 ; gotten from NFD, and is needed to configure NLSR
54 ; correctly. It is recommended not to set this
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -050055 ; variable too high, because it could cause
Nick Gordond5c1a372016-10-31 13:56:23 -050056 ; congestion for NFD.
57
58 face-dataset-fetch-interval 3600 ; default is 3600. Valid values 1800-5400.
59 ; This controls how often (in seconds) NLSR will attempt to
60 ; fetch a FaceStatus dataset from NFD.
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
Junxiao Shif09e2632015-01-02 18:15:01 -070093 ; calculation which turns link state routing 'off'. set value to 'dry-run'
Alexander Afanasyev8388ec62014-08-16 18:38:57 -070094 ; 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
Muktadir R Chowdhuryb00dc2a2016-11-05 10:48:58 -060098 angle 1.45,2.36 ; angle of the router in hyperbolic coordinate system
akmhoque157b0a42014-05-13 00:26:37 -050099}
100
101
Nick Gordond5c1a372016-10-31 13:56:23 -0500102; the fib section is used to configure fib entrys type to ndn FIB updated by NLSR
akmhoque157b0a42014-05-13 00:26:37 -0500103
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 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000137 id "NLSR Hello Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700138 for data
139 filter
140 {
141 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500142 regex ^[^<nlsr><INFO>]*<nlsr><INFO><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700143 }
144 checker
145 {
146 type customized
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700147 sig-type ecdsa-sha256
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700148 key-locator
149 {
150 type name
151 hyper-relation
152 {
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500153 k-regex ^([^<KEY><nlsr>]*)<nlsr><KEY><>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700154 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700155 h-relation equal
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -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 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000165 id "NLSR LSA Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700166 for data
167 filter
168 {
169 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500170 regex ^[^<nlsr><LSA>]*<nlsr><LSA>
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700171 }
172 checker
173 {
174 type customized
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700175 sig-type ecdsa-sha256
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700176 key-locator
177 {
178 type name
179 hyper-relation
180 {
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500181 k-regex ^([^<KEY><nlsr>]*)<nlsr><KEY><>$
Yingdi Yu6a3a4dd2014-06-20 14:10:39 -0700182 k-expand \\1
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700183 h-relation equal
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -0500184 ; the last four components in the prefix should be <lsaType><seqNo><version><segmentNo>
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500185 p-regex ^<localhop>([^<nlsr><LSA>]*)<nlsr><LSA>(<>*)<><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700186 p-expand \\1\\2
187 }
188 }
189 }
190 }
191
192 rule
193 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000194 id "NLSR Hierarchy Exception Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700195 for data
196 filter
197 {
198 type name
Ashlesh Gawandecba0ae22018-03-27 17:57:56 -0500199 regex ^[^<KEY><%C1.Router>]*<%C1.Router>[^<KEY><nlsr>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700200 }
201 checker
202 {
203 type customized
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700204 sig-type ecdsa-sha256
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700205 key-locator
206 {
207 type name
208 hyper-relation
209 {
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500210 k-regex ^([^<KEY><%C1.Operator>]*)<%C1.Operator>[^<KEY>]*<KEY><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700211 k-expand \\1
212 h-relation equal
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500213 p-regex ^([^<KEY><%C1.Router>]*)<%C1.Router>[^<KEY>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700214 p-expand \\1
215 }
216 }
217 }
218 }
219
220 rule
221 {
Laqin Fand8c9d8c2017-01-18 21:45:14 +0000222 id "NLSR Hierarchical Rule"
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700223 for data
224 filter
225 {
226 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500227 regex ^[^<KEY>]*<KEY><><><>$
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700228 }
229 checker
230 {
231 type hierarchical
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700232 sig-type ecdsa-sha256
Yingdi Yu20e3a6e2014-05-26 23:16:10 -0700233 }
234 }
235
236 trust-anchor
237 {
238 type file
239 file-name "root.cert"
240 }
241 }
alvy297f4162015-03-03 17:15:33 -0600242
243 prefix-update-validator
244 {
245 rule
246 {
247 id "NLSR ControlCommand Rule"
248 for interest
249 filter
250 {
251 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500252 ; /<prefix>/<management-module>/<command-verb>/<control-parameters>
253 ; /<timestamp>/<random-value>/<signed-interests-components>
254 regex ^<localhost><nlsr><prefix-update>[<advertise><withdraw>]<><><>$
alvy297f4162015-03-03 17:15:33 -0600255 }
256 checker
257 {
258 type customized
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700259 sig-type ecdsa-sha256
alvy297f4162015-03-03 17:15:33 -0600260 key-locator
261 {
262 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500263 regex ^([^<KEY><%C1.Operator>]*)<%C1.Operator>[^<KEY>]*<KEY><>$
alvy297f4162015-03-03 17:15:33 -0600264 }
265 }
266 }
267
268 rule
269 {
270 id "NLSR Hierarchy Rule"
271 for data
272 filter
273 {
274 type name
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500275 regex ^[^<KEY>]*<KEY><><><>$
alvy297f4162015-03-03 17:15:33 -0600276 }
277 checker
278 {
279 type hierarchical
Ashlesh Gawande30d96e42021-03-21 19:15:33 -0700280 sig-type ecdsa-sha256
alvy297f4162015-03-03 17:15:33 -0600281 }
282 }
283
284 trust-anchor
285 {
286 type file
287 file-name "site.cert"
288 }
289 }
Muktadir Chowdhuryf04f9892017-08-20 20:42:56 -0500290
Vince Lehman9f51efd2014-09-18 14:46:01 -0500291 ; cert-to-publish "root.cert" ; optional, a file containing the root certificate
292 ; Only the router that is designated to publish the root cert
293 ; needs to specify this
294
295 ; cert-to-publish "site.cert" ; optional, a file containing the site certificate
296 ; Only the router that is designated to publish the site cert
297 ; needs to specify this
298
299 ; cert-to-publish "operator.cert" ; optional, a file containing the operator certificate
300 ; Only the router that is designated to publish the operator
301 ; cert needs to specify this
302
akmhoque50125a92014-06-30 08:54:17 -0500303 cert-to-publish "router.cert" ; required, a file containing the router certificate.
akmhoque157b0a42014-05-13 00:26:37 -0500304}