1 /* $NetBSD: cryptodev.h,v 1.25 2011/06/09 14:41:24 drochner Exp $ */ 2 /* $FreeBSD: src/sys/opencrypto/cryptodev.h,v 1.2.2.6 2003/07/02 17:04:50 sam Exp $ */ 3 /* $OpenBSD: cryptodev.h,v 1.33 2002/07/17 23:52:39 art Exp $ */ 4 5 /*- 6 * Copyright (c) 2008 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Coyote Point Systems, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 /* 35 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 36 * 37 * This code was written by Angelos D. Keromytis in Athens, Greece, in 38 * February 2000. Network Security Technologies Inc. (NSTI) kindly 39 * supported the development of this code. 40 * 41 * Copyright (c) 2000 Angelos D. Keromytis 42 * 43 * Permission to use, copy, and modify this software with or without fee 44 * is hereby granted, provided that this entire notice is included in 45 * all source code copies of any software which is or includes a copy or 46 * modification of this software. 47 * 48 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 49 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 50 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 51 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 52 * PURPOSE. 53 * 54 * Copyright (c) 2001 Theo de Raadt 55 * 56 * Redistribution and use in source and binary forms, with or without 57 * modification, are permitted provided that the following conditions 58 * are met: 59 * 60 * 1. Redistributions of source code must retain the above copyright 61 * notice, this list of conditions and the following disclaimer. 62 * 2. Redistributions in binary form must reproduce the above copyright 63 * notice, this list of conditions and the following disclaimer in the 64 * documentation and/or other materials provided with the distribution. 65 * 3. The name of the author may not be used to endorse or promote products 66 * derived from this software without specific prior written permission. 67 * 68 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 69 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 70 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 71 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 72 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 73 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 74 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 75 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 76 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 77 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 78 * 79 * Effort sponsored in part by the Defense Advanced Research Projects 80 * Agency (DARPA) and Air Force Research Laboratory, Air Force 81 * Materiel Command, USAF, under agreement number F30602-01-2-0537. 82 * 83 */ 84 85 #ifndef _CRYPTO_CRYPTO_H_ 86 #define _CRYPTO_CRYPTO_H_ 87 88 #include <sys/ioccom.h> 89 #include <sys/condvar.h> 90 91 /* Some initial values */ 92 #define CRYPTO_DRIVERS_INITIAL 4 93 #define CRYPTO_SW_SESSIONS 32 94 95 /* HMAC values */ 96 #define HMAC_BLOCK_LEN 64 /* for compatibility */ 97 #define HMAC_IPAD_VAL 0x36 98 #define HMAC_OPAD_VAL 0x5C 99 100 /* Encryption algorithm block sizes */ 101 #define DES_BLOCK_LEN 8 102 #define DES3_BLOCK_LEN 8 103 #define BLOWFISH_BLOCK_LEN 8 104 #define SKIPJACK_BLOCK_LEN 8 105 #define CAST128_BLOCK_LEN 8 106 #define RIJNDAEL128_BLOCK_LEN 16 107 #define EALG_MAX_BLOCK_LEN 16 /* Keep this updated */ 108 109 /* Maximum hash algorithm result length */ 110 #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 111 112 #define CRYPTO_ALGORITHM_MIN 1 113 #define CRYPTO_DES_CBC 1 114 #define CRYPTO_3DES_CBC 2 115 #define CRYPTO_BLF_CBC 3 116 #define CRYPTO_CAST_CBC 4 117 #define CRYPTO_SKIPJACK_CBC 5 118 #define CRYPTO_MD5_HMAC 6 119 #define CRYPTO_SHA1_HMAC 7 120 #define CRYPTO_RIPEMD160_HMAC 8 121 #define CRYPTO_MD5_KPDK 9 122 #define CRYPTO_SHA1_KPDK 10 123 #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 124 #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 125 #define CRYPTO_ARC4 12 126 #define CRYPTO_MD5 13 127 #define CRYPTO_SHA1 14 128 #define CRYPTO_SHA2_256_HMAC 15 129 #define CRYPTO_SHA2_HMAC CRYPTO_SHA2_256_HMAC /* for compatibility */ 130 #define CRYPTO_NULL_HMAC 16 131 #define CRYPTO_NULL_CBC 17 132 #define CRYPTO_DEFLATE_COMP 18 /* Deflate compression algorithm */ 133 #define CRYPTO_MD5_HMAC_96 19 134 #define CRYPTO_SHA1_HMAC_96 20 135 #define CRYPTO_RIPEMD160_HMAC_96 21 136 #define CRYPTO_GZIP_COMP 22 /* gzip compression algorithm */ 137 #define CRYPTO_DEFLATE_COMP_NOGROW 23 /* Deflate, fail if not compressible */ 138 #define CRYPTO_SHA2_384_HMAC 24 139 #define CRYPTO_SHA2_512_HMAC 25 140 #define CRYPTO_CAMELLIA_CBC 26 141 #define CRYPTO_AES_CTR 27 142 #define CRYPTO_AES_XCBC_MAC_96 28 143 #define CRYPTO_AES_GCM_16 29 144 #define CRYPTO_AES_128_GMAC 30 145 #define CRYPTO_AES_192_GMAC 31 146 #define CRYPTO_AES_256_GMAC 32 147 #define CRYPTO_AES_GMAC 33 148 #define CRYPTO_ALGORITHM_MAX 33 /* Keep updated - see below */ 149 150 /* Algorithm flags */ 151 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 152 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 153 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 154 155 struct session_op { 156 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 157 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 158 u_int32_t comp_alg; /* ie. CRYPTO_GZIP_COMP */ 159 160 u_int32_t keylen; /* cipher key */ 161 void * key; 162 int mackeylen; /* mac key */ 163 void * mackey; 164 165 u_int32_t ses; /* returns: session # */ 166 }; 167 168 /* to support multiple session creation */ 169 170 struct session_n_op { 171 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 172 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 173 u_int32_t comp_alg; /* ie. CRYPTO_GZIP_COMP */ 174 175 u_int32_t keylen; /* cipher key */ 176 void * key; 177 int mackeylen; /* mac key */ 178 void * mackey; 179 180 u_int32_t ses; /* returns: session # */ 181 int status; 182 }; 183 184 struct crypt_op { 185 u_int32_t ses; 186 u_int16_t op; /* i.e. COP_ENCRYPT */ 187 #define COP_ENCRYPT 1 188 #define COP_DECRYPT 2 189 #define COP_COMP 3 190 #define COP_DECOMP 4 191 u_int16_t flags; 192 #define COP_F_BATCH 0x0008 /* Dispatch as quickly as possible */ 193 u_int len; /* src len */ 194 void * src, *dst; /* become iov[] inside kernel */ 195 void * mac; /* must be big enough for chosen MAC */ 196 void * iv; 197 u_int dst_len; /* dst len if not 0 */ 198 }; 199 200 /* to support multiple session creation */ 201 /* 202 * 203 * The reqid field is filled when the operation has 204 * been accepted and started, and can be used to later retrieve 205 * the operation results via CIOCNCRYPTRET or identify the 206 * request in the completion list returned by CIOCNCRYPTRETM. 207 * 208 * The opaque pointer can be set arbitrarily by the user 209 * and it is passed back in the crypt_result structure 210 * when the request completes. This field can be used for example 211 * to track context for the request and avoid lookups in the 212 * user application. 213 */ 214 215 struct crypt_n_op { 216 u_int32_t ses; 217 u_int16_t op; /* i.e. COP_ENCRYPT */ 218 #define COP_ENCRYPT 1 219 #define COP_DECRYPT 2 220 u_int16_t flags; 221 #define COP_F_BATCH 0x0008 /* Dispatch as quickly as possible */ 222 #define COP_F_MORE 0x0010 /* more data to follow */ 223 u_int len; /* src len */ 224 225 u_int32_t reqid; /* request id */ 226 int status; /* status of request -accepted or not */ 227 void *opaque; /* opaque pointer returned to user */ 228 u_int32_t keylen; /* cipher key - optional */ 229 void * key; 230 u_int32_t mackeylen; /* also optional */ 231 void * mackey; 232 233 void * src, *dst; /* become iov[] inside kernel */ 234 void * mac; /* must be big enough for chosen MAC */ 235 void * iv; 236 u_int dst_len; /* dst len if not 0 */ 237 }; 238 239 /* CIOCNCRYPTM ioctl argument, supporting one or more asynchronous 240 * crypt_n_op operations. 241 * Each crypt_n_op will receive a request id which can be used to check its 242 * status via CIOCNCRYPTRET, or to watch for its completion in the list 243 * obtained via CIOCNCRYPTRETM. 244 */ 245 struct crypt_mop { 246 size_t count; /* how many */ 247 struct crypt_n_op * reqs; /* where to get them */ 248 }; 249 250 struct crypt_sfop { 251 size_t count; 252 u_int32_t *sesid; 253 }; 254 255 struct crypt_sgop { 256 size_t count; 257 struct session_n_op * sessions; 258 }; 259 260 #define CRYPTO_MAX_MAC_LEN 20 261 262 /* bignum parameter, in packed bytes, ... */ 263 struct crparam { 264 void * crp_p; 265 u_int crp_nbits; 266 }; 267 268 #define CRK_MAXPARAM 8 269 270 struct crypt_kop { 271 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 272 u_int crk_status; /* return status */ 273 u_short crk_iparams; /* # of input parameters */ 274 u_short crk_oparams; /* # of output parameters */ 275 u_int crk_pad1; 276 struct crparam crk_param[CRK_MAXPARAM]; 277 }; 278 279 /* 280 * Used with the CIOCNFKEYM ioctl. 281 * 282 * This structure allows the OCF to return a request id 283 * for each of the kop operations specified in the CIOCNFKEYM call. 284 * 285 * The crk_opaque pointer can be arbitrarily set by the user 286 * and it is passed back in the crypt_result structure 287 * when the request completes. This field can be used for example 288 * to track context for the request and avoid lookups in the 289 * user application. 290 */ 291 struct crypt_n_kop { 292 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 293 u_int crk_status; /* return status */ 294 u_short crk_iparams; /* # of input parameters */ 295 u_short crk_oparams; /* # of output parameters */ 296 u_int32_t crk_reqid; /* request id */ 297 struct crparam crk_param[CRK_MAXPARAM]; 298 void *crk_opaque; /* opaque pointer returned to user */ 299 }; 300 301 struct crypt_mkop { 302 size_t count; /* how many */ 303 struct crypt_n_kop * reqs; /* where to get them */ 304 }; 305 306 /* Asynchronous key or crypto result. 307 * Note that the status will be set in the crypt_result structure, 308 * not in the original crypt_kop structure (crk_status). 309 */ 310 struct crypt_result { 311 u_int32_t reqid; /* request id */ 312 u_int32_t status; /* status of request: 0 if successful */ 313 void * opaque; /* Opaque pointer from the user, passed along */ 314 }; 315 316 struct cryptret { 317 size_t count; /* space for how many */ 318 struct crypt_result * results; /* where to put them */ 319 }; 320 321 322 /* Assymetric key operations */ 323 #define CRK_ALGORITM_MIN 0 324 #define CRK_MOD_EXP 0 325 #define CRK_MOD_EXP_CRT 1 326 #define CRK_DSA_SIGN 2 327 #define CRK_DSA_VERIFY 3 328 #define CRK_DH_COMPUTE_KEY 4 329 #define CRK_MOD_ADD 5 330 #define CRK_MOD_ADDINV 6 331 #define CRK_MOD_SUB 7 332 #define CRK_MOD_MULT 8 333 #define CRK_MOD_MULTINV 9 334 #define CRK_MOD 10 335 #define CRK_ALGORITHM_MAX 10 /* Keep updated - see below */ 336 337 #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 338 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 339 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 340 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 341 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 342 #define CRF_MOD_ADD (1 << CRK_MOD_ADD) 343 #define CRF_MOD_ADDINV (1 << CRK_MOD_ADDINV) 344 #define CRF_MOD_SUB (1 << CRK_MOD_SUB) 345 #define CRF_MOD_MULT (1 << CRK_MOD_MULT) 346 #define CRF_MOD_MULTINV (1 << CRK_MOD_MULTINV) 347 #define CRF_MOD (1 << CRK_MOD) 348 349 /* 350 * A large comment here once held descriptions of the ioctl 351 * requests implemented by the device. This text has been moved 352 * to the crypto(4) manual page and, later, removed from this file 353 * as it was always a step behind the times. 354 */ 355 356 /* 357 * done against open of /dev/crypto, to get a cloned descriptor. 358 * Please use F_SETFD against the cloned descriptor. But this ioctl 359 * is obsolete (the device now clones): please, just don't use it. 360 */ 361 #define CRIOGET _IOWR('c', 100, u_int32_t) 362 363 /* the following are done against the cloned descriptor */ 364 #define CIOCFSESSION _IOW('c', 102, u_int32_t) 365 #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 366 #define CIOCNFKEYM _IOWR('c', 108, struct crypt_mkop) 367 #define CIOCNFSESSION _IOW('c', 109, struct crypt_sfop) 368 #define CIOCNCRYPTRETM _IOWR('c', 110, struct cryptret) 369 #define CIOCNCRYPTRET _IOWR('c', 111, struct crypt_result) 370 371 #define CIOCGSESSION _IOWR('c', 112, struct session_op) 372 #define CIOCNGSESSION _IOWR('c', 113, struct crypt_sgop) 373 #define CIOCCRYPT _IOWR('c', 114, struct crypt_op) 374 #define CIOCNCRYPTM _IOWR('c', 115, struct crypt_mop) 375 376 #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 377 378 struct cryptotstat { 379 struct timespec acc; /* total accumulated time */ 380 struct timespec min; /* max time */ 381 struct timespec max; /* max time */ 382 u_int32_t count; /* number of observations */ 383 }; 384 385 struct cryptostats { 386 u_int32_t cs_ops; /* symmetric crypto ops submitted */ 387 u_int32_t cs_errs; /* symmetric crypto ops that failed */ 388 u_int32_t cs_kops; /* asymetric/key ops submitted */ 389 u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 390 u_int32_t cs_intrs; /* crypto swi thread activations */ 391 u_int32_t cs_rets; /* crypto return thread activations */ 392 u_int32_t cs_blocks; /* symmetric op driver block */ 393 u_int32_t cs_kblocks; /* symmetric op driver block */ 394 /* 395 * When CRYPTO_TIMING is defined at compile time and the 396 * sysctl debug.crypto is set to 1, the crypto system will 397 * accumulate statistics about how long it takes to process 398 * crypto requests at various points during processing. 399 */ 400 struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 401 struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 402 struct cryptotstat cs_cb; /* crypto_done -> callback */ 403 struct cryptotstat cs_finis; /* callback -> callback return */ 404 }; 405 406 #ifdef _KERNEL 407 /* Standard initialization structure beginning */ 408 struct cryptoini { 409 int cri_alg; /* Algorithm to use */ 410 int cri_klen; /* Key length, in bits */ 411 int cri_rnd; /* Algorithm rounds, where relevant */ 412 char *cri_key; /* key to use */ 413 u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 414 struct cryptoini *cri_next; 415 }; 416 417 /* Describe boundaries of a single crypto operation */ 418 struct cryptodesc { 419 int crd_skip; /* How many bytes to ignore from start */ 420 int crd_len; /* How many bytes to process */ 421 int crd_inject; /* Where to inject results, if applicable */ 422 int crd_flags; 423 424 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 425 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 426 place, so don't copy. */ 427 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 428 #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 429 #define CRD_F_COMP 0x10 /* Set when doing compression */ 430 431 struct cryptoini CRD_INI; /* Initialization/context data */ 432 #define crd_iv CRD_INI.cri_iv 433 #define crd_key CRD_INI.cri_key 434 #define crd_rnd CRD_INI.cri_rnd 435 #define crd_alg CRD_INI.cri_alg 436 #define crd_klen CRD_INI.cri_klen 437 438 struct cryptodesc *crd_next; 439 }; 440 441 /* Structure describing complete operation */ 442 struct cryptop { 443 TAILQ_ENTRY(cryptop) crp_next; 444 u_int64_t crp_sid; /* Session ID */ 445 446 int crp_ilen; /* Input data total length */ 447 int crp_olen; /* Result total length */ 448 449 int crp_etype; /* 450 * Error type (zero means no error). 451 * All error codes except EAGAIN 452 * indicate possible data corruption (as in, 453 * the data have been touched). On all 454 * errors, the crp_sid may have changed 455 * (reset to a new one), so the caller 456 * should always check and use the new 457 * value on future requests. 458 */ 459 int crp_flags; /* Note: must hold mutext to modify */ 460 461 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 462 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 463 #define CRYPTO_F_REL 0x0004 /* Must return data in same place */ 464 #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible possible */ 465 #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 466 #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 467 #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 468 #define CRYPTO_F_ONRETQ 0x0080 /* Request is on return queue */ 469 #define CRYPTO_F_USER 0x0100 /* Request is in user context */ 470 #define CRYPTO_F_MORE 0x0200 /* more data to follow */ 471 472 void * crp_buf; /* Data to be processed */ 473 void * crp_opaque; /* Opaque pointer, passed along */ 474 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 475 476 int (*crp_callback)(struct cryptop *); /* Callback function */ 477 478 void * crp_mac; 479 480 /* 481 * everything below is private to crypto(4) 482 */ 483 u_int32_t crp_reqid; /* request id */ 484 void * crp_usropaque; /* Opaque pointer from user, passed along */ 485 struct timespec crp_tstamp; /* performance time stamp */ 486 kcondvar_t crp_cv; 487 struct fcrypt *fcrp; 488 void * dst; 489 void * mac; 490 u_int len; 491 u_char tmp_iv[EALG_MAX_BLOCK_LEN]; 492 u_char tmp_mac[CRYPTO_MAX_MAC_LEN]; 493 494 struct iovec iovec[1]; 495 struct uio uio; 496 uint32_t magic; 497 }; 498 499 #define CRYPTO_BUF_CONTIG 0x0 500 #define CRYPTO_BUF_IOV 0x1 501 #define CRYPTO_BUF_MBUF 0x2 502 503 #define CRYPTO_OP_DECRYPT 0x0 504 #define CRYPTO_OP_ENCRYPT 0x1 505 506 /* 507 * Hints passed to process methods. 508 */ 509 #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 510 511 struct cryptkop { 512 TAILQ_ENTRY(cryptkop) krp_next; 513 514 u_int32_t krp_reqid; /* request id */ 515 void * krp_usropaque; /* Opaque pointer from user, passed along */ 516 517 u_int krp_op; /* ie. CRK_MOD_EXP or other */ 518 u_int krp_status; /* return status */ 519 u_short krp_iparams; /* # of input parameters */ 520 u_short krp_oparams; /* # of output parameters */ 521 u_int32_t krp_hid; 522 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 523 int (*krp_callback)(struct cryptkop *); 524 int krp_flags; /* same values as crp_flags */ 525 kcondvar_t krp_cv; 526 struct fcrypt *fcrp; 527 struct crparam crk_param[CRK_MAXPARAM]; 528 }; 529 530 /* Crypto capabilities structure */ 531 struct cryptocap { 532 u_int32_t cc_sessions; 533 534 /* 535 * Largest possible operator length (in bits) for each type of 536 * encryption algorithm. 537 */ 538 u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1]; 539 540 u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1]; 541 542 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1]; 543 544 u_int8_t cc_flags; 545 u_int8_t cc_qblocked; /* symmetric q blocked */ 546 u_int8_t cc_kqblocked; /* asymmetric q blocked */ 547 #define CRYPTOCAP_F_CLEANUP 0x01 /* needs resource cleanup */ 548 #define CRYPTOCAP_F_SOFTWARE 0x02 /* software implementation */ 549 #define CRYPTOCAP_F_SYNC 0x04 /* operates synchronously */ 550 551 void *cc_arg; /* callback argument */ 552 int (*cc_newsession)(void*, u_int32_t*, struct cryptoini*); 553 int (*cc_process) (void*, struct cryptop *, int); 554 int (*cc_freesession) (void*, u_int64_t); 555 void *cc_karg; /* callback argument */ 556 int (*cc_kprocess) (void*, struct cryptkop *, int); 557 }; 558 559 /* 560 * Session ids are 64 bits. The lower 32 bits contain a "local id" which 561 * is a driver-private session identifier. The upper 32 bits contain a 562 * "hardware id" used by the core crypto code to identify the driver and 563 * a copy of the driver's capabilities that can be used by client code to 564 * optimize operation. 565 */ 566 #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0xffffff) 567 #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 56) & 0xff) 568 #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff) 569 570 MALLOC_DECLARE(M_CRYPTO_DATA); 571 572 extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard); 573 extern int crypto_freesession(u_int64_t sid); 574 extern int32_t crypto_get_driverid(u_int32_t flags); 575 extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 576 u_int32_t flags, 577 int (*newses)(void*, u_int32_t*, struct cryptoini*), 578 int (*freeses)(void*, u_int64_t), 579 int (*process)(void*, struct cryptop *, int), 580 void *arg); 581 extern int crypto_kregister(u_int32_t, int, u_int32_t, 582 int (*)(void*, struct cryptkop *, int), 583 void *arg); 584 extern int crypto_unregister(u_int32_t driverid, int alg); 585 extern int crypto_unregister_all(u_int32_t driverid); 586 extern int crypto_dispatch(struct cryptop *crp); 587 extern int crypto_kdispatch(struct cryptkop *); 588 #define CRYPTO_SYMQ 0x1 589 #define CRYPTO_ASYMQ 0x2 590 extern int crypto_unblock(u_int32_t, int); 591 extern void crypto_done(struct cryptop *crp); 592 extern void crypto_kdone(struct cryptkop *); 593 extern int crypto_getfeat(int *); 594 595 void cuio_copydata(struct uio *, int, int, void *); 596 void cuio_copyback(struct uio *, int, int, void *); 597 int cuio_apply(struct uio *, int, int, 598 int (*f)(void *, void *, unsigned int), void *); 599 600 extern int crypto_ret_q_remove(struct cryptop *); 601 extern int crypto_ret_kq_remove(struct cryptkop *); 602 extern void crypto_freereq(struct cryptop *crp); 603 extern struct cryptop *crypto_getreq(int num); 604 605 extern int crypto_usercrypto; /* userland may do crypto requests */ 606 extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 607 extern int crypto_devallowsoft; /* only use hardware crypto */ 608 609 /* 610 * Asymmetric operations are allocated in cryptodev.c but can be 611 * freed in crypto.c. 612 */ 613 extern struct pool cryptkop_pool; 614 615 /* 616 * Mutual exclusion and its unwelcome friends. 617 */ 618 619 extern kmutex_t crypto_mtx; 620 621 /* 622 * initialize the crypto framework subsystem (not the pseudo-device). 623 * This must be called very early in boot, so the framework is ready 624 * to handle registration requests when crpto hardware is autoconfigured. 625 * (This declaration doesnt really belong here but there's no header 626 * for the raw framework.) 627 */ 628 void crypto_init(void); 629 630 /* 631 * Crypto-related utility routines used mainly by drivers. 632 * 633 * XXX these don't really belong here; but for now they're 634 * kept apart from the rest of the system. 635 */ 636 struct uio; 637 extern void cuio_copydata(struct uio* uio, int off, int len, void *cp); 638 extern void cuio_copyback(struct uio* uio, int off, int len, void *cp); 639 extern int cuio_getptr(struct uio *, int loc, int *off); 640 641 #ifdef CRYPTO_DEBUG /* yuck, netipsec defines these differently */ 642 #ifndef DPRINTF 643 #define DPRINTF(a) uprintf a 644 #endif 645 #ifndef DCPRINTF 646 #define DCPRINTF(a) printf a 647 #endif 648 #else 649 #ifndef DPRINTF 650 #define DPRINTF(a) 651 #endif 652 #ifndef DCPRINTF 653 #define DCPRINTF(a) 654 #endif 655 #endif 656 657 #endif /* _KERNEL */ 658 #endif /* _CRYPTO_CRYPTO_H_ */ 659