2 This file is part of GNUnet.
3 (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 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_HashCode ns;
363 char enc[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
365 GNUNET_assert (s != NULL);
367 pos = strlen (GNUNET_FS_URI_SKS_PREFIX);
368 if ((slen <= pos) || (0 != strncmp (s, GNUNET_FS_URI_SKS_PREFIX, pos)))
369 return NULL; /* not an SKS URI */
370 if ((slen < pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)) ||
371 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '/'))
373 *emsg = GNUNET_strdup (_("Malformed SKS URI"));
376 memcpy (enc, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
377 enc[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
378 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (enc, &ns))
380 *emsg = GNUNET_strdup (_("Malformed SKS URI"));
384 GNUNET_strdup (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)]);
385 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
386 ret->type = GNUNET_FS_URI_SKS;
387 ret->data.sks.ns = ns;
388 ret->data.sks.identifier = identifier;
392 #define GNUNET_FS_URI_CHK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX
398 * @param s an uri string
399 * @param emsg where to store the parser error message (if any)
400 * @return NULL on error, CHK URI otherwise
402 static struct GNUNET_FS_Uri *
403 uri_chk_parse (const char *s, char **emsg)
405 struct GNUNET_FS_Uri *ret;
406 struct FileIdentifier fi;
408 unsigned long long flen;
410 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
411 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
415 GNUNET_assert (s != NULL);
417 pos = strlen (GNUNET_FS_URI_CHK_PREFIX);
418 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
419 (0 != strncmp (s, GNUNET_FS_URI_CHK_PREFIX, pos)))
420 return NULL; /* not a CHK URI */
421 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
422 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
424 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
427 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
428 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
429 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
430 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
431 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
433 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &fi.chk.key)) ||
434 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &fi.chk.query)) ||
436 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
439 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
442 fi.file_length = GNUNET_htonll (flen);
443 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
444 ret->type = GNUNET_FS_URI_CHK;
451 * Convert a character back to the binary value
452 * that it represents (given base64-encoding).
454 * @param a character to convert
455 * @return offset in the "tbl" array
458 c2v (unsigned char a)
460 if ((a >= '0') && (a <= '9'))
462 if ((a >= 'A') && (a <= 'Z'))
463 return (a - 'A' + 10);
464 if ((a >= 'a') && (a <= 'z'))
465 return (a - 'a' + 36);
475 * Convert string back to binary data.
477 * @param input '\\0'-terminated string
478 * @param data where to write binary data
479 * @param size how much data should be converted
480 * @return number of characters processed from input,
484 enc2bin (const char *input, void *data, size_t size)
492 if (((size * 8) % 6) != 0)
494 if (strlen (input) < len)
495 return -1; /* error! */
499 for (pos = 0; pos < size; pos++)
503 bits |= (c2v (input[len++]) << hbits);
506 (((unsigned char *) data)[pos]) = (unsigned char) bits;
515 * Structure that defines how the
516 * contents of a location URI must be
517 * assembled in memory to create or
518 * verify the signature of a location
521 struct LocUriAssembly
523 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
525 struct GNUNET_TIME_AbsoluteNBO exptime;
527 struct FileIdentifier fi;
529 struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded peer;
534 #define GNUNET_FS_URI_LOC_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX
538 * Also verifies validity of the location URI.
540 * @param s an uri string
541 * @param emsg where to store the parser error message (if any)
542 * @return NULL on error, valid LOC URI otherwise
544 static struct GNUNET_FS_Uri *
545 uri_loc_parse (const char *s, char **emsg)
547 struct GNUNET_FS_Uri *uri;
548 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
549 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
552 unsigned long long exptime;
553 unsigned long long flen;
554 struct GNUNET_TIME_Absolute et;
555 struct GNUNET_CRYPTO_EccSignature sig;
556 struct LocUriAssembly ass;
560 GNUNET_assert (s != NULL);
562 pos = strlen (GNUNET_FS_URI_LOC_PREFIX);
563 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
564 (0 != strncmp (s, GNUNET_FS_URI_LOC_PREFIX, pos)))
565 return NULL; /* not an SKS URI */
566 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
567 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
569 *emsg = GNUNET_strdup (_("SKS URI malformed"));
572 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
573 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
574 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
575 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
576 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
578 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &ass.fi.chk.key)) ||
579 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &ass.fi.chk.query)) ||
581 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
584 *emsg = GNUNET_strdup (_("SKS URI malformed"));
587 ass.fi.file_length = GNUNET_htonll (flen);
589 npos = pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2;
590 while ((s[npos] != '\0') && (s[npos] != '.'))
594 *emsg = GNUNET_strdup (_("SKS URI malformed"));
599 enc2bin (&s[npos], &ass.peer,
600 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded));
604 GNUNET_strdup (_("SKS URI malformed (could not decode public key)"));
608 if (s[npos++] != '.')
610 *emsg = GNUNET_strdup (_("SKS URI malformed (could not find signature)"));
613 ret = enc2bin (&s[npos], &sig, sizeof (struct GNUNET_CRYPTO_EccSignature));
616 *emsg = GNUNET_strdup (_("SKS URI malformed (could not decode signature)"));
620 if (s[npos++] != '.')
622 *emsg = GNUNET_strdup (_("SKS URI malformed"));
625 if (1 != SSCANF (&s[npos], "%llu", &exptime))
629 ("SKS URI malformed (could not parse expiration time)"));
632 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
633 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
634 et.abs_value = exptime;
635 ass.exptime = GNUNET_TIME_absolute_hton (et);
637 GNUNET_CRYPTO_ecc_verify (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT,
638 &ass.purpose, &sig, &ass.peer))
641 GNUNET_strdup (_("SKS URI malformed (signature failed validation)"));
644 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
645 uri->type = GNUNET_FS_URI_LOC;
646 uri->data.loc.fi = ass.fi;
647 uri->data.loc.peer = ass.peer;
648 uri->data.loc.expirationTime = et;
649 uri->data.loc.contentSignature = sig;
658 * Convert a UTF-8 String to a URI.
660 * @param uri string to parse
661 * @param emsg where to store the parser error message (if any)
662 * @return NULL on error
664 struct GNUNET_FS_Uri *
665 GNUNET_FS_uri_parse (const char *uri, char **emsg)
667 struct GNUNET_FS_Uri *ret;
673 if ((NULL != (ret = uri_chk_parse (uri, emsg))) ||
674 (NULL != (ret = uri_ksk_parse (uri, emsg))) ||
675 (NULL != (ret = uri_sks_parse (uri, emsg))) ||
676 (NULL != (ret = uri_loc_parse (uri, emsg))))
679 *emsg = GNUNET_strdup (_("Unrecognized URI type"));
689 * @param uri uri to free
692 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri)
696 GNUNET_assert (uri != NULL);
699 case GNUNET_FS_URI_KSK:
700 for (i = 0; i < uri->data.ksk.keywordCount; i++)
701 GNUNET_free (uri->data.ksk.keywords[i]);
702 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount, 0);
704 case GNUNET_FS_URI_SKS:
705 GNUNET_free (uri->data.sks.identifier);
707 case GNUNET_FS_URI_LOC:
717 * How many keywords are ANDed in this keyword URI?
719 * @param uri ksk uri to get the number of keywords from
720 * @return 0 if this is not a keyword URI
723 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
725 if (uri->type != GNUNET_FS_URI_KSK)
727 return uri->data.ksk.keywordCount;
732 * Iterate over all keywords in this keyword URI.
734 * @param uri ksk uri to get the keywords from
735 * @param iterator function to call on each keyword
736 * @param iterator_cls closure for iterator
737 * @return -1 if this is not a keyword URI, otherwise number of
738 * keywords iterated over until iterator aborted
741 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
742 GNUNET_FS_KeywordIterator iterator,
748 if (uri->type != GNUNET_FS_URI_KSK)
750 if (iterator == NULL)
751 return uri->data.ksk.keywordCount;
752 for (i = 0; i < uri->data.ksk.keywordCount; i++)
754 keyword = uri->data.ksk.keywords[i];
755 /* first character of keyword indicates
756 * if it is mandatory or not */
757 if (GNUNET_OK != iterator (iterator_cls, &keyword[1], keyword[0] == '+'))
765 * Add the given keyword to the set of keywords represented by the URI.
766 * Does nothing if the keyword is already present.
768 * @param uri ksk uri to modify
769 * @param keyword keyword to add
770 * @param is_mandatory is this keyword mandatory?
773 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri, const char *keyword,
780 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
781 for (i = 0; i < uri->data.ksk.keywordCount; i++)
783 old = uri->data.ksk.keywords[i];
784 if (0 == strcmp (&old[1], keyword))
787 GNUNET_asprintf (&n, is_mandatory ? "+%s" : " %s", keyword);
788 GNUNET_array_append (uri->data.ksk.keywords, uri->data.ksk.keywordCount, n);
793 * Remove the given keyword from the set of keywords represented by the URI.
794 * Does nothing if the keyword is not present.
796 * @param uri ksk uri to modify
797 * @param keyword keyword to add
800 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
806 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
807 for (i = 0; i < uri->data.ksk.keywordCount; i++)
809 old = uri->data.ksk.keywords[i];
810 if (0 == strcmp (&old[1], keyword))
812 uri->data.ksk.keywords[i] =
813 uri->data.ksk.keywords[uri->data.ksk.keywordCount - 1];
814 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount,
815 uri->data.ksk.keywordCount - 1);
824 * Obtain the identity of the peer offering the data
826 * @param uri the location URI to inspect
827 * @param peer where to store the identify of the peer (presumably) offering the content
828 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
831 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
832 struct GNUNET_PeerIdentity *peer)
834 if (uri->type != GNUNET_FS_URI_LOC)
835 return GNUNET_SYSERR;
836 GNUNET_CRYPTO_hash (&uri->data.loc.peer,
837 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded),
844 * Obtain the expiration of the LOC URI.
846 * @param uri location URI to get the expiration from
847 * @return expiration time of the URI
849 struct GNUNET_TIME_Absolute
850 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri)
852 GNUNET_assert (uri->type == GNUNET_FS_URI_LOC);
853 return uri->data.loc.expirationTime;
859 * Obtain the URI of the content itself.
861 * @param uri location URI to get the content URI from
862 * @return NULL if argument is not a location URI
864 struct GNUNET_FS_Uri *
865 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
867 struct GNUNET_FS_Uri *ret;
869 if (uri->type != GNUNET_FS_URI_LOC)
871 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
872 ret->type = GNUNET_FS_URI_CHK;
873 ret->data.chk = uri->data.loc.fi;
879 * Construct a location URI (this peer will be used for the location).
881 * @param baseUri content offered by the sender
882 * @param cfg configuration information (used to find our hostkey)
883 * @param expiration_time how long will the content be offered?
884 * @return the location URI, NULL on error
886 struct GNUNET_FS_Uri *
887 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
888 const struct GNUNET_CONFIGURATION_Handle *cfg,
889 struct GNUNET_TIME_Absolute expiration_time)
891 struct GNUNET_FS_Uri *uri;
892 struct GNUNET_CRYPTO_EccPrivateKey *my_private_key;
893 struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded my_public_key;
895 struct LocUriAssembly ass;
897 if (baseUri->type != GNUNET_FS_URI_CHK)
900 GNUNET_CONFIGURATION_get_value_filename (cfg, "PEER", "PRIVATE_KEY",
903 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
904 _("Lacking key configuration settings.\n"));
907 if (NULL == (my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile)))
909 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
910 _("Could not access hostkey file `%s'.\n"), keyfile);
911 GNUNET_free (keyfile);
914 GNUNET_free (keyfile);
915 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
916 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
917 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
918 ass.exptime = GNUNET_TIME_absolute_hton (expiration_time);
919 ass.fi = baseUri->data.chk;
920 ass.peer = my_public_key;
921 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
922 uri->type = GNUNET_FS_URI_LOC;
923 uri->data.loc.fi = baseUri->data.chk;
924 uri->data.loc.expirationTime = expiration_time;
925 uri->data.loc.peer = my_public_key;
926 GNUNET_assert (GNUNET_OK ==
927 GNUNET_CRYPTO_ecc_sign (my_private_key, &ass.purpose,
928 &uri->data.loc.contentSignature));
929 GNUNET_CRYPTO_ecc_key_free (my_private_key);
935 * Create an SKS URI from a namespace and an identifier.
937 * @param ns namespace
938 * @param id identifier
939 * @param emsg where to store an error message
940 * @return an FS URI for the given namespace and identifier
942 struct GNUNET_FS_Uri *
943 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns, const char *id,
946 struct GNUNET_FS_Uri *ns_uri;
947 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
949 ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
950 ns_uri->type = GNUNET_FS_URI_SKS;
951 GNUNET_FS_namespace_get_public_key_hash (ns, &ns_uri->data.sks.ns);
952 ns_uri->data.sks.identifier = GNUNET_strdup (id);
958 * Create an SKS URI from a namespace ID and an identifier.
960 * @param nsid namespace ID
961 * @param id identifier
962 * @return an FS URI for the given namespace and identifier
964 struct GNUNET_FS_Uri *
965 GNUNET_FS_uri_sks_create_from_nsid (struct GNUNET_HashCode * nsid, const char *id)
967 struct GNUNET_FS_Uri *ns_uri;
969 ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
970 ns_uri->type = GNUNET_FS_URI_SKS;
971 ns_uri->data.sks.ns = *nsid;
972 ns_uri->data.sks.identifier = GNUNET_strdup (id);
978 * Merge the sets of keywords from two KSK URIs.
979 * (useful for merging the canonicalized keywords with
980 * the original keywords for sharing).
982 * @param u1 first uri
983 * @param u2 second uri
984 * @return merged URI, NULL on error
986 struct GNUNET_FS_Uri *
987 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
988 const struct GNUNET_FS_Uri *u2)
990 struct GNUNET_FS_Uri *ret;
998 if ((u1 == NULL) && (u2 == NULL))
1001 return GNUNET_FS_uri_dup (u2);
1003 return GNUNET_FS_uri_dup (u1);
1004 if ((u1->type != GNUNET_FS_URI_KSK) || (u2->type != GNUNET_FS_URI_KSK))
1009 kc = u1->data.ksk.keywordCount;
1010 kl = GNUNET_malloc ((kc + u2->data.ksk.keywordCount) * sizeof (char *));
1011 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1012 kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
1013 for (i = 0; i < u2->data.ksk.keywordCount; i++)
1015 kp = u2->data.ksk.keywords[i];
1017 for (j = 0; j < u1->data.ksk.keywordCount; j++)
1018 if (0 == strcmp (kp + 1, kl[j] + 1))
1026 kl[kc++] = GNUNET_strdup (kp);
1028 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1029 ret->type = GNUNET_FS_URI_KSK;
1030 ret->data.ksk.keywordCount = kc;
1031 ret->data.ksk.keywords = kl;
1039 * @param uri the URI to duplicate
1040 * @return copy of the URI
1042 struct GNUNET_FS_Uri *
1043 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
1045 struct GNUNET_FS_Uri *ret;
1050 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1051 memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
1054 case GNUNET_FS_URI_KSK:
1055 if (ret->data.ksk.keywordCount >=
1056 GNUNET_MAX_MALLOC_CHECKED / sizeof (char *))
1062 if (ret->data.ksk.keywordCount > 0)
1064 ret->data.ksk.keywords =
1065 GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
1066 for (i = 0; i < ret->data.ksk.keywordCount; i++)
1067 ret->data.ksk.keywords[i] = GNUNET_strdup (uri->data.ksk.keywords[i]);
1070 ret->data.ksk.keywords = NULL; /* just to be sure */
1072 case GNUNET_FS_URI_SKS:
1073 ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1075 case GNUNET_FS_URI_LOC:
1085 * Create an FS URI from a single user-supplied string of keywords.
1086 * The string is broken up at spaces into individual keywords.
1087 * Keywords that start with "+" are mandatory. Double-quotes can
1088 * be used to prevent breaking up strings at spaces (and also
1089 * to specify non-mandatory keywords starting with "+").
1091 * Keywords must contain a balanced number of double quotes and
1092 * double quotes can not be used in the actual keywords (for
1093 * example, the string '""foo bar""' will be turned into two
1094 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1096 * @param keywords the keyword string
1097 * @param emsg where to store an error message
1098 * @return an FS URI for the given keywords, NULL
1099 * if keywords is not legal (i.e. empty).
1101 struct GNUNET_FS_Uri *
1102 GNUNET_FS_uri_ksk_create (const char *keywords, char **emsg)
1105 unsigned int num_Words;
1108 struct GNUNET_FS_Uri *uri;
1112 if (keywords == NULL)
1114 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1118 searchString = GNUNET_strdup (keywords);
1123 while ('\0' != *pos)
1125 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1129 else if (0 == inWord)
1135 saw_quote = (saw_quote + 1) % 2;
1140 GNUNET_free (searchString);
1141 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1146 GNUNET_free (searchString);
1147 *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1150 keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1154 while ('\0' != *pos)
1156 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1161 else if (0 == inWord)
1163 keywordarr[num_Words] = pos;
1168 saw_quote = (saw_quote + 1) % 2;
1172 GNUNET_FS_uri_ksk_create_from_args (num_Words,
1173 (const char **) keywordarr);
1174 GNUNET_free (keywordarr);
1175 GNUNET_free (searchString);
1181 * Create an FS URI from a user-supplied command line of keywords.
1182 * Arguments should start with "+" to indicate mandatory
1185 * @param argc number of keywords
1186 * @param argv keywords (double quotes are not required for
1187 * keywords containing spaces; however, double
1188 * quotes are required for keywords starting with
1189 * "+"); there is no mechanism for having double
1190 * quotes in the actual keywords (if the user
1191 * did specifically specify double quotes, the
1192 * caller should convert each double quote
1193 * into two single quotes).
1194 * @return an FS URI for the given keywords, NULL
1195 * if keywords is not legal (i.e. empty).
1197 struct GNUNET_FS_Uri *
1198 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc, const char **argv)
1201 struct GNUNET_FS_Uri *uri;
1202 const char *keyword;
1210 /* allow URI to be given as one and only keyword and
1211 * handle accordingly */
1213 if ((argc == 1) && (strlen (argv[0]) > strlen (GNUNET_FS_URI_PREFIX)) &&
1215 strncmp (argv[0], GNUNET_FS_URI_PREFIX, strlen (GNUNET_FS_URI_PREFIX)))
1216 && (NULL != (uri = GNUNET_FS_uri_parse (argv[0], &emsg))))
1218 GNUNET_free_non_null (emsg);
1219 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1220 uri->type = GNUNET_FS_URI_KSK;
1221 uri->data.ksk.keywordCount = argc;
1222 uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1223 for (i = 0; i < argc; i++)
1226 if (keyword[0] == '+')
1227 val = GNUNET_strdup (keyword);
1229 GNUNET_asprintf (&val, " %s", keyword);
1240 uri->data.ksk.keywords[i] = val;
1247 * Test if two URIs are equal.
1249 * @param u1 one of the URIs
1250 * @param u2 the other URI
1251 * @return GNUNET_YES if the URIs are equal
1254 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1255 const struct GNUNET_FS_Uri *u2)
1261 GNUNET_assert (u1 != NULL);
1262 GNUNET_assert (u2 != NULL);
1263 if (u1->type != u2->type)
1267 case GNUNET_FS_URI_CHK:
1269 memcmp (&u1->data.chk, &u2->data.chk, sizeof (struct FileIdentifier)))
1272 case GNUNET_FS_URI_SKS:
1274 memcmp (&u1->data.sks.ns, &u2->data.sks.ns,
1275 sizeof (struct GNUNET_HashCode))) &&
1276 (0 == strcmp (u1->data.sks.identifier, u2->data.sks.identifier)))
1280 case GNUNET_FS_URI_KSK:
1281 if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1283 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1286 for (j = 0; j < u2->data.ksk.keywordCount; j++)
1288 if (0 == strcmp (u1->data.ksk.keywords[i], u2->data.ksk.keywords[j]))
1294 if (ret == GNUNET_NO)
1298 case GNUNET_FS_URI_LOC:
1300 (&u1->data.loc, &u2->data.loc,
1301 sizeof (struct FileIdentifier) +
1302 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded) +
1303 sizeof (struct GNUNET_TIME_Absolute) + sizeof (unsigned short) +
1304 sizeof (unsigned short)) != 0)
1314 * Is this a namespace URI?
1316 * @param uri the uri to check
1317 * @return GNUNET_YES if this is an SKS uri
1320 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1322 return uri->type == GNUNET_FS_URI_SKS;
1327 * Get the ID of a namespace from the given
1330 * @param uri the uri to get the namespace ID from
1331 * @param nsid where to store the ID of the namespace
1332 * @return GNUNET_OK on success
1335 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1336 struct GNUNET_HashCode * nsid)
1338 if (!GNUNET_FS_uri_test_sks (uri))
1341 return GNUNET_SYSERR;
1343 *nsid = uri->data.sks.ns;
1349 * Get the content identifier of an SKS URI.
1351 * @param uri the sks uri
1352 * @return NULL on error (not a valid SKS URI)
1355 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1357 if (!GNUNET_FS_uri_test_sks (uri))
1362 return GNUNET_strdup (uri->data.sks.identifier);
1367 * Convert namespace URI to a human readable format
1368 * (using the namespace description, if available).
1370 * @param cfg configuration to use
1371 * @param uri SKS uri to convert
1372 * @return NULL on error (not an SKS URI)
1375 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
1376 const struct GNUNET_FS_Uri *uri)
1382 if (uri->type != GNUNET_FS_URI_SKS)
1384 (void) GNUNET_PSEUDONYM_get_info (cfg, &uri->data.sks.ns,
1385 NULL, NULL, &name, NULL);
1386 unique_name = GNUNET_PSEUDONYM_name_uniquify (cfg, &uri->data.sks.ns, name, NULL);
1388 GNUNET_asprintf (&ret, "%s: %s", unique_name, uri->data.sks.identifier);
1389 GNUNET_free (unique_name);
1395 * Is this a keyword URI?
1397 * @param uri the uri
1398 * @return GNUNET_YES if this is a KSK uri
1401 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1406 if (uri->type == GNUNET_FS_URI_KSK)
1408 for (i=0;i < uri->data.ksk.keywordCount; i++)
1409 GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1412 return uri->type == GNUNET_FS_URI_KSK;
1417 * Is this a file (or directory) URI?
1419 * @param uri the uri to check
1420 * @return GNUNET_YES if this is a CHK uri
1423 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1425 return uri->type == GNUNET_FS_URI_CHK;
1430 * What is the size of the file that this URI
1433 * @param uri the CHK URI to inspect
1434 * @return size of the file as specified in the CHK URI
1437 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri * uri)
1441 case GNUNET_FS_URI_CHK:
1442 return GNUNET_ntohll (uri->data.chk.file_length);
1443 case GNUNET_FS_URI_LOC:
1444 return GNUNET_ntohll (uri->data.loc.fi.file_length);
1448 return 0; /* unreachable */
1453 * Is this a location URI?
1455 * @param uri the uri to check
1456 * @return GNUNET_YES if this is a LOC uri
1459 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1461 return uri->type == GNUNET_FS_URI_LOC;
1466 * Add a keyword as non-mandatory (with ' '-prefix) to the
1467 * given keyword list at offset 'index'. The array is
1468 * guaranteed to be long enough.
1470 * @param s keyword to add
1471 * @param array array to add the keyword to
1472 * @param index offset where to add the keyword
1475 insert_non_mandatory_keyword (const char *s, char **array, int index)
1478 GNUNET_asprintf (&nkword, " %s", /* space to mark as 'non mandatory' */ s);
1479 array[index] = nkword;
1484 * Test if the given keyword 's' is already present in the
1485 * given array, ignoring the '+'-mandatory prefix in the array.
1487 * @param s keyword to test
1488 * @param array keywords to test against, with ' ' or '+' prefix to ignore
1489 * @param array_length length of the array
1490 * @return GNUNET_YES if the keyword exists, GNUNET_NO if not
1493 find_duplicate (const char *s, const char **array, int array_length)
1497 for (j = array_length - 1; j >= 0; j--)
1498 if (0 == strcmp (&array[j][1], s))
1508 normalize_metadata (enum EXTRACTOR_MetaFormat format, const char *data,
1511 uint8_t *free_str = NULL;
1512 uint8_t *str_to_normalize = (uint8_t *) data;
1513 uint8_t *normalized;
1515 if (str_to_normalize == NULL)
1517 /* Don't trust libextractor */
1518 if (format == EXTRACTOR_METAFORMAT_UTF8)
1520 free_str = (uint8_t *) u8_check ((const uint8_t *) data, data_len);
1521 if (free_str == NULL)
1524 format = EXTRACTOR_METAFORMAT_C_STRING;
1526 if (format == EXTRACTOR_METAFORMAT_C_STRING)
1528 free_str = u8_strconv_from_encoding (data, locale_charset (), iconveh_escape_sequence);
1529 if (free_str == NULL)
1533 normalized = u8_tolower (str_to_normalize, strlen ((char *) str_to_normalize), NULL, UNINORM_NFD, NULL, &r_len);
1534 /* free_str is allocated by libunistring internally, use free() */
1535 if (free_str != NULL)
1537 if (normalized != NULL)
1539 /* u8_tolower allocates a non-NULL-terminated string! */
1540 free_str = GNUNET_malloc (r_len + 1);
1541 memcpy (free_str, normalized, r_len);
1542 free_str[r_len] = '\0';
1544 normalized = free_str;
1546 return (char *) normalized;
1550 * Counts the number of UTF-8 characters (not bytes) in the string,
1551 * returns that count.
1554 u8_strcount (const uint8_t *s)
1558 GNUNET_assert (s != NULL);
1561 for (count = 0; s != NULL; count++)
1562 s = u8_next (&c, s);
1568 * Break the filename up by matching [], () and {} pairs to make
1569 * keywords. In case of nesting parentheses only the inner pair counts.
1570 * You can't escape parentheses to scan something like "[blah\{foo]" to
1571 * make a "blah{foo" keyword, this function is only a heuristic!
1573 * @param s string to break down.
1574 * @param array array to fill with enclosed tokens. If NULL, then tokens
1576 * @param index index at which to start filling the array (entries prior
1577 * to it are used to check for duplicates). ignored if array == NULL.
1578 * @return number of tokens counted (including duplicates), or number of
1579 * tokens extracted (excluding duplicates). 0 if there are no
1580 * matching parens in the string (when counting), or when all tokens
1581 * were duplicates (when extracting).
1584 get_keywords_from_parens (const char *s, char **array, int index)
1594 ss = GNUNET_strdup (s);
1595 open_paren = ss - 1;
1596 while (NULL != (open_paren = strpbrk (open_paren + 1, "[{(")))
1600 close_paren = strpbrk (open_paren + 1, "]})");
1601 if (NULL == close_paren)
1603 switch (open_paren[0])
1606 if (']' == close_paren[0])
1610 if ('}' == close_paren[0])
1614 if (')' == close_paren[0])
1620 if (match && (close_paren - open_paren > 1))
1622 tmp = close_paren[0];
1623 close_paren[0] = '\0';
1624 /* Keywords must be at least 3 characters long */
1625 if (u8_strcount ((const uint8_t *) &open_paren[1]) <= 2)
1627 close_paren[0] = tmp;
1633 if (GNUNET_NO == find_duplicate ((const char *) &open_paren[1],
1634 (const char **) array, index + count))
1636 insert_non_mandatory_keyword ((const char *) &open_paren[1], array,
1640 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1641 &open_paren[1], close_paren - &open_paren[1]);
1642 if (normalized != NULL)
1644 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1645 (const char **) array, index + count))
1647 insert_non_mandatory_keyword ((const char *) normalized, array,
1651 GNUNET_free (normalized);
1656 close_paren[0] = tmp;
1665 * Where to break up keywords
1667 #define TOKENS "_. /-!?#&+@\"\'\\;:,()[]{}$<>|"
1670 * Break the filename up by TOKENS to make
1673 * @param s string to break down.
1674 * @param array array to fill with tokens. If NULL, then tokens are only
1676 * @param index index at which to start filling the array (entries prior
1677 * to it are used to check for duplicates). ignored if array == NULL.
1678 * @return number of tokens (>1) counted (including duplicates), or number of
1679 * tokens extracted (excluding duplicates). 0 if there are no
1680 * separators in the string (when counting), or when all tokens were
1681 * duplicates (when extracting).
1684 get_keywords_from_tokens (const char *s, char **array, int index)
1690 ss = GNUNET_strdup (s);
1691 for (p = strtok (ss, TOKENS); p != NULL; p = strtok (NULL, TOKENS))
1693 /* Keywords must be at least 3 characters long */
1694 if (u8_strcount ((const uint8_t *) p) <= 2)
1699 if (GNUNET_NO == find_duplicate (p, (const char **) array, index + seps))
1701 insert_non_mandatory_keyword (p, array,
1705 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1707 if (normalized != NULL)
1709 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1710 (const char **) array, index + seps))
1712 insert_non_mandatory_keyword ((const char *) normalized, array,
1716 GNUNET_free (normalized);
1728 * Function called on each value in the meta data.
1729 * Adds it to the URI.
1731 * @param cls URI to update
1732 * @param plugin_name name of the plugin that produced this value;
1733 * special values can be used (i.e. '<zlib>' for zlib being
1734 * used in the main libextractor library and yielding
1736 * @param type libextractor-type describing the meta data
1737 * @param format basic format information about data
1738 * @param data_mime_type mime-type of data (not of the original file);
1739 * can be NULL (if mime-type is not known)
1740 * @param data actual meta-data found
1741 * @param data_len number of bytes in data
1742 * @return 0 (always)
1745 gather_uri_data (void *cls, const char *plugin_name,
1746 enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
1747 const char *data_mime_type, const char *data, size_t data_len)
1749 struct GNUNET_FS_Uri *uri = cls;
1750 char *normalized_data;
1752 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
1753 (format != EXTRACTOR_METAFORMAT_C_STRING))
1755 /* Keywords must be at least 3 characters long
1756 * If given non-utf8 string it will, most likely, find it to be invalid,
1757 * and will return the length of its valid part, skipping the keyword.
1758 * If it does - fix the extractor, not this check!
1760 if (u8_strcount ((const uint8_t *) data) <= 2)
1764 normalized_data = normalize_metadata (format, data, data_len);
1765 if (!find_duplicate (data, (const char **) uri->data.ksk.keywords, uri->data.ksk.keywordCount))
1767 insert_non_mandatory_keyword (data,
1768 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1769 uri->data.ksk.keywordCount++;
1771 if (normalized_data != NULL)
1773 if (!find_duplicate (normalized_data, (const char **) uri->data.ksk.keywords, uri->data.ksk.keywordCount))
1775 insert_non_mandatory_keyword (normalized_data,
1776 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1777 uri->data.ksk.keywordCount++;
1779 GNUNET_free (normalized_data);
1786 * Construct a keyword-URI from meta-data (take all entries
1787 * in the meta-data and construct one large keyword URI
1788 * that lists all keywords that can be found in the meta-data).
1790 * @param md metadata to use
1791 * @return NULL on error, otherwise a KSK URI
1793 struct GNUNET_FS_Uri *
1794 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData
1797 struct GNUNET_FS_Uri *ret;
1799 char *full_name = NULL;
1802 int tok_keywords = 0;
1803 int paren_keywords = 0;
1807 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1808 ret->type = GNUNET_FS_URI_KSK;
1809 ent = GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL);
1812 full_name = GNUNET_CONTAINER_meta_data_get_first_by_types (md,
1813 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, -1);
1814 if (NULL != full_name)
1816 filename = full_name;
1817 while (NULL != (ss = strstr (filename, DIR_SEPARATOR_STR)))
1819 tok_keywords = get_keywords_from_tokens (filename, NULL, 0);
1820 paren_keywords = get_keywords_from_parens (filename, NULL, 0);
1822 /* x2 because there might be a normalized variant of every keyword */
1823 ret->data.ksk.keywords = GNUNET_malloc (sizeof (char *) * (ent
1824 + tok_keywords + paren_keywords) * 2);
1825 GNUNET_CONTAINER_meta_data_iterate (md, &gather_uri_data, ret);
1827 if (tok_keywords > 0)
1828 ret->data.ksk.keywordCount += get_keywords_from_tokens (filename,
1829 ret->data.ksk.keywords,
1830 ret->data.ksk.keywordCount);
1831 if (paren_keywords > 0)
1832 ret->data.ksk.keywordCount += get_keywords_from_parens (filename,
1833 ret->data.ksk.keywords,
1834 ret->data.ksk.keywordCount);
1836 GNUNET_free_non_null (full_name);
1842 * In URI-encoding, does the given character
1843 * need to be encoded using %-encoding?
1846 needs_percent (char c)
1849 ((isalnum ((unsigned char) c)) || (c == '-') || (c == '_') ||
1850 (c == '.') || (c == '~')));
1855 * Convert a KSK URI to a string.
1857 * @param uri the URI to convert
1858 * @return NULL on error (i.e. keywordCount == 0)
1861 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1864 unsigned int keywordCount;
1871 const char *keyword;
1873 if (uri->type != GNUNET_FS_URI_KSK)
1875 keywords = uri->data.ksk.keywords;
1876 keywordCount = uri->data.ksk.keywordCount;
1877 n = keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1878 strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1879 for (i = 0; i < keywordCount; i++)
1881 keyword = keywords[i];
1882 slen = strlen (keyword);
1884 for (j = 0; j < slen; j++)
1886 if ((j == 0) && (keyword[j] == ' '))
1889 continue; /* skip leading space */
1891 if (needs_percent (keyword[j]))
1892 n += 2; /* will use %-encoding */
1895 ret = GNUNET_malloc (n);
1896 strcpy (ret, GNUNET_FS_URI_PREFIX);
1897 strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1898 wpos = strlen (ret);
1899 for (i = 0; i < keywordCount; i++)
1901 keyword = keywords[i];
1902 slen = strlen (keyword);
1903 for (j = 0; j < slen; j++)
1905 if ((j == 0) && (keyword[j] == ' '))
1906 continue; /* skip leading space */
1907 if (needs_percent (keyword[j]))
1909 sprintf (&ret[wpos], "%%%02X", (unsigned char) keyword[j]);
1914 ret[wpos++] = keyword[j];
1917 if (i != keywordCount - 1)
1925 * Convert SKS URI to a string.
1927 * @param uri sks uri to convert
1928 * @return NULL on error
1931 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1933 const struct GNUNET_HashCode *ns;
1934 const char *identifier;
1936 struct GNUNET_CRYPTO_HashAsciiEncoded nsasc;
1938 if (uri->type != GNUNET_FS_URI_SKS)
1940 ns = &uri->data.sks.ns;
1941 identifier = uri->data.sks.identifier;
1942 GNUNET_CRYPTO_hash_to_enc (ns, &nsasc);
1943 GNUNET_asprintf (&ret, "%s%s%s/%s", GNUNET_FS_URI_PREFIX,
1944 GNUNET_FS_URI_SKS_INFIX, (const char *) &nsasc, identifier);
1950 * Convert a CHK URI to a string.
1952 * @param uri chk uri to convert
1953 * @return NULL on error
1956 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1958 const struct FileIdentifier *fi;
1960 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1961 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1963 if (uri->type != GNUNET_FS_URI_CHK)
1965 fi = &uri->data.chk;
1966 GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1967 GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1969 GNUNET_asprintf (&ret, "%s%s%s.%s.%llu", GNUNET_FS_URI_PREFIX,
1970 GNUNET_FS_URI_CHK_INFIX, (const char *) &keyhash,
1971 (const char *) &queryhash, GNUNET_ntohll (fi->file_length));
1976 * Convert binary data to a string.
1978 * @param data binary data to convert
1979 * @param size number of bytes in data
1980 * @return converted data
1983 bin2enc (const void *data, size_t size)
1986 * 64 characters for encoding, 6 bits per character
1989 "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_=";
1997 GNUNET_assert (strlen (tbl) == 64);
1999 if (((size * 8) % 6) != 0)
2001 ret = GNUNET_malloc (len + 1);
2006 for (pos = 0; pos < size; pos++)
2008 bits |= ((((const unsigned char *) data)[pos]) << hbits);
2012 ret[len++] = tbl[bits & 63];
2018 ret[len] = tbl[bits & 63];
2024 * Convert a LOC URI to a string.
2026 * @param uri loc uri to convert
2027 * @return NULL on error
2030 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
2033 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
2034 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
2038 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
2039 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
2041 bin2enc (&uri->data.loc.peer,
2042 sizeof (struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded));
2044 bin2enc (&uri->data.loc.contentSignature,
2045 sizeof (struct GNUNET_CRYPTO_EccSignature));
2046 GNUNET_asprintf (&ret, "%s%s%s.%s.%llu.%s.%s.%llu", GNUNET_FS_URI_PREFIX,
2047 GNUNET_FS_URI_LOC_INFIX, (const char *) &keyhash,
2048 (const char *) &queryhash,
2049 (unsigned long long) GNUNET_ntohll (uri->data.loc.
2050 fi.file_length), peerId,
2052 (unsigned long long) uri->data.loc.expirationTime.abs_value);
2053 GNUNET_free (peerSig);
2054 GNUNET_free (peerId);
2060 * Convert a URI to a UTF-8 String.
2062 * @param uri uri to convert to a string
2063 * @return the UTF-8 string
2066 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
2075 case GNUNET_FS_URI_KSK:
2076 return uri_ksk_to_string (uri);
2077 case GNUNET_FS_URI_SKS:
2078 return uri_sks_to_string (uri);
2079 case GNUNET_FS_URI_CHK:
2080 return uri_chk_to_string (uri);
2081 case GNUNET_FS_URI_LOC:
2082 return uri_loc_to_string (uri);
2089 /* end of fs_uri.c */