der.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  1. /*-
  2. * Copyright (c) 2016 Christos Zoulas
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. * 1. Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in the
  12. * documentation and/or other materials provided with the distribution.
  13. *
  14. * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  15. * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  16. * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  18. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24. * POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. /*
  27. * DER (Distinguished Encoding Rules) Parser
  28. *
  29. * Sources:
  30. * https://en.wikipedia.org/wiki/X.690
  31. * http://fm4dd.com/openssl/certexamples.htm
  32. * http://blog.engelke.com/2014/10/17/parsing-ber-and-der-encoded-asn-1-objects/
  33. */
  34. #ifndef TEST_DER
  35. #include "file.h"
  36. #ifndef lint
  37. FILE_RCSID("@(#)$File: der.c,v 1.21 2020/06/15 00:58:10 christos Exp $")
  38. #endif
  39. #else
  40. #define SIZE_T_FORMAT "z"
  41. #define CAST(a, b) ((a)(b))
  42. #endif
  43. #include <sys/types.h>
  44. #include <stdio.h>
  45. #include <fcntl.h>
  46. #include <stdlib.h>
  47. #include <string.h>
  48. #include <ctype.h>
  49. #ifndef TEST_DER
  50. #include "magic.h"
  51. #include "der.h"
  52. #else
  53. #ifndef PHP_WIN32
  54. #include <sys/mman.h>
  55. #endif
  56. #include <sys/stat.h>
  57. #include <err.h>
  58. #endif
  59. #define DER_BAD CAST(uint32_t, -1)
  60. #define DER_CLASS_UNIVERSAL 0
  61. #define DER_CLASS_APPLICATION 1
  62. #define DER_CLASS_CONTEXT 2
  63. #define DER_CLASS_PRIVATE 3
  64. #if defined(DEBUG_DER) || defined(TEST_DER)
  65. static const char der_class[] = "UACP";
  66. #endif
  67. #define DER_TYPE_PRIMITIVE 0
  68. #define DER_TYPE_CONSTRUCTED 1
  69. #if defined(DEBUG_DER) || defined(TEST_DER)
  70. static const char der_type[] = "PC";
  71. #endif
  72. #define DER_TAG_EOC 0x00
  73. #define DER_TAG_BOOLEAN 0x01
  74. #define DER_TAG_INTEGER 0x02
  75. #define DER_TAG_BIT STRING 0x03
  76. #define DER_TAG_OCTET_STRING 0x04
  77. #define DER_TAG_NULL 0x05
  78. #define DER_TAG_OBJECT_IDENTIFIER 0x06
  79. #define DER_TAG_OBJECT_DESCRIPTOR 0x07
  80. #define DER_TAG_EXTERNAL 0x08
  81. #define DER_TAG_REAL 0x09
  82. #define DER_TAG_ENUMERATED 0x0a
  83. #define DER_TAG_EMBEDDED_PDV 0x0b
  84. #define DER_TAG_UTF8_STRING 0x0c
  85. #define DER_TAG_RELATIVE_OID 0x0d
  86. #define DER_TAG_TIME 0x0e
  87. #define DER_TAG_RESERVED_2 0x0f
  88. #define DER_TAG_SEQUENCE 0x10
  89. #define DER_TAG_SET 0x11
  90. #define DER_TAG_NUMERIC_STRING 0x12
  91. #define DER_TAG_PRINTABLE_STRING 0x13
  92. #define DER_TAG_T61_STRING 0x14
  93. #define DER_TAG_VIDEOTEX_STRING 0x15
  94. #define DER_TAG_IA5_STRING 0x16
  95. #define DER_TAG_UTCTIME 0x17
  96. #define DER_TAG_GENERALIZED_TIME 0x18
  97. #define DER_TAG_GRAPHIC_STRING 0x19
  98. #define DER_TAG_VISIBLE_STRING 0x1a
  99. #define DER_TAG_GENERAL_STRING 0x1b
  100. #define DER_TAG_UNIVERSAL_STRING 0x1c
  101. #define DER_TAG_CHARACTER_STRING 0x1d
  102. #define DER_TAG_BMP_STRING 0x1e
  103. #define DER_TAG_DATE 0x1f
  104. #define DER_TAG_TIME_OF_DAY 0x20
  105. #define DER_TAG_DATE_TIME 0x21
  106. #define DER_TAG_DURATION 0x22
  107. #define DER_TAG_OID_IRI 0x23
  108. #define DER_TAG_RELATIVE_OID_IRI 0x24
  109. #define DER_TAG_LAST 0x25
  110. static const char *der__tag[] = {
  111. "eoc", "bool", "int", "bit_str", "octet_str",
  112. "null", "obj_id", "obj_desc", "ext", "real",
  113. "enum", "embed", "utf8_str", "rel_oid", "time",
  114. "res2", "seq", "set", "num_str", "prt_str",
  115. "t61_str", "vid_str", "ia5_str", "utc_time", "gen_time",
  116. "gr_str", "vis_str", "gen_str", "univ_str", "char_str",
  117. "bmp_str", "date", "tod", "datetime", "duration",
  118. "oid-iri", "rel-oid-iri",
  119. };
  120. #ifdef DEBUG_DER
  121. #define DPRINTF(a) printf a
  122. #else
  123. #define DPRINTF(a)
  124. #endif
  125. #ifdef TEST_DER
  126. static uint8_t
  127. getclass(uint8_t c)
  128. {
  129. return c >> 6;
  130. }
  131. static uint8_t
  132. gettype(uint8_t c)
  133. {
  134. return (c >> 5) & 1;
  135. }
  136. #endif
  137. static uint32_t
  138. gettag(const uint8_t *c, size_t *p, size_t l)
  139. {
  140. uint32_t tag;
  141. if (*p >= l)
  142. return DER_BAD;
  143. tag = c[(*p)++] & 0x1f;
  144. if (tag != 0x1f)
  145. return tag;
  146. if (*p >= l)
  147. return DER_BAD;
  148. while (c[*p] >= 0x80) {
  149. tag = tag * 128 + c[(*p)++] - 0x80;
  150. if (*p >= l)
  151. return DER_BAD;
  152. }
  153. return tag;
  154. }
  155. /*
  156. * Read the length of a DER tag from the input.
  157. *
  158. * `c` is the input, `p` is an output parameter that specifies how much of the
  159. * input we consumed, and `l` is the maximum input length.
  160. *
  161. * Returns the length, or DER_BAD if the end of the input is reached or the
  162. * length exceeds the remaining input.
  163. */
  164. static uint32_t
  165. getlength(const uint8_t *c, size_t *p, size_t l)
  166. {
  167. uint8_t digits, i;
  168. size_t len;
  169. int is_onebyte_result;
  170. if (*p >= l) {
  171. DPRINTF(("%s:[1] %zu >= %zu\n", __func__, *p, l));
  172. return DER_BAD;
  173. }
  174. /*
  175. * Digits can either be 0b0 followed by the result, or 0b1
  176. * followed by the number of digits of the result. In either case,
  177. * we verify that we can read so many bytes from the input.
  178. */
  179. is_onebyte_result = (c[*p] & 0x80) == 0;
  180. digits = c[(*p)++] & 0x7f;
  181. if (*p + digits >= l) {
  182. DPRINTF(("%s:[2] %zu + %u >= %zu\n", __func__, *p, digits, l));
  183. return DER_BAD;
  184. }
  185. if (is_onebyte_result)
  186. return digits;
  187. /*
  188. * Decode len. We've already verified that we're allowed to read
  189. * `digits` bytes.
  190. */
  191. len = 0;
  192. for (i = 0; i < digits; i++)
  193. len = (len << 8) | c[(*p)++];
  194. if (len > UINT32_MAX - *p || *p + len > l) {
  195. DPRINTF(("%s:[3] bad len %zu + %zu >= %zu\n",
  196. __func__, *p, len, l));
  197. return DER_BAD;
  198. }
  199. return CAST(uint32_t, len);
  200. }
  201. static const char *
  202. der_tag(char *buf, size_t len, uint32_t tag)
  203. {
  204. if (tag < DER_TAG_LAST)
  205. strlcpy(buf, der__tag[tag], len);
  206. else
  207. snprintf(buf, len, "%#x", tag);
  208. return buf;
  209. }
  210. #ifndef TEST_DER
  211. static int
  212. der_data(char *buf, size_t blen, uint32_t tag, const void *q, uint32_t len)
  213. {
  214. const uint8_t *d = CAST(const uint8_t *, q);
  215. switch (tag) {
  216. case DER_TAG_PRINTABLE_STRING:
  217. case DER_TAG_UTF8_STRING:
  218. case DER_TAG_IA5_STRING:
  219. return snprintf(buf, blen, "%.*s", len, RCAST(const char *, q));
  220. case DER_TAG_UTCTIME:
  221. if (len < 12)
  222. break;
  223. return snprintf(buf, blen,
  224. "20%c%c-%c%c-%c%c %c%c:%c%c:%c%c GMT", d[0], d[1], d[2],
  225. d[3], d[4], d[5], d[6], d[7], d[8], d[9], d[10], d[11]);
  226. default:
  227. break;
  228. }
  229. for (uint32_t i = 0; i < len; i++) {
  230. uint32_t z = i << 1;
  231. if (z < blen - 2)
  232. snprintf(buf + z, blen - z, "%.2x", d[i]);
  233. }
  234. return len * 2;
  235. }
  236. int32_t
  237. der_offs(struct magic_set *ms, struct magic *m, size_t nbytes)
  238. {
  239. const uint8_t *b = RCAST(const uint8_t *, ms->search.s);
  240. size_t offs = 0, len = ms->search.s_len ? ms->search.s_len : nbytes;
  241. if (gettag(b, &offs, len) == DER_BAD) {
  242. DPRINTF(("%s: bad tag 1\n", __func__));
  243. return -1;
  244. }
  245. DPRINTF(("%s1: %d %" SIZE_T_FORMAT "u %u\n", __func__, ms->offset,
  246. offs, m->offset));
  247. uint32_t tlen = getlength(b, &offs, len);
  248. if (tlen == DER_BAD) {
  249. DPRINTF(("%s: bad tag 2\n", __func__));
  250. return -1;
  251. }
  252. DPRINTF(("%s2: %d %" SIZE_T_FORMAT "u %u\n", __func__, ms->offset,
  253. offs, tlen));
  254. offs += ms->offset + m->offset;
  255. DPRINTF(("cont_level = %d\n", m->cont_level));
  256. #ifdef DEBUG_DER
  257. for (size_t i = 0; i < m->cont_level; i++)
  258. printf("cont_level[%" SIZE_T_FORMAT "u] = %u\n", i,
  259. ms->c.li[i].off);
  260. #endif
  261. if (m->cont_level != 0) {
  262. if (offs + tlen > nbytes)
  263. return -1;
  264. ms->c.li[m->cont_level - 1].off = CAST(int, offs + tlen);
  265. DPRINTF(("cont_level[%u] = %u\n", m->cont_level - 1,
  266. ms->c.li[m->cont_level - 1].off));
  267. }
  268. return CAST(int32_t, offs);
  269. }
  270. int
  271. der_cmp(struct magic_set *ms, struct magic *m)
  272. {
  273. const uint8_t *b = RCAST(const uint8_t *, ms->search.s);
  274. const char *s = m->value.s;
  275. size_t offs = 0, len = ms->search.s_len;
  276. uint32_t tag, tlen;
  277. char buf[128];
  278. DPRINTF(("%s: compare %zu bytes\n", __func__, len));
  279. tag = gettag(b, &offs, len);
  280. if (tag == DER_BAD) {
  281. DPRINTF(("%s: bad tag 1\n", __func__));
  282. return -1;
  283. }
  284. DPRINTF(("%s1: %d %" SIZE_T_FORMAT "u %u\n", __func__, ms->offset,
  285. offs, m->offset));
  286. tlen = getlength(b, &offs, len);
  287. if (tlen == DER_BAD) {
  288. DPRINTF(("%s: bad tag 2\n", __func__));
  289. return -1;
  290. }
  291. der_tag(buf, sizeof(buf), tag);
  292. if ((ms->flags & MAGIC_DEBUG) != 0)
  293. fprintf(stderr, "%s: tag %p got=%s exp=%s\n", __func__, b,
  294. buf, s);
  295. size_t slen = strlen(buf);
  296. if (strncmp(buf, s, slen) != 0)
  297. return 0;
  298. s += slen;
  299. again:
  300. switch (*s) {
  301. case '\0':
  302. return 1;
  303. case '=':
  304. s++;
  305. goto val;
  306. default:
  307. if (!isdigit(CAST(unsigned char, *s)))
  308. return 0;
  309. slen = 0;
  310. do
  311. slen = slen * 10 + *s - '0';
  312. while (isdigit(CAST(unsigned char, *++s)));
  313. if ((ms->flags & MAGIC_DEBUG) != 0)
  314. fprintf(stderr, "%s: len %" SIZE_T_FORMAT "u %u\n",
  315. __func__, slen, tlen);
  316. if (tlen != slen)
  317. return 0;
  318. goto again;
  319. }
  320. val:
  321. DPRINTF(("%s: before data %" SIZE_T_FORMAT "u %u\n", __func__, offs,
  322. tlen));
  323. der_data(buf, sizeof(buf), tag, b + offs, tlen);
  324. if ((ms->flags & MAGIC_DEBUG) != 0)
  325. fprintf(stderr, "%s: data %s %s\n", __func__, buf, s);
  326. if (strcmp(buf, s) != 0 && strcmp("x", s) != 0)
  327. return 0;
  328. strlcpy(ms->ms_value.s, buf, sizeof(ms->ms_value.s));
  329. return 1;
  330. }
  331. #endif
  332. #ifdef TEST_DER
  333. static void
  334. printtag(uint32_t tag, const void *q, uint32_t len)
  335. {
  336. const uint8_t *d = q;
  337. switch (tag) {
  338. case DER_TAG_PRINTABLE_STRING:
  339. case DER_TAG_UTF8_STRING:
  340. case DER_TAG_IA5_STRING:
  341. case DER_TAG_UTCTIME:
  342. printf("%.*s\n", len, (const char *)q);
  343. return;
  344. default:
  345. break;
  346. }
  347. for (uint32_t i = 0; i < len; i++)
  348. printf("%.2x", d[i]);
  349. printf("\n");
  350. }
  351. static void
  352. printdata(size_t level, const void *v, size_t x, size_t l)
  353. {
  354. const uint8_t *p = v, *ep = p + l;
  355. size_t ox;
  356. char buf[128];
  357. while (p + x < ep) {
  358. const uint8_t *q;
  359. uint8_t c = getclass(p[x]);
  360. uint8_t t = gettype(p[x]);
  361. ox = x;
  362. // if (x != 0)
  363. // printf("%.2x %.2x %.2x\n", p[x - 1], p[x], p[x + 1]);
  364. uint32_t tag = gettag(p, &x, ep - p + x);
  365. if (p + x >= ep)
  366. break;
  367. uint32_t len = getlength(p, &x, ep - p + x);
  368. printf("%" SIZE_T_FORMAT "u %" SIZE_T_FORMAT "u-%"
  369. SIZE_T_FORMAT "u %c,%c,%s,%u:", level, ox, x,
  370. der_class[c], der_type[t],
  371. der_tag(buf, sizeof(buf), tag), len);
  372. q = p + x;
  373. if (p + len > ep)
  374. errx(EXIT_FAILURE, "corrupt der");
  375. printtag(tag, q, len);
  376. if (t != DER_TYPE_PRIMITIVE)
  377. printdata(level + 1, p, x, len + x);
  378. x += len;
  379. }
  380. }
  381. int
  382. main(int argc, char *argv[])
  383. {
  384. int fd;
  385. struct stat st;
  386. size_t l;
  387. void *p;
  388. if ((fd = open(argv[1], O_RDONLY)) == -1)
  389. err(EXIT_FAILURE, "open `%s'", argv[1]);
  390. if (fstat(fd, &st) == -1)
  391. err(EXIT_FAILURE, "stat `%s'", argv[1]);
  392. l = (size_t)st.st_size;
  393. if ((p = mmap(NULL, l, PROT_READ, MAP_FILE, fd, 0)) == MAP_FAILED)
  394. err(EXIT_FAILURE, "mmap `%s'", argv[1]);
  395. printdata(0, p, 0, l);
  396. munmap(p, l);
  397. return 0;
  398. }
  399. #endif