Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 1 | ; The general section contains settings of nfd process. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 2 | ; general |
| 3 | ; { |
| 4 | ; } |
| 5 | |
Steve DiBenedetto | bf6a93d | 2014-03-21 14:03:02 -0600 | [diff] [blame] | 6 | log |
| 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 DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 38 | ; The face_system section defines what faces and channels are created. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 39 | face_system |
| 40 | { |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 41 | ; The unix section contains settings of UNIX stream faces and channels. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 42 | 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 DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 48 | ; The tcp section contains settings of TCP faces and channels. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 49 | tcp |
| 50 | { |
| 51 | listen yes ; set to 'no' to disable TCP listener, default 'yes' |
| 52 | port 6363 ; TCP listener port number |
Steve DiBenedetto | 9515287 | 2014-04-11 12:40:59 -0600 | [diff] [blame] | 53 | 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 DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 55 | } |
| 56 | |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 57 | ; The udp section contains settings of UDP faces and channels. |
Steve DiBenedetto | 9515287 | 2014-04-11 12:40:59 -0600 | [diff] [blame] | 58 | ; UDP channel is always listening; delete udp section to disable UDP |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 59 | udp |
| 60 | { |
| 61 | port 6363 ; UDP unicast port number |
Steve DiBenedetto | 9515287 | 2014-04-11 12:40:59 -0600 | [diff] [blame] | 62 | 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 DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 64 | idle_timeout 600 ; idle time (seconds) before closing a UDP unicast face |
| 65 | keep_alive_interval 25; interval (seconds) between keep-alive refreshes |
| 66 | |
Steve DiBenedetto | 791c46a | 2014-03-17 21:08:31 -0600 | [diff] [blame] | 67 | mcast yes |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 68 | |
| 69 | ; Example multicast settings |
| 70 | ; NFD creates one UDP multicast face per NIC |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 71 | |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 72 | ; mcast yes ; set to 'no' to disable UDP multicast, default 'yes' |
| 73 | ; mcast_port 56363 ; UDP multicast port number |
| 74 | ; mcast_group 224.0.23.170 ; UDP multicast group (IPv4 only) |
| 75 | } |
| 76 | |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 77 | ; The ether section contains settings of Ethernet faces and channels. |
| 78 | ; These settings will NOT work without root or setting the appropriate |
| 79 | ; permissions: |
| 80 | ; |
| 81 | ; sudo setcap cap_net_raw,cap_net_admin=eip /full/path/nfd |
| 82 | ; |
| 83 | ; You may need to install a package to use setcap: |
| 84 | ; |
| 85 | ; **Ubuntu:** |
| 86 | ; |
| 87 | ; sudo apt-get install libcap2-bin |
| 88 | ; |
| 89 | ; **Mac OS X:** |
| 90 | ; |
| 91 | ; curl https://bugs.wireshark.org/bugzilla/attachment.cgi?id=3373 -o ChmodBPF.tar.gz |
| 92 | ; tar zxvf ChmodBPF.tar.gz |
| 93 | ; open ChmodBPF/Install\ ChmodBPF.app |
| 94 | ; |
| 95 | ; or manually: |
| 96 | ; |
| 97 | ; sudo chgrp admin /dev/bpf* |
| 98 | ; sudo chmod g+rw /dev/bpf* |
| 99 | |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 100 | ether |
| 101 | { |
Steve DiBenedetto | 791c46a | 2014-03-17 21:08:31 -0600 | [diff] [blame] | 102 | mcast yes |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 103 | |
| 104 | ; Example multicast settings |
| 105 | ; NFD creates one Ethernet multicast face per NIC |
| 106 | ; |
| 107 | ; mcast yes ; set to 'no' to disable Ethernet multicast, default 'yes' |
| 108 | ; mcast_group 01:00:5E:00:17:AA ; Ethernet multicast group |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 109 | } |
| 110 | } |
| 111 | |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 112 | ; The authorizations section grants privileges to authorized keys. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 113 | authorizations |
| 114 | { |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 115 | ; An authorize section grants privileges to a NDN certificate. |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 116 | authorize |
| 117 | { |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 118 | ; If you do not already have NDN certificate, you can generate |
| 119 | ; one with the following commands. |
| 120 | ; |
| 121 | ; 1. Generate and install a self-signed identity certificate: |
| 122 | ; |
| 123 | ; ndnsec-keygen /`whoami` | ndnsec-install-cert - |
| 124 | ; |
| 125 | ; Note that the argument to ndnsec-key will be the identity name of the |
| 126 | ; new key (in this case, /your-username). Identities are hierarchical NDN |
| 127 | ; names and may have multiple components (e.g. `/ndn/ucla/edu/alice`). |
| 128 | ; You may create additional keys and identities as you see fit. |
| 129 | ; |
| 130 | ; 2. Dump the NDN certificate to a file: |
| 131 | ; |
| 132 | ; sudo mkdir -p @SYSCONFDIR@/ndn/keys/ |
| 133 | ; ndnsec-cert-dump -i /`whoami` > default.ndncert |
| 134 | ; sudo mv default.ndncert @SYSCONFDIR@/ndn/keys/default.ndncert |
| 135 | ; |
| 136 | ; The "certfile" field below specifies the default key directory for |
| 137 | ; your machine. You may move your newly created key to the location it |
| 138 | ; specifies or path. |
| 139 | |
| 140 | certfile keys/default.ndncert ; NDN identity certificate file |
| 141 | privileges ; set of privileges granted to this identity |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 142 | { |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 143 | faces |
| 144 | fib |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 145 | strategy-choice |
| 146 | } |
| 147 | } |
Steve DiBenedetto | 1a3c673 | 2014-03-13 06:44:05 -0600 | [diff] [blame] | 148 | |
| 149 | ; You may have multiple authorize sections that specify additional |
| 150 | ; certificates and their privileges. |
| 151 | |
| 152 | ; authorize |
| 153 | ; { |
| 154 | ; certfile keys/this_cert_does_not_exist.ndncert |
| 155 | ; authorize |
| 156 | ; privileges |
| 157 | ; { |
| 158 | ; faces |
| 159 | ; } |
| 160 | ; } |
Steve DiBenedetto | 84da5bf | 2014-03-11 14:51:29 -0600 | [diff] [blame] | 161 | } |