/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved. */ /* * Copyright 2013 Saso Kiselkov. All rights reserved. */ #ifndef _SYS_CRYPTO_COMMON_H #define _SYS_CRYPTO_COMMON_H /* * Header file for the common data structures of the cryptographic framework */ #ifdef __cplusplus extern "C" { #endif #include /* Cryptographic Mechanisms */ #define CRYPTO_MAX_MECH_NAME 32 typedef char crypto_mech_name_t[CRYPTO_MAX_MECH_NAME]; typedef uint64_t crypto_mech_type_t; typedef struct crypto_mechanism { crypto_mech_type_t cm_type; /* mechanism type */ caddr_t cm_param; /* mech. parameter */ size_t cm_param_len; /* mech. parameter len */ } crypto_mechanism_t; #ifdef _SYSCALL32 typedef struct crypto_mechanism32 { crypto_mech_type_t cm_type; /* mechanism type */ caddr32_t cm_param; /* mech. parameter */ size32_t cm_param_len; /* mech. parameter len */ } crypto_mechanism32_t; #endif /* _SYSCALL32 */ /* CK_AES_CTR_PARAMS provides parameters to the CKM_AES_CTR mechanism */ typedef struct CK_AES_CTR_PARAMS { ulong_t ulCounterBits; uint8_t cb[16]; } CK_AES_CTR_PARAMS; /* CK_AES_CCM_PARAMS provides parameters to the CKM_AES_CCM mechanism */ typedef struct CK_AES_CCM_PARAMS { ulong_t ulMACSize; ulong_t ulNonceSize; ulong_t ulAuthDataSize; ulong_t ulDataSize; /* used for plaintext or ciphertext */ uchar_t *nonce; uchar_t *authData; } CK_AES_CCM_PARAMS; /* CK_AES_GCM_PARAMS provides parameters to the CKM_AES_GCM mechanism */ typedef struct CK_AES_GCM_PARAMS { uchar_t *pIv; ulong_t ulIvLen; ulong_t ulIvBits; uchar_t *pAAD; ulong_t ulAADLen; ulong_t ulTagBits; } CK_AES_GCM_PARAMS; /* CK_AES_GMAC_PARAMS provides parameters to the CKM_AES_GMAC mechanism */ typedef struct CK_AES_GMAC_PARAMS { uchar_t *pIv; uchar_t *pAAD; ulong_t ulAADLen; } CK_AES_GMAC_PARAMS; /* * CK_ECDH1_DERIVE_PARAMS provides the parameters to the * CKM_ECDH1_KEY_DERIVE mechanism */ typedef struct CK_ECDH1_DERIVE_PARAMS { ulong_t kdf; ulong_t ulSharedDataLen; uchar_t *pSharedData; ulong_t ulPublicDataLen; uchar_t *pPublicData; } CK_ECDH1_DERIVE_PARAMS; #ifdef _SYSCALL32 /* needed for 32-bit applications running on 64-bit kernels */ typedef struct CK_AES_CTR_PARAMS32 { uint32_t ulCounterBits; uint8_t cb[16]; } CK_AES_CTR_PARAMS32; /* needed for 32-bit applications running on 64-bit kernels */ typedef struct CK_AES_CCM_PARAMS32 { uint32_t ulMACSize; uint32_t ulNonceSize; uint32_t ulAuthDataSize; uint32_t ulDataSize; caddr32_t nonce; caddr32_t authData; } CK_AES_CCM_PARAMS32; /* needed for 32-bit applications running on 64-bit kernels */ typedef struct CK_AES_GCM_PARAMS32 { caddr32_t pIv; uint32_t ulIvLen; uint32_t ulIvBits; caddr32_t pAAD; uint32_t ulAADLen; uint32_t ulTagBits; } CK_AES_GCM_PARAMS32; /* needed for 32-bit applications running on 64-bit kernels */ typedef struct CK_AES_GMAC_PARAMS32 { caddr32_t pIv; caddr32_t pAAD; uint32_t ulAADLen; } CK_AES_GMAC_PARAMS32; typedef struct CK_ECDH1_DERIVE_PARAMS32 { uint32_t kdf; uint32_t ulSharedDataLen; caddr32_t pSharedData; uint32_t ulPublicDataLen; caddr32_t pPublicData; } CK_ECDH1_DERIVE_PARAMS32; #endif /* _SYSCALL32 */ /* * The measurement unit bit flag for a mechanism's minimum or maximum key size. * The unit are mechanism dependent. It can be in bits or in bytes. */ typedef uint32_t crypto_keysize_unit_t; /* * The following bit flags are valid in cm_mech_flags field in * the crypto_mech_info_t structure of the SPI. * * Only the first two bit flags are valid in mi_keysize_unit * field in the crypto_mechanism_info_t structure of the API. */ #define CRYPTO_KEYSIZE_UNIT_IN_BITS 0x00000001 #define CRYPTO_KEYSIZE_UNIT_IN_BYTES 0x00000002 #define CRYPTO_CAN_SHARE_OPSTATE 0x00000004 /* supports sharing */ /* Mechanisms supported out-of-the-box */ #define SUN_CKM_MD4 "CKM_MD4" #define SUN_CKM_MD5 "CKM_MD5" #define SUN_CKM_MD5_HMAC "CKM_MD5_HMAC" #define SUN_CKM_MD5_HMAC_GENERAL "CKM_MD5_HMAC_GENERAL" #define SUN_CKM_SHA1 "CKM_SHA_1" #define SUN_CKM_SHA1_HMAC "CKM_SHA_1_HMAC" #define SUN_CKM_SHA1_HMAC_GENERAL "CKM_SHA_1_HMAC_GENERAL" #define SUN_CKM_SHA256 "CKM_SHA256" #define SUN_CKM_SHA256_HMAC "CKM_SHA256_HMAC" #define SUN_CKM_SHA256_HMAC_GENERAL "CKM_SHA256_HMAC_GENERAL" #define SUN_CKM_SHA384 "CKM_SHA384" #define SUN_CKM_SHA384_HMAC "CKM_SHA384_HMAC" #define SUN_CKM_SHA384_HMAC_GENERAL "CKM_SHA384_HMAC_GENERAL" #define SUN_CKM_SHA512 "CKM_SHA512" #define SUN_CKM_SHA512_HMAC "CKM_SHA512_HMAC" #define SUN_CKM_SHA512_HMAC_GENERAL "CKM_SHA512_HMAC_GENERAL" #define SUN_CKM_SHA512_224 "CKM_SHA512_224" #define SUN_CKM_SHA512_256 "CKM_SHA512_256" #define SUN_CKM_DES_CBC "CKM_DES_CBC" #define SUN_CKM_DES3_CBC "CKM_DES3_CBC" #define SUN_CKM_DES_ECB "CKM_DES_ECB" #define SUN_CKM_DES3_ECB "CKM_DES3_ECB" #define SUN_CKM_BLOWFISH_CBC "CKM_BLOWFISH_CBC" #define SUN_CKM_BLOWFISH_ECB "CKM_BLOWFISH_ECB" #define SUN_CKM_AES_CBC "CKM_AES_CBC" #define SUN_CKM_AES_ECB "CKM_AES_ECB" #define SUN_CKM_AES_CTR "CKM_AES_CTR" #define SUN_CKM_AES_CCM "CKM_AES_CCM" #define SUN_CKM_AES_GCM "CKM_AES_GCM" #define SUN_CKM_AES_GMAC "CKM_AES_GMAC" #define SUN_CKM_AES_CFB128 "CKM_AES_CFB128" #define SUN_CKM_RC4 "CKM_RC4" #define SUN_CKM_RSA_PKCS "CKM_RSA_PKCS" #define SUN_CKM_RSA_X_509 "CKM_RSA_X_509" #define SUN_CKM_MD5_RSA_PKCS "CKM_MD5_RSA_PKCS" #define SUN_CKM_SHA1_RSA_PKCS "CKM_SHA1_RSA_PKCS" #define SUN_CKM_SHA256_RSA_PKCS "CKM_SHA256_RSA_PKCS" #define SUN_CKM_SHA384_RSA_PKCS "CKM_SHA384_RSA_PKCS" #define SUN_CKM_SHA512_RSA_PKCS "CKM_SHA512_RSA_PKCS" #define SUN_CKM_EC_KEY_PAIR_GEN "CKM_EC_KEY_PAIR_GEN" #define SUN_CKM_ECDH1_DERIVE "CKM_ECDH1_DERIVE" #define SUN_CKM_ECDSA_SHA1 "CKM_ECDSA_SHA1" #define SUN_CKM_ECDSA "CKM_ECDSA" /* Data arguments of cryptographic operations */ typedef enum crypto_data_format { CRYPTO_DATA_RAW = 1, CRYPTO_DATA_UIO, } crypto_data_format_t; typedef struct crypto_data { crypto_data_format_t cd_format; /* Format identifier */ off_t cd_offset; /* Offset from the beginning */ size_t cd_length; /* # of bytes in use */ union { /* Raw format */ iovec_t cd_raw; /* Pointer and length */ /* uio scatter-gather format */ zfs_uio_t *cd_uio; }; /* Crypto Data Union */ } crypto_data_t; /* The keys, and their contents */ typedef struct { uint_t ck_length; /* # of bits in ck_data */ void *ck_data; /* ptr to key value */ } crypto_key_t; /* * Raw key lengths are expressed in number of bits. * The following macro returns the minimum number of * bytes that can contain the specified number of bits. * Round up without overflowing the integer type. */ #define CRYPTO_BITS2BYTES(n) ((n) == 0 ? 0 : (((n) - 1) >> 3) + 1) #define CRYPTO_BYTES2BITS(n) ((n) << 3) /* Providers */ typedef uint32_t crypto_provider_id_t; #define KCF_PROVID_INVALID ((uint32_t)-1) /* session data structure opaque to the consumer */ typedef void *crypto_session_t; typedef uint_t crypto_session_id_t; #define PROVIDER_OWNS_KEY_SCHEDULE 0x00000001 /* * Common cryptographic status and error codes. */ #define CRYPTO_SUCCESS 0x00000000 #define CRYPTO_HOST_MEMORY 0x00000002 #define CRYPTO_FAILED 0x00000004 #define CRYPTO_ARGUMENTS_BAD 0x00000005 #define CRYPTO_DATA_LEN_RANGE 0x0000000C #define CRYPTO_ENCRYPTED_DATA_LEN_RANGE 0x00000011 #define CRYPTO_KEY_SIZE_RANGE 0x00000013 #define CRYPTO_KEY_TYPE_INCONSISTENT 0x00000014 #define CRYPTO_MECHANISM_INVALID 0x0000001C #define CRYPTO_MECHANISM_PARAM_INVALID 0x0000001D #define CRYPTO_SIGNATURE_INVALID 0x0000002D #define CRYPTO_BUFFER_TOO_SMALL 0x00000042 #define CRYPTO_NOT_SUPPORTED 0x00000044 #define CRYPTO_INVALID_CONTEXT 0x00000047 #define CRYPTO_INVALID_MAC 0x00000048 #define CRYPTO_MECH_NOT_SUPPORTED 0x00000049 #define CRYPTO_INVALID_PROVIDER_ID 0x0000004C #define CRYPTO_BUSY 0x0000004E #define CRYPTO_UNKNOWN_PROVIDER 0x0000004F #ifdef __cplusplus } #endif #endif /* _SYS_CRYPTO_COMMON_H */