providers/implementations/signature/eddsa.c

   1 /*
   2  * Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/crypto.h>
  11 #include <openssl/core_dispatch.h>
  12 #include <openssl/core_names.h>
  13 #include <openssl/err.h>
  14 #include <openssl/params.h>
  15 #include <openssl/evp.h>
  16 #include <openssl/err.h>
  17 #include <openssl/proverr.h>
  18 #include "internal/nelem.h"
  19 #include "internal/sizes.h"
  20 #include "prov/providercommon.h"
  21 #include "prov/implementations.h"
  22 #include "prov/provider_ctx.h"
  23 #include "prov/der_ecx.h"
  24 #include "crypto/ecx.h"
  25
  26 #ifdef S390X_EC_ASM
  27 # include "s390x_arch.h"
  28
  29 # define S390X_CAN_SIGN(edtype)                                                \
  30 ((OPENSSL_s390xcap_P.pcc[1] & S390X_CAPBIT(S390X_SCALAR_MULTIPLY_##edtype))    \
  31 && (OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_SIGN_##edtype))      \
  32 && (OPENSSL_s390xcap_P.kdsa[0] & S390X_CAPBIT(S390X_EDDSA_VERIFY_##edtype)))
  33
  34 static int s390x_ed25519_digestsign(const ECX_KEY *edkey, unsigned char *sig,
  35                                     const unsigned char *tbs, size_t tbslen);
  36 static int s390x_ed448_digestsign(const ECX_KEY *edkey, unsigned char *sig,
  37                                   const unsigned char *tbs, size_t tbslen);
  38 static int s390x_ed25519_digestverify(const ECX_KEY *edkey,
  39                                       const unsigned char *sig,
  40                                       const unsigned char *tbs, size_t tbslen);
  41 static int s390x_ed448_digestverify(const ECX_KEY *edkey,
  42                                     const unsigned char *sig,
  43                                     const unsigned char *tbs, size_t tbslen);
  44
  45 #endif /* S390X_EC_ASM */
  46
  47 static OSSL_FUNC_signature_newctx_fn eddsa_newctx;
  48 static OSSL_FUNC_signature_digest_sign_init_fn eddsa_digest_signverify_init;
  49 static OSSL_FUNC_signature_digest_sign_fn ed25519_digest_sign;
  50 static OSSL_FUNC_signature_digest_sign_fn ed448_digest_sign;
  51 static OSSL_FUNC_signature_digest_verify_fn ed25519_digest_verify;
  52 static OSSL_FUNC_signature_digest_verify_fn ed448_digest_verify;
  53 static OSSL_FUNC_signature_freectx_fn eddsa_freectx;
  54 static OSSL_FUNC_signature_dupctx_fn eddsa_dupctx;
  55 static OSSL_FUNC_signature_get_ctx_params_fn eddsa_get_ctx_params;
  56 static OSSL_FUNC_signature_gettable_ctx_params_fn eddsa_gettable_ctx_params;
  57
  58 typedef struct {
  59     OSSL_LIB_CTX *libctx;
  60     ECX_KEY *key;
  61
  62     /* The Algorithm Identifier of the signature algorithm */
  63     unsigned char aid_buf[OSSL_MAX_ALGORITHM_ID_SIZE];
  64     unsigned char *aid;
  65     size_t  aid_len;
  66 } PROV_EDDSA_CTX;
  67
  68 static void *eddsa_newctx(void *provctx, const char *propq_unused)
  69 {
  70     PROV_EDDSA_CTX *peddsactx;
  71
  72     if (!ossl_prov_is_running())
  73         return NULL;
  74
  75     peddsactx = OPENSSL_zalloc(sizeof(PROV_EDDSA_CTX));
  76     if (peddsactx == NULL) {
  77         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  78         return NULL;
  79     }
  80
  81     peddsactx->libctx = PROV_LIBCTX_OF(provctx);
  82
  83     return peddsactx;
  84 }
  85
  86 static int eddsa_digest_signverify_init(void *vpeddsactx, const char *mdname,
  87                                         void *vedkey,
  88                                         ossl_unused const OSSL_PARAM params[])
  89 {
  90     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
  91     ECX_KEY *edkey = (ECX_KEY *)vedkey;
  92     WPACKET pkt;
  93     int ret;
  94
  95     if (!ossl_prov_is_running())
  96         return 0;
  97
  98     if (mdname != NULL && mdname[0] != '\0') {
  99         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DIGEST);
 100         return 0;
 101     }
 102
 103     if (!ossl_ecx_key_up_ref(edkey)) {
 104         ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
 105         return 0;
 106     }
 107
 108     /*
 109      * We do not care about DER writing errors.
 110      * All it really means is that for some reason, there's no
 111      * AlgorithmIdentifier to be had, but the operation itself is
 112      * still valid, just as long as it's not used to construct
 113      * anything that needs an AlgorithmIdentifier.
 114      */
 115     peddsactx->aid_len = 0;
 116     ret = WPACKET_init_der(&pkt, peddsactx->aid_buf, sizeof(peddsactx->aid_buf));
 117     switch (edkey->type) {
 118     case ECX_KEY_TYPE_ED25519:
 119         ret = ret && ossl_DER_w_algorithmIdentifier_ED25519(&pkt, -1, edkey);
 120         break;
 121     case ECX_KEY_TYPE_ED448:
 122         ret = ret && ossl_DER_w_algorithmIdentifier_ED448(&pkt, -1, edkey);
 123         break;
 124     default:
 125         /* Should never happen */
 126         ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
 127         return 0;
 128     }
 129     if (ret && WPACKET_finish(&pkt)) {
 130         WPACKET_get_total_written(&pkt, &peddsactx->aid_len);
 131         peddsactx->aid = WPACKET_get_curr(&pkt);
 132     }
 133     WPACKET_cleanup(&pkt);
 134
 135     peddsactx->key = edkey;
 136
 137     return 1;
 138 }
 139
 140 int ed25519_digest_sign(void *vpeddsactx, unsigned char *sigret,
 141                         size_t *siglen, size_t sigsize,
 142                         const unsigned char *tbs, size_t tbslen)
 143 {
 144     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 145     const ECX_KEY *edkey = peddsactx->key;
 146
 147     if (!ossl_prov_is_running())
 148         return 0;
 149
 150     if (sigret == NULL) {
 151         *siglen = ED25519_SIGSIZE;
 152         return 1;
 153     }
 154     if (sigsize < ED25519_SIGSIZE) {
 155         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 156         return 0;
 157     }
 158 #ifdef S390X_EC_ASM
 159     if (S390X_CAN_SIGN(ED25519))
 160         return s390x_ed25519_digestsign(edkey, sigret, tbs, tbslen);
 161 #endif /* S390X_EC_ASM */
 162     if (ossl_ed25519_sign(sigret, tbs, tbslen, edkey->pubkey, edkey->privkey,
 163                           peddsactx->libctx, NULL) == 0) {
 164         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SIGN);
 165         return 0;
 166     }
 167     *siglen = ED25519_SIGSIZE;
 168     return 1;
 169 }
 170
 171 int ed448_digest_sign(void *vpeddsactx, unsigned char *sigret,
 172                       size_t *siglen, size_t sigsize,
 173                       const unsigned char *tbs, size_t tbslen)
 174 {
 175     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 176     const ECX_KEY *edkey = peddsactx->key;
 177
 178     if (!ossl_prov_is_running())
 179         return 0;
 180
 181     if (sigret == NULL) {
 182         *siglen = ED448_SIGSIZE;
 183         return 1;
 184     }
 185     if (sigsize < ED448_SIGSIZE) {
 186         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 187         return 0;
 188     }
 189 #ifdef S390X_EC_ASM
 190     if (S390X_CAN_SIGN(ED448))
 191         return s390x_ed448_digestsign(edkey, sigret, tbs, tbslen);
 192 #endif /* S390X_EC_ASM */
 193     if (ossl_ed448_sign(peddsactx->libctx, sigret, tbs, tbslen, edkey->pubkey,
 194                         edkey->privkey, NULL, 0, edkey->propq) == 0) {
 195         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SIGN);
 196         return 0;
 197     }
 198     *siglen = ED448_SIGSIZE;
 199     return 1;
 200 }
 201
 202 int ed25519_digest_verify(void *vpeddsactx, const unsigned char *sig,
 203                           size_t siglen, const unsigned char *tbs,
 204                           size_t tbslen)
 205 {
 206     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 207     const ECX_KEY *edkey = peddsactx->key;
 208
 209     if (!ossl_prov_is_running() || siglen != ED25519_SIGSIZE)
 210         return 0;
 211
 212 #ifdef S390X_EC_ASM
 213     if (S390X_CAN_SIGN(ED25519))
 214         return s390x_ed25519_digestverify(edkey, sig, tbs, tbslen);
 215 #endif /* S390X_EC_ASM */
 216
 217     return ossl_ed25519_verify(tbs, tbslen, sig, edkey->pubkey,
 218                                peddsactx->libctx, edkey->propq);
 219 }
 220
 221 int ed448_digest_verify(void *vpeddsactx, const unsigned char *sig,
 222                         size_t siglen, const unsigned char *tbs,
 223                         size_t tbslen)
 224 {
 225     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 226     const ECX_KEY *edkey = peddsactx->key;
 227
 228     if (!ossl_prov_is_running() || siglen != ED448_SIGSIZE)
 229         return 0;
 230
 231 #ifdef S390X_EC_ASM
 232     if (S390X_CAN_SIGN(ED448))
 233         return s390x_ed448_digestverify(edkey, sig, tbs, tbslen);
 234 #endif /* S390X_EC_ASM */
 235
 236     return ossl_ed448_verify(peddsactx->libctx, tbs, tbslen, sig, edkey->pubkey,
 237                              NULL, 0, edkey->propq);
 238 }
 239
 240 static void eddsa_freectx(void *vpeddsactx)
 241 {
 242     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 243
 244     ossl_ecx_key_free(peddsactx->key);
 245
 246     OPENSSL_free(peddsactx);
 247 }
 248
 249 static void *eddsa_dupctx(void *vpeddsactx)
 250 {
 251     PROV_EDDSA_CTX *srcctx = (PROV_EDDSA_CTX *)vpeddsactx;
 252     PROV_EDDSA_CTX *dstctx;
 253
 254     if (!ossl_prov_is_running())
 255         return NULL;
 256
 257     dstctx = OPENSSL_zalloc(sizeof(*srcctx));
 258     if (dstctx == NULL)
 259         return NULL;
 260
 261     *dstctx = *srcctx;
 262     dstctx->key = NULL;
 263
 264     if (srcctx->key != NULL && !ossl_ecx_key_up_ref(srcctx->key)) {
 265         ERR_raise(ERR_LIB_PROV, ERR_R_INTERNAL_ERROR);
 266         goto err;
 267     }
 268     dstctx->key = srcctx->key;
 269
 270     return dstctx;
 271  err:
 272     eddsa_freectx(dstctx);
 273     return NULL;
 274 }
 275
 276 static int eddsa_get_ctx_params(void *vpeddsactx, OSSL_PARAM *params)
 277 {
 278     PROV_EDDSA_CTX *peddsactx = (PROV_EDDSA_CTX *)vpeddsactx;
 279     OSSL_PARAM *p;
 280
 281     if (peddsactx == NULL)
 282         return 0;
 283
 284     p = OSSL_PARAM_locate(params, OSSL_SIGNATURE_PARAM_ALGORITHM_ID);
 285     if (p != NULL && !OSSL_PARAM_set_octet_string(p, peddsactx->aid,
 286                                                   peddsactx->aid_len))
 287         return 0;
 288
 289     return 1;
 290 }
 291
 292 static const OSSL_PARAM known_gettable_ctx_params[] = {
 293     OSSL_PARAM_octet_string(OSSL_SIGNATURE_PARAM_ALGORITHM_ID, NULL, 0),
 294     OSSL_PARAM_END
 295 };
 296
 297 static const OSSL_PARAM *eddsa_gettable_ctx_params(ossl_unused void *vpeddsactx,
 298                                                    ossl_unused void *provctx)
 299 {
 300     return known_gettable_ctx_params;
 301 }
 302
 303 const OSSL_DISPATCH ossl_ed25519_signature_functions[] = {
 304     { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))eddsa_newctx },
 305     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
 306       (void (*)(void))eddsa_digest_signverify_init },
 307     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN,
 308       (void (*)(void))ed25519_digest_sign },
 309     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
 310       (void (*)(void))eddsa_digest_signverify_init },
 311     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY,
 312       (void (*)(void))ed25519_digest_verify },
 313     { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))eddsa_freectx },
 314     { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))eddsa_dupctx },
 315     { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))eddsa_get_ctx_params },
 316     { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
 317       (void (*)(void))eddsa_gettable_ctx_params },
 318     { 0, NULL }
 319 };
 320
 321 const OSSL_DISPATCH ossl_ed448_signature_functions[] = {
 322     { OSSL_FUNC_SIGNATURE_NEWCTX, (void (*)(void))eddsa_newctx },
 323     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT,
 324       (void (*)(void))eddsa_digest_signverify_init },
 325     { OSSL_FUNC_SIGNATURE_DIGEST_SIGN,
 326       (void (*)(void))ed448_digest_sign },
 327     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT,
 328       (void (*)(void))eddsa_digest_signverify_init },
 329     { OSSL_FUNC_SIGNATURE_DIGEST_VERIFY,
 330       (void (*)(void))ed448_digest_verify },
 331     { OSSL_FUNC_SIGNATURE_FREECTX, (void (*)(void))eddsa_freectx },
 332     { OSSL_FUNC_SIGNATURE_DUPCTX, (void (*)(void))eddsa_dupctx },
 333     { OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS, (void (*)(void))eddsa_get_ctx_params },
 334     { OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS,
 335       (void (*)(void))eddsa_gettable_ctx_params },
 336     { 0, NULL }
 337 };
 338
 339 #ifdef S390X_EC_ASM
 340
 341 static int s390x_ed25519_digestsign(const ECX_KEY *edkey, unsigned char *sig,
 342                                     const unsigned char *tbs, size_t tbslen)
 343 {
 344     int rc;
 345     union {
 346         struct {
 347             unsigned char sig[64];
 348             unsigned char priv[32];
 349         } ed25519;
 350         unsigned long long buff[512];
 351     } param;
 352
 353     memset(&param, 0, sizeof(param));
 354     memcpy(param.ed25519.priv, edkey->privkey, sizeof(param.ed25519.priv));
 355
 356     rc = s390x_kdsa(S390X_EDDSA_SIGN_ED25519, &param.ed25519, tbs, tbslen);
 357     OPENSSL_cleanse(param.ed25519.priv, sizeof(param.ed25519.priv));
 358     if (rc != 0)
 359         return 0;
 360
 361     s390x_flip_endian32(sig, param.ed25519.sig);
 362     s390x_flip_endian32(sig + 32, param.ed25519.sig + 32);
 363     return 1;
 364 }
 365
 366 static int s390x_ed448_digestsign(const ECX_KEY *edkey, unsigned char *sig,
 367                                   const unsigned char *tbs, size_t tbslen)
 368 {
 369     int rc;
 370     union {
 371         struct {
 372             unsigned char sig[128];
 373             unsigned char priv[64];
 374         } ed448;
 375         unsigned long long buff[512];
 376     } param;
 377
 378     memset(&param, 0, sizeof(param));
 379     memcpy(param.ed448.priv + 64 - 57, edkey->privkey, 57);
 380
 381     rc = s390x_kdsa(S390X_EDDSA_SIGN_ED448, &param.ed448, tbs, tbslen);
 382     OPENSSL_cleanse(param.ed448.priv, sizeof(param.ed448.priv));
 383     if (rc != 0)
 384         return 0;
 385
 386     s390x_flip_endian64(param.ed448.sig, param.ed448.sig);
 387     s390x_flip_endian64(param.ed448.sig + 64, param.ed448.sig + 64);
 388     memcpy(sig, param.ed448.sig, 57);
 389     memcpy(sig + 57, param.ed448.sig + 64, 57);
 390     return 1;
 391 }
 392
 393 static int s390x_ed25519_digestverify(const ECX_KEY *edkey,
 394                                       const unsigned char *sig,
 395                                       const unsigned char *tbs, size_t tbslen)
 396 {
 397     union {
 398         struct {
 399             unsigned char sig[64];
 400             unsigned char pub[32];
 401         } ed25519;
 402         unsigned long long buff[512];
 403     } param;
 404
 405     memset(&param, 0, sizeof(param));
 406     s390x_flip_endian32(param.ed25519.sig, sig);
 407     s390x_flip_endian32(param.ed25519.sig + 32, sig + 32);
 408     s390x_flip_endian32(param.ed25519.pub, edkey->pubkey);
 409
 410     return s390x_kdsa(S390X_EDDSA_VERIFY_ED25519,
 411                       &param.ed25519, tbs, tbslen) == 0 ? 1 : 0;
 412 }
 413
 414 static int s390x_ed448_digestverify(const ECX_KEY *edkey,
 415                                     const unsigned char *sig,
 416                                     const unsigned char *tbs,
 417                                     size_t tbslen)
 418 {
 419     union {
 420         struct {
 421             unsigned char sig[128];
 422             unsigned char pub[64];
 423         } ed448;
 424         unsigned long long buff[512];
 425     } param;
 426
 427     memset(&param, 0, sizeof(param));
 428     memcpy(param.ed448.sig, sig, 57);
 429     s390x_flip_endian64(param.ed448.sig, param.ed448.sig);
 430     memcpy(param.ed448.sig + 64, sig + 57, 57);
 431     s390x_flip_endian64(param.ed448.sig + 64, param.ed448.sig + 64);
 432     memcpy(param.ed448.pub, edkey->pubkey, 57);
 433     s390x_flip_endian64(param.ed448.pub, param.ed448.pub);
 434
 435     return s390x_kdsa(S390X_EDDSA_VERIFY_ED448,
 436                       &param.ed448, tbs, tbslen) == 0 ? 1 : 0;
 437 }
 438
 439 #endif /* S390X_EC_ASM */