blob: 22aae5a575802ae917d4a21303d14e23c3d5202b [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
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060069
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070070 mcast yes ; set to 'no' to disable UDP multicast, default 'yes'
71 mcast_port 56363 ; UDP multicast port number
72 mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only)
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060073 }
74
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060075 ; The ether section contains settings of Ethernet faces and channels.
76 ; These settings will NOT work without root or setting the appropriate
77 ; permissions:
78 ;
79 ; sudo setcap cap_net_raw,cap_net_admin=eip /full/path/nfd
80 ;
81 ; You may need to install a package to use setcap:
82 ;
83 ; **Ubuntu:**
84 ;
85 ; sudo apt-get install libcap2-bin
86 ;
87 ; **Mac OS X:**
88 ;
89 ; curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz
90 ; tar zxvf ChmodBPF.tar.gz
91 ; open ChmodBPF/Install\ ChmodBPF.app
92 ;
93 ; or manually:
94 ;
95 ; sudo chgrp admin /dev/bpf*
96 ; sudo chmod g+rw /dev/bpf*
97
Alexander Afanasyev885a85b2014-04-12 21:01:13 -070098 @IF_HAVE_LIBPCAP@ether
99 @IF_HAVE_LIBPCAP@{
100 @IF_HAVE_LIBPCAP@ ; Ethernet multicast settings
101 @IF_HAVE_LIBPCAP@ ; NFD creates one Ethernet multicast face per NIC
102 @IF_HAVE_LIBPCAP@
103 @IF_HAVE_LIBPCAP@ mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes'
104 @IF_HAVE_LIBPCAP@ mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group
105 @IF_HAVE_LIBPCAP@}
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600106}
107
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600108; The authorizations section grants privileges to authorized keys.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600109authorizations
110{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600111 ; An authorize section grants privileges to a NDN certificate.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600112 authorize
113 {
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600114 ; If you do not already have NDN certificate, you can generate
115 ; one with the following commands.
116 ;
117 ; 1. Generate and install a self-signed identity certificate:
118 ;
119 ; ndnsec-keygen /`whoami` | ndnsec-install-cert -
120 ;
121 ; Note that the argument to ndnsec-key will be the identity name of the
122 ; new key (in this case, /your-username). Identities are hierarchical NDN
123 ; names and may have multiple components (e.g. `/ndn/ucla/edu/alice`).
124 ; You may create additional keys and identities as you see fit.
125 ;
126 ; 2. Dump the NDN certificate to a file:
127 ;
128 ; sudo mkdir -p @SYSCONFDIR@/ndn/keys/
129 ; ndnsec-cert-dump -i /`whoami` > default.ndncert
130 ; sudo mv default.ndncert @SYSCONFDIR@/ndn/keys/default.ndncert
131 ;
132 ; The "certfile" field below specifies the default key directory for
133 ; your machine. You may move your newly created key to the location it
134 ; specifies or path.
135
136 certfile keys/default.ndncert ; NDN identity certificate file
137 privileges ; set of privileges granted to this identity
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600138 {
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600139 faces
140 fib
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600141 strategy-choice
142 }
143 }
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600144
145 ; You may have multiple authorize sections that specify additional
146 ; certificates and their privileges.
147
Alexander Afanasyev885a85b2014-04-12 21:01:13 -0700148 ; authorize
149 ; {
150 ; certfile keys/this_cert_does_not_exist.ndncert
151 ; authorize
152 ; privileges
153 ; {
154 ; faces
155 ; }
156 ; }
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600157}