1 /* $OpenBSD: cryptodev.h,v 1.55 2010/12/16 16:56:08 jsg Exp $ */ 2 3 /* 4 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 5 * 6 * This code was written by Angelos D. Keromytis in Athens, Greece, in 7 * February 2000. Network Security Technologies Inc. (NSTI) kindly 8 * supported the development of this code. 9 * 10 * Copyright (c) 2000 Angelos D. Keromytis 11 * 12 * Permission to use, copy, and modify this software with or without fee 13 * is hereby granted, provided that this entire notice is included in 14 * all source code copies of any software which is or includes a copy or 15 * modification of this software. 16 * 17 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 18 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 19 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 20 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 21 * PURPOSE. 22 * 23 * Copyright (c) 2001 Theo de Raadt 24 * 25 * Redistribution and use in source and binary forms, with or without 26 * modification, are permitted provided that the following conditions 27 * are met: 28 * 29 * 1. Redistributions of source code must retain the above copyright 30 * notice, this list of conditions and the following disclaimer. 31 * 2. Redistributions in binary form must reproduce the above copyright 32 * notice, this list of conditions and the following disclaimer in the 33 * documentation and/or other materials provided with the distribution. 34 * 35 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 36 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 38 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 39 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 40 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 41 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 42 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 43 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 44 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 45 * 46 * Effort sponsored in part by the Defense Advanced Research Projects 47 * Agency (DARPA) and Air Force Research Laboratory, Air Force 48 * Materiel Command, USAF, under agreement number F30602-01-2-0537. 49 * 50 */ 51 52 #ifndef _CRYPTO_CRYPTO_H_ 53 #define _CRYPTO_CRYPTO_H_ 54 55 #include <sys/ioccom.h> 56 #include <sys/workq.h> 57 58 /* Some initial values */ 59 #define CRYPTO_DRIVERS_INITIAL 4 60 #define CRYPTO_SW_SESSIONS 32 61 62 /* HMAC values */ 63 #define HMAC_MD5_BLOCK_LEN 64 64 #define HMAC_SHA1_BLOCK_LEN 64 65 #define HMAC_RIPEMD160_BLOCK_LEN 64 66 #define HMAC_SHA2_256_BLOCK_LEN 64 67 #define HMAC_SHA2_384_BLOCK_LEN 128 68 #define HMAC_SHA2_512_BLOCK_LEN 128 69 #define HMAC_MAX_BLOCK_LEN HMAC_SHA2_512_BLOCK_LEN /* keep in sync */ 70 #define HMAC_IPAD_VAL 0x36 71 #define HMAC_OPAD_VAL 0x5C 72 73 /* Encryption algorithm block sizes */ 74 #define DES_BLOCK_LEN 8 75 #define DES3_BLOCK_LEN 8 76 #define BLOWFISH_BLOCK_LEN 8 77 #define CAST128_BLOCK_LEN 8 78 #define RIJNDAEL128_BLOCK_LEN 16 79 #define EALG_MAX_BLOCK_LEN 16 /* Keep this updated */ 80 81 /* Maximum hash algorithm result length */ 82 #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 83 84 #define CRYPTO_DES_CBC 1 85 #define CRYPTO_3DES_CBC 2 86 #define CRYPTO_BLF_CBC 3 87 #define CRYPTO_CAST_CBC 4 88 #define CRYPTO_MD5_HMAC 6 89 #define CRYPTO_SHA1_HMAC 7 90 #define CRYPTO_RIPEMD160_HMAC 8 91 #define CRYPTO_MD5_KPDK 9 92 #define CRYPTO_SHA1_KPDK 10 93 #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 94 #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 95 #define CRYPTO_ARC4 12 96 #define CRYPTO_MD5 13 97 #define CRYPTO_SHA1 14 98 #define CRYPTO_DEFLATE_COMP 15 /* Deflate compression algorithm */ 99 #define CRYPTO_NULL 16 100 #define CRYPTO_LZS_COMP 17 /* LZS compression algorithm */ 101 #define CRYPTO_SHA2_256_HMAC 18 102 #define CRYPTO_SHA2_384_HMAC 19 103 #define CRYPTO_SHA2_512_HMAC 20 104 #define CRYPTO_AES_CTR 21 105 #define CRYPTO_AES_XTS 22 106 #define CRYPTO_AES_GCM_16 23 107 #define CRYPTO_AES_128_GMAC 24 108 #define CRYPTO_AES_192_GMAC 25 109 #define CRYPTO_AES_256_GMAC 26 110 #define CRYPTO_AES_GMAC 27 111 #define CRYPTO_ALGORITHM_MAX 27 /* Keep updated */ 112 113 /* Algorithm flags */ 114 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 115 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 116 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 117 118 /* Standard initialization structure beginning */ 119 struct cryptoini { 120 int cri_alg; /* Algorithm to use */ 121 int cri_klen; /* Key length, in bits */ 122 int cri_rnd; /* Algorithm rounds, where relevant */ 123 caddr_t cri_key; /* key to use */ 124 u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 125 struct cryptoini *cri_next; 126 }; 127 128 /* Describe boundaries of a single crypto operation */ 129 struct cryptodesc { 130 int crd_skip; /* How many bytes to ignore from start */ 131 int crd_len; /* How many bytes to process */ 132 int crd_inject; /* Where to inject results, if applicable */ 133 int crd_flags; 134 135 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 136 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 137 place, so don't copy. */ 138 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 139 #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 140 #define CRD_F_COMP 0x10 /* Set when doing compression */ 141 142 struct cryptoini CRD_INI; /* Initialization/context data */ 143 #define crd_iv CRD_INI.cri_iv 144 #define crd_key CRD_INI.cri_key 145 #define crd_rnd CRD_INI.cri_rnd 146 #define crd_alg CRD_INI.cri_alg 147 #define crd_klen CRD_INI.cri_klen 148 149 struct cryptodesc *crd_next; 150 }; 151 152 /* Structure describing complete operation */ 153 struct cryptop { 154 struct workq_task crp_wqt; 155 156 u_int64_t crp_sid; /* Session ID */ 157 int crp_ilen; /* Input data total length */ 158 int crp_olen; /* Result total length */ 159 int crp_alloctype; /* Type of buf to allocate if needed */ 160 161 int crp_etype; /* 162 * Error type (zero means no error). 163 * All error codes except EAGAIN 164 * indicate possible data corruption (as in, 165 * the data have been touched). On all 166 * errors, the crp_sid may have changed 167 * (reset to a new one), so the caller 168 * should always check and use the new 169 * value on future requests. 170 */ 171 int crp_flags; 172 173 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains, otherwise contig */ 174 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 175 #define CRYPTO_F_REL 0x0004 /* Must return data in same place */ 176 #define CRYPTO_F_NOQUEUE 0x0008 /* Don't use crypto queue/thread */ 177 #define CRYPTO_F_DONE 0x0010 /* request completed */ 178 179 void *crp_buf; /* Data to be processed */ 180 void *crp_opaque; /* Opaque pointer, passed along */ 181 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 182 183 int (*crp_callback)(struct cryptop *); /* Callback function */ 184 185 caddr_t crp_mac; 186 }; 187 188 #define CRYPTO_BUF_IOV 0x1 189 #define CRYPTO_BUF_MBUF 0x2 190 191 #define CRYPTO_OP_DECRYPT 0x0 192 #define CRYPTO_OP_ENCRYPT 0x1 193 194 /* bignum parameter, in packed bytes, ... */ 195 struct crparam { 196 caddr_t crp_p; 197 u_int crp_nbits; 198 }; 199 200 #define CRK_MAXPARAM 8 201 202 struct crypt_kop { 203 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 204 u_int crk_status; /* return status */ 205 u_short crk_iparams; /* # of input parameters */ 206 u_short crk_oparams; /* # of output parameters */ 207 u_int crk_pad1; 208 struct crparam crk_param[CRK_MAXPARAM]; 209 }; 210 #define CRK_MOD_EXP 0 211 #define CRK_MOD_EXP_CRT 1 212 #define CRK_DSA_SIGN 2 213 #define CRK_DSA_VERIFY 3 214 #define CRK_DH_COMPUTE_KEY 4 215 #define CRK_ALGORITHM_MAX 4 /* Keep updated */ 216 217 #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 218 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 219 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 220 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 221 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 222 223 struct cryptkop { 224 struct workq_task krp_wqt; 225 226 u_int krp_op; /* ie. CRK_MOD_EXP or other */ 227 u_int krp_status; /* return status */ 228 u_short krp_iparams; /* # of input parameters */ 229 u_short krp_oparams; /* # of output parameters */ 230 u_int32_t krp_hid; 231 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 232 int (*krp_callback)(struct cryptkop *); 233 }; 234 235 /* Crypto capabilities structure */ 236 struct cryptocap { 237 u_int64_t cc_operations; /* Counter of how many ops done */ 238 u_int64_t cc_bytes; /* Counter of how many bytes done */ 239 u_int64_t cc_koperations; /* How many PK ops done */ 240 241 u_int32_t cc_sessions; /* How many sessions allocated */ 242 243 /* Symmetric/hash algorithms supported */ 244 int cc_alg[CRYPTO_ALGORITHM_MAX + 1]; 245 246 /* Asymmetric algorithms supported */ 247 int cc_kalg[CRK_ALGORITHM_MAX + 1]; 248 249 int cc_queued; /* Operations queued */ 250 251 u_int8_t cc_flags; 252 #define CRYPTOCAP_F_CLEANUP 0x01 253 #define CRYPTOCAP_F_SOFTWARE 0x02 254 #define CRYPTOCAP_F_ENCRYPT_MAC 0x04 /* Can do encrypt-then-MAC (IPsec) */ 255 #define CRYPTOCAP_F_MAC_ENCRYPT 0x08 /* Can do MAC-then-encrypt (TLS) */ 256 257 int (*cc_newsession) (u_int32_t *, struct cryptoini *); 258 int (*cc_process) (struct cryptop *); 259 int (*cc_freesession) (u_int64_t); 260 int (*cc_kprocess) (struct cryptkop *); 261 }; 262 263 /* 264 * ioctl parameter to request creation of a session. 265 */ 266 struct session_op { 267 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 268 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 269 270 u_int32_t keylen; /* cipher key */ 271 caddr_t key; 272 int mackeylen; /* mac key */ 273 caddr_t mackey; 274 275 u_int32_t ses; /* returns: session # */ 276 }; 277 278 /* 279 * ioctl parameter to request a crypt/decrypt operation against a session. 280 */ 281 struct crypt_op { 282 u_int32_t ses; 283 u_int16_t op; /* ie. COP_ENCRYPT */ 284 #define COP_ENCRYPT 1 285 #define COP_DECRYPT 2 286 u_int16_t flags; /* always 0 */ 287 288 u_int len; 289 caddr_t src, dst; /* become iov[] inside kernel */ 290 caddr_t mac; /* must be big enough for chosen MAC */ 291 caddr_t iv; 292 }; 293 294 #define CRYPTO_MAX_MAC_LEN 20 295 296 /* 297 * done against open of /dev/crypto, to get a cloned descriptor. 298 * Please use F_SETFD against the cloned descriptor. 299 */ 300 #define CRIOGET _IOWR('c', 100, u_int32_t) 301 302 /* the following are done against the cloned descriptor */ 303 #define CIOCGSESSION _IOWR('c', 101, struct session_op) 304 #define CIOCFSESSION _IOW('c', 102, u_int32_t) 305 #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 306 #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 307 308 #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 309 310 #ifdef _KERNEL 311 int crypto_newsession(u_int64_t *, struct cryptoini *, int); 312 int crypto_freesession(u_int64_t); 313 int crypto_dispatch(struct cryptop *); 314 int crypto_kdispatch(struct cryptkop *); 315 int crypto_register(u_int32_t, int *, 316 int (*)(u_int32_t *, struct cryptoini *), int (*)(u_int64_t), 317 int (*)(struct cryptop *)); 318 int crypto_kregister(u_int32_t, int *, int (*)(struct cryptkop *)); 319 int crypto_unregister(u_int32_t, int); 320 int32_t crypto_get_driverid(u_int8_t); 321 int crypto_invoke(struct cryptop *); 322 int crypto_kinvoke(struct cryptkop *); 323 void crypto_done(struct cryptop *); 324 void crypto_kdone(struct cryptkop *); 325 int crypto_getfeat(int *); 326 327 void cuio_copydata(struct uio *, int, int, caddr_t); 328 void cuio_copyback(struct uio *, int, int, const void *); 329 int cuio_getptr(struct uio *, int, int *); 330 int cuio_apply(struct uio *, int, int, 331 int (*f)(caddr_t, caddr_t, unsigned int), caddr_t); 332 333 struct cryptop *crypto_getreq(int); 334 void crypto_freereq(struct cryptop *); 335 #endif /* _KERNEL */ 336 #endif /* _CRYPTO_CRYPTO_H_ */ 337