crypto/cmp/cmp_hdr.c

   1 /*
   2  * Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright Nokia 2007-2019
   4  * Copyright Siemens AG 2015-2019
   5  *
   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
  10  */
  11
  12 /* CMP functions for PKIHeader handling */
  13
  14 #include "cmp_local.h"
  15
  16 #include <openssl/rand.h>
  17
  18 /* explicit #includes not strictly needed since implied by the above: */
  19 #include <openssl/asn1t.h>
  20 #include <openssl/cmp.h>
  21 #include <openssl/err.h>
  22
  23 int ossl_cmp_hdr_set_pvno(OSSL_CMP_PKIHEADER *hdr, int pvno)
  24 {
  25     if (!ossl_assert(hdr != NULL))
  26         return 0;
  27     return ASN1_INTEGER_set(hdr->pvno, pvno);
  28 }
  29
  30 int ossl_cmp_hdr_get_pvno(const OSSL_CMP_PKIHEADER *hdr)
  31 {
  32     int64_t pvno;
  33
  34     if (!ossl_assert(hdr != NULL))
  35         return -1;
  36     if (!ASN1_INTEGER_get_int64(&pvno, hdr->pvno) || pvno < 0 || pvno > INT_MAX)
  37         return -1;
  38     return (int)pvno;
  39 }
  40
  41 ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_transactionID(const OSSL_CMP_PKIHEADER *hdr)
  42 {
  43     if (hdr == NULL) {
  44         CMPerr(0, CMP_R_NULL_ARGUMENT);
  45         return NULL;
  46     }
  47     return hdr->transactionID;
  48 }
  49
  50 ASN1_OCTET_STRING *ossl_cmp_hdr_get0_senderNonce(const OSSL_CMP_PKIHEADER *hdr)
  51 {
  52     if (!ossl_assert(hdr != NULL))
  53         return NULL;
  54     return hdr->senderNonce;
  55 }
  56
  57 ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_recipNonce(const OSSL_CMP_PKIHEADER *hdr)
  58 {
  59     if (hdr == NULL) {
  60         CMPerr(0, CMP_R_NULL_ARGUMENT);
  61         return NULL;
  62     }
  63     return hdr->recipNonce;
  64 }
  65
  66 /* assign to *tgt a copy of src (which may be NULL to indicate an empty DN) */
  67 static int set1_general_name(GENERAL_NAME **tgt, const X509_NAME *src)
  68 {
  69     GENERAL_NAME *gen;
  70
  71     if (!ossl_assert(tgt != NULL))
  72         return 0;
  73     if ((gen = GENERAL_NAME_new()) == NULL)
  74         goto err;
  75     gen->type = GEN_DIRNAME;
  76
  77     if (src == NULL) { /* NULL-DN */
  78         if ((gen->d.directoryName = X509_NAME_new()) == NULL)
  79             goto err;
  80     } else if (!X509_NAME_set(&gen->d.directoryName, src)) {
  81         goto err;
  82     }
  83
  84     GENERAL_NAME_free(*tgt);
  85     *tgt = gen;
  86
  87     return 1;
  88
  89  err:
  90     GENERAL_NAME_free(gen);
  91     return 0;
  92 }
  93
  94 /*
  95  * Set the sender name in PKIHeader.
  96  * when nm is NULL, sender is set to an empty string
  97  * returns 1 on success, 0 on error
  98  */
  99 int ossl_cmp_hdr_set1_sender(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm)
 100 {
 101     if (!ossl_assert(hdr != NULL))
 102         return 0;
 103     return set1_general_name(&hdr->sender, nm);
 104 }
 105
 106 int ossl_cmp_hdr_set1_recipient(OSSL_CMP_PKIHEADER *hdr, const X509_NAME *nm)
 107 {
 108     if (!ossl_assert(hdr != NULL))
 109         return 0;
 110     return set1_general_name(&hdr->recipient, nm);
 111 }
 112
 113 int ossl_cmp_hdr_update_messageTime(OSSL_CMP_PKIHEADER *hdr)
 114 {
 115     if (!ossl_assert(hdr != NULL))
 116         return 0;
 117     if (hdr->messageTime == NULL
 118             && (hdr->messageTime = ASN1_GENERALIZEDTIME_new()) == NULL)
 119         return 0;
 120     return ASN1_GENERALIZEDTIME_set(hdr->messageTime, time(NULL)) != NULL;
 121 }
 122
 123 /* assign to *tgt a copy of src (or if NULL a random byte array of given len) */
 124 static int set1_aostr_else_random(ASN1_OCTET_STRING **tgt,
 125                                   const ASN1_OCTET_STRING *src, size_t len)
 126 {
 127     unsigned char *bytes = NULL;
 128     int res = 0;
 129
 130     if (src == NULL) { /* generate a random value if src == NULL */
 131         if ((bytes = OPENSSL_malloc(len)) == NULL)
 132             goto err;
 133         if (RAND_bytes(bytes, len) <= 0) {
 134             CMPerr(0, CMP_R_FAILURE_OBTAINING_RANDOM);
 135             goto err;
 136         }
 137         res = ossl_cmp_asn1_octet_string_set1_bytes(tgt, bytes, len);
 138     } else {
 139         res = ossl_cmp_asn1_octet_string_set1(tgt, src);
 140     }
 141
 142  err:
 143     OPENSSL_free(bytes);
 144     return res;
 145 }
 146
 147 int ossl_cmp_hdr_set1_senderKID(OSSL_CMP_PKIHEADER *hdr,
 148                                 const ASN1_OCTET_STRING *senderKID)
 149 {
 150     if (!ossl_assert(hdr != NULL))
 151         return 0;
 152     return ossl_cmp_asn1_octet_string_set1(&hdr->senderKID, senderKID);
 153 }
 154
 155 /* push the given text string to the given PKIFREETEXT ft */
 156 int ossl_cmp_hdr_push0_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text)
 157 {
 158     if (!ossl_assert(hdr != NULL && text != NULL))
 159         return 0;
 160
 161     if (hdr->freeText == NULL
 162             && (hdr->freeText = sk_ASN1_UTF8STRING_new_null()) == NULL)
 163         return 0;
 164
 165     return sk_ASN1_UTF8STRING_push(hdr->freeText, text);
 166 }
 167
 168 int ossl_cmp_hdr_push1_freeText(OSSL_CMP_PKIHEADER *hdr, ASN1_UTF8STRING *text)
 169 {
 170     if (!ossl_assert(hdr != NULL && text != NULL))
 171         return 0;
 172
 173     if (hdr->freeText == NULL
 174             && (hdr->freeText = sk_ASN1_UTF8STRING_new_null()) == NULL)
 175         return 0;
 176
 177     return
 178         ossl_cmp_sk_ASN1_UTF8STRING_push_str(hdr->freeText, (char *)text->data);
 179 }
 180
 181 int ossl_cmp_hdr_generalInfo_push0_item(OSSL_CMP_PKIHEADER *hdr,
 182                                         OSSL_CMP_ITAV *itav)
 183 {
 184     if (!ossl_assert(hdr != NULL && itav != NULL))
 185         return 0;
 186     return OSSL_CMP_ITAV_push0_stack_item(&hdr->generalInfo, itav);
 187 }
 188
 189 int ossl_cmp_hdr_generalInfo_push1_items(OSSL_CMP_PKIHEADER *hdr,
 190                                          const STACK_OF(OSSL_CMP_ITAV) *itavs)
 191 {
 192     int i;
 193     OSSL_CMP_ITAV *itav;
 194
 195     if (!ossl_assert(hdr != NULL))
 196         return 0;
 197
 198     for (i = 0; i < sk_OSSL_CMP_ITAV_num(itavs); i++) {
 199         itav = OSSL_CMP_ITAV_dup(sk_OSSL_CMP_ITAV_value(itavs, i));
 200         if (itav == NULL)
 201             return 0;
 202
 203         if (!ossl_cmp_hdr_generalInfo_push0_item(hdr, itav)) {
 204             OSSL_CMP_ITAV_free(itav);
 205             return 0;
 206         }
 207     }
 208     return 1;
 209 }
 210
 211 int ossl_cmp_hdr_set_implicitConfirm(OSSL_CMP_PKIHEADER *hdr)
 212 {
 213     OSSL_CMP_ITAV *itav;
 214     ASN1_TYPE *asn1null;
 215
 216     if (!ossl_assert(hdr != NULL))
 217         return 0;
 218     asn1null = (ASN1_TYPE *)ASN1_NULL_new();
 219     if (asn1null == NULL)
 220         return 0;
 221     if ((itav = OSSL_CMP_ITAV_create(OBJ_nid2obj(NID_id_it_implicitConfirm),
 222                                      asn1null)) == NULL)
 223         goto err;
 224     if (!ossl_cmp_hdr_generalInfo_push0_item(hdr, itav))
 225         goto err;
 226     return 1;
 227
 228  err:
 229     ASN1_TYPE_free(asn1null);
 230     OSSL_CMP_ITAV_free(itav);
 231     return 0;
 232 }
 233
 234 /* return 1 if implicitConfirm in the generalInfo field of the header is set */
 235 int ossl_cmp_hdr_has_implicitConfirm(const OSSL_CMP_PKIHEADER *hdr)
 236 {
 237     int itavCount;
 238     int i;
 239     OSSL_CMP_ITAV *itav;
 240
 241     if (!ossl_assert(hdr != NULL))
 242         return 0;
 243
 244     itavCount = sk_OSSL_CMP_ITAV_num(hdr->generalInfo);
 245     for (i = 0; i < itavCount; i++) {
 246         itav = sk_OSSL_CMP_ITAV_value(hdr->generalInfo, i);
 247         if (itav != NULL
 248                 && OBJ_obj2nid(itav->infoType) == NID_id_it_implicitConfirm)
 249             return 1;
 250     }
 251
 252     return 0;
 253 }
 254
 255 /* fill in all fields of the hdr according to the info given in ctx */
 256 int ossl_cmp_hdr_init(OSSL_CMP_CTX *ctx, OSSL_CMP_PKIHEADER *hdr)
 257 {
 258     X509_NAME *sender;
 259     X509_NAME *rcp = NULL;
 260
 261     if (!ossl_assert(ctx != NULL && hdr != NULL))
 262         return 0;
 263
 264     /* set the CMP version */
 265     if (!ossl_cmp_hdr_set_pvno(hdr, OSSL_CMP_PVNO))
 266         return 0;
 267
 268     sender = ctx->clCert != NULL ?
 269         X509_get_subject_name(ctx->clCert) : ctx->subjectName;
 270     /*
 271      * The sender name is copied from the subject of the client cert, if any,
 272      * or else from the subject name provided for certification requests.
 273      * As required by RFC 4210 section 5.1.1., if the sender name is not known
 274      * to the client it set to NULL-DN. In this case for identification at least
 275      * the senderKID must be set, which we take from any referenceValue given.
 276      */
 277     if (sender == NULL && ctx->referenceValue == NULL) {
 278         CMPerr(0, CMP_R_MISSING_SENDER_IDENTIFICATION);
 279         return 0;
 280     }
 281     if (!ossl_cmp_hdr_set1_sender(hdr, sender))
 282         return 0;
 283
 284     /* determine recipient entry in PKIHeader */
 285     if (ctx->srvCert != NULL) {
 286         rcp = X509_get_subject_name(ctx->srvCert);
 287         /* set also as expected_sender of responses unless set explicitly */
 288         if (ctx->expected_sender == NULL && rcp != NULL
 289                 && !OSSL_CMP_CTX_set1_expected_sender(ctx, rcp))
 290             return 0;
 291     } else if (ctx->recipient != NULL) {
 292         rcp = ctx->recipient;
 293     } else if (ctx->issuer != NULL) {
 294         rcp = ctx->issuer;
 295     } else if (ctx->oldCert != NULL) {
 296         rcp = X509_get_issuer_name(ctx->oldCert);
 297     } else if (ctx->clCert != NULL) {
 298         rcp = X509_get_issuer_name(ctx->clCert);
 299     }
 300     if (!ossl_cmp_hdr_set1_recipient(hdr, rcp))
 301         return 0;
 302
 303     /* set current time as message time */
 304     if (!ossl_cmp_hdr_update_messageTime(hdr))
 305         return 0;
 306
 307     if (ctx->recipNonce != NULL
 308             && !ossl_cmp_asn1_octet_string_set1(&hdr->recipNonce,
 309                                                 ctx->recipNonce))
 310         return 0;
 311
 312     /*
 313      * set ctx->transactionID in CMP header
 314      * if ctx->transactionID is NULL, a random one is created with 128 bit
 315      * according to section 5.1.1:
 316      *
 317      * It is RECOMMENDED that the clients fill the transactionID field with
 318      * 128 bits of (pseudo-) random data for the start of a transaction to
 319      * reduce the probability of having the transactionID in use at the server.
 320      */
 321     if (ctx->transactionID == NULL
 322             && !set1_aostr_else_random(&ctx->transactionID, NULL,
 323                                        OSSL_CMP_TRANSACTIONID_LENGTH))
 324         return 0;
 325     if (!ossl_cmp_asn1_octet_string_set1(&hdr->transactionID,
 326                                          ctx->transactionID))
 327         return 0;
 328
 329     /*-
 330      * set random senderNonce
 331      * according to section 5.1.1:
 332      *
 333      * senderNonce                  present
 334      *         -- 128 (pseudo-)random bits
 335      * The senderNonce and recipNonce fields protect the PKIMessage against
 336      * replay attacks. The senderNonce will typically be 128 bits of
 337      * (pseudo-) random data generated by the sender, whereas the recipNonce
 338      * is copied from the senderNonce of the previous message in the
 339      * transaction.
 340      */
 341     if (!set1_aostr_else_random(&hdr->senderNonce, NULL,
 342                                 OSSL_CMP_SENDERNONCE_LENGTH))
 343         return 0;
 344
 345     /* store senderNonce - for cmp with recipNonce in next outgoing msg */
 346     if (!OSSL_CMP_CTX_set1_senderNonce(ctx, hdr->senderNonce))
 347         return 0;
 348
 349     /*-
 350      * freeText                [7] PKIFreeText OPTIONAL,
 351      * -- this may be used to indicate context-specific instructions
 352      * -- (this field is intended for human consumption)
 353      */
 354     if (ctx->freeText != NULL
 355             && !ossl_cmp_hdr_push1_freeText(hdr, ctx->freeText))
 356         return 0;
 357
 358     return 1;
 359 }