linux/drivers/s390/crypto/zcrypt_msgtype50.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3 *  Copyright IBM Corp. 2001, 2012
   4 *  Author(s): Robert Burroughs
   5 *             Eric Rossman (edrossma@us.ibm.com)
   6 *
   7 *  Hotplug & misc device support: Jochen Roehrig (roehrig@de.ibm.com)
   8 *  Major cleanup & driver split: Martin Schwidefsky <schwidefsky@de.ibm.com>
   9 *                                Ralph Wuerthner <rwuerthn@de.ibm.com>
  10 *  MSGTYPE restruct:             Holger Dengler <hd@linux.vnet.ibm.com>
  11 */
  12
  13#define KMSG_COMPONENT "zcrypt"
  14#define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  15
  16#include <linux/module.h>
  17#include <linux/slab.h>
  18#include <linux/init.h>
  19#include <linux/err.h>
  20#include <linux/atomic.h>
  21#include <linux/uaccess.h>
  22
  23#include "ap_bus.h"
  24#include "zcrypt_api.h"
  25#include "zcrypt_error.h"
  26#include "zcrypt_msgtype50.h"
  27
  28/* >= CEX3A: 4096 bits */
  29#define CEX3A_MAX_MOD_SIZE 512
  30
  31/* CEX2A: max outputdatalength + type80_hdr */
  32#define CEX2A_MAX_RESPONSE_SIZE 0x110
  33
  34/* >= CEX3A: 512 bit modulus, (max outputdatalength) + type80_hdr */
  35#define CEX3A_MAX_RESPONSE_SIZE 0x210
  36
  37MODULE_AUTHOR("IBM Corporation");
  38MODULE_DESCRIPTION("Cryptographic Accelerator (message type 50), " \
  39                   "Copyright IBM Corp. 2001, 2012");
  40MODULE_LICENSE("GPL");
  41
  42/**
  43 * The type 50 message family is associated with a CEXxA cards.
  44 *
  45 * The four members of the family are described below.
  46 *
  47 * Note that all unsigned char arrays are right-justified and left-padded
  48 * with zeroes.
  49 *
  50 * Note that all reserved fields must be zeroes.
  51 */
  52struct type50_hdr {
  53        unsigned char   reserved1;
  54        unsigned char   msg_type_code;  /* 0x50 */
  55        unsigned short  msg_len;
  56        unsigned char   reserved2;
  57        unsigned char   ignored;
  58        unsigned short  reserved3;
  59} __packed;
  60
  61#define TYPE50_TYPE_CODE        0x50
  62
  63#define TYPE50_MEB1_FMT         0x0001
  64#define TYPE50_MEB2_FMT         0x0002
  65#define TYPE50_MEB3_FMT         0x0003
  66#define TYPE50_CRB1_FMT         0x0011
  67#define TYPE50_CRB2_FMT         0x0012
  68#define TYPE50_CRB3_FMT         0x0013
  69
  70/* Mod-Exp, with a small modulus */
  71struct type50_meb1_msg {
  72        struct type50_hdr header;
  73        unsigned short  keyblock_type;  /* 0x0001 */
  74        unsigned char   reserved[6];
  75        unsigned char   exponent[128];
  76        unsigned char   modulus[128];
  77        unsigned char   message[128];
  78} __packed;
  79
  80/* Mod-Exp, with a large modulus */
  81struct type50_meb2_msg {
  82        struct type50_hdr header;
  83        unsigned short  keyblock_type;  /* 0x0002 */
  84        unsigned char   reserved[6];
  85        unsigned char   exponent[256];
  86        unsigned char   modulus[256];
  87        unsigned char   message[256];
  88} __packed;
  89
  90/* Mod-Exp, with a larger modulus */
  91struct type50_meb3_msg {
  92        struct type50_hdr header;
  93        unsigned short  keyblock_type;  /* 0x0003 */
  94        unsigned char   reserved[6];
  95        unsigned char   exponent[512];
  96        unsigned char   modulus[512];
  97        unsigned char   message[512];
  98} __packed;
  99
 100/* CRT, with a small modulus */
 101struct type50_crb1_msg {
 102        struct type50_hdr header;
 103        unsigned short  keyblock_type;  /* 0x0011 */
 104        unsigned char   reserved[6];
 105        unsigned char   p[64];
 106        unsigned char   q[64];
 107        unsigned char   dp[64];
 108        unsigned char   dq[64];
 109        unsigned char   u[64];
 110        unsigned char   message[128];
 111} __packed;
 112
 113/* CRT, with a large modulus */
 114struct type50_crb2_msg {
 115        struct type50_hdr header;
 116        unsigned short  keyblock_type;  /* 0x0012 */
 117        unsigned char   reserved[6];
 118        unsigned char   p[128];
 119        unsigned char   q[128];
 120        unsigned char   dp[128];
 121        unsigned char   dq[128];
 122        unsigned char   u[128];
 123        unsigned char   message[256];
 124} __packed;
 125
 126/* CRT, with a larger modulus */
 127struct type50_crb3_msg {
 128        struct type50_hdr header;
 129        unsigned short  keyblock_type;  /* 0x0013 */
 130        unsigned char   reserved[6];
 131        unsigned char   p[256];
 132        unsigned char   q[256];
 133        unsigned char   dp[256];
 134        unsigned char   dq[256];
 135        unsigned char   u[256];
 136        unsigned char   message[512];
 137} __packed;
 138
 139/**
 140 * The type 80 response family is associated with a CEXxA cards.
 141 *
 142 * Note that all unsigned char arrays are right-justified and left-padded
 143 * with zeroes.
 144 *
 145 * Note that all reserved fields must be zeroes.
 146 */
 147
 148#define TYPE80_RSP_CODE 0x80
 149
 150struct type80_hdr {
 151        unsigned char   reserved1;
 152        unsigned char   type;           /* 0x80 */
 153        unsigned short  len;
 154        unsigned char   code;           /* 0x00 */
 155        unsigned char   reserved2[3];
 156        unsigned char   reserved3[8];
 157} __packed;
 158
 159unsigned int get_rsa_modex_fc(struct ica_rsa_modexpo *mex, int *fcode)
 160{
 161
 162        if (!mex->inputdatalength)
 163                return -EINVAL;
 164
 165        if (mex->inputdatalength <= 128)        /* 1024 bit */
 166                *fcode = MEX_1K;
 167        else if (mex->inputdatalength <= 256)   /* 2048 bit */
 168                *fcode = MEX_2K;
 169        else                                    /* 4096 bit */
 170                *fcode = MEX_4K;
 171
 172        return 0;
 173}
 174
 175unsigned int get_rsa_crt_fc(struct ica_rsa_modexpo_crt *crt, int *fcode)
 176{
 177
 178        if (!crt->inputdatalength)
 179                return -EINVAL;
 180
 181        if (crt->inputdatalength <= 128)        /* 1024 bit */
 182                *fcode = CRT_1K;
 183        else if (crt->inputdatalength <= 256)   /* 2048 bit */
 184                *fcode = CRT_2K;
 185        else                                    /* 4096 bit */
 186                *fcode = CRT_4K;
 187
 188        return 0;
 189}
 190
 191/**
 192 * Convert a ICAMEX message to a type50 MEX message.
 193 *
 194 * @zq: crypto queue pointer
 195 * @ap_msg: crypto request pointer
 196 * @mex: pointer to user input data
 197 *
 198 * Returns 0 on success or -EFAULT.
 199 */
 200static int ICAMEX_msg_to_type50MEX_msg(struct zcrypt_queue *zq,
 201                                       struct ap_message *ap_msg,
 202                                       struct ica_rsa_modexpo *mex)
 203{
 204        unsigned char *mod, *exp, *inp;
 205        int mod_len;
 206
 207        mod_len = mex->inputdatalength;
 208
 209        if (mod_len <= 128) {
 210                struct type50_meb1_msg *meb1 = ap_msg->msg;
 211
 212                memset(meb1, 0, sizeof(*meb1));
 213                ap_msg->len = sizeof(*meb1);
 214                meb1->header.msg_type_code = TYPE50_TYPE_CODE;
 215                meb1->header.msg_len = sizeof(*meb1);
 216                meb1->keyblock_type = TYPE50_MEB1_FMT;
 217                mod = meb1->modulus + sizeof(meb1->modulus) - mod_len;
 218                exp = meb1->exponent + sizeof(meb1->exponent) - mod_len;
 219                inp = meb1->message + sizeof(meb1->message) - mod_len;
 220        } else if (mod_len <= 256) {
 221                struct type50_meb2_msg *meb2 = ap_msg->msg;
 222
 223                memset(meb2, 0, sizeof(*meb2));
 224                ap_msg->len = sizeof(*meb2);
 225                meb2->header.msg_type_code = TYPE50_TYPE_CODE;
 226                meb2->header.msg_len = sizeof(*meb2);
 227                meb2->keyblock_type = TYPE50_MEB2_FMT;
 228                mod = meb2->modulus + sizeof(meb2->modulus) - mod_len;
 229                exp = meb2->exponent + sizeof(meb2->exponent) - mod_len;
 230                inp = meb2->message + sizeof(meb2->message) - mod_len;
 231        } else if (mod_len <= 512) {
 232                struct type50_meb3_msg *meb3 = ap_msg->msg;
 233
 234                memset(meb3, 0, sizeof(*meb3));
 235                ap_msg->len = sizeof(*meb3);
 236                meb3->header.msg_type_code = TYPE50_TYPE_CODE;
 237                meb3->header.msg_len = sizeof(*meb3);
 238                meb3->keyblock_type = TYPE50_MEB3_FMT;
 239                mod = meb3->modulus + sizeof(meb3->modulus) - mod_len;
 240                exp = meb3->exponent + sizeof(meb3->exponent) - mod_len;
 241                inp = meb3->message + sizeof(meb3->message) - mod_len;
 242        } else
 243                return -EINVAL;
 244
 245        if (copy_from_user(mod, mex->n_modulus, mod_len) ||
 246            copy_from_user(exp, mex->b_key, mod_len) ||
 247            copy_from_user(inp, mex->inputdata, mod_len))
 248                return -EFAULT;
 249
 250#ifdef CONFIG_ZCRYPT_DEBUG
 251        if (ap_msg->fi.flags & AP_FI_FLAG_TOGGLE_SPECIAL)
 252                ap_msg->flags ^= AP_MSG_FLAG_SPECIAL;
 253#endif
 254
 255        return 0;
 256}
 257
 258/**
 259 * Convert a ICACRT message to a type50 CRT message.
 260 *
 261 * @zq: crypto queue pointer
 262 * @ap_msg: crypto request pointer
 263 * @crt: pointer to user input data
 264 *
 265 * Returns 0 on success or -EFAULT.
 266 */
 267static int ICACRT_msg_to_type50CRT_msg(struct zcrypt_queue *zq,
 268                                       struct ap_message *ap_msg,
 269                                       struct ica_rsa_modexpo_crt *crt)
 270{
 271        int mod_len, short_len;
 272        unsigned char *p, *q, *dp, *dq, *u, *inp;
 273
 274        mod_len = crt->inputdatalength;
 275        short_len = (mod_len + 1) / 2;
 276
 277        /*
 278         * CEX2A and CEX3A w/o FW update can handle requests up to
 279         * 256 byte modulus (2k keys).
 280         * CEX3A with FW update and newer CEXxA cards are able to handle
 281         * 512 byte modulus (4k keys).
 282         */
 283        if (mod_len <= 128) {           /* up to 1024 bit key size */
 284                struct type50_crb1_msg *crb1 = ap_msg->msg;
 285
 286                memset(crb1, 0, sizeof(*crb1));
 287                ap_msg->len = sizeof(*crb1);
 288                crb1->header.msg_type_code = TYPE50_TYPE_CODE;
 289                crb1->header.msg_len = sizeof(*crb1);
 290                crb1->keyblock_type = TYPE50_CRB1_FMT;
 291                p = crb1->p + sizeof(crb1->p) - short_len;
 292                q = crb1->q + sizeof(crb1->q) - short_len;
 293                dp = crb1->dp + sizeof(crb1->dp) - short_len;
 294                dq = crb1->dq + sizeof(crb1->dq) - short_len;
 295                u = crb1->u + sizeof(crb1->u) - short_len;
 296                inp = crb1->message + sizeof(crb1->message) - mod_len;
 297        } else if (mod_len <= 256) {    /* up to 2048 bit key size */
 298                struct type50_crb2_msg *crb2 = ap_msg->msg;
 299
 300                memset(crb2, 0, sizeof(*crb2));
 301                ap_msg->len = sizeof(*crb2);
 302                crb2->header.msg_type_code = TYPE50_TYPE_CODE;
 303                crb2->header.msg_len = sizeof(*crb2);
 304                crb2->keyblock_type = TYPE50_CRB2_FMT;
 305                p = crb2->p + sizeof(crb2->p) - short_len;
 306                q = crb2->q + sizeof(crb2->q) - short_len;
 307                dp = crb2->dp + sizeof(crb2->dp) - short_len;
 308                dq = crb2->dq + sizeof(crb2->dq) - short_len;
 309                u = crb2->u + sizeof(crb2->u) - short_len;
 310                inp = crb2->message + sizeof(crb2->message) - mod_len;
 311        } else if ((mod_len <= 512) &&  /* up to 4096 bit key size */
 312                   (zq->zcard->max_mod_size == CEX3A_MAX_MOD_SIZE)) {
 313                struct type50_crb3_msg *crb3 = ap_msg->msg;
 314
 315                memset(crb3, 0, sizeof(*crb3));
 316                ap_msg->len = sizeof(*crb3);
 317                crb3->header.msg_type_code = TYPE50_TYPE_CODE;
 318                crb3->header.msg_len = sizeof(*crb3);
 319                crb3->keyblock_type = TYPE50_CRB3_FMT;
 320                p = crb3->p + sizeof(crb3->p) - short_len;
 321                q = crb3->q + sizeof(crb3->q) - short_len;
 322                dp = crb3->dp + sizeof(crb3->dp) - short_len;
 323                dq = crb3->dq + sizeof(crb3->dq) - short_len;
 324                u = crb3->u + sizeof(crb3->u) - short_len;
 325                inp = crb3->message + sizeof(crb3->message) - mod_len;
 326        } else
 327                return -EINVAL;
 328
 329        /*
 330         * correct the offset of p, bp and mult_inv according zcrypt.h
 331         * block size right aligned (skip the first byte)
 332         */
 333        if (copy_from_user(p, crt->np_prime + MSGTYPE_ADJUSTMENT, short_len) ||
 334            copy_from_user(q, crt->nq_prime, short_len) ||
 335            copy_from_user(dp, crt->bp_key + MSGTYPE_ADJUSTMENT, short_len) ||
 336            copy_from_user(dq, crt->bq_key, short_len) ||
 337            copy_from_user(u, crt->u_mult_inv + MSGTYPE_ADJUSTMENT, short_len) ||
 338            copy_from_user(inp, crt->inputdata, mod_len))
 339                return -EFAULT;
 340
 341#ifdef CONFIG_ZCRYPT_DEBUG
 342        if (ap_msg->fi.flags & AP_FI_FLAG_TOGGLE_SPECIAL)
 343                ap_msg->flags ^= AP_MSG_FLAG_SPECIAL;
 344#endif
 345
 346        return 0;
 347}
 348
 349/**
 350 * Copy results from a type 80 reply message back to user space.
 351 *
 352 * @zq: crypto device pointer
 353 * @reply: reply AP message.
 354 * @data: pointer to user output data
 355 * @length: size of user output data
 356 *
 357 * Returns 0 on success or -EFAULT.
 358 */
 359static int convert_type80(struct zcrypt_queue *zq,
 360                          struct ap_message *reply,
 361                          char __user *outputdata,
 362                          unsigned int outputdatalength)
 363{
 364        struct type80_hdr *t80h = reply->msg;
 365        unsigned char *data;
 366
 367        if (t80h->len < sizeof(*t80h) + outputdatalength) {
 368                /* The result is too short, the CEXxA card may not do that.. */
 369                zq->online = 0;
 370                pr_err("Crypto dev=%02x.%04x code=0x%02x => online=0 rc=EAGAIN\n",
 371                       AP_QID_CARD(zq->queue->qid),
 372                       AP_QID_QUEUE(zq->queue->qid),
 373                       t80h->code);
 374                ZCRYPT_DBF_ERR("dev=%02x.%04x code=0x%02x => online=0 rc=EAGAIN\n",
 375                               AP_QID_CARD(zq->queue->qid),
 376                               AP_QID_QUEUE(zq->queue->qid),
 377                               t80h->code);
 378                return -EAGAIN;
 379        }
 380        if (zq->zcard->user_space_type == ZCRYPT_CEX2A)
 381                BUG_ON(t80h->len > CEX2A_MAX_RESPONSE_SIZE);
 382        else
 383                BUG_ON(t80h->len > CEX3A_MAX_RESPONSE_SIZE);
 384        data = reply->msg + t80h->len - outputdatalength;
 385        if (copy_to_user(outputdata, data, outputdatalength))
 386                return -EFAULT;
 387        return 0;
 388}
 389
 390static int convert_response_cex2a(struct zcrypt_queue *zq,
 391                                  struct ap_message *reply,
 392                                  char __user *outputdata,
 393                                  unsigned int outputdatalength)
 394{
 395        /* Response type byte is the second byte in the response. */
 396        unsigned char rtype = ((unsigned char *) reply->msg)[1];
 397
 398        switch (rtype) {
 399        case TYPE82_RSP_CODE:
 400        case TYPE88_RSP_CODE:
 401                return convert_error(zq, reply);
 402        case TYPE80_RSP_CODE:
 403                return convert_type80(zq, reply,
 404                                      outputdata, outputdatalength);
 405        default: /* Unknown response type, this should NEVER EVER happen */
 406                zq->online = 0;
 407                pr_err("Crypto dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
 408                       AP_QID_CARD(zq->queue->qid),
 409                       AP_QID_QUEUE(zq->queue->qid),
 410                       (int) rtype);
 411                ZCRYPT_DBF_ERR("dev=%02x.%04x unknown response type 0x%02x => online=0 rc=EAGAIN\n",
 412                               AP_QID_CARD(zq->queue->qid),
 413                               AP_QID_QUEUE(zq->queue->qid),
 414                               (int) rtype);
 415                return -EAGAIN;
 416        }
 417}
 418
 419/**
 420 * This function is called from the AP bus code after a crypto request
 421 * "msg" has finished with the reply message "reply".
 422 * It is called from tasklet context.
 423 * @aq: pointer to the AP device
 424 * @msg: pointer to the AP message
 425 * @reply: pointer to the AP reply message
 426 */
 427static void zcrypt_cex2a_receive(struct ap_queue *aq,
 428                                 struct ap_message *msg,
 429                                 struct ap_message *reply)
 430{
 431        static struct error_hdr error_reply = {
 432                .type = TYPE82_RSP_CODE,
 433                .reply_code = REP82_ERROR_MACHINE_FAILURE,
 434        };
 435        struct type80_hdr *t80h;
 436        int len;
 437
 438        /* Copy the reply message to the request message buffer. */
 439        if (!reply)
 440                goto out;       /* ap_msg->rc indicates the error */
 441        t80h = reply->msg;
 442        if (t80h->type == TYPE80_RSP_CODE) {
 443                if (aq->ap_dev.device_type == AP_DEVICE_TYPE_CEX2A)
 444                        len = min_t(int, CEX2A_MAX_RESPONSE_SIZE, t80h->len);
 445                else
 446                        len = min_t(int, CEX3A_MAX_RESPONSE_SIZE, t80h->len);
 447                memcpy(msg->msg, reply->msg, len);
 448        } else
 449                memcpy(msg->msg, reply->msg, sizeof(error_reply));
 450out:
 451        complete((struct completion *) msg->private);
 452}
 453
 454static atomic_t zcrypt_step = ATOMIC_INIT(0);
 455
 456/**
 457 * The request distributor calls this function if it picked the CEXxA
 458 * device to handle a modexpo request.
 459 * @zq: pointer to zcrypt_queue structure that identifies the
 460 *      CEXxA device to the request distributor
 461 * @mex: pointer to the modexpo request buffer
 462 */
 463static long zcrypt_cex2a_modexpo(struct zcrypt_queue *zq,
 464                                 struct ica_rsa_modexpo *mex,
 465                                 struct ap_message *ap_msg)
 466{
 467        struct completion work;
 468        int rc;
 469
 470        if (zq->zcard->user_space_type == ZCRYPT_CEX2A)
 471                ap_msg->msg = kmalloc(MSGTYPE50_CRB2_MAX_MSG_SIZE, GFP_KERNEL);
 472        else
 473                ap_msg->msg = kmalloc(MSGTYPE50_CRB3_MAX_MSG_SIZE, GFP_KERNEL);
 474        if (!ap_msg->msg)
 475                return -ENOMEM;
 476        ap_msg->receive = zcrypt_cex2a_receive;
 477        ap_msg->psmid = (((unsigned long long) current->pid) << 32) +
 478                atomic_inc_return(&zcrypt_step);
 479        ap_msg->private = &work;
 480        rc = ICAMEX_msg_to_type50MEX_msg(zq, ap_msg, mex);
 481        if (rc)
 482                goto out;
 483        init_completion(&work);
 484        rc = ap_queue_message(zq->queue, ap_msg);
 485        if (rc)
 486                goto out;
 487        rc = wait_for_completion_interruptible(&work);
 488        if (rc == 0) {
 489                rc = ap_msg->rc;
 490                if (rc == 0)
 491                        rc = convert_response_cex2a(zq, ap_msg,
 492                                                    mex->outputdata,
 493                                                    mex->outputdatalength);
 494        } else
 495                /* Signal pending. */
 496                ap_cancel_message(zq->queue, ap_msg);
 497out:
 498        ap_msg->private = NULL;
 499        return rc;
 500}
 501
 502/**
 503 * The request distributor calls this function if it picked the CEXxA
 504 * device to handle a modexpo_crt request.
 505 * @zq: pointer to zcrypt_queue structure that identifies the
 506 *      CEXxA device to the request distributor
 507 * @crt: pointer to the modexpoc_crt request buffer
 508 */
 509static long zcrypt_cex2a_modexpo_crt(struct zcrypt_queue *zq,
 510                                     struct ica_rsa_modexpo_crt *crt,
 511                                     struct ap_message *ap_msg)
 512{
 513        struct completion work;
 514        int rc;
 515
 516        if (zq->zcard->user_space_type == ZCRYPT_CEX2A)
 517                ap_msg->msg = kmalloc(MSGTYPE50_CRB2_MAX_MSG_SIZE, GFP_KERNEL);
 518        else
 519                ap_msg->msg = kmalloc(MSGTYPE50_CRB3_MAX_MSG_SIZE, GFP_KERNEL);
 520        if (!ap_msg->msg)
 521                return -ENOMEM;
 522        ap_msg->receive = zcrypt_cex2a_receive;
 523        ap_msg->psmid = (((unsigned long long) current->pid) << 32) +
 524                atomic_inc_return(&zcrypt_step);
 525        ap_msg->private = &work;
 526        rc = ICACRT_msg_to_type50CRT_msg(zq, ap_msg, crt);
 527        if (rc)
 528                goto out;
 529        init_completion(&work);
 530        rc = ap_queue_message(zq->queue, ap_msg);
 531        if (rc)
 532                goto out;
 533        rc = wait_for_completion_interruptible(&work);
 534        if (rc == 0) {
 535                rc = ap_msg->rc;
 536                if (rc == 0)
 537                        rc = convert_response_cex2a(zq, ap_msg,
 538                                                    crt->outputdata,
 539                                                    crt->outputdatalength);
 540        } else
 541                /* Signal pending. */
 542                ap_cancel_message(zq->queue, ap_msg);
 543out:
 544        ap_msg->private = NULL;
 545        return rc;
 546}
 547
 548/**
 549 * The crypto operations for message type 50.
 550 */
 551static struct zcrypt_ops zcrypt_msgtype50_ops = {
 552        .rsa_modexpo = zcrypt_cex2a_modexpo,
 553        .rsa_modexpo_crt = zcrypt_cex2a_modexpo_crt,
 554        .owner = THIS_MODULE,
 555        .name = MSGTYPE50_NAME,
 556        .variant = MSGTYPE50_VARIANT_DEFAULT,
 557};
 558
 559void __init zcrypt_msgtype50_init(void)
 560{
 561        zcrypt_msgtype_register(&zcrypt_msgtype50_ops);
 562}
 563
 564void __exit zcrypt_msgtype50_exit(void)
 565{
 566        zcrypt_msgtype_unregister(&zcrypt_msgtype50_ops);
 567}
 568