2 * Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 /* general CMP server functions */
14 #include <openssl/asn1t.h>
16 #include "cmp_local.h"
18 /* explicit #includes not strictly needed since implied by the above: */
19 #include <openssl/cmp.h>
20 #include <openssl/err.h>
22 DEFINE_STACK_OF(OSSL_CRMF_MSG)
24 DEFINE_STACK_OF(OSSL_CMP_ITAV)
25 DEFINE_STACK_OF(OSSL_CMP_CERTSTATUS)
27 /* the context for the generic CMP server */
28 struct ossl_cmp_srv_ctx_st
30 OSSL_CMP_CTX *ctx; /* Client CMP context, partly reused for srv */
31 void *custom_ctx; /* pointer to specific server context */
33 OSSL_CMP_SRV_cert_request_cb_t process_cert_request;
34 OSSL_CMP_SRV_rr_cb_t process_rr;
35 OSSL_CMP_SRV_genm_cb_t process_genm;
36 OSSL_CMP_SRV_error_cb_t process_error;
37 OSSL_CMP_SRV_certConf_cb_t process_certConf;
38 OSSL_CMP_SRV_pollReq_cb_t process_pollReq;
40 int sendUnprotectedErrors; /* Send error and rejection msgs unprotected */
41 int acceptUnprotected; /* Accept requests with no/invalid prot. */
42 int acceptRAVerified; /* Accept ir/cr/kur with POPO RAVerified */
43 int grantImplicitConfirm; /* Grant implicit confirmation if requested */
45 }; /* OSSL_CMP_SRV_CTX */
47 void OSSL_CMP_SRV_CTX_free(OSSL_CMP_SRV_CTX *srv_ctx)
52 OSSL_CMP_CTX_free(srv_ctx->ctx);
53 OPENSSL_free(srv_ctx);
56 OSSL_CMP_SRV_CTX *OSSL_CMP_SRV_CTX_new(void)
58 OSSL_CMP_SRV_CTX *ctx = OPENSSL_zalloc(sizeof(OSSL_CMP_SRV_CTX));
63 if ((ctx->ctx = OSSL_CMP_CTX_new()) == NULL)
66 /* all other elements are initialized to 0 or NULL, respectively */
69 OSSL_CMP_SRV_CTX_free(ctx);
73 int OSSL_CMP_SRV_CTX_init(OSSL_CMP_SRV_CTX *srv_ctx, void *custom_ctx,
74 OSSL_CMP_SRV_cert_request_cb_t process_cert_request,
75 OSSL_CMP_SRV_rr_cb_t process_rr,
76 OSSL_CMP_SRV_genm_cb_t process_genm,
77 OSSL_CMP_SRV_error_cb_t process_error,
78 OSSL_CMP_SRV_certConf_cb_t process_certConf,
79 OSSL_CMP_SRV_pollReq_cb_t process_pollReq)
81 if (srv_ctx == NULL) {
82 CMPerr(0, CMP_R_NULL_ARGUMENT);
85 srv_ctx->custom_ctx = custom_ctx;
86 srv_ctx->process_cert_request = process_cert_request;
87 srv_ctx->process_rr = process_rr;
88 srv_ctx->process_genm = process_genm;
89 srv_ctx->process_error = process_error;
90 srv_ctx->process_certConf = process_certConf;
91 srv_ctx->process_pollReq = process_pollReq;
95 OSSL_CMP_CTX *OSSL_CMP_SRV_CTX_get0_cmp_ctx(const OSSL_CMP_SRV_CTX *srv_ctx)
97 if (srv_ctx == NULL) {
98 CMPerr(0, CMP_R_NULL_ARGUMENT);
104 void *OSSL_CMP_SRV_CTX_get0_custom_ctx(const OSSL_CMP_SRV_CTX *srv_ctx)
106 if (srv_ctx == NULL) {
107 CMPerr(0, CMP_R_NULL_ARGUMENT);
110 return srv_ctx->custom_ctx;
113 int OSSL_CMP_SRV_CTX_set_send_unprotected_errors(OSSL_CMP_SRV_CTX *srv_ctx,
116 if (srv_ctx == NULL) {
117 CMPerr(0, CMP_R_NULL_ARGUMENT);
120 srv_ctx->sendUnprotectedErrors = val != 0;
124 int OSSL_CMP_SRV_CTX_set_accept_unprotected(OSSL_CMP_SRV_CTX *srv_ctx, int val)
126 if (srv_ctx == NULL) {
127 CMPerr(0, CMP_R_NULL_ARGUMENT);
130 srv_ctx->acceptUnprotected = val != 0;
134 int OSSL_CMP_SRV_CTX_set_accept_raverified(OSSL_CMP_SRV_CTX *srv_ctx, int val)
136 if (srv_ctx == NULL) {
137 CMPerr(0, CMP_R_NULL_ARGUMENT);
140 srv_ctx->acceptRAVerified = val != 0;
144 int OSSL_CMP_SRV_CTX_set_grant_implicit_confirm(OSSL_CMP_SRV_CTX *srv_ctx,
147 if (srv_ctx == NULL) {
148 CMPerr(0, CMP_R_NULL_ARGUMENT);
151 srv_ctx->grantImplicitConfirm = val != 0;
156 * Processes an ir/cr/p10cr/kur and returns a certification response.
157 * Only handles the first certification request contained in req
158 * returns an ip/cp/kup on success and NULL on error
160 static OSSL_CMP_MSG *process_cert_request(OSSL_CMP_SRV_CTX *srv_ctx,
161 const OSSL_CMP_MSG *req)
163 OSSL_CMP_MSG *msg = NULL;
164 OSSL_CMP_PKISI *si = NULL;
165 X509 *certOut = NULL;
166 STACK_OF(X509) *chainOut = NULL, *caPubs = NULL;
167 const OSSL_CRMF_MSG *crm = NULL;
168 const X509_REQ *p10cr = NULL;
172 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
175 switch (ossl_cmp_msg_get_bodytype(req)) {
176 case OSSL_CMP_PKIBODY_P10CR:
177 case OSSL_CMP_PKIBODY_CR:
178 bodytype = OSSL_CMP_PKIBODY_CP;
180 case OSSL_CMP_PKIBODY_IR:
181 bodytype = OSSL_CMP_PKIBODY_IP;
183 case OSSL_CMP_PKIBODY_KUR:
184 bodytype = OSSL_CMP_PKIBODY_KUP;
187 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
191 if (ossl_cmp_msg_get_bodytype(req) == OSSL_CMP_PKIBODY_P10CR) {
192 certReqId = OSSL_CMP_CERTREQID;
193 p10cr = req->body->value.p10cr;
195 OSSL_CRMF_MSGS *reqs = req->body->value.ir; /* same for cr and kur */
197 if (sk_OSSL_CRMF_MSG_num(reqs) != 1) { /* TODO: handle case > 1 */
198 CMPerr(0, CMP_R_MULTIPLE_REQUESTS_NOT_SUPPORTED);
202 if ((crm = sk_OSSL_CRMF_MSG_value(reqs, OSSL_CMP_CERTREQID)) == NULL) {
203 CMPerr(0, CMP_R_CERTREQMSG_NOT_FOUND);
206 certReqId = OSSL_CRMF_MSG_get_certReqId(crm);
209 if (!ossl_cmp_verify_popo(req, srv_ctx->acceptRAVerified)) {
210 /* Proof of possession could not be verified */
211 si = OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_rejection,
212 1 << OSSL_CMP_PKIFAILUREINFO_badPOP,
213 ERR_reason_error_string(ERR_peek_error()));
217 OSSL_CMP_PKIHEADER *hdr = OSSL_CMP_MSG_get0_header(req);
219 si = srv_ctx->process_cert_request(srv_ctx, req, certReqId, crm, p10cr,
220 &certOut, &chainOut, &caPubs);
223 /* set OSSL_CMP_OPT_IMPLICIT_CONFIRM if and only if transaction ends */
224 if (!OSSL_CMP_CTX_set_option(srv_ctx->ctx,
225 OSSL_CMP_OPT_IMPLICIT_CONFIRM,
226 ossl_cmp_hdr_has_implicitConfirm(hdr)
227 && srv_ctx->grantImplicitConfirm
228 /* do not set if polling starts: */
233 msg = ossl_cmp_certRep_new(srv_ctx->ctx, bodytype, certReqId, si,
234 certOut, chainOut, caPubs, 0 /* encrypted */,
235 srv_ctx->sendUnprotectedErrors);
237 * TODO when implemented in ossl_cmp_certrep_new():
238 * in case OSSL_CRMF_POPO_KEYENC, set encrypted
241 CMPerr(0, CMP_R_ERROR_CREATING_CERTREP);
244 OSSL_CMP_PKISI_free(si);
246 sk_X509_pop_free(chainOut, X509_free);
247 sk_X509_pop_free(caPubs, X509_free);
251 static OSSL_CMP_MSG *process_rr(OSSL_CMP_SRV_CTX *srv_ctx,
252 const OSSL_CMP_MSG *req)
254 OSSL_CMP_MSG *msg = NULL;
255 OSSL_CMP_REVDETAILS *details;
256 OSSL_CRMF_CERTID *certId;
257 OSSL_CRMF_CERTTEMPLATE *tmpl;
258 const X509_NAME *issuer;
259 ASN1_INTEGER *serial;
262 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
265 if (sk_OSSL_CMP_REVDETAILS_num(req->body->value.rr) != 1) {
266 /* TODO: handle multiple elements if multiple requests have been sent */
267 CMPerr(0, CMP_R_MULTIPLE_REQUESTS_NOT_SUPPORTED);
271 if ((details = sk_OSSL_CMP_REVDETAILS_value(req->body->value.rr,
272 OSSL_CMP_REVREQSID)) == NULL) {
273 CMPerr(0, CMP_R_ERROR_PROCESSING_MESSAGE);
277 tmpl = details->certDetails;
278 issuer = OSSL_CRMF_CERTTEMPLATE_get0_issuer(tmpl);
279 serial = OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(tmpl);
280 /* here issuer and serial may safely be NULL */
281 if ((certId = OSSL_CRMF_CERTID_gen(issuer, serial)) == NULL)
283 if ((si = srv_ctx->process_rr(srv_ctx, req, issuer, serial)) == NULL)
286 if ((msg = ossl_cmp_rp_new(srv_ctx->ctx, si, certId,
287 srv_ctx->sendUnprotectedErrors)) == NULL)
288 CMPerr(0, CMP_R_ERROR_CREATING_RR);
291 OSSL_CRMF_CERTID_free(certId);
292 OSSL_CMP_PKISI_free(si);
297 * Processes genm and creates a genp message mirroring the contents of the
300 static OSSL_CMP_MSG *process_genm(OSSL_CMP_SRV_CTX *srv_ctx,
301 const OSSL_CMP_MSG *req)
303 OSSL_CMP_GENMSGCONTENT *itavs;
306 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
309 if (!srv_ctx->process_genm(srv_ctx, req, req->body->value.genm, &itavs))
312 msg = ossl_cmp_genp_new(srv_ctx->ctx, itavs);
313 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
317 static OSSL_CMP_MSG *process_error(OSSL_CMP_SRV_CTX *srv_ctx,
318 const OSSL_CMP_MSG *req)
320 OSSL_CMP_ERRORMSGCONTENT *errorContent;
323 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
325 errorContent = req->body->value.error;
326 srv_ctx->process_error(srv_ctx, req, errorContent->pKIStatusInfo,
327 errorContent->errorCode, errorContent->errorDetails);
329 if ((msg = ossl_cmp_pkiconf_new(srv_ctx->ctx)) == NULL)
330 CMPerr(0, CMP_R_ERROR_CREATING_PKICONF);
334 static OSSL_CMP_MSG *process_certConf(OSSL_CMP_SRV_CTX *srv_ctx,
335 const OSSL_CMP_MSG *req)
338 OSSL_CMP_CERTCONFIRMCONTENT *ccc;
340 OSSL_CMP_MSG *msg = NULL;
341 OSSL_CMP_CERTSTATUS *status = NULL;
343 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
347 ccc = req->body->value.certConf;
348 num = sk_OSSL_CMP_CERTSTATUS_num(ccc);
350 if (OSSL_CMP_CTX_get_option(ctx, OSSL_CMP_OPT_IMPLICIT_CONFIRM) == 1) {
351 CMPerr(0, CMP_R_ERROR_UNEXPECTED_CERTCONF);
356 ossl_cmp_err(ctx, "certificate rejected by client");
359 ossl_cmp_warn(ctx, "All CertStatus but the first will be ignored");
360 status = sk_OSSL_CMP_CERTSTATUS_value(ccc, OSSL_CMP_CERTREQID);
363 if (status != NULL) {
364 int certReqId = ossl_cmp_asn1_get_int(status->certReqId);
365 ASN1_OCTET_STRING *certHash = status->certHash;
366 OSSL_CMP_PKISI *si = status->statusInfo;
368 if (!srv_ctx->process_certConf(srv_ctx, req, certReqId, certHash, si))
369 return NULL; /* reason code may be: CMP_R_CERTHASH_UNMATCHED */
371 if (si != NULL && ossl_cmp_pkisi_get_status(si)
372 != OSSL_CMP_PKISTATUS_accepted) {
373 int pki_status = ossl_cmp_pkisi_get_status(si);
374 const char *str = ossl_cmp_PKIStatus_to_string(pki_status);
376 ossl_cmp_log2(INFO, ctx, "certificate rejected by client %s %s",
377 str == NULL ? "without" : "with",
378 str == NULL ? "PKIStatus" : str);
382 if ((msg = ossl_cmp_pkiconf_new(ctx)) == NULL)
383 CMPerr(0, CMP_R_ERROR_CREATING_PKICONF);
387 static OSSL_CMP_MSG *process_pollReq(OSSL_CMP_SRV_CTX *srv_ctx,
388 const OSSL_CMP_MSG *req)
390 OSSL_CMP_POLLREQCONTENT *prc;
391 OSSL_CMP_POLLREQ *pr;
393 OSSL_CMP_MSG *certReq;
394 int64_t check_after = 0;
395 OSSL_CMP_MSG *msg = NULL;
397 if (!ossl_assert(srv_ctx != NULL && srv_ctx->ctx != NULL && req != NULL))
400 prc = req->body->value.pollReq;
401 if (sk_OSSL_CMP_POLLREQ_num(prc) != 1) { /* TODO: handle case > 1 */
402 CMPerr(0, CMP_R_MULTIPLE_REQUESTS_NOT_SUPPORTED);
406 pr = sk_OSSL_CMP_POLLREQ_value(prc, 0);
407 certReqId = ossl_cmp_asn1_get_int(pr->certReqId);
408 if (!srv_ctx->process_pollReq(srv_ctx, req, certReqId,
409 &certReq, &check_after))
412 if (certReq != NULL) {
413 msg = process_cert_request(srv_ctx, certReq);
414 OSSL_CMP_MSG_free(certReq);
416 if ((msg = ossl_cmp_pollRep_new(srv_ctx->ctx, certReqId,
417 check_after)) == NULL)
418 CMPerr(0, CMP_R_ERROR_CREATING_POLLREP);
424 * Determine whether missing/invalid protection of request message is allowed.
425 * Return 1 on acceptance, 0 on rejection, or -1 on (internal) error.
427 static int unprotected_exception(const OSSL_CMP_CTX *ctx,
428 const OSSL_CMP_MSG *req,
429 int invalid_protection,
430 int accept_unprotected_requests)
432 if (!ossl_assert(ctx != NULL && req != NULL))
435 if (accept_unprotected_requests) {
436 ossl_cmp_log1(WARN, ctx, "ignoring %s protection of request message",
437 invalid_protection ? "invalid" : "missing");
440 if (ossl_cmp_msg_get_bodytype(req) == OSSL_CMP_PKIBODY_ERROR
441 && OSSL_CMP_CTX_get_option(ctx, OSSL_CMP_OPT_UNPROTECTED_ERRORS) == 1) {
442 ossl_cmp_warn(ctx, "ignoring missing protection of error message");
449 * returns created message and NULL on internal error
451 OSSL_CMP_MSG *OSSL_CMP_SRV_process_request(OSSL_CMP_SRV_CTX *srv_ctx,
452 const OSSL_CMP_MSG *req)
455 ASN1_OCTET_STRING *backup_secret;
456 OSSL_CMP_PKIHEADER *hdr;
457 int req_type, rsp_type;
459 OSSL_CMP_MSG *rsp = NULL;
461 if (srv_ctx == NULL || srv_ctx->ctx == NULL
462 || req == NULL || req->body == NULL
463 || (hdr = OSSL_CMP_MSG_get0_header(req)) == NULL) {
464 CMPerr(0, CMP_R_NULL_ARGUMENT);
468 backup_secret = ctx->secretValue;
471 * Some things need to be done already before validating the message in
472 * order to be able to send an error message as far as needed and possible.
474 if (hdr->sender->type != GEN_DIRNAME) {
475 CMPerr(0, CMP_R_SENDER_GENERALNAME_TYPE_NOT_SUPPORTED);
478 if (!OSSL_CMP_CTX_set1_recipient(ctx, hdr->sender->d.directoryName))
481 req_type = ossl_cmp_msg_get_bodytype(req);
483 case OSSL_CMP_PKIBODY_IR:
484 case OSSL_CMP_PKIBODY_CR:
485 case OSSL_CMP_PKIBODY_P10CR:
486 case OSSL_CMP_PKIBODY_KUR:
487 case OSSL_CMP_PKIBODY_RR:
488 case OSSL_CMP_PKIBODY_GENM:
489 case OSSL_CMP_PKIBODY_ERROR:
490 if (ctx->transactionID != NULL) {
493 tid = OPENSSL_buf2hexstr(ctx->transactionID->data,
494 ctx->transactionID->length);
496 ossl_cmp_log1(WARN, ctx,
497 "Assuming that last transaction with ID=%s got aborted",
501 /* start of a new transaction, reset transactionID and senderNonce */
502 if (!OSSL_CMP_CTX_set1_transactionID(ctx, NULL)
503 || !OSSL_CMP_CTX_set1_senderNonce(ctx, NULL))
507 /* transactionID should be already initialized */
508 if (ctx->transactionID == NULL) {
509 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
510 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
516 res = ossl_cmp_msg_check_update(ctx, req, unprotected_exception,
517 srv_ctx->acceptUnprotected);
518 if (ctx->secretValue != NULL && ctx->pkey != NULL
519 && ossl_cmp_hdr_get_protection_nid(hdr) != NID_id_PasswordBasedMAC)
520 ctx->secretValue = NULL; /* use MSG_SIG_ALG when protecting rsp */
525 case OSSL_CMP_PKIBODY_IR:
526 case OSSL_CMP_PKIBODY_CR:
527 case OSSL_CMP_PKIBODY_P10CR:
528 case OSSL_CMP_PKIBODY_KUR:
529 if (srv_ctx->process_cert_request == NULL)
530 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
532 rsp = process_cert_request(srv_ctx, req);
534 case OSSL_CMP_PKIBODY_RR:
535 if (srv_ctx->process_rr == NULL)
536 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
538 rsp = process_rr(srv_ctx, req);
540 case OSSL_CMP_PKIBODY_GENM:
541 if (srv_ctx->process_genm == NULL)
542 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
544 rsp = process_genm(srv_ctx, req);
546 case OSSL_CMP_PKIBODY_ERROR:
547 if (srv_ctx->process_error == NULL)
548 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
550 rsp = process_error(srv_ctx, req);
552 case OSSL_CMP_PKIBODY_CERTCONF:
553 if (srv_ctx->process_certConf == NULL)
554 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
556 rsp = process_certConf(srv_ctx, req);
558 case OSSL_CMP_PKIBODY_POLLREQ:
559 if (srv_ctx->process_pollReq == NULL)
560 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
562 rsp = process_pollReq(srv_ctx, req);
565 /* TODO possibly support further request message types */
566 CMPerr(0, CMP_R_UNEXPECTED_PKIBODY);
572 /* on error, try to respond with CMP error message to client */
573 const char *data = NULL;
575 unsigned long err = ERR_peek_error_data(&data, &flags);
576 int fail_info = 1 << OSSL_CMP_PKIFAILUREINFO_badRequest;
577 /* TODO fail_info could be more specific */
578 OSSL_CMP_PKISI *si = NULL;
580 if (ctx->transactionID == NULL) {
581 /* ignore any (extra) error in next two function calls: */
582 (void)OSSL_CMP_CTX_set1_transactionID(ctx, hdr->transactionID);
583 (void)ossl_cmp_ctx_set1_recipNonce(ctx, hdr->senderNonce);
586 if ((si = OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_rejection,
587 fail_info, NULL)) != NULL) {
588 if (err != 0 && (flags & ERR_TXT_STRING) != 0)
589 data = ERR_reason_error_string(err);
590 rsp = ossl_cmp_error_new(srv_ctx->ctx, si,
591 err != 0 ? ERR_GET_REASON(err) : -1,
592 data, srv_ctx->sendUnprotectedErrors);
593 OSSL_CMP_PKISI_free(si);
596 ctx->secretValue = backup_secret;
598 /* possibly close the transaction */
600 rsp != NULL ? ossl_cmp_msg_get_bodytype(rsp) : OSSL_CMP_PKIBODY_ERROR;
602 case OSSL_CMP_PKIBODY_IP:
603 case OSSL_CMP_PKIBODY_CP:
604 case OSSL_CMP_PKIBODY_KUP:
605 case OSSL_CMP_PKIBODY_RP:
606 if (OSSL_CMP_CTX_get_option(ctx, OSSL_CMP_OPT_IMPLICIT_CONFIRM) == 0)
610 case OSSL_CMP_PKIBODY_PKICONF:
611 case OSSL_CMP_PKIBODY_GENP:
612 case OSSL_CMP_PKIBODY_ERROR:
613 /* TODO possibly support further terminating response message types */
614 /* prepare for next transaction, ignoring any errors here: */
615 (void)OSSL_CMP_CTX_set1_transactionID(ctx, NULL);
616 (void)OSSL_CMP_CTX_set1_senderNonce(ctx, NULL);
618 default: /* not closing transaction in other cases */
625 * Server interface that may substitute OSSL_CMP_MSG_http_perform at the client.
626 * The OSSL_CMP_SRV_CTX must be set as client_ctx->transfer_cb_arg.
627 * returns received message on success, else NULL and pushes an element on the
630 OSSL_CMP_MSG * OSSL_CMP_CTX_server_perform(OSSL_CMP_CTX *client_ctx,
631 const OSSL_CMP_MSG *req)
633 OSSL_CMP_SRV_CTX *srv_ctx = NULL;
635 if (client_ctx == NULL || req == NULL) {
636 CMPerr(0, CMP_R_NULL_ARGUMENT);
640 if ((srv_ctx = OSSL_CMP_CTX_get_transfer_cb_arg(client_ctx)) == NULL) {
641 CMPerr(0, CMP_R_TRANSFER_ERROR);
645 return OSSL_CMP_SRV_process_request(srv_ctx, req);