diff --git a/common/convert.c b/common/convert.c index 40fb4eecf..54182e15b 100644 --- a/common/convert.c +++ b/common/convert.c @@ -1,266 +1,297 @@ /* convert.c - Hex conversion functions. * Copyright (C) 2006, 2008 Free Software Foundation, Inc. * * This file is part of GnuPG. * * This file is free software; you can redistribute it and/or modify * it under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * This file is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . */ #include #include #include #include #include "util.h" #define tohex(n) ((n) < 10 ? ((n) + '0') : (((n) - 10) + 'A')) /* Convert STRING consisting of hex characters into its binary representation and store that at BUFFER. BUFFER needs to be of LENGTH bytes. The function checks that the STRING will convert exactly to LENGTH bytes. The string is delimited by either end of string or a white space character. The function returns -1 on error or the length of the parsed string. */ int hex2bin (const char *string, void *buffer, size_t length) { int i; const char *s = string; for (i=0; i < length; ) { if (!hexdigitp (s) || !hexdigitp (s+1)) return -1; /* Invalid hex digits. */ ((unsigned char*)buffer)[i++] = xtoi_2 (s); s += 2; } if (*s && (!isascii (*s) || !isspace (*s)) ) return -1; /* Not followed by Nul or white space. */ if (i != length) return -1; /* Not of expected length. */ if (*s) s++; /* Skip the delimiter. */ return s - string; } /* Convert STRING consisting of hex characters into its binary representation and store that at BUFFER. BUFFER needs to be of LENGTH bytes. The function check that the STRING will convert exactly to LENGTH bytes. Colons between the hex digits are allowed, if one colon has been given a colon is expected very 2 characters. The string is delimited by either end of string or a white space character. The function returns -1 on error or the length of the parsed string. */ int hexcolon2bin (const char *string, void *buffer, size_t length) { int i; const char *s = string; int need_colon = 0; for (i=0; i < length; ) { if (i==1 && *s == ':') /* Skip colons between hex digits. */ { need_colon = 1; s++; } else if (need_colon && *s == ':') s++; else if (need_colon) return -1; /* Colon expected. */ if (!hexdigitp (s) || !hexdigitp (s+1)) return -1; /* Invalid hex digits. */ ((unsigned char*)buffer)[i++] = xtoi_2 (s); s += 2; } if (*s == ':') return -1; /* Trailing colons are not allowed. */ if (*s && (!isascii (*s) || !isspace (*s)) ) return -1; /* Not followed by Nul or white space. */ if (i != length) return -1; /* Not of expected length. */ if (*s) s++; /* Skip the delimiter. */ return s - string; } static char * do_bin2hex (const void *buffer, size_t length, char *stringbuf, int with_colon) { const unsigned char *s; char *p; if (!stringbuf) { /* Not really correct for with_colon but we don't care about the one wasted byte. */ size_t n = with_colon? 3:2; size_t nbytes = n * length + 1; if (length && (nbytes-1) / n != length) { gpg_err_set_errno (ENOMEM); return NULL; } stringbuf = xtrymalloc (nbytes); if (!stringbuf) return NULL; } for (s = buffer, p = stringbuf; length; length--, s++) { if (with_colon && s != buffer) *p++ = ':'; *p++ = tohex ((*s>>4)&15); *p++ = tohex (*s&15); } *p = 0; return stringbuf; } /* Convert LENGTH bytes of data in BUFFER into hex encoding and store that at the provided STRINGBUF. STRINGBUF must be allocated of at least (2*LENGTH+1) bytes or be NULL so that the function mallocs an appropriate buffer. Returns STRINGBUF or NULL on error (which may only occur if STRINGBUF has been NULL and the internal malloc failed). */ char * bin2hex (const void *buffer, size_t length, char *stringbuf) { return do_bin2hex (buffer, length, stringbuf, 0); } /* Convert LENGTH bytes of data in BUFFER into hex encoding and store that at the provided STRINGBUF. STRINGBUF must be allocated of at least (3*LENGTH+1) bytes or be NULL so that the function mallocs an appropriate buffer. Returns STRINGBUF or NULL on error (which may only occur if STRINGBUF has been NULL and the internal malloc failed). */ char * bin2hexcolon (const void *buffer, size_t length, char *stringbuf) { return do_bin2hex (buffer, length, stringbuf, 1); } /* Convert HEXSTRING consisting of hex characters into string and store that at BUFFER. HEXSTRING is either delimited by end of string or a white space character. The function makes sure that the resulting string in BUFFER is terminated by a Nul byte. Note that the returned string may include embedded Nul bytes; the extra Nul byte at the end is used to make sure that the result can always be used as a C-string. BUFSIZE is the available length of BUFFER; if the converted result plus a possible required extra Nul character does not fit into this buffer, the function returns NULL and won't change the existing content of BUFFER. In-place conversion is possible as long as BUFFER points to HEXSTRING. If BUFFER is NULL and BUFSIZE is 0 the function scans HEXSTRING but does not store anything. This may be used to find the end of HEXSTRING. On success the function returns a pointer to the next character - after HEXSTRING (which is either end-of-string or a the next white + after HEXSTRING (which is either end-of-string or the next white space). If BUFLEN is not NULL the number of valid vytes in BUFFER is stored there (an extra Nul byte is not counted); this will even be done if BUFFER has been passed as NULL. */ const char * hex2str (const char *hexstring, char *buffer, size_t bufsize, size_t *buflen) { const char *s = hexstring; int idx, count; int need_nul = 0; if (buflen) *buflen = 0; for (s=hexstring, count=0; hexdigitp (s) && hexdigitp (s+1); s += 2, count++) ; if (*s && (!isascii (*s) || !isspace (*s)) ) { gpg_err_set_errno (EINVAL); return NULL; /* Not followed by Nul or white space. */ } /* We need to append a nul character. However we don't want that if the hexstring already ends with "00". */ need_nul = ((s == hexstring) || !(s[-2] == '0' && s[-1] == '0')); if (need_nul) count++; if (buffer) { if (count > bufsize) { gpg_err_set_errno (EINVAL); return NULL; /* Too long. */ } for (s=hexstring, idx=0; hexdigitp (s) && hexdigitp (s+1); s += 2) ((unsigned char*)buffer)[idx++] = xtoi_2 (s); if (need_nul) buffer[idx] = 0; } if (buflen) *buflen = count - need_nul; return s; } /* Same as hex2str but this function allocated a new string. Returns NULL on error. If R_COUNT is not NULL, the number of scanned bytes will be stored there. ERRNO is set on error. */ char * hex2str_alloc (const char *hexstring, size_t *r_count) { const char *tail; size_t nbytes; char *result; tail = hex2str (hexstring, NULL, 0, &nbytes); if (!tail) { if (r_count) *r_count = 0; return NULL; } if (r_count) *r_count = tail - hexstring; result = xtrymalloc (nbytes+1); if (!result) return NULL; if (!hex2str (hexstring, result, nbytes+1, NULL)) BUG (); return result; } + + + +/* Take the hex-encoded string HEXSTR and put it into the provided + * BUFFER in binary format. The length of the buffer is BUFEFR_SIZE + * and the expected size of the hex-string (sans leading and trailing + * spaces) is 2*BUFFER_SIZE. Returns the actual scanned length of + * HEXSTR including any leading and trailing spaces on success or 0 on + * error. The HEXSTR must be terminated by a Space or a Nul and may + * have leading spaces. */ +unsigned int +hex2fixedbuf (const char *hexstr, void *buffer_arg, size_t buffer_size) +{ + unsigned char *buffer = buffer_arg; + const char *s; + unsigned int leading_spaces, n; + + for (leading_spaces = 0; *hexstr && *hexstr == ' '; hexstr++) + leading_spaces++; + + for (s=hexstr, n=0; hexdigitp (s); s++, n++) + ; + if ((*s && *s != ' ') || !(n == 2*buffer_size)) + return 0; /* Invalid or wrong length. */ + for (s=hexstr, n=0; *s && n < buffer_size; s += 2, n++) + buffer[n] = xtoi_2 (s); + while (*s && *s == ' ') + s++; + + return leading_spaces + (s - hexstr); +} diff --git a/common/t-convert.c b/common/t-convert.c index e25de9012..c7ba8f6f7 100644 --- a/common/t-convert.c +++ b/common/t-convert.c @@ -1,463 +1,501 @@ /* t-convert.c - Module test for convert.c * Copyright (C) 2006, 2008 Free Software Foundation, Inc. * * This file is part of GnuPG. * * GnuPG is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * GnuPG is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, see . */ #include #include #include #include #include "util.h" #define pass() do { ; } while(0) #define fail(a) do { fprintf (stderr, "%s:%d: test %d failed\n",\ __FILE__,__LINE__, (a)); \ /*exit (1)*/; \ } while(0) static void test_hex2bin (void) { static const char *valid[] = { "00112233445566778899aabbccddeeff11223344", "00112233445566778899AABBCCDDEEFF11223344", "00112233445566778899AABBCCDDEEFF11223344 blah", "00112233445566778899AABBCCDDEEFF11223344\tblah", "00112233445566778899AABBCCDDEEFF11223344\nblah", NULL }; static const char *invalid[] = { "00112233445566778899aabbccddeeff1122334", "00112233445566778899AABBCCDDEEFF1122334", "00112233445566778899AABBCCDDEEFG11223344", "00 112233445566778899aabbccddeeff11223344", "00:112233445566778899aabbccddeeff11223344", ":00112233445566778899aabbccddeeff11223344", "0:0112233445566778899aabbccddeeff11223344", "00112233445566778899aabbccddeeff11223344:", "00112233445566778899aabbccddeeff112233445", "00112233445566778899aabbccddeeff1122334455", "00112233445566778899aabbccddeeff11223344blah", NULL }; static const char *valid2[] = { "00", "00 x", NULL }; static const char *invalid2[] = { "", "0", "00:", "00x", " 00", NULL }; unsigned char buffer[20]; int len; int i; for (i=0; valid[i]; i++) { len = hex2bin (valid[i], buffer, sizeof buffer); if (len < 0) fail (i); if (memcmp (buffer, ("\x00\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa" "\xbb\xcc\xdd\xee\xff\x11\x22\x33\x44"), 20)) fail (i); } if (hex2bin (valid[0], buffer, sizeof buffer) != 40) fail (0); if (hex2bin (valid[2], buffer, sizeof buffer) != 41) fail (0); for (i=0; invalid[i]; i++) { len = hex2bin (invalid[i], buffer, sizeof buffer); if (!(len < 0)) fail (i); } for (i=0; valid2[i]; i++) { len = hex2bin (valid2[i], buffer, 1); if (len < 0) fail (i); if (memcmp (buffer, "\x00", 1)) fail (i); } if (hex2bin (valid2[0], buffer, 1) != 2) fail (0); if (hex2bin (valid2[1], buffer, 1) != 3) fail (0); for (i=0; invalid2[i]; i++) { len = hex2bin (invalid2[i], buffer, 1); if (!(len < 0)) fail (i); } } static void test_hexcolon2bin (void) { static const char *valid[] = { "00112233445566778899aabbccddeeff11223344", "00112233445566778899AABBCCDDEEFF11223344", "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "00112233445566778899AABBCCDDEEFF11223344 blah", "00112233445566778899AABBCCDDEEFF11223344\tblah", "00112233445566778899AABBCCDDEEFF11223344\nblah", NULL }; static const char *invalid[] = { "00112233445566778899aabbccddeeff1122334", "00112233445566778899AABBCCDDEEFF1122334", "00112233445566778899AABBCCDDEEFG11223344", ":00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44:", "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:3344", "00:1122:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "0011:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "00 11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "00:11 22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:11:22:33:44", "00112233445566778899aabbccddeeff112233445", "00112233445566778899aabbccddeeff1122334455", "00112233445566778899aabbccddeeff11223344blah", NULL }; static const char *valid2[] = { "00", "00 x", NULL }; static const char *invalid2[] = { "", "0", "00:", ":00", "0:0", "00x", " 00", NULL }; unsigned char buffer[20]; int len; int i; for (i=0; valid[i]; i++) { len = hexcolon2bin (valid[i], buffer, sizeof buffer); if (len < 0) fail (i); if (memcmp (buffer, ("\x00\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa" "\xbb\xcc\xdd\xee\xff\x11\x22\x33\x44"), 20)) fail (i); } if (hexcolon2bin (valid[0], buffer, sizeof buffer) != 40) fail (0); if (hexcolon2bin (valid[3], buffer, sizeof buffer) != 41) fail (0); for (i=0; invalid[i]; i++) { len = hexcolon2bin (invalid[i], buffer, sizeof buffer); if (!(len < 0)) fail (i); } for (i=0; valid2[i]; i++) { len = hexcolon2bin (valid2[i], buffer, 1); if (len < 0) fail (i); if (memcmp (buffer, "\x00", 1)) fail (i); } if (hexcolon2bin (valid2[0], buffer, 1) != 2) fail (0); if (hexcolon2bin (valid2[1], buffer, 1) != 3) fail (0); for (i=0; invalid2[i]; i++) { len = hexcolon2bin (invalid2[i], buffer, 1); if (!(len < 0)) fail (i); } } static void test_bin2hex (void) { char stuff[20+1] = ("\x00\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa" "\xbb\xcc\xdd\xee\xff\x01\x10\x02\xa3"); char hexstuff[] = "00112233445566778899AABBCCDDEEFF011002A3"; char buffer[2*20+1]; char *p; p = bin2hex (stuff, 20, buffer); if (!p) fail (0); if (p != buffer) fail (0); if (strcmp (buffer, hexstuff)) fail (0); p = bin2hex (stuff, 20, NULL); if (!p) fail (0); else if (strcmp (p, hexstuff)) fail (0); xfree (p); p = bin2hex (stuff, (size_t)(-1), NULL); if (p) fail (0); else if (errno != ENOMEM) fail (1); } static void test_bin2hexcolon (void) { char stuff[20+1] = ("\x00\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa" "\xbb\xcc\xdd\xee\xff\x01\x10\x02\xa3"); char hexstuff[] = ("00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF" ":01:10:02:A3"); char buffer[3*20+1]; char *p; p = bin2hexcolon (stuff, 20, buffer); if (!p) fail (0); if (p != buffer) fail (0); if (strcmp (buffer, hexstuff)) fail (0); p = bin2hexcolon (stuff, 20, NULL); if (!p) fail (0); else if (strcmp (p, hexstuff)) fail (0); xfree (p); p = bin2hexcolon (stuff, (size_t)(-1), NULL); if (p) fail (0); else if (errno != ENOMEM) fail (1); } static void test_hex2str (void) { static struct { const char *hex; const char *str; int len; /* Length of STR. This may included embedded nuls. */ int off; int no_alloc_test; } tests[] = { /* Simple tests. */ { "112233445566778899aabbccddeeff1122", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22", 17, 34 }, { "112233445566778899aabbccddeeff1122 blah", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22", 17, 34 }, { "112233445566778899aabbccddeeff1122\tblah", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22", 17, 34 }, { "112233445566778899aabbccddeeff1122\nblah", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22", 17, 34 }, /* Valid tests yielding an empty string. */ { "00", "", 1, 2 }, { "00 x", "", 1, 2 }, { "", "", 0, 0 }, { " ", "", 0, 0 }, /* Test trailing Nul feature. */ { "112233445566778899aabbccddeeff1100", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x00", 17, 34 }, { "112233445566778899aabbccddeeff1100 ", "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x00", 17, 34 }, /* Test buffer size. (buffer is of length 20) */ { "6162636465666768696A6b6c6D6e6f70717273", "abcdefghijklmnopqrs", 19, 38 }, { "6162636465666768696A6b6c6D6e6f7071727300", "abcdefghijklmnopqrs", 20, 40 }, { "6162636465666768696A6b6c6D6e6f7071727374", NULL, 0, 0, 1 }, { "6162636465666768696A6b6c6D6e6f707172737400", NULL, 0, 0, 1 }, { "6162636465666768696A6b6c6D6e6f707172737475", NULL, 0, 0, 1 }, /* Invalid tests. */ { "112233445566778899aabbccddeeff1122334", NULL, 0, 0 }, { "112233445566778899AABBCCDDEEFF1122334", NULL, 0, 0 }, { "112233445566778899AABBCCDDEEFG11223344", NULL, 0, 0 }, { "0:0112233445566778899aabbccddeeff11223344", NULL, 0, 0 }, { "112233445566778899aabbccddeeff11223344:", NULL, 0, 0 }, { "112233445566778899aabbccddeeff112233445", NULL, 0, 0 }, { "112233445566778899aabbccddeeff1122334455", NULL, 0, 0, 1 }, { "112233445566778899aabbccddeeff11223344blah", NULL, 0, 0 }, { "0", NULL, 0, 0 }, { "00:", NULL, 0, 0 }, { "00x", NULL, 0, 0 }, { NULL, NULL, 0, 0 } }; int idx; char buffer[20]; const char *tail; size_t count; char *result; for (idx=0; tests[idx].hex; idx++) { tail = hex2str (tests[idx].hex, buffer, sizeof buffer, &count); if (tests[idx].str) { /* Good case test. */ if (!tail) fail (idx); else if (strcmp (tests[idx].str, buffer)) fail (idx); else if (tail - tests[idx].hex != tests[idx].off) fail (idx); else if (tests[idx].len != count) fail (idx); } else { /* Bad case test. */ if (tail) fail (idx); } } /* Same tests again using in-place conversion. */ for (idx=0; tests[idx].hex; idx++) { char tmpbuf[100]; assert (strlen (tests[idx].hex)+1 < sizeof tmpbuf); strcpy (tmpbuf, tests[idx].hex); /* Note: we still need to use 20 as buffer length because our tests assume that. */ tail = hex2str (tmpbuf, tmpbuf, 20, &count); if (tests[idx].str) { /* Good case test. */ if (!tail) fail (idx); else if (strcmp (tests[idx].str, tmpbuf)) fail (idx); else if (tail - tmpbuf != tests[idx].off) fail (idx); else if (tests[idx].len != count) fail (idx); } else { /* Bad case test. */ if (tail) fail (idx); if (strcmp (tmpbuf, tests[idx].hex)) fail (idx); /* Buffer was modified. */ } } /* Test the allocation variant. */ for (idx=0; tests[idx].hex; idx++) { if (tests[idx].no_alloc_test) continue; result = hex2str_alloc (tests[idx].hex, &count); if (tests[idx].str) { /* Good case test. */ if (!result) fail (idx); else if (strcmp (tests[idx].str, result)) fail (idx); else if (count != tests[idx].off) fail (idx); } else { /* Bad case test. */ if (result) fail (idx); } xfree (result); } } +static void +test_hex2fixedbuf (void) +{ + static struct { + const char *hex; + unsigned bufsize; + unsigned int resultlen; + const char *result; + } tests[] = { + /* Simple tests. */ + { "112233445566778899aabbccddeeff1122", 17, 34, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22"}, + { " 112233445566778899aabbccddeeff1122", 17, 35, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22"}, + { "112233445566778899aabbccddeeff1122 ", 17, 35, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22"}, + { " 112233445566778899aabbccddeeff1122 ", 17, 37, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11\x22"}, + { " 112233445566778899aabbccddeeff11 ", 16, 35, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11"}, + { " 112233445566778899aabbccddeeff11", 16, 34, + "\x11\x22\x33\x44\x55\x66\x77\x88\x99\xaa\xbb\xcc\xdd\xee\xff\x11"} + }; + char buffer[100]; /* Large enough for all tests. */ + int idx; + unsigned int n; + + for (idx=0; idx < DIM (tests); idx++) + { + n = hex2fixedbuf (tests[idx].hex, buffer, tests[idx].bufsize); + if (n != tests[idx].resultlen) + fail (idx); + else if (memcmp (buffer, tests[idx].result, tests[idx].bufsize)) + fail (idx); + } + +} int main (int argc, char **argv) { (void)argc; (void)argv; test_hex2bin (); test_hexcolon2bin (); test_bin2hex (); test_bin2hexcolon (); test_hex2str (); + test_hex2fixedbuf (); return 0; } diff --git a/common/util.h b/common/util.h index 8f8a06a41..6c878083a 100644 --- a/common/util.h +++ b/common/util.h @@ -1,393 +1,394 @@ /* util.h - Utility functions for GnuPG * Copyright (C) 2001, 2002, 2003, 2004, 2009 Free Software Foundation, Inc. * * This file is part of GnuPG. * * GnuPG is free software; you can redistribute and/or modify this * part of GnuPG under the terms of either * * - the GNU Lesser General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at * your option) any later version. * * or * * - the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at * your option) any later version. * * or both in parallel, as here. * * GnuPG is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copies of the GNU General Public License * and the GNU Lesser General Public License along with this program; * if not, see . */ #ifndef GNUPG_COMMON_UTIL_H #define GNUPG_COMMON_UTIL_H #include /* We need this for the memory function protos. */ #include /* We need errno. */ #include /* We need gpg_error_t and estream. */ /* These error codes are used but not defined in the required * libgpg-error version. Define them here. * Example: (#if GPG_ERROR_VERSION_NUMBER < 0x011500 // 1.21) */ #if GPG_ERROR_VERSION_NUMBER < 0x012400 /* 1.36 */ #define GPG_ERR_NO_AUTH 314 #define GPG_ERR_BAD_AUTH 315 #endif /*GPG_ERROR_VERSION_NUMBER*/ #if GPG_ERROR_VERSION_NUMBER < 0x012500 /* 1.37 */ #define GPG_ERR_NO_KEYBOXD 316 #define GPG_ERR_KEYBOXD 317 #endif /*GPG_ERROR_VERSION_NUMBER*/ /* Hash function used with libksba. */ #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write) /* The length of the keygrip. This is a SHA-1 hash of the key * parameters as generated by gcry_pk_get_keygrip. */ #define KEYGRIP_LEN 20 /* Get all the stuff from jnlib. */ #include "../common/logging.h" #include "../common/argparse.h" #include "../common/stringhelp.h" #include "../common/mischelp.h" #include "../common/strlist.h" #include "../common/dotlock.h" #include "../common/utf8conv.h" #include "../common/dynload.h" #include "../common/fwddecl.h" #include "../common/utilproto.h" #include "gettime.h" /* Redefine asprintf by our estream version which uses our own memory allocator.. */ #define asprintf gpgrt_asprintf #define vasprintf gpgrt_vasprintf /* Due to a bug in mingw32's snprintf related to the 'l' modifier and for increased portability we use our snprintf on all systems. */ #undef snprintf #define snprintf gpgrt_snprintf /* Replacements for macros not available with libgpg-error < 1.20. */ /* We need this type even if we are not using libreadline and or we did not include libreadline in the current file. */ #ifndef GNUPG_LIBREADLINE_H_INCLUDED typedef char **rl_completion_func_t (const char *, int, int); #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/ /* Handy malloc macros - please use only them. */ #define xtrymalloc(a) gcry_malloc ((a)) #define xtrymalloc_secure(a) gcry_malloc_secure ((a)) #define xtrycalloc(a,b) gcry_calloc ((a),(b)) #define xtrycalloc_secure(a,b) gcry_calloc_secure ((a),(b)) #define xtryrealloc(a,b) gcry_realloc ((a),(b)) #define xtrystrdup(a) gcry_strdup ((a)) #define xfree(a) gcry_free ((a)) #define xfree_fnc gcry_free #define xmalloc(a) gcry_xmalloc ((a)) #define xmalloc_secure(a) gcry_xmalloc_secure ((a)) #define xcalloc(a,b) gcry_xcalloc ((a),(b)) #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b)) #define xrealloc(a,b) gcry_xrealloc ((a),(b)) #define xstrdup(a) gcry_xstrdup ((a)) /* For compatibility with gpg 1.4 we also define these: */ #define xmalloc_clear(a) gcry_xcalloc (1, (a)) #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a)) /* The default error source of the application. This is different from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the source file and thus is usable in code shared by applications. Defined by init.c. */ extern gpg_err_source_t default_errsource; /* Convenience function to return a gpg-error code for memory allocation failures. This function makes sure that an error will be returned even if accidentally ERRNO is not set. */ static inline gpg_error_t out_of_core (void) { return gpg_error_from_syserror (); } /*-- yesno.c --*/ int answer_is_yes (const char *s); int answer_is_yes_no_default (const char *s, int def_answer); int answer_is_yes_no_quit (const char *s); int answer_is_okay_cancel (const char *s, int def_answer); /*-- xreadline.c --*/ ssize_t read_line (FILE *fp, char **addr_of_buffer, size_t *length_of_buffer, size_t *max_length); /*-- b64enc.c and b64dec.c --*/ struct b64state { unsigned int flags; int idx; int quad_count; FILE *fp; estream_t stream; char *title; unsigned char radbuf[4]; u32 crc; int stop_seen:1; int invalid_encoding:1; gpg_error_t lasterr; }; gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title); gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp, const char *title); gpg_error_t b64enc_write (struct b64state *state, const void *buffer, size_t nbytes); gpg_error_t b64enc_finish (struct b64state *state); gpg_error_t b64dec_start (struct b64state *state, const char *title); gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length, size_t *r_nbytes); gpg_error_t b64dec_finish (struct b64state *state); /*-- sexputil.c */ char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen); void log_printcanon (const char *text, const unsigned char *sexp, size_t sexplen); void log_printsexp (const char *text, gcry_sexp_t sexp); gpg_error_t make_canon_sexp (gcry_sexp_t sexp, unsigned char **r_buffer, size_t *r_buflen); gpg_error_t make_canon_sexp_pad (gcry_sexp_t sexp, int secure, unsigned char **r_buffer, size_t *r_buflen); gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen, unsigned char *grip); int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b); unsigned char *make_simple_sexp_from_hexstr (const char *line, size_t *nscanned); int hash_algo_from_sigval (const unsigned char *sigval); unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen, const void *e, size_t elen, size_t *r_len); gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata, size_t keydatalen, unsigned char const **r_n, size_t *r_nlen, unsigned char const **r_e, size_t *r_elen); int get_pk_algo_from_key (gcry_sexp_t key); int get_pk_algo_from_canon_sexp (const unsigned char *keydata, size_t keydatalen); char *pubkey_algo_string (gcry_sexp_t s_pkey, enum gcry_pk_algos *r_algoid); /*-- convert.c --*/ int hex2bin (const char *string, void *buffer, size_t length); int hexcolon2bin (const char *string, void *buffer, size_t length); char *bin2hex (const void *buffer, size_t length, char *stringbuf); char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf); const char *hex2str (const char *hexstring, char *buffer, size_t bufsize, size_t *buflen); char *hex2str_alloc (const char *hexstring, size_t *r_count); +unsigned int hex2fixedbuf (const char *hexstr, void *buffer, size_t bufsize); /*-- percent.c --*/ char *percent_plus_escape (const char *string); char *percent_data_escape (int plus, const char *prefix, const void *data, size_t datalen); char *percent_plus_unescape (const char *string, int nulrepl); char *percent_unescape (const char *string, int nulrepl); size_t percent_plus_unescape_inplace (char *string, int nulrepl); size_t percent_unescape_inplace (char *string, int nulrepl); /*-- openpgp-oid.c --*/ gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi); char *openpgp_oidbuf_to_str (const unsigned char *buf, size_t len); char *openpgp_oid_to_str (gcry_mpi_t a); int openpgp_oidbuf_is_ed25519 (const void *buf, size_t len); int openpgp_oid_is_ed25519 (gcry_mpi_t a); int openpgp_oidbuf_is_cv25519 (const void *buf, size_t len); int openpgp_oid_is_cv25519 (gcry_mpi_t a); const char *openpgp_curve_to_oid (const char *name, unsigned int *r_nbits); const char *openpgp_oid_to_curve (const char *oid, int canon); const char *openpgp_enum_curves (int *idxp); const char *openpgp_is_curve_supported (const char *name, int *r_algo, unsigned int *r_nbits); /*-- homedir.c --*/ const char *standard_homedir (void); const char *default_homedir (void); void gnupg_set_homedir (const char *newdir); const char *gnupg_homedir (void); int gnupg_default_homedir_p (void); const char *gnupg_daemon_rootdir (void); const char *gnupg_socketdir (void); const char *gnupg_sysconfdir (void); const char *gnupg_bindir (void); const char *gnupg_libexecdir (void); const char *gnupg_libdir (void); const char *gnupg_datadir (void); const char *gnupg_localedir (void); const char *gnupg_cachedir (void); const char *gpg_agent_socket_name (void); const char *dirmngr_socket_name (void); char *_gnupg_socketdir_internal (int skip_checks, unsigned *r_info); /* All module names. We also include gpg and gpgsm for the sake for gpgconf. */ #define GNUPG_MODULE_NAME_AGENT 1 #define GNUPG_MODULE_NAME_PINENTRY 2 #define GNUPG_MODULE_NAME_SCDAEMON 3 #define GNUPG_MODULE_NAME_DIRMNGR 4 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6 #define GNUPG_MODULE_NAME_GPGSM 7 #define GNUPG_MODULE_NAME_GPG 8 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9 #define GNUPG_MODULE_NAME_GPGCONF 10 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP 11 #define GNUPG_MODULE_NAME_GPGV 12 #define GNUPG_MODULE_NAME_KEYBOXD 13 const char *gnupg_module_name (int which); void gnupg_module_name_flush_some (void); void gnupg_set_builddir (const char *newdir); /* A list of constants to identify protocols. This is used by tools * which need to distinguish between the different protocols * implemented by GnuPG. May be used as bit flags. */ #define GNUPG_PROTOCOL_OPENPGP 1 /* The one and only (gpg). */ #define GNUPG_PROTOCOL_CMS 2 /* The core of S/MIME (gpgsm) */ #define GNUPG_PROTOCOL_SSH_AGENT 4 /* Out ssh-agent implementation */ /*-- gpgrlhelp.c --*/ void gnupg_rl_initialize (void); /*-- helpfile.c --*/ char *gnupg_get_help_string (const char *key, int only_current_locale); /*-- localename.c --*/ const char *gnupg_messages_locale_name (void); /*-- miscellaneous.c --*/ /* This function is called at startup to tell libgcrypt to use our own logging subsystem. */ void setup_libgcrypt_logging (void); /* Print an out of core message and die. */ void xoutofcore (void); /* Same as estream_asprintf but die on memory failure. */ char *xasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2); /* This is now an alias to estream_asprintf. */ char *xtryasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2); /* Replacement for gcry_cipher_algo_name. */ const char *gnupg_cipher_algo_name (int algo); void obsolete_option (const char *configname, unsigned int configlineno, const char *name); const char *print_fname_stdout (const char *s); const char *print_fname_stdin (const char *s); void print_utf8_buffer3 (estream_t fp, const void *p, size_t n, const char *delim); void print_utf8_buffer2 (estream_t fp, const void *p, size_t n, int delim); void print_utf8_buffer (estream_t fp, const void *p, size_t n); void print_utf8_string (estream_t stream, const char *p); void print_hexstring (FILE *fp, const void *buffer, size_t length, int reserved); char *try_make_printable_string (const void *p, size_t n, int delim); char *make_printable_string (const void *p, size_t n, int delim); char *decode_c_string (const char *src); int is_file_compressed (const char *s, int *ret_rc); int match_multistr (const char *multistr,const char *match); int gnupg_compare_version (const char *a, const char *b); struct debug_flags_s { unsigned int flag; const char *name; }; int parse_debug_flag (const char *string, unsigned int *debugvar, const struct debug_flags_s *flags); /*-- Simple replacement functions. */ /* We use the gnupg_ttyname macro to be safe not to run into conflicts which an extisting but broken ttyname. */ #if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME) # define gnupg_ttyname(n) _gnupg_ttyname ((n)) /* Systems without ttyname (W32) will merely return NULL. */ static inline char * _gnupg_ttyname (int fd) { (void)fd; return NULL; } #else /*HAVE_TTYNAME*/ # define gnupg_ttyname(n) ttyname ((n)) #endif /*HAVE_TTYNAME */ #ifdef HAVE_W32CE_SYSTEM #define getpid() GetCurrentProcessId () char *_gnupg_getenv (const char *name); /* See sysutils.c */ #define getenv(a) _gnupg_getenv ((a)) char *_gnupg_setenv (const char *name); /* See sysutils.c */ #define setenv(a,b,c) _gnupg_setenv ((a),(b),(c)) int _gnupg_isatty (int fd); #define gnupg_isatty(a) _gnupg_isatty ((a)) #else #define gnupg_isatty(a) isatty ((a)) #endif /*-- Macros to replace ctype ones to avoid locale problems. --*/ #define spacep(p) (*(p) == ' ' || *(p) == '\t') #define digitp(p) (*(p) >= '0' && *(p) <= '9') #define alphap(p) ((*(p) >= 'A' && *(p) <= 'Z') \ || (*(p) >= 'a' && *(p) <= 'z')) #define alnump(p) (alphap (p) || digitp (p)) #define hexdigitp(a) (digitp (a) \ || (*(a) >= 'A' && *(a) <= 'F') \ || (*(a) >= 'a' && *(a) <= 'f')) /* Note this isn't identical to a C locale isspace() without \f and \v, but works for the purposes used here. */ #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t') /* The atoi macros assume that the buffer has only valid digits. */ #define atoi_1(p) (*(p) - '0' ) #define atoi_2(p) ((atoi_1(p) * 10) + atoi_1((p)+1)) #define atoi_4(p) ((atoi_2(p) * 100) + atoi_2((p)+2)) #define xtoi_1(p) (*(p) <= '9'? (*(p)- '0'): \ *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10)) #define xtoi_2(p) ((xtoi_1(p) * 16) + xtoi_1((p)+1)) #define xtoi_4(p) ((xtoi_2(p) * 256) + xtoi_2((p)+2)) #endif /*GNUPG_COMMON_UTIL_H*/