aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation/chapters
diff options
context:
space:
mode:
Diffstat (limited to 'doc/documentation/chapters')
-rw-r--r--doc/documentation/chapters/contributing.texi25
-rw-r--r--doc/documentation/chapters/developer.texi13
-rw-r--r--doc/documentation/chapters/installation.texi129
-rw-r--r--doc/documentation/chapters/preface.texi67
-rw-r--r--doc/documentation/chapters/user.texi364
5 files changed, 464 insertions, 134 deletions
diff --git a/doc/documentation/chapters/contributing.texi b/doc/documentation/chapters/contributing.texi
index 745acca77..a92df45c3 100644
--- a/doc/documentation/chapters/contributing.texi
+++ b/doc/documentation/chapters/contributing.texi
@@ -6,17 +6,20 @@
6* Licenses of contributions:: 6* Licenses of contributions::
7* Copyright Assignment:: 7* Copyright Assignment::
8* Contributing to the Reference Manual:: 8* Contributing to the Reference Manual::
9* Contributing testcases::
9@end menu 10@end menu
10 11
11@node Contributing to GNUnet 12@node Contributing to GNUnet
12@section Contributing to GNUnet 13@section Contributing to GNUnet
13 14
15@cindex licenses
16@cindex licenses of contributions
14@node Licenses of contributions 17@node Licenses of contributions
15@section Licenses of contributions 18@section Licenses of contributions
16 19
17GNUnet is a @uref{https://www.gnu.org/, GNU} package. 20GNUnet is a @uref{https://www.gnu.org/, GNU} package.
18All code contributions must thus be put under the 21All code contributions must thus be put under the
19@uref{https://www.gnu.org/copyleft/gpl.html, GNU Public License (GPL)}. 22@uref{https://www.gnu.org/licenses/agpl.html, GNU Affero Public License (AGPL)}.
20All documentation should be put under FSF approved licenses 23All documentation should be put under FSF approved licenses
21(see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}). 24(see @uref{https://www.gnu.org/copyleft/fdl.html, fdl}).
22 25
@@ -40,7 +43,7 @@ rights, and in particular is allowed to dual-license the code. You
40retain non-exclusive rights to your contributions, so you can also 43retain non-exclusive rights to your contributions, so you can also
41share your contributions freely with other projects. 44share your contributions freely with other projects.
42 45
43GNUnet e.V. will publish all accepted contributions under the GPLv3 46GNUnet e.V. will publish all accepted contributions under the AGPLv3
44or any later version. The association may decide to publish 47or any later version. The association may decide to publish
45contributions under additional licenses (dual-licensing). 48contributions under additional licenses (dual-licensing).
46 49
@@ -88,3 +91,21 @@ In a 200+ pages handbook it's better to have footnotes accessible
88without having to skip over to the end. 91without having to skip over to the end.
89 92
90@end itemize 93@end itemize
94
95@node Contributing testcases
96@section Contributing testcases
97
98In the core of gnunet, we restrict new testcases to a small subset
99of languages, in order of preference:
100@enumerate
101@item C
102@item Bash (preferable portable without too much specifics to Bash)
103@item Python (@geq{}3.6)
104@end enumerate
105
106We welcome efforts to remove our existing python-2.7 scripts to
107replace them either with Bash or, at your choice, python-3.6+.
108
109If you contribute new python based testcases, we advise you to
110not repeat our past misfortunes and write the tests in a standard
111test framework like for example pytest.
diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi
index 1f74a8163..e82e32b59 100644
--- a/doc/documentation/chapters/developer.texi
+++ b/doc/documentation/chapters/developer.texi
@@ -214,9 +214,7 @@ Installation and update tool
214Template for starting 'external' GNUnet projects 214Template for starting 'external' GNUnet projects
215@item @command{gnunet-java} 215@item @command{gnunet-java}
216Java APIs for writing GNUnet services and applications 216Java APIs for writing GNUnet services and applications
217@c ** FIXME: Point to new website repository once we have it: 217@item @command{gnunet-java-ext}
218@c ** @item svn/gnunet-www/ Code and media helping drive the GNUnet
219@c website
220@item @command{eclectic} 218@item @command{eclectic}
221Code to run GNUnet nodes on testbeds for research, development, 219Code to run GNUnet nodes on testbeds for research, development,
222testing and evaluation 220testing and evaluation
@@ -227,6 +225,8 @@ Qt-based GNUnet GUI (is it deprecated?)
227cocoa-based GNUnet GUI (is it deprecated?) 225cocoa-based GNUnet GUI (is it deprecated?)
228@item @command{gnunet-guile} 226@item @command{gnunet-guile}
229Guile bindings for GNUnet 227Guile bindings for GNUnet
228@item @command{gnunet-python}
229Python bindings for GNUnet
230 230
231@end table 231@end table
232 232
@@ -246,6 +246,13 @@ Tool for automated debugging of distributed systems
246Library for accessing satellite connection quality reports 246Library for accessing satellite connection quality reports
247@item @command{libgnurl} 247@item @command{libgnurl}
248gnURL (feature-restricted variant of cURL/libcurl) 248gnURL (feature-restricted variant of cURL/libcurl)
249@item @command{www}
250work in progress of the new gnunet.org website (Jinja2 framework based to
251replace our current Drupal website)
252@item @command{bibliography}
253Our collected bibliography, papers, references, and so forth
254@item @command{gnunet-videos-}
255Videos about and around gnunet activities
249@end table 256@end table
250 257
251Finally, there are various external projects (see links for a list of 258Finally, there are various external projects (see links for a list of
diff --git a/doc/documentation/chapters/installation.texi b/doc/documentation/chapters/installation.texi
index f5e38fd3d..559a97f96 100644
--- a/doc/documentation/chapters/installation.texi
+++ b/doc/documentation/chapters/installation.texi
@@ -1,22 +1,40 @@
1@node Installing GNUnet 1@node Installing GNUnet
2@chapter Installing GNUnet 2@chapter Installing GNUnet
3 3
4This guide is intended for those who want to install Gnunet from source. For instructions on how to install GNUnet as a binary package please refer to the official documentation of your operating system or package manager. 4This guide is intended for those who want to install Gnunet from
5source. For instructions on how to install GNUnet as a binary package
6please refer to the official documentation of your operating system or
7package manager.
5 8
6@node Getting the Source Code 9@menu
10* Installing dependencies::
11* Getting the Source Code::
12* Create @code{gnunet} user and group::
13* Preparing and Compiling the Source Code::
14* Installation::
15* MOVED FROM USER Checking the Installation::
16* MOVED FROM USER The graphical configuration interface::
17* MOVED FROM USER Config Leftovers::
18@end menu
19
20@c -----------------------------------------------------------------------
21@node Installing dependencies
7@section Installing dependencies 22@section Installing dependencies
8GNUnet needs few libraries and applications for being able to run and another few optional ones for using certain features. Preferably they should be installed with a package manager. Just in case we include a link to the project websites. 23GNUnet needs few libraries and applications for being able to run and
24another few optional ones for using certain features. Preferably they
25should be installed with a package manager. Just in case we include a
26link to the project websites.
9 27
10The mandatory libraries and applications are 28The mandatory libraries and applications are
11@itemize @bullet 29@itemize @bullet
12@item libtool 30@item libtool
13@item autoconf >= version 2.59 31@item autoconf @geq{}2.59
14@item automake >= version 1.11.1 32@item automake @geq{}1.11.1
15@item pkg-config 33@item pkg-config
16@item libgcrypt >= version 1.6 34@item libgcrypt @geq{}1.6
17@item libextractor 35@item libextractor
18@item libidn 36@item libidn
19@item libmicrohttpd >= version 0.9.52 37@item libmicrohttpd @geq{}0.9.52
20@item libnss 38@item libnss
21@item libunistring 39@item libunistring
22@item gettext 40@item gettext
@@ -43,30 +61,43 @@ These are the dependencies only required for certain features
43@item libpulse (for running the GNUnet conversation telephony application) 61@item libpulse (for running the GNUnet conversation telephony application)
44@item libogg (for running the GNUnet conversation telephony application) 62@item libogg (for running the GNUnet conversation telephony application)
45@item bluez (for bluetooth support) 63@item bluez (for bluetooth support)
46@item libpbc (for attribute-based encryption and the identity provider subsystem) 64@item libpbc
47@item libgabe (for attribute-based encryption and the identity provider subsystem) 65(for attribute-based encryption and the identity provider subsystem)
66@item libgabe
67(for attribute-based encryption and the identity provider subsystem)
48@end itemize 68@end itemize
49 69
50 70@c -----------------------------------------------------------------------
71@node Getting the Source Code
51@section Getting the Source Code 72@section Getting the Source Code
52You can either download the source code using git (you obviously need git installed) or as an archive. 73You can either download the source code using git (you obviously need
74git installed) or as an archive.
53 75
54Using git type 76Using git type
55@example 77@example
56git clone https://gnunet.org/git/gnunet.git 78git clone https://gnunet.org/git/gnunet.git
57@end example 79@end example
58 80
59The archive can be found at @uref{https://gnunet.org/downloads}. Extract it using a graphical archive tool or @code{tar}: 81The archive can be found at
82@uref{https://gnunet.org/downloads}. Extract it using a graphical
83archive tool or @code{tar}:
60@example 84@example
61tar xzvf gnunet-0.11.0pre66.tar.gz 85tar xzvf gnunet-0.11.0pre66.tar.gz
62@end example 86@end example
63 87
64In the next chapter we will assume that the source code is available in the home directory at @code{~/gnunet}. 88In the next chapter we will assume that the source code is available
89in the home directory at @code{~/gnunet}.
65 90
91@c -----------------------------------------------------------------------
92@node Create @code{gnunet} user and group
66@section Create @code{gnunet} user and group 93@section Create @code{gnunet} user and group
67The GNUnet services should be run as a dedicated user called @code{gnunet}. For using them a user should be in the same group as this system user. 94The GNUnet services should be run as a dedicated user called
95@code{gnunet}. For using them a user should be in the same group as
96this system user.
68 97
69Create user @code{gnunet} who is member of the group @code{gnunet} and specify a home directory where the GNUnet services will store persistant data such as information about peers. 98Create user @code{gnunet} who is member of the group @code{gnunet} and
99specify a home directory where the GNUnet services will store
100persistant data such as information about peers.
70@example 101@example
71$ sudo useradd --system --groups gnunet --home-dir /var/lib/gnunet 102$ sudo useradd --system --groups gnunet --home-dir /var/lib/gnunet
72@end example 103@end example
@@ -76,8 +107,13 @@ Now add your own user to the @code{gnunet} group.
76$ sudo adduser alice gnunet 107$ sudo adduser alice gnunet
77@end example 108@end example
78 109
110@c -----------------------------------------------------------------------
111@node Preparing and Compiling the Source Code
79@section Preparing and Compiling the Source Code 112@section Preparing and Compiling the Source Code
80For preparing the source code for compilation a bootstrap script and @code{configure} has to be run from the source code directory. When running @code{configure} the following options can be specified to customize the compilation and installation process: 113For preparing the source code for compilation a bootstrap script and
114@code{configure} has to be run from the source code directory. When
115running @code{configure} the following options can be specified to
116customize the compilation and installation process:
81 117
82@itemize @bullet 118@itemize @bullet
83@item @code{--disable-documentation} - don't build the configuration documents 119@item @code{--disable-documentation} - don't build the configuration documents
@@ -91,27 +127,39 @@ For preparing the source code for compilation a bootstrap script and @code{confi
91@item @code{--with-sudo=[PATH]} - path to the sudo binary (no need to run @code{make install} as root if specified) 127@item @code{--with-sudo=[PATH]} - path to the sudo binary (no need to run @code{make install} as root if specified)
92@end itemize 128@end itemize
93 129
94The following example configures the installation prefix @code{/usr/lib} and disables building the documentation 130The following example configures the installation prefix
131@code{/usr/lib} and disables building the documentation
95@example 132@example
96$ cd ~/gnunet 133$ cd ~/gnunet
97$ ./bootstrap 134$ ./bootstrap
98$ configure --prefix=/usr/lib --disable-configuration 135$ configure --prefix=/usr/lib --disable-configuration
99@end example 136@end example
100 137
101After running the bootstrap script and @code{configure} successfully the source code can be compiled with make. Here @code{-j5} specifies that 5 threads should be used. 138After running the bootstrap script and @code{configure} successfully
139the source code can be compiled with make. Here @code{-j5} specifies
140that 5 threads should be used.
102@example 141@example
103$ make -j5 142$ make -j5
104@end example 143@end example
105 144
106 145@c -----------------------------------------------------------------------
146@node Installation
107@section Installation 147@section Installation
108The compiled binaries can be installed using @code{make install}. It needs to be run as root (or with sudo) because some binaries need the @code{suid} bit set. Without that some GNUnet subsystems (such as VPN) will not work. 148The compiled binaries can be installed using @code{make install}. It
149needs to be run as root (or with sudo) because some binaries need the
150@code{suid} bit set. Without that some GNUnet subsystems (such as VPN)
151will not work.
109 152
110@example 153@example
111$ sudo make install 154$ sudo make install
112@end example 155@end example
113 156
114One important library is the GNS plugin for NSS (the name services switch) which allows using GNS (the GNU name system) in the normal DNS resolution process. Unfortunately NSS expects it in a specific location (probably @code{/lib}) which may differ from the installation prefix (see @code{--prefix} option in the previous section). This is why the pugin has to be installed manually. 157One important library is the GNS plugin for NSS (the name services
158switch) which allows using GNS (the GNU name system) in the normal DNS
159resolution process. Unfortunately NSS expects it in a specific
160location (probably @code{/lib}) which may differ from the installation
161prefix (see @code{--prefix} option in the previous section). This is
162why the pugin has to be installed manually.
115 163
116Find the directory where nss plugins are installed on your system, e.g. 164Find the directory where nss plugins are installed on your system, e.g.
117 165
@@ -129,24 +177,30 @@ Copy the GNS NSS plugin to that directory:
129cp ~/gnunet/src/gns/nss/libnss_gns.so.2 /lib 177cp ~/gnunet/src/gns/nss/libnss_gns.so.2 /lib
130@end example 178@end example
131 179
132Now, to activate the plugin, you need to edit your @code{/etc/nsswitch.conf} where you should find a line like this: 180Now, to activate the plugin, you need to edit your
181@code{/etc/nsswitch.conf} where you should find a line like this:
133 182
134@example 183@example
135hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4 184hosts: files mdns4_minimal [NOTFOUND=return] dns mdns4
136@end example 185@end example
137 186
138The exact details may differ a bit, which is fine. Add the text @code{"gns [NOTFOUND=return]"} after @code{"files"}. 187The exact details may differ a bit, which is fine. Add the text
188@code{"gns [NOTFOUND=return]"} after @code{"files"}.
139 189
140@example 190@example
141hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 191hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4
142@end example 192@end example
143 193
144Optionally, if GNS shall be used with a browser, execute the GNS CA-setup script. It will isetup the GNS Certificate Authority with the user's browser. 194Optionally, if GNS shall be used with a browser, execute the GNS
195CA-setup script. It will isetup the GNS Certificate Authority with the
196user's browser.
145@example 197@example
146$ gnunet-gns-proxy-setup-ca 198$ gnunet-gns-proxy-setup-ca
147@end example 199@end example
148 200
149Finally install a configuration file in @code{~/.gnunet/gnunet.conf}. Below you find an example config which allows you to start GNUnet. 201Finally install a configuration file in
202@code{~/.gnunet/gnunet.conf}. Below you find an example config which
203allows you to start GNUnet.
150 204
151@example 205@example
152[arm] 206[arm]
@@ -170,7 +224,8 @@ This section describes a quick, casual way to check if your GNUnet
170installation works. However, if it does not, we do not cover 224installation works. However, if it does not, we do not cover
171steps for recovery --- for this, please study the instructions 225steps for recovery --- for this, please study the instructions
172provided in the developer handbook as well as the system-specific 226provided in the developer handbook as well as the system-specific
173instruction in the source code repository@footnote{The system specific instructions are not provided as part of this handbook!}. 227instruction in the source code repository@footnote{The system specific
228instructions are not provided as part of this handbook!}.
174 229
175 230
176@menu 231@menu
@@ -203,21 +258,25 @@ Currently these interfaces cover:
203@subsection Statistics 258@subsection Statistics
204@c %**end of header 259@c %**end of header
205 260
206First, you should launch GNUnet gtk@footnote{Obviously you should also start gnunet, via gnunet-arm or the system provided method}. 261First, you should launch GNUnet gtk@footnote{Obviously you should also
262start gnunet, via gnunet-arm or the system provided method}.
207You can do this from the command-line by typing 263You can do this from the command-line by typing
208 264
209@example 265@example
210gnunet-statistics-gtk 266gnunet-statistics-gtk
211@end example 267@end example
212 268
213If your peer@footnote{The term ``peer'' is a common word used in federated and distributed networks to describe a participating device which is connected to the network. Thus, your Personal Computer or whatever it is you are looking at the Gtk+ interface describes a ``Peer'' or a ``Node''.} 269If your peer@footnote{The term ``peer'' is a common word used in
214is running correctly, you should see a bunch of lines, 270federated and distributed networks to describe a participating device
215all of which should be ``significantly'' above zero (at least if your 271which is connected to the network. Thus, your Personal Computer or
216peer has been running for more than a few seconds). The lines indicate 272whatever it is you are looking at the Gtk+ interface describes a
217how many other peers your peer is connected to (via different 273``Peer'' or a ``Node''.} is running correctly, you should see a bunch
218mechanisms) and how large the entire overlay network is currently 274of lines, all of which should be ``significantly'' above zero (at
219estimated to be. The X-axis represents time (in seconds since the 275least if your peer has been running for more than a few seconds). The
220start of @command{gnunet-gtk}). 276lines indicate how many other peers your peer is connected to (via
277different mechanisms) and how large the entire overlay network is
278currently estimated to be. The X-axis represents time (in seconds
279since the start of @command{gnunet-gtk}).
221 280
222You can click on "Traffic" to see information about the amount of 281You can click on "Traffic" to see information about the amount of
223bandwidth your peer has consumed, and on "Storage" to check the amount 282bandwidth your peer has consumed, and on "Storage" to check the amount
diff --git a/doc/documentation/chapters/preface.texi b/doc/documentation/chapters/preface.texi
index 00e6290f0..29cf924a2 100644
--- a/doc/documentation/chapters/preface.texi
+++ b/doc/documentation/chapters/preface.texi
@@ -12,9 +12,9 @@ all kinds of basic applications for the foundation of a new Internet.
12 12
13@menu 13@menu
14* About this book:: 14* About this book::
15* Contributing to this book::
15* Introduction:: 16* Introduction::
16* Project governance:: 17* Project governance::
17* General Terminology::
18* Typography:: 18* Typography::
19@end menu 19@end menu
20 20
@@ -37,6 +37,26 @@ The first chapter (``Preface'') as well as the the second
37chapter (``Philosophy'') give an introduction to GNUnet as a project, 37chapter (``Philosophy'') give an introduction to GNUnet as a project,
38what GNUnet tries to achieve. 38what GNUnet tries to achieve.
39 39
40@node Contributing to this book
41@section Contributing to this book
42
43The GNUnet Reference Manual is a collective work produced by various
44people throughout the years. The version you are reading is derived
45from many individual efforts hosted on our website. This was a failed
46experiment, and with the conversion to Texinfo we hope to address this
47in the longterm. Texinfo is the documentation language of the GNU project.
48While it can be intimidating at first and look scary or complicated,
49it is just another way to express text format instructions. We encourage
50you to take this opportunity and learn about Texinfo, learn about GNUnet,
51and one word at a time we will arrive at a book which explains GNUnet in
52the least complicated way to you. Even when you don't want or can't learn
53Texinfo, you can contribute. Send us an Email or join our IRC chat room
54on freenode and talk with us about the documentation (the prefered way
55to reach out is the mailinglist, since you can communicate with us
56without waiting on someone in the chatroom). One way or another you
57can help shape the understanding of GNUnet without the ability to read
58and understand its sourcecode.
59
40@node Introduction 60@node Introduction
41@section Introduction 61@section Introduction
42 62
@@ -66,25 +86,31 @@ immediately. A few months after the first release we contacted the
66GNU project, happily agreed to their governance model and became an 86GNU project, happily agreed to their governance model and became an
67official GNU package. 87official GNU package.
68 88
69Within the first year, we created GNU libextractor, a helper library 89Within the first year, we created
90@uref{https://gnu.org/s/libextractor, GNU libextractor}, a helper library
70for meta data extraction which has been used by a few other projects 91for meta data extraction which has been used by a few other projects
71as well. 2003 saw the emergence of pluggable transports, the ability 92as well. 2003 saw the emergence of pluggable transports, the ability
72for GNUnet to use different mechanisms for communication, starting 93for GNUnet to use different mechanisms for communication, starting
73with TCP, UDP and SMTP (support for the latter was later dropped due 94with TCP, UDP and SMTP (support for the latter was later dropped due
74to a lack of maintenance). In 2005, the project first started to 95to a lack of maintenance). In 2005, the project first started to
75evolve beyond the original file-sharing application with a first 96evolve beyond the original file-sharing application with a first
76simple P2P chat. In 2007, we created GNU libmicrohttpd 97simple P2P chat. In 2007, we created
98@uref{https://gnu.org/s/libmicrohttpd, GNU libmicrohttpd}
77to support a pluggable transport based on HTTP. In 2009, the 99to support a pluggable transport based on HTTP. In 2009, the
78architecture was radically modularized into the multi-process system 100architecture was radically modularized into the multi-process system
79that exists today. Coincidentally, the first version of the ARM 101that exists today. Coincidentally, the first version of the ARM@footnote{ARM: Automatic Restart Manager}
80service was implemented a day before systemd was announced. From 2009 102service was implemented a day before systemd was announced. From 2009
81to 2014 work progressed rapidly thanks to a significant research grant 103to 2014 work progressed rapidly thanks to a significant research grant
82from the Deutsche Forschungsgesellschaft. This resulted in particular 104from the Deutsche Forschungsgesellschaft. This resulted in particular
83in the creation of the R5N DHT, CADET, ATS and the GNU Name System. 105in the creation of the R5N DHT, CADET, ATS and the GNU Name System.
84In 2010, GNUnet was selected as the basis for the SecuShare online 106In 2010, GNUnet was selected as the basis for the
85social network, resutling in a significant growth of the core team. 107@uref{https://secushare.org, secushare} online
86In 2013, we launched GNU Taler to address the challenge of convenient 108social network, resulting in a significant growth of the core team.
87and privacy-preserving online payments. In 2015, the pEp project 109In 2013, we launched @uref{https://taler.net, GNU Taler} to address
110the challenge of convenient
111and privacy-preserving online payments. In 2015, the
112@c TODO: Maybe even markup for the E if it renders in most outputs.
113@uref{https://pep.foundation/, pEp}@footnote{pretty easy privacy} project
88announced that they will use GNUnet as the technology for their 114announced that they will use GNUnet as the technology for their
89meta-data protection layer, ultimately resulting in GNUnet e.V. 115meta-data protection layer, ultimately resulting in GNUnet e.V.
90entering into a formal long-term collaboration with the pEp 116entering into a formal long-term collaboration with the pEp
@@ -99,9 +125,9 @@ computing has been the core driver of the GNU project. With GNUnet we
99are focusing on informational self-determination for collaborative 125are focusing on informational self-determination for collaborative
100computing and communication over networks. 126computing and communication over networks.
101 127
102The Internet is shaped as much by code and protocols as by its 128The Internet is shaped as much by code and protocols as it is by its
103associated political processes (IETF, ICANN, IEEE, etc.), and its 129associated political processes (IETF, ICANN, IEEE, etc.).
104flaws are similarly not limited to the protocol design. Thus, 130Similarly its flaws are not limited to the protocol design. Thus,
105technical excellence by itself will not suffice to create a better 131technical excellence by itself will not suffice to create a better
106network. We also need to build a community that is wise, humble and 132network. We also need to build a community that is wise, humble and
107has a sense of humor to achieve our goal to create a technical 133has a sense of humor to achieve our goal to create a technical
@@ -116,23 +142,22 @@ follows the governance model of a benevolent dictator. This means
116that ultimately, the GNU project appoints the GNU maintainer and can 142that ultimately, the GNU project appoints the GNU maintainer and can
117overrule decisions made by the GNUnet maintainer. Similarly, the 143overrule decisions made by the GNUnet maintainer. Similarly, the
118GNUnet maintainer can overrule any decisions made by individual 144GNUnet maintainer can overrule any decisions made by individual
145@c TODO: Should we mention if this is just about GNUnet? Other projects
146@c TODO: in GNU seem to have rare issues (GCC, the 2018 documentation
147@c TODO: discussion.
119developers. Still, in practice neither has happened in the last 20 148developers. Still, in practice neither has happened in the last 20
120years, and we hope to keep it that way. 149years, and we hope to keep it that way.
121 150
151@c TODO: Actually we are a Swiss association, or just a German association
152@c TODO: with Swiss bylaws/Satzung?
153@c TODO: Rewrite one of the 'GNUnet eV may also' sentences.
122The GNUnet project is supported by GNUnet e.V., a German association 154The GNUnet project is supported by GNUnet e.V., a German association
123where any developer can become a member. GNUnet e.V. servers as a 155where any developer can become a member. GNUnet e.V. serves as a
124legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also 156legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also
125choose to pay for project resources, and can collect donations. 157choose to pay for project resources, and can collect donations.
126GNUnet e.V. may also choose to adjust the license of the 158GNUnet e.V. may also choose to adjust the license of the
127software (with the constraint that it has to remain free software). 159software (with the constraint that it has to remain free software)@footnote{For example in 2018 we switched from GPL3 to AGPL3. In practice these changes do not happen very often.}
128
129
130@node General Terminology
131@section General Terminology
132 160
133In the following manual we may use words that can not be found in the
134Appendix. Since we want to keep the manual selfcontained, we will
135explain words here.
136 161
137@node Typography 162@node Typography
138@section Typography 163@section Typography
@@ -142,3 +167,5 @@ command should/can be issued as root, or if "normal" user privileges are
142sufficient. We use a @code{#} for root's shell prompt, a 167sufficient. We use a @code{#} for root's shell prompt, a
143@code{%} for users' shell prompt, assuming they use the C-shell or tcsh 168@code{%} for users' shell prompt, assuming they use the C-shell or tcsh
144and a @code{$} for bourne shell and derivatives. 169and a @code{$} for bourne shell and derivatives.
170@c TODO: Really? Why the different prompts? Do we already have c-shell
171@c TODO: examples?
diff --git a/doc/documentation/chapters/user.texi b/doc/documentation/chapters/user.texi
index fe47abb86..50b795197 100644
--- a/doc/documentation/chapters/user.texi
+++ b/doc/documentation/chapters/user.texi
@@ -26,6 +26,7 @@ always welcome.
26* First steps - Using the GNUnet VPN:: 26* First steps - Using the GNUnet VPN::
27* File-sharing:: 27* File-sharing::
28* The GNU Name System:: 28* The GNU Name System::
29* re@:claim Identity Provider::
29* Using the Virtual Public Network:: 30* Using the Virtual Public Network::
30@end menu 31@end menu
31 32
@@ -43,6 +44,7 @@ To stop GNUnet:
43@example 44@example
44$ gnunet-arm -e 45$ gnunet-arm -e
45@end example 46@end example
47
46@node First steps - Using the GNU Name System 48@node First steps - Using the GNU Name System
47@section First steps - Using the GNU Name System 49@section First steps - Using the GNU Name System
48@c %**end of header 50@c %**end of header
@@ -246,7 +248,7 @@ more an experimental feature and not really our primary goal at this
246time. Still, it is a possible use-case and we welcome help with testing 248time. Still, it is a possible use-case and we welcome help with testing
247and development. 249and development.
248 250
249 251@pindex gnunet-bcd
250@node Creating a Business Card 252@node Creating a Business Card
251@subsection Creating a Business Card 253@subsection Creating a Business Card
252@c FIXME: Which parts of texlive are needed? Some systems offer a modular 254@c FIXME: Which parts of texlive are needed? Some systems offer a modular
@@ -257,7 +259,9 @@ Note that this requires having @command{LaTeX} installed on your system.
257If you are using a Debian GNU/Linux based operating system, the 259If you are using a Debian GNU/Linux based operating system, the
258following command should install the required components. 260following command should install the required components.
259Keep in mind that this @b{requires 3GB} of downloaded data and possibly 261Keep in mind that this @b{requires 3GB} of downloaded data and possibly
260@b{even more} when unpacked. 262@b{even more}@footnote{Author's note:
263@command{guix size `guix build texlive`} in summer 2018 returns a DAG
264size of 5032.4 MiB} when unpacked.
261@b{We welcome any help in identifying the required components of the 265@b{We welcome any help in identifying the required components of the
262TexLive Distribution. This way we could just state the required components 266TexLive Distribution. This way we could just state the required components
263without pulling in the full distribution of TexLive.} 267without pulling in the full distribution of TexLive.}
@@ -312,12 +316,14 @@ you might need a trip to the store together.
312Before we get started, we need to tell @code{gnunet-qr} which zone 316Before we get started, we need to tell @code{gnunet-qr} which zone
313it should import new records into. For this, run: 317it should import new records into. For this, run:
314 318
319@pindex gnunet-identity
315@example 320@example
316$ gnunet-identity -s namestore -e NAME 321$ gnunet-identity -s namestore -e NAME
317@end example 322@end example
318where NAME is the name of the zone you want to import records 323where NAME is the name of the zone you want to import records
319into. In our running example, this would be ``gnu''. 324into. In our running example, this would be ``gnu''.
320 325
326@pindex gnunet-qr
321Henceforth, for every business card you collect, simply run: 327Henceforth, for every business card you collect, simply run:
322@example 328@example
323$ gnunet-qr 329$ gnunet-qr
@@ -335,6 +341,7 @@ GNUnet network at this time, you should thus be able to
335resolve your friends names. Suppose your friend's nickname 341resolve your friends names. Suppose your friend's nickname
336is "Bob". Then, type 342is "Bob". Then, type
337 343
344@pindex gnunet-gns
338@example 345@example
339$ gnunet-gns -u test.bob.gnu 346$ gnunet-gns -u test.bob.gnu
340@end example 347@end example
@@ -381,6 +388,7 @@ a revocation certificate corresponding to your ego. This certificate,
381when published on the P2P network, flags your private key as invalid, 388when published on the P2P network, flags your private key as invalid,
382and all further resolutions or other checks involving the key will fail. 389and all further resolutions or other checks involving the key will fail.
383 390
391@pindex gnunet-revocation
384A revocation certificate is thus a useful tool when things go out of 392A revocation certificate is thus a useful tool when things go out of
385control, but at the same time it should be stored securely. 393control, but at the same time it should be stored securely.
386Generation of the revocation certificate for a zone can be done through 394Generation of the revocation certificate for a zone can be done through
@@ -433,6 +441,7 @@ private conversation with your friend. Finally, help us
433with the next GNUnet release for even more applications 441with the next GNUnet release for even more applications
434using this new public key infrastructure. 442using this new public key infrastructure.
435 443
444@pindex gnunet-conservation-gtk
436@node First steps - Using GNUnet Conversation 445@node First steps - Using GNUnet Conversation
437@section First steps - Using GNUnet Conversation 446@section First steps - Using GNUnet Conversation
438@c %**end of header 447@c %**end of header
@@ -485,6 +494,7 @@ that will show up when you call somebody else, as well as the
485GNS zone that will be used to resolve names of users that you 494GNS zone that will be used to resolve names of users that you
486are calling. Run 495are calling. Run
487 496
497@pindex gnunet-conversation
488@example 498@example
489gnunet-conversation -e zone-name 499gnunet-conversation -e zone-name
490@end example 500@end example
@@ -564,7 +574,7 @@ Either of you can end the call using @command{/cancel}. You can exit
564 574
565@menu 575@menu
566* VPN Preliminaries:: 576* VPN Preliminaries::
567* Exit configuration:: 577* GNUnet-Exit configuration::
568* GNS configuration:: 578* GNS configuration::
569* Accessing the service:: 579* Accessing the service::
570* Using a Browser:: 580* Using a Browser::
@@ -595,6 +605,9 @@ The exact details may differ a bit, which is fine. Add the text
595hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4 605hosts: files gns [NOTFOUND=return] mdns4_minimal [NOTFOUND=return] dns mdns4
596@end example 606@end example
597 607
608@c TODO: outdated section, we no longer install this as part of the
609@c TODO: standard installation procedure and should point out the manual
610@c TODO: steps required to make it useful.
598@noindent 611@noindent
599You might want to make sure that @code{/lib/libnss_gns.so.2} exists on 612You might want to make sure that @code{/lib/libnss_gns.so.2} exists on
600your system, it should have been created during the installation. 613your system, it should have been created during the installation.
@@ -608,8 +621,8 @@ $ cd src/gns/nss; sudo make install
608@noindent 621@noindent
609to install the NSS plugins in the proper location. 622to install the NSS plugins in the proper location.
610 623
611@node Exit configuration 624@node GNUnet-Exit configuration
612@subsection Exit configuration 625@subsection GNUnet-Exit configuration
613@c %**end of header 626@c %**end of header
614 627
615Stop your peer (as user @code{gnunet}, run @command{gnunet-arm -e}) and 628Stop your peer (as user @code{gnunet}, run @command{gnunet-arm -e}) and
@@ -696,9 +709,10 @@ the searcher/downloader specify "no anonymity", non-anonymous
696file-sharing is used. If either user specifies some desired degree 709file-sharing is used. If either user specifies some desired degree
697of anonymity, anonymous file-sharing will be used. 710of anonymity, anonymous file-sharing will be used.
698 711
699After a short introduction, we will first look at the various concepts in 712After a short introduction, we will first look at the various concepts
700GNUnet's file-sharing implementation. Then, we will discuss specifics as to how 713in GNUnet's file-sharing implementation. Then, we will discuss
701they impact users that publish, search or download files. 714specifics as to how they impact users that publish, search or download
715files.
702 716
703 717
704@menu 718@menu
@@ -706,7 +720,6 @@ they impact users that publish, search or download files.
706* fs-Downloading:: 720* fs-Downloading::
707* fs-Publishing:: 721* fs-Publishing::
708* fs-Concepts:: 722* fs-Concepts::
709* fs-Directories::
710* Namespace Management:: 723* Namespace Management::
711* File-Sharing URIs:: 724* File-Sharing URIs::
712* GTK User Interface:: 725* GTK User Interface::
@@ -724,10 +737,11 @@ $ gnunet-search [-t TIMEOUT] KEYWORD
724@end example 737@end example
725 738
726@noindent 739@noindent
727The -t option specifies that the query should timeout after 740The @command{-t} option specifies that the query should timeout after
728approximately TIMEOUT seconds. A value of zero is interpreted 741approximately TIMEOUT seconds. A value of zero (``0'') is interpreted
729as @emph{no timeout}, which is also the default. In this case, 742as @emph{no timeout}, which is the default. In this case,
730gnunet-search will never terminate (unless you press CTRL-C). 743@command{gnunet-search} will never terminate (unless you press
744@command{CTRL-C}).
731 745
732If multiple words are passed as keywords, they will all be 746If multiple words are passed as keywords, they will all be
733considered optional. Prefix keywords with a "+" to make them mandatory. 747considered optional. Prefix keywords with a "+" to make them mandatory.
@@ -750,10 +764,11 @@ as the first will match files shared under the keywords
750"Das" or "Kapital" whereas the second will match files 764"Das" or "Kapital" whereas the second will match files
751shared under the keyword "Das Kapital". 765shared under the keyword "Das Kapital".
752 766
753Search results are printed by gnunet-search like this: 767Search results are printed by @command{gnunet-search} like this:
754 768
755@c it will be better the avoid the ellipsis altogether because I don't 769@c it will be better the avoid the ellipsis altogether because I don't
756@c understand the explanation below that 770@c understand the explanation below that
771@c ng0: who is ``I'' and what was the complete sentence?
757@example 772@example
758#15: 773#15:
759gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446 774gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446
@@ -762,10 +777,11 @@ gnunet-download -o "COPYING" gnunet://fs/chk/PGK8M...3EK130.75446
762 777
763@noindent 778@noindent
764The whole line is the command you would have to enter to download 779The whole line is the command you would have to enter to download
765the file. The argument passed to @code{-o} is the suggested 780the file. The first argument passed to @code{-o} is the suggested
766filename (you may change it to whatever you like). 781filename (you may change it to whatever you like).
767It is followed by the key for decrypting the file, the query for searching the 782It is followed by the key for decrypting the file, the query for
768file, a checksum (in hexadecimal) finally the size of the file in bytes. 783searching the file, a checksum (in hexadecimal) finally the size of
784the file in bytes.
769 785
770@node fs-Downloading 786@node fs-Downloading
771@subsection Downloading 787@subsection Downloading
@@ -802,9 +818,9 @@ already present.
802GNUnet's file-encoding mechanism will ensure file integrity, even if the 818GNUnet's file-encoding mechanism will ensure file integrity, even if the
803existing file was not downloaded from GNUnet in the first place. 819existing file was not downloaded from GNUnet in the first place.
804 820
805You may want to use the @command{-V} switch to turn on verbose reporting. In 821You may want to use the @command{-V} switch to turn on verbose
806this case, @command{gnunet-download} will print the current number of bytes 822reporting. In this case, @command{gnunet-download} will print the
807downloaded whenever new data was received. 823current number of bytes downloaded whenever new data was received.
808 824
809@node fs-Publishing 825@node fs-Publishing
810@subsection Publishing 826@subsection Publishing
@@ -834,7 +850,7 @@ $ gnunet-publish -m "description:GNU License" -k gpl -k test -m "mimetype:text/p
834The option @code{-k} is used to specify keywords for the file that 850The option @code{-k} is used to specify keywords for the file that
835should be inserted. You can supply any number of keywords, 851should be inserted. You can supply any number of keywords,
836and each of the keywords will be sufficient to locate and 852and each of the keywords will be sufficient to locate and
837retrieve the file. Please note that you must use the @code{-k} option 853retrieve the file. Please note that you must use the @code{-k} option
838more than once -- one for each expression you use as a keyword for 854more than once -- one for each expression you use as a keyword for
839the filename. 855the filename.
840 856
@@ -845,10 +861,14 @@ list by running @command{extract -L}. Use quotes around the entire
845meta-data argument if the value contains spaces. The meta-data 861meta-data argument if the value contains spaces. The meta-data
846is displayed to other users when they select which files to 862is displayed to other users when they select which files to
847download. The meta-data and the keywords are optional and 863download. The meta-data and the keywords are optional and
848maybe inferred using @code{GNU libextractor}. 864may be inferred using @code{GNU libextractor}.
865
866@command{gnunet-publish} has a few additional options to handle
867namespaces and directories. Refer to the man-page for details:
849 868
850gnunet-publish has a few additional options to handle namespaces and 869@example
851directories. See the man-page for details. 870man gnunet-publish
871@end example
852 872
853@node Indexing vs. Inserting 873@node Indexing vs. Inserting
854@subsubsection Indexing vs Inserting 874@subsubsection Indexing vs Inserting
@@ -890,18 +910,17 @@ able to crack the encryption (e.g. by guessing the keyword.
890@subsection Concepts 910@subsection Concepts
891@c %**end of header 911@c %**end of header
892 912
893Sharing files in GNUnet is not quite as simple as in traditional 913For better results with filesharing it is useful to understand the
894file sharing systems. For example, it is not sufficient to just 914following concepts.
895place files into a specific directory to share them. In addition 915In addition to anonymous routing GNUnet attempts to give users a better
896to anonymous routing GNUnet attempts to give users a better experience 916experience in searching for content. GNUnet uses cryptography to safely
897in searching for content. GNUnet uses cryptography to safely break 917break content into smaller pieces that can be obtained from different
898content into smaller pieces that can be obtained from different 918sources without allowing participants to corrupt files. GNUnet makes it
899sources without allowing participants to corrupt files. GNUnet 919difficult for an adversary to send back bogus search results. GNUnet
900makes it difficult for an adversary to send back bogus search 920enables content providers to group related content and to establish a
901results. GNUnet enables content providers to group related content 921reputation. Furthermore, GNUnet allows updates to certain content to be
902and to establish a reputation. Furthermore, GNUnet allows updates 922made available. This section is supposed to introduce users to the
903to certain content to be made available. This section is supposed 923concepts that are used to achieve these goals.
904to introduce users to the concepts that are used to achieve these goals.
905 924
906 925
907@menu 926@menu
@@ -921,10 +940,10 @@ to introduce users to the concepts that are used to achieve these goals.
921@c %**end of header 940@c %**end of header
922 941
923A file in GNUnet is just a sequence of bytes. Any file-format is allowed 942A file in GNUnet is just a sequence of bytes. Any file-format is allowed
924and the maximum file size is theoretically 264 bytes, except that it 943and the maximum file size is theoretically @math{2^64 - 1} bytes, except
925would take an impractical amount of time to share such a file. 944that it would take an impractical amount of time to share such a file.
926GNUnet itself never interprets the contents of shared files, except 945GNUnet itself never interprets the contents of shared files, except when
927when using GNU libextractor to obtain keywords. 946using GNU libextractor to obtain keywords.
928 947
929@node Keywords 948@node Keywords
930@subsubsection Keywords 949@subsubsection Keywords
@@ -954,10 +973,26 @@ it cannot be changed since it is treated just like an ordinary file
954by the network. Small files (of a few kilobytes) can be inlined in 973by the network. Small files (of a few kilobytes) can be inlined in
955the directory, so that a separate download becomes unnecessary. 974the directory, so that a separate download becomes unnecessary.
956 975
976Directories are shared just like ordinary files. If you download a
977directory with @command{gnunet-download}, you can use
978@command{gnunet-directory} to list its contents. The canonical
979extension for GNUnet directories when stored as files in your
980local file-system is ".gnd". The contents of a directory are URIs and
981meta data.
982The URIs contain all the information required by
983@command{gnunet-download} to retrieve the file. The meta data
984typically includes the mime-type, description, a filename and
985other meta information, and possibly even the full original file
986(if it was small).
987
957@node Pseudonyms 988@node Pseudonyms
958@subsubsection Pseudonyms 989@subsubsection Pseudonyms
959@c %**end of header 990@c %**end of header
960 991
992@b{Please note that the text in this subsection is outdated and needs}
993@b{to be rewritten for version 0.10!}
994@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
995
961Pseudonyms in GNUnet are essentially public-private (RSA) key pairs 996Pseudonyms in GNUnet are essentially public-private (RSA) key pairs
962that allow a GNUnet user to maintain an identity (which may or may not 997that allow a GNUnet user to maintain an identity (which may or may not
963be detached from their real-life identity). GNUnet's pseudonyms are not 998be detached from their real-life identity). GNUnet's pseudonyms are not
@@ -973,6 +1008,10 @@ to copy around).
973@subsubsection Namespaces 1008@subsubsection Namespaces
974@c %**end of header 1009@c %**end of header
975 1010
1011@b{Please note that the text in this subsection is outdated and needs}
1012@b{to be rewritten for version 0.10!}
1013@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1014
976A namespace is a set of files that were signed by the same pseudonym. 1015A namespace is a set of files that were signed by the same pseudonym.
977Files (or directories) that have been signed and placed into a namespace 1016Files (or directories) that have been signed and placed into a namespace
978can be updated. Updates are identified as authentic if the same secret 1017can be updated. Updates are identified as authentic if the same secret
@@ -984,11 +1023,15 @@ same entity (which does not have to be the same person).
984@subsubsection Advertisements 1023@subsubsection Advertisements
985@c %**end of header 1024@c %**end of header
986 1025
1026@b{Please note that the text in this subsection is outdated and needs}
1027@b{to be rewritten for version 0.10!}
1028@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1029
987Advertisements are used to notify other users about the existence of a 1030Advertisements are used to notify other users about the existence of a
988namespace. Advertisements are propagated using the normal keyword search. 1031namespace. Advertisements are propagated using the normal keyword search.
989When an advertisement is received (in response to a search), the namespace 1032When an advertisement is received (in response to a search), the namespace
990is added to the list of namespaces available in the namespace-search 1033is added to the list of namespaces available in the namespace-search
991dialogs of gnunet-fs-gtk and printed by gnunet-pseudonym. Whenever a 1034dialogs of gnunet-fs-gtk and printed by @code{gnunet-identity}. Whenever a
992namespace is created, an appropriate advertisement can be generated. 1035namespace is created, an appropriate advertisement can be generated.
993The default keyword for the advertising of namespaces is "namespace". 1036The default keyword for the advertising of namespaces is "namespace".
994 1037
@@ -996,7 +1039,7 @@ Note that GNUnet differentiates between your pseudonyms (the identities
996that you control) and namespaces. If you create a pseudonym, you will 1039that you control) and namespaces. If you create a pseudonym, you will
997not automatically see the respective namespace. You first have to create 1040not automatically see the respective namespace. You first have to create
998an advertisement for the namespace and find it using keyword 1041an advertisement for the namespace and find it using keyword
999search --- even for your own namespaces. The @command{gnunet-pseudonym} 1042search --- even for your own namespaces. The @command{gnunet-identity}
1000tool is currently responsible for both managing pseudonyms and namespaces. 1043tool is currently responsible for both managing pseudonyms and namespaces.
1001This will likely change in the future to reduce the potential for 1044This will likely change in the future to reduce the potential for
1002confusion. 1045confusion.
@@ -1044,22 +1087,6 @@ level by one. If all blocks reach replication level zero, the
1044selection is simply random. 1087selection is simply random.
1045 1088
1046 1089
1047@node fs-Directories
1048@subsection Directories
1049@c %**end of header
1050
1051Directories are shared just like ordinary files. If you download a
1052directory with @command{gnunet-download}, you can use
1053@command{gnunet-directory} to list its contents. The canonical
1054extension for GNUnet directories when stored as files in your
1055local file-system is ".gnd". The contents of a directory are URIs and
1056meta data.
1057The URIs contain all the information required by
1058@command{gnunet-download} to retrieve the file. The meta data
1059typically includes the mime-type, description, a filename and
1060other meta information, and possibly even the full original file
1061(if it was small).
1062
1063@node Namespace Management 1090@node Namespace Management
1064@subsection Namespace Management 1091@subsection Namespace Management
1065@c %**end of header 1092@c %**end of header
@@ -1067,8 +1094,8 @@ other meta information, and possibly even the full original file
1067@b{Please note that the text in this subsection is outdated and needs} 1094@b{Please note that the text in this subsection is outdated and needs}
1068@b{to be rewritten for version 0.10!} 1095@b{to be rewritten for version 0.10!}
1069 1096
1070The gnunet-pseudonym tool can be used to create pseudonyms and 1097The @code{gnunet-identity} tool can be used to create pseudonyms and
1071to advertise namespaces. By default, gnunet-pseudonym simply 1098to advertise namespaces. By default, @code{gnunet-identity -D} simply
1072lists all locally available pseudonyms. 1099lists all locally available pseudonyms.
1073 1100
1074 1101
@@ -1084,6 +1111,10 @@ lists all locally available pseudonyms.
1084@subsubsection Creating Pseudonyms 1111@subsubsection Creating Pseudonyms
1085@c %**end of header 1112@c %**end of header
1086 1113
1114@b{Please note that the text in this subsection is outdated and needs}
1115@b{to be rewritten for version 0.10!}
1116@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1117
1087With the @command{-C NICK} option it can also be used to 1118With the @command{-C NICK} option it can also be used to
1088create a new pseudonym. A pseudonym is the virtual identity 1119create a new pseudonym. A pseudonym is the virtual identity
1089of the entity in control of a namespace. Anyone can create 1120of the entity in control of a namespace. Anyone can create
@@ -1095,6 +1126,10 @@ used.
1095@subsubsection Deleting Pseudonyms 1126@subsubsection Deleting Pseudonyms
1096@c %**end of header 1127@c %**end of header
1097 1128
1129@b{Please note that the text in this subsection is outdated and needs}
1130@b{to be rewritten for version 0.10!}
1131@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1132
1098With the @command{-D NICK} option pseudonyms can be deleted. 1133With the @command{-D NICK} option pseudonyms can be deleted.
1099Once the pseudonym has been deleted it is impossible to add 1134Once the pseudonym has been deleted it is impossible to add
1100content to the corresponding namespace. Deleting the 1135content to the corresponding namespace. Deleting the
@@ -1105,6 +1140,10 @@ unavailable.
1105@subsubsection Advertising namespaces 1140@subsubsection Advertising namespaces
1106@c %**end of header 1141@c %**end of header
1107 1142
1143@b{Please note that the text in this subsection is outdated and needs}
1144@b{to be rewritten for version 0.10!}
1145@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1146
1108Each namespace is associated with meta-data that describes 1147Each namespace is associated with meta-data that describes
1109the namespace. This meta-data is provided by the user at 1148the namespace. This meta-data is provided by the user at
1110the time that the namespace is advertised. Advertisements 1149the time that the namespace is advertised. Advertisements
@@ -1121,6 +1160,10 @@ the quality of the content found in it.
1121@subsubsection Namespace names 1160@subsubsection Namespace names
1122@c %**end of header 1161@c %**end of header
1123 1162
1163@b{Please note that the text in this subsection is outdated and needs}
1164@b{to be rewritten for version 0.10!}
1165@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1166
1124While the namespace is uniquely identified by its ID, another way 1167While the namespace is uniquely identified by its ID, another way
1125to refer to the namespace is to use the NICKNAME. 1168to refer to the namespace is to use the NICKNAME.
1126The NICKNAME can be freely chosen by the creator of the namespace and 1169The NICKNAME can be freely chosen by the creator of the namespace and
@@ -1132,6 +1175,10 @@ to the NICKNAME to get a unique identifier.
1132@subsubsection Namespace root 1175@subsubsection Namespace root
1133@c %**end of header 1176@c %**end of header
1134 1177
1178@b{Please note that the text in this subsection is outdated and needs}
1179@b{to be rewritten for version 0.10!}
1180@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1181
1135An item of particular interest in the namespace advertisement is 1182An item of particular interest in the namespace advertisement is
1136the ROOT. The ROOT is the identifier of a designated entry in the 1183the ROOT. The ROOT is the identifier of a designated entry in the
1137namespace. The idea is that the ROOT can be used to advertise an 1184namespace. The idea is that the ROOT can be used to advertise an
@@ -1219,6 +1266,10 @@ Furthermore they must not contain '++'.
1219@subsubsection Namespace content (sks) 1266@subsubsection Namespace content (sks)
1220@c %**end of header 1267@c %**end of header
1221 1268
1269@b{Please note that the text in this subsection is outdated and needs}
1270@b{to be rewritten for version 0.10!}
1271@b{This especially concerns the terminology of Pseudonym/Ego/Identity.}
1272
1222Namespaces are sets of files that have been approved by some (usually 1273Namespaces are sets of files that have been approved by some (usually
1223pseudonymous) user --- typically by that user publishing all of the 1274pseudonymous) user --- typically by that user publishing all of the
1224files together. A file can be in many namespaces. A file is in a 1275files together. A file can be in many namespaces. A file is in a
@@ -1419,8 +1470,8 @@ $ gnunet-identity -C "myzone"
1419 1470
1420Henceforth, on your system you control the TLD ``myzone''. 1471Henceforth, on your system you control the TLD ``myzone''.
1421 1472
1422All of your zones can be listed using the @command{gnunet-identity} 1473All of your zones can be listed (displayed) using the
1423command line tool as well: 1474@command{gnunet-identity} command line tool as well:
1424 1475
1425@example 1476@example
1426$ gnunet-identity -d 1477$ gnunet-identity -d
@@ -1528,11 +1579,11 @@ record you want to access).
1528@subsection Using Public Keys as Top Level Domains 1579@subsection Using Public Keys as Top Level Domains
1529 1580
1530 1581
1531GNS also assumes responsibility for any name that uses in a well-formed 1582GNS also assumes responsibility for any name that uses in a
1532public key for the TLD. Names ending this way are then resolved by querying 1583well-formed public key for the TLD. Names ending this way are then
1533the respective zone. Such public key TLDs are expected to be used under rare 1584resolved by querying the respective zone. Such public key TLDs are
1534circumstances where globally unique names are required, and for 1585expected to be used under rare circumstances where globally unique
1535integration with legacy systems. 1586names are required, and for integration with legacy systems.
1536 1587
1537@node Resource Records in GNS 1588@node Resource Records in GNS
1538@subsection Resource Records in GNS 1589@subsection Resource Records in GNS
@@ -1569,18 +1620,31 @@ GNS currently supports the following record types:
1569* CNAME:: 1620* CNAME::
1570* GNS2DNS:: 1621* GNS2DNS::
1571* SOA SRV PTR and MX:: 1622* SOA SRV PTR and MX::
1623* PLACE::
1624* PHONE::
1625* ID ATTR::
1626* ID TOKEN::
1627* ID TOKEN METADATA::
1628* CREDENTIAL::
1629* POLICY::
1630* ATTRIBUTE::
1631* ABE KEY::
1632* ABE MASTER::
1633* RECLAIM OIDC CLIENT::
1634* RECLAIM OIDC REDIRECT::
1572@end menu 1635@end menu
1573 1636
1574@node NICK 1637@node NICK
1575@subsubsection NICK 1638@subsubsection NICK
1576 1639
1577A NICK record is used to give a zone a name. With a NICK record, you can 1640A NICK record is used to give a zone a name. With a NICK record, you
1578essentially specify how you would like to be called. GNS expects this 1641can essentially specify how you would like to be called. GNS expects
1579record under the empty label ``@@'' in the zone's database (NAMESTORE); however, 1642this record under the empty label ``@@'' in the zone's database
1580it will then automatically be copied into each record set, so that 1643(NAMESTORE); however, it will then automatically be copied into each
1581clients never need to do a separate lookup to discover the NICK record. 1644record set, so that clients never need to do a separate lookup to
1582Also, users do not usually have to worry about setting the NICK record: 1645discover the NICK record. Also, users do not usually have to worry
1583it is automatically set to the local name of the TLD. 1646about setting the NICK record: it is automatically set to the local
1647name of the TLD.
1584 1648
1585@b{Example}@ 1649@b{Example}@
1586 1650
@@ -1739,6 +1803,66 @@ should use the ZKEY zone as the destination hostname and
1739GNS-enabled mail servers should be configured to accept 1803GNS-enabled mail servers should be configured to accept
1740e-mails to the ZKEY-zones of all local users. 1804e-mails to the ZKEY-zones of all local users.
1741 1805
1806@node PLACE
1807@subsubsection PLACE
1808
1809Record type for a social place.
1810
1811@node PHONE
1812@subsubsection PHONE
1813
1814Record type for a phone (of CONVERSATION).
1815
1816@node ID ATTR
1817@subsubsection ID ATTR
1818
1819Record type for identity attributes (of IDENTITY).
1820
1821@node ID TOKEN
1822@subsubsection ID TOKEN
1823
1824Record type for an identity token (of IDENTITY-TOKEN).
1825
1826@node ID TOKEN METADATA
1827@subsubsection ID TOKEN METADATA
1828
1829Record type for the private metadata of an identity token (of IDENTITY-TOKEN).
1830
1831@node CREDENTIAL
1832@subsubsection CREDENTIAL
1833
1834Record type for credential.
1835
1836@node POLICY
1837@subsubsection POLICY
1838
1839Record type for policies.
1840
1841@node ATTRIBUTE
1842@subsubsection ATTRIBUTE
1843
1844Record type for reverse lookups.
1845
1846@node ABE KEY
1847@subsubsection ABE KEY
1848
1849Record type for ABE records.
1850
1851@node ABE MASTER
1852@subsubsection ABE MASTER
1853
1854Record type for ABE master keys.
1855
1856@node RECLAIM OIDC CLIENT
1857@subsubsection RECLAIM OIDC CLIENT
1858
1859Record type for reclaim OIDC clients.
1860
1861@node RECLAIM OIDC REDIRECT
1862@subsubsection RECLAIM OIDC REDIRECT
1863
1864Record type for reclaim OIDC redirect URIs.
1865
1742@node Synchronizing with legacy DNS 1866@node Synchronizing with legacy DNS
1743@subsection Synchronizing with legacy DNS 1867@subsection Synchronizing with legacy DNS
1744 1868
@@ -1769,6 +1893,98 @@ is thus advisable to disable the namecache by setting the
1769option ``DISABLE'' to ``YES'' in section ``[namecache]''. 1893option ``DISABLE'' to ``YES'' in section ``[namecache]''.
1770 1894
1771 1895
1896@node re@:claim Identity Provider
1897@section re@:claim Identity Provider
1898
1899The re:claim Identity Provider (IdP) is a decentralized IdP service.
1900It allows its users to manage and authorize third parties to access their identity attributes such as email or shipping addresses.
1901
1902It basically mimics the concepts of centralized IdPs, such as those offered by Google or Facebook.
1903Like other IdPs, re:claim features an (optional) OpenID-Connect 1.0-compliant protocol layer that can be used for websites to integrate re:claim as an Identity Provider with little effort.
1904
1905@menu
1906* Managing Attributes::
1907* Sharing Attributes with Third Parties::
1908* Revoking Authorizations of Third Parties::
1909* Using the OpenID-Connect IdP::
1910@end menu
1911
1912@node Managing Attributes
1913@subsection Managing Attributes
1914
1915Before adding attributes to an identity, you must first create an ego:
1916
1917@example
1918$ gnunet-identity -C "username"
1919@end example
1920
1921Henceforth, you can manage a new user profile of the user ``username''.
1922
1923To add an email address to your user profile, simply use the @command{gnunet-reclaim} command line tool::
1924
1925@example
1926$ gnunet-reclaim -e "username" -a "email" -V "username@@example.gnunet"
1927@end example
1928
1929All of your attributes can be listed using the @command{gnunet-reclaim}
1930command line tool as well:
1931
1932@example
1933$ gnunet-reclaim -e "username" -D
1934@end example
1935
1936Currently, and by default, attribute values are interpreted as plain text.
1937In the future there might be more value types such as X.509 certificate credentials.
1938
1939@node Sharing Attributes with Third Parties
1940@subsection Sharing Attributes with Third Parties
1941
1942If you want to allow a third party such as a website or friend to access to your attributes (or a subset thereof) execute:
1943
1944@example
1945$ gnunet-reclaim -e "username" -r "PKEY" -i "attribute1,attribute2,..."
1946@end example
1947
1948Where "PKEY" is the public key of the third party and "attribute1,attribute2,..." is a comma-separated list of attribute names, such as "email", that you want to share.
1949
1950The command will return a "ticket" string.
1951You must give this "ticket" to the requesting third party.
1952
1953The third party can then retrieve your shared identity attributes using:
1954
1955@example
1956$ gnunet-reclaim -e "friend" -C "ticket"
1957@end example
1958
1959This will retrieve and list the shared identity attributes.
1960The above command will also work if the user "username" is currently offline since the attributes are retrieved from GNS.
1961Further, the "ticket" can be re-used later to retrieve up-to-date attributes in case "username" has changed the value(s). For instance, becasue his email address changed.
1962
1963To list all given authorizations (tickets) you can execute:
1964@example
1965$ gnunet-reclaim -e "friend" -T (TODO there is only a REST API for this ATM)
1966@end example
1967
1968
1969@node Revoking Authorizations of Third Parties
1970@subsection Revoking Authorizations of Third Parties
1971
1972If you want to revoke the access of a third party to your attributes you can execute:
1973
1974@example
1975$ gnunet-idp -e "username" -R "ticket"
1976@end example
1977
1978This will prevent the third party from accessing the attribute in the future.
1979Please note that if the third party has previously accessed the attribute, there is not way in which the system could have prevented the thiry party from storing the data.
1980As such, only access to updated data in the future can be revoked.
1981This behaviour is _exactly the same_ as with other IdPs.
1982
1983@node Using the OpenID-Connect IdP
1984@subsection Using the OpenID-Connect IdP
1985
1986TODO: Document setup and REST endpoints
1987
1772@node Using the Virtual Public Network 1988@node Using the Virtual Public Network
1773@section Using the Virtual Public Network 1989@section Using the Virtual Public Network
1774 1990