Clarify documentation of password quality check modules
[heimdal.git] / lib / hx509 / ca.c
blob8ec6eae22a6398b46243ba426b66206edd363d23
1 /*
2 * Copyright (c) 2006 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
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
31 * SUCH DAMAGE.
34 #include "hx_locl.h"
35 #include <pkinit_asn1.h>
37 /**
38 * @page page_ca Hx509 CA functions
40 * See the library functions here: @ref hx509_ca
43 struct hx509_ca_tbs {
44 hx509_name subject;
45 SubjectPublicKeyInfo spki;
46 ExtKeyUsage eku;
47 GeneralNames san;
48 unsigned key_usage;
49 heim_integer serial;
50 struct {
51 unsigned int proxy:1;
52 unsigned int ca:1;
53 unsigned int key:1;
54 unsigned int serial:1;
55 unsigned int domaincontroller:1;
56 } flags;
57 time_t notBefore;
58 time_t notAfter;
59 int pathLenConstraint; /* both for CA and Proxy */
60 CRLDistributionPoints crldp;
63 /**
64 * Allocate an to-be-signed certificate object that will be converted
65 * into an certificate.
67 * @param context A hx509 context.
68 * @param tbs returned to-be-signed certicate object, free with
69 * hx509_ca_tbs_free().
71 * @return An hx509 error code, see hx509_get_error_string().
73 * @ingroup hx509_ca
76 int
77 hx509_ca_tbs_init(hx509_context context, hx509_ca_tbs *tbs)
79 *tbs = calloc(1, sizeof(**tbs));
80 if (*tbs == NULL)
81 return ENOMEM;
83 (*tbs)->subject = NULL;
84 (*tbs)->san.len = 0;
85 (*tbs)->san.val = NULL;
86 (*tbs)->eku.len = 0;
87 (*tbs)->eku.val = NULL;
88 (*tbs)->pathLenConstraint = 0;
89 (*tbs)->crldp.len = 0;
90 (*tbs)->crldp.val = NULL;
92 return 0;
95 /**
96 * Free an To Be Signed object.
98 * @param tbs object to free.
100 * @ingroup hx509_ca
103 void
104 hx509_ca_tbs_free(hx509_ca_tbs *tbs)
106 if (tbs == NULL || *tbs == NULL)
107 return;
109 free_SubjectPublicKeyInfo(&(*tbs)->spki);
110 free_GeneralNames(&(*tbs)->san);
111 free_ExtKeyUsage(&(*tbs)->eku);
112 der_free_heim_integer(&(*tbs)->serial);
113 free_CRLDistributionPoints(&(*tbs)->crldp);
115 hx509_name_free(&(*tbs)->subject);
117 memset(*tbs, 0, sizeof(**tbs));
118 free(*tbs);
119 *tbs = NULL;
123 * Set the absolute time when the certificate is valid from. If not
124 * set the current time will be used.
126 * @param context A hx509 context.
127 * @param tbs object to be signed.
128 * @param t time the certificated will start to be valid
130 * @return An hx509 error code, see hx509_get_error_string().
132 * @ingroup hx509_ca
136 hx509_ca_tbs_set_notBefore(hx509_context context,
137 hx509_ca_tbs tbs,
138 time_t t)
140 tbs->notBefore = t;
141 return 0;
145 * Set the absolute time when the certificate is valid to.
147 * @param context A hx509 context.
148 * @param tbs object to be signed.
149 * @param t time when the certificate will expire
151 * @return An hx509 error code, see hx509_get_error_string().
153 * @ingroup hx509_ca
157 hx509_ca_tbs_set_notAfter(hx509_context context,
158 hx509_ca_tbs tbs,
159 time_t t)
161 tbs->notAfter = t;
162 return 0;
166 * Set the relative time when the certificiate is going to expire.
168 * @param context A hx509 context.
169 * @param tbs object to be signed.
170 * @param delta seconds to the certificate is going to expire.
172 * @return An hx509 error code, see hx509_get_error_string().
174 * @ingroup hx509_ca
178 hx509_ca_tbs_set_notAfter_lifetime(hx509_context context,
179 hx509_ca_tbs tbs,
180 time_t delta)
182 return hx509_ca_tbs_set_notAfter(context, tbs, time(NULL) + delta);
185 static const struct units templatebits[] = {
186 { "ExtendedKeyUsage", HX509_CA_TEMPLATE_EKU },
187 { "KeyUsage", HX509_CA_TEMPLATE_KU },
188 { "SPKI", HX509_CA_TEMPLATE_SPKI },
189 { "notAfter", HX509_CA_TEMPLATE_NOTAFTER },
190 { "notBefore", HX509_CA_TEMPLATE_NOTBEFORE },
191 { "serial", HX509_CA_TEMPLATE_SERIAL },
192 { "subject", HX509_CA_TEMPLATE_SUBJECT },
193 { NULL, 0 }
197 * Make of template units, use to build flags argument to
198 * hx509_ca_tbs_set_template() with parse_units().
200 * @return an units structure.
202 * @ingroup hx509_ca
205 const struct units *
206 hx509_ca_tbs_template_units(void)
208 return templatebits;
212 * Initialize the to-be-signed certificate object from a template certifiate.
214 * @param context A hx509 context.
215 * @param tbs object to be signed.
216 * @param flags bit field selecting what to copy from the template
217 * certifiate.
218 * @param cert template certificate.
220 * @return An hx509 error code, see hx509_get_error_string().
222 * @ingroup hx509_ca
226 hx509_ca_tbs_set_template(hx509_context context,
227 hx509_ca_tbs tbs,
228 int flags,
229 hx509_cert cert)
231 int ret;
233 if (flags & HX509_CA_TEMPLATE_SUBJECT) {
234 if (tbs->subject)
235 hx509_name_free(&tbs->subject);
236 ret = hx509_cert_get_subject(cert, &tbs->subject);
237 if (ret) {
238 hx509_set_error_string(context, 0, ret,
239 "Failed to get subject from template");
240 return ret;
243 if (flags & HX509_CA_TEMPLATE_SERIAL) {
244 der_free_heim_integer(&tbs->serial);
245 ret = hx509_cert_get_serialnumber(cert, &tbs->serial);
246 tbs->flags.serial = !ret;
247 if (ret) {
248 hx509_set_error_string(context, 0, ret,
249 "Failed to copy serial number");
250 return ret;
253 if (flags & HX509_CA_TEMPLATE_NOTBEFORE)
254 tbs->notBefore = hx509_cert_get_notBefore(cert);
255 if (flags & HX509_CA_TEMPLATE_NOTAFTER)
256 tbs->notAfter = hx509_cert_get_notAfter(cert);
257 if (flags & HX509_CA_TEMPLATE_SPKI) {
258 free_SubjectPublicKeyInfo(&tbs->spki);
259 ret = hx509_cert_get_SPKI(context, cert, &tbs->spki);
260 tbs->flags.key = !ret;
261 if (ret)
262 return ret;
264 if (flags & HX509_CA_TEMPLATE_KU) {
265 KeyUsage ku;
266 ret = _hx509_cert_get_keyusage(context, cert, &ku);
267 if (ret)
268 return ret;
269 tbs->key_usage = KeyUsage2int(ku);
271 if (flags & HX509_CA_TEMPLATE_EKU) {
272 ExtKeyUsage eku;
273 int i;
274 ret = _hx509_cert_get_eku(context, cert, &eku);
275 if (ret)
276 return ret;
277 for (i = 0; i < eku.len; i++) {
278 ret = hx509_ca_tbs_add_eku(context, tbs, &eku.val[i]);
279 if (ret) {
280 free_ExtKeyUsage(&eku);
281 return ret;
284 free_ExtKeyUsage(&eku);
286 return 0;
290 * Make the to-be-signed certificate object a CA certificate. If the
291 * pathLenConstraint is negative path length constraint is used.
293 * @param context A hx509 context.
294 * @param tbs object to be signed.
295 * @param pathLenConstraint path length constraint, negative, no
296 * constraint.
298 * @return An hx509 error code, see hx509_get_error_string().
300 * @ingroup hx509_ca
304 hx509_ca_tbs_set_ca(hx509_context context,
305 hx509_ca_tbs tbs,
306 int pathLenConstraint)
308 tbs->flags.ca = 1;
309 tbs->pathLenConstraint = pathLenConstraint;
310 return 0;
314 * Make the to-be-signed certificate object a proxy certificate. If the
315 * pathLenConstraint is negative path length constraint is used.
317 * @param context A hx509 context.
318 * @param tbs object to be signed.
319 * @param pathLenConstraint path length constraint, negative, no
320 * constraint.
322 * @return An hx509 error code, see hx509_get_error_string().
324 * @ingroup hx509_ca
328 hx509_ca_tbs_set_proxy(hx509_context context,
329 hx509_ca_tbs tbs,
330 int pathLenConstraint)
332 tbs->flags.proxy = 1;
333 tbs->pathLenConstraint = pathLenConstraint;
334 return 0;
339 * Make the to-be-signed certificate object a windows domain controller certificate.
341 * @param context A hx509 context.
342 * @param tbs object to be signed.
344 * @return An hx509 error code, see hx509_get_error_string().
346 * @ingroup hx509_ca
350 hx509_ca_tbs_set_domaincontroller(hx509_context context,
351 hx509_ca_tbs tbs)
353 tbs->flags.domaincontroller = 1;
354 return 0;
358 * Set the subject public key info (SPKI) in the to-be-signed certificate
359 * object. SPKI is the public key and key related parameters in the
360 * certificate.
362 * @param context A hx509 context.
363 * @param tbs object to be signed.
364 * @param spki subject public key info to use for the to-be-signed certificate object.
366 * @return An hx509 error code, see hx509_get_error_string().
368 * @ingroup hx509_ca
372 hx509_ca_tbs_set_spki(hx509_context context,
373 hx509_ca_tbs tbs,
374 const SubjectPublicKeyInfo *spki)
376 int ret;
377 free_SubjectPublicKeyInfo(&tbs->spki);
378 ret = copy_SubjectPublicKeyInfo(spki, &tbs->spki);
379 tbs->flags.key = !ret;
380 return ret;
384 * Set the serial number to use for to-be-signed certificate object.
386 * @param context A hx509 context.
387 * @param tbs object to be signed.
388 * @param serialNumber serial number to use for the to-be-signed
389 * certificate object.
391 * @return An hx509 error code, see hx509_get_error_string().
393 * @ingroup hx509_ca
397 hx509_ca_tbs_set_serialnumber(hx509_context context,
398 hx509_ca_tbs tbs,
399 const heim_integer *serialNumber)
401 int ret;
402 der_free_heim_integer(&tbs->serial);
403 ret = der_copy_heim_integer(serialNumber, &tbs->serial);
404 tbs->flags.serial = !ret;
405 return ret;
409 * An an extended key usage to the to-be-signed certificate object.
410 * Duplicates will detected and not added.
412 * @param context A hx509 context.
413 * @param tbs object to be signed.
414 * @param oid extended key usage to add.
416 * @return An hx509 error code, see hx509_get_error_string().
418 * @ingroup hx509_ca
422 hx509_ca_tbs_add_eku(hx509_context context,
423 hx509_ca_tbs tbs,
424 const heim_oid *oid)
426 void *ptr;
427 int ret;
428 unsigned i;
430 /* search for duplicates */
431 for (i = 0; i < tbs->eku.len; i++) {
432 if (der_heim_oid_cmp(oid, &tbs->eku.val[i]) == 0)
433 return 0;
436 ptr = realloc(tbs->eku.val, sizeof(tbs->eku.val[0]) * (tbs->eku.len + 1));
437 if (ptr == NULL) {
438 hx509_set_error_string(context, 0, ENOMEM, "out of memory");
439 return ENOMEM;
441 tbs->eku.val = ptr;
442 ret = der_copy_oid(oid, &tbs->eku.val[tbs->eku.len]);
443 if (ret) {
444 hx509_set_error_string(context, 0, ret, "out of memory");
445 return ret;
447 tbs->eku.len += 1;
448 return 0;
452 * Add CRL distribution point URI to the to-be-signed certificate
453 * object.
455 * @param context A hx509 context.
456 * @param tbs object to be signed.
457 * @param uri uri to the CRL.
458 * @param issuername name of the issuer.
460 * @return An hx509 error code, see hx509_get_error_string().
462 * @ingroup hx509_ca
466 hx509_ca_tbs_add_crl_dp_uri(hx509_context context,
467 hx509_ca_tbs tbs,
468 const char *uri,
469 hx509_name issuername)
471 DistributionPoint dp;
472 int ret;
474 memset(&dp, 0, sizeof(dp));
476 dp.distributionPoint = ecalloc(1, sizeof(*dp.distributionPoint));
479 DistributionPointName name;
480 GeneralName gn;
481 size_t size;
483 name.element = choice_DistributionPointName_fullName;
484 name.u.fullName.len = 1;
485 name.u.fullName.val = &gn;
487 gn.element = choice_GeneralName_uniformResourceIdentifier;
488 gn.u.uniformResourceIdentifier = rk_UNCONST(uri);
490 ASN1_MALLOC_ENCODE(DistributionPointName,
491 dp.distributionPoint->data,
492 dp.distributionPoint->length,
493 &name, &size, ret);
494 if (ret) {
495 hx509_set_error_string(context, 0, ret,
496 "Failed to encoded DistributionPointName");
497 goto out;
499 if (dp.distributionPoint->length != size)
500 _hx509_abort("internal ASN.1 encoder error");
503 if (issuername) {
504 #if 1
506 * issuername not supported
508 hx509_set_error_string(context, 0, EINVAL,
509 "CRLDistributionPoints.name.issuername not yet supported");
510 return EINVAL;
511 #else
512 GeneralNames *crlissuer;
513 GeneralName gn;
514 Name n;
516 crlissuer = calloc(1, sizeof(*crlissuer));
517 if (crlissuer == NULL) {
518 return ENOMEM;
520 memset(&gn, 0, sizeof(gn));
522 gn.element = choice_GeneralName_directoryName;
523 ret = hx509_name_to_Name(issuername, &n);
524 if (ret) {
525 hx509_set_error_string(context, 0, ret, "out of memory");
526 goto out;
529 gn.u.directoryName.element = n.element;
530 gn.u.directoryName.u.rdnSequence = n.u.rdnSequence;
532 ret = add_GeneralNames(&crlissuer, &gn);
533 free_Name(&n);
534 if (ret) {
535 hx509_set_error_string(context, 0, ret, "out of memory");
536 goto out;
539 dp.cRLIssuer = &crlissuer;
540 #endif
543 ret = add_CRLDistributionPoints(&tbs->crldp, &dp);
544 if (ret) {
545 hx509_set_error_string(context, 0, ret, "out of memory");
546 goto out;
549 out:
550 free_DistributionPoint(&dp);
552 return ret;
556 * Add Subject Alternative Name otherName to the to-be-signed
557 * certificate object.
559 * @param context A hx509 context.
560 * @param tbs object to be signed.
561 * @param oid the oid of the OtherName.
562 * @param os data in the other name.
564 * @return An hx509 error code, see hx509_get_error_string().
566 * @ingroup hx509_ca
570 hx509_ca_tbs_add_san_otherName(hx509_context context,
571 hx509_ca_tbs tbs,
572 const heim_oid *oid,
573 const heim_octet_string *os)
575 GeneralName gn;
577 memset(&gn, 0, sizeof(gn));
578 gn.element = choice_GeneralName_otherName;
579 gn.u.otherName.type_id = *oid;
580 gn.u.otherName.value = *os;
582 return add_GeneralNames(&tbs->san, &gn);
586 * Add Kerberos Subject Alternative Name to the to-be-signed
587 * certificate object. The principal string is a UTF8 string.
589 * @param context A hx509 context.
590 * @param tbs object to be signed.
591 * @param principal Kerberos principal to add to the certificate.
593 * @return An hx509 error code, see hx509_get_error_string().
595 * @ingroup hx509_ca
599 hx509_ca_tbs_add_san_pkinit(hx509_context context,
600 hx509_ca_tbs tbs,
601 const char *principal)
603 heim_octet_string os;
604 KRB5PrincipalName p;
605 size_t size;
606 int ret;
607 char *s = NULL;
609 memset(&p, 0, sizeof(p));
611 /* parse principal */
613 const char *str;
614 char *q;
615 int n;
617 /* count number of component */
618 n = 1;
619 for(str = principal; *str != '\0' && *str != '@'; str++){
620 if(*str=='\\'){
621 if(str[1] == '\0' || str[1] == '@') {
622 ret = HX509_PARSING_NAME_FAILED;
623 hx509_set_error_string(context, 0, ret,
624 "trailing \\ in principal name");
625 goto out;
627 str++;
628 } else if(*str == '/')
629 n++;
631 p.principalName.name_string.val =
632 calloc(n, sizeof(*p.principalName.name_string.val));
633 if (p.principalName.name_string.val == NULL) {
634 ret = ENOMEM;
635 hx509_set_error_string(context, 0, ret, "malloc: out of memory");
636 goto out;
638 p.principalName.name_string.len = n;
640 p.principalName.name_type = KRB5_NT_PRINCIPAL;
641 q = s = strdup(principal);
642 if (q == NULL) {
643 ret = ENOMEM;
644 hx509_set_error_string(context, 0, ret, "malloc: out of memory");
645 goto out;
647 p.realm = strrchr(q, '@');
648 if (p.realm == NULL) {
649 ret = HX509_PARSING_NAME_FAILED;
650 hx509_set_error_string(context, 0, ret, "Missing @ in principal");
651 goto out;
653 *p.realm++ = '\0';
655 n = 0;
656 while (q) {
657 p.principalName.name_string.val[n++] = q;
658 q = strchr(q, '/');
659 if (q)
660 *q++ = '\0';
664 ASN1_MALLOC_ENCODE(KRB5PrincipalName, os.data, os.length, &p, &size, ret);
665 if (ret) {
666 hx509_set_error_string(context, 0, ret, "Out of memory");
667 goto out;
669 if (size != os.length)
670 _hx509_abort("internal ASN.1 encoder error");
672 ret = hx509_ca_tbs_add_san_otherName(context,
673 tbs,
674 &asn1_oid_id_pkinit_san,
675 &os);
676 free(os.data);
677 out:
678 if (p.principalName.name_string.val)
679 free (p.principalName.name_string.val);
680 if (s)
681 free(s);
682 return ret;
689 static int
690 add_utf8_san(hx509_context context,
691 hx509_ca_tbs tbs,
692 const heim_oid *oid,
693 const char *string)
695 const PKIXXmppAddr ustring = (const PKIXXmppAddr)string;
696 heim_octet_string os;
697 size_t size;
698 int ret;
700 os.length = 0;
701 os.data = NULL;
703 ASN1_MALLOC_ENCODE(PKIXXmppAddr, os.data, os.length, &ustring, &size, ret);
704 if (ret) {
705 hx509_set_error_string(context, 0, ret, "Out of memory");
706 goto out;
708 if (size != os.length)
709 _hx509_abort("internal ASN.1 encoder error");
711 ret = hx509_ca_tbs_add_san_otherName(context,
712 tbs,
713 oid,
714 &os);
715 free(os.data);
716 out:
717 return ret;
721 * Add Microsoft UPN Subject Alternative Name to the to-be-signed
722 * certificate object. The principal string is a UTF8 string.
724 * @param context A hx509 context.
725 * @param tbs object to be signed.
726 * @param principal Microsoft UPN string.
728 * @return An hx509 error code, see hx509_get_error_string().
730 * @ingroup hx509_ca
734 hx509_ca_tbs_add_san_ms_upn(hx509_context context,
735 hx509_ca_tbs tbs,
736 const char *principal)
738 return add_utf8_san(context, tbs, &asn1_oid_id_pkinit_ms_san, principal);
742 * Add a Jabber/XMPP jid Subject Alternative Name to the to-be-signed
743 * certificate object. The jid is an UTF8 string.
745 * @param context A hx509 context.
746 * @param tbs object to be signed.
747 * @param jid string of an a jabber id in UTF8.
749 * @return An hx509 error code, see hx509_get_error_string().
751 * @ingroup hx509_ca
755 hx509_ca_tbs_add_san_jid(hx509_context context,
756 hx509_ca_tbs tbs,
757 const char *jid)
759 return add_utf8_san(context, tbs, &asn1_oid_id_pkix_on_xmppAddr, jid);
764 * Add a Subject Alternative Name hostname to to-be-signed certificate
765 * object. A domain match starts with ., an exact match does not.
767 * Example of a an domain match: .domain.se matches the hostname
768 * host.domain.se.
770 * @param context A hx509 context.
771 * @param tbs object to be signed.
772 * @param dnsname a hostame.
774 * @return An hx509 error code, see hx509_get_error_string().
776 * @ingroup hx509_ca
780 hx509_ca_tbs_add_san_hostname(hx509_context context,
781 hx509_ca_tbs tbs,
782 const char *dnsname)
784 GeneralName gn;
786 memset(&gn, 0, sizeof(gn));
787 gn.element = choice_GeneralName_dNSName;
788 gn.u.dNSName = rk_UNCONST(dnsname);
790 return add_GeneralNames(&tbs->san, &gn);
794 * Add a Subject Alternative Name rfc822 (email address) to
795 * to-be-signed certificate object.
797 * @param context A hx509 context.
798 * @param tbs object to be signed.
799 * @param rfc822Name a string to a email address.
801 * @return An hx509 error code, see hx509_get_error_string().
803 * @ingroup hx509_ca
807 hx509_ca_tbs_add_san_rfc822name(hx509_context context,
808 hx509_ca_tbs tbs,
809 const char *rfc822Name)
811 GeneralName gn;
813 memset(&gn, 0, sizeof(gn));
814 gn.element = choice_GeneralName_rfc822Name;
815 gn.u.rfc822Name = rk_UNCONST(rfc822Name);
817 return add_GeneralNames(&tbs->san, &gn);
821 * Set the subject name of a to-be-signed certificate object.
823 * @param context A hx509 context.
824 * @param tbs object to be signed.
825 * @param subject the name to set a subject.
827 * @return An hx509 error code, see hx509_get_error_string().
829 * @ingroup hx509_ca
833 hx509_ca_tbs_set_subject(hx509_context context,
834 hx509_ca_tbs tbs,
835 hx509_name subject)
837 if (tbs->subject)
838 hx509_name_free(&tbs->subject);
839 return hx509_name_copy(context, subject, &tbs->subject);
843 * Expand the the subject name in the to-be-signed certificate object
844 * using hx509_name_expand().
846 * @param context A hx509 context.
847 * @param tbs object to be signed.
848 * @param env enviroment variable to expand variables in the subject
849 * name, see hx509_env_init().
851 * @return An hx509 error code, see hx509_get_error_string().
853 * @ingroup hx509_ca
857 hx509_ca_tbs_subject_expand(hx509_context context,
858 hx509_ca_tbs tbs,
859 hx509_env env)
861 return hx509_name_expand(context, tbs->subject, env);
864 static int
865 add_extension(hx509_context context,
866 TBSCertificate *tbsc,
867 int critical_flag,
868 const heim_oid *oid,
869 const heim_octet_string *data)
871 Extension ext;
872 int ret;
874 memset(&ext, 0, sizeof(ext));
876 if (critical_flag) {
877 ext.critical = malloc(sizeof(*ext.critical));
878 if (ext.critical == NULL) {
879 ret = ENOMEM;
880 hx509_set_error_string(context, 0, ret, "Out of memory");
881 goto out;
883 *ext.critical = TRUE;
886 ret = der_copy_oid(oid, &ext.extnID);
887 if (ret) {
888 hx509_set_error_string(context, 0, ret, "Out of memory");
889 goto out;
891 ret = der_copy_octet_string(data, &ext.extnValue);
892 if (ret) {
893 hx509_set_error_string(context, 0, ret, "Out of memory");
894 goto out;
896 ret = add_Extensions(tbsc->extensions, &ext);
897 if (ret) {
898 hx509_set_error_string(context, 0, ret, "Out of memory");
899 goto out;
901 out:
902 free_Extension(&ext);
903 return ret;
906 static int
907 build_proxy_prefix(hx509_context context, const Name *issuer, Name *subject)
909 char *tstr;
910 time_t t;
911 int ret;
913 ret = copy_Name(issuer, subject);
914 if (ret) {
915 hx509_set_error_string(context, 0, ret,
916 "Failed to copy subject name");
917 return ret;
920 t = time(NULL);
921 asprintf(&tstr, "ts-%lu", (unsigned long)t);
922 if (tstr == NULL) {
923 hx509_set_error_string(context, 0, ENOMEM,
924 "Failed to copy subject name");
925 return ENOMEM;
927 /* prefix with CN=<ts>,...*/
928 ret = _hx509_name_modify(context, subject, 1, &asn1_oid_id_at_commonName, tstr);
929 free(tstr);
930 if (ret)
931 free_Name(subject);
932 return ret;
935 static int
936 ca_sign(hx509_context context,
937 hx509_ca_tbs tbs,
938 hx509_private_key signer,
939 const AuthorityKeyIdentifier *ai,
940 const Name *issuername,
941 hx509_cert *certificate)
943 heim_octet_string data;
944 Certificate c;
945 TBSCertificate *tbsc;
946 size_t size;
947 int ret;
948 const AlgorithmIdentifier *sigalg;
949 time_t notBefore;
950 time_t notAfter;
951 unsigned key_usage;
953 sigalg = _hx509_crypto_default_sig_alg;
955 memset(&c, 0, sizeof(c));
958 * Default values are: Valid since 24h ago, valid one year into
959 * the future, KeyUsage digitalSignature and keyEncipherment set,
960 * and keyCertSign for CA certificates.
962 notBefore = tbs->notBefore;
963 if (notBefore == 0)
964 notBefore = time(NULL) - 3600 * 24;
965 notAfter = tbs->notAfter;
966 if (notAfter == 0)
967 notAfter = time(NULL) + 3600 * 24 * 365;
969 key_usage = tbs->key_usage;
970 if (key_usage == 0) {
971 KeyUsage ku;
972 memset(&ku, 0, sizeof(ku));
973 ku.digitalSignature = 1;
974 ku.keyEncipherment = 1;
975 key_usage = KeyUsage2int(ku);
978 if (tbs->flags.ca) {
979 KeyUsage ku;
980 memset(&ku, 0, sizeof(ku));
981 ku.keyCertSign = 1;
982 ku.cRLSign = 1;
983 key_usage |= KeyUsage2int(ku);
990 tbsc = &c.tbsCertificate;
992 if (tbs->flags.key == 0) {
993 ret = EINVAL;
994 hx509_set_error_string(context, 0, ret, "No public key set");
995 return ret;
998 * Don't put restrictions on proxy certificate's subject name, it
999 * will be generated below.
1001 if (!tbs->flags.proxy) {
1002 if (tbs->subject == NULL) {
1003 hx509_set_error_string(context, 0, EINVAL, "No subject name set");
1004 return EINVAL;
1006 if (hx509_name_is_null_p(tbs->subject) && tbs->san.len == 0) {
1007 hx509_set_error_string(context, 0, EINVAL,
1008 "NULL subject and no SubjectAltNames");
1009 return EINVAL;
1012 if (tbs->flags.ca && tbs->flags.proxy) {
1013 hx509_set_error_string(context, 0, EINVAL, "Can't be proxy and CA "
1014 "at the same time");
1015 return EINVAL;
1017 if (tbs->flags.proxy) {
1018 if (tbs->san.len > 0) {
1019 hx509_set_error_string(context, 0, EINVAL,
1020 "Proxy certificate is not allowed "
1021 "to have SubjectAltNames");
1022 return EINVAL;
1026 /* version [0] Version OPTIONAL, -- EXPLICIT nnn DEFAULT 1, */
1027 tbsc->version = calloc(1, sizeof(*tbsc->version));
1028 if (tbsc->version == NULL) {
1029 ret = ENOMEM;
1030 hx509_set_error_string(context, 0, ret, "Out of memory");
1031 goto out;
1033 *tbsc->version = rfc3280_version_3;
1034 /* serialNumber CertificateSerialNumber, */
1035 if (tbs->flags.serial) {
1036 ret = der_copy_heim_integer(&tbs->serial, &tbsc->serialNumber);
1037 if (ret) {
1038 hx509_set_error_string(context, 0, ret, "Out of memory");
1039 goto out;
1041 } else {
1042 tbsc->serialNumber.length = 20;
1043 tbsc->serialNumber.data = malloc(tbsc->serialNumber.length);
1044 if (tbsc->serialNumber.data == NULL){
1045 ret = ENOMEM;
1046 hx509_set_error_string(context, 0, ret, "Out of memory");
1047 goto out;
1049 /* XXX diffrent */
1050 RAND_bytes(tbsc->serialNumber.data, tbsc->serialNumber.length);
1051 ((unsigned char *)tbsc->serialNumber.data)[0] &= 0x7f;
1053 /* signature AlgorithmIdentifier, */
1054 ret = copy_AlgorithmIdentifier(sigalg, &tbsc->signature);
1055 if (ret) {
1056 hx509_set_error_string(context, 0, ret, "Failed to copy sigature alg");
1057 goto out;
1059 /* issuer Name, */
1060 if (issuername)
1061 ret = copy_Name(issuername, &tbsc->issuer);
1062 else
1063 ret = hx509_name_to_Name(tbs->subject, &tbsc->issuer);
1064 if (ret) {
1065 hx509_set_error_string(context, 0, ret, "Failed to copy issuer name");
1066 goto out;
1068 /* validity Validity, */
1069 tbsc->validity.notBefore.element = choice_Time_generalTime;
1070 tbsc->validity.notBefore.u.generalTime = notBefore;
1071 tbsc->validity.notAfter.element = choice_Time_generalTime;
1072 tbsc->validity.notAfter.u.generalTime = notAfter;
1073 /* subject Name, */
1074 if (tbs->flags.proxy) {
1075 ret = build_proxy_prefix(context, &tbsc->issuer, &tbsc->subject);
1076 if (ret)
1077 goto out;
1078 } else {
1079 ret = hx509_name_to_Name(tbs->subject, &tbsc->subject);
1080 if (ret) {
1081 hx509_set_error_string(context, 0, ret,
1082 "Failed to copy subject name");
1083 goto out;
1086 /* subjectPublicKeyInfo SubjectPublicKeyInfo, */
1087 ret = copy_SubjectPublicKeyInfo(&tbs->spki, &tbsc->subjectPublicKeyInfo);
1088 if (ret) {
1089 hx509_set_error_string(context, 0, ret, "Failed to copy spki");
1090 goto out;
1092 /* issuerUniqueID [1] IMPLICIT BIT STRING OPTIONAL */
1093 /* subjectUniqueID [2] IMPLICIT BIT STRING OPTIONAL */
1094 /* extensions [3] EXPLICIT Extensions OPTIONAL */
1095 tbsc->extensions = calloc(1, sizeof(*tbsc->extensions));
1096 if (tbsc->extensions == NULL) {
1097 ret = ENOMEM;
1098 hx509_set_error_string(context, 0, ret, "Out of memory");
1099 goto out;
1102 /* Add the text BMP string Domaincontroller to the cert */
1103 if (tbs->flags.domaincontroller) {
1104 data.data = rk_UNCONST("\x1e\x20\x00\x44\x00\x6f\x00\x6d"
1105 "\x00\x61\x00\x69\x00\x6e\x00\x43"
1106 "\x00\x6f\x00\x6e\x00\x74\x00\x72"
1107 "\x00\x6f\x00\x6c\x00\x6c\x00\x65"
1108 "\x00\x72");
1109 data.length = 34;
1111 ret = add_extension(context, tbsc, 0,
1112 &asn1_oid_id_ms_cert_enroll_domaincontroller,
1113 &data);
1114 if (ret)
1115 goto out;
1118 /* add KeyUsage */
1120 KeyUsage ku;
1122 ku = int2KeyUsage(key_usage);
1123 ASN1_MALLOC_ENCODE(KeyUsage, data.data, data.length, &ku, &size, ret);
1124 if (ret) {
1125 hx509_set_error_string(context, 0, ret, "Out of memory");
1126 goto out;
1128 if (size != data.length)
1129 _hx509_abort("internal ASN.1 encoder error");
1130 ret = add_extension(context, tbsc, 1,
1131 &asn1_oid_id_x509_ce_keyUsage, &data);
1132 free(data.data);
1133 if (ret)
1134 goto out;
1137 /* add ExtendedKeyUsage */
1138 if (tbs->eku.len > 0) {
1139 ASN1_MALLOC_ENCODE(ExtKeyUsage, data.data, data.length,
1140 &tbs->eku, &size, ret);
1141 if (ret) {
1142 hx509_set_error_string(context, 0, ret, "Out of memory");
1143 goto out;
1145 if (size != data.length)
1146 _hx509_abort("internal ASN.1 encoder error");
1147 ret = add_extension(context, tbsc, 0,
1148 &asn1_oid_id_x509_ce_extKeyUsage, &data);
1149 free(data.data);
1150 if (ret)
1151 goto out;
1154 /* add Subject Alternative Name */
1155 if (tbs->san.len > 0) {
1156 ASN1_MALLOC_ENCODE(GeneralNames, data.data, data.length,
1157 &tbs->san, &size, ret);
1158 if (ret) {
1159 hx509_set_error_string(context, 0, ret, "Out of memory");
1160 goto out;
1162 if (size != data.length)
1163 _hx509_abort("internal ASN.1 encoder error");
1164 ret = add_extension(context, tbsc, 0,
1165 &asn1_oid_id_x509_ce_subjectAltName,
1166 &data);
1167 free(data.data);
1168 if (ret)
1169 goto out;
1172 /* Add Authority Key Identifier */
1173 if (ai) {
1174 ASN1_MALLOC_ENCODE(AuthorityKeyIdentifier, data.data, data.length,
1175 ai, &size, ret);
1176 if (ret) {
1177 hx509_set_error_string(context, 0, ret, "Out of memory");
1178 goto out;
1180 if (size != data.length)
1181 _hx509_abort("internal ASN.1 encoder error");
1182 ret = add_extension(context, tbsc, 0,
1183 &asn1_oid_id_x509_ce_authorityKeyIdentifier,
1184 &data);
1185 free(data.data);
1186 if (ret)
1187 goto out;
1190 /* Add Subject Key Identifier */
1192 SubjectKeyIdentifier si;
1193 unsigned char hash[SHA_DIGEST_LENGTH];
1196 EVP_MD_CTX *ctx;
1198 ctx = EVP_MD_CTX_create();
1199 EVP_DigestInit_ex(ctx, EVP_sha1(), NULL);
1200 EVP_DigestUpdate(ctx, tbs->spki.subjectPublicKey.data,
1201 tbs->spki.subjectPublicKey.length / 8);
1202 EVP_DigestFinal_ex(ctx, hash, NULL);
1203 EVP_MD_CTX_destroy(ctx);
1206 si.data = hash;
1207 si.length = sizeof(hash);
1209 ASN1_MALLOC_ENCODE(SubjectKeyIdentifier, data.data, data.length,
1210 &si, &size, ret);
1211 if (ret) {
1212 hx509_set_error_string(context, 0, ret, "Out of memory");
1213 goto out;
1215 if (size != data.length)
1216 _hx509_abort("internal ASN.1 encoder error");
1217 ret = add_extension(context, tbsc, 0,
1218 &asn1_oid_id_x509_ce_subjectKeyIdentifier,
1219 &data);
1220 free(data.data);
1221 if (ret)
1222 goto out;
1225 /* Add BasicConstraints */
1227 BasicConstraints bc;
1228 int aCA = 1;
1229 unsigned int path;
1231 memset(&bc, 0, sizeof(bc));
1233 if (tbs->flags.ca) {
1234 bc.cA = &aCA;
1235 if (tbs->pathLenConstraint >= 0) {
1236 path = tbs->pathLenConstraint;
1237 bc.pathLenConstraint = &path;
1241 ASN1_MALLOC_ENCODE(BasicConstraints, data.data, data.length,
1242 &bc, &size, ret);
1243 if (ret) {
1244 hx509_set_error_string(context, 0, ret, "Out of memory");
1245 goto out;
1247 if (size != data.length)
1248 _hx509_abort("internal ASN.1 encoder error");
1249 /* Critical if this is a CA */
1250 ret = add_extension(context, tbsc, tbs->flags.ca,
1251 &asn1_oid_id_x509_ce_basicConstraints,
1252 &data);
1253 free(data.data);
1254 if (ret)
1255 goto out;
1258 /* add Proxy */
1259 if (tbs->flags.proxy) {
1260 ProxyCertInfo info;
1262 memset(&info, 0, sizeof(info));
1264 if (tbs->pathLenConstraint >= 0) {
1265 info.pCPathLenConstraint =
1266 malloc(sizeof(*info.pCPathLenConstraint));
1267 if (info.pCPathLenConstraint == NULL) {
1268 ret = ENOMEM;
1269 hx509_set_error_string(context, 0, ret, "Out of memory");
1270 goto out;
1272 *info.pCPathLenConstraint = tbs->pathLenConstraint;
1275 ret = der_copy_oid(&asn1_oid_id_pkix_ppl_inheritAll,
1276 &info.proxyPolicy.policyLanguage);
1277 if (ret) {
1278 free_ProxyCertInfo(&info);
1279 hx509_set_error_string(context, 0, ret, "Out of memory");
1280 goto out;
1283 ASN1_MALLOC_ENCODE(ProxyCertInfo, data.data, data.length,
1284 &info, &size, ret);
1285 free_ProxyCertInfo(&info);
1286 if (ret) {
1287 hx509_set_error_string(context, 0, ret, "Out of memory");
1288 goto out;
1290 if (size != data.length)
1291 _hx509_abort("internal ASN.1 encoder error");
1292 ret = add_extension(context, tbsc, 0,
1293 &asn1_oid_id_pkix_pe_proxyCertInfo,
1294 &data);
1295 free(data.data);
1296 if (ret)
1297 goto out;
1300 if (tbs->crldp.len) {
1302 ASN1_MALLOC_ENCODE(CRLDistributionPoints, data.data, data.length,
1303 &tbs->crldp, &size, ret);
1304 if (ret) {
1305 hx509_set_error_string(context, 0, ret, "Out of memory");
1306 goto out;
1308 if (size != data.length)
1309 _hx509_abort("internal ASN.1 encoder error");
1310 ret = add_extension(context, tbsc, FALSE,
1311 &asn1_oid_id_x509_ce_cRLDistributionPoints,
1312 &data);
1313 free(data.data);
1314 if (ret)
1315 goto out;
1318 ASN1_MALLOC_ENCODE(TBSCertificate, data.data, data.length,tbsc, &size, ret);
1319 if (ret) {
1320 hx509_set_error_string(context, 0, ret, "malloc out of memory");
1321 goto out;
1323 if (data.length != size)
1324 _hx509_abort("internal ASN.1 encoder error");
1326 ret = _hx509_create_signature_bitstring(context,
1327 signer,
1328 sigalg,
1329 &data,
1330 &c.signatureAlgorithm,
1331 &c.signatureValue);
1332 free(data.data);
1333 if (ret)
1334 goto out;
1336 ret = hx509_cert_init(context, &c, certificate);
1337 if (ret)
1338 goto out;
1340 free_Certificate(&c);
1342 return 0;
1344 out:
1345 free_Certificate(&c);
1346 return ret;
1349 static int
1350 get_AuthorityKeyIdentifier(hx509_context context,
1351 const Certificate *certificate,
1352 AuthorityKeyIdentifier *ai)
1354 SubjectKeyIdentifier si;
1355 int ret;
1357 ret = _hx509_find_extension_subject_key_id(certificate, &si);
1358 if (ret == 0) {
1359 ai->keyIdentifier = calloc(1, sizeof(*ai->keyIdentifier));
1360 if (ai->keyIdentifier == NULL) {
1361 free_SubjectKeyIdentifier(&si);
1362 ret = ENOMEM;
1363 hx509_set_error_string(context, 0, ret, "Out of memory");
1364 goto out;
1366 ret = der_copy_octet_string(&si, ai->keyIdentifier);
1367 free_SubjectKeyIdentifier(&si);
1368 if (ret) {
1369 hx509_set_error_string(context, 0, ret, "Out of memory");
1370 goto out;
1372 } else {
1373 GeneralNames gns;
1374 GeneralName gn;
1375 Name name;
1377 memset(&gn, 0, sizeof(gn));
1378 memset(&gns, 0, sizeof(gns));
1379 memset(&name, 0, sizeof(name));
1381 ai->authorityCertIssuer =
1382 calloc(1, sizeof(*ai->authorityCertIssuer));
1383 if (ai->authorityCertIssuer == NULL) {
1384 ret = ENOMEM;
1385 hx509_set_error_string(context, 0, ret, "Out of memory");
1386 goto out;
1388 ai->authorityCertSerialNumber =
1389 calloc(1, sizeof(*ai->authorityCertSerialNumber));
1390 if (ai->authorityCertSerialNumber == NULL) {
1391 ret = ENOMEM;
1392 hx509_set_error_string(context, 0, ret, "Out of memory");
1393 goto out;
1397 * XXX unbreak when asn1 compiler handle IMPLICIT
1399 * This is so horrible.
1402 ret = copy_Name(&certificate->tbsCertificate.subject, &name);
1403 if (ret) {
1404 hx509_set_error_string(context, 0, ret, "Out of memory");
1405 goto out;
1408 memset(&gn, 0, sizeof(gn));
1409 gn.element = choice_GeneralName_directoryName;
1410 gn.u.directoryName.element =
1411 choice_GeneralName_directoryName_rdnSequence;
1412 gn.u.directoryName.u.rdnSequence = name.u.rdnSequence;
1414 ret = add_GeneralNames(&gns, &gn);
1415 if (ret) {
1416 hx509_set_error_string(context, 0, ret, "Out of memory");
1417 goto out;
1420 ai->authorityCertIssuer->val = gns.val;
1421 ai->authorityCertIssuer->len = gns.len;
1423 ret = der_copy_heim_integer(&certificate->tbsCertificate.serialNumber,
1424 ai->authorityCertSerialNumber);
1425 if (ai->authorityCertSerialNumber == NULL) {
1426 ret = ENOMEM;
1427 hx509_set_error_string(context, 0, ret, "Out of memory");
1428 goto out;
1431 out:
1432 if (ret)
1433 free_AuthorityKeyIdentifier(ai);
1434 return ret;
1439 * Sign a to-be-signed certificate object with a issuer certificate.
1441 * The caller needs to at least have called the following functions on the
1442 * to-be-signed certificate object:
1443 * - hx509_ca_tbs_init()
1444 * - hx509_ca_tbs_set_subject()
1445 * - hx509_ca_tbs_set_spki()
1447 * When done the to-be-signed certificate object should be freed with
1448 * hx509_ca_tbs_free().
1450 * When creating self-signed certificate use hx509_ca_sign_self() instead.
1452 * @param context A hx509 context.
1453 * @param tbs object to be signed.
1454 * @param signer the CA certificate object to sign with (need private key).
1455 * @param certificate return cerificate, free with hx509_cert_free().
1457 * @return An hx509 error code, see hx509_get_error_string().
1459 * @ingroup hx509_ca
1463 hx509_ca_sign(hx509_context context,
1464 hx509_ca_tbs tbs,
1465 hx509_cert signer,
1466 hx509_cert *certificate)
1468 const Certificate *signer_cert;
1469 AuthorityKeyIdentifier ai;
1470 int ret;
1472 memset(&ai, 0, sizeof(ai));
1474 signer_cert = _hx509_get_cert(signer);
1476 ret = get_AuthorityKeyIdentifier(context, signer_cert, &ai);
1477 if (ret)
1478 goto out;
1480 ret = ca_sign(context,
1481 tbs,
1482 _hx509_cert_private_key(signer),
1483 &ai,
1484 &signer_cert->tbsCertificate.subject,
1485 certificate);
1487 out:
1488 free_AuthorityKeyIdentifier(&ai);
1490 return ret;
1494 * Work just like hx509_ca_sign() but signs it-self.
1496 * @param context A hx509 context.
1497 * @param tbs object to be signed.
1498 * @param signer private key to sign with.
1499 * @param certificate return cerificate, free with hx509_cert_free().
1501 * @return An hx509 error code, see hx509_get_error_string().
1503 * @ingroup hx509_ca
1507 hx509_ca_sign_self(hx509_context context,
1508 hx509_ca_tbs tbs,
1509 hx509_private_key signer,
1510 hx509_cert *certificate)
1512 return ca_sign(context,
1513 tbs,
1514 signer,
1515 NULL,
1516 NULL,
1517 certificate);