2 This file is part of GNUnet.
3 (C) 2003--2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief Parses and produces uri strings.
24 * @author Igor Wronsky, Christian Grothoff
26 * GNUnet URIs are of the general form "gnunet://MODULE/IDENTIFIER".
27 * The specific structure of "IDENTIFIER" depends on the module and
28 * maybe differenciated into additional subcategories if applicable.
29 * This module only deals with fs identifiers (MODULE = "fs").
32 * This module only parses URIs for the AFS module. The FS URIs fall
33 * into four categories, "chk", "sks", "ksk" and "loc". The first three
34 * categories were named in analogy (!) to Freenet, but they do NOT
35 * work in exactly the same way. They are very similar from the user's
36 * point of view (unique file identifier, subspace, keyword), but the
37 * implementation is rather different in pretty much every detail.
38 * The concrete URI formats are:
42 * First, there are URIs that identify a file. They have the format
43 * "gnunet://fs/chk/HEX1.HEX2.SIZE". These URIs can be used to
44 * download the file. The description, filename, mime-type and other
45 * meta-data is NOT part of the file-URI since a URI uniquely
46 * identifies a resource (and the contents of the file would be the
47 * same even if it had a different description).
51 * The second category identifies entries in a namespace. The format
52 * is "gnunet://fs/sks/NAMESPACE/IDENTIFIER" where the namespace
53 * should be given in HEX. Applications may allow using a nickname
54 * for the namespace if the nickname is not ambiguous. The identifier
55 * can be either an ASCII sequence or a HEX-encoding. If the
56 * identifier is in ASCII but the format is ambiguous and could denote
57 * a HEX-string a "/" is appended to indicate ASCII encoding.
61 * The third category identifies ordinary searches. The format is
62 * "gnunet://fs/ksk/KEYWORD[+KEYWORD]*". Using the "+" syntax
63 * it is possible to encode searches with the boolean "AND" operator.
64 * "+" is used since it indicates a commutative 'and' operation and
65 * is unlikely to be used in a keyword by itself.
69 * The last category identifies a datum on a specific machine. The
70 * format is "gnunet://fs/loc/HEX1.HEX2.SIZE.PEER.SIG.EXPTIME". PEER is
71 * the BinName of the public key of the peer storing the datum. The
72 * signature (SIG) certifies that this peer has this content.
73 * HEX1, HEX2 and SIZE correspond to a 'chk' URI.
77 * The encoding for hexadecimal values is defined in the hashing.c
78 * module in the gnunetutil library and discussed there.
82 #include "gnunet_fs_service.h"
83 #include "gnunet_signatures.h"
94 * Get a unique key from a URI. This is for putting URIs
95 * into HashMaps. The key may change between FS implementations.
97 * @param uri uri to convert to a unique key
98 * @param key wherer to store the unique key
101 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri, struct GNUNET_HashCode * key)
105 case GNUNET_FS_URI_CHK:
106 *key = uri->data.chk.chk.query;
108 case GNUNET_FS_URI_SKS:
109 GNUNET_CRYPTO_hash (uri->data.sks.identifier,
110 strlen (uri->data.sks.identifier), key);
112 case GNUNET_FS_URI_KSK:
113 if (uri->data.ksk.keywordCount > 0)
114 GNUNET_CRYPTO_hash (uri->data.ksk.keywords[0],
115 strlen (uri->data.ksk.keywords[0]), key);
117 case GNUNET_FS_URI_LOC:
118 GNUNET_CRYPTO_hash (&uri->data.loc.fi,
119 sizeof (struct FileIdentifier) +
120 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded),
124 memset (key, 0, sizeof (struct GNUNET_HashCode));
131 * Convert keyword URI to a human readable format
132 * (i.e. the search query that was used in the first place)
134 * @param uri ksk uri to convert to a string
135 * @return string with the keywords
138 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri)
145 unsigned int keywordCount;
147 if ((uri == NULL) || (uri->type != GNUNET_FS_URI_KSK))
152 keywords = uri->data.ksk.keywords;
153 keywordCount = uri->data.ksk.keywordCount;
154 n = keywordCount + 1;
155 for (i = 0; i < keywordCount; i++)
157 keyword = keywords[i];
158 n += strlen (keyword) - 1;
159 if (NULL != strstr (&keyword[1], " "))
161 if (keyword[0] == '+')
164 ret = GNUNET_malloc (n);
166 for (i = 0; i < keywordCount; i++)
168 keyword = keywords[i];
169 if (NULL != strstr (&keyword[1], " "))
172 if (keyword[0] == '+')
173 strcat (ret, keyword);
175 strcat (ret, &keyword[1]);
180 if (keyword[0] == '+')
181 strcat (ret, keyword);
183 strcat (ret, &keyword[1]);
192 * Given a keyword with %-encoding (and possibly quotes to protect
193 * spaces), return a copy of the keyword without %-encoding and
194 * without double-quotes (%22). Also, add a space at the beginning
195 * if there is not a '+'.
197 * @param in string with %-encoding
198 * @param emsg where to store the parser error message (if any)
199 * @return decodded string with leading space (or preserved plus)
202 percent_decode_keyword (const char *in, char **emsg)
210 out = GNUNET_strdup (in);
213 while (out[rpos] != '\0')
215 if (out[rpos] == '%')
217 if (1 != SSCANF (&out[rpos + 1], "%2X", &hx))
220 *emsg = GNUNET_strdup (_(/* xgettext:no-c-format */
221 "`%' must be followed by HEX number"));
226 continue; /* skip double quote */
227 out[wpos++] = (char) hx;
231 out[wpos++] = out[rpos++];
237 ret = GNUNET_strdup (out);
241 /* need to prefix with space */
242 ret = GNUNET_malloc (strlen (out) + 2);
250 #define GNUNET_FS_URI_KSK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX
255 * @param s an uri string
256 * @param emsg where to store the parser error message (if any)
257 * @return NULL on error, otherwise the KSK URI
259 static struct GNUNET_FS_Uri *
260 uri_ksk_parse (const char *s, char **emsg)
262 struct GNUNET_FS_Uri *ret;
272 GNUNET_assert (s != NULL);
274 pos = strlen (GNUNET_FS_URI_KSK_PREFIX);
275 if ((slen <= pos) || (0 != strncmp (s, GNUNET_FS_URI_KSK_PREFIX, pos)))
276 return NULL; /* not KSK URI */
277 if ((s[slen - 1] == '+') || (s[pos] == '+'))
280 GNUNET_strdup (_("Malformed KSK URI (must not begin or end with `+')"));
285 for (i = pos; i < slen; i++)
287 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
289 saw_quote = (saw_quote + 1) % 2;
293 if ((s[i] == '+') && (saw_quote == 0))
298 *emsg = GNUNET_strdup (_("`++' not allowed in KSK URI"));
305 *emsg = GNUNET_strdup (_("Quotes not balanced in KSK URI"));
309 dup = GNUNET_strdup (s);
310 keywords = GNUNET_malloc (max * sizeof (char *));
311 for (i = slen - 1; i >= pos; i--)
313 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
315 saw_quote = (saw_quote + 1) % 2;
319 if ((dup[i] == '+') && (saw_quote == 0))
321 keywords[--max] = percent_decode_keyword (&dup[i + 1], emsg);
322 if (NULL == keywords[max])
327 keywords[--max] = percent_decode_keyword (&dup[pos], emsg);
328 if (NULL == keywords[max])
330 GNUNET_assert (max == 0);
332 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
333 ret->type = GNUNET_FS_URI_KSK;
334 ret->data.ksk.keywordCount = iret;
335 ret->data.ksk.keywords = keywords;
338 for (i = 0; i < max; i++)
339 GNUNET_free_non_null (keywords[i]);
340 GNUNET_free (keywords);
346 #define GNUNET_FS_URI_SKS_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX
351 * @param s an uri string
352 * @param emsg where to store the parser error message (if any)
353 * @return NULL on error, SKS URI otherwise
355 static struct GNUNET_FS_Uri *
356 uri_sks_parse (const char *s, char **emsg)
358 struct GNUNET_FS_Uri *ret;
359 struct GNUNET_FS_PseudonymIdentifier id;
363 GNUNET_assert (s != NULL);
364 pos = strlen (GNUNET_FS_URI_SKS_PREFIX);
365 if ((strlen (s) <= pos) || (0 != strncmp (s, GNUNET_FS_URI_SKS_PREFIX, pos)))
366 return NULL; /* not an SKS URI */
367 end = strchr (&s[pos], '/');
368 if ( (NULL == end) ||
370 GNUNET_STRINGS_string_to_data (&s[pos],
375 *emsg = GNUNET_strdup (_("Malformed SKS URI"));
376 return NULL; /* malformed */
378 end++; /* skip over '/' */
379 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
380 ret->type = GNUNET_FS_URI_SKS;
381 ret->data.sks.ns = id;
382 ret->data.sks.identifier = GNUNET_strdup (end);
386 #define GNUNET_FS_URI_CHK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX
392 * @param s an uri string
393 * @param emsg where to store the parser error message (if any)
394 * @return NULL on error, CHK URI otherwise
396 static struct GNUNET_FS_Uri *
397 uri_chk_parse (const char *s, char **emsg)
399 struct GNUNET_FS_Uri *ret;
400 struct FileIdentifier fi;
402 unsigned long long flen;
404 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
405 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
409 GNUNET_assert (s != NULL);
411 pos = strlen (GNUNET_FS_URI_CHK_PREFIX);
412 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
413 (0 != strncmp (s, GNUNET_FS_URI_CHK_PREFIX, pos)))
414 return NULL; /* not a CHK URI */
415 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
416 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
418 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
421 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
422 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
423 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
424 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
425 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
427 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &fi.chk.key)) ||
428 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &fi.chk.query)) ||
430 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
433 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
436 fi.file_length = GNUNET_htonll (flen);
437 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
438 ret->type = GNUNET_FS_URI_CHK;
445 * Convert a character back to the binary value
446 * that it represents (given base64-encoding).
448 * @param a character to convert
449 * @return offset in the "tbl" array
452 c2v (unsigned char a)
454 if ((a >= '0') && (a <= '9'))
456 if ((a >= 'A') && (a <= 'Z'))
457 return (a - 'A' + 10);
458 if ((a >= 'a') && (a <= 'z'))
459 return (a - 'a' + 36);
469 * Convert string back to binary data.
471 * @param input '\\0'-terminated string
472 * @param data where to write binary data
473 * @param size how much data should be converted
474 * @return number of characters processed from input,
478 enc2bin (const char *input, void *data, size_t size)
486 if (((size * 8) % 6) != 0)
488 if (strlen (input) < len)
489 return -1; /* error! */
493 for (pos = 0; pos < size; pos++)
497 bits |= (c2v (input[len++]) << hbits);
500 (((unsigned char *) data)[pos]) = (unsigned char) bits;
509 * Structure that defines how the
510 * contents of a location URI must be
511 * assembled in memory to create or
512 * verify the signature of a location
515 struct LocUriAssembly
517 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
519 struct GNUNET_TIME_AbsoluteNBO exptime;
521 struct FileIdentifier fi;
523 struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded peer;
528 #define GNUNET_FS_URI_LOC_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX
532 * Also verifies validity of the location URI.
534 * @param s an uri string
535 * @param emsg where to store the parser error message (if any)
536 * @return NULL on error, valid LOC URI otherwise
538 static struct GNUNET_FS_Uri *
539 uri_loc_parse (const char *s, char **emsg)
541 struct GNUNET_FS_Uri *uri;
542 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
543 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
546 unsigned long long exptime;
547 unsigned long long flen;
548 struct GNUNET_TIME_Absolute et;
549 struct GNUNET_CRYPTO_EccSignature sig;
550 struct LocUriAssembly ass;
554 GNUNET_assert (s != NULL);
556 pos = strlen (GNUNET_FS_URI_LOC_PREFIX);
557 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
558 (0 != strncmp (s, GNUNET_FS_URI_LOC_PREFIX, pos)))
559 return NULL; /* not an SKS URI */
560 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
561 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
563 *emsg = GNUNET_strdup (_("SKS URI malformed"));
566 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
567 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
568 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
569 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
570 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
572 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &ass.fi.chk.key)) ||
573 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &ass.fi.chk.query)) ||
575 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
578 *emsg = GNUNET_strdup (_("SKS URI malformed"));
581 ass.fi.file_length = GNUNET_htonll (flen);
583 npos = pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2;
584 while ((s[npos] != '\0') && (s[npos] != '.'))
588 *emsg = GNUNET_strdup (_("SKS URI malformed"));
593 enc2bin (&s[npos], &ass.peer,
594 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded));
598 GNUNET_strdup (_("SKS URI malformed (could not decode public key)"));
602 if (s[npos++] != '.')
604 *emsg = GNUNET_strdup (_("SKS URI malformed (could not find signature)"));
607 ret = enc2bin (&s[npos], &sig, sizeof (struct GNUNET_CRYPTO_EccSignature));
610 *emsg = GNUNET_strdup (_("SKS URI malformed (could not decode signature)"));
614 if (s[npos++] != '.')
616 *emsg = GNUNET_strdup (_("SKS URI malformed"));
619 if (1 != SSCANF (&s[npos], "%llu", &exptime))
623 ("SKS URI malformed (could not parse expiration time)"));
626 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
627 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
628 et.abs_value = exptime;
629 ass.exptime = GNUNET_TIME_absolute_hton (et);
631 GNUNET_CRYPTO_ecc_verify (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT,
632 &ass.purpose, &sig, &ass.peer))
635 GNUNET_strdup (_("SKS URI malformed (signature failed validation)"));
638 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
639 uri->type = GNUNET_FS_URI_LOC;
640 uri->data.loc.fi = ass.fi;
641 uri->data.loc.peer = ass.peer;
642 uri->data.loc.expirationTime = et;
643 uri->data.loc.contentSignature = sig;
652 * Convert a UTF-8 String to a URI.
654 * @param uri string to parse
655 * @param emsg where to store the parser error message (if any)
656 * @return NULL on error
658 struct GNUNET_FS_Uri *
659 GNUNET_FS_uri_parse (const char *uri, char **emsg)
661 struct GNUNET_FS_Uri *ret;
667 if ((NULL != (ret = uri_chk_parse (uri, emsg))) ||
668 (NULL != (ret = uri_ksk_parse (uri, emsg))) ||
669 (NULL != (ret = uri_sks_parse (uri, emsg))) ||
670 (NULL != (ret = uri_loc_parse (uri, emsg))))
673 *emsg = GNUNET_strdup (_("Unrecognized URI type"));
683 * @param uri uri to free
686 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri)
690 GNUNET_assert (uri != NULL);
693 case GNUNET_FS_URI_KSK:
694 for (i = 0; i < uri->data.ksk.keywordCount; i++)
695 GNUNET_free (uri->data.ksk.keywords[i]);
696 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount, 0);
698 case GNUNET_FS_URI_SKS:
699 GNUNET_free (uri->data.sks.identifier);
701 case GNUNET_FS_URI_LOC:
711 * How many keywords are ANDed in this keyword URI?
713 * @param uri ksk uri to get the number of keywords from
714 * @return 0 if this is not a keyword URI
717 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
719 if (uri->type != GNUNET_FS_URI_KSK)
721 return uri->data.ksk.keywordCount;
726 * Iterate over all keywords in this keyword URI.
728 * @param uri ksk uri to get the keywords from
729 * @param iterator function to call on each keyword
730 * @param iterator_cls closure for iterator
731 * @return -1 if this is not a keyword URI, otherwise number of
732 * keywords iterated over until iterator aborted
735 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
736 GNUNET_FS_KeywordIterator iterator,
742 if (uri->type != GNUNET_FS_URI_KSK)
744 if (iterator == NULL)
745 return uri->data.ksk.keywordCount;
746 for (i = 0; i < uri->data.ksk.keywordCount; i++)
748 keyword = uri->data.ksk.keywords[i];
749 /* first character of keyword indicates
750 * if it is mandatory or not */
751 if (GNUNET_OK != iterator (iterator_cls, &keyword[1], keyword[0] == '+'))
759 * Add the given keyword to the set of keywords represented by the URI.
760 * Does nothing if the keyword is already present.
762 * @param uri ksk uri to modify
763 * @param keyword keyword to add
764 * @param is_mandatory is this keyword mandatory?
767 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri, const char *keyword,
774 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
775 for (i = 0; i < uri->data.ksk.keywordCount; i++)
777 old = uri->data.ksk.keywords[i];
778 if (0 == strcmp (&old[1], keyword))
781 GNUNET_asprintf (&n, is_mandatory ? "+%s" : " %s", keyword);
782 GNUNET_array_append (uri->data.ksk.keywords, uri->data.ksk.keywordCount, n);
787 * Remove the given keyword from the set of keywords represented by the URI.
788 * Does nothing if the keyword is not present.
790 * @param uri ksk uri to modify
791 * @param keyword keyword to add
794 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
800 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
801 for (i = 0; i < uri->data.ksk.keywordCount; i++)
803 old = uri->data.ksk.keywords[i];
804 if (0 == strcmp (&old[1], keyword))
806 uri->data.ksk.keywords[i] =
807 uri->data.ksk.keywords[uri->data.ksk.keywordCount - 1];
808 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount,
809 uri->data.ksk.keywordCount - 1);
818 * Obtain the identity of the peer offering the data
820 * @param uri the location URI to inspect
821 * @param peer where to store the identify of the peer (presumably) offering the content
822 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
825 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
826 struct GNUNET_PeerIdentity *peer)
828 if (uri->type != GNUNET_FS_URI_LOC)
829 return GNUNET_SYSERR;
830 GNUNET_CRYPTO_hash (&uri->data.loc.peer,
831 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded),
838 * Obtain the expiration of the LOC URI.
840 * @param uri location URI to get the expiration from
841 * @return expiration time of the URI
843 struct GNUNET_TIME_Absolute
844 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri)
846 GNUNET_assert (uri->type == GNUNET_FS_URI_LOC);
847 return uri->data.loc.expirationTime;
853 * Obtain the URI of the content itself.
855 * @param uri location URI to get the content URI from
856 * @return NULL if argument is not a location URI
858 struct GNUNET_FS_Uri *
859 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
861 struct GNUNET_FS_Uri *ret;
863 if (uri->type != GNUNET_FS_URI_LOC)
865 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
866 ret->type = GNUNET_FS_URI_CHK;
867 ret->data.chk = uri->data.loc.fi;
873 * Construct a location URI (this peer will be used for the location).
875 * @param baseUri content offered by the sender
876 * @param cfg configuration information (used to find our hostkey)
877 * @param expiration_time how long will the content be offered?
878 * @return the location URI, NULL on error
880 struct GNUNET_FS_Uri *
881 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
882 const struct GNUNET_CONFIGURATION_Handle *cfg,
883 struct GNUNET_TIME_Absolute expiration_time)
885 struct GNUNET_FS_Uri *uri;
886 struct GNUNET_CRYPTO_EccPrivateKey *my_private_key;
887 struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded my_public_key;
889 struct LocUriAssembly ass;
891 if (baseUri->type != GNUNET_FS_URI_CHK)
894 GNUNET_CONFIGURATION_get_value_filename (cfg, "PEER", "PRIVATE_KEY",
897 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
898 _("Lacking key configuration settings.\n"));
901 if (NULL == (my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile)))
903 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
904 _("Could not access hostkey file `%s'.\n"), keyfile);
905 GNUNET_free (keyfile);
908 GNUNET_free (keyfile);
909 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
910 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
911 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
912 ass.exptime = GNUNET_TIME_absolute_hton (expiration_time);
913 ass.fi = baseUri->data.chk;
914 ass.peer = my_public_key;
915 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
916 uri->type = GNUNET_FS_URI_LOC;
917 uri->data.loc.fi = baseUri->data.chk;
918 uri->data.loc.expirationTime = expiration_time;
919 uri->data.loc.peer = my_public_key;
920 GNUNET_assert (GNUNET_OK ==
921 GNUNET_CRYPTO_ecc_sign (my_private_key, &ass.purpose,
922 &uri->data.loc.contentSignature));
923 GNUNET_CRYPTO_ecc_key_free (my_private_key);
929 * Create an SKS URI from a namespace and an identifier.
931 * @param ns namespace
932 * @param id identifier
933 * @param emsg where to store an error message
934 * @return an FS URI for the given namespace and identifier
936 struct GNUNET_FS_Uri *
937 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns, const char *id,
940 struct GNUNET_FS_Uri *ns_uri;
945 *emsg = GNUNET_strdup (_("identifier is NULL!"));
948 else if ('\0' == id[0])
951 *emsg = GNUNET_strdup (_("identifier has zero length!"));
956 ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
957 ns_uri->type = GNUNET_FS_URI_SKS;
958 GNUNET_FS_namespace_get_public_identifier (ns, &ns_uri->data.sks.ns);
959 ns_uri->data.sks.identifier = GNUNET_strdup (id);
965 * Create an SKS URI from a namespace ID and an identifier.
967 * @param pseudonym namespace ID
968 * @param id identifier
969 * @return an FS URI for the given namespace and identifier
971 struct GNUNET_FS_Uri *
972 GNUNET_FS_uri_sks_create_from_nsid (struct GNUNET_FS_PseudonymIdentifier *pseudonym,
975 struct GNUNET_FS_Uri *ns_uri;
977 ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
978 ns_uri->type = GNUNET_FS_URI_SKS;
979 ns_uri->data.sks.ns = *pseudonym;
980 ns_uri->data.sks.identifier = GNUNET_strdup (id);
986 * Merge the sets of keywords from two KSK URIs.
987 * (useful for merging the canonicalized keywords with
988 * the original keywords for sharing).
990 * @param u1 first uri
991 * @param u2 second uri
992 * @return merged URI, NULL on error
994 struct GNUNET_FS_Uri *
995 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
996 const struct GNUNET_FS_Uri *u2)
998 struct GNUNET_FS_Uri *ret;
1006 if ((u1 == NULL) && (u2 == NULL))
1009 return GNUNET_FS_uri_dup (u2);
1011 return GNUNET_FS_uri_dup (u1);
1012 if ((u1->type != GNUNET_FS_URI_KSK) || (u2->type != GNUNET_FS_URI_KSK))
1017 kc = u1->data.ksk.keywordCount;
1018 kl = GNUNET_malloc ((kc + u2->data.ksk.keywordCount) * sizeof (char *));
1019 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1020 kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
1021 for (i = 0; i < u2->data.ksk.keywordCount; i++)
1023 kp = u2->data.ksk.keywords[i];
1025 for (j = 0; j < u1->data.ksk.keywordCount; j++)
1026 if (0 == strcmp (kp + 1, kl[j] + 1))
1034 kl[kc++] = GNUNET_strdup (kp);
1036 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1037 ret->type = GNUNET_FS_URI_KSK;
1038 ret->data.ksk.keywordCount = kc;
1039 ret->data.ksk.keywords = kl;
1047 * @param uri the URI to duplicate
1048 * @return copy of the URI
1050 struct GNUNET_FS_Uri *
1051 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
1053 struct GNUNET_FS_Uri *ret;
1058 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1059 memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
1062 case GNUNET_FS_URI_KSK:
1063 if (ret->data.ksk.keywordCount >=
1064 GNUNET_MAX_MALLOC_CHECKED / sizeof (char *))
1070 if (ret->data.ksk.keywordCount > 0)
1072 ret->data.ksk.keywords =
1073 GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
1074 for (i = 0; i < ret->data.ksk.keywordCount; i++)
1075 ret->data.ksk.keywords[i] = GNUNET_strdup (uri->data.ksk.keywords[i]);
1078 ret->data.ksk.keywords = NULL; /* just to be sure */
1080 case GNUNET_FS_URI_SKS:
1081 ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1083 case GNUNET_FS_URI_LOC:
1093 * Create an FS URI from a single user-supplied string of keywords.
1094 * The string is broken up at spaces into individual keywords.
1095 * Keywords that start with "+" are mandatory. Double-quotes can
1096 * be used to prevent breaking up strings at spaces (and also
1097 * to specify non-mandatory keywords starting with "+").
1099 * Keywords must contain a balanced number of double quotes and
1100 * double quotes can not be used in the actual keywords (for
1101 * example, the string '""foo bar""' will be turned into two
1102 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1104 * @param keywords the keyword string
1105 * @param emsg where to store an error message
1106 * @return an FS URI for the given keywords, NULL
1107 * if keywords is not legal (i.e. empty).
1109 struct GNUNET_FS_Uri *
1110 GNUNET_FS_uri_ksk_create (const char *keywords, char **emsg)
1113 unsigned int num_Words;
1116 struct GNUNET_FS_Uri *uri;
1120 if (keywords == NULL)
1122 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1126 searchString = GNUNET_strdup (keywords);
1131 while ('\0' != *pos)
1133 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1137 else if (0 == inWord)
1143 saw_quote = (saw_quote + 1) % 2;
1148 GNUNET_free (searchString);
1149 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1154 GNUNET_free (searchString);
1155 *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1158 keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1162 while ('\0' != *pos)
1164 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1169 else if (0 == inWord)
1171 keywordarr[num_Words] = pos;
1176 saw_quote = (saw_quote + 1) % 2;
1180 GNUNET_FS_uri_ksk_create_from_args (num_Words,
1181 (const char **) keywordarr);
1182 GNUNET_free (keywordarr);
1183 GNUNET_free (searchString);
1189 * Create an FS URI from a user-supplied command line of keywords.
1190 * Arguments should start with "+" to indicate mandatory
1193 * @param argc number of keywords
1194 * @param argv keywords (double quotes are not required for
1195 * keywords containing spaces; however, double
1196 * quotes are required for keywords starting with
1197 * "+"); there is no mechanism for having double
1198 * quotes in the actual keywords (if the user
1199 * did specifically specify double quotes, the
1200 * caller should convert each double quote
1201 * into two single quotes).
1202 * @return an FS URI for the given keywords, NULL
1203 * if keywords is not legal (i.e. empty).
1205 struct GNUNET_FS_Uri *
1206 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc, const char **argv)
1209 struct GNUNET_FS_Uri *uri;
1210 const char *keyword;
1218 /* allow URI to be given as one and only keyword and
1219 * handle accordingly */
1221 if ((argc == 1) && (strlen (argv[0]) > strlen (GNUNET_FS_URI_PREFIX)) &&
1223 strncmp (argv[0], GNUNET_FS_URI_PREFIX, strlen (GNUNET_FS_URI_PREFIX)))
1224 && (NULL != (uri = GNUNET_FS_uri_parse (argv[0], &emsg))))
1226 GNUNET_free_non_null (emsg);
1227 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1228 uri->type = GNUNET_FS_URI_KSK;
1229 uri->data.ksk.keywordCount = argc;
1230 uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1231 for (i = 0; i < argc; i++)
1234 if (keyword[0] == '+')
1235 val = GNUNET_strdup (keyword);
1237 GNUNET_asprintf (&val, " %s", keyword);
1248 uri->data.ksk.keywords[i] = val;
1255 * Test if two URIs are equal.
1257 * @param u1 one of the URIs
1258 * @param u2 the other URI
1259 * @return GNUNET_YES if the URIs are equal
1262 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1263 const struct GNUNET_FS_Uri *u2)
1269 GNUNET_assert (u1 != NULL);
1270 GNUNET_assert (u2 != NULL);
1271 if (u1->type != u2->type)
1275 case GNUNET_FS_URI_CHK:
1277 memcmp (&u1->data.chk, &u2->data.chk, sizeof (struct FileIdentifier)))
1280 case GNUNET_FS_URI_SKS:
1282 memcmp (&u1->data.sks.ns, &u2->data.sks.ns,
1283 sizeof (struct GNUNET_FS_PseudonymIdentifier))) &&
1284 (0 == strcmp (u1->data.sks.identifier, u2->data.sks.identifier)))
1288 case GNUNET_FS_URI_KSK:
1289 if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1291 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1294 for (j = 0; j < u2->data.ksk.keywordCount; j++)
1296 if (0 == strcmp (u1->data.ksk.keywords[i], u2->data.ksk.keywords[j]))
1302 if (ret == GNUNET_NO)
1306 case GNUNET_FS_URI_LOC:
1308 (&u1->data.loc, &u2->data.loc,
1309 sizeof (struct FileIdentifier) +
1310 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded) +
1311 sizeof (struct GNUNET_TIME_Absolute) + sizeof (unsigned short) +
1312 sizeof (unsigned short)) != 0)
1322 * Is this a namespace URI?
1324 * @param uri the uri to check
1325 * @return GNUNET_YES if this is an SKS uri
1328 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1330 return uri->type == GNUNET_FS_URI_SKS;
1335 * Get the ID of a namespace from the given
1338 * @param uri the uri to get the namespace ID from
1339 * @param pseudonym where to store the ID of the namespace
1340 * @return GNUNET_OK on success
1343 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1344 struct GNUNET_FS_PseudonymIdentifier *pseudonym)
1346 if (!GNUNET_FS_uri_test_sks (uri))
1349 return GNUNET_SYSERR;
1351 *pseudonym = uri->data.sks.ns;
1357 * Get the content identifier of an SKS URI.
1359 * @param uri the sks uri
1360 * @return NULL on error (not a valid SKS URI)
1363 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1365 if (!GNUNET_FS_uri_test_sks (uri))
1370 return GNUNET_strdup (uri->data.sks.identifier);
1375 * Convert namespace URI to a human readable format
1376 * (using the namespace description, if available).
1378 * @param cfg configuration to use
1379 * @param uri SKS uri to convert
1380 * @return NULL on error (not an SKS URI)
1383 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
1384 const struct GNUNET_FS_Uri *uri)
1390 if (uri->type != GNUNET_FS_URI_SKS)
1392 (void) GNUNET_FS_pseudonym_get_info (cfg, &uri->data.sks.ns,
1393 NULL, NULL, &name, NULL);
1394 unique_name = GNUNET_FS_pseudonym_name_uniquify (cfg, &uri->data.sks.ns, name, NULL);
1396 GNUNET_asprintf (&ret, "%s: %s", unique_name, uri->data.sks.identifier);
1397 GNUNET_free (unique_name);
1403 * Is this a keyword URI?
1405 * @param uri the uri
1406 * @return GNUNET_YES if this is a KSK uri
1409 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1414 if (uri->type == GNUNET_FS_URI_KSK)
1416 for (i=0;i < uri->data.ksk.keywordCount; i++)
1417 GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1420 return uri->type == GNUNET_FS_URI_KSK;
1425 * Is this a file (or directory) URI?
1427 * @param uri the uri to check
1428 * @return GNUNET_YES if this is a CHK uri
1431 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1433 return uri->type == GNUNET_FS_URI_CHK;
1438 * What is the size of the file that this URI
1441 * @param uri the CHK URI to inspect
1442 * @return size of the file as specified in the CHK URI
1445 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri * uri)
1449 case GNUNET_FS_URI_CHK:
1450 return GNUNET_ntohll (uri->data.chk.file_length);
1451 case GNUNET_FS_URI_LOC:
1452 return GNUNET_ntohll (uri->data.loc.fi.file_length);
1456 return 0; /* unreachable */
1461 * Is this a location URI?
1463 * @param uri the uri to check
1464 * @return GNUNET_YES if this is a LOC uri
1467 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1469 return uri->type == GNUNET_FS_URI_LOC;
1474 * Add a keyword as non-mandatory (with ' '-prefix) to the
1475 * given keyword list at offset 'index'. The array is
1476 * guaranteed to be long enough.
1478 * @param s keyword to add
1479 * @param array array to add the keyword to
1480 * @param index offset where to add the keyword
1483 insert_non_mandatory_keyword (const char *s, char **array, int index)
1486 GNUNET_asprintf (&nkword, " %s", /* space to mark as 'non mandatory' */ s);
1487 array[index] = nkword;
1492 * Test if the given keyword 's' is already present in the
1493 * given array, ignoring the '+'-mandatory prefix in the array.
1495 * @param s keyword to test
1496 * @param array keywords to test against, with ' ' or '+' prefix to ignore
1497 * @param array_length length of the array
1498 * @return GNUNET_YES if the keyword exists, GNUNET_NO if not
1501 find_duplicate (const char *s, const char **array, int array_length)
1505 for (j = array_length - 1; j >= 0; j--)
1506 if (0 == strcmp (&array[j][1], s))
1516 normalize_metadata (enum EXTRACTOR_MetaFormat format, const char *data,
1519 uint8_t *free_str = NULL;
1520 uint8_t *str_to_normalize = (uint8_t *) data;
1521 uint8_t *normalized;
1523 if (str_to_normalize == NULL)
1525 /* Don't trust libextractor */
1526 if (format == EXTRACTOR_METAFORMAT_UTF8)
1528 free_str = (uint8_t *) u8_check ((const uint8_t *) data, data_len);
1529 if (free_str == NULL)
1532 format = EXTRACTOR_METAFORMAT_C_STRING;
1534 if (format == EXTRACTOR_METAFORMAT_C_STRING)
1536 free_str = u8_strconv_from_encoding (data, locale_charset (), iconveh_escape_sequence);
1537 if (free_str == NULL)
1541 normalized = u8_tolower (str_to_normalize, strlen ((char *) str_to_normalize), NULL, UNINORM_NFD, NULL, &r_len);
1542 /* free_str is allocated by libunistring internally, use free() */
1543 if (free_str != NULL)
1545 if (normalized != NULL)
1547 /* u8_tolower allocates a non-NULL-terminated string! */
1548 free_str = GNUNET_malloc (r_len + 1);
1549 memcpy (free_str, normalized, r_len);
1550 free_str[r_len] = '\0';
1552 normalized = free_str;
1554 return (char *) normalized;
1558 * Counts the number of UTF-8 characters (not bytes) in the string,
1559 * returns that count.
1562 u8_strcount (const uint8_t *s)
1566 GNUNET_assert (s != NULL);
1569 for (count = 0; s != NULL; count++)
1570 s = u8_next (&c, s);
1576 * Break the filename up by matching [], () and {} pairs to make
1577 * keywords. In case of nesting parentheses only the inner pair counts.
1578 * You can't escape parentheses to scan something like "[blah\{foo]" to
1579 * make a "blah{foo" keyword, this function is only a heuristic!
1581 * @param s string to break down.
1582 * @param array array to fill with enclosed tokens. If NULL, then tokens
1584 * @param index index at which to start filling the array (entries prior
1585 * to it are used to check for duplicates). ignored if array == NULL.
1586 * @return number of tokens counted (including duplicates), or number of
1587 * tokens extracted (excluding duplicates). 0 if there are no
1588 * matching parens in the string (when counting), or when all tokens
1589 * were duplicates (when extracting).
1592 get_keywords_from_parens (const char *s, char **array, int index)
1602 ss = GNUNET_strdup (s);
1603 open_paren = ss - 1;
1604 while (NULL != (open_paren = strpbrk (open_paren + 1, "[{(")))
1608 close_paren = strpbrk (open_paren + 1, "]})");
1609 if (NULL == close_paren)
1611 switch (open_paren[0])
1614 if (']' == close_paren[0])
1618 if ('}' == close_paren[0])
1622 if (')' == close_paren[0])
1628 if (match && (close_paren - open_paren > 1))
1630 tmp = close_paren[0];
1631 close_paren[0] = '\0';
1632 /* Keywords must be at least 3 characters long */
1633 if (u8_strcount ((const uint8_t *) &open_paren[1]) <= 2)
1635 close_paren[0] = tmp;
1641 if (GNUNET_NO == find_duplicate ((const char *) &open_paren[1],
1642 (const char **) array, index + count))
1644 insert_non_mandatory_keyword ((const char *) &open_paren[1], array,
1648 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1649 &open_paren[1], close_paren - &open_paren[1]);
1650 if (normalized != NULL)
1652 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1653 (const char **) array, index + count))
1655 insert_non_mandatory_keyword ((const char *) normalized, array,
1659 GNUNET_free (normalized);
1664 close_paren[0] = tmp;
1673 * Where to break up keywords
1675 #define TOKENS "_. /-!?#&+@\"\'\\;:,()[]{}$<>|"
1678 * Break the filename up by TOKENS to make
1681 * @param s string to break down.
1682 * @param array array to fill with tokens. If NULL, then tokens are only
1684 * @param index index at which to start filling the array (entries prior
1685 * to it are used to check for duplicates). ignored if array == NULL.
1686 * @return number of tokens (>1) counted (including duplicates), or number of
1687 * tokens extracted (excluding duplicates). 0 if there are no
1688 * separators in the string (when counting), or when all tokens were
1689 * duplicates (when extracting).
1692 get_keywords_from_tokens (const char *s, char **array, int index)
1698 ss = GNUNET_strdup (s);
1699 for (p = strtok (ss, TOKENS); p != NULL; p = strtok (NULL, TOKENS))
1701 /* Keywords must be at least 3 characters long */
1702 if (u8_strcount ((const uint8_t *) p) <= 2)
1707 if (GNUNET_NO == find_duplicate (p, (const char **) array, index + seps))
1709 insert_non_mandatory_keyword (p, array,
1713 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1715 if (normalized != NULL)
1717 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1718 (const char **) array, index + seps))
1720 insert_non_mandatory_keyword ((const char *) normalized, array,
1724 GNUNET_free (normalized);
1736 * Function called on each value in the meta data.
1737 * Adds it to the URI.
1739 * @param cls URI to update
1740 * @param plugin_name name of the plugin that produced this value;
1741 * special values can be used (i.e. '<zlib>' for zlib being
1742 * used in the main libextractor library and yielding
1744 * @param type libextractor-type describing the meta data
1745 * @param format basic format information about data
1746 * @param data_mime_type mime-type of data (not of the original file);
1747 * can be NULL (if mime-type is not known)
1748 * @param data actual meta-data found
1749 * @param data_len number of bytes in data
1750 * @return 0 (always)
1753 gather_uri_data (void *cls, const char *plugin_name,
1754 enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
1755 const char *data_mime_type, const char *data, size_t data_len)
1757 struct GNUNET_FS_Uri *uri = cls;
1758 char *normalized_data;
1760 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
1761 (format != EXTRACTOR_METAFORMAT_C_STRING))
1763 /* Keywords must be at least 3 characters long
1764 * If given non-utf8 string it will, most likely, find it to be invalid,
1765 * and will return the length of its valid part, skipping the keyword.
1766 * If it does - fix the extractor, not this check!
1768 if (u8_strcount ((const uint8_t *) data) <= 2)
1772 normalized_data = normalize_metadata (format, data, data_len);
1773 if (!find_duplicate (data, (const char **) uri->data.ksk.keywords, uri->data.ksk.keywordCount))
1775 insert_non_mandatory_keyword (data,
1776 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1777 uri->data.ksk.keywordCount++;
1779 if (normalized_data != NULL)
1781 if (!find_duplicate (normalized_data, (const char **) uri->data.ksk.keywords, uri->data.ksk.keywordCount))
1783 insert_non_mandatory_keyword (normalized_data,
1784 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1785 uri->data.ksk.keywordCount++;
1787 GNUNET_free (normalized_data);
1794 * Construct a keyword-URI from meta-data (take all entries
1795 * in the meta-data and construct one large keyword URI
1796 * that lists all keywords that can be found in the meta-data).
1798 * @param md metadata to use
1799 * @return NULL on error, otherwise a KSK URI
1801 struct GNUNET_FS_Uri *
1802 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData
1805 struct GNUNET_FS_Uri *ret;
1807 char *full_name = NULL;
1810 int tok_keywords = 0;
1811 int paren_keywords = 0;
1815 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1816 ret->type = GNUNET_FS_URI_KSK;
1817 ent = GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL);
1820 full_name = GNUNET_CONTAINER_meta_data_get_first_by_types (md,
1821 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, -1);
1822 if (NULL != full_name)
1824 filename = full_name;
1825 while (NULL != (ss = strstr (filename, DIR_SEPARATOR_STR)))
1827 tok_keywords = get_keywords_from_tokens (filename, NULL, 0);
1828 paren_keywords = get_keywords_from_parens (filename, NULL, 0);
1830 /* x2 because there might be a normalized variant of every keyword */
1831 ret->data.ksk.keywords = GNUNET_malloc (sizeof (char *) * (ent
1832 + tok_keywords + paren_keywords) * 2);
1833 GNUNET_CONTAINER_meta_data_iterate (md, &gather_uri_data, ret);
1835 if (tok_keywords > 0)
1836 ret->data.ksk.keywordCount += get_keywords_from_tokens (filename,
1837 ret->data.ksk.keywords,
1838 ret->data.ksk.keywordCount);
1839 if (paren_keywords > 0)
1840 ret->data.ksk.keywordCount += get_keywords_from_parens (filename,
1841 ret->data.ksk.keywords,
1842 ret->data.ksk.keywordCount);
1844 GNUNET_free_non_null (full_name);
1850 * In URI-encoding, does the given character
1851 * need to be encoded using %-encoding?
1854 needs_percent (char c)
1857 ((isalnum ((unsigned char) c)) || (c == '-') || (c == '_') ||
1858 (c == '.') || (c == '~')));
1863 * Convert a KSK URI to a string.
1865 * @param uri the URI to convert
1866 * @return NULL on error (i.e. keywordCount == 0)
1869 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1872 unsigned int keywordCount;
1879 const char *keyword;
1881 if (uri->type != GNUNET_FS_URI_KSK)
1883 keywords = uri->data.ksk.keywords;
1884 keywordCount = uri->data.ksk.keywordCount;
1885 n = keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1886 strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1887 for (i = 0; i < keywordCount; i++)
1889 keyword = keywords[i];
1890 slen = strlen (keyword);
1892 for (j = 0; j < slen; j++)
1894 if ((j == 0) && (keyword[j] == ' '))
1897 continue; /* skip leading space */
1899 if (needs_percent (keyword[j]))
1900 n += 2; /* will use %-encoding */
1903 ret = GNUNET_malloc (n);
1904 strcpy (ret, GNUNET_FS_URI_PREFIX);
1905 strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1906 wpos = strlen (ret);
1907 for (i = 0; i < keywordCount; i++)
1909 keyword = keywords[i];
1910 slen = strlen (keyword);
1911 for (j = 0; j < slen; j++)
1913 if ((j == 0) && (keyword[j] == ' '))
1914 continue; /* skip leading space */
1915 if (needs_percent (keyword[j]))
1917 sprintf (&ret[wpos], "%%%02X", (unsigned char) keyword[j]);
1922 ret[wpos++] = keyword[j];
1925 if (i != keywordCount - 1)
1933 * Convert SKS URI to a string.
1935 * @param uri sks uri to convert
1936 * @return NULL on error
1939 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1944 if (GNUNET_FS_URI_SKS != uri->type)
1946 ret = GNUNET_STRINGS_data_to_string (&uri->data.sks.ns,
1947 sizeof (struct GNUNET_FS_PseudonymIdentifier),
1950 GNUNET_assert (NULL != ret);
1952 GNUNET_asprintf (&ret, "%s%s%s/%s", GNUNET_FS_URI_PREFIX,
1953 GNUNET_FS_URI_SKS_INFIX, buf,
1954 uri->data.sks.identifier);
1960 * Convert a CHK URI to a string.
1962 * @param uri chk uri to convert
1963 * @return NULL on error
1966 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1968 const struct FileIdentifier *fi;
1970 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1971 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1973 if (uri->type != GNUNET_FS_URI_CHK)
1975 fi = &uri->data.chk;
1976 GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1977 GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1979 GNUNET_asprintf (&ret, "%s%s%s.%s.%llu", GNUNET_FS_URI_PREFIX,
1980 GNUNET_FS_URI_CHK_INFIX, (const char *) &keyhash,
1981 (const char *) &queryhash, GNUNET_ntohll (fi->file_length));
1986 * Convert binary data to a string.
1988 * @param data binary data to convert
1989 * @param size number of bytes in data
1990 * @return converted data
1993 bin2enc (const void *data, size_t size)
1996 * 64 characters for encoding, 6 bits per character
1999 "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_=";
2007 GNUNET_assert (strlen (tbl) == 64);
2009 if (((size * 8) % 6) != 0)
2011 ret = GNUNET_malloc (len + 1);
2016 for (pos = 0; pos < size; pos++)
2018 bits |= ((((const unsigned char *) data)[pos]) << hbits);
2022 ret[len++] = tbl[bits & 63];
2028 ret[len] = tbl[bits & 63];
2034 * Convert a LOC URI to a string.
2036 * @param uri loc uri to convert
2037 * @return NULL on error
2040 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
2043 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
2044 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
2048 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
2049 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
2051 bin2enc (&uri->data.loc.peer,
2052 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded));
2054 bin2enc (&uri->data.loc.contentSignature,
2055 sizeof (struct GNUNET_CRYPTO_EccSignature));
2056 GNUNET_asprintf (&ret, "%s%s%s.%s.%llu.%s.%s.%llu", GNUNET_FS_URI_PREFIX,
2057 GNUNET_FS_URI_LOC_INFIX, (const char *) &keyhash,
2058 (const char *) &queryhash,
2059 (unsigned long long) GNUNET_ntohll (uri->data.loc.
2060 fi.file_length), peerId,
2062 (unsigned long long) uri->data.loc.expirationTime.abs_value);
2063 GNUNET_free (peerSig);
2064 GNUNET_free (peerId);
2070 * Convert a URI to a UTF-8 String.
2072 * @param uri uri to convert to a string
2073 * @return the UTF-8 string
2076 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
2085 case GNUNET_FS_URI_KSK:
2086 return uri_ksk_to_string (uri);
2087 case GNUNET_FS_URI_SKS:
2088 return uri_sks_to_string (uri);
2089 case GNUNET_FS_URI_CHK:
2090 return uri_chk_to_string (uri);
2091 case GNUNET_FS_URI_LOC:
2092 return uri_loc_to_string (uri);
2099 /* end of fs_uri.c */