2 * Copyright (c) 2004 - 2007 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
35 __RCSID("$Heimdal: name.c 22432 2008-01-13 14:08:03Z lha $"
39 * @page page_name PKIX/X.509 Names
41 * There are several names in PKIX/X.509, GeneralName and Name.
43 * A Name consists of an ordered list of Relative Distinguished Names
44 * (RDN). Each RDN consists of an unordered list of typed strings. The
45 * types are defined by OID and have long and short description. For
46 * example id-at-commonName (2.5.4.3) have the long name CommonName
47 * and short name CN. The string itself can be of serveral encoding,
48 * UTF8, UTF16, Teltex string, etc. The type limit what encoding
51 * GeneralName is a broader nametype that can contains al kind of
52 * stuff like Name, IP addresses, partial Name, etc.
54 * Name is mapped into a hx509_name object.
56 * Parse and string name into a hx509_name object with hx509_parse_name(),
57 * make it back into string representation with hx509_name_to_string().
59 * Name string are defined rfc2253, rfc1779 and X.501.
61 * See the library functions here: @ref hx509_name
66 const heim_oid
*(*o
)(void);
68 { "C", oid_id_at_countryName
},
69 { "CN", oid_id_at_commonName
},
70 { "DC", oid_id_domainComponent
},
71 { "L", oid_id_at_localityName
},
72 { "O", oid_id_at_organizationName
},
73 { "OU", oid_id_at_organizationalUnitName
},
74 { "S", oid_id_at_stateOrProvinceName
},
75 { "STREET", oid_id_at_streetAddress
},
76 { "UID", oid_id_Userid
},
77 { "emailAddress", oid_id_pkcs9_emailAddress
},
78 { "serialNumber", 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 uint16_t *bmp
= ds
->u
.bmpString
.data
;
227 size_t bmplen
= ds
->u
.bmpString
.length
;
230 ss
= malloc(bmplen
+ 1);
232 _hx509_abort("allocation failure"); /* XXX */
233 for (k
= 0; k
< bmplen
; k
++)
234 ss
[k
] = bmp
[k
] & 0xff; /* XXX */
238 case choice_DirectoryString_teletexString
:
239 ss
= malloc(ds
->u
.teletexString
.length
+ 1);
241 _hx509_abort("allocation failure"); /* XXX */
242 memcpy(ss
, ds
->u
.teletexString
.data
, ds
->u
.teletexString
.length
);
243 ss
[ds
->u
.teletexString
.length
] = '\0';
245 case choice_DirectoryString_universalString
: {
246 uint32_t *uni
= ds
->u
.universalString
.data
;
247 size_t unilen
= ds
->u
.universalString
.length
;
250 ss
= malloc(unilen
+ 1);
252 _hx509_abort("allocation failure"); /* XXX */
253 for (k
= 0; k
< unilen
; k
++)
254 ss
[k
] = uni
[k
] & 0xff; /* XXX */
259 _hx509_abort("unknown directory type: %d", ds
->element
);
262 append_string(str
, &total_len
, oidname
, strlen(oidname
), 0);
264 append_string(str
, &total_len
, "=", 1, 0);
266 append_string(str
, &total_len
, ss
, len
, 1);
267 if (ds
->element
== choice_DirectoryString_universalString
||
268 ds
->element
== choice_DirectoryString_bmpString
||
269 ds
->element
== choice_DirectoryString_teletexString
)
273 if (j
+ 1 < n
->u
.rdnSequence
.val
[i
].len
)
274 append_string(str
, &total_len
, "+", 1, 0);
278 append_string(str
, &total_len
, ",", 1, 0);
284 * XXX this function is broken, it needs to compare code points, not
289 prune_space(const unsigned char **s
)
296 _hx509_name_ds_cmp(const DirectoryString
*ds1
, const DirectoryString
*ds2
)
300 c
= ds1
->element
- ds2
->element
;
304 switch(ds1
->element
) {
305 case choice_DirectoryString_ia5String
:
306 c
= strcmp(ds1
->u
.ia5String
, ds2
->u
.ia5String
);
308 case choice_DirectoryString_teletexString
:
309 c
= der_heim_octet_string_cmp(&ds1
->u
.teletexString
,
310 &ds2
->u
.teletexString
);
312 case choice_DirectoryString_printableString
: {
313 const unsigned char *s1
= (unsigned char*)ds1
->u
.printableString
;
314 const unsigned char *s2
= (unsigned char*)ds2
->u
.printableString
;
315 prune_space(&s1
); prune_space(&s2
);
317 if (toupper(*s1
) != toupper(*s2
)) {
318 c
= toupper(*s1
) - toupper(*s2
);
321 if (*s1
== ' ') { prune_space(&s1
); prune_space(&s2
); }
324 prune_space(&s1
); prune_space(&s2
);
328 case choice_DirectoryString_utf8String
:
329 c
= strcmp(ds1
->u
.utf8String
, ds2
->u
.utf8String
);
331 case choice_DirectoryString_universalString
:
332 c
= der_heim_universal_string_cmp(&ds1
->u
.universalString
,
333 &ds2
->u
.universalString
);
335 case choice_DirectoryString_bmpString
:
336 c
= der_heim_bmp_string_cmp(&ds1
->u
.bmpString
,
347 _hx509_name_cmp(const Name
*n1
, const Name
*n2
)
351 c
= n1
->u
.rdnSequence
.len
- n2
->u
.rdnSequence
.len
;
355 for (i
= 0 ; i
< n1
->u
.rdnSequence
.len
; i
++) {
356 c
= n1
->u
.rdnSequence
.val
[i
].len
- n2
->u
.rdnSequence
.val
[i
].len
;
360 for (j
= 0; j
< n1
->u
.rdnSequence
.val
[i
].len
; j
++) {
361 c
= der_heim_oid_cmp(&n1
->u
.rdnSequence
.val
[i
].val
[j
].type
,
362 &n1
->u
.rdnSequence
.val
[i
].val
[j
].type
);
366 c
= _hx509_name_ds_cmp(&n1
->u
.rdnSequence
.val
[i
].val
[j
].value
,
367 &n2
->u
.rdnSequence
.val
[i
].val
[j
].value
);
376 * Compare to hx509 name object, useful for sorting.
378 * @param n1 a hx509 name object.
379 * @param n2 a hx509 name object.
381 * @return 0 the objects are the same, returns > 0 is n2 is "larger"
382 * then n2, < 0 if n1 is "smaller" then n2.
384 * @ingroup hx509_name
388 hx509_name_cmp(hx509_name n1
, hx509_name n2
)
390 return _hx509_name_cmp(&n1
->der_name
, &n2
->der_name
);
395 _hx509_name_from_Name(const Name
*n
, hx509_name
*name
)
398 *name
= calloc(1, sizeof(**name
));
401 ret
= copy_Name(n
, &(*name
)->der_name
);
410 _hx509_name_modify(hx509_context context
,
416 RelativeDistinguishedName
*rdn
;
420 ptr
= realloc(name
->u
.rdnSequence
.val
,
421 sizeof(name
->u
.rdnSequence
.val
[0]) *
422 (name
->u
.rdnSequence
.len
+ 1));
424 hx509_set_error_string(context
, 0, ENOMEM
, "Out of memory");
427 name
->u
.rdnSequence
.val
= ptr
;
430 rdn
= &name
->u
.rdnSequence
.val
[name
->u
.rdnSequence
.len
];
432 memmove(&name
->u
.rdnSequence
.val
[1],
433 &name
->u
.rdnSequence
.val
[0],
434 name
->u
.rdnSequence
.len
*
435 sizeof(name
->u
.rdnSequence
.val
[0]));
437 rdn
= &name
->u
.rdnSequence
.val
[0];
439 rdn
->val
= malloc(sizeof(rdn
->val
[0]));
440 if (rdn
->val
== NULL
)
443 ret
= der_copy_oid(oid
, &rdn
->val
[0].type
);
446 rdn
->val
[0].value
.element
= choice_DirectoryString_utf8String
;
447 rdn
->val
[0].value
.u
.utf8String
= strdup(str
);
448 if (rdn
->val
[0].value
.u
.utf8String
== NULL
)
450 name
->u
.rdnSequence
.len
+= 1;
456 * Parse a string into a hx509 name object.
458 * @param context A hx509 context.
459 * @param str a string to parse.
460 * @param name the resulting object, NULL in case of error.
462 * @return An hx509 error code, see hx509_get_error_string().
464 * @ingroup hx509_name
468 hx509_parse_name(hx509_context context
, const char *str
, hx509_name
*name
)
477 n
= calloc(1, sizeof(*n
));
479 hx509_set_error_string(context
, 0, ENOMEM
, "out of memory");
483 n
->der_name
.element
= choice_Name_rdnSequence
;
487 while (p
!= NULL
&& *p
!= '\0') {
502 ret
= HX509_PARSING_NAME_FAILED
;
503 hx509_set_error_string(context
, 0, ret
, "missing = in %s", p
);
507 ret
= HX509_PARSING_NAME_FAILED
;
508 hx509_set_error_string(context
, 0, ret
,
509 "missing name before = in %s", p
);
514 ret
= HX509_PARSING_NAME_FAILED
;
515 hx509_set_error_string(context
, 0, ret
, " = after , in %s", p
);
519 ret
= stringtooid(p
, q
- p
, &oid
);
521 ret
= HX509_PARSING_NAME_FAILED
;
522 hx509_set_error_string(context
, 0, ret
,
523 "unknown type: %.*s", (int)(q
- p
), p
);
528 size_t pstr_len
= len
- (q
- p
) - 1;
529 const char *pstr
= p
+ (q
- p
) + 1;
532 r
= malloc(pstr_len
+ 1);
536 hx509_set_error_string(context
, 0, ret
, "out of memory");
539 memcpy(r
, pstr
, pstr_len
);
542 ret
= _hx509_name_modify(context
, &n
->der_name
, 0, &oid
, r
);
556 return HX509_NAME_MALFORMED
;
560 * Copy a hx509 name object.
562 * @param context A hx509 cotext.
563 * @param from the name to copy from
564 * @param to the name to copy to
566 * @return An hx509 error code, see hx509_get_error_string().
568 * @ingroup hx509_name
572 hx509_name_copy(hx509_context context
, const hx509_name from
, hx509_name
*to
)
576 *to
= calloc(1, sizeof(**to
));
579 ret
= copy_Name(&from
->der_name
, &(*to
)->der_name
);
589 * Convert a hx509_name into a Name.
591 * @param from the name to copy from
592 * @param to the name to copy to
594 * @return An hx509 error code, see hx509_get_error_string().
596 * @ingroup hx509_name
600 hx509_name_to_Name(const hx509_name from
, Name
*to
)
602 return copy_Name(&from
->der_name
, to
);
606 hx509_name_normalize(hx509_context context
, hx509_name name
)
612 * Expands variables in the name using env. Variables are on the form
613 * ${name}. Useful when dealing with certificate templates.
615 * @param context A hx509 cotext.
616 * @param name the name to expand.
617 * @param env environment variable to expand.
619 * @return An hx509 error code, see hx509_get_error_string().
621 * @ingroup hx509_name
625 hx509_name_expand(hx509_context context
,
629 Name
*n
= &name
->der_name
;
635 if (n
->element
!= choice_Name_rdnSequence
) {
636 hx509_set_error_string(context
, 0, EINVAL
, "RDN not of supported type");
640 for (i
= 0 ; i
< n
->u
.rdnSequence
.len
; i
++) {
641 for (j
= 0; j
< n
->u
.rdnSequence
.val
[i
].len
; j
++) {
642 /** Only UTF8String rdnSequence names are allowed */
644 THIS SHOULD REALLY BE:
645 COMP = n->u.rdnSequence.val[i].val[j];
646 normalize COMP to utf8
647 check if there are variables
649 convert back to orignal format, store in COMP
650 free normalized utf8 string
652 DirectoryString
*ds
= &n
->u
.rdnSequence
.val
[i
].val
[j
].value
;
654 struct rk_strpool
*strpool
= NULL
;
656 if (ds
->element
!= choice_DirectoryString_utf8String
) {
657 hx509_set_error_string(context
, 0, EINVAL
, "unsupported type");
660 p
= strstr(ds
->u
.utf8String
, "${");
662 strpool
= rk_strpoolprintf(strpool
, "%.*s",
663 (int)(p
- ds
->u
.utf8String
),
665 if (strpool
== NULL
) {
666 hx509_set_error_string(context
, 0, ENOMEM
, "out of memory");
671 /* expand variables */
675 hx509_set_error_string(context
, 0, EINVAL
, "missing }");
676 rk_strpoolfree(strpool
);
680 value
= hx509_env_lfind(context
, env
, p
, p2
- p
);
682 hx509_set_error_string(context
, 0, EINVAL
,
683 "variable %.*s missing",
685 rk_strpoolfree(strpool
);
688 strpool
= rk_strpoolprintf(strpool
, "%s", value
);
689 if (strpool
== NULL
) {
690 hx509_set_error_string(context
, 0, ENOMEM
, "out of memory");
695 p
= strstr(p2
, "${");
697 strpool
= rk_strpoolprintf(strpool
, "%.*s",
700 strpool
= rk_strpoolprintf(strpool
, "%s", p2
);
701 if (strpool
== NULL
) {
702 hx509_set_error_string(context
, 0, ENOMEM
, "out of memory");
707 free(ds
->u
.utf8String
);
708 ds
->u
.utf8String
= rk_strpoolcollect(strpool
);
709 if (ds
->u
.utf8String
== NULL
) {
710 hx509_set_error_string(context
, 0, ENOMEM
, "out of memory");
720 * Free a hx509 name object, upond return *name will be NULL.
722 * @param name a hx509 name object to be freed.
724 * @ingroup hx509_name
728 hx509_name_free(hx509_name
*name
)
730 free_Name(&(*name
)->der_name
);
731 memset(*name
, 0, sizeof(**name
));
737 * Convert a DER encoded name info a string.
739 * @param data data to a DER/BER encoded name
740 * @param length length of data
741 * @param str the resulting string, is NULL on failure.
743 * @return An hx509 error code, see hx509_get_error_string().
745 * @ingroup hx509_name
749 hx509_unparse_der_name(const void *data
, size_t length
, char **str
)
756 ret
= decode_Name(data
, length
, &name
, NULL
);
759 ret
= _hx509_Name_to_string(&name
, str
);
765 * Convert a hx509_name object to DER encoded name.
767 * @param name name to concert
768 * @param os data to a DER encoded name, free the resulting octet
769 * string with hx509_xfree(os->data).
771 * @return An hx509 error code, see hx509_get_error_string().
773 * @ingroup hx509_name
777 hx509_name_binary(const hx509_name name
, heim_octet_string
*os
)
782 ASN1_MALLOC_ENCODE(Name
, os
->data
, os
->length
, &name
->der_name
, &size
, ret
);
785 if (os
->length
!= size
)
786 _hx509_abort("internal ASN.1 encoder error");
792 _hx509_unparse_Name(const Name
*aname
, char **str
)
797 ret
= _hx509_name_from_Name(aname
, &name
);
801 ret
= hx509_name_to_string(name
, str
);
802 hx509_name_free(&name
);
807 * Unparse the hx509 name in name into a string.
809 * @param name the name to check if its empty/null.
811 * @return non zero if the name is empty/null.
813 * @ingroup hx509_name
817 hx509_name_is_null_p(const hx509_name name
)
819 return name
->der_name
.u
.rdnSequence
.len
== 0;
823 * Unparse the hx509 name in name into a string.
825 * @param name the name to print
826 * @param str an allocated string returns the name in string form
828 * @return An hx509 error code, see krb5_get_error_string().
830 * @ingroup hx509_name
834 hx509_general_name_unparse(GeneralName
*name
, char **str
)
836 struct rk_strpool
*strpool
= NULL
;
840 switch (name
->element
) {
841 case choice_GeneralName_otherName
: {
843 hx509_oid_sprint(&name
->u
.otherName
.type_id
, &str
);
846 strpool
= rk_strpoolprintf(strpool
, "otherName: %s", str
);
850 case choice_GeneralName_rfc822Name
:
851 strpool
= rk_strpoolprintf(strpool
, "rfc822Name: %s\n",
854 case choice_GeneralName_dNSName
:
855 strpool
= rk_strpoolprintf(strpool
, "dNSName: %s\n",
858 case choice_GeneralName_directoryName
: {
862 memset(&dir
, 0, sizeof(dir
));
863 dir
.element
= name
->u
.directoryName
.element
;
864 dir
.u
.rdnSequence
= name
->u
.directoryName
.u
.rdnSequence
;
865 ret
= _hx509_unparse_Name(&dir
, &s
);
868 strpool
= rk_strpoolprintf(strpool
, "directoryName: %s", s
);
872 case choice_GeneralName_uniformResourceIdentifier
:
873 strpool
= rk_strpoolprintf(strpool
, "URI: %s",
874 name
->u
.uniformResourceIdentifier
);
876 case choice_GeneralName_iPAddress
: {
877 unsigned char *a
= name
->u
.iPAddress
.data
;
879 strpool
= rk_strpoolprintf(strpool
, "IPAddress: ");
882 if (name
->u
.iPAddress
.length
== 4)
883 strpool
= rk_strpoolprintf(strpool
, "%d.%d.%d.%d",
884 a
[0], a
[1], a
[2], a
[3]);
885 else if (name
->u
.iPAddress
.length
== 16)
886 strpool
= rk_strpoolprintf(strpool
,
887 "%02X:%02X:%02X:%02X:"
888 "%02X:%02X:%02X:%02X:"
889 "%02X:%02X:%02X:%02X:"
890 "%02X:%02X:%02X:%02X",
891 a
[0], a
[1], a
[2], a
[3],
892 a
[4], a
[5], a
[6], a
[7],
893 a
[8], a
[9], a
[10], a
[11],
894 a
[12], a
[13], a
[14], a
[15]);
896 strpool
= rk_strpoolprintf(strpool
,
897 "unknown IP address of length %lu",
898 (unsigned long)name
->u
.iPAddress
.length
);
901 case choice_GeneralName_registeredID
: {
903 hx509_oid_sprint(&name
->u
.registeredID
, &str
);
906 strpool
= rk_strpoolprintf(strpool
, "registeredID: %s", str
);
916 *str
= rk_strpoolcollect(strpool
);