ssl/ssl_asn1.c

   1 /*
   2  * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright 2005 Nokia. All rights reserved.
   4  *
   5  * Licensed under the OpenSSL license (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 at
   8  * https://www.openssl.org/source/license.html
   9  */
  10
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include "ssl_locl.h"
  14 #include <openssl/asn1t.h>
  15 #include <openssl/x509.h>
  16
  17 typedef struct {
  18     uint32_t version;
  19     int32_t ssl_version;
  20     ASN1_OCTET_STRING *cipher;
  21     ASN1_OCTET_STRING *comp_id;
  22     ASN1_OCTET_STRING *master_key;
  23     ASN1_OCTET_STRING *session_id;
  24     ASN1_OCTET_STRING *key_arg;
  25     int64_t time;
  26     int64_t timeout;
  27     X509 *peer;
  28     ASN1_OCTET_STRING *session_id_context;
  29     int32_t verify_result;
  30     ASN1_OCTET_STRING *tlsext_hostname;
  31     uint64_t tlsext_tick_lifetime_hint;
  32     uint32_t tlsext_tick_age_add;
  33     ASN1_OCTET_STRING *tlsext_tick;
  34 #ifndef OPENSSL_NO_PSK
  35     ASN1_OCTET_STRING *psk_identity_hint;
  36     ASN1_OCTET_STRING *psk_identity;
  37 #endif
  38 #ifndef OPENSSL_NO_SRP
  39     ASN1_OCTET_STRING *srp_username;
  40 #endif
  41     uint64_t flags;
  42     uint32_t max_early_data;
  43     ASN1_OCTET_STRING *alpn_selected;
  44 } SSL_SESSION_ASN1;
  45
  46 ASN1_SEQUENCE(SSL_SESSION_ASN1) = {
  47     ASN1_EMBED(SSL_SESSION_ASN1, version, UINT32),
  48     ASN1_EMBED(SSL_SESSION_ASN1, ssl_version, INT32),
  49     ASN1_SIMPLE(SSL_SESSION_ASN1, cipher, ASN1_OCTET_STRING),
  50     ASN1_SIMPLE(SSL_SESSION_ASN1, session_id, ASN1_OCTET_STRING),
  51     ASN1_SIMPLE(SSL_SESSION_ASN1, master_key, ASN1_OCTET_STRING),
  52     ASN1_IMP_OPT(SSL_SESSION_ASN1, key_arg, ASN1_OCTET_STRING, 0),
  53     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, time, ZINT64, 1),
  54     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, timeout, ZINT64, 2),
  55     ASN1_EXP_OPT(SSL_SESSION_ASN1, peer, X509, 3),
  56     ASN1_EXP_OPT(SSL_SESSION_ASN1, session_id_context, ASN1_OCTET_STRING, 4),
  57     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, verify_result, ZINT32, 5),
  58     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_hostname, ASN1_OCTET_STRING, 6),
  59 #ifndef OPENSSL_NO_PSK
  60     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity_hint, ASN1_OCTET_STRING, 7),
  61     ASN1_EXP_OPT(SSL_SESSION_ASN1, psk_identity, ASN1_OCTET_STRING, 8),
  62 #endif
  63     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, tlsext_tick_lifetime_hint, ZUINT64, 9),
  64     ASN1_EXP_OPT(SSL_SESSION_ASN1, tlsext_tick, ASN1_OCTET_STRING, 10),
  65     ASN1_EXP_OPT(SSL_SESSION_ASN1, comp_id, ASN1_OCTET_STRING, 11),
  66 #ifndef OPENSSL_NO_SRP
  67     ASN1_EXP_OPT(SSL_SESSION_ASN1, srp_username, ASN1_OCTET_STRING, 12),
  68 #endif
  69     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, flags, ZUINT64, 13),
  70     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, tlsext_tick_age_add, ZUINT32, 14),
  71     ASN1_EXP_OPT_EMBED(SSL_SESSION_ASN1, max_early_data, ZUINT32, 15),
  72     ASN1_EXP_OPT(SSL_SESSION_ASN1, alpn_selected, ASN1_OCTET_STRING, 16)
  73 } static_ASN1_SEQUENCE_END(SSL_SESSION_ASN1)
  74
  75 IMPLEMENT_STATIC_ASN1_ENCODE_FUNCTIONS(SSL_SESSION_ASN1)
  76
  77 /* Utility functions for i2d_SSL_SESSION */
  78
  79 /* Initialise OCTET STRING from buffer and length */
  80
  81 static void ssl_session_oinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
  82                               unsigned char *data, size_t len)
  83 {
  84     os->data = data;
  85     os->length = (int)len;
  86     os->flags = 0;
  87     *dest = os;
  88 }
  89
  90 /* Initialise OCTET STRING from string */
  91 static void ssl_session_sinit(ASN1_OCTET_STRING **dest, ASN1_OCTET_STRING *os,
  92                               char *data)
  93 {
  94     if (data != NULL)
  95         ssl_session_oinit(dest, os, (unsigned char *)data, strlen(data));
  96     else
  97         *dest = NULL;
  98 }
  99
 100 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp)
 101 {
 102
 103     SSL_SESSION_ASN1 as;
 104
 105     ASN1_OCTET_STRING cipher;
 106     unsigned char cipher_data[2];
 107     ASN1_OCTET_STRING master_key, session_id, sid_ctx;
 108
 109 #ifndef OPENSSL_NO_COMP
 110     ASN1_OCTET_STRING comp_id;
 111     unsigned char comp_id_data;
 112 #endif
 113     ASN1_OCTET_STRING tlsext_hostname, tlsext_tick;
 114 #ifndef OPENSSL_NO_SRP
 115     ASN1_OCTET_STRING srp_username;
 116 #endif
 117 #ifndef OPENSSL_NO_PSK
 118     ASN1_OCTET_STRING psk_identity, psk_identity_hint;
 119 #endif
 120     ASN1_OCTET_STRING alpn_selected;
 121
 122     long l;
 123
 124     if ((in == NULL) || ((in->cipher == NULL) && (in->cipher_id == 0)))
 125         return 0;
 126
 127     memset(&as, 0, sizeof(as));
 128
 129     as.version = SSL_SESSION_ASN1_VERSION;
 130     as.ssl_version = in->ssl_version;
 131
 132     if (in->cipher == NULL)
 133         l = in->cipher_id;
 134     else
 135         l = in->cipher->id;
 136     cipher_data[0] = ((unsigned char)(l >> 8L)) & 0xff;
 137     cipher_data[1] = ((unsigned char)(l)) & 0xff;
 138
 139     ssl_session_oinit(&as.cipher, &cipher, cipher_data, 2);
 140
 141 #ifndef OPENSSL_NO_COMP
 142     if (in->compress_meth) {
 143         comp_id_data = (unsigned char)in->compress_meth;
 144         ssl_session_oinit(&as.comp_id, &comp_id, &comp_id_data, 1);
 145     }
 146 #endif
 147
 148     ssl_session_oinit(&as.master_key, &master_key,
 149                       in->master_key, in->master_key_length);
 150
 151     ssl_session_oinit(&as.session_id, &session_id,
 152                       in->session_id, in->session_id_length);
 153
 154     ssl_session_oinit(&as.session_id_context, &sid_ctx,
 155                       in->sid_ctx, in->sid_ctx_length);
 156
 157     as.time = in->time;
 158     as.timeout = in->timeout;
 159     as.verify_result = in->verify_result;
 160
 161     as.peer = in->peer;
 162
 163     ssl_session_sinit(&as.tlsext_hostname, &tlsext_hostname,
 164                       in->ext.hostname);
 165     if (in->ext.tick) {
 166         ssl_session_oinit(&as.tlsext_tick, &tlsext_tick,
 167                           in->ext.tick, in->ext.ticklen);
 168     }
 169     if (in->ext.tick_lifetime_hint > 0)
 170         as.tlsext_tick_lifetime_hint = in->ext.tick_lifetime_hint;
 171     as.tlsext_tick_age_add = in->ext.tick_age_add;
 172 #ifndef OPENSSL_NO_PSK
 173     ssl_session_sinit(&as.psk_identity_hint, &psk_identity_hint,
 174                       in->psk_identity_hint);
 175     ssl_session_sinit(&as.psk_identity, &psk_identity, in->psk_identity);
 176 #endif                          /* OPENSSL_NO_PSK */
 177 #ifndef OPENSSL_NO_SRP
 178     ssl_session_sinit(&as.srp_username, &srp_username, in->srp_username);
 179 #endif                          /* OPENSSL_NO_SRP */
 180
 181     as.flags = in->flags;
 182     as.max_early_data = in->ext.max_early_data;
 183
 184     if (in->ext.alpn_selected == NULL)
 185         as.alpn_selected = NULL;
 186     else
 187         ssl_session_oinit(&as.alpn_selected, &alpn_selected,
 188                           in->ext.alpn_selected, in->ext.alpn_selected_len);
 189
 190     return i2d_SSL_SESSION_ASN1(&as, pp);
 191
 192 }
 193
 194 /* Utility functions for d2i_SSL_SESSION */
 195
 196 /* OPENSSL_strndup an OCTET STRING */
 197
 198 static int ssl_session_strndup(char **pdst, ASN1_OCTET_STRING *src)
 199 {
 200     OPENSSL_free(*pdst);
 201     *pdst = NULL;
 202     if (src == NULL)
 203         return 1;
 204     *pdst = OPENSSL_strndup((char *)src->data, src->length);
 205     if (*pdst == NULL)
 206         return 0;
 207     return 1;
 208 }
 209
 210 /* Copy an OCTET STRING, return error if it exceeds maximum length */
 211
 212 static int ssl_session_memcpy(unsigned char *dst, size_t *pdstlen,
 213                               ASN1_OCTET_STRING *src, size_t maxlen)
 214 {
 215     if (src == NULL) {
 216         *pdstlen = 0;
 217         return 1;
 218     }
 219     if (src->length < 0 || src->length > (int)maxlen)
 220         return 0;
 221     memcpy(dst, src->data, src->length);
 222     *pdstlen = src->length;
 223     return 1;
 224 }
 225
 226 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
 227                              long length)
 228 {
 229     long id;
 230     size_t tmpl;
 231     const unsigned char *p = *pp;
 232     SSL_SESSION_ASN1 *as = NULL;
 233     SSL_SESSION *ret = NULL;
 234
 235     as = d2i_SSL_SESSION_ASN1(NULL, &p, length);
 236     /* ASN.1 code returns suitable error */
 237     if (as == NULL)
 238         goto err;
 239
 240     if (!a || !*a) {
 241         ret = SSL_SESSION_new();
 242         if (ret == NULL)
 243             goto err;
 244     } else {
 245         ret = *a;
 246     }
 247
 248     if (as->version != SSL_SESSION_ASN1_VERSION) {
 249         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNKNOWN_SSL_VERSION);
 250         goto err;
 251     }
 252
 253     if ((as->ssl_version >> 8) != SSL3_VERSION_MAJOR
 254         && (as->ssl_version >> 8) != DTLS1_VERSION_MAJOR
 255         && as->ssl_version != DTLS1_BAD_VER) {
 256         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_UNSUPPORTED_SSL_VERSION);
 257         goto err;
 258     }
 259
 260     ret->ssl_version = (int)as->ssl_version;
 261
 262     if (as->cipher->length != 2) {
 263         SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_CIPHER_CODE_WRONG_LENGTH);
 264         goto err;
 265     }
 266
 267     id = 0x03000000L | ((unsigned long)as->cipher->data[0] << 8L)
 268                      | (unsigned long)as->cipher->data[1];
 269
 270     ret->cipher_id = id;
 271     ret->cipher = ssl3_get_cipher_by_id(id);
 272     if (ret->cipher == NULL)
 273         goto err;
 274
 275     if (!ssl_session_memcpy(ret->session_id, &ret->session_id_length,
 276                             as->session_id, SSL3_MAX_SSL_SESSION_ID_LENGTH))
 277         goto err;
 278
 279     if (!ssl_session_memcpy(ret->master_key, &tmpl,
 280                             as->master_key, TLS13_MAX_RESUMPTION_MASTER_LENGTH))
 281         goto err;
 282
 283     ret->master_key_length = tmpl;
 284
 285     if (as->time != 0)
 286         ret->time = as->time;
 287     else
 288         ret->time = (unsigned long)time(NULL);
 289
 290     if (as->timeout != 0)
 291         ret->timeout = as->timeout;
 292     else
 293         ret->timeout = 3;
 294
 295     X509_free(ret->peer);
 296     ret->peer = as->peer;
 297     as->peer = NULL;
 298
 299     if (!ssl_session_memcpy(ret->sid_ctx, &ret->sid_ctx_length,
 300                             as->session_id_context, SSL_MAX_SID_CTX_LENGTH))
 301         goto err;
 302
 303     /* NB: this defaults to zero which is X509_V_OK */
 304     ret->verify_result = as->verify_result;
 305
 306     if (!ssl_session_strndup(&ret->ext.hostname, as->tlsext_hostname))
 307         goto err;
 308
 309 #ifndef OPENSSL_NO_PSK
 310     if (!ssl_session_strndup(&ret->psk_identity_hint, as->psk_identity_hint))
 311         goto err;
 312     if (!ssl_session_strndup(&ret->psk_identity, as->psk_identity))
 313         goto err;
 314 #endif
 315
 316     ret->ext.tick_lifetime_hint = as->tlsext_tick_lifetime_hint;
 317     ret->ext.tick_age_add = as->tlsext_tick_age_add;
 318     if (as->tlsext_tick) {
 319         ret->ext.tick = as->tlsext_tick->data;
 320         ret->ext.ticklen = as->tlsext_tick->length;
 321         as->tlsext_tick->data = NULL;
 322     } else {
 323         ret->ext.tick = NULL;
 324     }
 325 #ifndef OPENSSL_NO_COMP
 326     if (as->comp_id) {
 327         if (as->comp_id->length != 1) {
 328             SSLerr(SSL_F_D2I_SSL_SESSION, SSL_R_BAD_LENGTH);
 329             goto err;
 330         }
 331         ret->compress_meth = as->comp_id->data[0];
 332     } else {
 333         ret->compress_meth = 0;
 334     }
 335 #endif
 336
 337 #ifndef OPENSSL_NO_SRP
 338     if (!ssl_session_strndup(&ret->srp_username, as->srp_username))
 339         goto err;
 340 #endif                          /* OPENSSL_NO_SRP */
 341     /* Flags defaults to zero which is fine */
 342     ret->flags = as->flags;
 343     ret->ext.max_early_data = as->max_early_data;
 344
 345     if (as->alpn_selected != NULL) {
 346         if (!ssl_session_strndup((char **)&ret->ext.alpn_selected,
 347                                  as->alpn_selected))
 348             goto err;
 349         ret->ext.alpn_selected_len = as->alpn_selected->length;
 350     } else {
 351         ret->ext.alpn_selected = NULL;
 352         ret->ext.alpn_selected_len = 0;
 353     }
 354
 355     M_ASN1_free_of(as, SSL_SESSION_ASN1);
 356
 357     if ((a != NULL) && (*a == NULL))
 358         *a = ret;
 359     *pp = p;
 360     return ret;
 361
 362  err:
 363     M_ASN1_free_of(as, SSL_SESSION_ASN1);
 364     if ((a == NULL) || (*a != ret))
 365         SSL_SESSION_free(ret);
 366     return NULL;
 367 }