2 * Copyright 2018-2022 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Siemens AG 2018-2020
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or atf
8 * https://www.openssl.org/source/license.html
12 #include "cmp_mock_srv.h"
14 #include <openssl/cmp.h>
15 #include <openssl/err.h>
16 #include <openssl/cmperr.h>
18 /* the context for the CMP mock server */
21 X509 *refCert; /* cert to expect for oldCertID in kur/rr msg */
22 X509 *certOut; /* certificate to be returned in cp/ip/kup msg */
23 STACK_OF(X509) *chainOut; /* chain of certOut to add to extraCerts field */
24 STACK_OF(X509) *caPubsOut; /* certs to return in caPubs field of ip msg */
25 OSSL_CMP_PKISI *statusOut; /* status for ip/cp/kup/rp msg unless polling */
26 int sendError; /* send error response also on valid requests */
27 OSSL_CMP_MSG *certReq; /* ir/cr/p10cr/kur remembered while polling */
28 int certReqId; /* id of last ir/cr/kur, used for polling */
29 int pollCount; /* number of polls before actual cert response */
30 int curr_pollCount; /* number of polls so far for current request */
31 int checkAfterTime; /* time the client should wait between polling */
35 static void mock_srv_ctx_free(mock_srv_ctx *ctx)
40 OSSL_CMP_PKISI_free(ctx->statusOut);
41 X509_free(ctx->refCert);
42 X509_free(ctx->certOut);
43 OSSL_STACK_OF_X509_free(ctx->chainOut);
44 OSSL_STACK_OF_X509_free(ctx->caPubsOut);
45 OSSL_CMP_MSG_free(ctx->certReq);
49 static mock_srv_ctx *mock_srv_ctx_new(void)
51 mock_srv_ctx *ctx = OPENSSL_zalloc(sizeof(mock_srv_ctx));
56 if ((ctx->statusOut = OSSL_CMP_PKISI_new()) == NULL)
61 /* all other elements are initialized to 0 or NULL, respectively */
64 mock_srv_ctx_free(ctx);
68 int ossl_cmp_mock_srv_set1_refCert(OSSL_CMP_SRV_CTX *srv_ctx, X509 *cert)
70 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
73 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
76 if (cert == NULL || X509_up_ref(cert)) {
77 X509_free(ctx->refCert);
84 int ossl_cmp_mock_srv_set1_certOut(OSSL_CMP_SRV_CTX *srv_ctx, X509 *cert)
86 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
89 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
92 if (cert == NULL || X509_up_ref(cert)) {
93 X509_free(ctx->certOut);
100 int ossl_cmp_mock_srv_set1_chainOut(OSSL_CMP_SRV_CTX *srv_ctx,
101 STACK_OF(X509) *chain)
103 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
104 STACK_OF(X509) *chain_copy = NULL;
107 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
110 if (chain != NULL && (chain_copy = X509_chain_up_ref(chain)) == NULL)
112 OSSL_STACK_OF_X509_free(ctx->chainOut);
113 ctx->chainOut = chain_copy;
117 int ossl_cmp_mock_srv_set1_caPubsOut(OSSL_CMP_SRV_CTX *srv_ctx,
118 STACK_OF(X509) *caPubs)
120 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
121 STACK_OF(X509) *caPubs_copy = NULL;
124 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
127 if (caPubs != NULL && (caPubs_copy = X509_chain_up_ref(caPubs)) == NULL)
129 OSSL_STACK_OF_X509_free(ctx->caPubsOut);
130 ctx->caPubsOut = caPubs_copy;
134 int ossl_cmp_mock_srv_set_statusInfo(OSSL_CMP_SRV_CTX *srv_ctx, int status,
135 int fail_info, const char *text)
137 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
141 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
144 if ((si = OSSL_CMP_STATUSINFO_new(status, fail_info, text)) == NULL)
146 OSSL_CMP_PKISI_free(ctx->statusOut);
151 int ossl_cmp_mock_srv_set_send_error(OSSL_CMP_SRV_CTX *srv_ctx, int val)
153 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
156 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
159 ctx->sendError = val != 0;
163 int ossl_cmp_mock_srv_set_pollCount(OSSL_CMP_SRV_CTX *srv_ctx, int count)
165 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
168 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
172 ERR_raise(ERR_LIB_CMP, CMP_R_INVALID_ARGS);
175 ctx->pollCount = count;
179 int ossl_cmp_mock_srv_set_checkAfterTime(OSSL_CMP_SRV_CTX *srv_ctx, int sec)
181 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
184 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
187 ctx->checkAfterTime = sec;
191 /* check for matching reference cert components, as far as given */
192 static int refcert_cmp(const X509 *refcert,
193 const X509_NAME *issuer, const ASN1_INTEGER *serial)
195 const X509_NAME *ref_issuer;
196 const ASN1_INTEGER *ref_serial;
200 ref_issuer = X509_get_issuer_name(refcert);
201 ref_serial = X509_get0_serialNumber(refcert);
202 return (ref_issuer == NULL || X509_NAME_cmp(issuer, ref_issuer) == 0)
203 && (ref_serial == NULL || ASN1_INTEGER_cmp(serial, ref_serial) == 0);
206 static OSSL_CMP_PKISI *process_cert_request(OSSL_CMP_SRV_CTX *srv_ctx,
207 const OSSL_CMP_MSG *cert_req,
209 const OSSL_CRMF_MSG *crm,
210 const X509_REQ *p10cr,
212 STACK_OF(X509) **chainOut,
213 STACK_OF(X509) **caPubs)
215 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
216 OSSL_CMP_PKISI *si = NULL;
218 if (ctx == NULL || cert_req == NULL
219 || certOut == NULL || chainOut == NULL || caPubs == NULL) {
220 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
223 if (ctx->sendError) {
224 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_PROCESSING_MESSAGE);
231 ctx->certReqId = certReqId;
233 if (ctx->pollCount > 0 && ctx->curr_pollCount == 0) {
235 if (ctx->certReq != NULL) {
236 /* already in polling mode */
237 ERR_raise(ERR_LIB_CMP, CMP_R_UNEXPECTED_PKIBODY);
240 if ((ctx->certReq = OSSL_CMP_MSG_dup(cert_req)) == NULL)
242 return OSSL_CMP_STATUSINFO_new(OSSL_CMP_PKISTATUS_waiting, 0, NULL);
244 if (ctx->curr_pollCount >= ctx->pollCount)
245 /* give final response after polling */
246 ctx->curr_pollCount = 0;
248 /* accept cert update request only for the reference cert, if given */
249 if (OSSL_CMP_MSG_get_bodytype(cert_req) == OSSL_CMP_KUR
250 && crm != NULL /* thus not p10cr */ && ctx->refCert != NULL) {
251 const OSSL_CRMF_CERTID *cid = OSSL_CRMF_MSG_get0_regCtrl_oldCertID(crm);
254 ERR_raise(ERR_LIB_CMP, CMP_R_MISSING_CERTID);
257 if (!refcert_cmp(ctx->refCert,
258 OSSL_CRMF_CERTID_get0_issuer(cid),
259 OSSL_CRMF_CERTID_get0_serialNumber(cid))) {
260 ERR_raise(ERR_LIB_CMP, CMP_R_WRONG_CERTID);
265 if (ctx->certOut != NULL
266 && (*certOut = X509_dup(ctx->certOut)) == NULL)
268 if (ctx->chainOut != NULL
269 && (*chainOut = X509_chain_up_ref(ctx->chainOut)) == NULL)
271 if (ctx->caPubsOut != NULL
272 && (*caPubs = X509_chain_up_ref(ctx->caPubsOut)) == NULL)
274 if (ctx->statusOut != NULL
275 && (si = OSSL_CMP_PKISI_dup(ctx->statusOut)) == NULL)
282 OSSL_STACK_OF_X509_free(*chainOut);
284 OSSL_STACK_OF_X509_free(*caPubs);
289 static OSSL_CMP_PKISI *process_rr(OSSL_CMP_SRV_CTX *srv_ctx,
290 const OSSL_CMP_MSG *rr,
291 const X509_NAME *issuer,
292 const ASN1_INTEGER *serial)
294 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
296 if (ctx == NULL || rr == NULL) {
297 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
300 if (ctx->sendError) {
301 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_PROCESSING_MESSAGE);
305 /* allow any RR derived from CSR which does not include issuer and serial */
306 if ((issuer != NULL || serial != NULL)
307 /* accept revocation only for the reference cert, if given */
308 && !refcert_cmp(ctx->refCert, issuer, serial)) {
309 ERR_raise_data(ERR_LIB_CMP, CMP_R_REQUEST_NOT_ACCEPTED,
310 "wrong certificate to revoke");
313 return OSSL_CMP_PKISI_dup(ctx->statusOut);
316 static int process_genm(OSSL_CMP_SRV_CTX *srv_ctx,
317 const OSSL_CMP_MSG *genm,
318 const STACK_OF(OSSL_CMP_ITAV) *in,
319 STACK_OF(OSSL_CMP_ITAV) **out)
321 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
323 if (ctx == NULL || genm == NULL || in == NULL || out == NULL) {
324 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
327 if (ctx->sendError) {
328 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_PROCESSING_MESSAGE);
332 *out = sk_OSSL_CMP_ITAV_deep_copy(in, OSSL_CMP_ITAV_dup,
337 static void process_error(OSSL_CMP_SRV_CTX *srv_ctx, const OSSL_CMP_MSG *error,
338 const OSSL_CMP_PKISI *statusInfo,
339 const ASN1_INTEGER *errorCode,
340 const OSSL_CMP_PKIFREETEXT *errorDetails)
342 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
343 char buf[OSSL_CMP_PKISI_BUFLEN];
347 if (ctx == NULL || error == NULL) {
348 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
352 BIO_printf(bio_err, "mock server received error:\n");
354 if (statusInfo == NULL) {
355 BIO_printf(bio_err, "pkiStatusInfo absent\n");
357 sibuf = OSSL_CMP_snprint_PKIStatusInfo(statusInfo, buf, sizeof(buf));
358 BIO_printf(bio_err, "pkiStatusInfo: %s\n",
359 sibuf != NULL ? sibuf: "<invalid>");
362 if (errorCode == NULL)
363 BIO_printf(bio_err, "errorCode absent\n");
365 BIO_printf(bio_err, "errorCode: %ld\n", ASN1_INTEGER_get(errorCode));
367 if (sk_ASN1_UTF8STRING_num(errorDetails) <= 0) {
368 BIO_printf(bio_err, "errorDetails absent\n");
370 BIO_printf(bio_err, "errorDetails: ");
371 for (i = 0; i < sk_ASN1_UTF8STRING_num(errorDetails); i++) {
373 BIO_printf(bio_err, ", ");
374 BIO_printf(bio_err, "\"");
375 ASN1_STRING_print(bio_err,
376 sk_ASN1_UTF8STRING_value(errorDetails, i));
377 BIO_printf(bio_err, "\"");
379 BIO_printf(bio_err, "\n");
383 static int process_certConf(OSSL_CMP_SRV_CTX *srv_ctx,
384 const OSSL_CMP_MSG *certConf, int certReqId,
385 const ASN1_OCTET_STRING *certHash,
386 const OSSL_CMP_PKISI *si)
388 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
389 ASN1_OCTET_STRING *digest;
391 if (ctx == NULL || certConf == NULL || certHash == NULL) {
392 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
395 if (ctx->sendError || ctx->certOut == NULL) {
396 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_PROCESSING_MESSAGE);
400 if (certReqId != ctx->certReqId) {
401 /* in case of error, invalid reqId -1 */
402 ERR_raise(ERR_LIB_CMP, CMP_R_BAD_REQUEST_ID);
406 if ((digest = X509_digest_sig(ctx->certOut, NULL, NULL)) == NULL)
408 if (ASN1_OCTET_STRING_cmp(certHash, digest) != 0) {
409 ASN1_OCTET_STRING_free(digest);
410 ERR_raise(ERR_LIB_CMP, CMP_R_CERTHASH_UNMATCHED);
413 ASN1_OCTET_STRING_free(digest);
417 static int process_pollReq(OSSL_CMP_SRV_CTX *srv_ctx,
418 const OSSL_CMP_MSG *pollReq, int certReqId,
419 OSSL_CMP_MSG **certReq, int64_t *check_after)
421 mock_srv_ctx *ctx = OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx);
423 if (ctx == NULL || pollReq == NULL
424 || certReq == NULL || check_after == NULL) {
425 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
428 if (ctx->sendError) {
430 ERR_raise(ERR_LIB_CMP, CMP_R_ERROR_PROCESSING_MESSAGE);
433 if (ctx->certReq == NULL) {
434 /* not currently in polling mode */
436 ERR_raise(ERR_LIB_CMP, CMP_R_UNEXPECTED_PKIBODY);
440 if (++ctx->curr_pollCount >= ctx->pollCount) {
442 *certReq = ctx->certReq;
447 *check_after = ctx->checkAfterTime;
452 OSSL_CMP_SRV_CTX *ossl_cmp_mock_srv_new(OSSL_LIB_CTX *libctx, const char *propq)
454 OSSL_CMP_SRV_CTX *srv_ctx = OSSL_CMP_SRV_CTX_new(libctx, propq);
455 mock_srv_ctx *ctx = mock_srv_ctx_new();
457 if (srv_ctx != NULL && ctx != NULL
458 && OSSL_CMP_SRV_CTX_init(srv_ctx, ctx, process_cert_request,
459 process_rr, process_genm, process_error,
460 process_certConf, process_pollReq))
463 mock_srv_ctx_free(ctx);
464 OSSL_CMP_SRV_CTX_free(srv_ctx);
468 void ossl_cmp_mock_srv_free(OSSL_CMP_SRV_CTX *srv_ctx)
471 mock_srv_ctx_free(OSSL_CMP_SRV_CTX_get0_custom_ctx(srv_ctx));
472 OSSL_CMP_SRV_CTX_free(srv_ctx);