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