blob: ace10e1a3a328a93b82528fff7e7fafdfb81a610 [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
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070022 default_level INFO
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060023
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
Steve DiBenedetto95152872014-04-11 12:40:59 -060053 enable_v4 yes ; set to 'no' to disable IPv4 channels, default 'yes'
54 enable_v6 yes ; set to 'no' to disable IPv6 channels, default 'yes'
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060055 }
56
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060057 ; The udp section contains settings of UDP faces and channels.
Steve DiBenedetto95152872014-04-11 12:40:59 -060058 ; UDP channel is always listening; delete udp section to disable UDP
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060059 udp
60 {
61 port 6363 ; UDP unicast port number
Steve DiBenedetto95152872014-04-11 12:40:59 -060062 enable_v4 yes ; set to 'no' to disable IPv4 channels, default 'yes'
63 enable_v6 yes ; set to 'no' to disable IPv6 channels, default 'yes'
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060064 idle_timeout 600 ; idle time (seconds) before closing a UDP unicast face
65 keep_alive_interval 25; interval (seconds) between keep-alive refreshes
66
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070067 ; UDP multicast settings
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060068 ; NFD creates one UDP multicast face per NIC
Giulio Grassi6d7176d2014-04-16 16:08:48 +020069 ;
70 ; In multi-homed Linux machines these settings will NOT work without
71 ; root or settings the appropriate permissions:
72 ;
73 ; sudo setcap cap_net_raw=eip /full/path/nfd
74 ;
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070075 mcast yes ; set to 'no' to disable UDP multicast, default 'yes'
76 mcast_port 56363 ; UDP multicast port number
77 mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only)
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060078 }
79
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060080 ; The ether section contains settings of Ethernet faces and channels.
81 ; These settings will NOT work without root or setting the appropriate
82 ; permissions:
83 ;
84 ; sudo setcap cap_net_raw,cap_net_admin=eip /full/path/nfd
85 ;
86 ; You may need to install a package to use setcap:
87 ;
88 ; **Ubuntu:**
89 ;
90 ; sudo apt-get install libcap2-bin
91 ;
92 ; **Mac OS X:**
93 ;
94 ; curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz
95 ; tar zxvf ChmodBPF.tar.gz
96 ; open ChmodBPF/Install\ ChmodBPF.app
97 ;
98 ; or manually:
99 ;
100 ; sudo chgrp admin /dev/bpf*
101 ; sudo chmod g+rw /dev/bpf*
102
Alexander Afanasyev885a85b2014-04-12 21:01:13 -0700103 @IF_HAVE_LIBPCAP@ether
104 @IF_HAVE_LIBPCAP@{
105 @IF_HAVE_LIBPCAP@ ; Ethernet multicast settings
106 @IF_HAVE_LIBPCAP@ ; NFD creates one Ethernet multicast face per NIC
107 @IF_HAVE_LIBPCAP@
108 @IF_HAVE_LIBPCAP@ mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes'
109 @IF_HAVE_LIBPCAP@ mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group
110 @IF_HAVE_LIBPCAP@}
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600111}
112
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600113; The authorizations section grants privileges to authorized keys.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600114authorizations
115{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600116 ; An authorize section grants privileges to a NDN certificate.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600117 authorize
118 {
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600119 ; If you do not already have NDN certificate, you can generate
120 ; one with the following commands.
121 ;
122 ; 1. Generate and install a self-signed identity certificate:
123 ;
124 ; ndnsec-keygen /`whoami` | ndnsec-install-cert -
125 ;
126 ; Note that the argument to ndnsec-key will be the identity name of the
127 ; new key (in this case, /your-username). Identities are hierarchical NDN
128 ; names and may have multiple components (e.g. `/ndn/ucla/edu/alice`).
129 ; You may create additional keys and identities as you see fit.
130 ;
131 ; 2. Dump the NDN certificate to a file:
132 ;
133 ; sudo mkdir -p @SYSCONFDIR@/ndn/keys/
134 ; ndnsec-cert-dump -i /`whoami` > default.ndncert
135 ; sudo mv default.ndncert @SYSCONFDIR@/ndn/keys/default.ndncert
136 ;
137 ; The "certfile" field below specifies the default key directory for
138 ; your machine. You may move your newly created key to the location it
139 ; specifies or path.
140
141 certfile keys/default.ndncert ; NDN identity certificate file
142 privileges ; set of privileges granted to this identity
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600143 {
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600144 faces
145 fib
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600146 strategy-choice
147 }
148 }
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600149
150 ; You may have multiple authorize sections that specify additional
151 ; certificates and their privileges.
152
Alexander Afanasyev885a85b2014-04-12 21:01:13 -0700153 ; authorize
154 ; {
155 ; certfile keys/this_cert_does_not_exist.ndncert
156 ; authorize
157 ; privileges
158 ; {
159 ; faces
160 ; }
161 ; }
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600162}