crypto/dh.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*  Diffie-Hellman Key Agreement Method [RFC2631]
   3  *
   4  * Copyright (c) 2016, Intel Corporation
   5  * Authors: Salvatore Benedetto <[email protected]>
   6  */
   7
   8 #include <linux/fips.h>
   9 #include <linux/module.h>
  10 #include <crypto/internal/kpp.h>
  11 #include <crypto/kpp.h>
  12 #include <crypto/dh.h>
  13 #include <linux/mpi.h>
  14
  15 struct dh_ctx {
  16         MPI p;  /* Value is guaranteed to be set. */
  17         MPI q;  /* Value is optional. */
  18         MPI g;  /* Value is guaranteed to be set. */
  19         MPI xa; /* Value is guaranteed to be set. */
  20 };
  21
  22 static void dh_clear_ctx(struct dh_ctx *ctx)
  23 {
  24         mpi_free(ctx->p);
  25         mpi_free(ctx->q);
  26         mpi_free(ctx->g);
  27         mpi_free(ctx->xa);
  28         memset(ctx, 0, sizeof(*ctx));
  29 }
  30
  31 /*
  32  * If base is g we compute the public key
  33  *      ya = g^xa mod p; [RFC2631 sec 2.1.1]
  34  * else if base if the counterpart public key we compute the shared secret
  35  *      ZZ = yb^xa mod p; [RFC2631 sec 2.1.1]
  36  */
  37 static int _compute_val(const struct dh_ctx *ctx, MPI base, MPI val)
  38 {
  39         /* val = base^xa mod p */
  40         return mpi_powm(val, base, ctx->xa, ctx->p);
  41 }
  42
  43 static inline struct dh_ctx *dh_get_ctx(struct crypto_kpp *tfm)
  44 {
  45         return kpp_tfm_ctx(tfm);
  46 }
  47
  48 static int dh_check_params_length(unsigned int p_len)
  49 {
  50         if (fips_enabled)
  51                 return (p_len < 2048) ? -EINVAL : 0;
  52
  53         return (p_len < 1536) ? -EINVAL : 0;
  54 }
  55
  56 static int dh_set_params(struct dh_ctx *ctx, struct dh *params)
  57 {
  58         if (dh_check_params_length(params->p_size << 3))
  59                 return -EINVAL;
  60
  61         ctx->p = mpi_read_raw_data(params->p, params->p_size);
  62         if (!ctx->p)
  63                 return -EINVAL;
  64
  65         if (params->q && params->q_size) {
  66                 ctx->q = mpi_read_raw_data(params->q, params->q_size);
  67                 if (!ctx->q)
  68                         return -EINVAL;
  69         }
  70
  71         ctx->g = mpi_read_raw_data(params->g, params->g_size);
  72         if (!ctx->g)
  73                 return -EINVAL;
  74
  75         return 0;
  76 }
  77
  78 static int dh_set_secret(struct crypto_kpp *tfm, const void *buf,
  79                          unsigned int len)
  80 {
  81         struct dh_ctx *ctx = dh_get_ctx(tfm);
  82         struct dh params;
  83
  84         /* Free the old MPI key if any */
  85         dh_clear_ctx(ctx);
  86
  87         if (crypto_dh_decode_key(buf, len, &params) < 0)
  88                 goto err_clear_ctx;
  89
  90         if (dh_set_params(ctx, &params) < 0)
  91                 goto err_clear_ctx;
  92
  93         ctx->xa = mpi_read_raw_data(params.key, params.key_size);
  94         if (!ctx->xa)
  95                 goto err_clear_ctx;
  96
  97         return 0;
  98
  99 err_clear_ctx:
 100         dh_clear_ctx(ctx);
 101         return -EINVAL;
 102 }
 103
 104 /*
 105  * SP800-56A public key verification:
 106  *
 107  * * If Q is provided as part of the domain paramenters, a full validation
 108  *   according to SP800-56A section 5.6.2.3.1 is performed.
 109  *
 110  * * If Q is not provided, a partial validation according to SP800-56A section
 111  *   5.6.2.3.2 is performed.
 112  */
 113 static int dh_is_pubkey_valid(struct dh_ctx *ctx, MPI y)
 114 {
 115         if (unlikely(!ctx->p))
 116                 return -EINVAL;
 117
 118         /*
 119          * Step 1: Verify that 2 <= y <= p - 2.
 120          *
 121          * The upper limit check is actually y < p instead of y < p - 1
 122          * as the mpi_sub_ui function is yet missing.
 123          */
 124         if (mpi_cmp_ui(y, 1) < 1 || mpi_cmp(y, ctx->p) >= 0)
 125                 return -EINVAL;
 126
 127         /* Step 2: Verify that 1 = y^q mod p */
 128         if (ctx->q) {
 129                 MPI val = mpi_alloc(0);
 130                 int ret;
 131
 132                 if (!val)
 133                         return -ENOMEM;
 134
 135                 ret = mpi_powm(val, y, ctx->q, ctx->p);
 136
 137                 if (ret) {
 138                         mpi_free(val);
 139                         return ret;
 140                 }
 141
 142                 ret = mpi_cmp_ui(val, 1);
 143
 144                 mpi_free(val);
 145
 146                 if (ret != 0)
 147                         return -EINVAL;
 148         }
 149
 150         return 0;
 151 }
 152
 153 static int dh_compute_value(struct kpp_request *req)
 154 {
 155         struct crypto_kpp *tfm = crypto_kpp_reqtfm(req);
 156         struct dh_ctx *ctx = dh_get_ctx(tfm);
 157         MPI base, val = mpi_alloc(0);
 158         int ret = 0;
 159         int sign;
 160
 161         if (!val)
 162                 return -ENOMEM;
 163
 164         if (unlikely(!ctx->xa)) {
 165                 ret = -EINVAL;
 166                 goto err_free_val;
 167         }
 168
 169         if (req->src) {
 170                 base = mpi_read_raw_from_sgl(req->src, req->src_len);
 171                 if (!base) {
 172                         ret = -EINVAL;
 173                         goto err_free_val;
 174                 }
 175                 ret = dh_is_pubkey_valid(ctx, base);
 176                 if (ret)
 177                         goto err_free_base;
 178         } else {
 179                 base = ctx->g;
 180         }
 181
 182         ret = _compute_val(ctx, base, val);
 183         if (ret)
 184                 goto err_free_base;
 185
 186         if (fips_enabled) {
 187                 /* SP800-56A rev3 5.7.1.1 check: Validation of shared secret */
 188                 if (req->src) {
 189                         MPI pone;
 190
 191                         /* z <= 1 */
 192                         if (mpi_cmp_ui(val, 1) < 1) {
 193                                 ret = -EBADMSG;
 194                                 goto err_free_base;
 195                         }
 196
 197                         /* z == p - 1 */
 198                         pone = mpi_alloc(0);
 199
 200                         if (!pone) {
 201                                 ret = -ENOMEM;
 202                                 goto err_free_base;
 203                         }
 204
 205                         ret = mpi_sub_ui(pone, ctx->p, 1);
 206                         if (!ret && !mpi_cmp(pone, val))
 207                                 ret = -EBADMSG;
 208
 209                         mpi_free(pone);
 210
 211                         if (ret)
 212                                 goto err_free_base;
 213
 214                 /* SP800-56A rev 3 5.6.2.1.3 key check */
 215                 } else {
 216                         if (dh_is_pubkey_valid(ctx, val)) {
 217                                 ret = -EAGAIN;
 218                                 goto err_free_val;
 219                         }
 220                 }
 221         }
 222
 223         ret = mpi_write_to_sgl(val, req->dst, req->dst_len, &sign);
 224         if (ret)
 225                 goto err_free_base;
 226
 227         if (sign < 0)
 228                 ret = -EBADMSG;
 229 err_free_base:
 230         if (req->src)
 231                 mpi_free(base);
 232 err_free_val:
 233         mpi_free(val);
 234         return ret;
 235 }
 236
 237 static unsigned int dh_max_size(struct crypto_kpp *tfm)
 238 {
 239         struct dh_ctx *ctx = dh_get_ctx(tfm);
 240
 241         return mpi_get_size(ctx->p);
 242 }
 243
 244 static void dh_exit_tfm(struct crypto_kpp *tfm)
 245 {
 246         struct dh_ctx *ctx = dh_get_ctx(tfm);
 247
 248         dh_clear_ctx(ctx);
 249 }
 250
 251 static struct kpp_alg dh = {
 252         .set_secret = dh_set_secret,
 253         .generate_public_key = dh_compute_value,
 254         .compute_shared_secret = dh_compute_value,
 255         .max_size = dh_max_size,
 256         .exit = dh_exit_tfm,
 257         .base = {
 258                 .cra_name = "dh",
 259                 .cra_driver_name = "dh-generic",
 260                 .cra_priority = 100,
 261                 .cra_module = THIS_MODULE,
 262                 .cra_ctxsize = sizeof(struct dh_ctx),
 263         },
 264 };
 265
 266 static int dh_init(void)
 267 {
 268         return crypto_register_kpp(&dh);
 269 }
 270
 271 static void dh_exit(void)
 272 {
 273         crypto_unregister_kpp(&dh);
 274 }
 275
 276 subsys_initcall(dh_init);
 277 module_exit(dh_exit);
 278 MODULE_ALIAS_CRYPTO("dh");
 279 MODULE_LICENSE("GPL");
 280 MODULE_DESCRIPTION("DH generic algorithm");