doc/man/gnunet-publish.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" ``FDL-1.3''.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" ``GPL3''.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd November 16, 2015
  25 .Dt GNUNET-PUBLISH 1
  26 .Sh NAME
  27 .Nm gnunet-publish
  28 .Nd
  29 a command line interface for publishing new content into GNUnet
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
  33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  34 .Op Fl D | \-disable\-extractor
  35 .Op Fl E | \-enable\-creation\-time
  36 .Op Fl e | \-extract
  37 .Op Fl h | \-help
  38 .Op Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD
  39 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  40 .Op Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE
  41 .Op Fl n | \-noindex
  42 .Op Fl N Ar ID | Fl \-next= Ns Ar ID
  43 .Op Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
  44 .Op Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME
  45 .Op Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
  46 .Op Fl s | \-simulate-only
  47 .Op Fl t Ar ID, \-this= Ns Ar ID
  48 .Op Fl u Ar URI | Fl \-uri= Ns Ar URI
  49 .Op Fl v | \-version
  50 .Op Fl V | \-verbose
  51 .Ao Ar FILENAME Ac
  52 .Sh DESCRIPTION
  53 In order to share files with other GNUnet users, the files must first be made available to GNUnet.
  54 GNUnet does not automatically share all files from a certain directory (however, you can do this with the gnunet\-auto\-share tool).
  55 In fact, even files that are downloaded are not automatically shared.
  56 .Pp
  57 In order to start sharing files, the files must be added either using gnunet\-publish or a graphical interface such as gnunet\-fs\-gtk.
  58 The command line tool gnunet\-publish is more useful if many files are supposed to be added.
  59 gnunet\-publish can automatically publish batches of files, recursively publish directories, create directories that can be browsed within GNUnet and publish file lists in a namespace.
  60 When run on a directory, gnunet\-publish will always recursively publish all of the files in the directory.
  61 .Pp
  62 gnunet\-publish can automatically extract keywords from the files that are shared.
  63 Users that want to download files from GNUnet use keywords to search for the appropriate content.
  64 You can disable keyword extraction with the \-D option.
  65 You can manually add keywords using the \-k option.
  66 The keywords are case\-sensitive.
  67 .Pp
  68 In addition to searching for files by keyword, GNUnet allows organizing files into directories.
  69 With directories, the user only needs to find the directory in order to be able to download any of the files listed in the directory.
  70 Directories can contain pointers to other directories.
  71 .Pp
  72 With gnunet\-publish, it is easy to create new directories simultaneously when adding the files.
  73 Simply pass the name of a directory instead of a file.
  74 .Pp
  75 Since keywords can be spammed (any user can add any content under any keyword), GNUnet supports namespaces.
  76 A namespace is a subset of the searchspace into which only the holder of a certain pseudonym can add content.
  77 Any GNUnet user can create any number of pseudonyms using \fBgnunet\-pseudonym\fR.
  78 Pseudonyms are stored in the user's GNUnet directory.
  79 While pseudonyms are locally identified with an arbitrary string that the user selects when the pseudonym is created, the namespace is globally known only under the hash of the public key of the pseudonym.
  80 Since only the owner of the pseudonym can add content to the namespace, it is impossible for other users to pollute the namespace.
  81 gnunet\-publish automatically publishes the top\-directory (or the only file if only one file is specified) into the namespace if a pseudonym is specified.
  82 .Pp
  83 It is possible to update content in GNUnet if that content was placed and obtained from a particular namespace.
  84 Updates are only possible for content in namespaces since this is the only way to assure that a malicious party can not supply counterfeited updates.
  85 Note that an update with GNUnet does not make the old content unavailable, GNUnet merely allows the publisher to point users to more recent versions.
  86 You can use the \-N option to specify the future identifier of an update.
  87 When using this option, a GNUnet client that finds the current (\-t) identifier will automatically begin a search for the update (\-N) identifier.
  88 If you later publish an update under the (\-N) identifier, both results will be given to the user.
  89 .Pp
  90 You can use automatic meta\-data extraction (based on libextractor) or the command\-line option \-m to specify meta-data.
  91 For the \-m option you need to use the form keyword\-type:value.
  92 For example, use "\-m os:Linux" to specify that the operating system is Linux.
  93 Common meta\-data types are "author", "title" , "mimetype", "filename", "language", "subject" and "keywords".
  94 A full list can be obtained from the extract tool using the option \-\-list.
  95 The meta\-data is used to help users in searching for files on the network.
  96 The keywords are case\-sensitive.
  97 .Pp
  98 GNUnet supports two styles of publishing files on the network.
  99 Publishing a file means that a copy of the file is made in the local (!) database of the node.
 100 Indexing a file means that an index is added to the local (!) database with symbolic links to the file itself.
 101 The links will use the SHA-512 hash of the entire file as the filename.
 102 Indexing is generally significantly more efficient and the default choice.
 103 However, indexing only works if the indexed file can be read (using the same absolute path) by gnunet-service-fs.
 104 If this is not the case, indexing will fail (and gnunet\-publish will automatically revert to publishing instead).
 105 Regardless of which method is used to publish the file, the file will be slowly (depending on how often it is requested and on how much bandwidth is available) dispersed into the network.
 106 If you publish or index a file and then leave the network, it will almost always NOT be available anymore.
 107 .Bl -tag -width Ds
 108 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
 109 Use alternate config file FILENAME.
 110 If this option is not specified, the default is ~/.config/gnunet.conf).
 111 .It Fl D | \-disable\-extractor
 112 Disable use of GNU libextractor for finding additional keywords and metadata.
 113 .It Fl E | \-enable\-creation\-time
 114 Enable use of creation time timestamp in metadata.
 115 Setting this information will leak information about the time at which a file was made available.
 116 .It Fl e | \-extract
 117 Print the list of keywords that will be used for each file given the current options.
 118 Do not perform any indexing or publishing.
 119 .It Fl h | \-help
 120 Print a brief help page with all the options.
 121 .It Fl k Ar KEYWORD | Fl \-key= Ns Ar KEYWORD
 122 Additional key to index the content with (to add multiple keys, specify multiple times).
 123 Each additional key is case\-sensitive.
 124 Can be specified multiple times.
 125 The keyword is only applied to the top\-level file or directory.
 126 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
 127 Change the loglevel.
 128 Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
 129 .It Fl m Ar TYPE:VALUE | Fl \-meta= Ns Ar TYPE:VALUE
 130 For the main file (or directory), set the metadata of the given TYPE to the given VALUE.
 131 Note that this will not add the respective VALUE to the set of keywords under which the file can be found.
 132 .It Fl n | \-noindex
 133 Executive summary: You probably don't need it.
 134 Do not index, full publishing.
 135 Note that directories, information for keyword search, namespace search and indexing data are always published (even without this option).
 136 With this option, every block of the actual files is stored in encrypted form in the block database of the local peer.
 137 While this adds security if the local node is compromised (the adversary snags your machine), it is significantly less efficient compared to on\-demand encryption and is definitely not recommended for large files.
 138 .It Fl N Ar ID | Fl \-next= Ns Ar ID
 139 Specifies the next identifier of a future version of the file to be published under the same pseudonym.
 140 This option is only valid together with the \-P option.
 141 This option can be used to specify what the identifier of an updated version will look like.
 142 Note that specifying \-i and \-N without \-t is not allowed.
 143 .It Fl p Ar PRIORITY | Fl \-prio= Ns Ar PRIORITY
 144 Executive summary: You probably don't need it.
 145 Set the priority of the published content (default: 365).
 146 If the local database is full, GNUnet will discard the content with the lowest ranking.
 147 Note that ranks change over time depending on popularity.
 148 The default should be high enough to preserve the locally published content in favor of content that migrates from other peers.
 149 .It Fl P Ar NAME | Fl \-pseudonym= Ns Ar NAME
 150 For the top\-level directory or file, places the file into the namespace identified by the pseudonym NAME.
 151 NAME must be a valid pseudonym managed by gnunet\-identity.
 152 .It Fl r Ar LEVEL | Fl \-replication= Ns Ar LEVEL
 153 Set the desired replication level.
 154 If CONTENT_PUSHING is set to YES, GNUnet will push each block (for the file) LEVEL times to other peers before doing normal "random" replication of all content.
 155 This option can be used to push some content out into the network harder.
 156 Note that pushing content LEVEL times into the network does not guarantee that there will actually be LEVEL replicas.
 157 .It Fl s | \-simulate-only
 158 When this option is used, gnunet\-publish will not actually publish the file but just simulate what would be done.
 159 This can be used to compute the GNUnet URI for a file without actually sharing it.
 160 .It Fl t Ar ID, \-this= Ns Ar ID
 161 Specifies the identifier under which the file is to be published under a pseudonym.
 162 This option is only valid together with the\ \-P option.
 163 .It Fl u Ar URI | Fl \-uri= Ns Ar URI
 164 This option can be used to specify the URI of a file instead of a filename (this is the only case where the otherwise mandatory filename argument must be omitted).
 165 Instead of publishing a file or directory and using the corresponding URI, gnunet\-publish will use this URI and perform the selected namespace or keyword operations.
 166 This can be used to add additional keywords to a file that has already been shared or to add files to a namespace for which the URI is known but the content is not locally available.
 167 .It Fl v | \-version
 168 Print the version number.
 169 .It Fl V | \-verbose
 170 Be verbose.
 171 Using this option causes gnunet\-publish to print progress information and at the end the file identification that can be used to download the file from GNUnet.
 172 .El
 173 .Ss SETTING ANONYMITY LEVEL
 174 .Bl -tag -width Ds
 175 .It Fl a Ar LEVEL | Fl \-anonymity= Ns Ar LEVEL
 176 .El
 177 .sp
 178 The \fB\-a\fR option can be used to specify additional anonymity constraints.
 179 If set to 0, GNUnet will publish the file non-anonymously and in fact sign the advertisement for the file using your peer's private key.
 180 This will allow other users to download the file as fast as possible, including using non-anonymous methods (DHT, direct transfer).
 181 If you set it to 1 (default), you use the standard anonymous routing algorithm (which does not explicitly leak your identity).
 182 However, a powerful adversary may still be able to perform traffic analysis (statistics) to over time infer data about your identity.
 183 You can gain better privacy by specifying a higher level of anonymity, which increases the amount of cover traffic your own traffic will get, at the expense of performance.
 184 Note that regardless of the anonymity level you choose, peers that cache content in the network always use anonymity level 1.
 185 .Pp
 186 The definition of the ANONYMITY LEVEL is the following.
 187 0 means no anonymity is required.
 188 Otherwise a value of 'v' means that 1 out of v bytes of "anonymous" traffic can be from the local user, leaving 'v-1' bytes of cover traffic per byte on the wire.
 189 Thus, if GNUnet routes n bytes of messages from foreign peers (using anonymous routing), it may originate n/(v-1) bytes of data in the same time\-period.
 190 The time\-period is twice the average delay that GNUnet defers forwarded queries.
 191 .Pp
 192 The default is 1 and this should be fine for most users.
 193 Also notice that if you choose very large values, you may end up having no throughput at all, especially if many of your fellow GNUnet\-peers all do the same.
 194 .Sh EXAMPLES
 195 .Ss BASIC EXAMPLES
 196 Index a file COPYING:
 197 .Pp
 198 .Dl gnunet-publish COPYING
 199 .Pp
 200 Publish a file COPYING:
 201 .Pp
 202 .Dl gnunet\-publish \-n COPYING
 203 .Pp
 204 Index a file COPYING with the keywords \fBgpl\fR and \fBtest\fR
 205 .Pp
 206 .Dl gnunet\-publish \-k gpl \-k test COPYING
 207 .Pp
 208 Index a file COPYING with description "GNU License", mime-type "text/plain" and keywords \fBgpl\fR and \fBtest\fR
 209 .Pp
 210 .Dl gnunet\-publish \-m "description:GNU License" \-k gpl \-k test \-m "mimetype:text/plain" COPYING
 211 .Pp
 212 .Ss USING DIRECTORIES
 213 Index the files COPYING and AUTHORS with keyword \fBtest\fR and build a directory containing the two files.
 214 Make the directory itself available under keyword \fBgnu\fR and disable keyword extraction using libextractor
 215 .Pp
 216 .Dl mkdir gnu ; mv COPYING AUTHORS gnu/ ; gnunet\-publish \-k test \-k gnu \-D gnu/
 217 .Pp
 218 Neatly publish an image gallery in \fBkittendir/\fR and its subdirs with keyword \fBkittens\fR for the directory but no keywords for the individual files or subdirs (\-n).
 219 Force description for all files.
 220 .Pp
 221 .Dl gnunet\-publish \-n \-m "description:Kitten collection" \-k kittens kittendir/
 222 .Pp
 223 .Ss SECURE PUBLISHING WITH NAMESPACES
 224 Publish file COPYING with pseudonym RIAA-2 (\-P) and with identifier \fBgpl\fR (\-t) and no updates.
 225 .Pp
 226 .Dl gnunet\-publish \-P RIAA-2 \-t gpl COPYING
 227 .Pp
 228 Recursively index /home/ogg and build a matching directory structure.
 229 Publish the top\-level directory into the namespace under the pseudonym RIAA\-2 (\-P) under identifier 'MUSIC' (\-t) and promise to provide an update with identifier 'VIDEOS' (\-N):
 230 .Pp
 231 .Dl gnunet\-publish \-P RIAA-2 \-t MUSIC \-N VIDEOS /home/ogg
 232 .Pp
 233 Recursively publish (\-n) /var/lib/mysql and build a matching directory structure, but disable the use of libextractor to extract keywords (\-n).
 234 Print the file identifiers (\-V) that can be used to retrieve the files.
 235 This will store a copy of the MySQL database in GNUnet but without adding any keywords to search for it.
 236 Thus only people that have been told the secret file identifiers printed with the \-V option can retrieve the (secret?) files:
 237 .Pp
 238 .Dl gnunet\-publish \-nV /var/lib/mysql
 239 .Pp
 240 Create a namespace entry 'root' in namespace MPAA-1 and announce that the next update will be called 'next':
 241 .Pp
 242 .Dl gnunet\-publish \-P MPAA-1 \-t root \-N next noise.mp3
 243 .Pp
 244 Update the previous entry, do not allow any future updates:
 245 .Pp
 246 .Dl gnunet\-publish \-P MPAA-1 \-t next noise_updated.mp3
 247 .Pp
 248 .Sh FILES
 249 .TP
 250 ~/.config/gnunet.conf
 251 GNUnet configuration file
 252 .Sh SEE ALSO
 253 .Xr gnunet-auto-share 1 ,
 254 .Xr gnunet-fs-gtk 1 ,
 255 .Xr gnunet-search 1 ,
 256 .Xr gnunet-download 1 ,
 257 .Xr gnunet.conf 5 ,
 258 .Xr extract 1 ,
 259 .Xr gnunet-identity 1
 260 .sp
 261 The full documentation for gnunet is maintained as a Texinfo manual.
 262 If the
 263 .Xr info 1
 264 and gnunet programs are properly installed at your site, the command
 265 .Pp
 266 .Dl info gnunet
 267 .Pp
 268 should give you access to the complete handbook,
 269 .Pp
 270 .Dl info gnunet-c-tutorial
 271 .Pp
 272 will give you access to a tutorial for developers.
 273 .sp
 274 Depending on your installation, this information is also available in
 275 .Xr gnunet 7 and
 276 .Xr gnunet-c-tutorial 7 .
 277 .\".Sh HISTORY
 278 .\".Sh AUTHORS
 279 .Sh BUGS
 280 Report bugs by using
 281 .Lk https://bugs.gnunet.org
 282 or by sending electronic mail to
 283 .Aq Mt gnunet-developers@gnu.org .