x_name.c 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  1. /* crypto/asn1/x_name.c */
  2. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young (eay@cryptsoft.com).
  7. * The implementation was written so as to conform with Netscapes SSL.
  8. *
  9. * This library is free for commercial and non-commercial use as long as
  10. * the following conditions are aheared to. The following conditions
  11. * apply to all code found in this distribution, be it the RC4, RSA,
  12. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  13. * included with this distribution is covered by the same copyright terms
  14. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15. *
  16. * Copyright remains Eric Young's, and as such any Copyright notices in
  17. * the code are not to be removed.
  18. * If this package is used in a product, Eric Young should be given attribution
  19. * as the author of the parts of the library used.
  20. * This can be in the form of a textual message at program startup or
  21. * in documentation (online or textual) provided with the package.
  22. *
  23. * Redistribution and use in source and binary forms, with or without
  24. * modification, are permitted provided that the following conditions
  25. * are met:
  26. * 1. Redistributions of source code must retain the copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * 2. Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in the
  30. * documentation and/or other materials provided with the distribution.
  31. * 3. All advertising materials mentioning features or use of this software
  32. * must display the following acknowledgement:
  33. * "This product includes cryptographic software written by
  34. * Eric Young (eay@cryptsoft.com)"
  35. * The word 'cryptographic' can be left out if the rouines from the library
  36. * being used are not cryptographic related :-).
  37. * 4. If you include any Windows specific code (or a derivative thereof) from
  38. * the apps directory (application code) you must include an acknowledgement:
  39. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. *
  53. * The licence and distribution terms for any publically available version or
  54. * derivative of this code cannot be changed. i.e. this code cannot simply be
  55. * copied and put under another distribution licence
  56. * [including the GNU Public Licence.]
  57. */
  58. #include <stdio.h>
  59. #include <ctype.h>
  60. #include "cryptlib.h"
  61. #include <openssl/asn1t.h>
  62. #include <openssl/x509.h>
  63. #include "asn1_locl.h"
  64. typedef STACK_OF(X509_NAME_ENTRY) STACK_OF_X509_NAME_ENTRY;
  65. DECLARE_STACK_OF(STACK_OF_X509_NAME_ENTRY)
  66. static int x509_name_ex_d2i(ASN1_VALUE **val,
  67. const unsigned char **in, long len,
  68. const ASN1_ITEM *it,
  69. int tag, int aclass, char opt, ASN1_TLC *ctx);
  70. static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
  71. const ASN1_ITEM *it, int tag, int aclass);
  72. static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it);
  73. static void x509_name_ex_free(ASN1_VALUE **val, const ASN1_ITEM *it);
  74. static int x509_name_encode(X509_NAME *a);
  75. static int x509_name_canon(X509_NAME *a);
  76. static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in);
  77. static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * intname,
  78. unsigned char **in);
  79. static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
  80. int indent,
  81. const char *fname, const ASN1_PCTX *pctx);
  82. ASN1_SEQUENCE(X509_NAME_ENTRY) = {
  83. ASN1_SIMPLE(X509_NAME_ENTRY, object, ASN1_OBJECT),
  84. ASN1_SIMPLE(X509_NAME_ENTRY, value, ASN1_PRINTABLE)
  85. } ASN1_SEQUENCE_END(X509_NAME_ENTRY)
  86. IMPLEMENT_ASN1_FUNCTIONS(X509_NAME_ENTRY)
  87. IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME_ENTRY)
  88. /*
  89. * For the "Name" type we need a SEQUENCE OF { SET OF X509_NAME_ENTRY } so
  90. * declare two template wrappers for this
  91. */
  92. ASN1_ITEM_TEMPLATE(X509_NAME_ENTRIES) =
  93. ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_OF, 0, RDNS, X509_NAME_ENTRY)
  94. ASN1_ITEM_TEMPLATE_END(X509_NAME_ENTRIES)
  95. ASN1_ITEM_TEMPLATE(X509_NAME_INTERNAL) =
  96. ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, Name, X509_NAME_ENTRIES)
  97. ASN1_ITEM_TEMPLATE_END(X509_NAME_INTERNAL)
  98. /*
  99. * Normally that's where it would end: we'd have two nested STACK structures
  100. * representing the ASN1. Unfortunately X509_NAME uses a completely different
  101. * form and caches encodings so we have to process the internal form and
  102. * convert to the external form.
  103. */
  104. const ASN1_EXTERN_FUNCS x509_name_ff = {
  105. NULL,
  106. x509_name_ex_new,
  107. x509_name_ex_free,
  108. 0, /* Default clear behaviour is OK */
  109. x509_name_ex_d2i,
  110. x509_name_ex_i2d,
  111. x509_name_ex_print
  112. };
  113. IMPLEMENT_EXTERN_ASN1(X509_NAME, V_ASN1_SEQUENCE, x509_name_ff)
  114. IMPLEMENT_ASN1_FUNCTIONS(X509_NAME)
  115. IMPLEMENT_ASN1_DUP_FUNCTION(X509_NAME)
  116. static int x509_name_ex_new(ASN1_VALUE **val, const ASN1_ITEM *it)
  117. {
  118. X509_NAME *ret = NULL;
  119. ret = OPENSSL_malloc(sizeof(X509_NAME));
  120. if (!ret)
  121. goto memerr;
  122. if ((ret->entries = sk_X509_NAME_ENTRY_new_null()) == NULL)
  123. goto memerr;
  124. if ((ret->bytes = BUF_MEM_new()) == NULL)
  125. goto memerr;
  126. ret->canon_enc = NULL;
  127. ret->canon_enclen = 0;
  128. ret->modified = 1;
  129. *val = (ASN1_VALUE *)ret;
  130. return 1;
  131. memerr:
  132. ASN1err(ASN1_F_X509_NAME_EX_NEW, ERR_R_MALLOC_FAILURE);
  133. if (ret) {
  134. if (ret->entries)
  135. sk_X509_NAME_ENTRY_free(ret->entries);
  136. OPENSSL_free(ret);
  137. }
  138. return 0;
  139. }
  140. static void x509_name_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it)
  141. {
  142. X509_NAME *a;
  143. if (!pval || !*pval)
  144. return;
  145. a = (X509_NAME *)*pval;
  146. BUF_MEM_free(a->bytes);
  147. sk_X509_NAME_ENTRY_pop_free(a->entries, X509_NAME_ENTRY_free);
  148. if (a->canon_enc)
  149. OPENSSL_free(a->canon_enc);
  150. OPENSSL_free(a);
  151. *pval = NULL;
  152. }
  153. static int x509_name_ex_d2i(ASN1_VALUE **val,
  154. const unsigned char **in, long len,
  155. const ASN1_ITEM *it, int tag, int aclass,
  156. char opt, ASN1_TLC *ctx)
  157. {
  158. const unsigned char *p = *in, *q;
  159. union {
  160. STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
  161. ASN1_VALUE *a;
  162. } intname = {
  163. NULL
  164. };
  165. union {
  166. X509_NAME *x;
  167. ASN1_VALUE *a;
  168. } nm = {
  169. NULL
  170. };
  171. int i, j, ret;
  172. STACK_OF(X509_NAME_ENTRY) *entries;
  173. X509_NAME_ENTRY *entry;
  174. q = p;
  175. /* Get internal representation of Name */
  176. ret = ASN1_item_ex_d2i(&intname.a,
  177. &p, len, ASN1_ITEM_rptr(X509_NAME_INTERNAL),
  178. tag, aclass, opt, ctx);
  179. if (ret <= 0)
  180. return ret;
  181. if (*val)
  182. x509_name_ex_free(val, NULL);
  183. if (!x509_name_ex_new(&nm.a, NULL))
  184. goto err;
  185. /* We've decoded it: now cache encoding */
  186. if (!BUF_MEM_grow(nm.x->bytes, p - q))
  187. goto err;
  188. memcpy(nm.x->bytes->data, q, p - q);
  189. /* Convert internal representation to X509_NAME structure */
  190. for (i = 0; i < sk_STACK_OF_X509_NAME_ENTRY_num(intname.s); i++) {
  191. entries = sk_STACK_OF_X509_NAME_ENTRY_value(intname.s, i);
  192. for (j = 0; j < sk_X509_NAME_ENTRY_num(entries); j++) {
  193. entry = sk_X509_NAME_ENTRY_value(entries, j);
  194. entry->set = i;
  195. if (!sk_X509_NAME_ENTRY_push(nm.x->entries, entry))
  196. goto err;
  197. }
  198. sk_X509_NAME_ENTRY_free(entries);
  199. }
  200. sk_STACK_OF_X509_NAME_ENTRY_free(intname.s);
  201. ret = x509_name_canon(nm.x);
  202. if (!ret)
  203. goto err;
  204. nm.x->modified = 0;
  205. *val = nm.a;
  206. *in = p;
  207. return ret;
  208. err:
  209. if (nm.x != NULL)
  210. X509_NAME_free(nm.x);
  211. ASN1err(ASN1_F_X509_NAME_EX_D2I, ERR_R_NESTED_ASN1_ERROR);
  212. return 0;
  213. }
  214. static int x509_name_ex_i2d(ASN1_VALUE **val, unsigned char **out,
  215. const ASN1_ITEM *it, int tag, int aclass)
  216. {
  217. int ret;
  218. X509_NAME *a = (X509_NAME *)*val;
  219. if (a->modified) {
  220. ret = x509_name_encode(a);
  221. if (ret < 0)
  222. return ret;
  223. ret = x509_name_canon(a);
  224. if (ret < 0)
  225. return ret;
  226. }
  227. ret = a->bytes->length;
  228. if (out != NULL) {
  229. memcpy(*out, a->bytes->data, ret);
  230. *out += ret;
  231. }
  232. return ret;
  233. }
  234. static void local_sk_X509_NAME_ENTRY_free(STACK_OF(X509_NAME_ENTRY) *ne)
  235. {
  236. sk_X509_NAME_ENTRY_free(ne);
  237. }
  238. static void local_sk_X509_NAME_ENTRY_pop_free(STACK_OF(X509_NAME_ENTRY) *ne)
  239. {
  240. sk_X509_NAME_ENTRY_pop_free(ne, X509_NAME_ENTRY_free);
  241. }
  242. static int x509_name_encode(X509_NAME *a)
  243. {
  244. union {
  245. STACK_OF(STACK_OF_X509_NAME_ENTRY) *s;
  246. ASN1_VALUE *a;
  247. } intname = {
  248. NULL
  249. };
  250. int len;
  251. unsigned char *p;
  252. STACK_OF(X509_NAME_ENTRY) *entries = NULL;
  253. X509_NAME_ENTRY *entry;
  254. int i, set = -1;
  255. intname.s = sk_STACK_OF_X509_NAME_ENTRY_new_null();
  256. if (!intname.s)
  257. goto memerr;
  258. for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
  259. entry = sk_X509_NAME_ENTRY_value(a->entries, i);
  260. if (entry->set != set) {
  261. entries = sk_X509_NAME_ENTRY_new_null();
  262. if (!entries)
  263. goto memerr;
  264. if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname.s, entries))
  265. goto memerr;
  266. set = entry->set;
  267. }
  268. if (!sk_X509_NAME_ENTRY_push(entries, entry))
  269. goto memerr;
  270. }
  271. len = ASN1_item_ex_i2d(&intname.a, NULL,
  272. ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
  273. if (!BUF_MEM_grow(a->bytes, len))
  274. goto memerr;
  275. p = (unsigned char *)a->bytes->data;
  276. ASN1_item_ex_i2d(&intname.a,
  277. &p, ASN1_ITEM_rptr(X509_NAME_INTERNAL), -1, -1);
  278. sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
  279. local_sk_X509_NAME_ENTRY_free);
  280. a->modified = 0;
  281. return len;
  282. memerr:
  283. sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname.s,
  284. local_sk_X509_NAME_ENTRY_free);
  285. ASN1err(ASN1_F_X509_NAME_ENCODE, ERR_R_MALLOC_FAILURE);
  286. return -1;
  287. }
  288. static int x509_name_ex_print(BIO *out, ASN1_VALUE **pval,
  289. int indent,
  290. const char *fname, const ASN1_PCTX *pctx)
  291. {
  292. if (X509_NAME_print_ex(out, (X509_NAME *)*pval,
  293. indent, pctx->nm_flags) <= 0)
  294. return 0;
  295. return 2;
  296. }
  297. /*
  298. * This function generates the canonical encoding of the Name structure. In
  299. * it all strings are converted to UTF8, leading, trailing and multiple
  300. * spaces collapsed, converted to lower case and the leading SEQUENCE header
  301. * removed. In future we could also normalize the UTF8 too. By doing this
  302. * comparison of Name structures can be rapidly perfomed by just using
  303. * memcmp() of the canonical encoding. By omitting the leading SEQUENCE name
  304. * constraints of type dirName can also be checked with a simple memcmp().
  305. */
  306. static int x509_name_canon(X509_NAME *a)
  307. {
  308. unsigned char *p;
  309. STACK_OF(STACK_OF_X509_NAME_ENTRY) *intname = NULL;
  310. STACK_OF(X509_NAME_ENTRY) *entries = NULL;
  311. X509_NAME_ENTRY *entry, *tmpentry = NULL;
  312. int i, set = -1, ret = 0;
  313. if (a->canon_enc) {
  314. OPENSSL_free(a->canon_enc);
  315. a->canon_enc = NULL;
  316. }
  317. /* Special case: empty X509_NAME => null encoding */
  318. if (sk_X509_NAME_ENTRY_num(a->entries) == 0) {
  319. a->canon_enclen = 0;
  320. return 1;
  321. }
  322. intname = sk_STACK_OF_X509_NAME_ENTRY_new_null();
  323. if (!intname)
  324. goto err;
  325. for (i = 0; i < sk_X509_NAME_ENTRY_num(a->entries); i++) {
  326. entry = sk_X509_NAME_ENTRY_value(a->entries, i);
  327. if (entry->set != set) {
  328. entries = sk_X509_NAME_ENTRY_new_null();
  329. if (!entries)
  330. goto err;
  331. if (!sk_STACK_OF_X509_NAME_ENTRY_push(intname, entries))
  332. goto err;
  333. set = entry->set;
  334. }
  335. tmpentry = X509_NAME_ENTRY_new();
  336. if (!tmpentry)
  337. goto err;
  338. tmpentry->object = OBJ_dup(entry->object);
  339. if (!asn1_string_canon(tmpentry->value, entry->value))
  340. goto err;
  341. if (!sk_X509_NAME_ENTRY_push(entries, tmpentry))
  342. goto err;
  343. tmpentry = NULL;
  344. }
  345. /* Finally generate encoding */
  346. a->canon_enclen = i2d_name_canon(intname, NULL);
  347. p = OPENSSL_malloc(a->canon_enclen);
  348. if (!p)
  349. goto err;
  350. a->canon_enc = p;
  351. i2d_name_canon(intname, &p);
  352. ret = 1;
  353. err:
  354. if (tmpentry)
  355. X509_NAME_ENTRY_free(tmpentry);
  356. if (intname)
  357. sk_STACK_OF_X509_NAME_ENTRY_pop_free(intname,
  358. local_sk_X509_NAME_ENTRY_pop_free);
  359. return ret;
  360. }
  361. /* Bitmap of all the types of string that will be canonicalized. */
  362. #define ASN1_MASK_CANON \
  363. (B_ASN1_UTF8STRING | B_ASN1_BMPSTRING | B_ASN1_UNIVERSALSTRING \
  364. | B_ASN1_PRINTABLESTRING | B_ASN1_T61STRING | B_ASN1_IA5STRING \
  365. | B_ASN1_VISIBLESTRING)
  366. static int asn1_string_canon(ASN1_STRING *out, ASN1_STRING *in)
  367. {
  368. unsigned char *to, *from;
  369. int len, i;
  370. /* If type not in bitmask just copy string across */
  371. if (!(ASN1_tag2bit(in->type) & ASN1_MASK_CANON)) {
  372. if (!ASN1_STRING_copy(out, in))
  373. return 0;
  374. return 1;
  375. }
  376. out->type = V_ASN1_UTF8STRING;
  377. out->length = ASN1_STRING_to_UTF8(&out->data, in);
  378. if (out->length == -1)
  379. return 0;
  380. to = out->data;
  381. from = to;
  382. len = out->length;
  383. /*
  384. * Convert string in place to canonical form. Ultimately we may need to
  385. * handle a wider range of characters but for now ignore anything with
  386. * MSB set and rely on the isspace() and tolower() functions.
  387. */
  388. /* Ignore leading spaces */
  389. while ((len > 0) && !(*from & 0x80) && isspace(*from)) {
  390. from++;
  391. len--;
  392. }
  393. to = from + len - 1;
  394. /* Ignore trailing spaces */
  395. while ((len > 0) && !(*to & 0x80) && isspace(*to)) {
  396. to--;
  397. len--;
  398. }
  399. to = out->data;
  400. i = 0;
  401. while (i < len) {
  402. /* If MSB set just copy across */
  403. if (*from & 0x80) {
  404. *to++ = *from++;
  405. i++;
  406. }
  407. /* Collapse multiple spaces */
  408. else if (isspace(*from)) {
  409. /* Copy one space across */
  410. *to++ = ' ';
  411. /*
  412. * Ignore subsequent spaces. Note: don't need to check len here
  413. * because we know the last character is a non-space so we can't
  414. * overflow.
  415. */
  416. do {
  417. from++;
  418. i++;
  419. }
  420. while (!(*from & 0x80) && isspace(*from));
  421. } else {
  422. *to++ = tolower(*from);
  423. from++;
  424. i++;
  425. }
  426. }
  427. out->length = to - out->data;
  428. return 1;
  429. }
  430. static int i2d_name_canon(STACK_OF(STACK_OF_X509_NAME_ENTRY) * _intname,
  431. unsigned char **in)
  432. {
  433. int i, len, ltmp;
  434. ASN1_VALUE *v;
  435. STACK_OF(ASN1_VALUE) *intname = (STACK_OF(ASN1_VALUE) *)_intname;
  436. len = 0;
  437. for (i = 0; i < sk_ASN1_VALUE_num(intname); i++) {
  438. v = sk_ASN1_VALUE_value(intname, i);
  439. ltmp = ASN1_item_ex_i2d(&v, in,
  440. ASN1_ITEM_rptr(X509_NAME_ENTRIES), -1, -1);
  441. if (ltmp < 0)
  442. return ltmp;
  443. len += ltmp;
  444. }
  445. return len;
  446. }
  447. int X509_NAME_set(X509_NAME **xn, X509_NAME *name)
  448. {
  449. X509_NAME *in;
  450. if (!xn || !name)
  451. return (0);
  452. if (*xn != name) {
  453. in = X509_NAME_dup(name);
  454. if (in != NULL) {
  455. X509_NAME_free(*xn);
  456. *xn = in;
  457. }
  458. }
  459. return (*xn != NULL);
  460. }
  461. IMPLEMENT_STACK_OF(X509_NAME_ENTRY)
  462. IMPLEMENT_ASN1_SET_OF(X509_NAME_ENTRY)