2 This file is part of GNUnet.
3 (C) 2003--2014 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 where to store the unique key
101 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
102 struct GNUNET_HashCode *key)
106 case GNUNET_FS_URI_CHK:
107 *key = uri->data.chk.chk.query;
109 case GNUNET_FS_URI_SKS:
110 GNUNET_CRYPTO_hash (uri->data.sks.identifier,
111 strlen (uri->data.sks.identifier), key);
113 case GNUNET_FS_URI_KSK:
114 if (uri->data.ksk.keywordCount > 0)
115 GNUNET_CRYPTO_hash (uri->data.ksk.keywords[0],
116 strlen (uri->data.ksk.keywords[0]), key);
118 case GNUNET_FS_URI_LOC:
119 GNUNET_CRYPTO_hash (&uri->data.loc.fi,
120 sizeof (struct FileIdentifier) +
121 sizeof (struct GNUNET_PeerIdentity),
125 memset (key, 0, sizeof (struct GNUNET_HashCode));
132 * Convert keyword URI to a human readable format
133 * (i.e. the search query that was used in the first place)
135 * @param uri ksk uri to convert to a string
136 * @return string with the keywords
139 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri)
146 unsigned int keywordCount;
148 if ((NULL == uri) || (GNUNET_FS_URI_KSK != uri->type))
153 keywords = uri->data.ksk.keywords;
154 keywordCount = uri->data.ksk.keywordCount;
155 n = keywordCount + 1;
156 for (i = 0; i < keywordCount; i++)
158 keyword = keywords[i];
159 n += strlen (keyword) - 1;
160 if (NULL != strstr (&keyword[1], " "))
162 if (keyword[0] == '+')
165 ret = GNUNET_malloc (n);
167 for (i = 0; i < keywordCount; i++)
169 keyword = keywords[i];
170 if (NULL != strstr (&keyword[1], " "))
173 if (keyword[0] == '+')
174 strcat (ret, keyword);
176 strcat (ret, &keyword[1]);
181 if (keyword[0] == '+')
182 strcat (ret, keyword);
184 strcat (ret, &keyword[1]);
193 * Given a keyword with %-encoding (and possibly quotes to protect
194 * spaces), return a copy of the keyword without %-encoding and
195 * without double-quotes (%22). Also, add a space at the beginning
196 * if there is not a '+'.
198 * @param in string with %-encoding
199 * @param emsg where to store the parser error message (if any)
200 * @return decodded string with leading space (or preserved plus)
203 percent_decode_keyword (const char *in,
212 out = GNUNET_strdup (in);
215 while (out[rpos] != '\0')
217 if (out[rpos] == '%')
219 if (1 != SSCANF (&out[rpos + 1], "%2X", &hx))
222 *emsg = GNUNET_strdup (_(/* xgettext:no-c-format */
223 "Malformed KSK URI (`%' must be followed by HEX number)"));
228 continue; /* skip double quote */
229 out[wpos++] = (char) hx;
233 out[wpos++] = out[rpos++];
239 ret = GNUNET_strdup (out);
243 /* need to prefix with space */
244 ret = GNUNET_malloc (strlen (out) + 2);
252 #define GNUNET_FS_URI_KSK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX
257 * @param s an uri string
258 * @param emsg where to store the parser error message (if any)
259 * @return NULL on error, otherwise the KSK URI
261 static struct GNUNET_FS_Uri *
262 uri_ksk_parse (const char *s,
265 struct GNUNET_FS_Uri *ret;
276 pos = strlen (GNUNET_FS_URI_KSK_PREFIX);
277 if ((slen <= pos) || (0 != strncmp (s, GNUNET_FS_URI_KSK_PREFIX, pos)))
278 return NULL; /* not KSK URI */
279 if ((s[slen - 1] == '+') || (s[pos] == '+'))
282 GNUNET_strdup (_("Malformed KSK URI (must not begin or end with `+')"));
287 for (i = pos; i < slen; i++)
289 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
291 saw_quote = (saw_quote + 1) % 2;
295 if ((s[i] == '+') && (saw_quote == 0))
300 *emsg = GNUNET_strdup (_("Malformed KSK URI (`++' not allowed)"));
307 *emsg = GNUNET_strdup (_("Malformed KSK URI (quotes not balanced)"));
311 dup = GNUNET_strdup (s);
312 keywords = GNUNET_malloc (max * sizeof (char *));
313 for (i = slen - 1; i >= (int) pos; i--)
315 if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
317 saw_quote = (saw_quote + 1) % 2;
320 if ((dup[i] == '+') && (saw_quote == 0))
322 keywords[--max] = percent_decode_keyword (&dup[i + 1], emsg);
323 if (NULL == keywords[max])
328 keywords[--max] = percent_decode_keyword (&dup[pos], emsg);
329 if (NULL == keywords[max])
331 GNUNET_assert (0 == max);
333 ret = GNUNET_new (struct GNUNET_FS_Uri);
334 ret->type = GNUNET_FS_URI_KSK;
335 ret->data.ksk.keywordCount = iret;
336 ret->data.ksk.keywords = keywords;
339 for (i = 0; i < max; i++)
340 GNUNET_free_non_null (keywords[i]);
341 GNUNET_free (keywords);
347 #define GNUNET_FS_URI_SKS_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX
352 * @param s an uri string
353 * @param emsg where to store the parser error message (if any)
354 * @return NULL on error, SKS URI otherwise
356 static struct GNUNET_FS_Uri *
357 uri_sks_parse (const char *s,
360 struct GNUNET_FS_Uri *ret;
361 struct GNUNET_CRYPTO_EcdsaPublicKey ns;
365 pos = strlen (GNUNET_FS_URI_SKS_PREFIX);
366 if ((strlen (s) <= pos) || (0 != strncmp (s, GNUNET_FS_URI_SKS_PREFIX, pos)))
367 return NULL; /* not an SKS URI */
368 end = strchr (&s[pos], '/');
369 if ( (NULL == end) ||
371 GNUNET_STRINGS_string_to_data (&s[pos],
376 *emsg = GNUNET_strdup (_("Malformed SKS URI (wrong syntax)"));
377 return NULL; /* malformed */
379 end++; /* skip over '/' */
380 ret = GNUNET_new (struct GNUNET_FS_Uri);
381 ret->type = GNUNET_FS_URI_SKS;
382 ret->data.sks.ns = ns;
383 ret->data.sks.identifier = GNUNET_strdup (end);
387 #define GNUNET_FS_URI_CHK_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX
393 * @param s an uri string
394 * @param emsg where to store the parser error message (if any)
395 * @return NULL on error, CHK URI otherwise
397 static struct GNUNET_FS_Uri *
398 uri_chk_parse (const char *s,
401 struct GNUNET_FS_Uri *ret;
402 struct FileIdentifier fi;
404 unsigned long long flen;
406 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
407 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
410 pos = strlen (GNUNET_FS_URI_CHK_PREFIX);
411 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
412 (0 != strncmp (s, GNUNET_FS_URI_CHK_PREFIX, pos)))
413 return NULL; /* not a CHK URI */
414 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
415 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
417 *emsg = GNUNET_strdup (_("Malformed CHK URI (wrong syntax)"));
420 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
421 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
422 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
423 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
424 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
426 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &fi.chk.key)) ||
427 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &fi.chk.query)) ||
429 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
432 *emsg = GNUNET_strdup (_("Malformed CHK URI (failed to decode CHK)"));
435 fi.file_length = GNUNET_htonll (flen);
436 ret = GNUNET_new (struct GNUNET_FS_Uri);
437 ret->type = GNUNET_FS_URI_CHK;
443 GNUNET_NETWORK_STRUCT_BEGIN
445 * Structure that defines how the contents of a location URI must be
446 * assembled in memory to create or verify the signature of a location
449 struct LocUriAssembly
452 * What is being signed (rest of this struct).
454 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
457 * Expiration time of the offer.
459 struct GNUNET_TIME_AbsoluteNBO exptime;
462 * File being offered.
464 struct FileIdentifier fi;
467 * Peer offering the file.
469 struct GNUNET_PeerIdentity peer;
472 GNUNET_NETWORK_STRUCT_END
475 #define GNUNET_FS_URI_LOC_PREFIX GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX
477 #define SIGNATURE_ASCII_LENGTH 103
481 * Also verifies validity of the location URI.
483 * @param s an uri string
484 * @param emsg where to store the parser error message (if any)
485 * @return NULL on error, valid LOC URI otherwise
487 static struct GNUNET_FS_Uri *
488 uri_loc_parse (const char *s,
491 struct GNUNET_FS_Uri *uri;
492 char h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
493 char h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)];
496 unsigned long long exptime;
497 unsigned long long flen;
498 struct GNUNET_TIME_Absolute et;
499 struct GNUNET_CRYPTO_EddsaSignature sig;
500 struct LocUriAssembly ass;
504 pos = strlen (GNUNET_FS_URI_LOC_PREFIX);
505 if ((slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
506 (0 != strncmp (s, GNUNET_FS_URI_LOC_PREFIX, pos)))
507 return NULL; /* not a LOC URI */
508 if ((s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
509 (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.'))
511 *emsg = GNUNET_strdup (_("LOC URI malformed (wrong syntax)"));
514 memcpy (h1, &s[pos], sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
515 h1[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
516 memcpy (h2, &s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)],
517 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded));
518 h2[sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] = '\0';
520 if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1, &ass.fi.chk.key)) ||
521 (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2, &ass.fi.chk.query)) ||
523 SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
526 *emsg = GNUNET_strdup (_("LOC URI malformed (no CHK)"));
529 ass.fi.file_length = GNUNET_htonll (flen);
531 npos = pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2;
532 while ((s[npos] != '\0') && (s[npos] != '.'))
536 *emsg = GNUNET_strdup (_("LOC URI malformed (missing LOC)"));
540 if ( (strlen (&s[npos]) <= GNUNET_CRYPTO_PKEY_ASCII_LENGTH + 1) ||
541 ('.' != s[npos+GNUNET_CRYPTO_PKEY_ASCII_LENGTH]) )
544 GNUNET_strdup (_("LOC URI malformed (wrong syntax for public key)"));
547 GNUNET_CRYPTO_eddsa_public_key_from_string (&s[npos],
548 GNUNET_CRYPTO_PKEY_ASCII_LENGTH,
549 &ass.peer.public_key))
552 GNUNET_strdup (_("LOC URI malformed (could not decode public key)"));
555 npos += GNUNET_CRYPTO_PKEY_ASCII_LENGTH;
556 if (s[npos++] != '.')
558 *emsg = GNUNET_strdup (_("LOC URI malformed (could not find signature)"));
561 if ( (strlen (&s[npos]) <= SIGNATURE_ASCII_LENGTH + 1) ||
562 ('.' != s[npos + SIGNATURE_ASCII_LENGTH]) )
564 *emsg = GNUNET_strdup (_("LOC URI malformed (wrong syntax for signature)"));
568 GNUNET_STRINGS_string_to_data (&s[npos],
569 SIGNATURE_ASCII_LENGTH,
571 sizeof (struct GNUNET_CRYPTO_EddsaSignature)))
573 *emsg = GNUNET_strdup (_("LOC URI malformed (could not decode signature)"));
576 npos += SIGNATURE_ASCII_LENGTH;
577 if (s[npos++] != '.')
579 *emsg = GNUNET_strdup (_("LOC URI malformed (wrong syntax for expiration time)"));
582 if (1 != SSCANF (&s[npos], "%llu", &exptime))
585 GNUNET_strdup (_("LOC URI malformed (could not parse expiration time)"));
588 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
589 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
590 et.abs_value_us = exptime * 1000LL * 1000LL;
591 ass.exptime = GNUNET_TIME_absolute_hton (et);
593 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT,
594 &ass.purpose, &sig, &ass.peer.public_key))
597 GNUNET_strdup (_("LOC URI malformed (signature failed validation)"));
600 uri = GNUNET_new (struct GNUNET_FS_Uri);
601 uri->type = GNUNET_FS_URI_LOC;
602 uri->data.loc.fi = ass.fi;
603 uri->data.loc.peer = ass.peer;
604 uri->data.loc.expirationTime = et;
605 uri->data.loc.contentSignature = sig;
614 * Convert a UTF-8 String to a URI.
616 * @param uri string to parse
617 * @param emsg where to store the parser error message (if any)
618 * @return NULL on error
620 struct GNUNET_FS_Uri *
621 GNUNET_FS_uri_parse (const char *uri,
624 struct GNUNET_FS_Uri *ret;
631 *emsg = GNUNET_strdup (_("invalid argument"));
637 if ((NULL != (ret = uri_chk_parse (uri, emsg))) ||
638 (NULL != (ret = uri_ksk_parse (uri, emsg))) ||
639 (NULL != (ret = uri_sks_parse (uri, emsg))) ||
640 (NULL != (ret = uri_loc_parse (uri, emsg))))
643 *emsg = GNUNET_strdup (_("Unrecognized URI type"));
653 * @param uri uri to free
656 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri)
662 case GNUNET_FS_URI_KSK:
663 for (i = 0; i < uri->data.ksk.keywordCount; i++)
664 GNUNET_free (uri->data.ksk.keywords[i]);
665 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount, 0);
667 case GNUNET_FS_URI_SKS:
668 GNUNET_free (uri->data.sks.identifier);
670 case GNUNET_FS_URI_LOC:
681 * How many keywords are ANDed in this keyword URI?
683 * @param uri ksk uri to get the number of keywords from
684 * @return 0 if this is not a keyword URI
687 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
689 if (uri->type != GNUNET_FS_URI_KSK)
691 return uri->data.ksk.keywordCount;
696 * Iterate over all keywords in this keyword URI.
698 * @param uri ksk uri to get the keywords from
699 * @param iterator function to call on each keyword
700 * @param iterator_cls closure for iterator
701 * @return -1 if this is not a keyword URI, otherwise number of
702 * keywords iterated over until iterator aborted
705 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
706 GNUNET_FS_KeywordIterator iterator,
712 if (uri->type != GNUNET_FS_URI_KSK)
714 if (NULL == iterator)
715 return uri->data.ksk.keywordCount;
716 for (i = 0; i < uri->data.ksk.keywordCount; i++)
718 keyword = uri->data.ksk.keywords[i];
719 /* first character of keyword indicates
720 * if it is mandatory or not */
721 if (GNUNET_OK != iterator (iterator_cls, &keyword[1], keyword[0] == '+'))
729 * Add the given keyword to the set of keywords represented by the URI.
730 * Does nothing if the keyword is already present.
732 * @param uri ksk uri to modify
733 * @param keyword keyword to add
734 * @param is_mandatory is this keyword mandatory?
737 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri,
745 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
746 for (i = 0; i < uri->data.ksk.keywordCount; i++)
748 old = uri->data.ksk.keywords[i];
749 if (0 == strcmp (&old[1], keyword))
752 GNUNET_asprintf (&n, is_mandatory ? "+%s" : " %s", keyword);
753 GNUNET_array_append (uri->data.ksk.keywords, uri->data.ksk.keywordCount, n);
758 * Remove the given keyword from the set of keywords represented by the URI.
759 * Does nothing if the keyword is not present.
761 * @param uri ksk uri to modify
762 * @param keyword keyword to add
765 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
771 GNUNET_assert (uri->type == GNUNET_FS_URI_KSK);
772 for (i = 0; i < uri->data.ksk.keywordCount; i++)
774 old = uri->data.ksk.keywords[i];
775 if (0 == strcmp (&old[1], keyword))
777 uri->data.ksk.keywords[i] =
778 uri->data.ksk.keywords[uri->data.ksk.keywordCount - 1];
779 GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount,
780 uri->data.ksk.keywordCount - 1);
789 * Obtain the identity of the peer offering the data
791 * @param uri the location URI to inspect
792 * @param peer where to store the identify of the peer (presumably) offering the content
793 * @return #GNUNET_SYSERR if this is not a location URI, otherwise #GNUNET_OK
796 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
797 struct GNUNET_PeerIdentity *peer)
799 if (uri->type != GNUNET_FS_URI_LOC)
800 return GNUNET_SYSERR;
801 *peer = uri->data.loc.peer;
807 * Obtain the expiration of the LOC URI.
809 * @param uri location URI to get the expiration from
810 * @return expiration time of the URI
812 struct GNUNET_TIME_Absolute
813 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri)
815 GNUNET_assert (uri->type == GNUNET_FS_URI_LOC);
816 return uri->data.loc.expirationTime;
821 * Obtain the URI of the content itself.
823 * @param uri location URI to get the content URI from
824 * @return NULL if argument is not a location URI
826 struct GNUNET_FS_Uri *
827 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
829 struct GNUNET_FS_Uri *ret;
831 if (uri->type != GNUNET_FS_URI_LOC)
833 ret = GNUNET_new (struct GNUNET_FS_Uri);
834 ret->type = GNUNET_FS_URI_CHK;
835 ret->data.chk = uri->data.loc.fi;
841 * Construct a location URI (this peer will be used for the location).
842 * This function should only be called from within gnunet-service-fs,
843 * as it requires the peer's private key which is generally unavailable
844 * to processes directly under the user's control. However, for
845 * testing and as it logically fits under URIs, it is in this API.
847 * @param base_uri content offered by the sender
848 * @param sign_key private key of the peer
849 * @param expiration_time how long will the content be offered?
850 * @return the location URI, NULL on error
852 struct GNUNET_FS_Uri *
853 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *base_uri,
854 const struct GNUNET_CRYPTO_EddsaPrivateKey *sign_key,
855 struct GNUNET_TIME_Absolute expiration_time)
857 struct GNUNET_FS_Uri *uri;
858 struct GNUNET_CRYPTO_EddsaPublicKey my_public_key;
859 struct LocUriAssembly ass;
860 struct GNUNET_TIME_Absolute et;
862 if (GNUNET_FS_URI_CHK != base_uri->type)
864 /* we round expiration time to full seconds for SKS URIs */
865 et.abs_value_us = (expiration_time.abs_value_us / 1000000LL) * 1000000LL;
866 GNUNET_CRYPTO_eddsa_key_get_public (sign_key,
868 ass.purpose.size = htonl (sizeof (struct LocUriAssembly));
869 ass.purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
870 ass.exptime = GNUNET_TIME_absolute_hton (et);
871 ass.fi = base_uri->data.chk;
872 ass.peer.public_key = my_public_key;
873 uri = GNUNET_new (struct GNUNET_FS_Uri);
874 uri->type = GNUNET_FS_URI_LOC;
875 uri->data.loc.fi = base_uri->data.chk;
876 uri->data.loc.expirationTime = et;
877 uri->data.loc.peer.public_key = my_public_key;
878 GNUNET_assert (GNUNET_OK ==
879 GNUNET_CRYPTO_eddsa_sign (sign_key,
881 &uri->data.loc.contentSignature));
887 * Create an SKS URI from a namespace ID and an identifier.
889 * @param ns namespace ID
890 * @param id identifier
891 * @return an FS URI for the given namespace and identifier
893 struct GNUNET_FS_Uri *
894 GNUNET_FS_uri_sks_create (const struct GNUNET_CRYPTO_EcdsaPublicKey *ns,
897 struct GNUNET_FS_Uri *ns_uri;
899 ns_uri = GNUNET_new (struct GNUNET_FS_Uri);
900 ns_uri->type = GNUNET_FS_URI_SKS;
901 ns_uri->data.sks.ns = *ns;
902 ns_uri->data.sks.identifier = GNUNET_strdup (id);
908 * Merge the sets of keywords from two KSK URIs.
909 * (useful for merging the canonicalized keywords with
910 * the original keywords for sharing).
912 * @param u1 first uri
913 * @param u2 second uri
914 * @return merged URI, NULL on error
916 struct GNUNET_FS_Uri *
917 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
918 const struct GNUNET_FS_Uri *u2)
920 struct GNUNET_FS_Uri *ret;
928 if ((u1 == NULL) && (u2 == NULL))
931 return GNUNET_FS_uri_dup (u2);
933 return GNUNET_FS_uri_dup (u1);
934 if ((u1->type != GNUNET_FS_URI_KSK) || (u2->type != GNUNET_FS_URI_KSK))
939 kc = u1->data.ksk.keywordCount;
940 kl = GNUNET_malloc ((kc + u2->data.ksk.keywordCount) * sizeof (char *));
941 for (i = 0; i < u1->data.ksk.keywordCount; i++)
942 kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
943 for (i = 0; i < u2->data.ksk.keywordCount; i++)
945 kp = u2->data.ksk.keywords[i];
947 for (j = 0; j < u1->data.ksk.keywordCount; j++)
948 if (0 == strcmp (kp + 1, kl[j] + 1))
956 kl[kc++] = GNUNET_strdup (kp);
958 ret = GNUNET_new (struct GNUNET_FS_Uri);
959 ret->type = GNUNET_FS_URI_KSK;
960 ret->data.ksk.keywordCount = kc;
961 ret->data.ksk.keywords = kl;
969 * @param uri the URI to duplicate
970 * @return copy of the URI
972 struct GNUNET_FS_Uri *
973 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
975 struct GNUNET_FS_Uri *ret;
980 ret = GNUNET_new (struct GNUNET_FS_Uri);
981 memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
984 case GNUNET_FS_URI_KSK:
985 if (ret->data.ksk.keywordCount >=
986 GNUNET_MAX_MALLOC_CHECKED / sizeof (char *))
992 if (ret->data.ksk.keywordCount > 0)
994 ret->data.ksk.keywords =
995 GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
996 for (i = 0; i < ret->data.ksk.keywordCount; i++)
997 ret->data.ksk.keywords[i] = GNUNET_strdup (uri->data.ksk.keywords[i]);
1000 ret->data.ksk.keywords = NULL; /* just to be sure */
1002 case GNUNET_FS_URI_SKS:
1003 ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1005 case GNUNET_FS_URI_LOC:
1015 * Create an FS URI from a single user-supplied string of keywords.
1016 * The string is broken up at spaces into individual keywords.
1017 * Keywords that start with "+" are mandatory. Double-quotes can
1018 * be used to prevent breaking up strings at spaces (and also
1019 * to specify non-mandatory keywords starting with "+").
1021 * Keywords must contain a balanced number of double quotes and
1022 * double quotes can not be used in the actual keywords (for
1023 * example, the string '""foo bar""' will be turned into two
1024 * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1026 * @param keywords the keyword string
1027 * @param emsg where to store an error message
1028 * @return an FS URI for the given keywords, NULL
1029 * if keywords is not legal (i.e. empty).
1031 struct GNUNET_FS_Uri *
1032 GNUNET_FS_uri_ksk_create (const char *keywords,
1036 unsigned int num_Words;
1039 struct GNUNET_FS_Uri *uri;
1043 if (keywords == NULL)
1045 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1049 searchString = GNUNET_strdup (keywords);
1054 while ('\0' != *pos)
1056 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1060 else if (0 == inWord)
1066 saw_quote = (saw_quote + 1) % 2;
1071 GNUNET_free (searchString);
1072 *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1077 GNUNET_free (searchString);
1078 *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1081 keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1085 while ('\0' != *pos)
1087 if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1092 else if (0 == inWord)
1094 keywordarr[num_Words] = pos;
1099 saw_quote = (saw_quote + 1) % 2;
1103 GNUNET_FS_uri_ksk_create_from_args (num_Words,
1104 (const char **) keywordarr);
1105 GNUNET_free (keywordarr);
1106 GNUNET_free (searchString);
1112 * Create an FS URI from a user-supplied command line of keywords.
1113 * Arguments should start with "+" to indicate mandatory
1116 * @param argc number of keywords
1117 * @param argv keywords (double quotes are not required for
1118 * keywords containing spaces; however, double
1119 * quotes are required for keywords starting with
1120 * "+"); there is no mechanism for having double
1121 * quotes in the actual keywords (if the user
1122 * did specifically specify double quotes, the
1123 * caller should convert each double quote
1124 * into two single quotes).
1125 * @return an FS URI for the given keywords, NULL
1126 * if keywords is not legal (i.e. empty).
1128 struct GNUNET_FS_Uri *
1129 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
1133 struct GNUNET_FS_Uri *uri;
1134 const char *keyword;
1142 /* allow URI to be given as one and only keyword and
1143 * handle accordingly */
1145 if ((argc == 1) && (strlen (argv[0]) > strlen (GNUNET_FS_URI_PREFIX)) &&
1147 strncmp (argv[0], GNUNET_FS_URI_PREFIX, strlen (GNUNET_FS_URI_PREFIX)))
1148 && (NULL != (uri = GNUNET_FS_uri_parse (argv[0], &emsg))))
1150 GNUNET_free_non_null (emsg);
1151 uri = GNUNET_new (struct GNUNET_FS_Uri);
1152 uri->type = GNUNET_FS_URI_KSK;
1153 uri->data.ksk.keywordCount = argc;
1154 uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1155 for (i = 0; i < argc; i++)
1158 if (keyword[0] == '+')
1159 val = GNUNET_strdup (keyword);
1161 GNUNET_asprintf (&val, " %s", keyword);
1172 uri->data.ksk.keywords[i] = val;
1179 * Test if two URIs are equal.
1181 * @param u1 one of the URIs
1182 * @param u2 the other URI
1183 * @return #GNUNET_YES if the URIs are equal
1186 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1187 const struct GNUNET_FS_Uri *u2)
1193 GNUNET_assert (u1 != NULL);
1194 GNUNET_assert (u2 != NULL);
1195 if (u1->type != u2->type)
1199 case GNUNET_FS_URI_CHK:
1201 memcmp (&u1->data.chk, &u2->data.chk, sizeof (struct FileIdentifier)))
1204 case GNUNET_FS_URI_SKS:
1206 memcmp (&u1->data.sks.ns, &u2->data.sks.ns,
1207 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey))) &&
1208 (0 == strcmp (u1->data.sks.identifier, u2->data.sks.identifier)))
1212 case GNUNET_FS_URI_KSK:
1213 if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1215 for (i = 0; i < u1->data.ksk.keywordCount; i++)
1218 for (j = 0; j < u2->data.ksk.keywordCount; j++)
1220 if (0 == strcmp (u1->data.ksk.keywords[i], u2->data.ksk.keywords[j]))
1226 if (ret == GNUNET_NO)
1230 case GNUNET_FS_URI_LOC:
1232 (&u1->data.loc, &u2->data.loc,
1233 sizeof (struct FileIdentifier) +
1234 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) +
1235 sizeof (struct GNUNET_TIME_Absolute) + sizeof (unsigned short) +
1236 sizeof (unsigned short)) != 0)
1246 * Is this a namespace URI?
1248 * @param uri the uri to check
1249 * @return #GNUNET_YES if this is an SKS uri
1252 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1254 return uri->type == GNUNET_FS_URI_SKS;
1259 * Get the ID of a namespace from the given
1262 * @param uri the uri to get the namespace ID from
1263 * @param pseudonym where to store the ID of the namespace
1264 * @return #GNUNET_OK on success
1267 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1268 struct GNUNET_CRYPTO_EcdsaPublicKey *pseudonym)
1270 if (!GNUNET_FS_uri_test_sks (uri))
1273 return GNUNET_SYSERR;
1275 *pseudonym = uri->data.sks.ns;
1281 * Get the content identifier of an SKS URI.
1283 * @param uri the sks uri
1284 * @return NULL on error (not a valid SKS URI)
1287 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1289 if (!GNUNET_FS_uri_test_sks (uri))
1294 return GNUNET_strdup (uri->data.sks.identifier);
1299 * Is this a keyword URI?
1301 * @param uri the uri
1302 * @return #GNUNET_YES if this is a KSK uri
1305 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1310 if (uri->type == GNUNET_FS_URI_KSK)
1312 for (i=0;i < uri->data.ksk.keywordCount; i++)
1313 GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1316 return uri->type == GNUNET_FS_URI_KSK;
1321 * Is this a file (or directory) URI?
1323 * @param uri the uri to check
1324 * @return #GNUNET_YES if this is a CHK uri
1327 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1329 return uri->type == GNUNET_FS_URI_CHK;
1334 * What is the size of the file that this URI
1337 * @param uri the CHK URI to inspect
1338 * @return size of the file as specified in the CHK URI
1341 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri * uri)
1345 case GNUNET_FS_URI_CHK:
1346 return GNUNET_ntohll (uri->data.chk.file_length);
1347 case GNUNET_FS_URI_LOC:
1348 return GNUNET_ntohll (uri->data.loc.fi.file_length);
1352 return 0; /* unreachable */
1357 * Is this a location URI?
1359 * @param uri the uri to check
1360 * @return #GNUNET_YES if this is a LOC uri
1363 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1365 return uri->type == GNUNET_FS_URI_LOC;
1370 * Add a keyword as non-mandatory (with ' '-prefix) to the
1371 * given keyword list at offset 'index'. The array is
1372 * guaranteed to be long enough.
1374 * @param s keyword to add
1375 * @param array array to add the keyword to
1376 * @param index offset where to add the keyword
1379 insert_non_mandatory_keyword (const char *s,
1385 GNUNET_asprintf (&nkword,
1386 " %s", /* space to mark as 'non mandatory' */
1388 array[index] = nkword;
1393 * Test if the given keyword @a s is already present in the
1394 * given array, ignoring the '+'-mandatory prefix in the array.
1396 * @param s keyword to test
1397 * @param array keywords to test against, with ' ' or '+' prefix to ignore
1398 * @param array_length length of the @a array
1399 * @return #GNUNET_YES if the keyword exists, #GNUNET_NO if not
1402 find_duplicate (const char *s,
1408 for (j = array_length - 1; j >= 0; j--)
1409 if (0 == strcmp (&array[j][1], s))
1419 normalize_metadata (enum EXTRACTOR_MetaFormat format,
1423 uint8_t *free_str = NULL;
1424 uint8_t *str_to_normalize = (uint8_t *) data;
1425 uint8_t *normalized;
1427 if (str_to_normalize == NULL)
1429 /* Don't trust libextractor */
1430 if (format == EXTRACTOR_METAFORMAT_UTF8)
1432 free_str = (uint8_t *) u8_check ((const uint8_t *) data, data_len);
1433 if (free_str == NULL)
1436 format = EXTRACTOR_METAFORMAT_C_STRING;
1438 if (format == EXTRACTOR_METAFORMAT_C_STRING)
1440 free_str = u8_strconv_from_encoding (data, locale_charset (), iconveh_escape_sequence);
1441 if (free_str == NULL)
1445 normalized = u8_tolower (str_to_normalize, strlen ((char *) str_to_normalize), NULL, UNINORM_NFD, NULL, &r_len);
1446 /* free_str is allocated by libunistring internally, use free() */
1447 if (free_str != NULL)
1449 if (normalized != NULL)
1451 /* u8_tolower allocates a non-NULL-terminated string! */
1452 free_str = GNUNET_malloc (r_len + 1);
1453 memcpy (free_str, normalized, r_len);
1454 free_str[r_len] = '\0';
1456 normalized = free_str;
1458 return (char *) normalized;
1463 * Counts the number of UTF-8 characters (not bytes) in the string,
1464 * returns that count.
1467 u8_strcount (const uint8_t *s)
1471 GNUNET_assert (s != NULL);
1474 for (count = 0; s != NULL; count++)
1475 s = u8_next (&c, s);
1481 * Break the filename up by matching [], () and {} pairs to make
1482 * keywords. In case of nesting parentheses only the inner pair counts.
1483 * You can't escape parentheses to scan something like "[blah\{foo]" to
1484 * make a "blah{foo" keyword, this function is only a heuristic!
1486 * @param s string to break down.
1487 * @param array array to fill with enclosed tokens. If NULL, then tokens
1489 * @param index index at which to start filling the array (entries prior
1490 * to it are used to check for duplicates). ignored if @a array == NULL.
1491 * @return number of tokens counted (including duplicates), or number of
1492 * tokens extracted (excluding duplicates). 0 if there are no
1493 * matching parens in the string (when counting), or when all tokens
1494 * were duplicates (when extracting).
1497 get_keywords_from_parens (const char *s,
1509 ss = GNUNET_strdup (s);
1510 open_paren = ss - 1;
1511 while (NULL != (open_paren = strpbrk (open_paren + 1, "[{(")))
1515 close_paren = strpbrk (open_paren + 1, "]})");
1516 if (NULL == close_paren)
1518 switch (open_paren[0])
1521 if (']' == close_paren[0])
1525 if ('}' == close_paren[0])
1529 if (')' == close_paren[0])
1535 if (match && (close_paren - open_paren > 1))
1537 tmp = close_paren[0];
1538 close_paren[0] = '\0';
1539 /* Keywords must be at least 3 characters long */
1540 if (u8_strcount ((const uint8_t *) &open_paren[1]) <= 2)
1542 close_paren[0] = tmp;
1548 if (GNUNET_NO == find_duplicate ((const char *) &open_paren[1],
1549 (const char **) array, index + count))
1551 insert_non_mandatory_keyword ((const char *) &open_paren[1], array,
1555 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1556 &open_paren[1], close_paren - &open_paren[1]);
1557 if (normalized != NULL)
1559 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1560 (const char **) array, index + count))
1562 insert_non_mandatory_keyword ((const char *) normalized, array,
1566 GNUNET_free (normalized);
1571 close_paren[0] = tmp;
1580 * Where to break up keywords
1582 #define TOKENS "_. /-!?#&+@\"\'\\;:,()[]{}$<>|"
1585 * Break the filename up by TOKENS to make
1588 * @param s string to break down.
1589 * @param array array to fill with tokens. If NULL, then tokens are only
1591 * @param index index at which to start filling the array (entries prior
1592 * to it are used to check for duplicates). ignored if @a array == NULL.
1593 * @return number of tokens (>1) counted (including duplicates), or number of
1594 * tokens extracted (excluding duplicates). 0 if there are no
1595 * separators in the string (when counting), or when all tokens were
1596 * duplicates (when extracting).
1599 get_keywords_from_tokens (const char *s,
1607 ss = GNUNET_strdup (s);
1608 for (p = strtok (ss, TOKENS); p != NULL; p = strtok (NULL, TOKENS))
1610 /* Keywords must be at least 3 characters long */
1611 if (u8_strcount ((const uint8_t *) p) <= 2)
1616 if (GNUNET_NO == find_duplicate (p, (const char **) array, index + seps))
1618 insert_non_mandatory_keyword (p, array,
1622 normalized = normalize_metadata (EXTRACTOR_METAFORMAT_UTF8,
1624 if (normalized != NULL)
1626 if (GNUNET_NO == find_duplicate ((const char *) normalized,
1627 (const char **) array, index + seps))
1629 insert_non_mandatory_keyword ((const char *) normalized, array,
1633 GNUNET_free (normalized);
1646 * Function called on each value in the meta data.
1647 * Adds it to the URI.
1649 * @param cls URI to update
1650 * @param plugin_name name of the plugin that produced this value;
1651 * special values can be used (i.e. '<zlib>' for zlib being
1652 * used in the main libextractor library and yielding
1654 * @param type libextractor-type describing the meta data
1655 * @param format basic format information about data
1656 * @param data_mime_type mime-type of data (not of the original file);
1657 * can be NULL (if mime-type is not known)
1658 * @param data actual meta-data found
1659 * @param data_len number of bytes in @a data
1660 * @return 0 (always)
1663 gather_uri_data (void *cls, const char *plugin_name,
1664 enum EXTRACTOR_MetaType type,
1665 enum EXTRACTOR_MetaFormat format,
1666 const char *data_mime_type,
1670 struct GNUNET_FS_Uri *uri = cls;
1671 char *normalized_data;
1674 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
1675 (format != EXTRACTOR_METAFORMAT_C_STRING))
1677 /* Keywords must be at least 3 characters long
1678 * If given non-utf8 string it will, most likely, find it to be invalid,
1679 * and will return the length of its valid part, skipping the keyword.
1680 * If it does - fix the extractor, not this check!
1682 if (u8_strcount ((const uint8_t *) data) <= 2)
1684 if ( (EXTRACTOR_METATYPE_MIMETYPE == type) &&
1685 (NULL != (sep = memchr (data, '/', data_len))) &&
1690 GNUNET_asprintf (&xtra,
1694 if (! find_duplicate (xtra,
1695 (const char **) uri->data.ksk.keywords,
1696 uri->data.ksk.keywordCount))
1698 insert_non_mandatory_keyword (xtra,
1699 uri->data.ksk.keywords,
1700 uri->data.ksk.keywordCount);
1701 uri->data.ksk.keywordCount++;
1706 normalized_data = normalize_metadata (format, data, data_len);
1707 if (! find_duplicate (data,
1708 (const char **) uri->data.ksk.keywords,
1709 uri->data.ksk.keywordCount))
1711 insert_non_mandatory_keyword (data,
1712 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1713 uri->data.ksk.keywordCount++;
1715 if (NULL != normalized_data)
1717 if (! find_duplicate (normalized_data,
1718 (const char **) uri->data.ksk.keywords,
1719 uri->data.ksk.keywordCount))
1721 insert_non_mandatory_keyword (normalized_data,
1722 uri->data.ksk.keywords, uri->data.ksk.keywordCount);
1723 uri->data.ksk.keywordCount++;
1725 GNUNET_free (normalized_data);
1732 * Construct a keyword-URI from meta-data (take all entries
1733 * in the meta-data and construct one large keyword URI
1734 * that lists all keywords that can be found in the meta-data).
1736 * @param md metadata to use
1737 * @return NULL on error, otherwise a KSK URI
1739 struct GNUNET_FS_Uri *
1740 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md)
1742 struct GNUNET_FS_Uri *ret;
1744 char *full_name = NULL;
1747 int tok_keywords = 0;
1748 int paren_keywords = 0;
1752 ret = GNUNET_new (struct GNUNET_FS_Uri);
1753 ret->type = GNUNET_FS_URI_KSK;
1754 ent = GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL);
1757 full_name = GNUNET_CONTAINER_meta_data_get_first_by_types (md,
1758 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, -1);
1759 if (NULL != full_name)
1761 filename = full_name;
1762 while (NULL != (ss = strstr (filename, DIR_SEPARATOR_STR)))
1764 tok_keywords = get_keywords_from_tokens (filename, NULL, 0);
1765 paren_keywords = get_keywords_from_parens (filename, NULL, 0);
1767 /* x3 because there might be a normalized variant of every keyword,
1768 plus theoretically one more for mime... */
1769 ret->data.ksk.keywords = GNUNET_malloc
1770 (sizeof (char *) * (ent + tok_keywords + paren_keywords) * 3);
1771 GNUNET_CONTAINER_meta_data_iterate (md, &gather_uri_data, ret);
1773 if (tok_keywords > 0)
1774 ret->data.ksk.keywordCount += get_keywords_from_tokens (filename,
1775 ret->data.ksk.keywords,
1776 ret->data.ksk.keywordCount);
1777 if (paren_keywords > 0)
1778 ret->data.ksk.keywordCount += get_keywords_from_parens (filename,
1779 ret->data.ksk.keywords,
1780 ret->data.ksk.keywordCount);
1782 GNUNET_free_non_null (full_name);
1788 * In URI-encoding, does the given character
1789 * need to be encoded using %-encoding?
1792 needs_percent (char c)
1795 ((isalnum ((unsigned char) c)) || (c == '-') || (c == '_') ||
1796 (c == '.') || (c == '~')));
1801 * Convert a KSK URI to a string.
1803 * @param uri the URI to convert
1804 * @return NULL on error (i.e. keywordCount == 0)
1807 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1810 unsigned int keywordCount;
1817 const char *keyword;
1819 if (uri->type != GNUNET_FS_URI_KSK)
1821 keywords = uri->data.ksk.keywords;
1822 keywordCount = uri->data.ksk.keywordCount;
1823 n = keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1824 strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1825 for (i = 0; i < keywordCount; i++)
1827 keyword = keywords[i];
1828 slen = strlen (keyword);
1830 for (j = 0; j < slen; j++)
1832 if ((j == 0) && (keyword[j] == ' '))
1835 continue; /* skip leading space */
1837 if (needs_percent (keyword[j]))
1838 n += 2; /* will use %-encoding */
1841 ret = GNUNET_malloc (n);
1842 strcpy (ret, GNUNET_FS_URI_PREFIX);
1843 strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1844 wpos = strlen (ret);
1845 for (i = 0; i < keywordCount; i++)
1847 keyword = keywords[i];
1848 slen = strlen (keyword);
1849 for (j = 0; j < slen; j++)
1851 if ((j == 0) && (keyword[j] == ' '))
1852 continue; /* skip leading space */
1853 if (needs_percent (keyword[j]))
1855 sprintf (&ret[wpos], "%%%02X", (unsigned char) keyword[j]);
1860 ret[wpos++] = keyword[j];
1863 if (i != keywordCount - 1)
1871 * Convert SKS URI to a string.
1873 * @param uri sks uri to convert
1874 * @return NULL on error
1877 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1882 if (GNUNET_FS_URI_SKS != uri->type)
1884 ret = GNUNET_STRINGS_data_to_string (&uri->data.sks.ns,
1885 sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
1888 GNUNET_assert (NULL != ret);
1890 GNUNET_asprintf (&ret, "%s%s%s/%s", GNUNET_FS_URI_PREFIX,
1891 GNUNET_FS_URI_SKS_INFIX, buf,
1892 uri->data.sks.identifier);
1898 * Convert a CHK URI to a string.
1900 * @param uri chk uri to convert
1901 * @return NULL on error
1904 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1906 const struct FileIdentifier *fi;
1908 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1909 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1911 if (uri->type != GNUNET_FS_URI_CHK)
1913 fi = &uri->data.chk;
1914 GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1915 GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1917 GNUNET_asprintf (&ret, "%s%s%s.%s.%llu", GNUNET_FS_URI_PREFIX,
1918 GNUNET_FS_URI_CHK_INFIX, (const char *) &keyhash,
1919 (const char *) &queryhash, GNUNET_ntohll (fi->file_length));
1925 * Convert a LOC URI to a string.
1927 * @param uri loc uri to convert
1928 * @return NULL on error
1931 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
1934 struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1935 struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1937 char peer_sig[SIGNATURE_ASCII_LENGTH + 1];
1939 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
1940 GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
1942 GNUNET_CRYPTO_eddsa_public_key_to_string (&uri->data.loc.peer.public_key);
1943 GNUNET_assert (NULL !=
1944 GNUNET_STRINGS_data_to_string (&uri->data.loc.contentSignature,
1945 sizeof (struct GNUNET_CRYPTO_EddsaSignature),
1947 sizeof (peer_sig)));
1948 GNUNET_asprintf (&ret,
1949 "%s%s%s.%s.%llu.%s.%s.%llu", GNUNET_FS_URI_PREFIX,
1950 GNUNET_FS_URI_LOC_INFIX, (const char *) &keyhash,
1951 (const char *) &queryhash,
1952 (unsigned long long) GNUNET_ntohll (uri->data.loc.
1956 (unsigned long long) uri->data.loc.expirationTime.abs_value_us / 1000000LL);
1957 GNUNET_free (peer_id);
1963 * Convert a URI to a UTF-8 String.
1965 * @param uri uri to convert to a string
1966 * @return the UTF-8 string
1969 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
1978 case GNUNET_FS_URI_KSK:
1979 return uri_ksk_to_string (uri);
1980 case GNUNET_FS_URI_SKS:
1981 return uri_sks_to_string (uri);
1982 case GNUNET_FS_URI_CHK:
1983 return uri_chk_to_string (uri);
1984 case GNUNET_FS_URI_LOC:
1985 return uri_loc_to_string (uri);
1992 /* end of fs_uri.c */