1 /* $NetBSD: cryptodev.h,v 1.19 2011/02/25 20:13:10 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_ALGORITHM_MAX 26 /* Keep updated - see below */ 141 142 /* Algorithm flags */ 143 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 144 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 145 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 146 147 struct session_op { 148 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 149 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 150 u_int32_t comp_alg; /* ie. CRYPTO_GZIP_COMP */ 151 152 u_int32_t keylen; /* cipher key */ 153 void * key; 154 int mackeylen; /* mac key */ 155 void * mackey; 156 157 u_int32_t ses; /* returns: session # */ 158 }; 159 160 /* to support multiple session creation */ 161 162 struct session_n_op { 163 u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ 164 u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ 165 u_int32_t comp_alg; /* ie. CRYPTO_GZIP_COMP */ 166 167 u_int32_t keylen; /* cipher key */ 168 void * key; 169 int mackeylen; /* mac key */ 170 void * mackey; 171 172 u_int32_t ses; /* returns: session # */ 173 int status; 174 }; 175 176 struct crypt_op { 177 u_int32_t ses; 178 u_int16_t op; /* i.e. COP_ENCRYPT */ 179 #define COP_ENCRYPT 1 180 #define COP_DECRYPT 2 181 #define COP_COMP 3 182 #define COP_DECOMP 4 183 u_int16_t flags; 184 #define COP_F_BATCH 0x0008 /* Dispatch as quickly as possible */ 185 u_int len; /* src len */ 186 void * src, *dst; /* become iov[] inside kernel */ 187 void * mac; /* must be big enough for chosen MAC */ 188 void * iv; 189 u_int dst_len; /* dst len if not 0 */ 190 }; 191 192 /* to support multiple session creation */ 193 /* 194 * 195 * The reqid field is filled when the operation has 196 * been accepted and started, and can be used to later retrieve 197 * the operation results via CIOCNCRYPTRET or identify the 198 * request in the completion list returned by CIOCNCRYPTRETM. 199 * 200 * The opaque pointer can be set arbitrarily by the user 201 * and it is passed back in the crypt_result structure 202 * when the request completes. This field can be used for example 203 * to track context for the request and avoid lookups in the 204 * user application. 205 */ 206 207 struct crypt_n_op { 208 u_int32_t ses; 209 u_int16_t op; /* i.e. COP_ENCRYPT */ 210 #define COP_ENCRYPT 1 211 #define COP_DECRYPT 2 212 u_int16_t flags; 213 #define COP_F_BATCH 0x0008 /* Dispatch as quickly as possible */ 214 #define COP_F_MORE 0x0010 /* more data to follow */ 215 u_int len; /* src len */ 216 217 u_int32_t reqid; /* request id */ 218 int status; /* status of request -accepted or not */ 219 void *opaque; /* opaque pointer returned to user */ 220 u_int32_t keylen; /* cipher key - optional */ 221 void * key; 222 u_int32_t mackeylen; /* also optional */ 223 void * mackey; 224 225 void * src, *dst; /* become iov[] inside kernel */ 226 void * mac; /* must be big enough for chosen MAC */ 227 void * iv; 228 u_int dst_len; /* dst len if not 0 */ 229 }; 230 231 /* CIOCNCRYPTM ioctl argument, supporting one or more asynchronous 232 * crypt_n_op operations. 233 * Each crypt_n_op will receive a request id which can be used to check its 234 * status via CIOCNCRYPTRET, or to watch for its completion in the list 235 * obtained via CIOCNCRYPTRETM. 236 */ 237 struct crypt_mop { 238 size_t count; /* how many */ 239 struct crypt_n_op * reqs; /* where to get them */ 240 }; 241 242 struct crypt_sfop { 243 size_t count; 244 u_int32_t *sesid; 245 }; 246 247 struct crypt_sgop { 248 size_t count; 249 struct session_n_op * sessions; 250 }; 251 252 #define CRYPTO_MAX_MAC_LEN 20 253 254 /* bignum parameter, in packed bytes, ... */ 255 struct crparam { 256 void * crp_p; 257 u_int crp_nbits; 258 }; 259 260 #define CRK_MAXPARAM 8 261 262 struct crypt_kop { 263 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 264 u_int crk_status; /* return status */ 265 u_short crk_iparams; /* # of input parameters */ 266 u_short crk_oparams; /* # of output parameters */ 267 u_int crk_pad1; 268 struct crparam crk_param[CRK_MAXPARAM]; 269 }; 270 271 /* 272 * Used with the CIOCNFKEYM ioctl. 273 * 274 * This structure allows the OCF to return a request id 275 * for each of the kop operations specified in the CIOCNFKEYM call. 276 * 277 * The crk_opaque pointer can be arbitrarily set by the user 278 * and it is passed back in the crypt_result structure 279 * when the request completes. This field can be used for example 280 * to track context for the request and avoid lookups in the 281 * user application. 282 */ 283 struct crypt_n_kop { 284 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 285 u_int crk_status; /* return status */ 286 u_short crk_iparams; /* # of input parameters */ 287 u_short crk_oparams; /* # of output parameters */ 288 u_int32_t crk_reqid; /* request id */ 289 struct crparam crk_param[CRK_MAXPARAM]; 290 void *crk_opaque; /* opaque pointer returned to user */ 291 }; 292 293 struct crypt_mkop { 294 size_t count; /* how many */ 295 struct crypt_n_kop * reqs; /* where to get them */ 296 }; 297 298 /* Asynchronous key or crypto result. 299 * Note that the status will be set in the crypt_result structure, 300 * not in the original crypt_kop structure (crk_status). 301 */ 302 struct crypt_result { 303 u_int32_t reqid; /* request id */ 304 u_int32_t status; /* status of request: 0 if successful */ 305 void * opaque; /* Opaque pointer from the user, passed along */ 306 }; 307 308 struct cryptret { 309 size_t count; /* space for how many */ 310 struct crypt_result * results; /* where to put them */ 311 }; 312 313 314 /* Assymetric key operations */ 315 #define CRK_ALGORITM_MIN 0 316 #define CRK_MOD_EXP 0 317 #define CRK_MOD_EXP_CRT 1 318 #define CRK_DSA_SIGN 2 319 #define CRK_DSA_VERIFY 3 320 #define CRK_DH_COMPUTE_KEY 4 321 #define CRK_MOD_ADD 5 322 #define CRK_MOD_ADDINV 6 323 #define CRK_MOD_SUB 7 324 #define CRK_MOD_MULT 8 325 #define CRK_MOD_MULTINV 9 326 #define CRK_MOD 10 327 #define CRK_ALGORITHM_MAX 10 /* Keep updated - see below */ 328 329 #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 330 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 331 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 332 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 333 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 334 #define CRF_MOD_ADD (1 << CRK_MOD_ADD) 335 #define CRF_MOD_ADDINV (1 << CRK_MOD_ADDINV) 336 #define CRF_MOD_SUB (1 << CRK_MOD_SUB) 337 #define CRF_MOD_MULT (1 << CRK_MOD_MULT) 338 #define CRF_MOD_MULTINV (1 << CRK_MOD_MULTINV) 339 #define CRF_MOD (1 << CRK_MOD) 340 341 /* 342 * A large comment here once held descriptions of the ioctl 343 * requests implemented by the device. This text has been moved 344 * to the crypto(4) manual page and, later, removed from this file 345 * as it was always a step behind the times. 346 */ 347 348 /* 349 * done against open of /dev/crypto, to get a cloned descriptor. 350 * Please use F_SETFD against the cloned descriptor. But this ioctl 351 * is obsolete (the device now clones): please, just don't use it. 352 */ 353 #define CRIOGET _IOWR('c', 100, u_int32_t) 354 355 /* the following are done against the cloned descriptor */ 356 #define CIOCFSESSION _IOW('c', 102, u_int32_t) 357 #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 358 #define CIOCNFKEYM _IOWR('c', 108, struct crypt_mkop) 359 #define CIOCNFSESSION _IOW('c', 109, struct crypt_sfop) 360 #define CIOCNCRYPTRETM _IOWR('c', 110, struct cryptret) 361 #define CIOCNCRYPTRET _IOWR('c', 111, struct crypt_result) 362 363 #define CIOCGSESSION _IOWR('c', 112, struct session_op) 364 #define CIOCNGSESSION _IOWR('c', 113, struct crypt_sgop) 365 #define CIOCCRYPT _IOWR('c', 114, struct crypt_op) 366 #define CIOCNCRYPTM _IOWR('c', 115, struct crypt_mop) 367 368 #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) 369 370 struct cryptotstat { 371 struct timespec acc; /* total accumulated time */ 372 struct timespec min; /* max time */ 373 struct timespec max; /* max time */ 374 u_int32_t count; /* number of observations */ 375 }; 376 377 struct cryptostats { 378 u_int32_t cs_ops; /* symmetric crypto ops submitted */ 379 u_int32_t cs_errs; /* symmetric crypto ops that failed */ 380 u_int32_t cs_kops; /* asymetric/key ops submitted */ 381 u_int32_t cs_kerrs; /* asymetric/key ops that failed */ 382 u_int32_t cs_intrs; /* crypto swi thread activations */ 383 u_int32_t cs_rets; /* crypto return thread activations */ 384 u_int32_t cs_blocks; /* symmetric op driver block */ 385 u_int32_t cs_kblocks; /* symmetric op driver block */ 386 /* 387 * When CRYPTO_TIMING is defined at compile time and the 388 * sysctl debug.crypto is set to 1, the crypto system will 389 * accumulate statistics about how long it takes to process 390 * crypto requests at various points during processing. 391 */ 392 struct cryptotstat cs_invoke; /* crypto_dipsatch -> crypto_invoke */ 393 struct cryptotstat cs_done; /* crypto_invoke -> crypto_done */ 394 struct cryptotstat cs_cb; /* crypto_done -> callback */ 395 struct cryptotstat cs_finis; /* callback -> callback return */ 396 }; 397 398 #ifdef _KERNEL 399 /* Standard initialization structure beginning */ 400 struct cryptoini { 401 int cri_alg; /* Algorithm to use */ 402 int cri_klen; /* Key length, in bits */ 403 int cri_rnd; /* Algorithm rounds, where relevant */ 404 char *cri_key; /* key to use */ 405 u_int8_t cri_iv[EALG_MAX_BLOCK_LEN]; /* IV to use */ 406 struct cryptoini *cri_next; 407 }; 408 409 /* Describe boundaries of a single crypto operation */ 410 struct cryptodesc { 411 int crd_skip; /* How many bytes to ignore from start */ 412 int crd_len; /* How many bytes to process */ 413 int crd_inject; /* Where to inject results, if applicable */ 414 int crd_flags; 415 416 #define CRD_F_ENCRYPT 0x01 /* Set when doing encryption */ 417 #define CRD_F_IV_PRESENT 0x02 /* When encrypting, IV is already in 418 place, so don't copy. */ 419 #define CRD_F_IV_EXPLICIT 0x04 /* IV explicitly provided */ 420 #define CRD_F_DSA_SHA_NEEDED 0x08 /* Compute SHA-1 of buffer for DSA */ 421 #define CRD_F_COMP 0x10 /* Set when doing compression */ 422 423 struct cryptoini CRD_INI; /* Initialization/context data */ 424 #define crd_iv CRD_INI.cri_iv 425 #define crd_key CRD_INI.cri_key 426 #define crd_rnd CRD_INI.cri_rnd 427 #define crd_alg CRD_INI.cri_alg 428 #define crd_klen CRD_INI.cri_klen 429 430 struct cryptodesc *crd_next; 431 }; 432 433 /* Structure describing complete operation */ 434 struct cryptop { 435 TAILQ_ENTRY(cryptop) crp_next; 436 u_int64_t crp_sid; /* Session ID */ 437 438 u_int32_t crp_reqid; /* request id */ 439 void * crp_usropaque; /* Opaque pointer from user, passed along */ 440 441 int crp_ilen; /* Input data total length */ 442 int crp_olen; /* Result total length */ 443 444 int crp_etype; /* 445 * Error type (zero means no error). 446 * All error codes except EAGAIN 447 * indicate possible data corruption (as in, 448 * the data have been touched). On all 449 * errors, the crp_sid may have changed 450 * (reset to a new one), so the caller 451 * should always check and use the new 452 * value on future requests. 453 */ 454 int crp_flags; /* Note: must hold mutext to modify */ 455 456 #define CRYPTO_F_IMBUF 0x0001 /* Input/output are mbuf chains */ 457 #define CRYPTO_F_IOV 0x0002 /* Input/output are uio */ 458 #define CRYPTO_F_REL 0x0004 /* Must return data in same place */ 459 #define CRYPTO_F_BATCH 0x0008 /* Batch op if possible possible */ 460 #define CRYPTO_F_CBIMM 0x0010 /* Do callback immediately */ 461 #define CRYPTO_F_DONE 0x0020 /* Operation completed */ 462 #define CRYPTO_F_CBIFSYNC 0x0040 /* Do CBIMM if op is synchronous */ 463 #define CRYPTO_F_ONRETQ 0x0080 /* Request is on return queue */ 464 #define CRYPTO_F_USER 0x0100 /* Request is in user context */ 465 #define CRYPTO_F_MORE 0x0200 /* more data to follow */ 466 467 void * crp_buf; /* Data to be processed */ 468 void * crp_opaque; /* Opaque pointer, passed along */ 469 struct cryptodesc *crp_desc; /* Linked list of processing descriptors */ 470 471 int (*crp_callback)(struct cryptop *); /* Callback function */ 472 473 void * crp_mac; 474 struct timespec crp_tstamp; /* performance time stamp */ 475 kcondvar_t crp_cv; 476 struct fcrypt *fcrp; 477 void * dst; 478 void * mac; 479 u_int len; 480 u_char tmp_iv[EALG_MAX_BLOCK_LEN]; 481 u_char tmp_mac[CRYPTO_MAX_MAC_LEN]; 482 483 struct iovec iovec[1]; 484 struct uio uio; 485 uint32_t magic; 486 }; 487 488 #define CRYPTO_BUF_CONTIG 0x0 489 #define CRYPTO_BUF_IOV 0x1 490 #define CRYPTO_BUF_MBUF 0x2 491 492 #define CRYPTO_OP_DECRYPT 0x0 493 #define CRYPTO_OP_ENCRYPT 0x1 494 495 /* 496 * Hints passed to process methods. 497 */ 498 #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 499 500 struct cryptkop { 501 TAILQ_ENTRY(cryptkop) krp_next; 502 503 u_int32_t krp_reqid; /* request id */ 504 void * krp_usropaque; /* Opaque pointer from user, passed along */ 505 506 u_int krp_op; /* ie. CRK_MOD_EXP or other */ 507 u_int krp_status; /* return status */ 508 u_short krp_iparams; /* # of input parameters */ 509 u_short krp_oparams; /* # of output parameters */ 510 u_int32_t krp_hid; 511 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 512 int (*krp_callback)(struct cryptkop *); 513 int krp_flags; /* same values as crp_flags */ 514 kcondvar_t krp_cv; 515 struct fcrypt *fcrp; 516 struct crparam crk_param[CRK_MAXPARAM]; 517 }; 518 519 /* Crypto capabilities structure */ 520 struct cryptocap { 521 u_int32_t cc_sessions; 522 523 /* 524 * Largest possible operator length (in bits) for each type of 525 * encryption algorithm. 526 */ 527 u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1]; 528 529 u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1]; 530 531 u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1]; 532 533 u_int8_t cc_flags; 534 u_int8_t cc_qblocked; /* symmetric q blocked */ 535 u_int8_t cc_kqblocked; /* asymmetric q blocked */ 536 #define CRYPTOCAP_F_CLEANUP 0x01 /* needs resource cleanup */ 537 #define CRYPTOCAP_F_SOFTWARE 0x02 /* software implementation */ 538 #define CRYPTOCAP_F_SYNC 0x04 /* operates synchronously */ 539 540 void *cc_arg; /* callback argument */ 541 int (*cc_newsession)(void*, u_int32_t*, struct cryptoini*); 542 int (*cc_process) (void*, struct cryptop *, int); 543 int (*cc_freesession) (void*, u_int64_t); 544 void *cc_karg; /* callback argument */ 545 int (*cc_kprocess) (void*, struct cryptkop *, int); 546 }; 547 548 /* 549 * Session ids are 64 bits. The lower 32 bits contain a "local id" which 550 * is a driver-private session identifier. The upper 32 bits contain a 551 * "hardware id" used by the core crypto code to identify the driver and 552 * a copy of the driver's capabilities that can be used by client code to 553 * optimize operation. 554 */ 555 #define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0xffffff) 556 #define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 56) & 0xff) 557 #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff) 558 559 MALLOC_DECLARE(M_CRYPTO_DATA); 560 561 extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard); 562 extern int crypto_freesession(u_int64_t sid); 563 extern int32_t crypto_get_driverid(u_int32_t flags); 564 extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, 565 u_int32_t flags, 566 int (*newses)(void*, u_int32_t*, struct cryptoini*), 567 int (*freeses)(void*, u_int64_t), 568 int (*process)(void*, struct cryptop *, int), 569 void *arg); 570 extern int crypto_kregister(u_int32_t, int, u_int32_t, 571 int (*)(void*, struct cryptkop *, int), 572 void *arg); 573 extern int crypto_unregister(u_int32_t driverid, int alg); 574 extern int crypto_unregister_all(u_int32_t driverid); 575 extern int crypto_dispatch(struct cryptop *crp); 576 extern int crypto_kdispatch(struct cryptkop *); 577 #define CRYPTO_SYMQ 0x1 578 #define CRYPTO_ASYMQ 0x2 579 extern int crypto_unblock(u_int32_t, int); 580 extern void crypto_done(struct cryptop *crp); 581 extern void crypto_kdone(struct cryptkop *); 582 extern int crypto_getfeat(int *); 583 584 void cuio_copydata(struct uio *, int, int, void *); 585 void cuio_copyback(struct uio *, int, int, void *); 586 int cuio_apply(struct uio *, int, int, 587 int (*f)(void *, void *, unsigned int), void *); 588 589 extern int crypto_ret_q_remove(struct cryptop *); 590 extern int crypto_ret_kq_remove(struct cryptkop *); 591 extern void crypto_freereq(struct cryptop *crp); 592 extern struct cryptop *crypto_getreq(int num); 593 594 extern int crypto_usercrypto; /* userland may do crypto requests */ 595 extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 596 extern int crypto_devallowsoft; /* only use hardware crypto */ 597 598 /* 599 * Asymmetric operations are allocated in cryptodev.c but can be 600 * freed in crypto.c. 601 */ 602 extern struct pool cryptkop_pool; 603 604 /* 605 * Mutual exclusion and its unwelcome friends. 606 */ 607 608 extern kmutex_t crypto_mtx; 609 610 /* 611 * initialize the crypto framework subsystem (not the pseudo-device). 612 * This must be called very early in boot, so the framework is ready 613 * to handle registration requests when crpto hardware is autoconfigured. 614 * (This declaration doesnt really belong here but there's no header 615 * for the raw framework.) 616 */ 617 void crypto_init(void); 618 619 /* 620 * Crypto-related utility routines used mainly by drivers. 621 * 622 * XXX these don't really belong here; but for now they're 623 * kept apart from the rest of the system. 624 */ 625 struct mbuf; 626 struct mbuf *m_getptr(struct mbuf *, int, int *); 627 628 struct uio; 629 extern void cuio_copydata(struct uio* uio, int off, int len, void *cp); 630 extern void cuio_copyback(struct uio* uio, int off, int len, void *cp); 631 extern int cuio_getptr(struct uio *, int loc, int *off); 632 633 #ifdef CRYPTO_DEBUG /* yuck, netipsec defines these differently */ 634 #ifndef DPRINTF 635 #define DPRINTF(a) uprintf a 636 #endif 637 #ifndef DCPRINTF 638 #define DCPRINTF(a) printf a 639 #endif 640 #else 641 #ifndef DPRINTF 642 #define DPRINTF(a) 643 #endif 644 #ifndef DCPRINTF 645 #define DCPRINTF(a) 646 #endif 647 #endif 648 649 #endif /* _KERNEL */ 650 #endif /* _CRYPTO_CRYPTO_H_ */ 651