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 2, 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"
88 * Get a unique key from a URI. This is for putting URIs
89 * into HashMaps. The key may change between FS implementations.
91 * @param uri uri to convert to a unique key
92 * @param key wherer to store the unique key
95 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
96 GNUNET_HashCode * key)
101 *key = uri->data.chk.chk.query;
104 GNUNET_CRYPTO_hash (uri->data.sks.identifier,
105 strlen (uri->data.sks.identifier), key);
108 if (uri->data.ksk.keywordCount > 0)
109 GNUNET_CRYPTO_hash (uri->data.ksk.keywords[0],
110 strlen (uri->data.ksk.keywords[0]), key);
113 GNUNET_CRYPTO_hash (&uri->data.loc.fi,
114 sizeof (struct FileIdentifier) +
115 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded), key);
118 memset (key, 0, sizeof (GNUNET_HashCode));
125 * Convert keyword URI to a human readable format
126 * (i.e. the search query that was used in the first place)
128 * @param uri ksk uri to convert to a string
129 * @return string with the keywords
132 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri)
139 unsigned int keywordCount;
141 if ((uri == NULL) || (uri->type != ksk))
146 keywords = uri->data.ksk.keywords;
147 keywordCount = uri->data.ksk.keywordCount;
148 n = keywordCount + 1;
149 for (i = 0; i < keywordCount; i++)
151 keyword = keywords[i];
152 n += strlen (keyword) - 1;
153 if (NULL != strstr (&keyword[1], " "))
155 if (keyword[0] == '+')
158 ret = GNUNET_malloc (n);
160 for (i = 0; i < keywordCount; i++)
162 keyword = keywords[i];
163 if (NULL != strstr (&keyword[1], " "))
166 if (keyword[0] == '+')
167 strcat (ret, keyword);
169 strcat (ret, &keyword[1]);
174 if (keyword[0] == '+')
175 strcat (ret, keyword);
177 strcat (ret, &keyword[1]);
186 * Given a keyword with %-encoding (and possibly quotes to protect
187 * spaces), return a copy of the keyword without %-encoding and
188 * without double-quotes (%22). Also, add a space at the beginning
189 * if there is not a '+'.
191 * @param in string with %-encoding
192 * @param emsg where to store the parser error message (if any)
193 * @return decodded string with leading space (or preserved plus)
196 percent_decode_keyword (const char *in, char **emsg)
204 out = GNUNET_strdup (in);
207 while (out[rpos] != '\0')
209 if (out[rpos] == '%')
211 if (1 != sscanf (&out[rpos + 1], "%2X", &hx))
214 *emsg = GNUNET_strdup (_("`%' must be followed by HEX number"));
219 continue; /* skip double quote */
220 out[wpos++] = (char) hx;
224 out[wpos++] = out[rpos++];
230 ret = GNUNET_strdup (out);
234 /* need to prefix with space */
235 ret = GNUNET_malloc (strlen (out) + 2);
247 * @param s an uri string
248 * @param emsg where to store the parser error message (if any)
249 * @return NULL on error, otherwise the KSK URI
251 static struct GNUNET_FS_Uri *
252 uri_ksk_parse (const char *s, char **emsg)
254 struct GNUNET_FS_Uri *ret;
264 GNUNET_assert (s != NULL);
266 pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX);
267 if ( (slen <= pos) ||
268 (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX,
270 return NULL; /* not KSK URI */
271 if ( (s[slen - 1] == '+') ||
274 *emsg = GNUNET_strdup (_("Malformed KSK URI (must not begin or end with `+')"));
279 for (i = pos; i < slen; i++)
281 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
283 saw_quote = (saw_quote + 1) % 2;
287 if ((s[i] == '+') && (saw_quote == 0))
292 *emsg = GNUNET_strdup (_("`++' not allowed in KSK URI"));
299 *emsg = GNUNET_strdup (_("Quotes not balanced in KSK URI"));
303 dup = GNUNET_strdup (s);
304 keywords = GNUNET_malloc (max * sizeof (char *));
305 for (i = slen - 1; i >= pos; i--)
307 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
309 saw_quote = (saw_quote + 1) % 2;
313 if ((dup[i] == '+') && (saw_quote == 0))
315 keywords[--max] = percent_decode_keyword (&dup[i + 1], emsg);
316 if (NULL == keywords[max])
321 keywords[--max] = percent_decode_keyword (&dup[pos], emsg);
322 if (NULL == keywords[max])
324 GNUNET_assert (max == 0);
326 ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
328 ret->data.ksk.keywordCount = iret;
329 ret->data.ksk.keywords = keywords;
332 for (i = 0; i < max; i++)
333 GNUNET_free_non_null (keywords[i]);
334 GNUNET_free (keywords);
343 * @param s an uri string
344 * @param emsg where to store the parser error message (if any)
345 * @return NULL on error, SKS URI otherwise
347 static struct GNUNET_FS_Uri *
348 uri_sks_parse (const char *s, char **emsg)
350 struct GNUNET_FS_Uri *ret;
351 GNUNET_HashCode namespace;
355 char enc[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
357 GNUNET_assert (s != NULL);
359 pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX);
360 if ( (slen <= pos) ||
361 (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX,
363 return NULL; /* not an SKS URI */
364 if ( (slen < pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
365 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '/') )
367 *emsg = GNUNET_strdup (_("Malformed SKS URI"));
370 memcpy (enc, &s[pos], sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
371 enc[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
372 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (enc, &namespace))
374 *emsg = GNUNET_strdup (_("Malformed SKS URI"));
377 identifier = GNUNET_strdup (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)]);
378 ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
380 ret->data.sks.namespace = namespace;
381 ret->data.sks.identifier = identifier;
389 * @param s an uri string
390 * @param emsg where to store the parser error message (if any)
391 * @return NULL on error, CHK URI otherwise
393 static struct GNUNET_FS_Uri *
394 uri_chk_parse (const char *s, char **emsg)
396 struct GNUNET_FS_Uri *ret;
397 struct FileIdentifier fi;
399 unsigned long long flen;
401 char h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
402 char h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
404 GNUNET_assert (s != NULL);
407 pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX);
408 if ( (slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
409 (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX,
411 return NULL; /* not a CHK URI */
412 if ( (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
413 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.') )
415 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
420 sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
421 h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
423 &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,
429 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2,
431 (1 != SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
435 *emsg = GNUNET_strdup (_("Malformed CHK URI"));
438 fi.file_length = GNUNET_htonll (flen);
439 ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
447 * Convert a character back to the binary value
448 * that it represents (given base64-encoding).
450 * @param a character to convert
451 * @return offset in the "tbl" array
454 c2v (unsigned char a)
456 if ((a >= '0') && (a <= '9'))
458 if ((a >= 'A') && (a <= 'Z'))
459 return (a - 'A' + 10);
460 if ((a >= 'a') && (a <= 'z'))
461 return (a - 'a' + 36);
471 * Convert string back to binary data.
473 * @param input '\0'-terminated string
474 * @param data where to write binary data
475 * @param size how much data should be converted
476 * @return number of characters processed from input,
480 enc2bin (const char *input, void *data, size_t size)
488 if (((size * 8) % 6) != 0)
490 if (strlen (input) < len)
491 return -1; /* error! */
496 for (pos = 0; pos < size; pos++)
500 bits |= (c2v (input[len++]) << hbits);
503 (((unsigned char *) data)[pos]) = (unsigned char) bits;
512 * Structure that defines how the
513 * contents of a location URI must be
514 * assembled in memory to create or
515 * verify the signature of a location
518 struct LocUriAssembly
520 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
522 struct GNUNET_TIME_AbsoluteNBO exptime;
524 struct FileIdentifier fi;
526 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
533 * Also verifies validity of the location URI.
535 * @param s an uri string
536 * @param emsg where to store the parser error message (if any)
537 * @return NULL on error, valid LOC URI otherwise
539 static struct GNUNET_FS_Uri *
540 uri_loc_parse (const char *s, char **emsg)
542 struct GNUNET_FS_Uri *uri;
543 char h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
544 char h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
547 unsigned long long exptime;
548 unsigned long long flen;
549 struct GNUNET_TIME_Absolute et;
550 struct GNUNET_CRYPTO_RsaSignature sig;
551 struct LocUriAssembly ass;
555 GNUNET_assert (s != NULL);
557 pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX);
558 if ( (slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
559 (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX,
561 return NULL; /* not an SKS URI */
562 if ( (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
563 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.') )
565 *emsg = GNUNET_strdup (_("SKS URI malformed"));
570 sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
571 h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
573 &s[pos + sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)],
574 sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
575 h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
577 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1,
579 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2,
580 &ass.fi.chk.query)) ||
581 (1 != SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
585 *emsg = GNUNET_strdup (_("SKS URI malformed"));
588 ass.fi.file_length = GNUNET_htonll (flen);
590 npos = pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2;
591 while ((s[npos] != '\0') && (s[npos] != '.'))
595 *emsg = GNUNET_strdup (_("SKS URI malformed"));
599 ret = enc2bin (&s[npos],
601 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
604 *emsg = 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],
615 sizeof (struct GNUNET_CRYPTO_RsaSignature));
618 *emsg = GNUNET_strdup (_("SKS URI malformed (could not decode signature)"));
622 if (s[npos++] != '.')
624 *emsg = GNUNET_strdup (_("SKS URI malformed"));
627 if (1 != SSCANF (&s[npos], "%llu", &exptime))
629 *emsg = GNUNET_strdup (_("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);
635 ass.exptime = GNUNET_TIME_absolute_hton (et);
637 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT,
642 *emsg = GNUNET_strdup (_("SKS URI malformed (signature failed validation)"));
645 uri = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
647 uri->data.loc.fi = ass.fi;
648 uri->data.loc.peer = ass.peer;
649 uri->data.loc.expirationTime = et;
650 uri->data.loc.contentSignature = sig;
659 * Convert a UTF-8 String to a URI.
661 * @param uri string to parse
662 * @param emsg where to store the parser error message (if any)
663 * @return NULL on error
665 struct GNUNET_FS_Uri *
666 GNUNET_FS_uri_parse (const char *uri,
669 struct GNUNET_FS_Uri *ret;
675 if ( (NULL != (ret = uri_chk_parse (uri, emsg))) ||
676 (NULL != (ret = uri_ksk_parse (uri, emsg))) ||
677 (NULL != (ret = uri_sks_parse (uri, emsg))) ||
678 (NULL != (ret = uri_loc_parse (uri, emsg))) )
681 *emsg = GNUNET_strdup (_("Unrecognized URI type"));
691 * @param uri uri to free
694 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri)
698 GNUNET_assert (uri != NULL);
702 for (i = 0; i < uri->data.ksk.keywordCount; i++)
703 GNUNET_free (uri->data.ksk.keywords[i]);
704 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount,
708 GNUNET_free (uri->data.sks.identifier);
720 * How many keywords are ANDed in this keyword URI?
722 * @param uri ksk uri to get the number of keywords from
723 * @return 0 if this is not a keyword URI
726 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
728 if (uri->type != ksk)
730 return uri->data.ksk.keywordCount;
735 * Iterate over all keywords in this keyword URI.
737 * @param uri ksk uri to get the keywords from
738 * @param iterator function to call on each keyword
739 * @param iterator_cls closure for iterator
740 * @return -1 if this is not a keyword URI, otherwise number of
741 * keywords iterated over until iterator aborted
744 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
745 GNUNET_FS_KeywordIterator iterator,
751 if (uri->type != ksk)
753 if (iterator == NULL)
754 return uri->data.ksk.keywordCount;
755 for (i = 0; i < uri->data.ksk.keywordCount; i++)
757 keyword = uri->data.ksk.keywords[i];
758 /* first character of keyword indicates
759 if it is mandatory or not */
760 if (GNUNET_OK != iterator (iterator_cls,
770 * Obtain the identity of the peer offering the data
772 * @param uri the location URI to inspect
773 * @param peer where to store the identify of the peer (presumably) offering the content
774 * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
777 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
778 struct GNUNET_PeerIdentity * peer)
780 if (uri->type != loc)
781 return GNUNET_SYSERR;
782 GNUNET_CRYPTO_hash (&uri->data.loc.peer,
783 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
790 * Obtain the URI of the content itself.
792 * @param uri location URI to get the content URI from
793 * @return NULL if argument is not a location URI
795 struct GNUNET_FS_Uri *
796 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
798 struct GNUNET_FS_Uri *ret;
800 if (uri->type != loc)
802 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
804 ret->data.chk = uri->data.loc.fi;
810 * Construct a location URI (this peer will be used for the location).
812 * @param baseURI content offered by the sender
813 * @param cfg configuration information (used to find our hostkey)
814 * @param expiration_time how long will the content be offered?
815 * @return the location URI, NULL on error
817 struct GNUNET_FS_Uri *
818 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
819 struct GNUNET_CONFIGURATION_Handle *cfg,
820 struct GNUNET_TIME_Absolute expiration_time)
822 struct GNUNET_FS_Uri *uri;
823 struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
824 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
826 struct LocUriAssembly ass;
828 if (baseUri->type != chk)
831 GNUNET_CONFIGURATION_get_value_filename (cfg,
833 "HOSTKEY", &keyfile))
835 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
837 ("Lacking key configuration settings.\n"));
840 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
841 if (my_private_key == NULL)
843 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
844 _("Could not access hostkey file `%s'.\n"),
846 GNUNET_free (keyfile);
849 GNUNET_free (keyfile);
850 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
851 ass.purpose.size = htonl(sizeof(struct LocUriAssembly));
852 ass.purpose.purpose = htonl(GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
853 ass.exptime = GNUNET_TIME_absolute_hton (expiration_time);
854 ass.fi = baseUri->data.chk;
855 ass.peer = my_public_key;
856 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
858 uri->data.loc.fi = baseUri->data.chk;
859 uri->data.loc.expirationTime = expiration_time;
860 uri->data.loc.peer = my_public_key;
861 GNUNET_assert (GNUNET_OK ==
862 GNUNET_CRYPTO_rsa_sign (my_private_key,
864 &uri->data.loc.contentSignature));
865 GNUNET_CRYPTO_rsa_key_free (my_private_key);
871 * Canonicalize a keyword.
873 * @param in input string (the keyword)
874 * @return canonicalized keyword
877 canonicalize_keyword (const char *in)
883 ret = GNUNET_strdup (in);
886 while ('\0' != *rpos)
888 switch (tolower(*rpos))
899 /* skip characters listed above */
922 /* convert characters listed above to lower case */
923 *wpos = tolower(*rpos);
929 /* keep characters listed above without changes */
933 /* replace characters listed above with '_' */
944 * Canonicalize keyword URI. Performs operations such
945 * as decapitalization and removal of certain characters.
946 * (useful for search).
948 * @param uri the URI to canonicalize
949 * @return canonicalized version of the URI, NULL on error
951 struct GNUNET_FS_Uri *
952 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri)
954 struct GNUNET_FS_Uri *ret;
959 kc = uri->data.ksk.keywordCount;
960 kl = GNUNET_malloc (kc*sizeof(char*));
962 kl[i] = canonicalize_keyword (uri->data.ksk.keywords[i]);
963 ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
965 ret->data.ksk.keywordCount = kc;
966 ret->data.ksk.keywords = kl;
972 * Merge the sets of keywords from two KSK URIs.
973 * (useful for merging the canonicalized keywords with
974 * the original keywords for sharing).
976 * @param u1 first uri
977 * @param u2 second uri
978 * @return merged URI, NULL on error
980 struct GNUNET_FS_Uri *
981 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
982 const struct GNUNET_FS_Uri *u2)
984 struct GNUNET_FS_Uri *ret;
992 if ( (u1->type != ksk) ||
998 kc = u1->data.ksk.keywordCount;
999 kl = GNUNET_malloc ((kc+u2->data.ksk.keywordCount)*sizeof(char*));
1000 for (i=0;i<u1->data.ksk.keywordCount;i++)
1001 kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
1002 for (i=0;i<u2->data.ksk.keywordCount;i++)
1004 kp = u2->data.ksk.keywords[i];
1006 for (j=0;j<u1->data.ksk.keywordCount;j++)
1007 if (0 == strcmp(kp + 1,
1016 kl[kc++] = GNUNET_strdup (kp - 1);
1018 ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
1020 ret->data.ksk.keywordCount = kc;
1021 ret->data.ksk.keywords = kl;
1029 * @param uri the URI to duplicate
1030 * @return copy of the URI
1032 struct GNUNET_FS_Uri *
1033 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
1035 struct GNUNET_FS_Uri *ret;
1038 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1039 memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
1043 if (ret->data.ksk.keywordCount > 0)
1045 ret->data.ksk.keywords
1046 = GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
1047 for (i = 0; i < ret->data.ksk.keywordCount; i++)
1048 ret->data.ksk.keywords[i] =
1049 GNUNET_strdup (uri->data.ksk.keywords[i]);
1052 ret->data.ksk.keywords = NULL; /* just to be sure */
1055 ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1067 * Create an FS URI from a single user-supplied string of keywords.
1068 * The string is broken up at spaces into individual keywords.
1069 * Keywords that start with "+" are mandatory. Double-quotes can
1070 * be used to prevent breaking up strings at spaces (and also
1071 * to specify non-mandatory keywords starting with "+").
1073 * Keywords must contain a balanced number of double quotes and
1074 * double quotes can not be used in the actual keywords (for
1075 * example, the string '""foo bar""' will be turned into two
1076 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1078 * @param keywords the keyword string
1079 * @param emsg where to store an error message
1080 * @return an FS URI for the given keywords, NULL
1081 * if keywords is not legal (i.e. empty).
1083 struct GNUNET_FS_Uri *
1084 GNUNET_FS_uri_ksk_create (const char *keywords,
1088 unsigned int num_Words;
1091 struct GNUNET_FS_Uri *uri;
1095 if (keywords == NULL)
1100 searchString = GNUNET_strdup (keywords);
1105 while ('\0' != *pos)
1107 if ((saw_quote == 0) && (isspace (*pos)))
1111 else if (0 == inWord)
1117 saw_quote = (saw_quote + 1) % 2;
1122 GNUNET_free (searchString);
1123 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1128 GNUNET_free (searchString);
1129 *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1132 keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1136 while ('\0' != *pos)
1138 if ((saw_quote == 0) && (isspace (*pos)))
1143 else if (0 == inWord)
1145 keywordarr[num_Words] = pos;
1150 saw_quote = (saw_quote + 1) % 2;
1154 GNUNET_FS_uri_ksk_create_from_args (num_Words,
1155 (const char **) keywordarr);
1156 GNUNET_free (keywordarr);
1157 GNUNET_free (searchString);
1163 * Create an FS URI from a user-supplied command line of keywords.
1164 * Arguments should start with "+" to indicate mandatory
1167 * @param argc number of keywords
1168 * @param argv keywords (double quotes are not required for
1169 * keywords containing spaces; however, double
1170 * quotes are required for keywords starting with
1171 * "+"); there is no mechanism for having double
1172 * quotes in the actual keywords (if the user
1173 * did specifically specify double quotes, the
1174 * caller should convert each double quote
1175 * into two single quotes).
1176 * @return an FS URI for the given keywords, NULL
1177 * if keywords is not legal (i.e. empty).
1179 struct GNUNET_FS_Uri *
1180 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
1184 struct GNUNET_FS_Uri *uri;
1185 const char *keyword;
1193 /* allow URI to be given as one and only keyword and
1194 handle accordingly */
1197 (strlen(argv[0]) > strlen(GNUNET_FS_URI_PREFIX)) &&
1198 (strncmp(argv[0], GNUNET_FS_URI_PREFIX, strlen(GNUNET_FS_URI_PREFIX)) ) &&
1199 (NULL != (uri = GNUNET_FS_uri_parse(argv[0], &emsg)) ) )
1201 GNUNET_free_non_null (emsg);
1202 uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1204 uri->data.ksk.keywordCount = argc;
1205 uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1206 for (i = 0; i < argc; i++)
1209 if (keyword[0] == '+')
1210 val = GNUNET_strdup (keyword);
1212 GNUNET_asprintf (&val, " %s", keyword);
1223 uri->data.ksk.keywords[i] = val;
1230 * Test if two URIs are equal.
1232 * @param u1 one of the URIs
1233 * @param u2 the other URI
1234 * @return GNUNET_YES if the URIs are equal
1237 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1238 const struct GNUNET_FS_Uri *u2)
1244 GNUNET_assert (u1 != NULL);
1245 GNUNET_assert (u2 != NULL);
1246 if (u1->type != u2->type)
1251 if (0 == memcmp (&u1->data.chk,
1253 sizeof (struct FileIdentifier)))
1257 if ((0 == memcmp (&u1->data.sks.namespace,
1258 &u2->data.sks.namespace,
1259 sizeof (GNUNET_HashCode))) &&
1260 (0 == strcmp (u1->data.sks.identifier,
1261 u2->data.sks.identifier)))
1266 if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1268 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1271 for (j = 0; j < u2->data.ksk.keywordCount; j++)
1273 if (0 == strcmp (u1->data.ksk.keywords[i],
1274 u2->data.ksk.keywords[j]))
1280 if (ret == GNUNET_NO)
1285 if (memcmp (&u1->data.loc,
1287 sizeof (struct FileIdentifier) +
1288 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
1289 sizeof (struct GNUNET_TIME_Absolute) +
1290 sizeof (unsigned short) + sizeof (unsigned short)) != 0)
1300 * Is this a namespace URI?
1302 * @param uri the uri to check
1303 * @return GNUNET_YES if this is an SKS uri
1306 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1308 return uri->type == sks;
1313 * Get the ID of a namespace from the given
1316 * @param uri the uri to get the namespace ID from
1317 * @param nsid where to store the ID of the namespace
1318 * @return GNUNET_OK on success
1321 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1322 GNUNET_HashCode * nsid)
1324 if (! GNUNET_FS_uri_test_sks (uri))
1327 return GNUNET_SYSERR;
1329 *nsid = uri->data.sks.namespace;
1335 * Get the content identifier of an SKS URI.
1337 * @param uri the sks uri
1338 * @return NULL on error (not a valid SKS URI)
1341 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1343 if (!GNUNET_FS_uri_test_sks (uri))
1348 return GNUNET_strdup (uri->data.sks.identifier);
1353 * Convert namespace URI to a human readable format
1354 * (using the namespace description, if available).
1356 * @param cfg configuration to use
1357 * @param uri SKS uri to convert
1358 * @return NULL on error (not an SKS URI)
1361 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
1362 const struct GNUNET_FS_Uri *uri)
1367 if (uri->type != sks)
1369 name = GNUNET_PSEUDONYM_id_to_name (cfg, &uri->data.sks.namespace);
1371 return GNUNET_FS_uri_to_string (uri);
1372 GNUNET_asprintf (&ret,
1375 uri->data.sks.identifier);
1382 * Is this a keyword URI?
1384 * @param uri the uri
1385 * @return GNUNET_YES if this is a KSK uri
1388 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1393 if (uri->type == ksk)
1395 for (i = uri->data.ksk.keywordCount - 1; i >= 0; i--)
1396 GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1399 return uri->type == ksk;
1404 * Is this a file (or directory) URI?
1406 * @param uri the uri to check
1407 * @return GNUNET_YES if this is a CHK uri
1410 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1412 return uri->type == chk;
1417 * What is the size of the file that this URI
1420 * @param uri the CHK URI to inspect
1421 * @return size of the file as specified in the CHK URI
1424 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri)
1429 return GNUNET_ntohll (uri->data.chk.file_length);
1431 return GNUNET_ntohll (uri->data.loc.fi.file_length);
1435 return 0; /* unreachable */
1440 * Is this a location URI?
1442 * @param uri the uri to check
1443 * @return GNUNET_YES if this is a LOC uri
1446 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1448 return uri->type == loc;
1453 * Function called on each value in the meta data.
1454 * Adds it to the URI.
1456 * @param cls URI to update
1457 * @param type type of the meta data
1458 * @param data value of the meta data
1459 * @return GNUNET_OK (always)
1462 gather_uri_data (void *cls,
1463 EXTRACTOR_KeywordType type,
1466 struct GNUNET_FS_Uri *uri = cls;
1470 for (j = uri->data.ksk.keywordCount - 1; j >= 0; j--)
1471 if (0 == strcmp (&uri->data.ksk.keywords[j][1], data))
1473 nkword = GNUNET_malloc (strlen (data) + 2);
1474 strcpy (nkword, " "); /* not mandatory */
1475 strcat (nkword, data);
1476 uri->data.ksk.keywords[uri->data.ksk.keywordCount++] = nkword;
1482 * Construct a keyword-URI from meta-data (take all entries
1483 * in the meta-data and construct one large keyword URI
1484 * that lists all keywords that can be found in the meta-data).
1487 struct GNUNET_FS_Uri *
1488 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md)
1490 struct GNUNET_FS_Uri *ret;
1494 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1496 ret->data.ksk.keywordCount = 0;
1497 ret->data.ksk.keywords = NULL;
1498 ret->data.ksk.keywords
1499 = GNUNET_malloc (sizeof (char *) *
1500 GNUNET_CONTAINER_meta_data_get_contents (md, NULL, NULL));
1501 GNUNET_CONTAINER_meta_data_get_contents (md, &gather_uri_data, ret);
1508 * In URI-encoding, does the given character
1509 * need to be encoded using %-encoding?
1512 needs_percent (char c)
1514 return (!((isalnum (c)) ||
1515 (c == '-') || (c == '_') || (c == '.') || (c == '~')));
1520 * Convert a KSK URI to a string.
1522 * @param uri the URI to convert
1523 * @return NULL on error (i.e. keywordCount == 0)
1526 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1529 unsigned int keywordCount;
1536 const char *keyword;
1538 if (uri->type != ksk)
1540 keywords = uri->data.ksk.keywords;
1541 keywordCount = uri->data.ksk.keywordCount;
1543 keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1544 strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1545 for (i = 0; i < keywordCount; i++)
1547 keyword = keywords[i];
1548 slen = strlen (keyword);
1550 for (j = 0; j < slen; j++)
1552 if ((j == 0) && (keyword[j] == ' '))
1555 continue; /* skip leading space */
1557 if (needs_percent (keyword[j]))
1558 n += 2; /* will use %-encoding */
1561 ret = GNUNET_malloc (n);
1562 strcpy (ret, GNUNET_FS_URI_PREFIX);
1563 strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1564 wpos = strlen (ret);
1565 for (i = 0; i < keywordCount; i++)
1567 keyword = keywords[i];
1568 slen = strlen (keyword);
1569 for (j = 0; j < slen; j++)
1571 if ((j == 0) && (keyword[j] == ' '))
1572 continue; /* skip leading space */
1573 if (needs_percent (keyword[j]))
1575 sprintf (&ret[wpos], "%%%02X", keyword[j]);
1580 ret[wpos++] = keyword[j];
1583 if (i != keywordCount - 1)
1591 * Convert SKS URI to a string.
1593 * @param uri sks uri to convert
1594 * @return NULL on error
1597 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1599 const GNUNET_HashCode * namespace;
1600 const char *identifier;
1602 struct GNUNET_CRYPTO_HashAsciiEncoded ns;
1604 if (uri->type != sks)
1606 namespace = &uri->data.sks.namespace;
1607 identifier = uri->data.sks.identifier;
1608 GNUNET_CRYPTO_hash_to_enc (namespace, &ns);
1609 GNUNET_asprintf (&ret,
1611 GNUNET_FS_URI_PREFIX,
1612 GNUNET_FS_URI_SKS_INFIX,
1613 (const char *) &ns, identifier);
1619 * Convert a CHK URI to a string.
1621 * @param uri chk uri to convert
1622 * @return NULL on error
1625 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1627 const struct FileIdentifier * fi;
1629 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1630 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1632 if (uri->type != chk)
1634 fi = &uri->data.chk;
1635 GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1636 GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1638 GNUNET_asprintf (&ret,
1640 GNUNET_FS_URI_PREFIX,
1641 GNUNET_FS_URI_CHK_INFIX,
1642 (const char *) &keyhash,
1643 (const char *) &queryhash,
1644 GNUNET_ntohll (fi->file_length));
1649 * Convert binary data to a string.
1651 * @param data binary data to convert
1652 * @param size number of bytes in data
1653 * @return converted data
1656 bin2enc (const void *data, size_t size)
1659 * 64 characters for encoding, 6 bits per character
1662 "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_=";
1670 GNUNET_assert (strlen (tbl) == 64);
1672 if (((size * 8) % 6) != 0)
1674 ret = GNUNET_malloc (len + 1);
1679 for (pos = 0; pos < size; pos++)
1681 bits |= ((((const unsigned char *) data)[pos]) << hbits);
1685 ret[len++] = tbl[bits & 63];
1691 ret[len++] = tbl[bits & 63];
1697 * Convert a LOC URI to a string.
1699 * @param uri loc uri to convert
1700 * @return NULL on error
1703 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
1706 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1707 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1711 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
1712 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
1713 peerId = bin2enc (&uri->data.loc.peer,
1714 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
1715 peerSig = bin2enc (&uri->data.loc.contentSignature,
1716 sizeof (struct GNUNET_CRYPTO_RsaSignature));
1717 GNUNET_asprintf (&ret,
1718 "%s%s%s.%s.%llu.%s.%s.%llu",
1719 GNUNET_FS_URI_PREFIX,
1720 GNUNET_FS_URI_LOC_INFIX,
1721 (const char *) &keyhash,
1722 (const char *) &queryhash,
1723 (unsigned long long) GNUNET_ntohll (uri->data.loc.fi.file_length),
1726 (unsigned long long) uri->data.loc.expirationTime.value);
1727 GNUNET_free (peerSig);
1728 GNUNET_free (peerId);
1734 * Convert a URI to a UTF-8 String.
1736 * @param uri uri to convert to a string
1737 * @return the UTF-8 string
1740 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
1750 return uri_ksk_to_string (uri);
1752 return uri_sks_to_string (uri);
1754 return uri_chk_to_string (uri);
1756 return uri_loc_to_string (uri);
1763 /* end of fs_uri.c */