-fix leak
[oweals/gnunet.git] / README
1 ======================================================================
2
3 THIS SVN VERSION OF GNUNET IS INCOMPATIBLE TO ALL PREVIOUS RELEASES.
4 WE ARE WORKING ON CHANGING FUNDAMENTAL PARTS OF THE CRYPTOGRAPHIC
5 PARTS OF THE SYSTEM.
6
7 You need to install libgcrypt from git master (1.6.0beta93 at least)
8 for the code to compile.
9
10 =======================================================================
11
12                        Welcome to GNUnet
13
14
15 What is GNUnet?
16 ===============
17
18 GNUnet is peer-to-peer framework focusing on security.  The first and
19 primary application for GNUnet is anonymous file-sharing.  GNUnet is
20 currently developed by a worldwide group of independent free software
21 developers.  GNUnet is a GNU package (http://www.gnu.org/).
22
23 This is an ALPHA release.  There are known and significant bugs as
24 well as many missing features in this release.
25
26 Additional documentation about GNUnet can be found at
27 https://gnunet.org/.
28
29
30 Dependencies:
31 =============
32
33 Please note that for many of its dependencies GNUnet requires very
34 recent versions of the libraries which are often NOT to be found in
35 stable distributions in 2011.  While using older packages may in some
36 cases on some operating systems may seem to work in some limited
37 fashion, we are in many cases aware of serious problems with older
38 packages.  Hence please make sure to use  the versions listed below.
39
40 These are the direct dependencies for running GNUnet:
41
42 - libextractor  >= 0.6.1
43 - libmicrohttpd >= 0.9.31
44 - libgcrypt     >= 1.2
45 - libgnurl      >= 7.33.0 (available from https://gnunet.org/gnurl)
46 - libunistring  >= 0.9.2
47 - gnutls        >= 3.2.5
48 - libidn        >= 1.0
49 - libglpk       >= 4.45
50 - openssl       >= 1.0 (binary, used to generate X.509 certificate)
51 - libltdl       >= 2.2 (part of GNU libtool)
52 - sqlite        >= 3.8 (default database, required)
53 - mysql         >= 5.1 (alternative to sqlite)
54 - postgres      >= 8.3 (alternative to sqlite)
55 - libopus       >= 0.9.14 (optional for experimental conversation tool)
56 - libpulse      >= 2.0 (optional for experimental conversation tool)
57
58 Recommended autotools for compiling the SVN version are:
59 - autoconf >= 2.59
60 - automake >= 1.11.1
61 - libtool  >= 2.2
62
63
64 How to install?
65 ===============
66
67 The fastest way is to use a binary package if it is available for your
68 system.  For a more detailed description, read the installation
69 instructions on the webpage at https://gnunet.org/installation.
70
71 Note that some functions of GNUnet require "root" access.  GNUnet will
72 install (tiny) SUID binaries for those functions is you run "make
73 install" as root.  If you do not, GNUnet will still work, but some
74 functionality will not be available (including certain forms of NAT
75 traversal).
76
77 GNUnet requires the GNU MP library (http://www.gnu.org/software/gmp/)
78 and libgcrypt (http://www.gnupg.org/).  You can specify the path to
79 libgcrypt by passing "--with-gcrypt=PATH" to configure.  You will also
80 need either sqlite (http://www.sqlite.org/), MySQL
81 (http://www.mysql.org/) or PostGres (http://www.postgres.org/).
82
83 If you install from source, you need to install GNU libextractor first
84 (download from http://www.gnu.org/software/libextractor/).  We also
85 recommend installing GNU libmicrohttpd (download from
86 http://www.gnu.org/software/libmicrohttpd/).  Then you can start the
87 actual GNUnet compilation and installation process with:
88
89 $ export GNUNET_PREFIX=/usr/local # or other directory of your choice
90 # addgroup gnunetdns
91 # adduser gnunet gnunet
92 # ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
93 $ make
94 # make install
95 # sudo -u gnunet gnunet-arm -s
96
97 Note that running the 'configure' and 'make install' steps as
98 root (or with sudo) is required as some parts of the installation
99 require the creation of SUID binaries.  The installation will
100 work if you do not run these steps as root, but some components
101 may not be installed in the perfect place or with the right
102 permissions and thus won't work.
103
104 This will create the users and groups needed for running GNUnet
105 securely and then compile and install GNUnet to $GNUNET_PREFIX/bin/,
106 $GNUNET_PREFIX/lib/ and $GNUNET_PREFIX/share/ and start the system
107 with the default configuration.  It is strongly recommended that you
108 add a user "gnunet" to run "gnunet-arm".  You can then still run the
109 end-user applications as another user.
110
111 If you create a system user "gnunet", it is recommended that you edit
112 the configuration file slightly so that data can be stored in the
113 system user home directory at "/var/lib/gnunet".  Depending on what
114 the $HOME-directory of your "gnunet" user is, you might need to set
115 the SERVICEHOME option in section "[PATHS]" to "/var/lib/gnunet" to
116 do this.  Depending on your personal preferences, you may also want to
117 use "/etc/gnunet.conf" for the location of the configuration file in
118 this case (instead of ~gnunet/.config/gnunet.conf").  In this case,
119 you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf" or
120 set "XDG_CONFIG_HOME=/etc/".
121
122 You can avoid running 'make install' as root if you run configure
123 with the "--with-sudo=yes" option and have extensive sudo rights
124 (can run "chmod +s" and "chown" via 'sudo').  If you run 'make install'
125 as a normal user without sudo rights (or the configure option),
126 certain binaries that require additional priviledges will not be
127 installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and
128 the VPN will then not work).
129
130 If you run 'configure' and 'make install' as root or use the SUDO
131 option, GNUnet's build system will install "libnss_gns*" libraries to
132 "/lib/" regardless (!) of the $GNUNET_PREFIX you might have specified,
133 as those libraries must be in "/lib/".  If you are packaging GNUnet
134 for binary distribution, this may cause your packaging script to miss
135 those plugins, so you might need to do some additional manual work to
136 include those libraries in your binary package(s).  Similarly, if you
137 want to use the GNUnet naming system and did NOT run GNUnet's 'make
138 install' process with SUDO rights, the libraries will be installed to
139 "$GNUNET_PREFIX/lib" and you will have to move them to "/lib/"
140 manually.
141
142 Finally, if you are compiling the code from subversion, you have to
143 run ". bootstrap" before ./configure.  If you receive an error during
144 the running of ". bootstrap" that looks like "macro `AM_PATH_GTK' not
145 found in library", you may need to run aclocal by hand with the -I
146 option, pointing to your aclocal m4 macros, i.e.
147
148 $ aclocal -I /usr/local/share/aclocal
149
150
151 Configuration
152 =============
153
154 Note that additional, per-user configuration files can be created by
155 each user.  However, this is usually not necessary as there are few
156 per-user options that normal users would want to modify.  The defaults
157 that are shipped with the installation are usually just fine.
158
159 The gnunet-setup tool is particularly useful to generate the master
160 configuration for the peer.  gnunet-setup can be used to configure and
161 test (!) the network settings, choose which applications should be run
162 and configure databases.  Other options you might want to control
163 include system limitations (such as disk space consumption, bandwidth,
164 etc.).  The resulting configuration files are human-readable and can
165 theoretically be created or edited by hand.
166
167 gnunet-setup is a separate download and requires somewhat recent
168 versions of GTK+ and Glade. You can also create the configuration file
169 by hand, but this is not recommended.  For more general information
170 about the GNU build process read the INSTALL file.
171
172 GNUnet uses two types of configuration files, one that specifies the
173 system-wide defaults (typically located in
174 $GNUNET_PREFIX/share/gnunet/config.d/) and a second one that overrides
175 default values with user-specific preferences.  The user-specific
176 configuration file should be located in "~/.config/gnunet.conf" or its
177 location can be specified by giving the "-c" option to the respective
178 GNUnet application.
179
180
181 Usage
182 =====
183
184 First, you must obtain an initial list of GNUnet hosts.  Knowing a
185 single peer is sufficient since after that GNUnet propagates
186 information about other peers.  Note that the default configuration
187 contains URLs from where GNUnet downloads an initial hostlist
188 whenever it is started.  If you want to create an alternative URL for
189 others to use, the file can be generated on any machine running
190 GNUnet by periodically executing
191
192 $ cat $SERVICEHOME/data/hosts/* > the_file
193
194 and offering 'the_file' via your web server.  Alternatively, you can
195 run the build-in web server by adding '-p' to the OPTIONS value
196 in the "hostlist" section of gnunet.conf and opening the respective
197 HTTPPORT to the public.
198
199 If the solution with the hostlist URL is not feasible for your
200 situation, you can also add hosts manually.  Simply copy the hostkeys
201 to "$SERVICEHOME/data/hosts/" (where $SERVICEHOME is the directory
202 specified in the gnunet.conf configuration file).  You can also use
203 "gnunet-peerinfo -g" to GET a URI for a peer and "gnunet-peerinfo -p
204 URI" to add a URI from another peer.  Finally, GNUnet peers that use
205 UDP or WLAN will discover each other automatically (if they are in the
206 vicinity of each other) using broadcasts (IPv4/WLAN) or multicasts
207 (IPv6).
208
209 The local node is started using "gnunet-arm -s".  GNUnet should run
210 24/7 if you want to maximize your anonymity, as this makes partitioning
211 attacks harder.
212
213 Once your peer is running, you should then be able to access GNUnet
214 using the shell:
215
216 $ gnunet-search KEYWORD
217
218 This will display a list of results to the console.  You can abort
219 the command using "CTRL-C".  Then use
220
221 $ gnunet-download -o FILENAME GNUNET_URI
222
223 to retrieve a file.  The GNUNET_URI is printed by gnunet-search
224 together with a description.  To publish files on GNUnet, use the
225 "gnunet-publish" command.
226
227
228 The GTK user interface is shipped separately.  After downloading and
229 installing gnunet-gtk, you can invoke the setup tool and the
230 file-sharing GUI with:
231
232 $ gnunet-setup
233 $ gnunet-fs-gtk
234
235 For further documentation, see our webpage.
236
237
238 Hacking GNUnet
239 ==============
240
241 Contributions are welcome, please submit bugs to
242 https://gnunet.org/bugs/.  Please make sure to run contrib/report.sh
243 and include the output with your bug reports.  More about how to
244 report bugs can be found in the GNUnet FAQ on the webpage.  Submit
245 patches via E-Mail to gnunet-developers@gnu.org.
246
247 In order to run the unit tests with "make check", you need to
248 set an environment variable ("GNUNET_PREFIX") to the directory
249 where GNUnet is installed (usually, GNUnet will use OS specific
250 tricks in order to try to figure out the PREFIX, but since the
251 testcase binaries are not installed, that trick does not work
252 for them).  Also, before running any testcases, you must
253 complete the installation first.  Quick summary:
254
255 $ ./configure --prefix=$SOMEWHERE
256 $ make
257 $ make install
258 $ export GNUNET_PREFIX=$SOMEWHERE
259 $ make check
260
261 Some of the testcases require python >= 2.6 and pexpect to be
262 installed.  If any testcases fail to pass on your system, run
263 "contrib/report.sh" and report the output together with
264 information about the failing testcase to the Mantis bugtracking
265 system at https://gnunet.org/bugs/.
266
267
268 Running HTTP on port 80 and HTTPS on port 443
269 =============================================
270
271 In order to hide GNUnet's HTTP/HTTPS traffic perfectly, you might
272 consider running GNUnet's HTTP/HTTPS transport on port 80/443.
273 However, we do not recommend running GNUnet as root.  Instead, forward
274 port 80 to say 1080 with this command (as root, in your startup
275 scripts):
276
277 # iptables -t nat -A PREROUTING -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 1080
278
279 or for HTTPS
280
281 # iptables -t nat -A PREROUTING -p tcp -m tcp --dport 443 -j REDIRECT --to-ports 4433
282
283 Then set in the HTTP section of gnunet.conf the "ADVERTISED_PORT" to
284 "80" and "PORT" to 1080 and similarly in the HTTPS section the
285 "ADVERTISED_PORT" to "443" and "PORT" to 4433.
286
287 You can do the same trick for the TCP and UDP transports if you want
288 to map them to a priviledged port (from the point of view of the
289 network).  However, we are not aware of this providing any advantages
290 at this point.
291
292 If you are already running an HTTP or HTTPS server on port 80 (or 443),
293 you may be able to configure it as a "ReverseProxy".  Here, you tell
294 GNUnet that the externally visible URI is some sub-page on your website,
295 and GNUnet can then tunnel its traffic via your existing HTTP server.
296 This is particularly powerful if your existing server uses HTTPS, as
297 it makes it harder for an adversary to distinguish normal traffic to
298 your server from GNUnet traffic.  Finally, even if you just use HTTP,
299 you might benefit (!) from ISP's traffic shaping as opposed to being
300 throttled by ISPs that dislike P2P.  Details for configuring the
301 reverse proxy are documented on our website.
302
303
304 Stay tuned
305 ==========
306
307 * https://gnunet.org/
308 * https://gnunet.org/bugs/
309 * https://gnunet.org/svn/
310 * http://www.gnu.org/software/gnunet/
311 * http://mail.gnu.org/mailman/listinfo/gnunet-developers
312 * http://mail.gnu.org/mailman/listinfo/help-gnunet
313 * http://mail.gnu.org/mailman/listinfo/info-gnunet
314 * http://mail.gnu.org/mailman/listinfo/gnunet-svn