1 /* $FreeBSD$ */ 2 /* $OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $ */ 3 4 /*- 5 * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) 6 * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting 7 * 8 * This code was written by Angelos D. Keromytis in Athens, Greece, in 9 * February 2000. Network Security Technologies Inc. (NSTI) kindly 10 * supported the development of this code. 11 * 12 * Copyright (c) 2000 Angelos D. Keromytis 13 * 14 * Permission to use, copy, and modify this software with or without fee 15 * is hereby granted, provided that this entire notice is included in 16 * all source code copies of any software which is or includes a copy or 17 * modification of this software. 18 * 19 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 20 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 21 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 22 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 23 * PURPOSE. 24 * 25 * Copyright (c) 2001 Theo de Raadt 26 * Copyright (c) 2014 The FreeBSD Foundation 27 * All rights reserved. 28 * 29 * Portions of this software were developed by John-Mark Gurney 30 * under sponsorship of the FreeBSD Foundation and 31 * Rubicon Communications, LLC (Netgate). 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 37 * 1. Redistributions of source code must retain the above copyright 38 * notice, this list of conditions and the following disclaimer. 39 * 2. Redistributions in binary form must reproduce the above copyright 40 * notice, this list of conditions and the following disclaimer in the 41 * documentation and/or other materials provided with the distribution. 42 * 3. The name of the author may not be used to endorse or promote products 43 * derived from this software without specific prior written permission. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 55 * 56 * Effort sponsored in part by the Defense Advanced Research Projects 57 * Agency (DARPA) and Air Force Research Laboratory, Air Force 58 * Materiel Command, USAF, under agreement number F30602-01-2-0537. 59 * 60 */ 61 62 #ifndef _CRYPTO_CRYPTO_H_ 63 #define _CRYPTO_CRYPTO_H_ 64 65 #include <sys/ioccom.h> 66 67 #ifdef _KERNEL 68 #include <opencrypto/_cryptodev.h> 69 #include <sys/_task.h> 70 #endif 71 72 /* Some initial values */ 73 #define CRYPTO_DRIVERS_INITIAL 4 74 75 /* Hash values */ 76 #define NULL_HASH_LEN 16 77 #define SHA1_HASH_LEN 20 78 #define RIPEMD160_HASH_LEN 20 79 #define SHA2_224_HASH_LEN 28 80 #define SHA2_256_HASH_LEN 32 81 #define SHA2_384_HASH_LEN 48 82 #define SHA2_512_HASH_LEN 64 83 #define AES_GMAC_HASH_LEN 16 84 #define POLY1305_HASH_LEN 16 85 #define AES_CBC_MAC_HASH_LEN 16 86 /* Maximum hash algorithm result length */ 87 #define HASH_MAX_LEN SHA2_512_HASH_LEN /* Keep this updated */ 88 89 #define SHA1_BLOCK_LEN 64 90 #define RIPEMD160_BLOCK_LEN 64 91 #define SHA2_224_BLOCK_LEN 64 92 #define SHA2_256_BLOCK_LEN 64 93 #define SHA2_384_BLOCK_LEN 128 94 #define SHA2_512_BLOCK_LEN 128 95 96 /* HMAC values */ 97 #define NULL_HMAC_BLOCK_LEN 64 98 /* Maximum HMAC block length */ 99 #define HMAC_MAX_BLOCK_LEN SHA2_512_BLOCK_LEN /* Keep this updated */ 100 #define HMAC_IPAD_VAL 0x36 101 #define HMAC_OPAD_VAL 0x5C 102 /* HMAC Key Length */ 103 #define AES_128_GMAC_KEY_LEN 16 104 #define AES_192_GMAC_KEY_LEN 24 105 #define AES_256_GMAC_KEY_LEN 32 106 #define AES_128_CBC_MAC_KEY_LEN 16 107 #define AES_192_CBC_MAC_KEY_LEN 24 108 #define AES_256_CBC_MAC_KEY_LEN 32 109 110 #define POLY1305_KEY_LEN 32 111 112 /* Encryption algorithm block sizes */ 113 #define NULL_BLOCK_LEN 4 /* IPsec to maintain alignment */ 114 #define RIJNDAEL128_BLOCK_LEN 16 115 #define AES_BLOCK_LEN 16 116 #define AES_ICM_BLOCK_LEN 1 117 #define CAMELLIA_BLOCK_LEN 16 118 #define CHACHA20_NATIVE_BLOCK_LEN 64 119 #define EALG_MAX_BLOCK_LEN CHACHA20_NATIVE_BLOCK_LEN /* Keep this updated */ 120 121 /* IV Lengths */ 122 123 #define AES_GCM_IV_LEN 12 124 #define AES_CCM_IV_LEN 12 125 #define AES_XTS_IV_LEN 8 126 #define AES_XTS_ALPHA 0x87 /* GF(2^128) generator polynomial */ 127 #define CHACHA20_POLY1305_IV_LEN 12 128 129 /* Min and Max Encryption Key Sizes */ 130 #define NULL_MIN_KEY 0 131 #define NULL_MAX_KEY 256 /* 2048 bits, max key */ 132 #define RIJNDAEL_MIN_KEY 16 133 #define RIJNDAEL_MAX_KEY 32 134 #define AES_MIN_KEY RIJNDAEL_MIN_KEY 135 #define AES_MAX_KEY RIJNDAEL_MAX_KEY 136 #define AES_XTS_MIN_KEY (2 * AES_MIN_KEY) 137 #define AES_XTS_MAX_KEY (2 * AES_MAX_KEY) 138 #define CAMELLIA_MIN_KEY 16 139 #define CAMELLIA_MAX_KEY 32 140 #define CHACHA20_POLY1305_KEY 32 141 142 /* Maximum hash algorithm result length */ 143 #define AALG_MAX_RESULT_LEN 64 /* Keep this updated */ 144 145 #define CRYPTO_ALGORITHM_MIN 1 146 #define CRYPTO_DES_CBC 1 147 #define CRYPTO_3DES_CBC 2 148 #define CRYPTO_BLF_CBC 3 149 #define CRYPTO_CAST_CBC 4 150 #define CRYPTO_SKIPJACK_CBC 5 151 #define CRYPTO_MD5_HMAC 6 152 #define CRYPTO_SHA1_HMAC 7 153 #define CRYPTO_RIPEMD160_HMAC 8 154 #define CRYPTO_MD5_KPDK 9 155 #define CRYPTO_SHA1_KPDK 10 156 #define CRYPTO_RIJNDAEL128_CBC 11 /* 128 bit blocksize */ 157 #define CRYPTO_AES_CBC 11 /* 128 bit blocksize -- the same as above */ 158 #define CRYPTO_ARC4 12 159 #define CRYPTO_MD5 13 160 #define CRYPTO_SHA1 14 161 #define CRYPTO_NULL_HMAC 15 162 #define CRYPTO_NULL_CBC 16 163 #define CRYPTO_DEFLATE_COMP 17 /* Deflate compression algorithm */ 164 #define CRYPTO_SHA2_256_HMAC 18 165 #define CRYPTO_SHA2_384_HMAC 19 166 #define CRYPTO_SHA2_512_HMAC 20 167 #define CRYPTO_CAMELLIA_CBC 21 168 #define CRYPTO_AES_XTS 22 169 #define CRYPTO_AES_ICM 23 /* commonly known as CTR mode */ 170 #define CRYPTO_AES_NIST_GMAC 24 /* GMAC only */ 171 #define CRYPTO_AES_NIST_GCM_16 25 /* 16 byte ICV */ 172 #ifdef _KERNEL 173 #define CRYPTO_AES_128_NIST_GMAC 26 /* auth side */ 174 #define CRYPTO_AES_192_NIST_GMAC 27 /* auth side */ 175 #define CRYPTO_AES_256_NIST_GMAC 28 /* auth side */ 176 #endif 177 #define CRYPTO_BLAKE2B 29 /* Blake2b hash */ 178 #define CRYPTO_BLAKE2S 30 /* Blake2s hash */ 179 #define CRYPTO_CHACHA20 31 /* Chacha20 stream cipher */ 180 #define CRYPTO_SHA2_224_HMAC 32 181 #define CRYPTO_RIPEMD160 33 182 #define CRYPTO_SHA2_224 34 183 #define CRYPTO_SHA2_256 35 184 #define CRYPTO_SHA2_384 36 185 #define CRYPTO_SHA2_512 37 186 #define CRYPTO_POLY1305 38 187 #define CRYPTO_AES_CCM_CBC_MAC 39 /* auth side */ 188 #define CRYPTO_AES_CCM_16 40 /* cipher side */ 189 #define CRYPTO_CHACHA20_POLY1305 41 /* combined AEAD cipher per RFC 8439 */ 190 #define CRYPTO_ALGORITHM_MAX 41 /* Keep updated - see below */ 191 192 #define CRYPTO_ALGO_VALID(x) ((x) >= CRYPTO_ALGORITHM_MIN && \ 193 (x) <= CRYPTO_ALGORITHM_MAX) 194 195 /* Algorithm flags */ 196 #define CRYPTO_ALG_FLAG_SUPPORTED 0x01 /* Algorithm is supported */ 197 #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ 198 #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ 199 200 /* 201 * Crypto driver/device flags. They can set in the crid 202 * parameter when creating a session or submitting a key 203 * op to affect the device/driver assigned. If neither 204 * of these are specified then the crid is assumed to hold 205 * the driver id of an existing (and suitable) device that 206 * must be used to satisfy the request. 207 */ 208 #define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ 209 #define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ 210 211 /* Does the kernel support vmpage buffers on this platform? */ 212 #ifdef __powerpc__ 213 #define CRYPTO_MAY_HAVE_VMPAGE 1 214 #else 215 #define CRYPTO_MAY_HAVE_VMPAGE ( PMAP_HAS_DMAP ) 216 #endif 217 /* Does the currently running system support vmpage buffers on this platform? */ 218 #define CRYPTO_HAS_VMPAGE ( PMAP_HAS_DMAP ) 219 220 /* NB: deprecated */ 221 struct session_op { 222 uint32_t cipher; /* ie. CRYPTO_AES_CBC */ 223 uint32_t mac; /* ie. CRYPTO_SHA2_256_HMAC */ 224 225 uint32_t keylen; /* cipher key */ 226 const void *key; 227 int mackeylen; /* mac key */ 228 const void *mackey; 229 230 uint32_t ses; /* returns: session # */ 231 }; 232 233 /* 234 * session and crypt _op structs are used by userspace programs to interact 235 * with /dev/crypto. Confusingly, the internal kernel interface is named 236 * "cryptop" (no underscore). 237 */ 238 struct session2_op { 239 uint32_t cipher; /* ie. CRYPTO_AES_CBC */ 240 uint32_t mac; /* ie. CRYPTO_SHA2_256_HMAC */ 241 242 uint32_t keylen; /* cipher key */ 243 const void *key; 244 int mackeylen; /* mac key */ 245 const void *mackey; 246 247 uint32_t ses; /* returns: session # */ 248 int crid; /* driver id + flags (rw) */ 249 int pad[4]; /* for future expansion */ 250 }; 251 252 struct crypt_op { 253 uint32_t ses; 254 uint16_t op; /* i.e. COP_ENCRYPT */ 255 #define COP_ENCRYPT 1 256 #define COP_DECRYPT 2 257 uint16_t flags; 258 #define COP_F_CIPHER_FIRST 0x0001 /* Cipher before MAC. */ 259 #define COP_F_BATCH 0x0008 /* Batch op if possible */ 260 u_int len; 261 const void *src; /* become iov[] inside kernel */ 262 void *dst; 263 void *mac; /* must be big enough for chosen MAC */ 264 const void *iv; 265 }; 266 267 /* op and flags the same as crypt_op */ 268 struct crypt_aead { 269 uint32_t ses; 270 uint16_t op; /* i.e. COP_ENCRYPT */ 271 uint16_t flags; 272 u_int len; 273 u_int aadlen; 274 u_int ivlen; 275 const void *src; /* become iov[] inside kernel */ 276 void *dst; 277 const void *aad; /* additional authenticated data */ 278 void *tag; /* must fit for chosen TAG length */ 279 const void *iv; 280 }; 281 282 /* 283 * Parameters for looking up a crypto driver/device by 284 * device name or by id. The latter are returned for 285 * created sessions (crid) and completed key operations. 286 */ 287 struct crypt_find_op { 288 int crid; /* driver id + flags */ 289 char name[32]; /* device/driver name */ 290 }; 291 292 /* bignum parameter, in packed bytes, ... */ 293 struct crparam { 294 void *crp_p; 295 u_int crp_nbits; 296 }; 297 298 #define CRK_MAXPARAM 8 299 300 struct crypt_kop { 301 u_int crk_op; /* ie. CRK_MOD_EXP or other */ 302 u_int crk_status; /* return status */ 303 u_short crk_iparams; /* # of input parameters */ 304 u_short crk_oparams; /* # of output parameters */ 305 u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ 306 struct crparam crk_param[CRK_MAXPARAM]; 307 }; 308 #define CRK_ALGORITM_MIN 0 309 #define CRK_MOD_EXP 0 310 #define CRK_MOD_EXP_CRT 1 311 #define CRK_DSA_SIGN 2 312 #define CRK_DSA_VERIFY 3 313 #define CRK_DH_COMPUTE_KEY 4 314 #define CRK_ALGORITHM_MAX 4 /* Keep updated - see below */ 315 316 #define CRF_MOD_EXP (1 << CRK_MOD_EXP) 317 #define CRF_MOD_EXP_CRT (1 << CRK_MOD_EXP_CRT) 318 #define CRF_DSA_SIGN (1 << CRK_DSA_SIGN) 319 #define CRF_DSA_VERIFY (1 << CRK_DSA_VERIFY) 320 #define CRF_DH_COMPUTE_KEY (1 << CRK_DH_COMPUTE_KEY) 321 322 #define CIOCGSESSION _IOWR('c', 101, struct session_op) 323 #define CIOCFSESSION _IOW('c', 102, uint32_t) 324 #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) 325 #define CIOCKEY _IOWR('c', 104, struct crypt_kop) 326 #define CIOCASYMFEAT _IOR('c', 105, uint32_t) 327 #define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) 328 #define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) 329 #define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) 330 #define CIOCCRYPTAEAD _IOWR('c', 109, struct crypt_aead) 331 332 struct cryptostats { 333 uint64_t cs_ops; /* symmetric crypto ops submitted */ 334 uint64_t cs_errs; /* symmetric crypto ops that failed */ 335 uint64_t cs_kops; /* asymetric/key ops submitted */ 336 uint64_t cs_kerrs; /* asymetric/key ops that failed */ 337 uint64_t cs_intrs; /* crypto swi thread activations */ 338 uint64_t cs_rets; /* crypto return thread activations */ 339 uint64_t cs_blocks; /* symmetric op driver block */ 340 uint64_t cs_kblocks; /* symmetric op driver block */ 341 }; 342 343 #ifdef _KERNEL 344 345 /* 346 * Return values for cryptodev_probesession methods. 347 */ 348 #define CRYPTODEV_PROBE_HARDWARE (-100) 349 #define CRYPTODEV_PROBE_ACCEL_SOFTWARE (-200) 350 #define CRYPTODEV_PROBE_SOFTWARE (-500) 351 352 #if 0 353 #define CRYPTDEB(s, ...) do { \ 354 printf("%s:%d: " s "\n", __FILE__, __LINE__, ## __VA_ARGS__); \ 355 } while (0) 356 #else 357 #define CRYPTDEB(...) do { } while (0) 358 #endif 359 360 struct crypto_session_params { 361 int csp_mode; /* Type of operations to perform. */ 362 363 #define CSP_MODE_NONE 0 364 #define CSP_MODE_COMPRESS 1 /* Compression/decompression. */ 365 #define CSP_MODE_CIPHER 2 /* Encrypt/decrypt. */ 366 #define CSP_MODE_DIGEST 3 /* Compute/verify digest. */ 367 #define CSP_MODE_AEAD 4 /* Combined auth/encryption. */ 368 #define CSP_MODE_ETA 5 /* IPsec style encrypt-then-auth */ 369 370 int csp_flags; 371 372 #define CSP_F_SEPARATE_OUTPUT 0x0001 /* Requests can use separate output */ 373 #define CSP_F_SEPARATE_AAD 0x0002 /* Requests can use separate AAD */ 374 #define CSP_F_ESN 0x0004 /* Requests can use seperate ESN field */ 375 376 int csp_ivlen; /* IV length in bytes. */ 377 378 int csp_cipher_alg; 379 int csp_cipher_klen; /* Key length in bytes. */ 380 const void *csp_cipher_key; 381 382 int csp_auth_alg; 383 int csp_auth_klen; /* Key length in bytes. */ 384 const void *csp_auth_key; 385 int csp_auth_mlen; /* Number of digest bytes to use. 386 0 means all. */ 387 }; 388 389 enum crypto_buffer_type { 390 CRYPTO_BUF_NONE = 0, 391 CRYPTO_BUF_CONTIG, 392 CRYPTO_BUF_UIO, 393 CRYPTO_BUF_MBUF, 394 CRYPTO_BUF_VMPAGE, 395 CRYPTO_BUF_LAST = CRYPTO_BUF_VMPAGE 396 }; 397 398 /* 399 * Description of a data buffer for a request. Requests can either 400 * have a single buffer that is modified in place or separate input 401 * and output buffers. 402 */ 403 struct crypto_buffer { 404 union { 405 struct { 406 char *cb_buf; 407 int cb_buf_len; 408 }; 409 struct mbuf *cb_mbuf; 410 struct { 411 vm_page_t *cb_vm_page; 412 int cb_vm_page_len; 413 int cb_vm_page_offset; 414 }; 415 struct uio *cb_uio; 416 }; 417 enum crypto_buffer_type cb_type; 418 }; 419 420 /* 421 * A cursor is used to iterate through a crypto request data buffer. 422 */ 423 struct crypto_buffer_cursor { 424 union { 425 char *cc_buf; 426 struct mbuf *cc_mbuf; 427 struct iovec *cc_iov; 428 vm_page_t *cc_vmpage; 429 }; 430 /* Optional bytes of valid data remaining */ 431 int cc_buf_len; 432 /* 433 * Optional offset within the current buffer segment where 434 * valid data begins 435 */ 436 size_t cc_offset; 437 enum crypto_buffer_type cc_type; 438 }; 439 440 /* Structure describing complete operation */ 441 struct cryptop { 442 TAILQ_ENTRY(cryptop) crp_next; 443 444 struct task crp_task; 445 446 crypto_session_t crp_session; /* Session */ 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_session 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; 460 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_ASYNC_ORDERED 0x0100 /* Completions must happen in order */ 465 #define CRYPTO_F_IV_SEPARATE 0x0200 /* Use crp_iv[] as IV. */ 466 467 int crp_op; 468 469 struct crypto_buffer crp_buf; 470 struct crypto_buffer crp_obuf; 471 472 void *crp_aad; /* AAD buffer. */ 473 int crp_aad_start; /* Location of AAD. */ 474 int crp_aad_length; /* 0 => no AAD. */ 475 uint8_t crp_esn[4]; /* high-order ESN */ 476 477 int crp_iv_start; /* Location of IV. IV length is from 478 * the session. 479 */ 480 int crp_payload_start; /* Location of ciphertext. */ 481 int crp_payload_output_start; 482 int crp_payload_length; 483 int crp_digest_start; /* Location of MAC/tag. Length is 484 * from the session. 485 */ 486 487 uint8_t crp_iv[EALG_MAX_BLOCK_LEN]; /* IV if IV_SEPARATE. */ 488 489 const void *crp_cipher_key; /* New cipher key if non-NULL. */ 490 const void *crp_auth_key; /* New auth key if non-NULL. */ 491 492 void *crp_opaque; /* Opaque pointer, passed along */ 493 494 int (*crp_callback)(struct cryptop *); /* Callback function */ 495 496 struct bintime crp_tstamp; /* performance time stamp */ 497 uint32_t crp_seq; /* used for ordered dispatch */ 498 uint32_t crp_retw_id; /* 499 * the return worker to be used, 500 * used for ordered dispatch 501 */ 502 }; 503 504 TAILQ_HEAD(cryptopq, cryptop); 505 506 static __inline void 507 _crypto_use_buf(struct crypto_buffer *cb, void *buf, int len) 508 { 509 cb->cb_buf = buf; 510 cb->cb_buf_len = len; 511 cb->cb_type = CRYPTO_BUF_CONTIG; 512 } 513 514 static __inline void 515 _crypto_use_mbuf(struct crypto_buffer *cb, struct mbuf *m) 516 { 517 cb->cb_mbuf = m; 518 cb->cb_type = CRYPTO_BUF_MBUF; 519 } 520 521 static __inline void 522 _crypto_use_vmpage(struct crypto_buffer *cb, vm_page_t *pages, int len, 523 int offset) 524 { 525 cb->cb_vm_page = pages; 526 cb->cb_vm_page_len = len; 527 cb->cb_vm_page_offset = offset; 528 cb->cb_type = CRYPTO_BUF_VMPAGE; 529 } 530 531 static __inline void 532 _crypto_use_uio(struct crypto_buffer *cb, struct uio *uio) 533 { 534 cb->cb_uio = uio; 535 cb->cb_type = CRYPTO_BUF_UIO; 536 } 537 538 static __inline void 539 crypto_use_buf(struct cryptop *crp, void *buf, int len) 540 { 541 _crypto_use_buf(&crp->crp_buf, buf, len); 542 } 543 544 static __inline void 545 crypto_use_mbuf(struct cryptop *crp, struct mbuf *m) 546 { 547 _crypto_use_mbuf(&crp->crp_buf, m); 548 } 549 550 static __inline void 551 crypto_use_vmpage(struct cryptop *crp, vm_page_t *pages, int len, int offset) 552 { 553 _crypto_use_vmpage(&crp->crp_buf, pages, len, offset); 554 } 555 556 static __inline void 557 crypto_use_uio(struct cryptop *crp, struct uio *uio) 558 { 559 _crypto_use_uio(&crp->crp_buf, uio); 560 } 561 562 static __inline void 563 crypto_use_output_buf(struct cryptop *crp, void *buf, int len) 564 { 565 _crypto_use_buf(&crp->crp_obuf, buf, len); 566 } 567 568 static __inline void 569 crypto_use_output_mbuf(struct cryptop *crp, struct mbuf *m) 570 { 571 _crypto_use_mbuf(&crp->crp_obuf, m); 572 } 573 574 static __inline void 575 crypto_use_output_vmpage(struct cryptop *crp, vm_page_t *pages, int len, 576 int offset) 577 { 578 _crypto_use_vmpage(&crp->crp_obuf, pages, len, offset); 579 } 580 581 static __inline void 582 crypto_use_output_uio(struct cryptop *crp, struct uio *uio) 583 { 584 _crypto_use_uio(&crp->crp_obuf, uio); 585 } 586 587 #define CRYPTO_HAS_OUTPUT_BUFFER(crp) \ 588 ((crp)->crp_obuf.cb_type != CRYPTO_BUF_NONE) 589 590 /* Flags in crp_op. */ 591 #define CRYPTO_OP_DECRYPT 0x0 592 #define CRYPTO_OP_ENCRYPT 0x1 593 #define CRYPTO_OP_IS_ENCRYPT(op) ((op) & CRYPTO_OP_ENCRYPT) 594 #define CRYPTO_OP_COMPUTE_DIGEST 0x0 595 #define CRYPTO_OP_VERIFY_DIGEST 0x2 596 #define CRYPTO_OP_DECOMPRESS CRYPTO_OP_DECRYPT 597 #define CRYPTO_OP_COMPRESS CRYPTO_OP_ENCRYPT 598 #define CRYPTO_OP_IS_COMPRESS(op) ((op) & CRYPTO_OP_COMPRESS) 599 600 /* 601 * Hints passed to process methods. 602 */ 603 #define CRYPTO_HINT_MORE 0x1 /* more ops coming shortly */ 604 605 struct cryptkop { 606 TAILQ_ENTRY(cryptkop) krp_next; 607 608 u_int krp_op; /* ie. CRK_MOD_EXP or other */ 609 u_int krp_status; /* return status */ 610 u_short krp_iparams; /* # of input parameters */ 611 u_short krp_oparams; /* # of output parameters */ 612 u_int krp_crid; /* desired device, etc. */ 613 uint32_t krp_hid; /* device used */ 614 struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ 615 void (*krp_callback)(struct cryptkop *); 616 struct cryptocap *krp_cap; 617 }; 618 619 uint32_t crypto_ses2hid(crypto_session_t crypto_session); 620 uint32_t crypto_ses2caps(crypto_session_t crypto_session); 621 void *crypto_get_driver_session(crypto_session_t crypto_session); 622 const struct crypto_session_params *crypto_get_params( 623 crypto_session_t crypto_session); 624 struct auth_hash *crypto_auth_hash(const struct crypto_session_params *csp); 625 struct enc_xform *crypto_cipher(const struct crypto_session_params *csp); 626 627 MALLOC_DECLARE(M_CRYPTO_DATA); 628 629 extern int crypto_newsession(crypto_session_t *cses, 630 const struct crypto_session_params *params, int hard); 631 extern void crypto_freesession(crypto_session_t cses); 632 #define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE 633 #define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE 634 #define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ 635 #define CRYPTOCAP_F_ACCEL_SOFTWARE 0x08000000 636 #define CRYPTO_SESS_SYNC(sess) \ 637 ((crypto_ses2caps(sess) & CRYPTOCAP_F_SYNC) != 0) 638 extern int32_t crypto_get_driverid(device_t dev, size_t session_size, 639 int flags); 640 extern int crypto_find_driver(const char *); 641 extern device_t crypto_find_device_byhid(int hid); 642 extern int crypto_getcaps(int hid); 643 extern int crypto_kregister(uint32_t, int, uint32_t); 644 extern int crypto_unregister_all(uint32_t driverid); 645 extern int crypto_dispatch(struct cryptop *crp); 646 #define CRYPTO_ASYNC_ORDERED 0x1 /* complete in order dispatched */ 647 extern int crypto_dispatch_async(struct cryptop *crp, int flags); 648 extern void crypto_dispatch_batch(struct cryptopq *crpq, int flags); 649 extern int crypto_kdispatch(struct cryptkop *); 650 #define CRYPTO_SYMQ 0x1 651 #define CRYPTO_ASYMQ 0x2 652 extern int crypto_unblock(uint32_t, int); 653 extern void crypto_done(struct cryptop *crp); 654 extern void crypto_kdone(struct cryptkop *); 655 extern int crypto_getfeat(int *); 656 657 extern void crypto_destroyreq(struct cryptop *crp); 658 extern void crypto_initreq(struct cryptop *crp, crypto_session_t cses); 659 extern void crypto_freereq(struct cryptop *crp); 660 extern struct cryptop *crypto_getreq(crypto_session_t cses, int how); 661 662 extern int crypto_usercrypto; /* userland may do crypto requests */ 663 extern int crypto_userasymcrypto; /* userland may do asym crypto reqs */ 664 extern int crypto_devallowsoft; /* only use hardware crypto */ 665 666 #ifdef SYSCTL_DECL 667 SYSCTL_DECL(_kern_crypto); 668 #endif 669 670 /* Helper routines for drivers to initialize auth contexts for HMAC. */ 671 struct auth_hash; 672 673 void hmac_init_ipad(const struct auth_hash *axf, const char *key, int klen, 674 void *auth_ctx); 675 void hmac_init_opad(const struct auth_hash *axf, const char *key, int klen, 676 void *auth_ctx); 677 678 /* 679 * Crypto-related utility routines used mainly by drivers. 680 * 681 * Similar to m_copyback/data, *_copyback copy data from the 'src' 682 * buffer into the crypto request's data buffer while *_copydata copy 683 * data from the crypto request's data buffer into the the 'dst' 684 * buffer. 685 */ 686 void crypto_copyback(struct cryptop *crp, int off, int size, 687 const void *src); 688 void crypto_copydata(struct cryptop *crp, int off, int size, void *dst); 689 int crypto_apply(struct cryptop *crp, int off, int len, 690 int (*f)(void *, const void *, u_int), void *arg); 691 void *crypto_contiguous_subsegment(struct cryptop *crp, size_t skip, 692 size_t len); 693 694 int crypto_apply_buf(struct crypto_buffer *cb, int off, int len, 695 int (*f)(void *, const void *, u_int), void *arg); 696 void *crypto_buffer_contiguous_subsegment(struct crypto_buffer *cb, 697 size_t skip, size_t len); 698 size_t crypto_buffer_len(struct crypto_buffer *cb); 699 void crypto_cursor_init(struct crypto_buffer_cursor *cc, 700 const struct crypto_buffer *cb); 701 void crypto_cursor_advance(struct crypto_buffer_cursor *cc, size_t amount); 702 void *crypto_cursor_segbase(struct crypto_buffer_cursor *cc); 703 size_t crypto_cursor_seglen(struct crypto_buffer_cursor *cc); 704 void crypto_cursor_copyback(struct crypto_buffer_cursor *cc, int size, 705 const void *vsrc); 706 void crypto_cursor_copydata(struct crypto_buffer_cursor *cc, int size, 707 void *vdst); 708 void crypto_cursor_copydata_noadv(struct crypto_buffer_cursor *cc, int size, 709 void *vdst); 710 711 static __inline void 712 crypto_read_iv(struct cryptop *crp, void *iv) 713 { 714 const struct crypto_session_params *csp; 715 716 csp = crypto_get_params(crp->crp_session); 717 if (crp->crp_flags & CRYPTO_F_IV_SEPARATE) 718 memcpy(iv, crp->crp_iv, csp->csp_ivlen); 719 else 720 crypto_copydata(crp, crp->crp_iv_start, csp->csp_ivlen, iv); 721 } 722 723 #endif /* _KERNEL */ 724 #endif /* _CRYPTO_CRYPTO_H_ */ 725