2 * Copyright 2007-2023 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 /* CMP functions for PKIStatusInfo handling and PKIMessage decomposition */
16 #include "cmp_local.h"
18 /* explicit #includes not strictly needed since implied by the above: */
20 #include <openssl/cmp.h>
21 #include <openssl/crmf.h>
22 #include <openssl/err.h> /* needed in case config no-deprecated */
23 #include <openssl/engine.h>
24 #include <openssl/evp.h>
25 #include <openssl/objects.h>
26 #include <openssl/x509.h>
27 #include <openssl/asn1err.h> /* for ASN1_R_TOO_SMALL and ASN1_R_TOO_LARGE */
29 /* CMP functions related to PKIStatus */
31 int ossl_cmp_pkisi_get_status(const OSSL_CMP_PKISI *si)
35 if (!ossl_assert(si != NULL && si->status != NULL))
37 res = ossl_cmp_asn1_get_int(si->status);
38 return res == -2 ? -1 : res;
41 const char *ossl_cmp_PKIStatus_to_string(int status)
44 case OSSL_CMP_PKISTATUS_accepted:
45 return "PKIStatus: accepted";
46 case OSSL_CMP_PKISTATUS_grantedWithMods:
47 return "PKIStatus: granted with modifications";
48 case OSSL_CMP_PKISTATUS_rejection:
49 return "PKIStatus: rejection";
50 case OSSL_CMP_PKISTATUS_waiting:
51 return "PKIStatus: waiting";
52 case OSSL_CMP_PKISTATUS_revocationWarning:
53 return "PKIStatus: revocation warning - a revocation of the cert is imminent";
54 case OSSL_CMP_PKISTATUS_revocationNotification:
55 return "PKIStatus: revocation notification - a revocation of the cert has occurred";
56 case OSSL_CMP_PKISTATUS_keyUpdateWarning:
57 return "PKIStatus: key update warning - update already done for the cert";
59 ERR_raise_data(ERR_LIB_CMP, CMP_R_ERROR_PARSING_PKISTATUS,
60 "PKIStatus: invalid=%d", status);
65 OSSL_CMP_PKIFREETEXT *ossl_cmp_pkisi_get0_statusString(const OSSL_CMP_PKISI *si)
67 if (!ossl_assert(si != NULL))
69 return si->statusString;
72 int ossl_cmp_pkisi_get_pkifailureinfo(const OSSL_CMP_PKISI *si)
77 if (!ossl_assert(si != NULL))
79 if (si->failInfo != NULL)
80 for (i = 0; i <= OSSL_CMP_PKIFAILUREINFO_MAX; i++)
81 if (ASN1_BIT_STRING_get_bit(si->failInfo, i))
87 * convert PKIFailureInfo number to human-readable string
88 * returns pointer to static string, or NULL on error
90 static const char *CMP_PKIFAILUREINFO_to_string(int number)
93 case OSSL_CMP_PKIFAILUREINFO_badAlg:
95 case OSSL_CMP_PKIFAILUREINFO_badMessageCheck:
96 return "badMessageCheck";
97 case OSSL_CMP_PKIFAILUREINFO_badRequest:
99 case OSSL_CMP_PKIFAILUREINFO_badTime:
101 case OSSL_CMP_PKIFAILUREINFO_badCertId:
103 case OSSL_CMP_PKIFAILUREINFO_badDataFormat:
104 return "badDataFormat";
105 case OSSL_CMP_PKIFAILUREINFO_wrongAuthority:
106 return "wrongAuthority";
107 case OSSL_CMP_PKIFAILUREINFO_incorrectData:
108 return "incorrectData";
109 case OSSL_CMP_PKIFAILUREINFO_missingTimeStamp:
110 return "missingTimeStamp";
111 case OSSL_CMP_PKIFAILUREINFO_badPOP:
113 case OSSL_CMP_PKIFAILUREINFO_certRevoked:
114 return "certRevoked";
115 case OSSL_CMP_PKIFAILUREINFO_certConfirmed:
116 return "certConfirmed";
117 case OSSL_CMP_PKIFAILUREINFO_wrongIntegrity:
118 return "wrongIntegrity";
119 case OSSL_CMP_PKIFAILUREINFO_badRecipientNonce:
120 return "badRecipientNonce";
121 case OSSL_CMP_PKIFAILUREINFO_timeNotAvailable:
122 return "timeNotAvailable";
123 case OSSL_CMP_PKIFAILUREINFO_unacceptedPolicy:
124 return "unacceptedPolicy";
125 case OSSL_CMP_PKIFAILUREINFO_unacceptedExtension:
126 return "unacceptedExtension";
127 case OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable:
128 return "addInfoNotAvailable";
129 case OSSL_CMP_PKIFAILUREINFO_badSenderNonce:
130 return "badSenderNonce";
131 case OSSL_CMP_PKIFAILUREINFO_badCertTemplate:
132 return "badCertTemplate";
133 case OSSL_CMP_PKIFAILUREINFO_signerNotTrusted:
134 return "signerNotTrusted";
135 case OSSL_CMP_PKIFAILUREINFO_transactionIdInUse:
136 return "transactionIdInUse";
137 case OSSL_CMP_PKIFAILUREINFO_unsupportedVersion:
138 return "unsupportedVersion";
139 case OSSL_CMP_PKIFAILUREINFO_notAuthorized:
140 return "notAuthorized";
141 case OSSL_CMP_PKIFAILUREINFO_systemUnavail:
142 return "systemUnavail";
143 case OSSL_CMP_PKIFAILUREINFO_systemFailure:
144 return "systemFailure";
145 case OSSL_CMP_PKIFAILUREINFO_duplicateCertReq:
146 return "duplicateCertReq";
148 return NULL; /* illegal failure number */
152 int ossl_cmp_pkisi_check_pkifailureinfo(const OSSL_CMP_PKISI *si, int bit_index)
154 if (!ossl_assert(si != NULL && si->failInfo != NULL))
156 if (bit_index < 0 || bit_index > OSSL_CMP_PKIFAILUREINFO_MAX) {
157 ERR_raise(ERR_LIB_CMP, CMP_R_INVALID_ARGS);
161 return ASN1_BIT_STRING_get_bit(si->failInfo, bit_index);
165 * place human-readable error string created from PKIStatusInfo in given buffer
166 * returns pointer to the same buffer containing the string, or NULL on error
169 char *snprint_PKIStatusInfo_parts(int status, int fail_info,
170 const OSSL_CMP_PKIFREETEXT *status_strings,
171 char *buf, size_t bufsize)
174 const char *status_string, *failure_string;
175 ASN1_UTF8STRING *text;
178 int failinfo_found = 0;
179 int n_status_strings;
180 char *write_ptr = buf;
184 || (status_string = ossl_cmp_PKIStatus_to_string(status)) == NULL)
187 #define ADVANCE_BUFFER \
188 if (printed_chars < 0 || (size_t)printed_chars >= bufsize) \
190 write_ptr += printed_chars; \
191 bufsize -= printed_chars;
193 printed_chars = BIO_snprintf(write_ptr, bufsize, "%s", status_string);
197 * failInfo is optional and may be empty;
198 * if present, print failInfo before statusString because it is more concise
200 if (fail_info != -1 && fail_info != 0) {
201 printed_chars = BIO_snprintf(write_ptr, bufsize, "; PKIFailureInfo: ");
203 for (failure = 0; failure <= OSSL_CMP_PKIFAILUREINFO_MAX; failure++) {
204 if ((fail_info & (1 << failure)) != 0) {
205 failure_string = CMP_PKIFAILUREINFO_to_string(failure);
206 if (failure_string != NULL) {
207 printed_chars = BIO_snprintf(write_ptr, bufsize, "%s%s",
208 failinfo_found ? ", " : "",
216 if (!failinfo_found && status != OSSL_CMP_PKISTATUS_accepted
217 && status != OSSL_CMP_PKISTATUS_grantedWithMods) {
218 printed_chars = BIO_snprintf(write_ptr, bufsize, "; <no failure info>");
222 /* statusString sequence is optional and may be empty */
223 n_status_strings = sk_ASN1_UTF8STRING_num(status_strings);
224 if (n_status_strings > 0) {
225 printed_chars = BIO_snprintf(write_ptr, bufsize, "; StatusString%s: ",
226 n_status_strings > 1 ? "s" : "");
228 for (i = 0; i < n_status_strings; i++) {
229 text = sk_ASN1_UTF8STRING_value(status_strings, i);
230 printed_chars = BIO_snprintf(write_ptr, bufsize, "\"%.*s\"%s",
231 ASN1_STRING_length(text),
232 ASN1_STRING_get0_data(text),
233 i < n_status_strings - 1 ? ", " : "");
237 #undef ADVANCE_BUFFER
241 char *OSSL_CMP_snprint_PKIStatusInfo(const OSSL_CMP_PKISI *statusInfo,
242 char *buf, size_t bufsize)
246 if (statusInfo == NULL) {
247 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
251 failure_info = ossl_cmp_pkisi_get_pkifailureinfo(statusInfo);
253 return snprint_PKIStatusInfo_parts(ASN1_INTEGER_get(statusInfo->status),
255 statusInfo->statusString, buf, bufsize);
258 char *OSSL_CMP_CTX_snprint_PKIStatus(const OSSL_CMP_CTX *ctx, char *buf,
262 ERR_raise(ERR_LIB_CMP, CMP_R_NULL_ARGUMENT);
266 return snprint_PKIStatusInfo_parts(OSSL_CMP_CTX_get_status(ctx),
267 OSSL_CMP_CTX_get_failInfoCode(ctx),
268 OSSL_CMP_CTX_get0_statusString(ctx),
273 * Creates a new PKIStatusInfo structure and fills it in
274 * returns a pointer to the structure on success, NULL on error
275 * note: strongly overlaps with TS_RESP_CTX_set_status_info()
276 * and TS_RESP_CTX_add_failure_info() in ../ts/ts_rsp_sign.c
278 OSSL_CMP_PKISI *OSSL_CMP_STATUSINFO_new(int status, int fail_info,
281 OSSL_CMP_PKISI *si = OSSL_CMP_PKISI_new();
282 ASN1_UTF8STRING *utf8_text = NULL;
287 if (!ASN1_INTEGER_set(si->status, status))
291 if ((utf8_text = ASN1_UTF8STRING_new()) == NULL
292 || !ASN1_STRING_set(utf8_text, text, -1))
294 if ((si->statusString = sk_ASN1_UTF8STRING_new_null()) == NULL)
296 if (!sk_ASN1_UTF8STRING_push(si->statusString, utf8_text))
298 /* Ownership is lost. */
302 for (failure = 0; failure <= OSSL_CMP_PKIFAILUREINFO_MAX; failure++) {
303 if ((fail_info & (1 << failure)) != 0) {
304 if (si->failInfo == NULL
305 && (si->failInfo = ASN1_BIT_STRING_new()) == NULL)
307 if (!ASN1_BIT_STRING_set_bit(si->failInfo, failure, 1))
314 OSSL_CMP_PKISI_free(si);
315 ASN1_UTF8STRING_free(utf8_text);