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