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