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.
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.
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]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_CRYPTO_COMMON_H
27 #define _SYS_CRYPTO_COMMON_H
30 * Header file for the common data structures of the cryptographic framework
37 #include <sys/types.h>
39 #include <sys/stream.h>
40 #include <sys/mutex.h>
41 #include <sys/condvar.h>
44 /* Cryptographic Mechanisms */
46 #define CRYPTO_MAX_MECH_NAME 32
47 typedef char crypto_mech_name_t
[CRYPTO_MAX_MECH_NAME
];
49 typedef uint64_t crypto_mech_type_t
;
51 typedef struct crypto_mechanism
{
52 crypto_mech_type_t cm_type
; /* mechanism type */
53 caddr_t cm_param
; /* mech. parameter */
54 size_t cm_param_len
; /* mech. parameter len */
59 typedef struct crypto_mechanism32
{
60 crypto_mech_type_t cm_type
; /* mechanism type */
61 caddr32_t cm_param
; /* mech. parameter */
62 size32_t cm_param_len
; /* mech. parameter len */
63 } crypto_mechanism32_t
;
65 #endif /* _SYSCALL32 */
68 /* CK_AES_CTR_PARAMS provides parameters to the CKM_AES_CTR mechanism */
69 typedef struct CK_AES_CTR_PARAMS
{
70 ulong_t ulCounterBits
;
75 /* CK_AES_CCM_PARAMS provides parameters to the CKM_AES_CCM mechanism */
76 typedef struct CK_AES_CCM_PARAMS
{
79 ulong_t ulAuthDataSize
;
80 ulong_t ulDataSize
; /* used for plaintext or ciphertext */
85 /* CK_AES_GCM_PARAMS provides parameters to the CKM_AES_GCM mechanism */
86 typedef struct CK_AES_GCM_PARAMS
{
97 * CK_ECDH1_DERIVE_PARAMS provides the parameters to the
98 * CKM_ECDH1_KEY_DERIVE mechanism
100 typedef struct CK_ECDH1_DERIVE_PARAMS
{
102 ulong_t ulSharedDataLen
;
103 uchar_t
*pSharedData
;
104 ulong_t ulPublicDataLen
;
105 uchar_t
*pPublicData
;
106 } CK_ECDH1_DERIVE_PARAMS
;
112 /* needed for 32-bit applications running on 64-bit kernels */
113 typedef struct CK_AES_CTR_PARAMS32
{
114 uint32_t ulCounterBits
;
116 } CK_AES_CTR_PARAMS32
;
118 /* needed for 32-bit applications running on 64-bit kernels */
119 typedef struct CK_AES_CCM_PARAMS32
{
121 uint32_t ulNonceSize
;
122 uint32_t ulAuthDataSize
;
126 } CK_AES_CCM_PARAMS32
;
128 /* needed for 32-bit applications running on 64-bit kernels */
129 typedef struct CK_AES_GCM_PARAMS32
{
136 } CK_AES_GCM_PARAMS32
;
138 typedef struct CK_ECDH1_DERIVE_PARAMS32
{
140 uint32_t ulSharedDataLen
;
141 caddr32_t pSharedData
;
142 uint32_t ulPublicDataLen
;
143 caddr32_t pPublicData
;
144 } CK_ECDH1_DERIVE_PARAMS32
;
146 #endif /* _SYSCALL32 */
150 * The measurement unit bit flag for a mechanism's minimum or maximum key size.
151 * The unit are mechanism dependant. It can be in bits or in bytes.
153 typedef uint32_t crypto_keysize_unit_t
;
156 * The following bit flags are valid in cm_mech_flags field in
157 * the crypto_mech_info_t structure of the SPI.
159 * Only the first two bit flags are valid in mi_keysize_unit
160 * field in the crypto_mechanism_info_t structure of the API.
162 #define CRYPTO_KEYSIZE_UNIT_IN_BITS 0x00000001
163 #define CRYPTO_KEYSIZE_UNIT_IN_BYTES 0x00000002
164 #define CRYPTO_CAN_SHARE_OPSTATE 0x00000004 /* supports sharing */
167 /* Mechanisms supported out-of-the-box */
168 #define SUN_CKM_MD4 "CKM_MD4"
169 #define SUN_CKM_MD5 "CKM_MD5"
170 #define SUN_CKM_MD5_HMAC "CKM_MD5_HMAC"
171 #define SUN_CKM_MD5_HMAC_GENERAL "CKM_MD5_HMAC_GENERAL"
172 #define SUN_CKM_SHA1 "CKM_SHA_1"
173 #define SUN_CKM_SHA1_HMAC "CKM_SHA_1_HMAC"
174 #define SUN_CKM_SHA1_HMAC_GENERAL "CKM_SHA_1_HMAC_GENERAL"
175 #define SUN_CKM_SHA256 "CKM_SHA256"
176 #define SUN_CKM_SHA256_HMAC "CKM_SHA256_HMAC"
177 #define SUN_CKM_SHA256_HMAC_GENERAL "CKM_SHA256_HMAC_GENERAL"
178 #define SUN_CKM_SHA384 "CKM_SHA384"
179 #define SUN_CKM_SHA384_HMAC "CKM_SHA384_HMAC"
180 #define SUN_CKM_SHA384_HMAC_GENERAL "CKM_SHA384_HMAC_GENERAL"
181 #define SUN_CKM_SHA512 "CKM_SHA512"
182 #define SUN_CKM_SHA512_HMAC "CKM_SHA512_HMAC"
183 #define SUN_CKM_SHA512_HMAC_GENERAL "CKM_SHA512_HMAC_GENERAL"
184 #define SUN_CKM_DES_CBC "CKM_DES_CBC"
185 #define SUN_CKM_DES3_CBC "CKM_DES3_CBC"
186 #define SUN_CKM_DES_ECB "CKM_DES_ECB"
187 #define SUN_CKM_DES3_ECB "CKM_DES3_ECB"
188 #define SUN_CKM_BLOWFISH_CBC "CKM_BLOWFISH_CBC"
189 #define SUN_CKM_BLOWFISH_ECB "CKM_BLOWFISH_ECB"
190 #define SUN_CKM_AES_CBC "CKM_AES_CBC"
191 #define SUN_CKM_AES_ECB "CKM_AES_ECB"
192 #define SUN_CKM_AES_CTR "CKM_AES_CTR"
193 #define SUN_CKM_AES_CCM "CKM_AES_CCM"
194 #define SUN_CKM_AES_GCM "CKM_AES_GCM"
195 #define SUN_CKM_RC4 "CKM_RC4"
196 #define SUN_CKM_RSA_PKCS "CKM_RSA_PKCS"
197 #define SUN_CKM_RSA_X_509 "CKM_RSA_X_509"
198 #define SUN_CKM_MD5_RSA_PKCS "CKM_MD5_RSA_PKCS"
199 #define SUN_CKM_SHA1_RSA_PKCS "CKM_SHA1_RSA_PKCS"
200 #define SUN_CKM_SHA256_RSA_PKCS "CKM_SHA256_RSA_PKCS"
201 #define SUN_CKM_SHA384_RSA_PKCS "CKM_SHA384_RSA_PKCS"
202 #define SUN_CKM_SHA512_RSA_PKCS "CKM_SHA512_RSA_PKCS"
203 #define SUN_CKM_EC_KEY_PAIR_GEN "CKM_EC_KEY_PAIR_GEN"
204 #define SUN_CKM_ECDH1_DERIVE "CKM_ECDH1_DERIVE"
205 #define SUN_CKM_ECDSA_SHA1 "CKM_ECDSA_SHA1"
206 #define SUN_CKM_ECDSA "CKM_ECDSA"
208 /* Shared operation context format for CKM_RC4 */
217 uint64_t pad
; /* For 64-bit alignment */
220 /* Data arguments of cryptographic operations */
222 typedef enum crypto_data_format
{
226 } crypto_data_format_t
;
228 typedef struct crypto_data
{
229 crypto_data_format_t cd_format
; /* Format identifier */
230 off_t cd_offset
; /* Offset from the beginning */
231 size_t cd_length
; /* # of bytes in use */
232 caddr_t cd_miscdata
; /* ancillary data */
235 iovec_t cdu_raw
; /* Pointer and length */
237 /* uio scatter-gather format */
240 /* mblk scatter-gather format */
241 mblk_t
*cdu_mp
; /* The mblk chain */
243 } cdu
; /* Crypto Data Union */
246 #define cd_raw cdu.cdu_raw
247 #define cd_uio cdu.cdu_uio
248 #define cd_mp cdu.cdu_mp
250 typedef struct crypto_dual_data
{
251 crypto_data_t dd_data
; /* The data */
252 off_t dd_offset2
; /* Used by dual operation */
253 size_t dd_len2
; /* # of bytes to take */
254 } crypto_dual_data_t
;
256 #define dd_format dd_data.cd_format
257 #define dd_offset1 dd_data.cd_offset
258 #define dd_len1 dd_data.cd_length
259 #define dd_miscdata dd_data.cd_miscdata
260 #define dd_raw dd_data.cd_raw
261 #define dd_uio dd_data.cd_uio
262 #define dd_mp dd_data.cd_mp
264 /* The keys, and their contents */
267 CRYPTO_KEY_RAW
= 1, /* ck_data is a cleartext key */
268 CRYPTO_KEY_REFERENCE
, /* ck_obj_id is an opaque reference */
269 CRYPTO_KEY_ATTR_LIST
/* ck_attrs is a list of object attributes */
270 } crypto_key_format_t
;
272 typedef uint64_t crypto_attr_type_t
;
274 /* Attribute types to use for passing a RSA public key or a private key. */
275 #define SUN_CKA_MODULUS 0x00000120
276 #define SUN_CKA_MODULUS_BITS 0x00000121
277 #define SUN_CKA_PUBLIC_EXPONENT 0x00000122
278 #define SUN_CKA_PRIVATE_EXPONENT 0x00000123
279 #define SUN_CKA_PRIME_1 0x00000124
280 #define SUN_CKA_PRIME_2 0x00000125
281 #define SUN_CKA_EXPONENT_1 0x00000126
282 #define SUN_CKA_EXPONENT_2 0x00000127
283 #define SUN_CKA_COEFFICIENT 0x00000128
284 #define SUN_CKA_PRIME 0x00000130
285 #define SUN_CKA_SUBPRIME 0x00000131
286 #define SUN_CKA_BASE 0x00000132
288 #define CKK_EC 0x00000003
289 #define CKK_GENERIC_SECRET 0x00000010
290 #define CKK_RC4 0x00000012
291 #define CKK_AES 0x0000001F
292 #define CKK_DES 0x00000013
293 #define CKK_DES2 0x00000014
294 #define CKK_DES3 0x00000015
296 #define CKO_PUBLIC_KEY 0x00000002
297 #define CKO_PRIVATE_KEY 0x00000003
298 #define CKA_CLASS 0x00000000
299 #define CKA_VALUE 0x00000011
300 #define CKA_KEY_TYPE 0x00000100
301 #define CKA_VALUE_LEN 0x00000161
302 #define CKA_EC_PARAMS 0x00000180
303 #define CKA_EC_POINT 0x00000181
305 typedef uint32_t crypto_object_id_t
;
307 typedef struct crypto_object_attribute
{
308 crypto_attr_type_t oa_type
; /* attribute type */
309 caddr_t oa_value
; /* attribute value */
310 ssize_t oa_value_len
; /* length of attribute value */
311 } crypto_object_attribute_t
;
313 typedef struct crypto_key
{
314 crypto_key_format_t ck_format
; /* format identifier */
316 /* for CRYPTO_KEY_RAW ck_format */
318 uint_t cku_v_length
; /* # of bits in ck_data */
319 void *cku_v_data
; /* ptr to key value */
322 /* for CRYPTO_KEY_REFERENCE ck_format */
323 crypto_object_id_t cku_key_id
; /* reference to object key */
325 /* for CRYPTO_KEY_ATTR_LIST ck_format */
327 uint_t cku_a_count
; /* number of attributes */
328 crypto_object_attribute_t
*cku_a_oattr
;
330 } cku_data
; /* Crypto Key union */
335 typedef struct crypto_object_attribute32
{
336 uint64_t oa_type
; /* attribute type */
337 caddr32_t oa_value
; /* attribute value */
338 ssize32_t oa_value_len
; /* length of attribute value */
339 } crypto_object_attribute32_t
;
341 typedef struct crypto_key32
{
342 crypto_key_format_t ck_format
; /* format identifier */
344 /* for CRYPTO_KEY_RAW ck_format */
346 uint32_t cku_v_length
; /* # of bytes in ck_data */
347 caddr32_t cku_v_data
; /* ptr to key value */
350 /* for CRYPTO_KEY_REFERENCE ck_format */
351 crypto_object_id_t cku_key_id
; /* reference to object key */
353 /* for CRYPTO_KEY_ATTR_LIST ck_format */
355 uint32_t cku_a_count
; /* number of attributes */
356 caddr32_t cku_a_oattr
;
358 } cku_data
; /* Crypto Key union */
361 #endif /* _SYSCALL32 */
363 #define ck_data cku_data.cku_key_value.cku_v_data
364 #define ck_length cku_data.cku_key_value.cku_v_length
365 #define ck_obj_id cku_data.cku_key_id
366 #define ck_count cku_data.cku_key_attrs.cku_a_count
367 #define ck_attrs cku_data.cku_key_attrs.cku_a_oattr
370 * Raw key lengths are expressed in number of bits.
371 * The following macro returns the minimum number of
372 * bytes that can contain the specified number of bits.
374 #define CRYPTO_BITS2BYTES(n) (((n) + 7) >> 3)
379 CRYPTO_HW_PROVIDER
= 0,
381 CRYPTO_LOGICAL_PROVIDER
382 } crypto_provider_type_t
;
384 typedef uint32_t crypto_provider_id_t
;
385 #define KCF_PROVID_INVALID ((uint32_t)-1)
387 typedef struct crypto_provider_entry
{
388 crypto_provider_id_t pe_provider_id
;
389 uint_t pe_mechanism_count
;
390 } crypto_provider_entry_t
;
392 typedef struct crypto_dev_list_entry
{
393 char le_dev_name
[MAXNAMELEN
];
394 uint_t le_dev_instance
;
395 uint_t le_mechanism_count
;
396 } crypto_dev_list_entry_t
;
398 /* User type for authentication ioctls and SPI entry points */
400 typedef enum crypto_user_type
{
403 } crypto_user_type_t
;
405 /* Version for provider management ioctls and SPI entry points */
407 typedef struct crypto_version
{
412 /* session data structure opaque to the consumer */
413 typedef void *crypto_session_t
;
415 /* provider data structure opaque to the consumer */
416 typedef void *crypto_provider_t
;
418 /* Limits used by both consumers and providers */
419 #define CRYPTO_EXT_SIZE_LABEL 32
420 #define CRYPTO_EXT_SIZE_MANUF 32
421 #define CRYPTO_EXT_SIZE_MODEL 16
422 #define CRYPTO_EXT_SIZE_SERIAL 16
423 #define CRYPTO_EXT_SIZE_TIME 16
425 typedef struct crypto_provider_ext_info
{
426 uchar_t ei_label
[CRYPTO_EXT_SIZE_LABEL
];
427 uchar_t ei_manufacturerID
[CRYPTO_EXT_SIZE_MANUF
];
428 uchar_t ei_model
[CRYPTO_EXT_SIZE_MODEL
];
429 uchar_t ei_serial_number
[CRYPTO_EXT_SIZE_SERIAL
];
431 ulong_t ei_max_session_count
;
432 ulong_t ei_max_pin_len
;
433 ulong_t ei_min_pin_len
;
434 ulong_t ei_total_public_memory
;
435 ulong_t ei_free_public_memory
;
436 ulong_t ei_total_private_memory
;
437 ulong_t ei_free_private_memory
;
438 crypto_version_t ei_hardware_version
;
439 crypto_version_t ei_firmware_version
;
440 uchar_t ei_time
[CRYPTO_EXT_SIZE_TIME
];
441 } crypto_provider_ext_info_t
;
443 typedef uint_t crypto_session_id_t
;
445 typedef enum cmd_type
{
455 #define CRYPTO_DO_UPDATE 0x01
456 #define CRYPTO_DO_FINAL 0x02
457 #define CRYPTO_DO_MD5 0x04
458 #define CRYPTO_DO_SHA1 0x08
459 #define CRYPTO_DO_SIGN 0x10
460 #define CRYPTO_DO_VERIFY 0x20
461 #define CRYPTO_DO_SHA2 0x40
463 #define PROVIDER_OWNS_KEY_SCHEDULE 0x00000001
466 * Common cryptographic status and error codes.
468 #define CRYPTO_SUCCESS 0x00000000
469 #define CRYPTO_CANCEL 0x00000001
470 #define CRYPTO_HOST_MEMORY 0x00000002
471 #define CRYPTO_GENERAL_ERROR 0x00000003
472 #define CRYPTO_FAILED 0x00000004
473 #define CRYPTO_ARGUMENTS_BAD 0x00000005
474 #define CRYPTO_ATTRIBUTE_READ_ONLY 0x00000006
475 #define CRYPTO_ATTRIBUTE_SENSITIVE 0x00000007
476 #define CRYPTO_ATTRIBUTE_TYPE_INVALID 0x00000008
477 #define CRYPTO_ATTRIBUTE_VALUE_INVALID 0x00000009
478 #define CRYPTO_CANCELED 0x0000000A
479 #define CRYPTO_DATA_INVALID 0x0000000B
480 #define CRYPTO_DATA_LEN_RANGE 0x0000000C
481 #define CRYPTO_DEVICE_ERROR 0x0000000D
482 #define CRYPTO_DEVICE_MEMORY 0x0000000E
483 #define CRYPTO_DEVICE_REMOVED 0x0000000F
484 #define CRYPTO_ENCRYPTED_DATA_INVALID 0x00000010
485 #define CRYPTO_ENCRYPTED_DATA_LEN_RANGE 0x00000011
486 #define CRYPTO_KEY_HANDLE_INVALID 0x00000012
487 #define CRYPTO_KEY_SIZE_RANGE 0x00000013
488 #define CRYPTO_KEY_TYPE_INCONSISTENT 0x00000014
489 #define CRYPTO_KEY_NOT_NEEDED 0x00000015
490 #define CRYPTO_KEY_CHANGED 0x00000016
491 #define CRYPTO_KEY_NEEDED 0x00000017
492 #define CRYPTO_KEY_INDIGESTIBLE 0x00000018
493 #define CRYPTO_KEY_FUNCTION_NOT_PERMITTED 0x00000019
494 #define CRYPTO_KEY_NOT_WRAPPABLE 0x0000001A
495 #define CRYPTO_KEY_UNEXTRACTABLE 0x0000001B
496 #define CRYPTO_MECHANISM_INVALID 0x0000001C
497 #define CRYPTO_MECHANISM_PARAM_INVALID 0x0000001D
498 #define CRYPTO_OBJECT_HANDLE_INVALID 0x0000001E
499 #define CRYPTO_OPERATION_IS_ACTIVE 0x0000001F
500 #define CRYPTO_OPERATION_NOT_INITIALIZED 0x00000020
501 #define CRYPTO_PIN_INCORRECT 0x00000021
502 #define CRYPTO_PIN_INVALID 0x00000022
503 #define CRYPTO_PIN_LEN_RANGE 0x00000023
504 #define CRYPTO_PIN_EXPIRED 0x00000024
505 #define CRYPTO_PIN_LOCKED 0x00000025
506 #define CRYPTO_SESSION_CLOSED 0x00000026
507 #define CRYPTO_SESSION_COUNT 0x00000027
508 #define CRYPTO_SESSION_HANDLE_INVALID 0x00000028
509 #define CRYPTO_SESSION_READ_ONLY 0x00000029
510 #define CRYPTO_SESSION_EXISTS 0x0000002A
511 #define CRYPTO_SESSION_READ_ONLY_EXISTS 0x0000002B
512 #define CRYPTO_SESSION_READ_WRITE_SO_EXISTS 0x0000002C
513 #define CRYPTO_SIGNATURE_INVALID 0x0000002D
514 #define CRYPTO_SIGNATURE_LEN_RANGE 0x0000002E
515 #define CRYPTO_TEMPLATE_INCOMPLETE 0x0000002F
516 #define CRYPTO_TEMPLATE_INCONSISTENT 0x00000030
517 #define CRYPTO_UNWRAPPING_KEY_HANDLE_INVALID 0x00000031
518 #define CRYPTO_UNWRAPPING_KEY_SIZE_RANGE 0x00000032
519 #define CRYPTO_UNWRAPPING_KEY_TYPE_INCONSISTENT 0x00000033
520 #define CRYPTO_USER_ALREADY_LOGGED_IN 0x00000034
521 #define CRYPTO_USER_NOT_LOGGED_IN 0x00000035
522 #define CRYPTO_USER_PIN_NOT_INITIALIZED 0x00000036
523 #define CRYPTO_USER_TYPE_INVALID 0x00000037
524 #define CRYPTO_USER_ANOTHER_ALREADY_LOGGED_IN 0x00000038
525 #define CRYPTO_USER_TOO_MANY_TYPES 0x00000039
526 #define CRYPTO_WRAPPED_KEY_INVALID 0x0000003A
527 #define CRYPTO_WRAPPED_KEY_LEN_RANGE 0x0000003B
528 #define CRYPTO_WRAPPING_KEY_HANDLE_INVALID 0x0000003C
529 #define CRYPTO_WRAPPING_KEY_SIZE_RANGE 0x0000003D
530 #define CRYPTO_WRAPPING_KEY_TYPE_INCONSISTENT 0x0000003E
531 #define CRYPTO_RANDOM_SEED_NOT_SUPPORTED 0x0000003F
532 #define CRYPTO_RANDOM_NO_RNG 0x00000040
533 #define CRYPTO_DOMAIN_PARAMS_INVALID 0x00000041
534 #define CRYPTO_BUFFER_TOO_SMALL 0x00000042
535 #define CRYPTO_INFORMATION_SENSITIVE 0x00000043
536 #define CRYPTO_NOT_SUPPORTED 0x00000044
538 #define CRYPTO_QUEUED 0x00000045
539 #define CRYPTO_BUFFER_TOO_BIG 0x00000046
540 #define CRYPTO_INVALID_CONTEXT 0x00000047
541 #define CRYPTO_INVALID_MAC 0x00000048
542 #define CRYPTO_MECH_NOT_SUPPORTED 0x00000049
543 #define CRYPTO_INCONSISTENT_ATTRIBUTE 0x0000004A
544 #define CRYPTO_NO_PERMISSION 0x0000004B
545 #define CRYPTO_INVALID_PROVIDER_ID 0x0000004C
546 #define CRYPTO_VERSION_MISMATCH 0x0000004D
547 #define CRYPTO_BUSY 0x0000004E
548 #define CRYPTO_UNKNOWN_PROVIDER 0x0000004F
549 #define CRYPTO_MODVERIFICATION_FAILED 0x00000050
550 #define CRYPTO_OLD_CTX_TEMPLATE 0x00000051
551 #define CRYPTO_WEAK_KEY 0x00000052
554 * Special values that can be used to indicate that information is unavailable
555 * or that there is not practical limit. These values can be used
556 * by fields of the SPI crypto_provider_ext_info(9S) structure.
557 * The value of CRYPTO_UNAVAILABLE_INFO should be the same as
558 * CK_UNAVAILABLE_INFO in the PKCS#11 spec.
560 #define CRYPTO_UNAVAILABLE_INFO ((ulong_t)(-1))
561 #define CRYPTO_EFFECTIVELY_INFINITE 0x0
567 #endif /* _SYS_CRYPTO_COMMON_H */