/*

 * partial PKCS15 emulation for PIV-II cards

 * only minimal use of the authentication cert and key

 *

 * Copyright (C) 2005,2006,2007,2008,2009,2010

 *               Douglas E. Engert <deengert@anl.gov>

 * Copyright (C) 2020 Douglas E. Engert <deengert@gmail.com>

 *               2004, Nils Larsch <larsch@trustcenter.de>

 * Copyright (C) 2006, Identity Alliance,

 *               Thomas Harning <thomas.harning@identityalliance.com>

 * Copyright (C) 2007, EMC, Russell Larner <rlarner@rsa.com>

 *

 * 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 <stdlib.h>

#include <string.h>

#include <stdio.h>

#include <ctype.h>

#include "internal.h"

#include "cardctl.h"

#include "asn1.h"

#include "pkcs15.h"

#define MANU_ID   "piv_II "

typedef struct objdata_st {

  const char *id;

  const char *label;

  const char *aoid;

  const char *auth_id;

  const char *path;

  int         obj_flags;

} objdata;

typedef struct cdata_st {

  const char *id;

  const char *label;

  const char *path;

  int     authority;

  int         obj_flags;

} cdata;

typedef struct pdata_st {

  const char *id;

  const char *label;

  const char *path;

  int         ref;

  int         type;

  unsigned int maxlen;

  unsigned int minlen;

  unsigned int storedlen;

  int         flags;

  int         tries_left;

  const unsigned char  pad_char;

  int         obj_flags;

  int         cardmod; /* only use with cardmod minidriver */

} pindata;

typedef struct pubdata_st {

  const char *id;

  const char *label;

  int         usage_rsa;

  int         usage_ec;

  const char *path;

  int         ref;

  const char *auth_id;

  int         obj_flags;

  const char *getenvname;

} pubdata;

typedef struct prdata_st {

  const char *id;

  const char *label;

  int         usage_rsa;

  int     usage_ec;

  const char *path;

  int         ref;

  const char *auth_id;

  int         obj_flags;

  int     user_consent;

} prdata;

typedef struct common_key_info_st {

  int cert_found;

  int pubkey_found;

  int pubkey_from_file;

  unsigned long key_alg;

  size_t pubkey_len;

  unsigned int cert_keyUsage; /* x509 key usage as defined in certificate */

  int cert_keyUsage_present; /* 1 if keyUsage found in certificate */

  int pub_usage;

  int priv_usage;

  struct sc_pkcs15_pubkey *pubkey_from_cert;

  int not_present;

} common_key_info;

/*

 * The PIV applet has no serial number, and so the either the FASC-N

 * is used, or the GUID is used as a serial number.

 * We need to return a GUID like value for each object

 * But this needs to be some what unique.

 * So we will use two different methods, depending

 * on the size of the serial number.

 * If it is 25 bytes, then it was from a FASCN. If 16 bytes

 * its from a GUID.

 * If neither, we will uase the default method.

 */

static int piv_get_guid(struct sc_pkcs15_card *p15card, const struct sc_pkcs15_object *obj,

    unsigned char *out, size_t *out_size)

{

  struct sc_serial_number serialnr;

  struct sc_pkcs15_id  id;

  unsigned char guid_bin[SC_PKCS15_MAX_ID_SIZE + SC_MAX_SERIALNR];

  size_t bin_size, offs, tlen, i;

  int r;

  unsigned char fbit, fbits, fbyte, fbyte2, fnibble;

  unsigned char *f5p, *f8p;

  if (!p15card || !obj || !out || *out_size < 3)

    return SC_ERROR_INCORRECT_PARAMETERS;

  r = sc_pkcs15_get_object_id(obj, &id);

  if (r)

    return r;

  r = sc_card_ctl(p15card->card, SC_CARDCTL_GET_SERIALNR, &serialnr);

  if (r)

    return r;

  if (serialnr.len > SC_MAX_SERIALNR)

    return SC_ERROR_INTERNAL;

  memset(guid_bin, 0, sizeof(guid_bin));

  memset(out, 0, *out_size);

  if (id.len == 1 && serialnr.len == 25) {

    /* It is from a FASCN, and we need to shorten it but keep

     * as much uniqueness as possible.

     * FASC-N is stored like a ISO 7811 Magnetic Strip Card

     * Using the ANSI/ISO BCD Data Format

     * 4 data bit + 1 parity bit (odd) least significant bit first.

     * It starts with the Start Sentinel 0x0b ";"

     * Fields are separated by 0x0d "="

     * Ends with End Sentinel 0x0f "?"

     * Its 39 characters + the LRC

     * http://www.dataip.co.uk/Reference/MagneticCardBCD.php

     * 0x0a, 0x0c, 0x0e are some type of control

     * the FASCN has a lot of extra bits, with only 32 digits.

     */

    f5p = serialnr.value;

    f8p = guid_bin;

    fbyte = 0;

    fbyte2 = 0;

    fnibble = 0;

    fbits = 0;

    for (i = 0; i < 25*8; i++) {

      if (i%8 == 0) {

        fbyte=*f5p++;

      }

      fbit = (fbyte & 0x80) ? 1:0;

      fbyte <<= 1;

      fbits = (fbits >> 1) + (fbit << 4);

      /* reversed with parity */

      if ((i - 4)%5 == 0) {

        fbits = fbits & 0x0f; /* drop parity */

        if (fbits <= 9) {  /* only save digits, drop control codes */

          fbyte2 = (fbyte2 << 4) | fbits;

          if (fnibble) {

            *f8p = fbyte2;

            f8p++;

            fbyte2 = 0;

            fnibble = 0;

          } else

          fnibble = 1;

        }

        fbits = 0;

      }

    }

    /* overwrite two insignificant digits in middle with id */

    memcpy(guid_bin + 7, id.value, id.len);

    tlen = 16;

  }

  else if (id.len == 1 && serialnr.len == 16) {

    /* its from a GUID, we will overwrite the

     * first byte with id.value, as this preserves most

       * of the uniqueness.

     */

    memcpy(guid_bin, id.value, id.len);

    memcpy(guid_bin + id.len, serialnr.value + 1, serialnr.len - 1);

    tlen = id.len + serialnr.len - 1; /* i.e. 16 */

  } else {

    /* not what was expected...  use default */

    memcpy(guid_bin, serialnr.value, serialnr.len);

    memcpy(guid_bin + serialnr.len, id.value, id.len);

    tlen = id.len + serialnr.len;

  }

  /* reserve one byte for the 'C' line ending */

  bin_size = (*out_size - 1)/2;

  if (bin_size > tlen)

    bin_size = tlen;

  offs = tlen - bin_size;

  for (i=0; i<bin_size; i++)

    sprintf((char *) out + i*2, "%02x", guid_bin[offs + i]);

  return SC_SUCCESS;

}

static int piv_detect_card(sc_pkcs15_card_t *p15card)

{

  sc_card_t *card = p15card->card;

  SC_FUNC_CALLED(card->ctx, SC_LOG_DEBUG_VERBOSE);

  if (card->type < SC_CARD_TYPE_PIV_II_BASE

    || card->type >= SC_CARD_TYPE_PIV_II_BASE + 1000)

    return SC_ERROR_INVALID_CARD;

  return SC_SUCCESS;

}

static int sc_pkcs15emu_piv_init(sc_pkcs15_card_t *p15card)

{

  /* The cert objects will return all the data */

  /* Note: pkcs11 objects do not have CK_ID values */

  // clang-format off

  static const objdata objects[] = {

  {"01", "Card Capability Container",

      "2.16.840.1.101.3.7.1.219.0", NULL, "DB00", 0},

  {"02", "Card Holder Unique Identifier",

      "2.16.840.1.101.3.7.2.48.0", NULL, "3000", 0},

  {"03", "Unsigned Card Holder Unique Identifier",

      "2.16.840.1.101.3.7.2.48.2", NULL, "3010", 0},

  {"04", "X.509 Certificate for PIV Authentication",

      "2.16.840.1.101.3.7.2.1.1", NULL, "0101", 0},

  {"05", "Cardholder Fingerprints",

      "2.16.840.1.101.3.7.2.96.16", "01", "6010", SC_PKCS15_CO_FLAG_PRIVATE},

  {"06", "Printed Information",

      "2.16.840.1.101.3.7.2.48.1", "01", "3001", SC_PKCS15_CO_FLAG_PRIVATE},

  {"07", "Cardholder Facial Image",

      "2.16.840.1.101.3.7.2.96.48", "01", "6030", SC_PKCS15_CO_FLAG_PRIVATE},

  {"08", "X.509 Certificate for Digital Signature",

      "2.16.840.1.101.3.7.2.1.0",  NULL, "0100", 0},

  {"09", "X.509 Certificate for Key Management",

      "2.16.840.1.101.3.7.2.1.2", NULL, "0102", 0},

  {"10","X.509 Certificate for Card Authentication",

      "2.16.840.1.101.3.7.2.5.0", NULL, "0500", 0},

  {"11", "Security Object",

      "2.16.840.1.101.3.7.2.144.0", NULL, "9000", 0},

  {"12", "Discovery Object",

      "2.16.840.1.101.3.7.2.96.80", NULL, "6050", 0},

  {"13", "Key History Object",

      "2.16.840.1.101.3.7.2.96.96", NULL, "6060", 0},

  {"14", "Cardholder Iris Image",

      "2.16.840.1.101.3.7.2.16.21", NULL, "1015", SC_PKCS15_CO_FLAG_PRIVATE},

  {"15", "Retired X.509 Certificate for Key Management 1",

      "2.16.840.1.101.3.7.2.16.1", NULL, "1001", 0},

  {"16", "Retired X.509 Certificate for Key Management 2",

      "2.16.840.1.101.3.7.2.16.2", NULL, "1002", 0},

  {"17", "Retired X.509 Certificate for Key Management 3",

      "2.16.840.1.101.3.7.2.16.3", NULL, "1003", 0},

  {"18", "Retired X.509 Certificate for Key Management 4",

      "2.16.840.1.101.3.7.2.16.4", NULL, "1004", 0},

  {"19", "Retired X.509 Certificate for Key Management 5",

      "2.16.840.1.101.3.7.2.16.5", NULL, "1005", 0},

  {"20", "Retired X.509 Certificate for Key Management 6",

      "2.16.840.1.101.3.7.2.16.6", NULL, "1006", 0},

  {"21", "Retired X.509 Certificate for Key Management 7",

      "2.16.840.1.101.3.7.2.16.7", NULL, "1007", 0},

  {"22", "Retired X.509 Certificate for Key Management 8",

      "2.16.840.1.101.3.7.2.16.8", NULL, "1008", 0},

  {"23", "Retired X.509 Certificate for Key Management 9",

      "2.16.840.1.101.3.7.2.16.9", NULL, "1009", 0},

  {"24", "Retired X.509 Certificate for Key Management 10",

      "2.16.840.1.101.3.7.2.16.10", NULL, "100A", 0},

  {"25", "Retired X.509 Certificate for Key Management 11",

      "2.16.840.1.101.3.7.2.16.11", NULL, "100B", 0},

  {"26", "Retired X.509 Certificate for Key Management 12",

      "2.16.840.1.101.3.7.2.16.12", NULL, "100C", 0},

  {"27", "Retired X.509 Certificate for Key Management 13",

      "2.16.840.1.101.3.7.2.16.13", NULL, "100D", 0},

  {"28", "Retired X.509 Certificate for Key Management 14",

      "2.16.840.1.101.3.7.2.16.14", NULL, "100E", 0},

  {"29", "Retired X.509 Certificate for Key Management 15",

      "2.16.840.1.101.3.7.2.16.15", NULL, "100F", 0},

  {"30", "Retired X.509 Certificate for Key Management 16",

      "2.16.840.1.101.3.7.2.16.16", NULL, "1010", 0},

  {"31", "Retired X.509 Certificate for Key Management 17",

      "2.16.840.1.101.3.7.2.16.17", NULL, "1011", 0},

  {"32", "Retired X.509 Certificate for Key Management 18",

      "2.16.840.1.101.3.7.2.16.18", NULL, "1012", 0},

  {"33", "Retired X.509 Certificate for Key Management 19",

      "2.16.840.1.101.3.7.2.16.19", NULL, "1013", 0},

  {"34", "Retired X.509 Certificate for Key Management 20",

      "2.16.840.1.101.3.7.2.16.20", NULL, "1014", 0},

  /* new in 800-73-4 */

  {"35", "Biometric Information Templates Group Template",

      "2.16.840.1.101.3.7.2.16.22", NULL, "1016", 0},

  {"36", "Secure Messaging Certificate Signer",

      "2.16.840.1.101.3.7.2.16.23", NULL, "1017", 0},

  {"37", "Pairing Code Reference Data Container",

      "2.16.840.1.101.3.7.2.16.24", NULL, "1018", SC_PKCS15_CO_FLAG_PRIVATE},

  {NULL, NULL, NULL, NULL, NULL, 0}

  };

  // clang-format on

  /* NIST 800-73-1 lifted the restriction on

   * requiring pin protected certs. Thus the default is to

   * not require this.

   *

   * Certs will be pulled out from the cert objects

   * But there may be extra certs (SM Signer cert) that do

   * not have a private keys on the card. These certs must be last

   */

  /* Any certs on card without private key must be last */

#define PIV_NUM_CERTS 25

#define PIV_NUM_KEYS  24

  // clang-format off

  static const cdata certs[PIV_NUM_CERTS] = {

    {"01", "Certificate for PIV Authentication", "0101cece", 0, 0},

    {"02", "Certificate for Digital Signature", "0100cece", 0, 0},

    {"03", "Certificate for Key Management", "0102cece", 0, 0},

    {"04", "Certificate for Card Authentication", "0500cece", 0, 0},

    {"05", "Retired Certificate for Key Management 1", "1001cece", 0, 0},

    {"06", "Retired Certificate for Key Management 2", "1002cece", 0, 0},

    {"07", "Retired Certificate for Key Management 3", "1003cece", 0, 0},

    {"08", "Retired Certificate for Key Management 4", "1004cece", 0, 0},

    {"09", "Retired Certificate for Key Management 5", "1005cece", 0, 0},

    {"10", "Retired Certificate for Key Management 6", "1006cece", 0, 0},

    {"11", "Retired Certificate for Key Management 7", "1007cece", 0, 0},

    {"12", "Retired Certificate for Key Management 8", "1008cece", 0, 0},

    {"13", "Retired Certificate for Key Management 9", "1009cece", 0, 0},

    {"14", "Retired Certificate for Key Management 10", "100Acece", 0, 0},

    {"15", "Retired Certificate for Key Management 11", "100Bcece", 0, 0},

    {"16", "Retired Certificate for Key Management 12", "100Ccece", 0, 0},

    {"17", "Retired Certificate for Key Management 13", "100Dcece", 0, 0},

    {"18", "Retired Certificate for Key Management 14", "100Ecece", 0, 0},

    {"19", "Retired Certificate for Key Management 15", "100Fcece", 0, 0},

    {"20", "Retired Certificate for Key Management 16", "1010cece", 0, 0},

    {"21", "Retired Certificate for Key Management 17", "1011cece", 0, 0},

    {"22", "Retired Certificate for Key Management 18", "1012cece", 0, 0},

    {"23", "Retired Certificate for Key Management 19", "1013cece", 0, 0},

    {"24", "Retired Certificate for Key Management 20", "1014cece", 0, 0},

    /* Yubikey Attestation uses "25" but not read via GET_DATA */

    {"81", "Secure Messaging Certificate Signer",   "1017cece", 0, 0} /* no keys on card */

  };

  // clang-format on

  // clang-format off

  static const pindata pins[] = {

    { "01", "PIN", "", 0x80,

      /* label, flag  and ref will change if using global pin */

      SC_PKCS15_PIN_TYPE_ASCII_NUMERIC,

      8, 4, 8,

      SC_PKCS15_PIN_FLAG_NEEDS_PADDING |

      SC_PKCS15_PIN_FLAG_INITIALIZED |

      SC_PKCS15_PIN_FLAG_LOCAL,

      -1, 0xFF,

      SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "02", "PIV PUK", "", 0x81,

      SC_PKCS15_PIN_TYPE_ASCII_NUMERIC,

      8, 4, 8,

      SC_PKCS15_PIN_FLAG_NEEDS_PADDING |

      SC_PKCS15_PIN_FLAG_INITIALIZED |

      SC_PKCS15_PIN_FLAG_SO_PIN |

      SC_PKCS15_PIN_FLAG_UNBLOCKING_PIN,

      -1, 0xFF,

      SC_PKCS15_CO_FLAG_PRIVATE, 0},

    /* only used with minidriver */

    { "03", "PIN", "", 0x80,

      /* used in minidriver as the sign key and for 9C key */

      /* label, flag  and ref will change if using global pin */

      SC_PKCS15_PIN_TYPE_ASCII_NUMERIC,

      8, 4, 8,

      SC_PKCS15_PIN_FLAG_NEEDS_PADDING |

      SC_PKCS15_PIN_FLAG_INITIALIZED |

      SC_PKCS15_PIN_FLAG_LOCAL,

      -1, 0xFF,

      SC_PKCS15_CO_FLAG_PRIVATE, 1}, /* only use if cardmod */

    { NULL, NULL, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

  };

  // clang-format on

  /*

   * The size of the key or the algid is not really known

   * but can be derived from the certificates.

   * the cert, pubkey and privkey are a set.

   * Key usages bits taken from pkcs15v1_1 Table 2

   * RSA and EC have different sets of usage

   */

  // clang-format off

  static const pubdata pubkeys[PIV_NUM_KEYS] = {

    { "01", "PIV AUTH pubkey",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT |

          SC_PKCS15_PRKEY_USAGE_WRAP |

          SC_PKCS15_PRKEY_USAGE_VERIFY |

          SC_PKCS15_PRKEY_USAGE_VERIFYRECOVER,

        /*EC*/SC_PKCS15_PRKEY_USAGE_VERIFY,

      "9A06", 0x9A, NULL, 0, "PIV_9A_KEY"},

    { "02", "SIGN pubkey",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT |

          SC_PKCS15_PRKEY_USAGE_VERIFY |

          SC_PKCS15_PRKEY_USAGE_VERIFYRECOVER |

          SC_PKCS15_PRKEY_USAGE_NONREPUDIATION,

        /*EC*/SC_PKCS15_PRKEY_USAGE_VERIFY |

          SC_PKCS15_PRKEY_USAGE_NONREPUDIATION,

      "9C06", 0x9C, NULL, 0, "PIV_9C_KEY"},

    { "03", "KEY MAN pubkey",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT| SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "9D06", 0x9D, NULL, 0, "PIV_9D_KEY"},

    { "04", "CARD AUTH pubkey",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_VERIFY |

          SC_PKCS15_PRKEY_USAGE_VERIFYRECOVER,

        /*EC*/SC_PKCS15_PRKEY_USAGE_VERIFY,

      "9E06", 0x9E, NULL, 0, "PIV_9E_KEY"},  /* no pin, and avail in contactless */

    { "05", "Retired KEY MAN 1",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8206", 0x82, NULL, 0, NULL},

    { "06", "Retired KEY MAN 2",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8306", 0x83, NULL, 0, NULL},

    { "07", "Retired KEY MAN 3",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8406", 0x84, NULL, 0, NULL},

    { "08", "Retired KEY MAN 4",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8506", 0x85, NULL, 0, NULL},

    { "09", "Retired KEY MAN 5",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8606", 0x86, NULL, 0, NULL},

    { "10", "Retired KEY MAN 6",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8706", 0x87, NULL, 0, NULL},

    { "11", "Retired KEY MAN 7",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8806", 0x88, NULL, 0, NULL},

    { "12", "Retired KEY MAN 8",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8906", 0x89, NULL, 0, NULL},

    { "13", "Retired KEY MAN 9",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8A06", 0x8A, NULL, 0, NULL},

    { "14", "Retired KEY MAN 10",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8B06", 0x8B, NULL, 0, NULL},

    { "15", "Retired KEY MAN 11",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8C06", 0x8C, NULL, 0, NULL},

    { "16", "Retired KEY MAN 12",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8D06", 0x8D, NULL, 0, NULL},

    { "17", "Retired KEY MAN 13",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8E06", 0x8E, NULL, 0, NULL},

    { "18", "Retired KEY MAN 14",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "8F06", 0x8F, NULL, 0, NULL},

    { "19", "Retired KEY MAN 15",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9006", 0x90, NULL, 0, NULL},

    { "20", "Retired KEY MAN 16",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9106", 0x91, NULL, 0, NULL},

    { "21", "Retired KEY MAN 17",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9206", 0x92, NULL, 0, NULL},

    { "22", "Retired KEY MAN 18",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9306", 0x93, NULL, 0, NULL},

    { "23", "Retired KEY MAN 19",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9406", 0x94, NULL, 0, NULL},

    { "24", "Retired KEY MAN 20",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_ENCRYPT | SC_PKCS15_PRKEY_USAGE_WRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

       "9506", 0x95, NULL, 0, NULL}

  };

  // clang-format on

/*

 * Note some of the SC_PKCS15_PRKEY values are dependent

 * on the key algorithm, and will be reset.

 * No SM Signer private Key on card

 * The 04 SM ECC CVC pubkey is in response to SELECT AID

 */

  // clang-format off

  static const prdata prkeys[PIV_NUM_KEYS] = {

    { "01", "PIV AUTH key",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT |

          SC_PKCS15_PRKEY_USAGE_UNWRAP |

          SC_PKCS15_PRKEY_USAGE_SIGN |

          SC_PKCS15_PRKEY_USAGE_SIGNRECOVER,

        /*EC*/SC_PKCS15_PRKEY_USAGE_SIGN,

      "", 0x9A, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "02", "SIGN key",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT |

          SC_PKCS15_PRKEY_USAGE_SIGN |

          SC_PKCS15_PRKEY_USAGE_SIGNRECOVER |

          SC_PKCS15_PRKEY_USAGE_NONREPUDIATION,

        /*EC*/SC_PKCS15_PRKEY_USAGE_SIGN |

          SC_PKCS15_PRKEY_USAGE_NONREPUDIATION,

      "", 0x9C, "01", SC_PKCS15_CO_FLAG_PRIVATE, 1}, /* use sign pin and user_consent */

    { "03", "KEY MAN key",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x9D, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "04", "CARD AUTH key",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_SIGN |

        SC_PKCS15_PRKEY_USAGE_SIGNRECOVER,

        /*EC*/SC_PKCS15_PRKEY_USAGE_SIGN,

      "", 0x9E, NULL, 0, 0}, /* no PIN needed, works with wireless */

    { "05", "Retired KEY MAN 1",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x82, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "06", "Retired KEY MAN 2",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x83, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "07", "Retired KEY MAN 3",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x84, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "08", "Retired KEY MAN 4",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x85, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "09", "Retired KEY MAN 5",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x86, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "10", "Retired KEY MAN 6",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x87, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "11", "Retired KEY MAN 7",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x88, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "12", "Retired KEY MAN 8",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x89, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "13", "Retired KEY MAN 9",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8A, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "14", "Retired KEY MAN 10",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8B, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "15", "Retired KEY MAN 11",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8C, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "16", "Retired KEY MAN 12",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8D, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "17", "Retired KEY MAN 13",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8E, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "18", "Retired KEY MAN 14",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x8F, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "19", "Retired KEY MAN 15",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x90, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "20", "Retired KEY MAN 16",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x91, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "21", "Retired KEY MAN 17",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x92, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "22", "Retired KEY MAN 18",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x93, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "23", "Retired KEY MAN 19",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x94, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0},

    { "24", "Retired KEY MAN 20",

        /*RSA*/SC_PKCS15_PRKEY_USAGE_DECRYPT | SC_PKCS15_PRKEY_USAGE_UNWRAP,

        /*EC*/SC_PKCS15_PRKEY_USAGE_DERIVE,

      "", 0x95, "01", SC_PKCS15_CO_FLAG_PRIVATE, 0}

    /* SM Signer certificate does not have private key on card */

  };

  // clang-format on

  int    r, i;

  sc_card_t *card = p15card->card;

  sc_serial_number_t serial;

  char buf[SC_MAX_SERIALNR * 2 + 1];

  common_key_info ckis[PIV_NUM_CERTS];

  int follows_nist_fascn = 0;

  char *token_name = NULL;

  SC_FUNC_CALLED(card->ctx, SC_LOG_DEBUG_VERBOSE);

  memset(&serial, 0, sizeof(serial));

  /* could read this off card if needed */

  /* CSP does not like a - in the name */

  set_string(&p15card->tokeninfo->label, "PIV_II");

  set_string(&p15card->tokeninfo->manufacturer_id, MANU_ID);

  /*

   * get serial number

   * We will use the FASC-N from the CHUID

   * Note we are not verifying CHUID, belongs to this card

   * but need serial number for Mac tokend

   */

  r = sc_card_ctl(card, SC_CARDCTL_GET_SERIALNR, &serial);

  if (r < 0) {

    sc_log(card->ctx, "sc_card_ctl rc=%d",r);

    set_string(&p15card->tokeninfo->serial_number, "00000000");

  } else {

    sc_bin_to_hex(serial.value, serial.len, buf, sizeof(buf), 0);

    set_string(&p15card->tokeninfo->serial_number, buf);

  }

  /* US gov issued PIVs have CHUID with a FASCN that does not start with 9999 */

  if (serial.len == 25 && !(serial.value[0] == 0xD4 && serial.value[1] == 0xE7 && serial.value[2] == 0x39 && (serial.value[3] | 0x7F) == 0xFF)) {

      follows_nist_fascn = 1;

  }

  sc_log(card->ctx,  "PIV-II adding objects...");

  /* set other objects */

  for (i = 0; objects[i].label; i++) {

    struct sc_pkcs15_data_info obj_info;

    struct sc_pkcs15_object    obj_obj;

    memset(&obj_info, 0, sizeof(obj_info));

    memset(&obj_obj, 0, sizeof(obj_obj));

    sc_pkcs15_format_id(objects[i].id, &obj_info.id);

    sc_format_path(objects[i].path, &obj_info.path);

    /* See if the object can not be present on the card */

    r = sc_card_ctl(card, SC_CARDCTL_PIV_OBJECT_PRESENT, &obj_info.path);

    if (r == 1)

      continue; /* Not on card, do not define the object */

    strncpy(obj_info.app_label, objects[i].label, SC_PKCS15_MAX_LABEL_SIZE - 1);

    r = sc_format_oid(&obj_info.app_oid, objects[i].aoid);

    if (r != SC_SUCCESS)

      LOG_FUNC_RETURN(card->ctx, r);

    /* We can not read all the objects, as some need the PIN! */

    if (objects[i].auth_id)

      sc_pkcs15_format_id(objects[i].auth_id, &obj_obj.auth_id);

    strncpy(obj_obj.label, objects[i].label, SC_PKCS15_MAX_LABEL_SIZE - 1);

    obj_obj.flags = objects[i].obj_flags;

    r = sc_pkcs15emu_object_add(p15card, SC_PKCS15_TYPE_DATA_OBJECT,

      &obj_obj, &obj_info);

    if (r < 0)

      LOG_FUNC_RETURN(card->ctx, r);

  }

  /*

   * certs, pubkeys and priv keys are related and we assume

   * they are in order

   * We need to read the cert, get modulus and keylen

   * We use those for the pubkey, and priv key objects.

   * If no cert, then see if pubkey (i.e. we are initializing,

   * and the pubkey is in a file,) then add pubkey and privkey

   * If no cert and no pubkey, skip adding them.

   */

  /* set certs */

  sc_log(card->ctx,  "PIV-II adding certs...");

  for (i = 0; i < PIV_NUM_CERTS; i++) {

    struct sc_pkcs15_cert_info cert_info;

    struct sc_pkcs15_object    cert_obj;

    sc_pkcs15_der_t   cert_der;

    sc_pkcs15_cert_t *cert_out = NULL;

    int private_obj;

    ckis[i].cert_found = 0;

    ckis[i].key_alg = -1;

    ckis[i].pubkey_found = 0;

    ckis[i].pubkey_from_file = 0;

    ckis[i].pubkey_len = 0;

    ckis[i].pubkey_from_cert = NULL;

    ckis[i].cert_keyUsage = 0;

    ckis[i].cert_keyUsage_present = 0;

    ckis[i].pub_usage = 0;

    ckis[i].priv_usage = 0;

    memset(&cert_info, 0, sizeof(cert_info));

    memset(&cert_obj,  0, sizeof(cert_obj));

    sc_pkcs15_format_id(certs[i].id, &cert_info.id);

    cert_info.authority = certs[i].authority;

    sc_format_path(certs[i].path, &cert_info.path);

    strncpy(cert_obj.label, certs[i].label, SC_PKCS15_MAX_LABEL_SIZE - 1);

    cert_obj.flags = certs[i].obj_flags;

    /* See if the cert might be present or not. */

    r = sc_card_ctl(card, SC_CARDCTL_PIV_OBJECT_PRESENT, &cert_info.path);

    if (r == 1) {

      sc_log(card->ctx,  "Cert can not be present,i=%d", i);

      continue;

    }

    private_obj = cert_obj.flags & SC_PKCS15_CO_FLAG_PRIVATE;

    r = sc_pkcs15_read_file(p15card, &cert_info.path, &cert_der.value, &cert_der.len, private_obj);

    if (r) {

      sc_log(card->ctx,  "No cert found,i=%d", i);

      continue;

    }

    ckis[i].cert_found = 1;

    /* cache it using the PKCS15 emulation objects */

    /* as it does not change */

    if (cert_der.value) {

      cert_info.value.value = cert_der.value;

      cert_info.value.len = cert_der.len;

      if (!p15card->opts.use_file_cache

          || (private_obj && !(p15card->opts.use_file_cache & SC_PKCS15_OPTS_CACHE_ALL_FILES))) {

        cert_info.path.len = 0; /* use in mem cert from now on */

      }

    }

    /* following will find the cached cert in cert_info */

    r =  sc_pkcs15_read_certificate(p15card, &cert_info, private_obj, &cert_out);

    if (r < 0 || cert_out == NULL || cert_out->key == NULL) {

      sc_log(card->ctx,  "Failed to read/parse the certificate r=%d",r);

      if (cert_out != NULL)

        sc_pkcs15_free_certificate(cert_out);

      free(cert_der.value);

      continue;

    }

    /* set the token name to the name of the CN of the first certificate */

    if (!token_name) {

      u8 * cn_name = NULL;

      size_t cn_len = 0;

      static const struct sc_object_id cn_oid = {{ 2, 5, 4, 3, -1 }};

      r = sc_pkcs15_get_name_from_dn(card->ctx, cert_out->subject,

        cert_out->subject_len, &cn_oid, &cn_name, &cn_len);

      if (r == SC_SUCCESS) {

        token_name = malloc (cn_len+1);

        if (!token_name) {

          sc_pkcs15_free_certificate(cert_out);

          free(cn_name);

          r = SC_ERROR_OUT_OF_MEMORY;

          LOG_TEST_GOTO_ERR(card->ctx, r,

            "Failed to allocate memory");

        }

        memcpy(token_name, cn_name, cn_len);

        free(cn_name);

        token_name[cn_len] = 0;

        free(p15card->tokeninfo->label);

        p15card->tokeninfo->label = token_name;

      }

    }

    /*

     * get keyUsage if present save in ckis[i]

     * Will only use it if this in a non FED issued card

     * which has a CHUID with FASC-N not starting with 9999

     */

    if (follows_nist_fascn == 0) {

      struct sc_object_id keyUsage_oid={{2,5,29,15,-1}};

      int r = 0;

      r = sc_pkcs15_get_bitstring_extension(card->ctx, cert_out,

        &keyUsage_oid,

        &ckis[i].cert_keyUsage, NULL);

      if ( r >= 0)

        ckis[i].cert_keyUsage_present = 1;

        /* TODO if no key usage, we could set all uses */

    }

    ckis[i].key_alg = cert_out->key->algorithm;

    switch (cert_out->key->algorithm) {

      case SC_ALGORITHM_RSA:

        /* save pubkey_len for pub and priv */

        ckis[i].pubkey_len = cert_out->key->u.rsa.modulus.len * 8;

        /* See RFC 5280 and PKCS#11 V2.40 */

        if (ckis[i].cert_keyUsage_present) {

          if (ckis[i].cert_keyUsage & SC_X509_DIGITAL_SIGNATURE) {

            ckis[i].pub_usage |= SC_PKCS15_PRKEY_USAGE_ENCRYPT /* extra*/

                  |SC_PKCS15_PRKEY_USAGE_WRAP

                  |SC_PKCS15_PRKEY_USAGE_VERIFY

                  |SC_PKCS15_PRKEY_USAGE_VERIFYRECOVER;

                  ckis[i].priv_usage |= SC_PKCS15_PRKEY_USAGE_DECRYPT /*extra */

                  |SC_PKCS15_PRKEY_USAGE_UNWRAP

                  |SC_PKCS15_PRKEY_USAGE_SIGN

                  |SC_PKCS15_PRKEY_USAGE_SIGNRECOVER;

          }

          if (ckis[i].cert_keyUsage & SC_X509_NON_REPUDIATION) {

            ckis[i].pub_usage |= SC_PKCS15_PRKEY_USAGE_ENCRYPT /* extra */

                  |SC_PKCS15_PRKEY_USAGE_NONREPUDIATION

                  |SC_PKCS15_PRKEY_USAGE_VERIFY

                  |SC_PKCS15_PRKEY_USAGE_VERIFYRECOVER;

            ckis[i].priv_usage |= SC_PKCS15_PRKEY_USAGE_DECRYPT /*extra*/

                  |SC_PKCS15_PRKEY_USAGE_NONREPUDIATION

                  |SC_PKCS15_PRKEY_USAGE_SIGN

                  |SC_PKCS15_PRKEY_USAGE_SIGNRECOVER;

          }

          if (ckis[i].cert_keyUsage & SC_X509_KEY_ENCIPHERMENT) {

            ckis[i].pub_usage |= SC_PKCS15_PRKEY_USAGE_ENCRYPT| SC_PKCS15_PRKEY_USAGE_WRAP;

            ckis[i].priv_usage |= SC_PKCS15_PRKEY_USAGE_DECRYPT| SC_PKCS15_PRKEY_USAGE_UNWRAP;

          }

          if (ckis[i].cert_keyUsage & SC_X509_DATA_ENCIPHERMENT) {

            ckis[i].pub_usage |= SC_PKCS15_PRKEY_USAGE_ENCRYPT;

            ckis[i].priv_usage |= SC_PKCS15_PRKEY_USAGE_DECRYPT;

          }

          if (ckis[i].cert_keyUsage & SC_X509_KEY_AGREEMENT) {

            ckis[i].pub_usage |= SC_PKCS15_PRKEY_USAGE_DERIVE;