asn1write.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481
  1. /*
  2. * ASN.1 buffer writing functionality
  3. *
  4. * Copyright The Mbed TLS Contributors
  5. * SPDX-License-Identifier: Apache-2.0
  6. *
  7. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  8. * not use this file except in compliance with the License.
  9. * You may obtain a copy of the License at
  10. *
  11. * http://www.apache.org/licenses/LICENSE-2.0
  12. *
  13. * Unless required by applicable law or agreed to in writing, software
  14. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16. * See the License for the specific language governing permissions and
  17. * limitations under the License.
  18. */
  19. #include "common.h"
  20. #if defined(MBEDTLS_ASN1_WRITE_C)
  21. #include "mbedtls/asn1write.h"
  22. #include "mbedtls/error.h"
  23. #include <string.h>
  24. #include "mbedtls/platform.h"
  25. int mbedtls_asn1_write_len(unsigned char **p, unsigned char *start, size_t len)
  26. {
  27. if (len < 0x80) {
  28. if (*p - start < 1) {
  29. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  30. }
  31. *--(*p) = (unsigned char) len;
  32. return 1;
  33. }
  34. if (len <= 0xFF) {
  35. if (*p - start < 2) {
  36. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  37. }
  38. *--(*p) = (unsigned char) len;
  39. *--(*p) = 0x81;
  40. return 2;
  41. }
  42. if (len <= 0xFFFF) {
  43. if (*p - start < 3) {
  44. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  45. }
  46. *--(*p) = MBEDTLS_BYTE_0(len);
  47. *--(*p) = MBEDTLS_BYTE_1(len);
  48. *--(*p) = 0x82;
  49. return 3;
  50. }
  51. if (len <= 0xFFFFFF) {
  52. if (*p - start < 4) {
  53. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  54. }
  55. *--(*p) = MBEDTLS_BYTE_0(len);
  56. *--(*p) = MBEDTLS_BYTE_1(len);
  57. *--(*p) = MBEDTLS_BYTE_2(len);
  58. *--(*p) = 0x83;
  59. return 4;
  60. }
  61. int len_is_valid = 1;
  62. #if SIZE_MAX > 0xFFFFFFFF
  63. len_is_valid = (len <= 0xFFFFFFFF);
  64. #endif
  65. if (len_is_valid) {
  66. if (*p - start < 5) {
  67. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  68. }
  69. *--(*p) = MBEDTLS_BYTE_0(len);
  70. *--(*p) = MBEDTLS_BYTE_1(len);
  71. *--(*p) = MBEDTLS_BYTE_2(len);
  72. *--(*p) = MBEDTLS_BYTE_3(len);
  73. *--(*p) = 0x84;
  74. return 5;
  75. }
  76. return MBEDTLS_ERR_ASN1_INVALID_LENGTH;
  77. }
  78. int mbedtls_asn1_write_tag(unsigned char **p, unsigned char *start, unsigned char tag)
  79. {
  80. if (*p - start < 1) {
  81. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  82. }
  83. *--(*p) = tag;
  84. return 1;
  85. }
  86. int mbedtls_asn1_write_raw_buffer(unsigned char **p, unsigned char *start,
  87. const unsigned char *buf, size_t size)
  88. {
  89. size_t len = 0;
  90. if (*p < start || (size_t) (*p - start) < size) {
  91. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  92. }
  93. len = size;
  94. (*p) -= len;
  95. memcpy(*p, buf, len);
  96. return (int) len;
  97. }
  98. #if defined(MBEDTLS_BIGNUM_C)
  99. int mbedtls_asn1_write_mpi(unsigned char **p, unsigned char *start, const mbedtls_mpi *X)
  100. {
  101. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  102. size_t len = 0;
  103. // Write the MPI
  104. //
  105. len = mbedtls_mpi_size(X);
  106. /* DER represents 0 with a sign bit (0=nonnegative) and 7 value bits, not
  107. * as 0 digits. We need to end up with 020100, not with 0200. */
  108. if (len == 0) {
  109. len = 1;
  110. }
  111. if (*p < start || (size_t) (*p - start) < len) {
  112. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  113. }
  114. (*p) -= len;
  115. MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(X, *p, len));
  116. // DER format assumes 2s complement for numbers, so the leftmost bit
  117. // should be 0 for positive numbers and 1 for negative numbers.
  118. //
  119. if (X->s == 1 && **p & 0x80) {
  120. if (*p - start < 1) {
  121. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  122. }
  123. *--(*p) = 0x00;
  124. len += 1;
  125. }
  126. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  127. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_INTEGER));
  128. ret = (int) len;
  129. cleanup:
  130. return ret;
  131. }
  132. #endif /* MBEDTLS_BIGNUM_C */
  133. int mbedtls_asn1_write_null(unsigned char **p, unsigned char *start)
  134. {
  135. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  136. size_t len = 0;
  137. // Write NULL
  138. //
  139. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, 0));
  140. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_NULL));
  141. return (int) len;
  142. }
  143. int mbedtls_asn1_write_oid(unsigned char **p, unsigned char *start,
  144. const char *oid, size_t oid_len)
  145. {
  146. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  147. size_t len = 0;
  148. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_raw_buffer(p, start,
  149. (const unsigned char *) oid, oid_len));
  150. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  151. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_OID));
  152. return (int) len;
  153. }
  154. int mbedtls_asn1_write_algorithm_identifier(unsigned char **p, unsigned char *start,
  155. const char *oid, size_t oid_len,
  156. size_t par_len)
  157. {
  158. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  159. size_t len = 0;
  160. if (par_len == 0) {
  161. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_null(p, start));
  162. } else {
  163. len += par_len;
  164. }
  165. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_oid(p, start, oid, oid_len));
  166. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  167. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start,
  168. MBEDTLS_ASN1_CONSTRUCTED |
  169. MBEDTLS_ASN1_SEQUENCE));
  170. return (int) len;
  171. }
  172. int mbedtls_asn1_write_bool(unsigned char **p, unsigned char *start, int boolean)
  173. {
  174. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  175. size_t len = 0;
  176. if (*p - start < 1) {
  177. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  178. }
  179. *--(*p) = (boolean) ? 255 : 0;
  180. len++;
  181. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  182. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_BOOLEAN));
  183. return (int) len;
  184. }
  185. static int asn1_write_tagged_int(unsigned char **p, unsigned char *start, int val, int tag)
  186. {
  187. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  188. size_t len = 0;
  189. do {
  190. if (*p - start < 1) {
  191. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  192. }
  193. len += 1;
  194. *--(*p) = val & 0xff;
  195. val >>= 8;
  196. } while (val > 0);
  197. if (**p & 0x80) {
  198. if (*p - start < 1) {
  199. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  200. }
  201. *--(*p) = 0x00;
  202. len += 1;
  203. }
  204. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  205. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, tag));
  206. return (int) len;
  207. }
  208. int mbedtls_asn1_write_int(unsigned char **p, unsigned char *start, int val)
  209. {
  210. return asn1_write_tagged_int(p, start, val, MBEDTLS_ASN1_INTEGER);
  211. }
  212. int mbedtls_asn1_write_enum(unsigned char **p, unsigned char *start, int val)
  213. {
  214. return asn1_write_tagged_int(p, start, val, MBEDTLS_ASN1_ENUMERATED);
  215. }
  216. int mbedtls_asn1_write_tagged_string(unsigned char **p, unsigned char *start, int tag,
  217. const char *text, size_t text_len)
  218. {
  219. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  220. size_t len = 0;
  221. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_raw_buffer(p, start,
  222. (const unsigned char *) text,
  223. text_len));
  224. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  225. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, tag));
  226. return (int) len;
  227. }
  228. int mbedtls_asn1_write_utf8_string(unsigned char **p, unsigned char *start,
  229. const char *text, size_t text_len)
  230. {
  231. return mbedtls_asn1_write_tagged_string(p, start, MBEDTLS_ASN1_UTF8_STRING, text, text_len);
  232. }
  233. int mbedtls_asn1_write_printable_string(unsigned char **p, unsigned char *start,
  234. const char *text, size_t text_len)
  235. {
  236. return mbedtls_asn1_write_tagged_string(p, start, MBEDTLS_ASN1_PRINTABLE_STRING, text,
  237. text_len);
  238. }
  239. int mbedtls_asn1_write_ia5_string(unsigned char **p, unsigned char *start,
  240. const char *text, size_t text_len)
  241. {
  242. return mbedtls_asn1_write_tagged_string(p, start, MBEDTLS_ASN1_IA5_STRING, text, text_len);
  243. }
  244. int mbedtls_asn1_write_named_bitstring(unsigned char **p,
  245. unsigned char *start,
  246. const unsigned char *buf,
  247. size_t bits)
  248. {
  249. size_t unused_bits, byte_len;
  250. const unsigned char *cur_byte;
  251. unsigned char cur_byte_shifted;
  252. unsigned char bit;
  253. byte_len = (bits + 7) / 8;
  254. unused_bits = (byte_len * 8) - bits;
  255. /*
  256. * Named bitstrings require that trailing 0s are excluded in the encoding
  257. * of the bitstring. Trailing 0s are considered part of the 'unused' bits
  258. * when encoding this value in the first content octet
  259. */
  260. if (bits != 0) {
  261. cur_byte = buf + byte_len - 1;
  262. cur_byte_shifted = *cur_byte >> unused_bits;
  263. for (;;) {
  264. bit = cur_byte_shifted & 0x1;
  265. cur_byte_shifted >>= 1;
  266. if (bit != 0) {
  267. break;
  268. }
  269. bits--;
  270. if (bits == 0) {
  271. break;
  272. }
  273. if (bits % 8 == 0) {
  274. cur_byte_shifted = *--cur_byte;
  275. }
  276. }
  277. }
  278. return mbedtls_asn1_write_bitstring(p, start, buf, bits);
  279. }
  280. int mbedtls_asn1_write_bitstring(unsigned char **p, unsigned char *start,
  281. const unsigned char *buf, size_t bits)
  282. {
  283. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  284. size_t len = 0;
  285. size_t unused_bits, byte_len;
  286. byte_len = (bits + 7) / 8;
  287. unused_bits = (byte_len * 8) - bits;
  288. if (*p < start || (size_t) (*p - start) < byte_len + 1) {
  289. return MBEDTLS_ERR_ASN1_BUF_TOO_SMALL;
  290. }
  291. len = byte_len + 1;
  292. /* Write the bitstring. Ensure the unused bits are zeroed */
  293. if (byte_len > 0) {
  294. byte_len--;
  295. *--(*p) = buf[byte_len] & ~((0x1 << unused_bits) - 1);
  296. (*p) -= byte_len;
  297. memcpy(*p, buf, byte_len);
  298. }
  299. /* Write unused bits */
  300. *--(*p) = (unsigned char) unused_bits;
  301. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  302. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_BIT_STRING));
  303. return (int) len;
  304. }
  305. int mbedtls_asn1_write_octet_string(unsigned char **p, unsigned char *start,
  306. const unsigned char *buf, size_t size)
  307. {
  308. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  309. size_t len = 0;
  310. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_raw_buffer(p, start, buf, size));
  311. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_len(p, start, len));
  312. MBEDTLS_ASN1_CHK_ADD(len, mbedtls_asn1_write_tag(p, start, MBEDTLS_ASN1_OCTET_STRING));
  313. return (int) len;
  314. }
  315. /* This is a copy of the ASN.1 parsing function mbedtls_asn1_find_named_data(),
  316. * which is replicated to avoid a dependency ASN1_WRITE_C on ASN1_PARSE_C. */
  317. static mbedtls_asn1_named_data *asn1_find_named_data(
  318. mbedtls_asn1_named_data *list,
  319. const char *oid, size_t len)
  320. {
  321. while (list != NULL) {
  322. if (list->oid.len == len &&
  323. memcmp(list->oid.p, oid, len) == 0) {
  324. break;
  325. }
  326. list = list->next;
  327. }
  328. return list;
  329. }
  330. mbedtls_asn1_named_data *mbedtls_asn1_store_named_data(
  331. mbedtls_asn1_named_data **head,
  332. const char *oid, size_t oid_len,
  333. const unsigned char *val,
  334. size_t val_len)
  335. {
  336. mbedtls_asn1_named_data *cur;
  337. if ((cur = asn1_find_named_data(*head, oid, oid_len)) == NULL) {
  338. // Add new entry if not present yet based on OID
  339. //
  340. cur = (mbedtls_asn1_named_data *) mbedtls_calloc(1,
  341. sizeof(mbedtls_asn1_named_data));
  342. if (cur == NULL) {
  343. return NULL;
  344. }
  345. cur->oid.len = oid_len;
  346. cur->oid.p = mbedtls_calloc(1, oid_len);
  347. if (cur->oid.p == NULL) {
  348. mbedtls_free(cur);
  349. return NULL;
  350. }
  351. memcpy(cur->oid.p, oid, oid_len);
  352. cur->val.len = val_len;
  353. if (val_len != 0) {
  354. cur->val.p = mbedtls_calloc(1, val_len);
  355. if (cur->val.p == NULL) {
  356. mbedtls_free(cur->oid.p);
  357. mbedtls_free(cur);
  358. return NULL;
  359. }
  360. }
  361. cur->next = *head;
  362. *head = cur;
  363. } else if (val_len == 0) {
  364. mbedtls_free(cur->val.p);
  365. cur->val.p = NULL;
  366. } else if (cur->val.len != val_len) {
  367. /*
  368. * Enlarge existing value buffer if needed
  369. * Preserve old data until the allocation succeeded, to leave list in
  370. * a consistent state in case allocation fails.
  371. */
  372. void *p = mbedtls_calloc(1, val_len);
  373. if (p == NULL) {
  374. return NULL;
  375. }
  376. mbedtls_free(cur->val.p);
  377. cur->val.p = p;
  378. cur->val.len = val_len;
  379. }
  380. if (val != NULL && val_len != 0) {
  381. memcpy(cur->val.p, val, val_len);
  382. }
  383. return cur;
  384. }
  385. #endif /* MBEDTLS_ASN1_WRITE_C */