usr/src/cmd/mdb/common/modules/crypto/spi.c

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 /*
  27  * mdb dcmds for selected structures from include/sys/crypto/spi.h
  28  *
  29  * Also the mdb module housekeeping
  30  */
  31
  32 #include <sys/mdb_modapi.h>
  33 #include <sys/modctl.h>
  34 #include <sys/crypto/api.h>
  35 #include <sys/crypto/common.h>
  36 #include <sys/crypto/spi.h>
  37 #include <sys/crypto/impl.h>
  38 #include "crypto_cmds.h"
  39
  40
  41 const mdb_bitmask_t extf_flags[] = {
  42         { "NIL", (ulong_t)-1, 0L },
  43         { "CRYPTO_EXTF_RNG", CRYPTO_EXTF_RNG, CRYPTO_EXTF_RNG },
  44         { "CRYPTO_EXTF_WRITE_PROTECTED", CRYPTO_EXTF_WRITE_PROTECTED,
  45                 CRYPTO_EXTF_WRITE_PROTECTED },
  46         { "CRYPTO_EXTF_LOGIN_REQUIRED", CRYPTO_EXTF_LOGIN_REQUIRED,
  47                 CRYPTO_EXTF_LOGIN_REQUIRED },
  48         { "CRYPTO_EXTF_USER_PIN_INITIALIZED", CRYPTO_EXTF_USER_PIN_INITIALIZED,
  49                 CRYPTO_EXTF_USER_PIN_INITIALIZED },
  50         { "CRYPTO_EXTF_CLOCK_ON_TOKEN", CRYPTO_EXTF_CLOCK_ON_TOKEN,
  51                 CRYPTO_EXTF_CLOCK_ON_TOKEN },
  52         { "CRYPTO_EXTF_PROTECTED_AUTHENTICATION_PATH",
  53                 CRYPTO_EXTF_PROTECTED_AUTHENTICATION_PATH,
  54                 CRYPTO_EXTF_PROTECTED_AUTHENTICATION_PATH },
  55         { "CRYPTO_EXTF_DUAL_CRYPTO_OPERATIONS",
  56                 CRYPTO_EXTF_DUAL_CRYPTO_OPERATIONS,
  57                 CRYPTO_EXTF_DUAL_CRYPTO_OPERATIONS },
  58         { "CRYPTO_EXTF_TOKEN_INITIALIZED", CRYPTO_EXTF_TOKEN_INITIALIZED,
  59                 CRYPTO_EXTF_TOKEN_INITIALIZED },
  60         { "CRYPTO_EXTF_USER_PIN_COUNT_LOW", CRYPTO_EXTF_USER_PIN_COUNT_LOW,
  61                 CRYPTO_EXTF_USER_PIN_COUNT_LOW },
  62         { "CRYPTO_EXTF_USER_PIN_FINAL_TRY", CRYPTO_EXTF_USER_PIN_FINAL_TRY,
  63                 CRYPTO_EXTF_USER_PIN_FINAL_TRY },
  64         { "CRYPTO_EXTF_USER_PIN_LOCKED", CRYPTO_EXTF_USER_PIN_LOCKED,
  65                 CRYPTO_EXTF_USER_PIN_LOCKED },
  66         { "CRYPTO_EXTF_USER_PIN_TO_BE_CHANGED",
  67                 CRYPTO_EXTF_USER_PIN_TO_BE_CHANGED,
  68                 CRYPTO_EXTF_USER_PIN_TO_BE_CHANGED },
  69         { "CRYPTO_EXTF_SO_PIN_COUNT_LOW", CRYPTO_EXTF_SO_PIN_COUNT_LOW,
  70                 CRYPTO_EXTF_SO_PIN_COUNT_LOW },
  71         { "CRYPTO_EXTF_SO_PIN_FINAL_TRY", CRYPTO_EXTF_SO_PIN_FINAL_TRY,
  72                 CRYPTO_EXTF_SO_PIN_FINAL_TRY },
  73         { "CRYPTO_EXTF_SO_PIN_LOCKED", CRYPTO_EXTF_SO_PIN_LOCKED,
  74                 CRYPTO_EXTF_SO_PIN_LOCKED },
  75         { "CRYPTO_EXTF_SO_PIN_TO_BE_CHANGED", CRYPTO_EXTF_SO_PIN_TO_BE_CHANGED,
  76                 CRYPTO_EXTF_SO_PIN_TO_BE_CHANGED },
  77         { NULL, 0, 0 }
  78 };
  79
  80 /*ARGSUSED*/
  81 int
  82 crypto_provider_ext_info(uintptr_t addr, uint_t flags, int argc,
  83     const mdb_arg_t *argv)
  84 {
  85         crypto_provider_ext_info_t ext_prov;
  86         /*
  87          * 33 is 1 + MAX(CRYPTO_EXT_SIZE_LABEL, CRYPTO_EXT_SIZE_MANUF,
  88          *               CRYPTO_EXT_SIZE_MODEL, CRYPTO_EXT_SIZE_SERIAL)
  89          */
  90         char scratch[33];
  91
  92         if (!(flags & DCMD_ADDRSPEC))
  93                 return (DCMD_USAGE);
  94
  95         if (mdb_vread(&ext_prov, sizeof (crypto_provider_ext_info_t), addr)
  96             == -1) {
  97                 mdb_warn("cannot read addr");
  98                 return (DCMD_ERR);
  99         }
 100         bcopy(ext_prov.ei_label, scratch, CRYPTO_EXT_SIZE_LABEL);
 101         scratch[CRYPTO_EXT_SIZE_LABEL] = '\0';
 102         mdb_printf("ei_label\t\t%s\n", scratch);
 103
 104         bcopy(ext_prov.ei_manufacturerID, scratch, CRYPTO_EXT_SIZE_MANUF);
 105         scratch[CRYPTO_EXT_SIZE_MANUF] = '\0';
 106         mdb_printf("ei_manufacturerID\t%s\n", scratch);
 107
 108         bcopy(ext_prov.ei_model, scratch, CRYPTO_EXT_SIZE_MODEL);
 109         scratch[CRYPTO_EXT_SIZE_MODEL] = '\0';
 110         mdb_printf("ei_model\t\t%s\n", scratch);
 111
 112         bcopy(ext_prov.ei_serial_number, scratch, CRYPTO_EXT_SIZE_SERIAL);
 113         scratch[CRYPTO_EXT_SIZE_SERIAL] = '\0';
 114         mdb_printf("ei_serial_number\t%s\n", scratch);
 115
 116         mdb_printf("ei_flags\t0x%x:\t<%lb>\n", ext_prov.ei_flags,
 117             ext_prov.ei_flags, extf_flags);
 118         mdb_printf("ei_max_session_count\t%lu\n",
 119             ext_prov.ei_max_session_count);
 120         mdb_printf("ei_max_pin_len\t\t%lu\n", ext_prov.ei_max_pin_len);
 121         mdb_printf("ei_min_pin_len\t\t%lu\n", ext_prov.ei_min_pin_len);
 122         mdb_printf("ei_total_public_memory\t%lu\n",
 123             ext_prov.ei_total_public_memory);
 124         mdb_printf("ei_free_public_memory\t%lu\n",
 125             ext_prov.ei_free_public_memory);
 126         mdb_printf("ei_total_private_memory\t%lu\n",
 127             ext_prov.ei_total_private_memory);
 128         mdb_printf("ei_free_private_memory\t%lu\n",
 129             ext_prov.ei_free_private_memory);
 130         mdb_printf("ei_hardware_version\tmajor %c minor %c\n",
 131             ext_prov.ei_hardware_version.cv_major,
 132             ext_prov.ei_hardware_version.cv_minor);
 133         mdb_printf("ei_firmware_version\tmajor %c minor %c\n",
 134             ext_prov.ei_firmware_version.cv_major,
 135             ext_prov.ei_firmware_version.cv_minor);
 136         mdb_printf("ei_time\t%s\n", ext_prov.ei_time);
 137         return (DCMD_OK);
 138 }
 139
 140 const mdb_bitmask_t mech_bits[] = {
 141         { "NIL", (uint32_t)-1, 0 },
 142         { "CRYPTO_FG_ENCRYPT", CRYPTO_FG_ENCRYPT, CRYPTO_FG_ENCRYPT },
 143         { "CRYPTO_FG_DECRYPT", CRYPTO_FG_DECRYPT, CRYPTO_FG_DECRYPT },
 144         { "CRYPTO_FG_DIGEST", CRYPTO_FG_DIGEST, CRYPTO_FG_DIGEST },
 145         { "CRYPTO_FG_SIGN", CRYPTO_FG_SIGN, CRYPTO_FG_SIGN },
 146         { "CRYPTO_FG_SIGN_RECOVER", CRYPTO_FG_SIGN_RECOVER,
 147                 CRYPTO_FG_SIGN_RECOVER },
 148         { "CRYPTO_FG_VERIFY", CRYPTO_FG_VERIFY, CRYPTO_FG_VERIFY },
 149         { "CRYPTO_FG_VERIFY_RECOVER", CRYPTO_FG_VERIFY_RECOVER,
 150                 CRYPTO_FG_VERIFY_RECOVER },
 151         { "CRYPTO_FG_GENERATE", CRYPTO_FG_GENERATE, CRYPTO_FG_GENERATE },
 152         { "CRYPTO_FG_GENERATE_KEY_PAIR", CRYPTO_FG_GENERATE_KEY_PAIR,
 153                 CRYPTO_FG_GENERATE_KEY_PAIR },
 154         { "CRYPTO_FG_WRAP", CRYPTO_FG_WRAP, CRYPTO_FG_WRAP },
 155         { "CRYPTO_FG_UNWRAP", CRYPTO_FG_UNWRAP, CRYPTO_FG_UNWRAP },
 156         { "CRYPTO_FG_DERIVE", CRYPTO_FG_DERIVE, CRYPTO_FG_DERIVE },
 157         { "CRYPTO_FG_MAC", CRYPTO_FG_MAC, CRYPTO_FG_MAC },
 158         { "CRYPTO_FG_ENCRYPT_MAC", CRYPTO_FG_ENCRYPT_MAC,
 159                 CRYPTO_FG_ENCRYPT_MAC },
 160         { "CRYPTO_FG_MAC_DECRYPT", CRYPTO_FG_MAC_DECRYPT,
 161                 CRYPTO_FG_MAC_DECRYPT },
 162         { "CRYPTO_FG_ENCRYPT_ATOMIC", CRYPTO_FG_ENCRYPT_ATOMIC,
 163                 CRYPTO_FG_ENCRYPT_ATOMIC },
 164         { "CRYPTO_FG_DECRYPT_ATOMIC", CRYPTO_FG_DECRYPT_ATOMIC,
 165                 CRYPTO_FG_DECRYPT_ATOMIC },
 166         { "CRYPTO_FG_MAC_ATOMIC", CRYPTO_FG_MAC_ATOMIC, CRYPTO_FG_MAC_ATOMIC },
 167         { "CRYPTO_FG_DIGEST_ATOMIC", CRYPTO_FG_DIGEST_ATOMIC,
 168                 CRYPTO_FG_DIGEST_ATOMIC },
 169         { "CRYPTO_FG_SIGN_ATOMIC", CRYPTO_FG_SIGN_ATOMIC,
 170                 CRYPTO_FG_SIGN_ATOMIC },
 171         { "CRYPTO_FG_SIGN_RECOVER_ATOMIC", CRYPTO_FG_SIGN_RECOVER_ATOMIC,
 172                 CRYPTO_FG_SIGN_RECOVER_ATOMIC },
 173         { "CRYPTO_FG_VERIFY_ATOMIC", CRYPTO_FG_VERIFY_ATOMIC,
 174                 CRYPTO_FG_VERIFY_ATOMIC },
 175         { "CRYPTO_FG_VERIFY_RECOVER_ATOMIC", CRYPTO_FG_VERIFY_RECOVER_ATOMIC,
 176                 CRYPTO_FG_VERIFY_RECOVER_ATOMIC },
 177         { "CRYPTO_FG_ENCRYPT_MAC_ATOMIC", CRYPTO_FG_ENCRYPT_MAC_ATOMIC,
 178                 CRYPTO_FG_ENCRYPT_MAC_ATOMIC },
 179         { "CRYPTO_FG_MAC_DECRYPT_ATOMIC", CRYPTO_FG_MAC_DECRYPT_ATOMIC,
 180                 CRYPTO_FG_MAC_DECRYPT_ATOMIC },
 181         { "CRYPTO_FG_RANDOM", CRYPTO_FG_RANDOM, CRYPTO_FG_RANDOM},
 182         { NULL, 0, 0 }
 183 };
 184
 185 /*ARGSUSED*/
 186 int
 187 crypto_mech_info(uintptr_t addr, uint_t flags, int argc,
 188     const mdb_arg_t *argv)
 189 {
 190         crypto_mech_info_t minfo;
 191         const char *unit = "bits";
 192
 193         if (! flags & DCMD_ADDRSPEC)
 194                 return (DCMD_USAGE);
 195
 196         if (mdb_vread(&minfo, sizeof (crypto_mech_info_t), addr)
 197             == -1) {
 198                 mdb_warn("cannot read addr %p", addr);
 199                 return (DCMD_ERR);
 200         }
 201         mdb_printf("cm_mech_name_t\t%s\n", minfo.cm_mech_name);
 202         mdb_printf("cm_mech_number\t%lld\n", minfo.cm_mech_number);
 203         mdb_printf("cm_func_group_mask\t0x%x:\t<%b>\n",
 204             minfo.cm_func_group_mask, minfo.cm_func_group_mask, mech_bits);
 205         if (minfo.cm_keysize_unit & CRYPTO_KEYSIZE_UNIT_IN_BYTES)
 206                 unit = "bytes";
 207         mdb_printf("cm_min_key_length\t%lu %s\n", minfo.cm_min_key_length,
 208             unit);
 209         mdb_printf("cm_max_key_length\t%lu %s\n", minfo.cm_max_key_length,
 210             unit);
 211
 212         return (DCMD_OK);
 213 }
 214
 215 /*
 216  * MDB module linkage information:
 217  *
 218  * We declare a list of structures describing our dcmds, and a function
 219  * named _mdb_init to return a pointer to our module information.
 220  */
 221
 222 static const mdb_dcmd_t dcmds[] = {
 223
 224         /* spi.c */
 225         { "crypto_provider_ext_info", ":",
 226             "module-private crypto provider info",
 227             crypto_provider_ext_info, NULL },
 228         { "crypto_mech_info", ":",
 229             "print as crypto_mech_info",
 230             crypto_mech_info, NULL },
 231
 232         /* common.c */
 233         { "crypto_mechanism", ":",
 234             "details about a crypto mechanism", crypto_mechanism, NULL },
 235         { "crypto_data", ":",
 236             "print as crypto_data",
 237             crypto_data, NULL },
 238         { "crypto_dual_data", ":",
 239             "print as crypto_dual_data",
 240             crypto_dual_data, NULL },
 241         { "crypto_key", ":",
 242             "print as crypto_key", crypto_key, NULL },
 243
 244
 245         /* impl.c */
 246         { "kcf_provider_desc", ":",
 247             "crypto provider description struct", kcf_provider_desc, NULL },
 248
 249         { "prov_tab", "",
 250             "global table of crypto providers ", prov_tab, NULL },
 251
 252         { "policy_tab", "",
 253             "print global policy_tab", policy_tab, NULL },
 254
 255         /* sched_impl.c */
 256         { "kcf_areq_node", ":[-v]",
 257             "print asynchronous crypto request struct, [ verbose ]",
 258                 kcf_areq_node, NULL },
 259
 260         { "kcf_global_swq", "?[-v]",
 261             "global or addr global crypto queue.  [ -v = verbose ]",
 262                 kcf_global_swq, NULL },
 263         { "crypto_find_reqid", "?[-v] reqid",
 264             "look for reqid, print if found [ -v = verbose ]",
 265                 crypto_find_reqid, NULL },
 266
 267         { "kcf_reqid_table", ":[-v]",
 268             "print contents of a request ID hash table [ -v = verbose ]",
 269                 kcf_reqid_table_dcmd, NULL },
 270
 271         { "kcf_soft_conf_entry", "?",
 272             "head or addr of configured software crypto providers",
 273                 kcf_soft_conf_entry, NULL },
 274
 275         { "kcf_policy_desc", ":", "policy descriptors for crypto",
 276                 kcf_policy_desc, NULL },
 277         { NULL }
 278 };
 279
 280 static const mdb_walker_t walkers[] = {
 281         { "an_next", "walk kcf_areq_node's by an_next",
 282                 areq_first_walk_init, an_next_walk_step, areq_walk_fini },
 283         { "an_prev", "walk kcf_areq_node's by an_prev",
 284                 areq_last_walk_init, an_prev_walk_step, areq_walk_fini },
 285         { "an_idnext", "walk kcf_areq_node's by an_idnext",
 286                 an_idnext_walk_init, an_idnext_walk_step, areq_walk_fini },
 287         { "an_idprev", "walk kcf_areq_node's by an_idprev",
 288                 an_idprev_walk_init, an_idprev_walk_step, areq_walk_fini },
 289         { "an_ctxchain_next",
 290                 "walk kcf_areq_node's by an_ctxchain_next",
 291                 an_ctxchain_walk_init, an_ctxchain_walk_step, areq_walk_fini },
 292         { "kcf_reqid_table", "table of asynchronous crypto requests",
 293                 reqid_table_walk_init, reqid_table_walk_step,
 294                     reqid_table_walk_fini },
 295         { "soft_conf_entry", "table of software providers or addr",
 296                 soft_conf_walk_init, soft_conf_walk_step,
 297                     soft_conf_walk_fini },
 298         { NULL }
 299 };
 300
 301
 302 static const mdb_modinfo_t modinfo = {
 303         MDB_API_VERSION, dcmds, walkers
 304 };
 305
 306 const mdb_modinfo_t *
 307 _mdb_init(void)
 308 {
 309         return (&modinfo);
 310 }