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