blob: c915202b6ee84b397b05934ba4b0713ed44e9bc8 [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 DiBenedetto1a3c6732014-03-13 06:44:05 -06006; The face_system section defines what faces and channels are created.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -06007face_system
8{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -06009 ; The unix section contains settings of UNIX stream faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060010 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 DiBenedetto1a3c6732014-03-13 06:44:05 -060016 ; The tcp section contains settings of TCP faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060017 tcp
18 {
19 listen yes ; set to 'no' to disable TCP listener, default 'yes'
20 port 6363 ; TCP listener port number
21 }
22
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060023 ; The udp section contains settings of UDP faces and channels.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060024 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
30 mcast no
31
32 ; Example multicast settings
33 ; NFD creates one UDP multicast face per NIC
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060034
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060035 ; 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 DiBenedetto1a3c6732014-03-13 06:44:05 -060040 ; 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 DiBenedetto84da5bf2014-03-11 14:51:29 -060063 ether
64 {
65 mcast no
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060066
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 DiBenedetto84da5bf2014-03-11 14:51:29 -060072 }
73}
74
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060075; The authorizations section grants privileges to authorized keys.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060076authorizations
77{
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060078 ; An authorize section grants privileges to a NDN certificate.
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -060079 authorize
80 {
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -060081 ; 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 DiBenedetto84da5bf2014-03-11 14:51:29 -0600105 {
106 control-header
107 faces
108 fib
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600109 strategy-choice
110 }
111 }
Steve DiBenedetto1a3c6732014-03-13 06:44:05 -0600112
113 ; You may have multiple authorize sections that specify additional
114 ; certificates and their privileges.
115
116; authorize
117; {
118; certfile keys/this_cert_does_not_exist.ndncert
119; authorize
120; privileges
121; {
122; faces
123; }
124; }
Steve DiBenedetto84da5bf2014-03-11 14:51:29 -0600125}