blob: 9a081e42aeb55c4a1869f13e8ba272973c741b10 [file] [log] [blame]
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -06001; The general section contains settings of nfd process.
Steve DiBenedetto24b9a642014-04-07 15:45:39 -06002general
3{
4 ; Specify a user and/or group for NFD to drop privileges to
5 ; when not performing privileged tasks. NFD does not drop
6 ; privileges by default.
7
8 ; user ndn-user
9 ; group ndn-user
10}
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060011
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060012log
13{
14 ; default_level specifies the logging level for modules
15 ; that are not explicitly named. All debugging levels
16 ; listed above the selected value are enabled.
17 ;
18 ; Valid values:
19 ;
20 ; NONE ; no messages
21 ; ERROR ; error messages
22 ; WARN ; warning messages
23 ; INFO ; informational messages (default)
24 ; DEBUG ; debugging messages
25 ; TRACE ; trace messages (most verbose)
26 ; ALL ; all messages
27
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070028 default_level INFO
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060029
30 ; You may override default_level by assigning a logging level
31 ; to the desired module name. Module names can be found in two ways:
32 ;
33 ; Run:
34 ; nfd --modules
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -070035 ; nrd --modules
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060036 ;
37 ; Or look for NFD_LOG_INIT(<module name>) statements in .cpp files
38 ;
39 ; Example module-level settings:
40 ;
41 ; FibManager DEBUG
42 ; Forwarder INFO
43}
44
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060045; The face_system section defines what faces and channels are created.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060046face_system
47{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060048 ; The unix section contains settings of UNIX stream faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060049 unix
50 {
51 listen yes ; set to 'no' to disable UNIX stream listener, default 'yes'
52 path /var/run/nfd.sock ; UNIX stream listener path
53 }
54
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060055 ; The tcp section contains settings of TCP faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060056 tcp
57 {
58 listen yes ; set to 'no' to disable TCP listener, default 'yes'
59 port 6363 ; TCP listener port number
Steve DiBenedetto95152872014-04-11 12:40:59 -060060 enable_v4 yes ; set to 'no' to disable IPv4 channels, default 'yes'
61 enable_v6 yes ; set to 'no' to disable IPv6 channels, default 'yes'
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060062 }
63
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060064 ; The udp section contains settings of UDP faces and channels.
Steve DiBenedetto95152872014-04-11 12:40:59 -060065 ; UDP channel is always listening; delete udp section to disable UDP
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060066 udp
67 {
68 port 6363 ; UDP unicast port number
Steve DiBenedetto95152872014-04-11 12:40:59 -060069 enable_v4 yes ; set to 'no' to disable IPv4 channels, default 'yes'
70 enable_v6 yes ; set to 'no' to disable IPv6 channels, default 'yes'
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060071 idle_timeout 600 ; idle time (seconds) before closing a UDP unicast face
72 keep_alive_interval 25; interval (seconds) between keep-alive refreshes
73
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070074 ; UDP multicast settings
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060075 ; NFD creates one UDP multicast face per NIC
Giulio Grassi6d7176d2014-04-16 16:08:48 +020076 ;
77 ; In multi-homed Linux machines these settings will NOT work without
78 ; root or settings the appropriate permissions:
79 ;
80 ; sudo setcap cap_net_raw=eip /full/path/nfd
81 ;
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070082 mcast yes ; set to 'no' to disable UDP multicast, default 'yes'
83 mcast_port 56363 ; UDP multicast port number
84 mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only)
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060085 }
86
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060087 ; The ether section contains settings of Ethernet faces and channels.
88 ; These settings will NOT work without root or setting the appropriate
89 ; permissions:
90 ;
91 ; sudo setcap cap_net_raw,cap_net_admin=eip /full/path/nfd
92 ;
93 ; You may need to install a package to use setcap:
94 ;
95 ; **Ubuntu:**
96 ;
97 ; sudo apt-get install libcap2-bin
98 ;
99 ; **Mac OS X:**
100 ;
101 ; curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz
102 ; tar zxvf ChmodBPF.tar.gz
103 ; open ChmodBPF/Install\ ChmodBPF.app
104 ;
105 ; or manually:
106 ;
107 ; sudo chgrp admin /dev/bpf*
108 ; sudo chmod g+rw /dev/bpf*
109
Alexander Afanasyev885a85b2014-04-12 21:01:13 -0700110 @IF_HAVE_LIBPCAP@ether
111 @IF_HAVE_LIBPCAP@{
112 @IF_HAVE_LIBPCAP@ ; Ethernet multicast settings
113 @IF_HAVE_LIBPCAP@ ; NFD creates one Ethernet multicast face per NIC
114 @IF_HAVE_LIBPCAP@
115 @IF_HAVE_LIBPCAP@ mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes'
116 @IF_HAVE_LIBPCAP@ mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group
117 @IF_HAVE_LIBPCAP@}
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600118}
119
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600120; The authorizations section grants privileges to authorized keys.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600121authorizations
122{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600123 ; An authorize section grants privileges to a NDN certificate.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600124 authorize
125 {
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600126 ; If you do not already have NDN certificate, you can generate
127 ; one with the following commands.
128 ;
129 ; 1. Generate and install a self-signed identity certificate:
130 ;
131 ; ndnsec-keygen /`whoami` | ndnsec-install-cert -
132 ;
133 ; Note that the argument to ndnsec-key will be the identity name of the
134 ; new key (in this case, /your-username). Identities are hierarchical NDN
135 ; names and may have multiple components (e.g. `/ndn/ucla/edu/alice`).
136 ; You may create additional keys and identities as you see fit.
137 ;
138 ; 2. Dump the NDN certificate to a file:
139 ;
140 ; sudo mkdir -p @SYSCONFDIR@/ndn/keys/
141 ; ndnsec-cert-dump -i /`whoami` > default.ndncert
142 ; sudo mv default.ndncert @SYSCONFDIR@/ndn/keys/default.ndncert
143 ;
144 ; The "certfile" field below specifies the default key directory for
145 ; your machine. You may move your newly created key to the location it
146 ; specifies or path.
147
Yingdi Yuc8f214c2014-04-29 20:39:37 -0700148 ; certfile keys/default.ndncert ; NDN identity certificate file
149 certfile any ; "any" authorizes command interests signed under any certificate,
150 ; i.e., no actual validation.
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600151 privileges ; set of privileges granted to this identity
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600152 {
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600153 faces
154 fib
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600155 strategy-choice
156 }
157 }
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600158
159 ; You may have multiple authorize sections that specify additional
160 ; certificates and their privileges.
161
Alexander Afanasyev885a85b2014-04-12 21:01:13 -0700162 ; authorize
163 ; {
164 ; certfile keys/this_cert_does_not_exist.ndncert
165 ; authorize
166 ; privileges
167 ; {
168 ; faces
169 ; }
170 ; }
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600171}
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700172
Yingdi Yue5224e92014-04-29 18:04:02 -0700173rib
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700174{
Yingdi Yue5224e92014-04-29 18:04:02 -0700175 ; The following localhost_security allows anyone to register routing entries in local RIB
176 localhost_security
177 {
178 trust-anchor
179 {
180 type any
181 }
182 }
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700183
Yingdi Yue5224e92014-04-29 18:04:02 -0700184 ; localhop_security should be enabled when NFD runs on a hub.
185 ; "/localhop/nfd/fib" command prefix will be disabled when localhop_security section is missing.
186 ; localhop_security
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700187 ; {
Yingdi Yue5224e92014-04-29 18:04:02 -0700188 ; ; This section defines the trust model for NFD RIB Management. It consists of rules and
189 ; ; trust-anchors, which are briefly defined in this file. For more information refer to
190 ; ; manpage of ndn-validator.conf:
191 ; ;
192 ; ; man ndn-validator.conf
193 ; ;
194 ; ; A trust-anchor is a pre-trusted certificate. This can be any certificate that is the
195 ; ; root of certification chain (e.g., NDN testbed root certificate) or an existing
196 ; ; default system certificate `default.ndncert`.
197 ; ;
198 ; ; A rule defines conditions a valid packet MUST have. A packet must satisfy one of the
199 ; ; rules defined here. A rule can be broken into two parts: matching & checking. A packet
200 ; ; will be matched against rules from the first to the last until a matched rule is
201 ; ; encountered. The matched rule will be used to check the packet. If a packet does not
202 ; ; match any rule, it will be treated as invalid. The matching part of a rule consists
203 ; ; of `for` and `filter` sections. They collectively define which packets can be checked
204 ; ; with this rule. `for` defines packet type (data or interest) and `filter` defines
205 ; ; conditions on other properties of a packet. Right now, you can only define conditions
206 ; ; on packet name, and you can only specify ONLY ONE filter for packet name. The
207 ; ; checking part of a rule consists of `checker`, which defines the conditions that a
208 ; ; VALID packet MUST have. See comments in checker section for more details.
209 ;
210 ; rule
211 ; {
212 ; id "NRD Prefix Registration Command Rule"
213 ; for interest ; rule for Interests (to validate CommandInterests)
214 ; filter
215 ; {
216 ; type name ; condition on interest name (w/o signature)
217 ; regex ^[<localhop><localhost>]<nfd><rib>[<register><unregister>]<>{3}$
218 ; }
219 ; checker
220 ; {
221 ; type customized
222 ; sig-type rsa-sha256 ; interest must have a rsa-sha256 signature
223 ; key-locator
224 ; {
225 ; type name ; key locator must be the certificate name of the
226 ; ; signing key
227 ; regex ^[^<KEY>]*<KEY><>*<ksk-.*><ID-CERT>$
228 ; }
229 ; }
230 ; }
231 ; rule
232 ; {
233 ; id "NDN Testbed Hierarchy Rule"
234 ; for data ; rule for Data (to validate NDN certificates)
235 ; filter
236 ; {
237 ; type name ; condition on data name
238 ; regex ^[^<KEY>]*<KEY><>*<ksk-.*><ID-CERT><>$
239 ; }
240 ; checker
241 ; {
242 ; type hierarchical ; the certificate name of the signing key and
243 ; ; the data name must follow the hierarchical model
244 ; sig-type rsa-sha256 ; data must have a rsa-sha256 signature
245 ; }
246 ; }
247 ; trust-anchor
248 ; {
249 ; type file
250 ; file-name keys/default.ndncert ; the file name, by default this file should be placed in the
251 ; ; same folder as this config file.
252 ; }
253 ; ; trust-anchor ; Can be repeated multiple times to specify multiple trust anchors
254 ; ; {
255 ; ; type file
256 ; ; file-name keys/ndn-testbed.ndncert
257 ; ; }
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700258 ; }
259}