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 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_CRYPTO_COMMON_H 27 #define _SYS_CRYPTO_COMMON_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 /* 32 * Header file for the common data structures of the cryptographic framework 33 */ 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <sys/types.h> 40 #include <sys/uio.h> 41 #include <sys/stream.h> 42 #include <sys/mutex.h> 43 #include <sys/condvar.h> 44 45 46 /* Cryptographic Mechanisms */ 47 48 #define CRYPTO_MAX_MECH_NAME 32 49 typedef char crypto_mech_name_t[CRYPTO_MAX_MECH_NAME]; 50 51 typedef uint64_t crypto_mech_type_t; 52 53 typedef struct crypto_mechanism { 54 crypto_mech_type_t cm_type; /* mechanism type */ 55 caddr_t cm_param; /* mech. parameter */ 56 size_t cm_param_len; /* mech. parameter len */ 57 } crypto_mechanism_t; 58 59 #ifdef _SYSCALL32 60 61 typedef struct crypto_mechanism32 { 62 crypto_mech_type_t cm_type; /* mechanism type */ 63 caddr32_t cm_param; /* mech. parameter */ 64 size32_t cm_param_len; /* mech. parameter len */ 65 } crypto_mechanism32_t; 66 67 #endif /* _SYSCALL32 */ 68 69 /* CK_AES_CTR_PARAMS provides parameters to the CKM_AES_CTR mechanism */ 70 typedef struct CK_AES_CTR_PARAMS { 71 ulong_t ulCounterBits; 72 uint8_t cb[16]; 73 } CK_AES_CTR_PARAMS; 74 75 /* CK_AES_CCM_PARAMS provides parameters to the CKM_AES_CCM mechanism */ 76 typedef struct CK_AES_CCM_PARAMS { 77 ulong_t ulMACSize; 78 ulong_t ulNonceSize; 79 ulong_t ulAuthDataSize; 80 ulong_t ulDataSize; /* used for plaintext or ciphertext */ 81 uchar_t *nonce; 82 uchar_t *authData; 83 } CK_AES_CCM_PARAMS; 84 85 /* 86 * CK_ECDH1_DERIVE_PARAMS provides the parameters to the 87 * CKM_ECDH1_KEY_DERIVE mechanism 88 */ 89 typedef struct CK_ECDH1_DERIVE_PARAMS { 90 ulong_t kdf; 91 ulong_t ulSharedDataLen; 92 uchar_t *pSharedData; 93 ulong_t ulPublicDataLen; 94 uchar_t *pPublicData; 95 } CK_ECDH1_DERIVE_PARAMS; 96 97 98 #ifdef _KERNEL 99 #ifdef _SYSCALL32 100 101 /* needed for 32-bit applications running on 64-bit kernels */ 102 typedef struct CK_AES_CTR_PARAMS32 { 103 uint32_t ulCounterBits; 104 uint8_t cb[16]; 105 } CK_AES_CTR_PARAMS32; 106 107 /* needed for 32-bit applications running on 64-bit kernels */ 108 typedef struct CK_AES_CCM_PARAMS32 { 109 uint32_t ulMACSize; 110 uint32_t ulNonceSize; 111 uint32_t ulAuthDataSize; 112 uint32_t ulDataSize; 113 caddr32_t nonce; 114 caddr32_t authData; 115 } CK_AES_CCM_PARAMS32; 116 117 typedef struct CK_ECDH1_DERIVE_PARAMS32 { 118 uint32_t kdf; 119 uint32_t ulSharedDataLen; 120 caddr32_t pSharedData; 121 uint32_t ulPublicDataLen; 122 caddr32_t pPublicData; 123 } CK_ECDH1_DERIVE_PARAMS32; 124 125 #endif /* _SYSCALL32 */ 126 #endif /* _KERNEL */ 127 128 /* 129 * The measurement unit bit flag for a mechanism's minimum or maximum key size. 130 * The unit are mechanism dependant. It can be in bits or in bytes. 131 */ 132 typedef uint32_t crypto_keysize_unit_t; 133 134 /* 135 * The following bit flags are valid in cm_mech_flags field in 136 * the crypto_mech_info_t structure of the SPI. 137 * 138 * Only the first two bit flags are valid in mi_keysize_unit 139 * field in the crypto_mechanism_info_t structure of the API. 140 */ 141 #define CRYPTO_KEYSIZE_UNIT_IN_BITS 0x00000001 142 #define CRYPTO_KEYSIZE_UNIT_IN_BYTES 0x00000002 143 #define CRYPTO_CAN_SHARE_OPSTATE 0x00000004 /* supports sharing */ 144 145 146 /* Mechanisms supported out-of-the-box */ 147 #define SUN_CKM_MD4 "CKM_MD4" 148 #define SUN_CKM_MD5 "CKM_MD5" 149 #define SUN_CKM_MD5_HMAC "CKM_MD5_HMAC" 150 #define SUN_CKM_MD5_HMAC_GENERAL "CKM_MD5_HMAC_GENERAL" 151 #define SUN_CKM_SHA1 "CKM_SHA_1" 152 #define SUN_CKM_SHA1_HMAC "CKM_SHA_1_HMAC" 153 #define SUN_CKM_SHA1_HMAC_GENERAL "CKM_SHA_1_HMAC_GENERAL" 154 #define SUN_CKM_SHA256 "CKM_SHA256" 155 #define SUN_CKM_SHA256_HMAC "CKM_SHA256_HMAC" 156 #define SUN_CKM_SHA256_HMAC_GENERAL "CKM_SHA256_HMAC_GENERAL" 157 #define SUN_CKM_SHA384 "CKM_SHA384" 158 #define SUN_CKM_SHA384_HMAC "CKM_SHA384_HMAC" 159 #define SUN_CKM_SHA384_HMAC_GENERAL "CKM_SHA384_HMAC_GENERAL" 160 #define SUN_CKM_SHA512 "CKM_SHA512" 161 #define SUN_CKM_SHA512_HMAC "CKM_SHA512_HMAC" 162 #define SUN_CKM_SHA512_HMAC_GENERAL "CKM_SHA512_HMAC_GENERAL" 163 #define SUN_CKM_DES_CBC "CKM_DES_CBC" 164 #define SUN_CKM_DES3_CBC "CKM_DES3_CBC" 165 #define SUN_CKM_DES_ECB "CKM_DES_ECB" 166 #define SUN_CKM_DES3_ECB "CKM_DES3_ECB" 167 #define SUN_CKM_BLOWFISH_CBC "CKM_BLOWFISH_CBC" 168 #define SUN_CKM_BLOWFISH_ECB "CKM_BLOWFISH_ECB" 169 #define SUN_CKM_AES_CBC "CKM_AES_CBC" 170 #define SUN_CKM_AES_ECB "CKM_AES_ECB" 171 #define SUN_CKM_AES_CTR "CKM_AES_CTR" 172 #define SUN_CKM_AES_CCM "CKM_AES_CCM" 173 #define SUN_CKM_RC4 "CKM_RC4" 174 #define SUN_CKM_RSA_PKCS "CKM_RSA_PKCS" 175 #define SUN_CKM_RSA_X_509 "CKM_RSA_X_509" 176 #define SUN_CKM_MD5_RSA_PKCS "CKM_MD5_RSA_PKCS" 177 #define SUN_CKM_SHA1_RSA_PKCS "CKM_SHA1_RSA_PKCS" 178 #define SUN_CKM_SHA256_RSA_PKCS "CKM_SHA256_RSA_PKCS" 179 #define SUN_CKM_SHA384_RSA_PKCS "CKM_SHA384_RSA_PKCS" 180 #define SUN_CKM_SHA512_RSA_PKCS "CKM_SHA512_RSA_PKCS" 181 182 /* Shared operation context format for CKM_RC4 */ 183 typedef struct { 184 uchar_t arr[256]; 185 uchar_t i, j; 186 uint64_t pad; /* For 64-bit alignment */ 187 } arcfour_state_t; 188 189 190 /* Data arguments of cryptographic operations */ 191 192 typedef enum crypto_data_format { 193 CRYPTO_DATA_RAW = 1, 194 CRYPTO_DATA_UIO, 195 CRYPTO_DATA_MBLK 196 } crypto_data_format_t; 197 198 typedef struct crypto_data { 199 crypto_data_format_t cd_format; /* Format identifier */ 200 off_t cd_offset; /* Offset from the beginning */ 201 size_t cd_length; /* # of bytes in use */ 202 caddr_t cd_miscdata; /* ancillary data */ 203 union { 204 /* Raw format */ 205 iovec_t cdu_raw; /* Pointer and length */ 206 207 /* uio scatter-gather format */ 208 uio_t *cdu_uio; 209 210 /* mblk scatter-gather format */ 211 mblk_t *cdu_mp; /* The mblk chain */ 212 213 } cdu; /* Crypto Data Union */ 214 } crypto_data_t; 215 216 #define cd_raw cdu.cdu_raw 217 #define cd_uio cdu.cdu_uio 218 #define cd_mp cdu.cdu_mp 219 220 typedef struct crypto_dual_data { 221 crypto_data_t dd_data; /* The data */ 222 off_t dd_offset2; /* Used by dual operation */ 223 size_t dd_len2; /* # of bytes to take */ 224 } crypto_dual_data_t; 225 226 #define dd_format dd_data.cd_format 227 #define dd_offset1 dd_data.cd_offset 228 #define dd_len1 dd_data.cd_length 229 #define dd_miscdata dd_data.cd_miscdata 230 #define dd_raw dd_data.cd_raw 231 #define dd_uio dd_data.cd_uio 232 #define dd_mp dd_data.cd_mp 233 234 /* The keys, and their contents */ 235 236 typedef enum { 237 CRYPTO_KEY_RAW = 1, /* ck_data is a cleartext key */ 238 CRYPTO_KEY_REFERENCE, /* ck_obj_id is an opaque reference */ 239 CRYPTO_KEY_ATTR_LIST /* ck_attrs is a list of object attributes */ 240 } crypto_key_format_t; 241 242 typedef uint64_t crypto_attr_type_t; 243 244 /* Attribute types to use for passing a RSA public key or a private key. */ 245 #define SUN_CKA_MODULUS 0x00000120 246 #define SUN_CKA_MODULUS_BITS 0x00000121 247 #define SUN_CKA_PUBLIC_EXPONENT 0x00000122 248 #define SUN_CKA_PRIVATE_EXPONENT 0x00000123 249 #define SUN_CKA_PRIME_1 0x00000124 250 #define SUN_CKA_PRIME_2 0x00000125 251 #define SUN_CKA_EXPONENT_1 0x00000126 252 #define SUN_CKA_EXPONENT_2 0x00000127 253 #define SUN_CKA_COEFFICIENT 0x00000128 254 #define SUN_CKA_PRIME 0x00000130 255 #define SUN_CKA_SUBPRIME 0x00000131 256 #define SUN_CKA_BASE 0x00000132 257 258 typedef uint32_t crypto_object_id_t; 259 260 typedef struct crypto_object_attribute { 261 crypto_attr_type_t oa_type; /* attribute type */ 262 caddr_t oa_value; /* attribute value */ 263 ssize_t oa_value_len; /* length of attribute value */ 264 } crypto_object_attribute_t; 265 266 typedef struct crypto_key { 267 crypto_key_format_t ck_format; /* format identifier */ 268 union { 269 /* for CRYPTO_KEY_RAW ck_format */ 270 struct { 271 uint_t cku_v_length; /* # of bits in ck_data */ 272 void *cku_v_data; /* ptr to key value */ 273 } cku_key_value; 274 275 /* for CRYPTO_KEY_REFERENCE ck_format */ 276 crypto_object_id_t cku_key_id; /* reference to object key */ 277 278 /* for CRYPTO_KEY_ATTR_LIST ck_format */ 279 struct { 280 uint_t cku_a_count; /* number of attributes */ 281 crypto_object_attribute_t *cku_a_oattr; 282 } cku_key_attrs; 283 } cku_data; /* Crypto Key union */ 284 } crypto_key_t; 285 286 #ifdef _SYSCALL32 287 288 typedef struct crypto_object_attribute32 { 289 uint64_t oa_type; /* attribute type */ 290 caddr32_t oa_value; /* attribute value */ 291 ssize32_t oa_value_len; /* length of attribute value */ 292 } crypto_object_attribute32_t; 293 294 typedef struct crypto_key32 { 295 crypto_key_format_t ck_format; /* format identifier */ 296 union { 297 /* for CRYPTO_KEY_RAW ck_format */ 298 struct { 299 uint32_t cku_v_length; /* # of bytes in ck_data */ 300 caddr32_t cku_v_data; /* ptr to key value */ 301 } cku_key_value; 302 303 /* for CRYPTO_KEY_REFERENCE ck_format */ 304 crypto_object_id_t cku_key_id; /* reference to object key */ 305 306 /* for CRYPTO_KEY_ATTR_LIST ck_format */ 307 struct { 308 uint32_t cku_a_count; /* number of attributes */ 309 caddr32_t cku_a_oattr; 310 } cku_key_attrs; 311 } cku_data; /* Crypto Key union */ 312 } crypto_key32_t; 313 314 #endif /* _SYSCALL32 */ 315 316 #define ck_data cku_data.cku_key_value.cku_v_data 317 #define ck_length cku_data.cku_key_value.cku_v_length 318 #define ck_obj_id cku_data.cku_key_id 319 #define ck_count cku_data.cku_key_attrs.cku_a_count 320 #define ck_attrs cku_data.cku_key_attrs.cku_a_oattr 321 322 /* 323 * Raw key lengths are expressed in number of bits. 324 * The following macro returns the minimum number of 325 * bytes that can contain the specified number of bits. 326 */ 327 #define CRYPTO_BITS2BYTES(n) (((n) + 7) >> 3) 328 329 /* Providers */ 330 331 typedef enum { 332 CRYPTO_HW_PROVIDER = 0, 333 CRYPTO_SW_PROVIDER, 334 CRYPTO_LOGICAL_PROVIDER 335 } crypto_provider_type_t; 336 337 typedef uint32_t crypto_provider_id_t; 338 #define KCF_PROVID_INVALID ((uint32_t)-1) 339 340 typedef struct crypto_provider_entry { 341 crypto_provider_id_t pe_provider_id; 342 uint_t pe_mechanism_count; 343 } crypto_provider_entry_t; 344 345 typedef struct crypto_dev_list_entry { 346 char le_dev_name[MAXNAMELEN]; 347 uint_t le_dev_instance; 348 uint_t le_mechanism_count; 349 } crypto_dev_list_entry_t; 350 351 /* User type for authentication ioctls and SPI entry points */ 352 353 typedef enum crypto_user_type { 354 CRYPTO_SO = 0, 355 CRYPTO_USER 356 } crypto_user_type_t; 357 358 /* Version for provider management ioctls and SPI entry points */ 359 360 typedef struct crypto_version { 361 uchar_t cv_major; 362 uchar_t cv_minor; 363 } crypto_version_t; 364 365 /* session data structure opaque to the consumer */ 366 typedef void *crypto_session_t; 367 368 /* provider data structure opaque to the consumer */ 369 typedef void *crypto_provider_t; 370 371 /* Limits used by both consumers and providers */ 372 #define CRYPTO_EXT_SIZE_LABEL 32 373 #define CRYPTO_EXT_SIZE_MANUF 32 374 #define CRYPTO_EXT_SIZE_MODEL 16 375 #define CRYPTO_EXT_SIZE_SERIAL 16 376 #define CRYPTO_EXT_SIZE_TIME 16 377 378 typedef struct crypto_provider_ext_info { 379 uchar_t ei_label[CRYPTO_EXT_SIZE_LABEL]; 380 uchar_t ei_manufacturerID[CRYPTO_EXT_SIZE_MANUF]; 381 uchar_t ei_model[CRYPTO_EXT_SIZE_MODEL]; 382 uchar_t ei_serial_number[CRYPTO_EXT_SIZE_SERIAL]; 383 ulong_t ei_flags; 384 ulong_t ei_max_session_count; 385 ulong_t ei_max_pin_len; 386 ulong_t ei_min_pin_len; 387 ulong_t ei_total_public_memory; 388 ulong_t ei_free_public_memory; 389 ulong_t ei_total_private_memory; 390 ulong_t ei_free_private_memory; 391 crypto_version_t ei_hardware_version; 392 crypto_version_t ei_firmware_version; 393 uchar_t ei_time[CRYPTO_EXT_SIZE_TIME]; 394 } crypto_provider_ext_info_t; 395 396 typedef uint_t crypto_session_id_t; 397 398 /* 399 * Common cryptographic status and error codes. 400 */ 401 #define CRYPTO_SUCCESS 0x00000000 402 #define CRYPTO_CANCEL 0x00000001 403 #define CRYPTO_HOST_MEMORY 0x00000002 404 #define CRYPTO_GENERAL_ERROR 0x00000003 405 #define CRYPTO_FAILED 0x00000004 406 #define CRYPTO_ARGUMENTS_BAD 0x00000005 407 #define CRYPTO_ATTRIBUTE_READ_ONLY 0x00000006 408 #define CRYPTO_ATTRIBUTE_SENSITIVE 0x00000007 409 #define CRYPTO_ATTRIBUTE_TYPE_INVALID 0x00000008 410 #define CRYPTO_ATTRIBUTE_VALUE_INVALID 0x00000009 411 #define CRYPTO_CANCELED 0x0000000A 412 #define CRYPTO_DATA_INVALID 0x0000000B 413 #define CRYPTO_DATA_LEN_RANGE 0x0000000C 414 #define CRYPTO_DEVICE_ERROR 0x0000000D 415 #define CRYPTO_DEVICE_MEMORY 0x0000000E 416 #define CRYPTO_DEVICE_REMOVED 0x0000000F 417 #define CRYPTO_ENCRYPTED_DATA_INVALID 0x00000010 418 #define CRYPTO_ENCRYPTED_DATA_LEN_RANGE 0x00000011 419 #define CRYPTO_KEY_HANDLE_INVALID 0x00000012 420 #define CRYPTO_KEY_SIZE_RANGE 0x00000013 421 #define CRYPTO_KEY_TYPE_INCONSISTENT 0x00000014 422 #define CRYPTO_KEY_NOT_NEEDED 0x00000015 423 #define CRYPTO_KEY_CHANGED 0x00000016 424 #define CRYPTO_KEY_NEEDED 0x00000017 425 #define CRYPTO_KEY_INDIGESTIBLE 0x00000018 426 #define CRYPTO_KEY_FUNCTION_NOT_PERMITTED 0x00000019 427 #define CRYPTO_KEY_NOT_WRAPPABLE 0x0000001A 428 #define CRYPTO_KEY_UNEXTRACTABLE 0x0000001B 429 #define CRYPTO_MECHANISM_INVALID 0x0000001C 430 #define CRYPTO_MECHANISM_PARAM_INVALID 0x0000001D 431 #define CRYPTO_OBJECT_HANDLE_INVALID 0x0000001E 432 #define CRYPTO_OPERATION_IS_ACTIVE 0x0000001F 433 #define CRYPTO_OPERATION_NOT_INITIALIZED 0x00000020 434 #define CRYPTO_PIN_INCORRECT 0x00000021 435 #define CRYPTO_PIN_INVALID 0x00000022 436 #define CRYPTO_PIN_LEN_RANGE 0x00000023 437 #define CRYPTO_PIN_EXPIRED 0x00000024 438 #define CRYPTO_PIN_LOCKED 0x00000025 439 #define CRYPTO_SESSION_CLOSED 0x00000026 440 #define CRYPTO_SESSION_COUNT 0x00000027 441 #define CRYPTO_SESSION_HANDLE_INVALID 0x00000028 442 #define CRYPTO_SESSION_READ_ONLY 0x00000029 443 #define CRYPTO_SESSION_EXISTS 0x0000002A 444 #define CRYPTO_SESSION_READ_ONLY_EXISTS 0x0000002B 445 #define CRYPTO_SESSION_READ_WRITE_SO_EXISTS 0x0000002C 446 #define CRYPTO_SIGNATURE_INVALID 0x0000002D 447 #define CRYPTO_SIGNATURE_LEN_RANGE 0x0000002E 448 #define CRYPTO_TEMPLATE_INCOMPLETE 0x0000002F 449 #define CRYPTO_TEMPLATE_INCONSISTENT 0x00000030 450 #define CRYPTO_UNWRAPPING_KEY_HANDLE_INVALID 0x00000031 451 #define CRYPTO_UNWRAPPING_KEY_SIZE_RANGE 0x00000032 452 #define CRYPTO_UNWRAPPING_KEY_TYPE_INCONSISTENT 0x00000033 453 #define CRYPTO_USER_ALREADY_LOGGED_IN 0x00000034 454 #define CRYPTO_USER_NOT_LOGGED_IN 0x00000035 455 #define CRYPTO_USER_PIN_NOT_INITIALIZED 0x00000036 456 #define CRYPTO_USER_TYPE_INVALID 0x00000037 457 #define CRYPTO_USER_ANOTHER_ALREADY_LOGGED_IN 0x00000038 458 #define CRYPTO_USER_TOO_MANY_TYPES 0x00000039 459 #define CRYPTO_WRAPPED_KEY_INVALID 0x0000003A 460 #define CRYPTO_WRAPPED_KEY_LEN_RANGE 0x0000003B 461 #define CRYPTO_WRAPPING_KEY_HANDLE_INVALID 0x0000003C 462 #define CRYPTO_WRAPPING_KEY_SIZE_RANGE 0x0000003D 463 #define CRYPTO_WRAPPING_KEY_TYPE_INCONSISTENT 0x0000003E 464 #define CRYPTO_RANDOM_SEED_NOT_SUPPORTED 0x0000003F 465 #define CRYPTO_RANDOM_NO_RNG 0x00000040 466 #define CRYPTO_DOMAIN_PARAMS_INVALID 0x00000041 467 #define CRYPTO_BUFFER_TOO_SMALL 0x00000042 468 #define CRYPTO_INFORMATION_SENSITIVE 0x00000043 469 #define CRYPTO_NOT_SUPPORTED 0x00000044 470 471 #define CRYPTO_QUEUED 0x00000045 472 #define CRYPTO_BUFFER_TOO_BIG 0x00000046 473 #define CRYPTO_INVALID_CONTEXT 0x00000047 474 #define CRYPTO_INVALID_MAC 0x00000048 475 #define CRYPTO_MECH_NOT_SUPPORTED 0x00000049 476 #define CRYPTO_INCONSISTENT_ATTRIBUTE 0x0000004A 477 #define CRYPTO_NO_PERMISSION 0x0000004B 478 #define CRYPTO_INVALID_PROVIDER_ID 0x0000004C 479 #define CRYPTO_VERSION_MISMATCH 0x0000004D 480 #define CRYPTO_BUSY 0x0000004E 481 #define CRYPTO_UNKNOWN_PROVIDER 0x0000004F 482 #define CRYPTO_MODVERIFICATION_FAILED 0x00000050 483 #define CRYPTO_OLD_CTX_TEMPLATE 0x00000051 484 #define CRYPTO_WEAK_KEY 0x00000052 485 486 /* 487 * Special values that can be used to indicate that information is unavailable 488 * or that there is not practical limit. These values can be used 489 * by fields of the SPI crypto_provider_ext_info(9S) structure. 490 * The value of CRYPTO_UNAVAILABLE_INFO should be the same as 491 * CK_UNAVAILABLE_INFO in the PKCS#11 spec. 492 */ 493 #define CRYPTO_UNAVAILABLE_INFO ((ulong_t)(-1)) 494 #define CRYPTO_EFFECTIVELY_INFINITE 0x0 495 496 #ifdef __cplusplus 497 } 498 #endif 499 500 #endif /* _SYS_CRYPTO_COMMON_H */ 501