2 * Copyright (c) 2004 - 2009 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @page page_name PKIX/X.509 Names
40 * There are several names in PKIX/X.509, GeneralName and Name.
42 * A Name consists of an ordered list of Relative Distinguished Names
43 * (RDN). Each RDN consists of an unordered list of typed strings. The
44 * types are defined by OID and have long and short description. For
45 * example id-at-commonName (2.5.4.3) have the long name CommonName
46 * and short name CN. The string itself can be of serveral encoding,
47 * UTF8, UTF16, Teltex string, etc. The type limit what encoding
50 * GeneralName is a broader nametype that can contains al kind of
51 * stuff like Name, IP addresses, partial Name, etc.
53 * Name is mapped into a hx509_name object.
55 * Parse and string name into a hx509_name object with hx509_parse_name(),
56 * make it back into string representation with hx509_name_to_string().
58 * Name string are defined rfc2253, rfc1779 and X.501.
60 * See the library functions here: @ref hx509_name
66 wind_profile_flags flags;
68 { "C", &asn1_oid_id_at_countryName },
69 { "CN", &asn1_oid_id_at_commonName },
70 { "DC", &asn1_oid_id_domainComponent },
71 { "L", &asn1_oid_id_at_localityName },
72 { "O", &asn1_oid_id_at_organizationName },
73 { "OU", &asn1_oid_id_at_organizationalUnitName },
74 { "S", &asn1_oid_id_at_stateOrProvinceName },
75 { "STREET", &asn1_oid_id_at_streetAddress },
76 { "UID", &asn1_oid_id_Userid },
77 { "emailAddress", &asn1_oid_id_pkcs9_emailAddress },
78 { "serialNumber", &asn1_oid_id_at_serialNumber }
82 quote_string(const char *f, size_t len, size_t *rlen)
93 for (i = 0, j = 0; i < len; i++) {
94 if (from[i] == ' ' && i + 1 < len)
96 else if (from[i] == ',' || from[i] == '=' || from[i] == '+' ||
97 from[i] == '<' || from[i] == '>' || from[i] == '#' ||
98 from[i] == ';' || from[i] == ' ')
102 } else if (((unsigned char)from[i]) >= 32 && ((unsigned char)from[i]) <= 127) {
105 int l = snprintf(&to[j], tolen - j - 1,
106 "#%02x", (unsigned char)from[i]);
118 append_string(char **str, size_t *total_len, const char *ss,
119 size_t len, int quote)
124 qs = quote_string(ss, len, &len);
128 s = realloc(*str, len + *total_len + 1);
130 _hx509_abort("allocation failure"); /* XXX */
131 memcpy(s + *total_len, qs, len);
134 s[*total_len + len] = '\0';
141 oidtostring(const heim_oid *type)
146 for (i = 0; i < sizeof(no)/sizeof(no[0]); i++) {
147 if (der_heim_oid_cmp(no[i].o, type) == 0)
148 return strdup(no[i].n);
150 if (der_print_heim_oid(type, '.', &s) != 0)
156 stringtooid(const char *name, size_t len, heim_oid *oid)
161 memset(oid, 0, sizeof(*oid));
163 for (i = 0; i < sizeof(no)/sizeof(no[0]); i++) {
164 if (strncasecmp(no[i].n, name, len) == 0)
165 return der_copy_oid(no[i].o, oid);
170 memcpy(s, name, len);
172 ret = der_parse_heim_oid(s, ".", oid);
178 * Convert the hx509 name object into a printable string.
179 * The resulting string should be freed with free().
181 * @param name name to print
182 * @param str the string to return
184 * @return An hx509 error code, see hx509_get_error_string().
186 * @ingroup hx509_name
190 hx509_name_to_string(const hx509_name name, char **str)
192 return _hx509_Name_to_string(&name->der_name, str);
196 _hx509_Name_to_string(const Name *n, char **str)
198 size_t total_len = 0;
205 for (i = n->u.rdnSequence.len - 1 ; i >= 0 ; i--) {
208 for (j = 0; j < n->u.rdnSequence.val[i].len; j++) {
209 DirectoryString *ds = &n->u.rdnSequence.val[i].val[j].value;
213 oidname = oidtostring(&n->u.rdnSequence.val[i].val[j].type);
215 switch(ds->element) {
216 case choice_DirectoryString_ia5String:
217 ss = ds->u.ia5String;
219 case choice_DirectoryString_printableString:
220 ss = ds->u.printableString;
222 case choice_DirectoryString_utf8String:
223 ss = ds->u.utf8String;
225 case choice_DirectoryString_bmpString: {
226 const uint16_t *bmp = ds->u.bmpString.data;
227 size_t bmplen = ds->u.bmpString.length;
230 ret = wind_ucs2utf8_length(bmp, bmplen, &k);
236 _hx509_abort("allocation failure"); /* XXX */
237 ret = wind_ucs2utf8(bmp, bmplen, ss, NULL);
245 case choice_DirectoryString_teletexString:
246 ss = ds->u.teletexString;
248 case choice_DirectoryString_universalString: {
249 const uint32_t *uni = ds->u.universalString.data;
250 size_t unilen = ds->u.universalString.length;
253 ret = wind_ucs4utf8_length(uni, unilen, &k);
259 _hx509_abort("allocation failure"); /* XXX */
260 ret = wind_ucs4utf8(uni, unilen, ss, NULL);
269 _hx509_abort("unknown directory type: %d", ds->element);
272 append_string(str, &total_len, oidname, strlen(oidname), 0);
274 append_string(str, &total_len, "=", 1, 0);
276 append_string(str, &total_len, ss, len, 1);
277 if (ds->element == choice_DirectoryString_universalString ||
278 ds->element == choice_DirectoryString_bmpString)
282 if (j + 1 < n->u.rdnSequence.val[i].len)
283 append_string(str, &total_len, "+", 1, 0);
287 append_string(str, &total_len, ",", 1, 0);
292 #define COPYCHARARRAY(_ds,_el,_l,_n) \
293 (_l) = strlen(_ds->u._el); \
294 (_n) = malloc((_l) * sizeof((_n)[0])); \
297 for (i = 0; i < (_l); i++) \
298 (_n)[i] = _ds->u._el[i]
301 #define COPYVALARRAY(_ds,_el,_l,_n) \
302 (_l) = _ds->u._el.length; \
303 (_n) = malloc((_l) * sizeof((_n)[0])); \
306 for (i = 0; i < (_l); i++) \
307 (_n)[i] = _ds->u._el.data[i]
309 #define COPYVOIDARRAY(_ds,_el,_l,_n) \
310 (_l) = _ds->u._el.length; \
311 (_n) = malloc((_l) * sizeof((_n)[0])); \
314 for (i = 0; i < (_l); i++) \
315 (_n)[i] = ((unsigned char *)_ds->u._el.data)[i]
320 dsstringprep(const DirectoryString *ds, uint32_t **rname, size_t *rlen)
322 wind_profile_flags flags = 0;
330 switch(ds->element) {
331 case choice_DirectoryString_ia5String:
332 COPYCHARARRAY(ds, ia5String, len, name);
334 case choice_DirectoryString_printableString:
335 flags = WIND_PROFILE_LDAP_CASE_EXACT_ATTRIBUTE;
336 COPYCHARARRAY(ds, printableString, len, name);
338 case choice_DirectoryString_teletexString:
339 COPYCHARARRAY(ds, teletexString, len, name);
341 case choice_DirectoryString_bmpString:
342 COPYVALARRAY(ds, bmpString, len, name);
344 case choice_DirectoryString_universalString:
345 COPYVALARRAY(ds, universalString, len, name);
347 case choice_DirectoryString_utf8String:
348 ret = wind_utf8ucs4_length(ds->u.utf8String, &len);
351 name = malloc(len * sizeof(name[0]));
354 ret = wind_utf8ucs4(ds->u.utf8String, name, &len);
361 _hx509_abort("unknown directory type: %d", ds->element);
365 /* try a couple of times to get the length right, XXX gross */
366 for (i = 0; i < 4; i++) {
368 *rname = malloc(*rlen * sizeof((*rname)[0]));
370 ret = wind_stringprep(name, len, *rname, rlen,
371 WIND_PROFILE_LDAP|flags);
372 if (ret == WIND_ERR_OVERRUN) {
392 _hx509_name_ds_cmp(const DirectoryString *ds1,
393 const DirectoryString *ds2,
396 uint32_t *ds1lp, *ds2lp;
397 size_t ds1len, ds2len, i;
400 ret = dsstringprep(ds1, &ds1lp, &ds1len);
403 ret = dsstringprep(ds2, &ds2lp, &ds2len);
409 if (ds1len != ds2len)
410 *diff = ds1len - ds2len;
412 for (i = 0; i < ds1len; i++) {
413 *diff = ds1lp[i] - ds2lp[i];
425 _hx509_name_cmp(const Name *n1, const Name *n2, int *c)
429 *c = n1->u.rdnSequence.len - n2->u.rdnSequence.len;
433 for (i = 0 ; i < n1->u.rdnSequence.len; i++) {
434 *c = n1->u.rdnSequence.val[i].len - n2->u.rdnSequence.val[i].len;
438 for (j = 0; j < n1->u.rdnSequence.val[i].len; j++) {
439 *c = der_heim_oid_cmp(&n1->u.rdnSequence.val[i].val[j].type,
440 &n1->u.rdnSequence.val[i].val[j].type);
444 ret = _hx509_name_ds_cmp(&n1->u.rdnSequence.val[i].val[j].value,
445 &n2->u.rdnSequence.val[i].val[j].value,
458 * Compare to hx509 name object, useful for sorting.
460 * @param n1 a hx509 name object.
461 * @param n2 a hx509 name object.
463 * @return 0 the objects are the same, returns > 0 is n2 is "larger"
464 * then n2, < 0 if n1 is "smaller" then n2.
466 * @ingroup hx509_name
470 hx509_name_cmp(hx509_name n1, hx509_name n2)
473 ret = _hx509_name_cmp(&n1->der_name, &n2->der_name, &diff);
481 _hx509_name_from_Name(const Name *n, hx509_name *name)
484 *name = calloc(1, sizeof(**name));
487 ret = copy_Name(n, &(*name)->der_name);
496 _hx509_name_modify(hx509_context context,
502 RelativeDistinguishedName *rdn;
506 ptr = realloc(name->u.rdnSequence.val,
507 sizeof(name->u.rdnSequence.val[0]) *
508 (name->u.rdnSequence.len + 1));
510 hx509_set_error_string(context, 0, ENOMEM, "Out of memory");
513 name->u.rdnSequence.val = ptr;
516 rdn = &name->u.rdnSequence.val[name->u.rdnSequence.len];
518 memmove(&name->u.rdnSequence.val[1],
519 &name->u.rdnSequence.val[0],
520 name->u.rdnSequence.len *
521 sizeof(name->u.rdnSequence.val[0]));
523 rdn = &name->u.rdnSequence.val[0];
525 rdn->val = malloc(sizeof(rdn->val[0]));
526 if (rdn->val == NULL)
529 ret = der_copy_oid(oid, &rdn->val[0].type);
532 rdn->val[0].value.element = choice_DirectoryString_utf8String;
533 rdn->val[0].value.u.utf8String = strdup(str);
534 if (rdn->val[0].value.u.utf8String == NULL)
536 name->u.rdnSequence.len += 1;
542 * Parse a string into a hx509 name object.
544 * @param context A hx509 context.
545 * @param str a string to parse.
546 * @param name the resulting object, NULL in case of error.
548 * @return An hx509 error code, see hx509_get_error_string().
550 * @ingroup hx509_name
554 hx509_parse_name(hx509_context context, const char *str, hx509_name *name)
563 n = calloc(1, sizeof(*n));
565 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
569 n->der_name.element = choice_Name_rdnSequence;
573 while (p != NULL && *p != '\0') {
588 ret = HX509_PARSING_NAME_FAILED;
589 hx509_set_error_string(context, 0, ret, "missing = in %s", p);
593 ret = HX509_PARSING_NAME_FAILED;
594 hx509_set_error_string(context, 0, ret,
595 "missing name before = in %s", p);
600 ret = HX509_PARSING_NAME_FAILED;
601 hx509_set_error_string(context, 0, ret, " = after , in %s", p);
605 ret = stringtooid(p, q - p, &oid);
607 ret = HX509_PARSING_NAME_FAILED;
608 hx509_set_error_string(context, 0, ret,
609 "unknown type: %.*s", (int)(q - p), p);
614 size_t pstr_len = len - (q - p) - 1;
615 const char *pstr = p + (q - p) + 1;
618 r = malloc(pstr_len + 1);
622 hx509_set_error_string(context, 0, ret, "out of memory");
625 memcpy(r, pstr, pstr_len);
628 ret = _hx509_name_modify(context, &n->der_name, 0, &oid, r);
642 return HX509_NAME_MALFORMED;
646 * Copy a hx509 name object.
648 * @param context A hx509 cotext.
649 * @param from the name to copy from
650 * @param to the name to copy to
652 * @return An hx509 error code, see hx509_get_error_string().
654 * @ingroup hx509_name
658 hx509_name_copy(hx509_context context, const hx509_name from, hx509_name *to)
662 *to = calloc(1, sizeof(**to));
665 ret = copy_Name(&from->der_name, &(*to)->der_name);
675 * Convert a hx509_name into a Name.
677 * @param from the name to copy from
678 * @param to the name to copy to
680 * @return An hx509 error code, see hx509_get_error_string().
682 * @ingroup hx509_name
686 hx509_name_to_Name(const hx509_name from, Name *to)
688 return copy_Name(&from->der_name, to);
692 hx509_name_normalize(hx509_context context, hx509_name name)
698 * Expands variables in the name using env. Variables are on the form
699 * ${name}. Useful when dealing with certificate templates.
701 * @param context A hx509 cotext.
702 * @param name the name to expand.
703 * @param env environment variable to expand.
705 * @return An hx509 error code, see hx509_get_error_string().
707 * @ingroup hx509_name
711 hx509_name_expand(hx509_context context,
715 Name *n = &name->der_name;
721 if (n->element != choice_Name_rdnSequence) {
722 hx509_set_error_string(context, 0, EINVAL, "RDN not of supported type");
726 for (i = 0 ; i < n->u.rdnSequence.len; i++) {
727 for (j = 0; j < n->u.rdnSequence.val[i].len; j++) {
728 /** Only UTF8String rdnSequence names are allowed */
730 THIS SHOULD REALLY BE:
731 COMP = n->u.rdnSequence.val[i].val[j];
732 normalize COMP to utf8
733 check if there are variables
735 convert back to orignal format, store in COMP
736 free normalized utf8 string
738 DirectoryString *ds = &n->u.rdnSequence.val[i].val[j].value;
740 struct rk_strpool *strpool = NULL;
742 if (ds->element != choice_DirectoryString_utf8String) {
743 hx509_set_error_string(context, 0, EINVAL, "unsupported type");
746 p = strstr(ds->u.utf8String, "${");
748 strpool = rk_strpoolprintf(strpool, "%.*s",
749 (int)(p - ds->u.utf8String),
751 if (strpool == NULL) {
752 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
757 /* expand variables */
761 hx509_set_error_string(context, 0, EINVAL, "missing }");
762 rk_strpoolfree(strpool);
766 value = hx509_env_lfind(context, env, p, p2 - p);
768 hx509_set_error_string(context, 0, EINVAL,
769 "variable %.*s missing",
771 rk_strpoolfree(strpool);
774 strpool = rk_strpoolprintf(strpool, "%s", value);
775 if (strpool == NULL) {
776 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
781 p = strstr(p2, "${");
783 strpool = rk_strpoolprintf(strpool, "%.*s",
786 strpool = rk_strpoolprintf(strpool, "%s", p2);
787 if (strpool == NULL) {
788 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
793 free(ds->u.utf8String);
794 ds->u.utf8String = rk_strpoolcollect(strpool);
795 if (ds->u.utf8String == NULL) {
796 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
806 * Free a hx509 name object, upond return *name will be NULL.
808 * @param name a hx509 name object to be freed.
810 * @ingroup hx509_name
814 hx509_name_free(hx509_name *name)
816 free_Name(&(*name)->der_name);
817 memset(*name, 0, sizeof(**name));
823 * Convert a DER encoded name info a string.
825 * @param data data to a DER/BER encoded name
826 * @param length length of data
827 * @param str the resulting string, is NULL on failure.
829 * @return An hx509 error code, see hx509_get_error_string().
831 * @ingroup hx509_name
835 hx509_unparse_der_name(const void *data, size_t length, char **str)
842 ret = decode_Name(data, length, &name, NULL);
845 ret = _hx509_Name_to_string(&name, str);
851 * Convert a hx509_name object to DER encoded name.
853 * @param name name to concert
854 * @param os data to a DER encoded name, free the resulting octet
855 * string with hx509_xfree(os->data).
857 * @return An hx509 error code, see hx509_get_error_string().
859 * @ingroup hx509_name
863 hx509_name_binary(const hx509_name name, heim_octet_string *os)
868 ASN1_MALLOC_ENCODE(Name, os->data, os->length, &name->der_name, &size, ret);
871 if (os->length != size)
872 _hx509_abort("internal ASN.1 encoder error");
878 _hx509_unparse_Name(const Name *aname, char **str)
883 ret = _hx509_name_from_Name(aname, &name);
887 ret = hx509_name_to_string(name, str);
888 hx509_name_free(&name);
893 * Unparse the hx509 name in name into a string.
895 * @param name the name to check if its empty/null.
897 * @return non zero if the name is empty/null.
899 * @ingroup hx509_name
903 hx509_name_is_null_p(const hx509_name name)
905 return name->der_name.u.rdnSequence.len == 0;
909 * Unparse the hx509 name in name into a string.
911 * @param name the name to print
912 * @param str an allocated string returns the name in string form
914 * @return An hx509 error code, see hx509_get_error_string().
916 * @ingroup hx509_name
920 hx509_general_name_unparse(GeneralName *name, char **str)
922 struct rk_strpool *strpool = NULL;
926 switch (name->element) {
927 case choice_GeneralName_otherName: {
929 hx509_oid_sprint(&name->u.otherName.type_id, &oid);
932 strpool = rk_strpoolprintf(strpool, "otherName: %s", oid);
936 case choice_GeneralName_rfc822Name:
937 strpool = rk_strpoolprintf(strpool, "rfc822Name: %s\n",
940 case choice_GeneralName_dNSName:
941 strpool = rk_strpoolprintf(strpool, "dNSName: %s\n",
944 case choice_GeneralName_directoryName: {
948 memset(&dir, 0, sizeof(dir));
949 dir.element = name->u.directoryName.element;
950 dir.u.rdnSequence = name->u.directoryName.u.rdnSequence;
951 ret = _hx509_unparse_Name(&dir, &s);
954 strpool = rk_strpoolprintf(strpool, "directoryName: %s", s);
958 case choice_GeneralName_uniformResourceIdentifier:
959 strpool = rk_strpoolprintf(strpool, "URI: %s",
960 name->u.uniformResourceIdentifier);
962 case choice_GeneralName_iPAddress: {
963 unsigned char *a = name->u.iPAddress.data;
965 strpool = rk_strpoolprintf(strpool, "IPAddress: ");
968 if (name->u.iPAddress.length == 4)
969 strpool = rk_strpoolprintf(strpool, "%d.%d.%d.%d",
970 a[0], a[1], a[2], a[3]);
971 else if (name->u.iPAddress.length == 16)
972 strpool = rk_strpoolprintf(strpool,
973 "%02X:%02X:%02X:%02X:"
974 "%02X:%02X:%02X:%02X:"
975 "%02X:%02X:%02X:%02X:"
976 "%02X:%02X:%02X:%02X",
977 a[0], a[1], a[2], a[3],
978 a[4], a[5], a[6], a[7],
979 a[8], a[9], a[10], a[11],
980 a[12], a[13], a[14], a[15]);
982 strpool = rk_strpoolprintf(strpool,
983 "unknown IP address of length %lu",
984 (unsigned long)name->u.iPAddress.length);
987 case choice_GeneralName_registeredID: {
989 hx509_oid_sprint(&name->u.registeredID, &oid);
992 strpool = rk_strpoolprintf(strpool, "registeredID: %s", oid);
1002 *str = rk_strpoolcollect(strpool);