blob: b825cca1cb06d9595848b369d64d6d54b9c19dec [file] [log] [blame]
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -06001; The general section contains settings of nfd process.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -06002; general
3; {
4; }
5
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -06006log
7{
8 ; default_level specifies the logging level for modules
9 ; that are not explicitly named. All debugging levels
10 ; listed above the selected value are enabled.
11 ;
12 ; Valid values:
13 ;
14 ; NONE ; no messages
15 ; ERROR ; error messages
16 ; WARN ; warning messages
17 ; INFO ; informational messages (default)
18 ; DEBUG ; debugging messages
19 ; TRACE ; trace messages (most verbose)
20 ; ALL ; all messages
21
22 ; default_level INFO
23
24 ; You may override default_level by assigning a logging level
25 ; to the desired module name. Module names can be found in two ways:
26 ;
27 ; Run:
28 ; nfd --modules
29 ;
30 ; Or look for NFD_LOG_INIT(<module name>) statements in .cpp files
31 ;
32 ; Example module-level settings:
33 ;
34 ; FibManager DEBUG
35 ; Forwarder INFO
36}
37
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060038; The face_system section defines what faces and channels are created.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060039face_system
40{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060041 ; The unix section contains settings of UNIX stream faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060042 unix
43 {
44 listen yes ; set to 'no' to disable UNIX stream listener, default 'yes'
45 path /var/run/nfd.sock ; UNIX stream listener path
46 }
47
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060048 ; The tcp section contains settings of TCP faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060049 tcp
50 {
51 listen yes ; set to 'no' to disable TCP listener, default 'yes'
52 port 6363 ; TCP listener port number
53 }
54
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060055 ; The udp section contains settings of UDP faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060056 udp
57 {
58 port 6363 ; UDP unicast port number
59 idle_timeout 600 ; idle time (seconds) before closing a UDP unicast face
60 keep_alive_interval 25; interval (seconds) between keep-alive refreshes
61
Steve DiBenedetto791c46a2014-03-17 21:08:31 -060062 mcast yes
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060063
64 ; Example multicast settings
65 ; NFD creates one UDP multicast face per NIC
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060066
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060067 ; mcast yes ; set to 'no' to disable UDP multicast, default 'yes'
68 ; mcast_port 56363 ; UDP multicast port number
69 ; mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only)
70 }
71
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060072 ; The ether section contains settings of Ethernet faces and channels.
73 ; These settings will NOT work without root or setting the appropriate
74 ; permissions:
75 ;
76 ; sudo setcap cap_net_raw,cap_net_admin=eip /full/path/nfd
77 ;
78 ; You may need to install a package to use setcap:
79 ;
80 ; **Ubuntu:**
81 ;
82 ; sudo apt-get install libcap2-bin
83 ;
84 ; **Mac OS X:**
85 ;
86 ; curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz
87 ; tar zxvf ChmodBPF.tar.gz
88 ; open ChmodBPF/Install\ ChmodBPF.app
89 ;
90 ; or manually:
91 ;
92 ; sudo chgrp admin /dev/bpf*
93 ; sudo chmod g+rw /dev/bpf*
94
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060095 ether
96 {
Steve DiBenedetto791c46a2014-03-17 21:08:31 -060097 mcast yes
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060098
99 ; Example multicast settings
100 ; NFD creates one Ethernet multicast face per NIC
101 ;
102 ; mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes'
103 ; mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600104 }
105}
106
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600107; The authorizations section grants privileges to authorized keys.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600108authorizations
109{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600110 ; An authorize section grants privileges to a NDN certificate.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600111 authorize
112 {
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600113 ; If you do not already have NDN certificate, you can generate
114 ; one with the following commands.
115 ;
116 ; 1. Generate and install a self-signed identity certificate:
117 ;
118 ; ndnsec-keygen /`whoami` | ndnsec-install-cert -
119 ;
120 ; Note that the argument to ndnsec-key will be the identity name of the
121 ; new key (in this case, /your-username). Identities are hierarchical NDN
122 ; names and may have multiple components (e.g. `/ndn/ucla/edu/alice`).
123 ; You may create additional keys and identities as you see fit.
124 ;
125 ; 2. Dump the NDN certificate to a file:
126 ;
127 ; sudo mkdir -p @SYSCONFDIR@/ndn/keys/
128 ; ndnsec-cert-dump -i /`whoami` > default.ndncert
129 ; sudo mv default.ndncert @SYSCONFDIR@/ndn/keys/default.ndncert
130 ;
131 ; The "certfile" field below specifies the default key directory for
132 ; your machine. You may move your newly created key to the location it
133 ; specifies or path.
134
135 certfile keys/default.ndncert ; NDN identity certificate file
136 privileges ; set of privileges granted to this identity
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600137 {
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600138 faces
139 fib
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600140 strategy-choice
141 }
142 }
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600143
144 ; You may have multiple authorize sections that specify additional
145 ; certificates and their privileges.
146
147; authorize
148; {
149; certfile keys/this_cert_does_not_exist.ndncert
150; authorize
151; privileges
152; {
153; faces
154; }
155; }
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600156}