/src/opensc/src/libopensc/card-sc-hsm.c

Source
/*
 * card-sc-hsm.c
 *
 * Driver for the SmartCard-HSM, a light-weight hardware security module
 *
 * Copyright (C) 2012 Andreas Schwier, CardContact, Minden, Germany, and others
 * Copyright (C) 2018-2019 GSMK - Gesellschaft für Sichere Mobile Kommunikation mbH
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <string.h>
#include <stdlib.h>
#include <ctype.h>

#include "internal.h"
#include "asn1.h"
#include "cardctl.h"
#include "types.h"

#include "card-sc-hsm.h"

#if defined(ENABLE_SM) && defined(ENABLE_OPENPACE)
#include "sm/sm-eac.h"
#include <eac/ca.h>
#include <eac/cv_cert.h>
#include <eac/eac.h>
#include <eac/ta.h>
#include <openssl/evp.h>
#endif


/* Static reference to ISO driver */
static const struct sc_card_operations *iso_ops = NULL;

/* Our operations */
static struct sc_card_operations sc_hsm_ops;

/* Our driver description */
static struct sc_card_driver sc_hsm_drv = {
  "SmartCard-HSM",
  "sc-hsm",
  &sc_hsm_ops,
  NULL,
  0,
  NULL
};



/* Our AID */
struct sc_aid sc_hsm_aid = { { 0xE8,0x2B,0x06,0x01,0x04,0x01,0x81,0xC3,0x1F,0x02,0x01 }, 11 };



/* Known ATRs for SmartCard-HSMs */
const struct sc_atr_table sc_hsm_atrs[] = {
  /* standard version */
  {"3B:FE:18:00:00:81:31:FE:45:80:31:81:54:48:53:4D:31:73:80:21:40:81:07:FA", NULL, NULL, SC_CARD_TYPE_SC_HSM, 0, NULL},
  {"3B:8E:80:01:80:31:81:54:48:53:4D:31:73:80:21:40:81:07:18", NULL, NULL, SC_CARD_TYPE_SC_HSM, 0, NULL},
  {"3B:DE:18:FF:81:91:FE:1F:C3:80:31:81:54:48:53:4D:31:73:80:21:40:81:07:1C", NULL, NULL, SC_CARD_TYPE_SC_HSM, 0, NULL},
  {"3B:DE:96:FF:81:91:FE:1F:C3:80:31:81:54:48:53:4D:31:73:80:21:40:81:07:92", NULL, NULL, SC_CARD_TYPE_SC_HSM, 0, NULL},

  {"3B:80:80:01:01", NULL, NULL, SC_CARD_TYPE_SC_HSM_SOC, 0, NULL}, // SoC Sample Card
  {
    "3B:84:80:01:47:6f:49:44:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:85:80:01:47:6f:49:44:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:86:80:01:47:6f:49:44:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:87:80:01:47:6f:49:44:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:88:80:01:47:6f:49:44:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:89:80:01:47:6f:49:44:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8a:80:01:47:6f:49:44:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8b:80:01:47:6f:49:44:00:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8c:80:01:47:6f:49:44:00:00:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8d:80:01:47:6f:49:44:00:00:00:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8e:80:01:47:6f:49:44:00:00:00:00:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {
    "3B:8f:80:01:47:6f:49:44:00:00:00:00:00:00:00:00:00:00:00:00",
    "FF:FF:FF:FF:FF:FF:FF:FF:00:00:00:00:00:00:00:00:00:00:00:00",
    "GoID", SC_CARD_TYPE_SC_HSM_GOID, 0, NULL
  },
  {NULL, NULL, NULL, 0, 0, NULL}
};



static int sc_hsm_select_file_ex(sc_card_t *card,
             const sc_path_t *in_path, int forceselect,
             sc_file_t **file_out)
{
  int rv;
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  sc_file_t *file = NULL;
  sc_path_t cpath;
  size_t card_max_recv_size = card->max_recv_size;
  size_t reader_max_recv_size = card->reader->max_recv_size;

  if (file_out == NULL) {       // Versions before 0.16 of the SmartCard-HSM do not support P2='0C'
    rv = sc_hsm_select_file_ex(card, in_path, forceselect, &file);
    sc_file_free(file);
    return rv;
  }

  if ((in_path->type == SC_PATH_TYPE_FILE_ID) && in_path->aid.len) {
    // Split applet selection and file selection into two separate calls
    cpath = *in_path;
    cpath.len = 0;
    cpath.type = SC_PATH_TYPE_DF_NAME;
    rv = sc_hsm_select_file_ex(card, &cpath, forceselect, NULL);
    LOG_TEST_RET(card->ctx, rv, "Could not select SmartCard-HSM application");

    if (in_path->len) {
      cpath = *in_path;
      cpath.aid.len = 0;
      rv = sc_hsm_select_file_ex(card, &cpath, forceselect, file_out);
    }
    return rv;
  }

  // Prevent selection of applet unless this is the first time, selection is forced or the device is not authenticated
  if (in_path->type == SC_PATH_TYPE_DF_NAME
      || (in_path->type == SC_PATH_TYPE_PATH
        && in_path->len == sc_hsm_aid.len
        && !memcmp(in_path->value, sc_hsm_aid.value, sc_hsm_aid.len))
      || (in_path->type == SC_PATH_TYPE_PATH
        && in_path->len == 0
        && in_path->aid.len == sc_hsm_aid.len
        && !memcmp(in_path->aid.value, sc_hsm_aid.value, sc_hsm_aid.len))) {
    if (!priv || (priv->dffcp == NULL) || forceselect) {
      /* Force use of Le = 0x00 in iso7816_select_file as required by SC-HSM */
      card->max_recv_size = card->reader->max_recv_size = SC_READER_SHORT_APDU_MAX_RECV_SIZE;
      rv = (*iso_ops->select_file)(card, in_path, file_out);
      card->max_recv_size = card_max_recv_size;
      card->reader->max_recv_size = reader_max_recv_size;
      LOG_TEST_RET(card->ctx, rv, "Could not select SmartCard-HSM application");

      if (priv) {
        sc_file_free(priv->dffcp);
        // Cache the FCP returned when selecting the applet
        sc_file_dup(&priv->dffcp, *file_out);
      }
    } else {
      sc_file_dup(file_out, priv->dffcp);
      rv = SC_SUCCESS;
    }
    return rv;
  }

  if ((in_path->len >= 2) && (in_path->value[0] == 0x3F) && (in_path->value[1] == 0x00)) {
    // The SmartCard-HSM is an applet that is not default selected. Simulate selection of the MF
    if (in_path->len == 2) {
      file = sc_file_new();
      if (file == NULL)
        LOG_FUNC_RETURN(card->ctx, SC_ERROR_OUT_OF_MEMORY);
      file->path = *in_path;
      file->id = 0x3F00;
      file->type = SC_FILE_TYPE_DF;
      file->magic = SC_FILE_MAGIC;

      *file_out = file;
      return SC_SUCCESS;
    } else {
      /* Force use of Le = 0x00 in iso7816_select_file as required by SC-HSM */
      card->max_recv_size = card->reader->max_recv_size = SC_READER_SHORT_APDU_MAX_RECV_SIZE;
      sc_path_t truncated;
      memcpy(&truncated, in_path, sizeof truncated);
      truncated.len = in_path->len - 2;
      memcpy(truncated.value, in_path->value+2, truncated.len);
      rv = (*iso_ops->select_file)(card, &truncated, file_out);
      card->max_recv_size = card_max_recv_size;
      card->reader->max_recv_size = reader_max_recv_size;
      return rv;
    }
  }
  /* Force use of Le = 0x00 in iso7816_select_file as required by SC-HSM */
  card->max_recv_size = card->reader->max_recv_size = SC_READER_SHORT_APDU_MAX_RECV_SIZE;
  rv = (*iso_ops->select_file)(card, in_path, file_out);
  card->max_recv_size = card_max_recv_size;
  card->reader->max_recv_size = reader_max_recv_size;
  return rv;
}



static int sc_hsm_select_file(sc_card_t *card,
             const sc_path_t *in_path,
             sc_file_t **file_out)
{
  return sc_hsm_select_file_ex(card, in_path, 0, file_out);
}



static int sc_hsm_get_challenge(struct sc_card *card, unsigned char *rnd, size_t len)
{
  LOG_FUNC_CALLED(card->ctx);

  if (len > 1024) {
    len = 1024;
  }

  LOG_FUNC_RETURN(card->ctx, iso_ops->get_challenge(card, rnd, len));
}



static int sc_hsm_match_card(struct sc_card *card)
{
  sc_path_t path;
  int i, r, type = 0;
  sc_file_t *file = NULL;

  i = _sc_match_atr(card, sc_hsm_atrs, &type);
  if (i >= 0 && type != SC_CARD_TYPE_SC_HSM_SOC) {
    card->type = type;
    return 1;
  }

  sc_path_set(&path, SC_PATH_TYPE_DF_NAME, sc_hsm_aid.value, sc_hsm_aid.len, 0, 0);
  r = sc_hsm_select_file(card, &path, &file);
  LOG_TEST_RET(card->ctx, r, "Could not select SmartCard-HSM application");

  // Validate that card returns a FCP with a proprietary tag 85 with value longer than 2 byte (Fixes #1377)
  if (file != NULL) {
    size_t sz = file->prop_attr_len;
    sc_file_free(file);
    if (sz < 2) {
      return 0;
    }
  }

  if (type == SC_CARD_TYPE_SC_HSM_SOC) {
    card->type = SC_CARD_TYPE_SC_HSM_SOC;
  } else {
    card->type = SC_CARD_TYPE_SC_HSM;
  }

  return 1;
}



/*
 * Encode 16 hexadecimals of SO-PIN into binary form
 * Caller must check length of sopin and provide an 8 byte buffer
 */
static int sc_hsm_encode_sopin(const u8 *sopin, u8 *sopinbin)
{
  int i;
  unsigned char digit;

  memset(sopinbin, 0, 8);
  for (i = 0; i < 16; i++) {
    *sopinbin <<= 4;
    digit = *sopin++;

    if (!isxdigit(digit))
      return SC_ERROR_PIN_CODE_INCORRECT;
    digit = toupper(digit);

    if (digit >= 'A')
      digit = digit - 'A' + 10;
    else
      digit = digit & 0xF;

    *sopinbin |= digit & 0xf;
    if (i & 1)
      sopinbin++;
  }
  return SC_SUCCESS;
}


static int sc_hsm_soc_select_minbioclient(sc_card_t *card)
{
  static const struct sc_aid minBioClient_aid = {
      {0xFF, 'm', 'i', 'n', 'B', 'i', 'o', 'C', 'l', 'i', 'e', 'n', 't', 0x01},
      14
    };

  /* Select MinBioClient */
#ifdef ENABLE_SM
  sc_sm_stop(card);
#endif
  return iso7816_select_aid(card, minBioClient_aid.value, minBioClient_aid.len, NULL, NULL);
}

static int sc_hsm_soc_change(sc_card_t *card, struct sc_pin_cmd_data *data)
{
  sc_apdu_t apdu;
  sc_path_t path;
  int r;

  if (card->type == SC_CARD_TYPE_SC_HSM_SOC) {
    /* Select MinBioClient */
    r = sc_hsm_soc_select_minbioclient(card);
    LOG_TEST_RET(card->ctx, r, "Could not select MinBioClient application");

    /* verify PIN */
    sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x20, 0x00, 0x80);
    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");
    r = sc_check_sw(card, apdu.sw1, apdu.sw2);
    LOG_TEST_GOTO_ERR(card->ctx, r, "Could not verify PIN");

    /* change PIN */
    sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x24, 0x01, 0x80);
    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");
    r = sc_check_sw(card, apdu.sw1, apdu.sw2);
    LOG_TEST_GOTO_ERR(card->ctx, r, "Could not change PIN");
  } else {
#ifdef ENABLE_SM
    unsigned sm_mode = card->sm_ctx.sm_mode;
#endif

    /* verify PIN */
    sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x20, 0x00, 0x85);
    apdu.cla = 0x80;
    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");

#ifdef ENABLE_SM
    /* temporary disable SM, change reference data does not reach the applet */
    card->sm_ctx.sm_mode = SM_MODE_NONE;
#endif

    /* change PIN */
    sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x24, 0x01, 0x85);
    apdu.cla = 0x80;
    r = sc_transmit_apdu(card, &apdu);
#ifdef ENABLE_SM
    /* restore SM if possible */
    card->sm_ctx.sm_mode = sm_mode;
#endif
    LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");
    r = sc_check_sw(card, apdu.sw1, apdu.sw2);
    LOG_TEST_GOTO_ERR(card->ctx, r, "Could not change PIN");
  }

err:
  if (card->type == SC_CARD_TYPE_SC_HSM_SOC) {
    /* Select SC-HSM */
    sc_path_set(&path, SC_PATH_TYPE_DF_NAME,
          sc_hsm_aid.value, sc_hsm_aid.len, 0, 0);
    LOG_TEST_RET(card->ctx,
        sc_hsm_select_file_ex(card, &path, 1, NULL),
        "Could not select SmartCard-HSM application");
  }

  return r;
}

static int sc_hsm_soc_unblock(sc_card_t *card, struct sc_pin_cmd_data *data)
{
  sc_apdu_t apdu;
  sc_path_t path;
  int r;

  if (card->type == SC_CARD_TYPE_SC_HSM_GOID) {
    return SC_ERROR_NOT_SUPPORTED;
  }

  /* Select MinBioClient */
  r = sc_hsm_soc_select_minbioclient(card);
  LOG_TEST_RET(card->ctx, r, "Could not select MinBioClient application");

  /* verify PUK */
  sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x20, 0x00, 0x81);
  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_GOTO_ERR(card->ctx, r, "Could not verify PUK");

  /* reset retry counter */
  sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x2c, 0x03, 0x00);
  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_GOTO_ERR(card->ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_GOTO_ERR(card->ctx, r, "Could not unblock PIN");

err:
  /* Select SC-HSM */
  sc_path_set(&path, SC_PATH_TYPE_DF_NAME, sc_hsm_aid.value, sc_hsm_aid.len, 0, 0);
  LOG_TEST_RET(card->ctx,
      sc_hsm_select_file_ex(card, &path, 1, NULL),
      "Could not select SmartCard-HSM application");

  return r;
}

static int sc_hsm_soc_biomatch(sc_card_t *card, struct sc_pin_cmd_data *data)
{
  sc_apdu_t apdu;
  u8 rbuf[SC_MAX_APDU_BUFFER_SIZE];
  int r;

  if (card->type == SC_CARD_TYPE_SC_HSM_SOC) {
    sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0x20, 0x00, 0x85);
    apdu.cla = 0x80;
    apdu.data = (unsigned char*)"\x7F\x24\x00";
    apdu.datalen = 3;
    apdu.lc = 3;
    apdu.resplen = 0;

    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_RET(card->ctx, r, "APDU transmit failed");
    /* ignore the actual status bytes */
  }

  /* JCOP's SM accelerator is incapable of using case 1 APDU in SM */
  sc_format_apdu(card, &apdu, SC_APDU_CASE_2, 0x20, 0x00, 0x81);
  if (card->type == SC_CARD_TYPE_SC_HSM_GOID) {
    apdu.cla = 0x80;
  }
  apdu.resp = rbuf;
  apdu.resplen = sizeof rbuf;
  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

  /* now check the status bytes */
  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);
  if (r == SC_SUCCESS) {
    LOG_FUNC_RETURN(card->ctx, r);
  }

  LOG_FUNC_RETURN(card->ctx, SC_ERROR_PIN_CODE_INCORRECT);
}

#if defined(ENABLE_SM) && defined(ENABLE_OPENPACE)

static int sc_hsm_perform_chip_authentication(sc_card_t *card)
{
  int r, protocol;
  sc_path_t path;
  u8 all_certs[1024];
  EAC_CTX *ctx = NULL;
  size_t all_certs_len = sizeof all_certs, left, device_cert_len, issuer_cert_len;
  const unsigned char *cert = all_certs, *device_cert, *issuer_cert;
  BUF_MEM *comp_pub_key = NULL;
  sc_cvc_t cvc_device, cvc_issuer;
  /* this is only needed to call sc_pkcs15emu_sc_hsm_decode_cvc */
  sc_pkcs15_card_t p15card;
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  /* we know that sc_pkcs15emu_sc_hsm_decode_cvc does not require anything
   * else to be initialized than p15card->card */
  p15card.card = card;

  memset(&cvc_device, 0, sizeof(cvc_device));
  memset(&cvc_issuer, 0, sizeof(cvc_issuer));


  if (priv->EF_C_DevAut && priv->EF_C_DevAut_len) {
    all_certs_len = priv->EF_C_DevAut_len;
    cert = priv->EF_C_DevAut;
  } else {
    /* get issuer and device certificate from the card */
    r = sc_path_set(&path, SC_PATH_TYPE_FILE_ID, (u8 *) "\x2F\x02", 2, 0, 0);
    if (r < 0)
      goto err;
    r = sc_select_file(card, &path, NULL);
    if (r < 0)
      goto err;
    r = sc_read_binary(card, 0, all_certs, all_certs_len, 0);
    if (r < 0)
      goto err;
    if (r == 0) {
      r = SC_ERROR_FILE_NOT_FOUND;
      goto err;
    }

    all_certs_len = r;

    /* save EF_C_DevAut for further use */
    cert = realloc(priv->EF_C_DevAut, all_certs_len);
    if (cert) {
      memcpy((unsigned char *) cert, all_certs, all_certs_len);
      priv->EF_C_DevAut = (unsigned char *) cert;
      priv->EF_C_DevAut_len = all_certs_len;
    }

    cert = all_certs;
  }
  left = all_certs_len;

  device_cert = cert;
  r = sc_pkcs15emu_sc_hsm_decode_cvc(&p15card, &cert, &left, &cvc_device);
  if (r < 0)
    goto err;
  device_cert_len = all_certs_len - left;

  issuer_cert = cert;
  r = sc_pkcs15emu_sc_hsm_decode_cvc(&p15card, &cert, &left, &cvc_issuer);
  if (r < 0)
    goto err;
  issuer_cert_len = all_certs_len - device_cert_len - left;

  ctx = EAC_CTX_new();
  if (!ctx) {
    r = SC_ERROR_INTERNAL;
    goto err;
  }

  /* FIXME set flags with opensc.conf */
  TA_disable_checks(ctx);
  CA_disable_passive_authentication(ctx);

  /* check all CVCs given of the document's pki */
  if (!TA_STEP2_import_certificate(ctx, issuer_cert, issuer_cert_len)
      || !TA_STEP2_import_certificate(ctx, device_cert, device_cert_len)) {
    r = SC_ERROR_INTERNAL;
    goto err;
  }

  /* XXX on older JCOPs only NID_id_CA_ECDH_3DES_CBC_CBC may be
   * supported. The card does not export its capabilities. We hardcode
   * NID_id_CA_ECDH_AES_CBC_CMAC_128 here, because we don't have the older
   * cards in production. */
  protocol = NID_id_CA_ECDH_AES_CBC_CMAC_128;

  /* initialize CA domain parameter with the document's public key */
  if (!EAC_CTX_init_ca(ctx, protocol, 8)) {
    r = SC_ERROR_INTERNAL;
    goto err;
  }
  EVP_PKEY_free(ctx->ca_ctx->ka_ctx->key);
  if (!EVP_PKEY_up_ref(ctx->ta_ctx->pub_key)) {
    sc_log_openssl(card->ctx);
    r = SC_ERROR_INTERNAL;
    goto err;
  }
  ctx->ca_ctx->ka_ctx->key = ctx->ta_ctx->pub_key;

  /* generate keys for CA */
  comp_pub_key = TA_STEP3_generate_ephemeral_key(ctx);
  r = perform_chip_authentication_ex(card, ctx,
      cvc_device.publicPoint, cvc_device.publicPointlen);

err:
  if (r < 0)
    EAC_CTX_clear_free(ctx);
  if (comp_pub_key)
    BUF_MEM_free(comp_pub_key);
  sc_pkcs15emu_sc_hsm_free_cvc(&cvc_device);
  sc_pkcs15emu_sc_hsm_free_cvc(&cvc_issuer);

  return r;
}

#else

static int sc_hsm_perform_chip_authentication(sc_card_t *card)
{
  return SC_ERROR_NOT_SUPPORTED;
}
#endif



static int sc_hsm_pin_cmd(sc_card_t *card, struct sc_pin_cmd_data *data)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  sc_apdu_t apdu;
  u8 cmdbuff[16];
#ifdef ENABLE_SM
  u8 rbuf[SC_MAX_APDU_BUFFER_SIZE];
#endif
  int r;
  int cmd = data->cmd;
  size_t pin2_len = data->pin2.len;

  if (cmd == SC_PIN_CMD_GET_SESSION_PIN) {
    /* First, perform a standard VERIFY */
    data->cmd = SC_PIN_CMD_VERIFY;
    /* we assign pin2.len to 0 early on so that in case of an error we are
     * not exiting with an undefined session PIN */
    data->pin2.len = 0;
  }

  if ((card->caps & SC_CARD_CAP_PROTECTED_AUTHENTICATION_PATH)
        && (data->cmd == SC_PIN_CMD_CHANGE)
        && (data->pin_reference == 0x81)
      && (!data->pin1.data || data->pin1.len <= 0)) {
    return sc_hsm_soc_change(card, data);
  } else if ((card->caps & SC_CARD_CAP_PROTECTED_AUTHENTICATION_PATH)
        && (data->cmd == SC_PIN_CMD_UNBLOCK)
        && (data->pin_reference == 0x81)
      && (!data->pin1.data || data->pin1.len <= 0)) {
    return sc_hsm_soc_unblock(card, data);
  }

#ifdef ENABLE_SM
  /* For contactless cards always establish a secure channel before PIN
   * verification. Also, Session PIN generation requires SM. */
  if ((card->type == SC_CARD_TYPE_SC_HSM_SOC
        || card->type == SC_CARD_TYPE_SC_HSM_GOID
        || card->reader->uid.len || cmd == SC_PIN_CMD_GET_SESSION_PIN)
      && (data->cmd != SC_PIN_CMD_GET_INFO)) {
    struct sc_pin_cmd_data check_sm_pin_data;
    memset(&check_sm_pin_data, 0, sizeof(check_sm_pin_data));
    check_sm_pin_data.cmd = SC_PIN_CMD_GET_INFO;
    check_sm_pin_data.pin_type = data->pin_type;
    check_sm_pin_data.pin_reference = data->pin_reference;

    r = SC_ERROR_NOT_ALLOWED;
    if (card->sm_ctx.sm_mode == SM_MODE_TRANSMIT) {
      /* check if the existing SM channel is still valid */
      r = sc_pin_cmd(card, &check_sm_pin_data);
    }
    if (r == SC_ERROR_ASN1_OBJECT_NOT_FOUND || r == SC_ERROR_NOT_ALLOWED) {
      /* need to establish a new SM channel */
      LOG_TEST_RET(card->ctx,
          sc_hsm_perform_chip_authentication(card),
          "Could not perform chip authentication");
    }
  }
#endif

  if ((card->caps & SC_CARD_CAP_PROTECTED_AUTHENTICATION_PATH)
      && (data->cmd == SC_PIN_CMD_VERIFY)
      && (data->pin_reference == 0x81)
      && (!data->pin1.data || data->pin1.len <= 0)) {
    r = sc_hsm_soc_biomatch(card, data);
  } else {
    if ((data->cmd == SC_PIN_CMD_VERIFY) && (data->pin_reference == 0x88)) {
      if (data->pin1.len != 16)
        return SC_ERROR_INVALID_PIN_LENGTH;

      // Save SO PIN for later use in sc_hsm_init_pin()
      r = sc_hsm_encode_sopin(data->pin1.data, priv->sopin);
      LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

      LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
    }

    if ((data->cmd == SC_PIN_CMD_CHANGE) && (data->pin_reference == 0x88)) {
      if ((data->pin1.len != 16) || (data->pin2.len != 16))
        return SC_ERROR_INVALID_PIN_LENGTH;

      r = sc_hsm_encode_sopin(data->pin1.data, cmdbuff);
      LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

      r = sc_hsm_encode_sopin(data->pin2.data, cmdbuff + 8);
      LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

      sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0x24, 0x00, data->pin_reference);
      apdu.data = cmdbuff;
      apdu.datalen = sizeof(cmdbuff);
      apdu.lc = 16;
      apdu.resplen = 0;
      data->apdu = &apdu;
    }

#ifdef ENABLE_SM
    if ((data->cmd == SC_PIN_CMD_GET_INFO)
        && (card->sm_ctx.sm_mode == SM_MODE_TRANSMIT)) {
      /* JCOP's SM accelerator is incapable of using case 1 APDU in SM */
      sc_format_apdu(card, &apdu, SC_APDU_CASE_2, 0x20, 0x00, data->pin_reference);
      apdu.resp = rbuf;
      apdu.resplen = sizeof rbuf;
      data->apdu = &apdu;
    }
#endif

    data->pin1.offset = 5;
    data->pin2.offset = 5;

    r = (*iso_ops->pin_cmd)(card, data);
    data->apdu = NULL;
  }
  LOG_TEST_RET(card->ctx, r, "Verification failed");

  if (cmd == SC_PIN_CMD_GET_SESSION_PIN) {
    /* reset data->cmd to its original value */
    data->cmd = SC_PIN_CMD_GET_SESSION_PIN;
    if (data->pin_reference == 0x81) {
      u8 recvbuf[SC_MAX_APDU_BUFFER_SIZE];
#ifdef ENABLE_SM
      if (card->sm_ctx.sm_mode != SM_MODE_TRANSMIT) {
        sc_log(card->ctx,
            "Session PIN generation only supported in SM");
        LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
      }
#else
      sc_log(card->ctx,
          "Session PIN generation only supported in SM");
      LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
#endif
      sc_format_apdu(card, &apdu, SC_APDU_CASE_2_SHORT, 0x5A, 0x01, data->pin_reference);
      apdu.cla = 0x80;
      apdu.resp = recvbuf;
      apdu.resplen = sizeof recvbuf;
      apdu.le = 0;
      if (sc_transmit_apdu(card, &apdu) != SC_SUCCESS
          || sc_check_sw(card, apdu.sw1, apdu.sw2) != SC_SUCCESS) {
        sc_log(card->ctx,
            "Generating session PIN failed");
        LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
      }
      if (data->pin2.data && pin2_len > 0) {
        if (pin2_len >= apdu.resplen) {
          memcpy((unsigned char *) data->pin2.data, apdu.resp,
              apdu.resplen);
          data->pin2.len = apdu.resplen;
        } else {
          sc_log(card->ctx,
              "Buffer too small for session PIN");
        }
      }
    } else {
      sc_log(card->ctx,
          "Session PIN not supported for this PIN (0x%02X)",
          data->pin_reference);
    }
  }
  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_logout(sc_card_t * card)
{
  sc_path_t path;
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  memset(priv->sopin, 0, sizeof(priv->sopin));
#ifdef ENABLE_SM
  sc_sm_stop(card);
#endif

  sc_path_set(&path, SC_PATH_TYPE_DF_NAME, sc_hsm_aid.value, sc_hsm_aid.len, 0, 0);

  return sc_hsm_select_file_ex(card, &path, 1, NULL);
}


/* NOTE: idx is an offset into the card's file, not into buf */
static int sc_hsm_read_binary(sc_card_t *card,
             unsigned int idx, u8 *buf, size_t count,
             unsigned long *flags)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 cmdbuff[4];
  int r;

  if (idx > 0xffff) {
    sc_log(ctx,  "invalid EF offset: 0x%X > 0xFFFF", idx);
    return SC_ERROR_OFFSET_TOO_LARGE;
  }

  cmdbuff[0] = 0x54;
  cmdbuff[1] = 0x02;
  cmdbuff[2] = (idx >> 8) & 0xFF;
  cmdbuff[3] = idx & 0xFF;

  if (count > sc_get_max_recv_size(card))
    return SC_ERROR_INTERNAL;
  sc_format_apdu(card, &apdu, SC_APDU_CASE_4, 0xB1, 0x00, 0x00);
  apdu.data = cmdbuff;
  apdu.datalen = 4;
  apdu.lc = 4;
  apdu.le = count;
  apdu.resplen = count;
  apdu.resp = buf;

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);
  if (r != SC_ERROR_FILE_END_REACHED) {
    LOG_TEST_RET(ctx, r, "Check SW error");
  }

  LOG_FUNC_RETURN(ctx, (int)apdu.resplen);
}


/* NOTE: idx is an offset into the card's file, not into buf */
static int sc_hsm_write_ef(sc_card_t *card,
             int fid,
             unsigned int idx, const u8 *buf, size_t count)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 *cmdbuff, *p;
  size_t len;
  int r;

  if (idx > 0xffff) {
    sc_log(ctx,  "invalid EF offset: 0x%X > 0xFFFF", idx);
    return SC_ERROR_OFFSET_TOO_LARGE;
  }

  cmdbuff = malloc(8 + count);
  if (!cmdbuff) {
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_OUT_OF_MEMORY);
  }

  size_t bytes_left = count;
  // 8 bytes are required for T54(4) and T53(4)
  size_t blk_size = card->max_send_size - 8;
  size_t to_send = 0;
  size_t file_offset = (size_t) idx;
  size_t offset = 0;
  do {
    to_send = bytes_left >= blk_size ? blk_size : bytes_left;
    p = cmdbuff;
    // ASN1 0x54 offset
    *p++ = 0x54;
    *p++ = 0x02;
    *p++ = (file_offset >> 8) & 0xFF;
    *p++ = file_offset & 0xFF;
    // ASN1 0x53 to_send
    *p++ = 0x53;
    if (to_send < 128) {
      *p++ = (u8)to_send;
      len = 6;
    } else if (to_send < 256) {
      *p++ = 0x81;
      *p++ = (u8)to_send;
      len = 7;
    } else {
      *p++ = 0x82;
      *p++ = (to_send >> 8) & 0xFF;
      *p++ = to_send & 0xFF;
      len = 8;
    }

    if (buf != NULL)
      memcpy(p, buf+offset, to_send);
    len += to_send;

    sc_format_apdu(card, &apdu, SC_APDU_CASE_3, 0xD7, fid >> 8, fid & 0xFF);
    apdu.data = cmdbuff;
    apdu.datalen = len;
    apdu.lc = len;

    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_GOTO_ERR(ctx, r, "APDU transmit failed");
    r = sc_check_sw(card, apdu.sw1, apdu.sw2);
    LOG_TEST_GOTO_ERR(ctx, r, "Check SW error");

    bytes_left -= to_send;
    offset += to_send;
    file_offset += to_send;
  } while (0 < bytes_left);

err:
  free(cmdbuff);

  LOG_FUNC_RETURN(ctx, (int)count);
}


static int sc_hsm_update_binary(sc_card_t *card,
             unsigned int idx, const u8 *buf, size_t count,
             unsigned long flags)
{
  return sc_hsm_write_ef(card, 0, idx, buf, count);
}



static int sc_hsm_list_files(sc_card_t *card, u8 * buf, size_t buflen)
{
  sc_apdu_t apdu;
  u8 recvbuf[MAX_EXT_APDU_LENGTH];
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  int r;

  if (priv->noExtLength) {
    sc_format_apdu(card, &apdu, SC_APDU_CASE_2, 0x58, 0, 0);
  } else {
    sc_format_apdu(card, &apdu, SC_APDU_CASE_2_EXT, 0x58, 0, 0);
  }
  apdu.cla = 0x80;
  apdu.resp = recvbuf;
  apdu.resplen = sizeof(recvbuf);
  apdu.le = 0;
  r = sc_transmit_apdu(card, &apdu);

  if ((r == SC_ERROR_TRANSMIT_FAILED) && (!priv->noExtLength)) {
    sc_log(card->ctx, "No extended length support ? Trying fall-back to short APDUs, probably breaking support for RSA 2048 operations");
    priv->noExtLength = 1;
    card->max_send_size = 248;    // 255 - 7 because of TLV in odd ins UPDATE BINARY
    return sc_hsm_list_files(card, buf, buflen);
  }
  LOG_TEST_RET(card->ctx, r, "ENUMERATE OBJECTS APDU transmit failed");

  if (buflen < apdu.resplen)
    memcpy(buf, recvbuf, buflen);
  else
    memcpy(buf, recvbuf, apdu.resplen);

  LOG_FUNC_RETURN(card->ctx, (int)apdu.resplen);
}



static int sc_hsm_create_file(sc_card_t *card, sc_file_t *file)
{
  int r;

  r = sc_hsm_write_ef(card, file->id, 0, NULL, 0);
  LOG_TEST_RET(card->ctx, r, "Create file failed");

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_delete_file(sc_card_t *card, const sc_path_t *path)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 sbuf[2];
  int r;

  if ((path->type != SC_PATH_TYPE_FILE_ID) || (path->len != 2)) {
    sc_log(card->ctx,  "File type has to be SC_PATH_TYPE_FILE_ID");
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_INVALID_ARGUMENTS);
  }

  sbuf[0] = path->value[0];
  sbuf[1] = path->value[1];

  sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0xE4, 0x02, 0x00);
  apdu.data = sbuf;
  apdu.datalen = sizeof(sbuf);
  apdu.lc = sizeof(sbuf);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(ctx, r, "Check SW error");

  LOG_FUNC_RETURN(ctx, SC_SUCCESS);
}


static int sc_hsm_set_security_env(sc_card_t *card,
           const sc_security_env_t *env,
           int se_num)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;

  priv->env = env;

  switch(env->algorithm) {
  case SC_ALGORITHM_RSA:
    if (env->algorithm_flags & SC_ALGORITHM_RSA_PAD_PKCS1) {
      if (env->algorithm_flags & SC_ALGORITHM_RSA_HASH_SHA1) {
        priv->algorithm = ALGO_RSA_PKCS1_SHA1;
      } else if (env->algorithm_flags & SC_ALGORITHM_RSA_HASH_SHA256) {
        priv->algorithm = ALGO_RSA_PKCS1_SHA256;
      } else if (env->algorithm_flags & SC_ALGORITHM_RSA_HASH_SHA384) {
        priv->algorithm = ALGO_RSA_PKCS1_SHA384;
      } else if (env->algorithm_flags & SC_ALGORITHM_RSA_HASH_SHA512) {
        priv->algorithm = ALGO_RSA_PKCS1_SHA512;
      } else {
        priv->algorithm = ALGO_RSA_PKCS1;
      }
    } else if (env->algorithm_flags & SC_ALGORITHM_RSA_PAD_PSS) {
      if ((env->algorithm_flags & SC_ALGORITHM_RSA_HASHES) &&
          (((env->algorithm_flags & SC_ALGORITHM_MGF1_HASHES) >> 8) != (env->algorithm_flags & SC_ALGORITHM_RSA_HASHES))) {
        LOG_FUNC_RETURN(card->ctx, SC_ERROR_INVALID_ARGUMENTS);
      }
      priv->algorithm = ALGO_RSA_PSS;
    } else {
      if (env->operation == SC_SEC_OPERATION_DECIPHER) {
        priv->algorithm = ALGO_RSA_DECRYPT;
      } else {
        priv->algorithm = ALGO_RSA_RAW;
      }
    }
    break;
  case SC_ALGORITHM_EC:
    if (env->operation == SC_SEC_OPERATION_DERIVE) {
      priv->algorithm = ALGO_EC_DH;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_NONE) {
      priv->algorithm = ALGO_EC_RAW;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_SHA1) {
      priv->algorithm = ALGO_EC_SHA1;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_SHA224) {
      priv->algorithm = ALGO_EC_SHA224;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_SHA256) {
      priv->algorithm = ALGO_EC_SHA256;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_SHA384) {
      priv->algorithm = ALGO_EC_SHA384;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_HASH_SHA512) {
      priv->algorithm = ALGO_EC_SHA512;
    } else if (env->algorithm_flags & SC_ALGORITHM_ECDSA_RAW) {
      priv->algorithm = ALGO_EC_RAW;
    } else {
      LOG_FUNC_RETURN(card->ctx, SC_ERROR_INVALID_ARGUMENTS);
    }
    break;
  default:
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_INVALID_ARGUMENTS);
    break;
  }
  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_decode_ecdsa_signature(sc_card_t *card,
          const u8 * data, size_t datalen,
          u8 * out, size_t outlen,
          size_t key_size) {

  int r;
  size_t fieldsizebytes = (key_size + 7) >> 3;

  sc_log(card->ctx, "Field size %zu, signature buffer size %zu", fieldsizebytes, outlen);

  r = sc_asn1_decode_ecdsa_signature(card->ctx, data, datalen, fieldsizebytes, &out, outlen);
  LOG_FUNC_RETURN(card->ctx, r);
}



static int sc_hsm_compute_signature(sc_card_t *card,
             const u8 * data, size_t datalen,
             u8 * out, size_t outlen)
{
  int r;
  sc_apdu_t apdu;
  u8 rbuf[514];
  sc_hsm_private_data_t *priv;

  if (card == NULL || data == NULL || out == NULL) {
    return SC_ERROR_INVALID_ARGUMENTS;
  }
  priv = (sc_hsm_private_data_t *) card->drv_data;

  if (priv->env == NULL) {
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_OBJECT_NOT_FOUND);
  }

  sc_format_apdu(card, &apdu, SC_APDU_CASE_4_EXT, 0x68, priv->env->key_ref[0], priv->algorithm);
  apdu.cla = 0x80;
  apdu.resp = rbuf;
  apdu.resplen = sizeof(rbuf);
  apdu.le = 512;

  apdu.data = data;
  apdu.lc = datalen;
  apdu.datalen = datalen;
  r = sc_transmit_apdu(card, &apdu);

  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");
  if (apdu.sw1 == 0x90 && apdu.sw2 == 0x00) {
    int len;

    if ((priv->algorithm & 0xF0) == ALGO_EC_RAW) {
      len = sc_hsm_decode_ecdsa_signature(card, apdu.resp, apdu.resplen, out, outlen, priv->env->key_size_bits);
      if (len < 0) {
        LOG_FUNC_RETURN(card->ctx, len);
      }
    } else {
      len = (int)(apdu.resplen > outlen ? outlen : apdu.resplen);
      memcpy(out, apdu.resp, len);
    }
    LOG_FUNC_RETURN(card->ctx, len);
  }
  LOG_FUNC_RETURN(card->ctx, sc_check_sw(card, apdu.sw1, apdu.sw2));
}



static int sc_hsm_decipher(sc_card_t *card, const u8 * crgram, size_t crgram_len, u8 * out, size_t outlen)
{
  int r;
  size_t len;
  sc_apdu_t apdu;
  u8 rbuf[514];
  sc_hsm_private_data_t *priv;

  if (card == NULL || crgram == NULL || out == NULL) {
    return SC_ERROR_INVALID_ARGUMENTS;
  }
  LOG_FUNC_CALLED(card->ctx);
  priv = (sc_hsm_private_data_t *) card->drv_data;

  sc_format_apdu(card, &apdu, SC_APDU_CASE_4_EXT, 0x62, priv->env->key_ref[0], priv->algorithm);
  apdu.cla = 0x80;
  apdu.resp = rbuf;
  apdu.resplen = sizeof(rbuf);
  apdu.le = 512;

  apdu.data = (u8 *)crgram;
  apdu.lc = crgram_len;
  apdu.datalen = crgram_len;

  r = sc_transmit_apdu(card, &apdu);

  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");
  if (apdu.sw1 == 0x90 && apdu.sw2 == 0x00) {
    if (priv->algorithm == ALGO_EC_DH) {
      //
      // The SmartCard-HSM returns the point result of the DH operation
      // with a leading '04'
      if (apdu.resplen <= 0)
        return SC_ERROR_INTERNAL;
      len = apdu.resplen - 1 > outlen ? outlen : apdu.resplen - 1;
      memcpy(out, apdu.resp + 1, len);
      LOG_FUNC_RETURN(card->ctx, (int)len);
    } else {
      len = apdu.resplen > outlen ? outlen : apdu.resplen;
      memcpy(out, apdu.resp, len);
      LOG_FUNC_RETURN(card->ctx, (int)len);
    }
  }
  else
    LOG_FUNC_RETURN(card->ctx, sc_check_sw(card, apdu.sw1, apdu.sw2));
}



void sc_hsm_set_serialnr(sc_card_t *card, char *serial)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;

  if (priv->serialno) {
    free(priv->serialno);
  }

  priv->serialno = strdup(serial);
}



static int sc_hsm_get_serialnr(sc_card_t *card, sc_serial_number_t *serial)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;

  LOG_FUNC_CALLED(card->ctx);

  if (!priv->serialno && 0 == strcmp(card->ctx->app_name, "opensc-tool")) {
    /* sc-hsm initializes the serial number via its PKCS#15 layer.
     * Create and destroy a dummy card to get this initialized.  Only do
     * this for `opensc-tool --serial` to avoid unnecessary card commands
     * in all other cases. */
    sc_pkcs15_card_t *p15card = NULL;
    (void)sc_pkcs15_bind(card, NULL, &p15card);
    sc_pkcs15_unbind(p15card);
  }

  if (!priv->serialno) {
    return SC_ERROR_OBJECT_NOT_FOUND;
  }

  serial->len = strlen(priv->serialno);
  if (serial->len > sizeof(serial->value))
    serial->len = sizeof(serial->value);

  memcpy(serial->value, priv->serialno, serial->len);

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_initialize(sc_card_t *card, sc_cardctl_sc_hsm_init_param_t *params)
{
  sc_context_t *ctx = card->ctx;
  sc_pkcs15_tokeninfo_t ti;
  int r;
  size_t tilen;
  sc_apdu_t apdu;
  u8 ibuff[68+0xFF], *p;

  LOG_FUNC_CALLED(card->ctx);

  p = ibuff;
  *p++ = 0x80;  // Options
  *p++ = 0x02;
  memcpy(p, params->options, 2);
  p += 2;

  if (params->user_pin != NULL) {
    if (params->user_pin_len > 16) {
      return SC_ERROR_INVALID_ARGUMENTS;
    }
    *p++ = 0x81; // User PIN
    *p++ = (u8)params->user_pin_len;
    memcpy(p, params->user_pin, params->user_pin_len);
    p += params->user_pin_len;
  }

  *p++ = 0x82;  // Initialization code
  *p++ = 0x08;
  memcpy(p, params->init_code, 8);
  p += 8;

  if (params->user_pin != NULL) {
    *p++ = 0x91; // User PIN retry counter
    *p++ = 0x01;
    *p++ = params->user_pin_retry_counter;
  }

  if (params->dkek_shares >= 0) {
    *p++ = 0x92;  // Number of DKEK shares
    *p++ = 0x01;
    *p++ = (u8)params->dkek_shares;
  }

  if (params->key_domains > 0) {
    *p++ = 0x97; // Number of key domains
    *p++ = 0x01;
    *p++ = params->key_domains;
  }

  if (params->num_of_pub_keys > 0) {
    *p++ = 0x93;  // Use public key authentication
    *p++ = 0x02;
    *p++ = params->num_of_pub_keys; // Total number of public keys used for public authentication
    *p++ = params->required_pub_keys; // Number of public keys required for authentication
  }

  if (params->bio1.len) {
    *p++ = 0x95;
    *p++ = params->bio1.len;
    memcpy(p, params->bio1.value, params->bio1.len);
    p += params->bio1.len;
  }
  if (params->bio2.len) {
    *p++ = 0x96;
    *p++ = params->bio2.len;
    memcpy(p, params->bio2.value, params->bio2.len);
    p += params->bio2.len;
  }

  sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0x50, 0x00, 0x00);
  apdu.cla = 0x80;
  apdu.data = ibuff;
  apdu.datalen = p - ibuff;
  apdu.lc = apdu.datalen;

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);

  if (r == SC_ERROR_NOT_ALLOWED) {
    r = SC_ERROR_PIN_CODE_INCORRECT;
  }

  LOG_TEST_RET(ctx, r, "Check SW error");

  if (params->label) {
    memset(&ti, 0, sizeof(ti));

    ti.label = params->label;
    ti.flags = SC_PKCS15_TOKEN_PRN_GENERATION;

    r = sc_pkcs15_encode_tokeninfo(ctx, &ti, &p, &tilen);
    LOG_TEST_RET(ctx, r, "Error encoding tokeninfo");

    r = sc_hsm_write_ef(card, 0x2F03, 0, p, tilen);
    LOG_TEST_RET(ctx, r, "Could not write EF.TokenInfo");
  }

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}

static int
sc_hsm_manage_key_domain(sc_card_t *card, sc_cardctl_sc_hsm_key_domain_t *params)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 status[SC_MAX_APDU_BUFFER_SIZE];
  int r;

  LOG_FUNC_CALLED(card->ctx);

  switch (params->operation) {
  case SC_HSM_MANAGE_KEY_DOMAIN_GET_STATUS:
    sc_format_apdu(card, &apdu, SC_APDU_CASE_2_SHORT, 0x52, 0x00, params->key_domain_idx);
    break;
  case SC_HSM_MANAGE_KEY_DOMAIN_IMPORT_DKEK_SHARE:
    sc_format_apdu(card, &apdu, SC_APDU_CASE_4_SHORT, 0x52, params->operation - 1, params->key_domain_idx);
    apdu.data = params->dkek_share;
    apdu.datalen = sizeof(params->dkek_share);
    apdu.lc = apdu.datalen;
    break;
  case SC_HSM_MANAGE_KEY_DOMAIN_CREATE_DKEK_KEY_DOMAIN:
    sc_format_apdu(card, &apdu, SC_APDU_CASE_4_SHORT, 0x52, params->operation - 1, params->key_domain_idx);
    apdu.data = &params->dkek_shares;
    apdu.datalen = sizeof(params->dkek_shares);
    apdu.lc = apdu.datalen;
    break;
  case SC_HSM_MANAGE_KEY_DOMAIN_DELETE_KEY_DOMAIN:
  case SC_HSM_MANAGE_KEY_DOMAIN_CLEAR_KEK:
    sc_format_apdu(card, &apdu, SC_APDU_CASE_2_SHORT, 0x52, (params->operation - 1), params->key_domain_idx);
    break;
  default:
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_UNKNOWN);
  }

  apdu.cla = 0x80;
  apdu.le = 0;
  apdu.resp = status;
  apdu.resplen = sizeof(status);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);

  LOG_TEST_RET(ctx, r, "Check SW error");

  if (params->operation == SC_HSM_MANAGE_KEY_DOMAIN_DELETE_KEY_DOMAIN) {
    LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
  }

  if (apdu.resplen < (sizeof(params->key_check_value) + 2))
    return SC_ERROR_INTERNAL;

  params->type = 0;
  params->dkek_shares = status[0];
  params->outstanding_shares = status[1];
  memcpy(params->key_check_value, status + 2, sizeof(params->key_check_value));

  if (apdu.resplen > (sizeof(params->key_check_value) + 2)) {
    if (apdu.resplen < (sizeof(params->key_check_value) + sizeof(params->key_domain_uid) + 2))
      return SC_ERROR_INTERNAL;
    memcpy(params->key_domain_uid, status + 2 + sizeof(params->key_check_value), sizeof(params->key_domain_uid));
    params->type = 1;
  }

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_wrap_key(sc_card_t *card, sc_cardctl_sc_hsm_wrapped_key_t *params)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 data[1500];
  int r;

  LOG_FUNC_CALLED(card->ctx);

  sc_format_apdu(card, &apdu, SC_APDU_CASE_2_EXT, 0x72, params->key_id, 0x92);
  apdu.cla = 0x80;
  apdu.le = 0;
  apdu.resp = data;
  apdu.resplen = sizeof(data);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);

  LOG_TEST_RET(ctx, r, "Check SW error");

  if (params->wrapped_key == NULL) {
    params->wrapped_key_length = apdu.resplen;
    params->wrapped_key = malloc(apdu.resplen);
    if (params->wrapped_key == NULL) {
      LOG_FUNC_RETURN(card->ctx, SC_ERROR_OUT_OF_MEMORY);
    }
  } else {
    if (apdu.resplen > params->wrapped_key_length) {
      LOG_FUNC_RETURN(card->ctx, SC_ERROR_BUFFER_TOO_SMALL);
    }
    params->wrapped_key_length = apdu.resplen;
  }
  memcpy(params->wrapped_key, data, apdu.resplen);
  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_unwrap_key(sc_card_t *card, sc_cardctl_sc_hsm_wrapped_key_t *params)
{
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  int r;

  LOG_FUNC_CALLED(card->ctx);

  r = sc_hsm_write_ef(card, 0x2F10, 0, params->wrapped_key, params->wrapped_key_length);
  LOG_TEST_RET(card->ctx, r, "Create EF failed");

  sc_format_apdu(card, &apdu, SC_APDU_CASE_1, 0x74, params->key_id, 0x93);
  apdu.cla = 0x80;
  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(ctx, r, "Check SW error");

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}

static int verify_certificate(sc_card_t *card, sc_cvc_t *cvc,
    const u8 *cvc_buf, size_t cvc_buf_len)
{
  u8 tag = SC_ASN1_TAG_CONTEXT | SC_ASN1_TAG_BIT_STRING; /* 0x83 */
  size_t pukref_len;
  u8 pukref[BUFSIZ];
  sc_apdu_t apdu;
  u8 *ptr;
  int r;

  LOG_FUNC_CALLED(card->ctx);

  /* check if public key is already known */
  if ((r = sc_asn1_put_tag(tag, (u8 *)cvc->chr, cvc->chrLen,
          pukref, sizeof(pukref), &ptr)) < 0) {
    sc_log(card->ctx, "Error formatting ASN.1 sequence: %s\n", sc_strerror(r));
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_UNKNOWN);
  }
  pukref_len = ptr - pukref;

  /* MANAGE SECURITY ENVIRONMENT to query public key by chr */
  sc_format_apdu_ex(&apdu, 0x00, 0x22, 0x81, 0xB6, pukref, pukref_len, NULL, 0);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  if (!r) {
    /* already known */
    LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
  }
  if (apdu.sw1 != 0x6A && apdu.sw2 != 0x88) {
    LOG_TEST_RET(card->ctx, SC_ERROR_UNKNOWN, "Check SW error");
  }

  if ((r = sc_asn1_put_tag(tag, (u8 *)cvc->car, cvc->carLen,
          pukref, sizeof(pukref), &ptr)) < 0) {
    sc_log(card->ctx, "Error formatting ASN.1 sequence: %s\n", sc_strerror(r));
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_UNKNOWN);
  }
  pukref_len = ptr - pukref;

  /* MANAGE SECURITY ENVIRONMENT to set the CAR public key */
  sc_format_apdu_ex(&apdu, 0x00, 0x22, 0x81, 0xB6, pukref, pukref_len, NULL, 0);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(card->ctx, r, "Check SW error");

  /* PERFORM SECURITY OPERATION -> VERIFY CERTIFICATE */
  sc_format_apdu_ex(&apdu, 0x00, 0x2A, 0x00, 0xBE, cvc_buf, cvc_buf_len, NULL, 0);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(card->ctx, r, "Check SW error");

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_register_public_key(sc_card_t *card,
    sc_cardctl_sc_hsm_pka_register_t *pka_register)
{
  u8 tag = SC_ASN1_TAG_CONTEXT | SC_ASN1_TAG_BIT_STRING; /* 0x83 */
  u8 recvbuf[4];
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  u8 *ptr;
  int r;
  sc_pkcs15_card_t p15card;
  const u8 *pka_buf;
  size_t pka_buf_len;
  sc_cvc_pka_t pka;
  /* outer CAR in ASN.1 needs a byte for tag and a byte for length */
  u8 asn1_outer_car[sizeof(pka.public_key_req.cvc.outer_car) + 2];

  LOG_FUNC_CALLED(ctx);

  memset(&pka, 0, sizeof(pka));
  memset(&p15card, 0, sizeof(p15card));
  p15card.card = card;

  pka_buf = pka_register->buf;
  pka_buf_len = pka_register->buflen;
  r = sc_pkcs15emu_sc_hsm_decode_pka(&p15card, &pka_buf, &pka_buf_len, &pka);
  LOG_TEST_GOTO_ERR(ctx, r, "sc_pkcs15emu_sc_hsm_decode_pka failed");

  /* the DICA CVC must be verified first */
  r = verify_certificate(card, &pka.dica.cvc, pka.dica.ptr, pka.dica.len);
  LOG_TEST_GOTO_ERR(ctx, r, "Verify device issuer CA CVC failed");

  /* the device CVC must be verified before registering the public key */
  r = verify_certificate(card, &pka.device.cvc, pka.device.ptr, pka.device.len);
  LOG_TEST_GOTO_ERR(ctx, r, "Verify device CVC failed");

  r = sc_asn1_put_tag(tag,
      (u8 *)pka.public_key_req.cvc.outer_car,
      pka.public_key_req.cvc.outerCARLen,
      asn1_outer_car, sizeof(asn1_outer_car), &ptr);
  LOG_TEST_GOTO_ERR(ctx, r, "ASN.1 encode outer CAR failed");

  /* MANAGE SECURITY ENVIRONMENT with the outer CAR of the public key */
  sc_format_apdu_ex(&apdu, 0x00, 0x22, 0x81, 0xB6,
      asn1_outer_car, ptr - asn1_outer_car, NULL, 0);

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_GOTO_ERR(ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_GOTO_ERR(ctx, r, "Check SW error");

  sc_format_apdu_ex(&apdu, 0x80, 0x54, 0x00, 0x00,
      pka.public_key_req.ptr, pka.public_key_req.len,
      recvbuf, sizeof(recvbuf));

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_GOTO_ERR(ctx, r, "APDU transmit failed");
  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_GOTO_ERR(ctx, r, "Check SW error");

  pka_register->new_status.num_total = recvbuf[0];
  pka_register->new_status.num_missing = recvbuf[1];
  pka_register->new_status.num_required = recvbuf[2];
  pka_register->new_status.num_authenticated = recvbuf[3];

  r = 0;
  /* fall-through */

err:
  sc_pkcs15emu_sc_hsm_free_cvc_pka(&pka);
  return r;
}



static int sc_hsm_public_key_auth_status(sc_card_t *card,
  sc_cardctl_sc_hsm_pka_status_t *status)
{
  u8 recvbuf[4];
  sc_context_t *ctx = card->ctx;
  sc_apdu_t apdu;
  int r;

  LOG_FUNC_CALLED(card->ctx);

  /* get status */
  sc_format_apdu_ex(&apdu, 0x00, 0x54, 0x00, 0x00, NULL, 0, recvbuf, sizeof recvbuf);
  apdu.cla = 0x80;

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r = sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(ctx, r, "Check SW error");

  status->num_total = recvbuf[0];
  status->num_missing = recvbuf[1];
  status->num_required = recvbuf[2];
  status->num_authenticated = recvbuf[3];

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_init_token(sc_card_t *card, sc_cardctl_pkcs11_init_token_t *params)
{
  sc_context_t *ctx = card->ctx;
  sc_cardctl_sc_hsm_init_param_t ip;
  int r;
  char label[33],*cpo;

  LOG_FUNC_CALLED(ctx);

  if (params->so_pin_len != 16) {
    LOG_TEST_RET(ctx, SC_ERROR_INVALID_DATA, "SO PIN wrong length (!=16)");
  }

  memset(&ip, 0, sizeof(ip));
  ip.dkek_shares = -1;
  ip.options[0] = 0x00;
  ip.options[1] = 0x01;

  r = sc_hsm_encode_sopin(params->so_pin, ip.init_code);
  LOG_TEST_RET(ctx, r, "SO PIN wrong format");

  ip.user_pin = ip.init_code;   // Use the first 6 bytes of the SO-PIN as initial User-PIN value
  ip.user_pin_len = 6;
  ip.user_pin_retry_counter = 3;

  if (params->label) {
    // Strip trailing spaces
    memcpy(label, params->label, 32);
    label[32] = 0;
    cpo = label + 31;
    while ((cpo >= label) && (*cpo == ' ')) {
      *cpo = 0;
      cpo--;
    }
    ip.label = label;
  }

  r = sc_hsm_initialize(card, &ip);
  LOG_TEST_RET(ctx, r, "Check SW error");

  LOG_FUNC_RETURN(ctx, SC_SUCCESS);
}



static int sc_hsm_init_pin(sc_card_t *card, sc_cardctl_pkcs11_init_pin_t *params)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
  sc_context_t *ctx = card->ctx;
  int r;
  sc_apdu_t apdu;
  u8 ibuff[50], *p;

  LOG_FUNC_CALLED(card->ctx);

  if (params->pin_len > 16) {
    LOG_TEST_RET(card->ctx, SC_ERROR_INVALID_DATA, "User PIN too long");
  }

  p = ibuff;

  memcpy(p, priv->sopin, sizeof(priv->sopin));
  p += sizeof(priv->sopin);

  memcpy(p, params->pin, params->pin_len);
  p += params->pin_len;

  sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0x2C, 0x00, 0x81);
  apdu.data = ibuff;
  apdu.datalen = p - ibuff;
  apdu.lc = apdu.datalen;

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);

  // Cards before version 1.0 do not implement RESET_RETRY_COUNTER
  // For those cards the CHANGE REFERENCE DATA command is used instead
  if (r == SC_ERROR_INS_NOT_SUPPORTED) {
    p = ibuff;
    memcpy(p, priv->sopin, 6);
    p += 6;

    memcpy(p, params->pin, params->pin_len);
    p += params->pin_len;

    sc_format_apdu(card, &apdu, SC_APDU_CASE_3_SHORT, 0x24, 0x00, 0x81);
    apdu.data = ibuff;
    apdu.datalen = p - ibuff;
    apdu.lc = apdu.datalen;

    r = sc_transmit_apdu(card, &apdu);
    LOG_TEST_RET(ctx, r, "APDU transmit failed");

    r =  sc_check_sw(card, apdu.sw1, apdu.sw2);
  }

  LOG_TEST_RET(ctx, r, "Check SW error");

  memset(priv->sopin, 0, sizeof(priv->sopin));

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_generate_keypair(sc_card_t *card, sc_cardctl_sc_hsm_keygen_info_t *keyinfo)
{
  u8 rbuf[1200];
  int r;
  sc_apdu_t apdu;

  LOG_FUNC_CALLED(card->ctx);

  sc_format_apdu(card, &apdu, SC_APDU_CASE_4_EXT, 0x46, keyinfo->key_id, keyinfo->auth_key_id);
  apdu.cla = 0x00;
  apdu.resp = rbuf;
  apdu.resplen = sizeof(rbuf);
  apdu.le = 0;

  apdu.data = keyinfo->gakprequest;
  apdu.lc = keyinfo->gakprequest_len;
  apdu.datalen = keyinfo->gakprequest_len;

  r = sc_transmit_apdu(card, &apdu);
  LOG_TEST_RET(card->ctx, r, "APDU transmit failed");

  r =  sc_check_sw(card, apdu.sw1, apdu.sw2);
  LOG_TEST_RET(card->ctx, r, "Check SW error");

  keyinfo->gakpresponse_len = apdu.resplen;
  keyinfo->gakpresponse = malloc(apdu.resplen);

  if (keyinfo->gakpresponse == NULL) {
    LOG_FUNC_RETURN(card->ctx, SC_ERROR_OUT_OF_MEMORY);
  }

  memcpy(keyinfo->gakpresponse, apdu.resp, apdu.resplen);

  LOG_FUNC_RETURN(card->ctx, SC_SUCCESS);
}



static int sc_hsm_card_ctl(sc_card_t *card, unsigned long cmd, void *ptr)
{
  switch (cmd) {
  case SC_CARDCTL_GET_SERIALNR:
    return sc_hsm_get_serialnr(card, (sc_serial_number_t *)ptr);
  case SC_CARDCTL_PKCS11_INIT_TOKEN:
    return sc_hsm_init_token(card, (sc_cardctl_pkcs11_init_token_t *)ptr);
  case SC_CARDCTL_PKCS11_INIT_PIN:
    return sc_hsm_init_pin(card, (sc_cardctl_pkcs11_init_pin_t *)ptr);
  case SC_CARDCTL_SC_HSM_GENERATE_KEY:
    return sc_hsm_generate_keypair(card, (sc_cardctl_sc_hsm_keygen_info_t *)ptr);
  case SC_CARDCTL_SC_HSM_INITIALIZE:
    return sc_hsm_initialize(card, (sc_cardctl_sc_hsm_init_param_t *)ptr);
  case SC_CARDCTL_SC_HSM_MANAGE_KEY_DOMAIN:
    return sc_hsm_manage_key_domain(card, (sc_cardctl_sc_hsm_key_domain_t *)ptr);
  case SC_CARDCTL_SC_HSM_WRAP_KEY:
    return sc_hsm_wrap_key(card, (sc_cardctl_sc_hsm_wrapped_key_t *)ptr);
  case SC_CARDCTL_SC_HSM_UNWRAP_KEY:
    return sc_hsm_unwrap_key(card, (sc_cardctl_sc_hsm_wrapped_key_t *)ptr);
  case SC_CARDCTL_SC_HSM_REGISTER_PUBLIC_KEY:
    return sc_hsm_register_public_key(card, ptr);
  case SC_CARDCTL_SC_HSM_PUBLIC_KEY_AUTH_STATUS:
    return sc_hsm_public_key_auth_status(card, ptr);
  }
  return SC_ERROR_NOT_SUPPORTED;
}



static int sc_hsm_init(struct sc_card *card)
{
#if defined(ENABLE_SM) && defined(ENABLE_OPENPACE) && defined(_WIN32)
  char expanded_val[PATH_MAX];
  size_t expanded_len = PATH_MAX;
#endif
  int flags,ext_flags;
  sc_file_t *file = NULL;
  sc_path_t path;
  sc_hsm_private_data_t *priv = NULL;

  LOG_FUNC_CALLED(card->ctx);

  flags = SC_ALGORITHM_RSA_RAW|SC_ALGORITHM_RSA_PAD_PSS|SC_ALGORITHM_ONBOARD_KEY_GEN
      |SC_ALGORITHM_RSA_HASH_SHA1|SC_ALGORITHM_RSA_HASH_SHA256|SC_ALGORITHM_RSA_HASH_SHA384|SC_ALGORITHM_RSA_HASH_SHA512
      |SC_ALGORITHM_MGF1_SHA256|SC_ALGORITHM_MGF1_SHA384|SC_ALGORITHM_MGF1_SHA512;

  _sc_card_add_rsa_alg(card, 1024, flags, 0);
  _sc_card_add_rsa_alg(card, 1536, flags, 0);
  _sc_card_add_rsa_alg(card, 2048, flags, 0);
  _sc_card_add_rsa_alg(card, 3072, flags, 0);
  _sc_card_add_rsa_alg(card, 4096, flags, 0);

  flags = SC_ALGORITHM_ECDSA_RAW|
    SC_ALGORITHM_ECDH_CDH_RAW|
    SC_ALGORITHM_ECDSA_HASH_NONE|
    SC_ALGORITHM_ECDSA_HASH_SHA1|
    SC_ALGORITHM_ECDSA_HASH_SHA224|
    SC_ALGORITHM_ECDSA_HASH_SHA256|
    SC_ALGORITHM_ECDSA_HASH_SHA384|
    SC_ALGORITHM_ECDSA_HASH_SHA512|
    SC_ALGORITHM_ONBOARD_KEY_GEN;

  ext_flags = SC_ALGORITHM_EXT_EC_F_P|
      SC_ALGORITHM_EXT_EC_ECPARAMETERS|
      SC_ALGORITHM_EXT_EC_NAMEDCURVE|
      SC_ALGORITHM_EXT_EC_UNCOMPRESES|
      SC_ALGORITHM_ONBOARD_KEY_GEN;
  _sc_card_add_ec_alg(card, 192, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 224, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 256, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 320, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 384, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 512, flags, ext_flags, NULL);
  _sc_card_add_ec_alg(card, 521, flags, ext_flags, NULL);

  card->caps |= SC_CARD_CAP_RNG|SC_CARD_CAP_APDU_EXT|SC_CARD_CAP_ISO7816_PIN_INFO;

  // APDU Size limits
  //   JCOP 2.4.1r3           1462
  //   JCOP 2.4.2r3           1454
  //   JCOP 3                 1232
  //   JCOP 4                 1454
  //   MicroSD with JCOP 3    478 / 506 - handled in reader-pcsc.c
  //   Reiner SCT             1014 - handled in reader-pcsc.c
  //
  // Note, that these are limits for the whole APDU, but the semantics of max_send_size
  // is the size of the APDU send buffer so to get the right value from them, we need
  // to subtract APDU headers (CLA, INS, P1, P2, Lc (3B)), 7 bytes altogether for
  // class 3 APDU
  // (or 9 bytes for case 4 when we pass in >255 B data and expect return of more than 255 B)

  // Use JCOP 3 (smallest unhandled by reader limitation) card limits for sending
  // And make it 9 smaller to make sure we fit the rest of the APDU.
  card->max_send_size = 1232 - 9;
  // Assume that card supports sending with extended length APDU and without limit
  card->max_recv_size = 0;

  if (card->type == SC_CARD_TYPE_SC_HSM_SOC
      || card->type == SC_CARD_TYPE_SC_HSM_GOID) {
    card->max_recv_size = 0x0630; // SoC Proxy forces this limit
  } else {
    // Adjust to the limits set by the reader
    if (card->reader->max_send_size < card->max_send_size) {
      if (18 >= card->reader->max_send_size)
        LOG_FUNC_RETURN(card->ctx, SC_ERROR_INCONSISTENT_CONFIGURATION);

      // 17 byte header and TLV because of odd ins in UPDATE BINARY
      card->max_send_size = card->reader->max_send_size - 17;
    }

    if (0 < card->reader->max_recv_size) {
      if (3 >= card->reader->max_recv_size)
        LOG_FUNC_RETURN(card->ctx, SC_ERROR_INCONSISTENT_CONFIGURATION);
      card->max_recv_size = card->reader->max_recv_size - 2;
    }
  }

  priv = card->drv_data;
  if (!priv) {
    priv = calloc(1, sizeof(sc_hsm_private_data_t));
    if (!priv)
      LOG_FUNC_RETURN(card->ctx, SC_ERROR_OUT_OF_MEMORY);
    card->drv_data = priv;
  }

  sc_path_set(&path, SC_PATH_TYPE_DF_NAME, sc_hsm_aid.value, sc_hsm_aid.len, 0, 0);
  if (sc_hsm_select_file_ex(card, &path, 0, &file) == SC_SUCCESS
      && file && file->prop_attr && file->prop_attr_len >= 2) {
    static char card_name[SC_MAX_APDU_BUFFER_SIZE];
    u8 type = 0xFF;
    u8 major = file->prop_attr[file->prop_attr_len - 2];
    u8 minor = file->prop_attr[file->prop_attr_len - 1];
    char p00[] = "SmartCard-HSM Applet for JCOP";
    char p01[] = "SmartCard-HSM Demo Applet for JCOP";
    char *p = "SmartCard-HSM";
    if (file->prop_attr_len >= 3) {
      type = file->prop_attr[file->prop_attr_len - 3];
    }
    switch (type) {
      case 0x00:
        p = p00;
        break;
      case 0x01:
        p = p01;
        break;
      default:
        break;
    }
    snprintf(card_name, sizeof card_name, "%s version %u.%u", p, major, minor);
    card->name = card_name;

    if (file->prop_attr[1] & 0x04) {
      card->caps |= SC_CARD_CAP_SESSION_PIN;
    }
  }
  sc_file_free(file);

  priv->EF_C_DevAut = NULL;
  priv->EF_C_DevAut_len = 0;

#if defined(ENABLE_SM) && defined(ENABLE_OPENPACE)
  EAC_init();
#ifdef _WIN32
  expanded_len = ExpandEnvironmentStringsA(CVCDIR, expanded_val, sizeof expanded_val);
  if (0 < expanded_len && expanded_len < sizeof expanded_val)
    EAC_set_cvc_default_dir(expanded_val);
#else
  EAC_set_cvc_default_dir(CVCDIR);
#endif
#endif

  return 0;
}



static int sc_hsm_finish(sc_card_t * card)
{
  sc_hsm_private_data_t *priv = (sc_hsm_private_data_t *) card->drv_data;
#ifdef ENABLE_SM
  sc_sm_stop(card);
#endif
  if (priv) {
    free(priv->serialno);
    sc_file_free(priv->dffcp);
    free(priv->EF_C_DevAut);
  }
  free(priv);

  return SC_SUCCESS;
}



static struct sc_card_driver * sc_get_driver(void)
{
  struct sc_card_driver *iso_drv = sc_get_iso7816_driver();

  if (iso_ops == NULL)
    iso_ops = iso_drv->ops;

  sc_hsm_ops                   = *iso_drv->ops;
  sc_hsm_ops.match_card        = sc_hsm_match_card;
  sc_hsm_ops.select_file       = sc_hsm_select_file;
  sc_hsm_ops.get_challenge     = sc_hsm_get_challenge;
  sc_hsm_ops.read_binary       = sc_hsm_read_binary;
  sc_hsm_ops.update_binary     = sc_hsm_update_binary;
  sc_hsm_ops.list_files        = sc_hsm_list_files;
  sc_hsm_ops.create_file       = sc_hsm_create_file;
  sc_hsm_ops.delete_file       = sc_hsm_delete_file;
  sc_hsm_ops.set_security_env  = sc_hsm_set_security_env;
  sc_hsm_ops.compute_signature = sc_hsm_compute_signature;
  sc_hsm_ops.decipher          = sc_hsm_decipher;
  sc_hsm_ops.init              = sc_hsm_init;
  sc_hsm_ops.finish            = sc_hsm_finish;
  sc_hsm_ops.card_ctl          = sc_hsm_card_ctl;
  sc_hsm_ops.pin_cmd           = sc_hsm_pin_cmd;
  sc_hsm_ops.logout            = sc_hsm_logout;

  /* no record oriented file services */
  sc_hsm_ops.read_record       = NULL;
  sc_hsm_ops.write_record      = NULL;
  sc_hsm_ops.append_record     = NULL;
  sc_hsm_ops.update_record     = NULL;

  return &sc_hsm_drv;
}



struct sc_card_driver * sc_get_sc_hsm_driver(void)
{
  return sc_get_driver();
}


Coverage Report

Created: 2026-10-17 06:29