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