test/punycode_test.c

   1 /*
   2  * Copyright 2022 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/crypto.h>
  11 #include <string.h>
  12
  13 #include "crypto/punycode.h"
  14 #include "internal/nelem.h"
  15 #include "internal/packet.h"
  16 #include "testutil.h"
  17
  18
  19 static const struct puny_test {
  20     unsigned int raw[50];
  21     const char *encoded;
  22 } puny_cases[] = {
  23     /* Test cases from RFC 3492 */
  24     {   /* Arabic (Egyptian) */
  25         { 0x0644, 0x064A, 0x0647, 0x0645, 0x0627, 0x0628, 0x062A, 0x0643, 0x0644,
  26           0x0645, 0x0648, 0x0634, 0x0639, 0x0631, 0x0628, 0x064A, 0x061F
  27         },
  28         "egbpdaj6bu4bxfgehfvwxn"
  29     },
  30     {   /* Chinese (simplified) */
  31         { 0x4ED6, 0x4EEC, 0x4E3A, 0x4EC0, 0x4E48, 0x4E0D, 0x8BF4, 0x4E2D, 0x6587
  32         },
  33         "ihqwcrb4cv8a8dqg056pqjye"
  34     },
  35     {   /* Chinese (traditional) */
  36         { 0x4ED6, 0x5011, 0x7232, 0x4EC0, 0x9EBD, 0x4E0D, 0x8AAA, 0x4E2D, 0x6587
  37         },
  38         "ihqwctvzc91f659drss3x8bo0yb"
  39     },
  40     {    /* Czech: Pro<ccaron>prost<ecaron>nemluv<iacute><ccaron>esky */
  41         { 0x0050, 0x0072, 0x006F, 0x010D, 0x0070, 0x0072, 0x006F, 0x0073, 0x0074,
  42           0x011B, 0x006E, 0x0065, 0x006D, 0x006C, 0x0075, 0x0076, 0x00ED, 0x010D,
  43           0x0065, 0x0073, 0x006B, 0x0079
  44        },
  45         "Proprostnemluvesky-uyb24dma41a"
  46     },
  47     {   /* Hebrew */
  48         { 0x05DC, 0x05DE, 0x05D4, 0x05D4, 0x05DD, 0x05E4, 0x05E9, 0x05D5, 0x05D8,
  49           0x05DC, 0x05D0, 0x05DE, 0x05D3, 0x05D1, 0x05E8, 0x05D9, 0x05DD, 0x05E2,
  50           0x05D1, 0x05E8, 0x05D9, 0x05EA
  51         },
  52         "4dbcagdahymbxekheh6e0a7fei0b"
  53     },
  54     {   /* Hindi (Devanagari) */
  55         { 0x092F, 0x0939, 0x0932, 0x094B, 0x0917, 0x0939, 0x093F, 0x0928, 0x094D,
  56           0x0926, 0x0940, 0x0915, 0x094D, 0x092F, 0x094B, 0x0902, 0x0928, 0x0939,
  57           0x0940, 0x0902, 0x092C, 0x094B, 0x0932, 0x0938, 0x0915, 0x0924, 0x0947,
  58           0x0939, 0x0948, 0x0902
  59         },
  60         "i1baa7eci9glrd9b2ae1bj0hfcgg6iyaf8o0a1dig0cd"
  61     },
  62     {   /* Japanese (kanji and hiragana) */
  63         { 0x306A, 0x305C, 0x307F, 0x3093, 0x306A, 0x65E5, 0x672C, 0x8A9E, 0x3092,
  64           0x8A71, 0x3057, 0x3066, 0x304F, 0x308C, 0x306A, 0x3044, 0x306E, 0x304B
  65         },
  66         "n8jok5ay5dzabd5bym9f0cm5685rrjetr6pdxa"
  67     },
  68     {   /* Korean (Hangul syllables) */
  69         { 0xC138, 0xACC4, 0xC758, 0xBAA8, 0xB4E0, 0xC0AC, 0xB78C, 0xB4E4, 0xC774,
  70           0xD55C, 0xAD6D, 0xC5B4, 0xB97C, 0xC774, 0xD574, 0xD55C, 0xB2E4, 0xBA74,
  71           0xC5BC, 0xB9C8, 0xB098, 0xC88B, 0xC744, 0xAE4C
  72         },
  73         "989aomsvi5e83db1d2a355cv1e0vak1dwrv93d5xbh15a0dt30a5jpsd879ccm6fea98c"
  74     },
  75     {   /* Russian (Cyrillic) */
  76         { 0x043F, 0x043E, 0x0447, 0x0435, 0x043C, 0x0443, 0x0436, 0x0435, 0x043E,
  77           0x043D, 0x0438, 0x043D, 0x0435, 0x0433, 0x043E, 0x0432, 0x043E, 0x0440,
  78           0x044F, 0x0442, 0x043F, 0x043E, 0x0440, 0x0443, 0x0441, 0x0441, 0x043A,
  79           0x0438
  80         },
  81         "b1abfaaepdrnnbgefbaDotcwatmq2g4l"
  82     },
  83     {   /* Spanish */
  84         { 0x0050, 0x006F, 0x0072, 0x0071, 0x0075, 0x00E9, 0x006E, 0x006F, 0x0070,
  85           0x0075, 0x0065, 0x0064, 0x0065, 0x006E, 0x0073, 0x0069, 0x006D, 0x0070,
  86           0x006C, 0x0065, 0x006D, 0x0065, 0x006E, 0x0074, 0x0065, 0x0068, 0x0061,
  87           0x0062, 0x006C, 0x0061, 0x0072, 0x0065, 0x006E, 0x0045, 0x0073, 0x0070,
  88           0x0061, 0x00F1, 0x006F, 0x006C
  89         },
  90         "PorqunopuedensimplementehablarenEspaol-fmd56a"
  91     },
  92     {   /* Vietnamese */
  93         { 0x0054, 0x1EA1, 0x0069, 0x0073, 0x0061, 0x006F, 0x0068, 0x1ECD, 0x006B,
  94           0x0068, 0x00F4, 0x006E, 0x0067, 0x0074, 0x0068, 0x1EC3, 0x0063, 0x0068,
  95           0x1EC9, 0x006E, 0x00F3, 0x0069, 0x0074, 0x0069, 0x1EBF, 0x006E, 0x0067,
  96           0x0056, 0x0069, 0x1EC7, 0x0074
  97         },
  98         "TisaohkhngthchnitingVit-kjcr8268qyxafd2f1b9g"
  99     },
 100     {   /* Japanese: 3<nen>B<gumi><kinpachi><sensei> */
 101         { 0x0033, 0x5E74, 0x0042, 0x7D44, 0x91D1, 0x516B, 0x5148, 0x751F
 102         },
 103         "3B-ww4c5e180e575a65lsy2b"
 104     },
 105     {   /* Japanese: <amuro><namie>-with-SUPER-MONKEYS */
 106         { 0x5B89, 0x5BA4, 0x5948, 0x7F8E, 0x6075, 0x002D, 0x0077, 0x0069, 0x0074,
 107           0x0068, 0x002D, 0x0053, 0x0055, 0x0050, 0x0045, 0x0052, 0x002D, 0x004D,
 108           0x004F, 0x004E, 0x004B, 0x0045, 0x0059, 0x0053
 109         },
 110         "-with-SUPER-MONKEYS-pc58ag80a8qai00g7n9n"
 111     },
 112     {   /* Japanese: Hello-Another-Way-<sorezore><no><basho> */
 113         { 0x0048, 0x0065, 0x006C, 0x006C, 0x006F, 0x002D, 0x0041, 0x006E, 0x006F,
 114           0x0074, 0x0068, 0x0065, 0x0072, 0x002D, 0x0057, 0x0061, 0x0079, 0x002D,
 115           0x305D, 0x308C, 0x305E, 0x308C, 0x306E, 0x5834, 0x6240
 116         },
 117         "Hello-Another-Way--fc4qua05auwb3674vfr0b"
 118     },
 119     {   /* Japanese: <hitotsu><yane><no><shita>2 */
 120         { 0x3072, 0x3068, 0x3064, 0x5C4B, 0x6839, 0x306E, 0x4E0B, 0x0032
 121         },
 122         "2-u9tlzr9756bt3uc0v"
 123     },
 124     {   /* Japanese: Maji<de>Koi<suru>5<byou><mae> */
 125         { 0x004D, 0x0061, 0x006A, 0x0069, 0x3067, 0x004B, 0x006F, 0x0069, 0x3059,
 126           0x308B, 0x0035, 0x79D2, 0x524D
 127         },
 128         "MajiKoi5-783gue6qz075azm5e"
 129     },
 130     {   /* Japanese: <pafii>de<runba> */
 131         { 0x30D1, 0x30D5, 0x30A3, 0x30FC, 0x0064, 0x0065, 0x30EB, 0x30F3, 0x30D0
 132         },
 133         "de-jg4avhby1noc0d"
 134     },
 135     {   /* Japanese: <sono><supiido><de> */
 136         { 0x305D, 0x306E, 0x30B9, 0x30D4, 0x30FC, 0x30C9, 0x3067
 137         },
 138         "d9juau41awczczp"
 139     },
 140     {   /* -> $1.00 <- */
 141         { 0x002D, 0x003E, 0x0020, 0x0024, 0x0031, 0x002E, 0x0030, 0x0030, 0x0020,
 142           0x003C, 0x002D
 143         },
 144         "-> $1.00 <--"
 145     }
 146 };
 147
 148 static int test_punycode(int n)
 149 {
 150     const struct puny_test *tc = puny_cases + n;
 151     unsigned int buffer[50];
 152     unsigned int bsize = OSSL_NELEM(buffer);
 153     size_t i;
 154
 155     if (!TEST_true(ossl_punycode_decode(tc->encoded, strlen(tc->encoded),
 156                                         buffer, &bsize)))
 157         return 0;
 158     for (i = 0; i < OSSL_NELEM(tc->raw); i++)
 159         if (tc->raw[i] == 0)
 160             break;
 161     if (!TEST_mem_eq(buffer, bsize * sizeof(*buffer),
 162                      tc->raw, i * sizeof(*tc->raw)))
 163         return 0;
 164     return 1;
 165 }
 166
 167 static int test_a2ulabel(void)
 168 {
 169     char out[50];
 170
 171     /*
 172      * The punycode being passed in and parsed is malformed but we're not
 173      * verifying that behaviour here.
 174      */
 175     if (!TEST_int_eq(ossl_a2ulabel("xn--a.b.c", out, 1), 0)
 176             || !TEST_int_eq(ossl_a2ulabel("xn--a.b.c", out, 7), 1))
 177         return 0;
 178     /* Test for an off by one on the buffer size works */
 179     if (!TEST_int_eq(ossl_a2ulabel("xn--a.b.c", out, 6), 0)
 180             || !TEST_int_eq(ossl_a2ulabel("xn--a.b.c", out, 7), 1)
 181             || !TEST_str_eq(out,"\xc2\x80.b.c"))
 182         return 0;
 183     return 1;
 184 }
 185
 186 static int test_puny_overrun(void)
 187 {
 188     static const unsigned int out[] = {
 189         0x0033, 0x5E74, 0x0042, 0x7D44, 0x91D1, 0x516B, 0x5148, 0x751F
 190     };
 191     static const char *in = "3B-ww4c5e180e575a65lsy2b";
 192     unsigned int buf[OSSL_NELEM(out)];
 193     unsigned int bsize = OSSL_NELEM(buf) - 1;
 194
 195     if (!TEST_false(ossl_punycode_decode(in, strlen(in), buf, &bsize))) {
 196         if (TEST_mem_eq(buf, bsize * sizeof(*buf), out, sizeof(out)))
 197             TEST_error("CRITICAL: buffer overrun detected!");
 198         return 0;
 199     }
 200     return 1;
 201 }
 202
 203 static int test_dotted_overflow(void)
 204 {
 205     static const char string[] = "a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a.a";
 206     const size_t num_reps = OSSL_NELEM(string) / 2;
 207     WPACKET p;
 208     BUF_MEM *in;
 209     char *out = NULL;
 210     size_t i;
 211     int res = 0;
 212
 213     /* Create out input punycode string */
 214     if (!TEST_ptr(in = BUF_MEM_new()))
 215         return 0;
 216     if (!TEST_true(WPACKET_init_len(&p, in, 0))) {
 217         BUF_MEM_free(in);
 218         return 0;
 219     }
 220     for (i = 0; i < num_reps; i++) {
 221         if (i > 1 && !TEST_true(WPACKET_put_bytes_u8(&p, '.')))
 222             goto err;
 223         if (!TEST_true(WPACKET_memcpy(&p, "xn--a", sizeof("xn--a") - 1)))
 224             goto err;
 225     }
 226     if (!TEST_true(WPACKET_put_bytes_u8(&p, '\0')))
 227             goto err;
 228     if (!TEST_ptr(out = OPENSSL_malloc(in->length)))
 229         goto err;
 230
 231     /* Test the decode into an undersized buffer */
 232     memset(out, 0x7f, in->length - 1);
 233     if (!TEST_int_le(ossl_a2ulabel(in->data, out, num_reps), 0)
 234             || !TEST_int_eq(out[num_reps], 0x7f))
 235         goto err;
 236
 237     /* Test the decode works into a full size buffer */
 238     if (!TEST_int_gt(ossl_a2ulabel(in->data, out, in->length), 0)
 239             || !TEST_size_t_eq(strlen(out), num_reps * 3))
 240         goto err;
 241
 242     res = 1;
 243  err:
 244     WPACKET_cleanup(&p);
 245     BUF_MEM_free(in);
 246     OPENSSL_free(out);
 247     return res;
 248 }
 249
 250 int setup_tests(void)
 251 {
 252     ADD_ALL_TESTS(test_punycode, OSSL_NELEM(puny_cases));
 253     ADD_TEST(test_dotted_overflow);
 254     ADD_TEST(test_a2ulabel);
 255     ADD_TEST(test_puny_overrun);
 256     return 1;
 257 }