share/man/man9/crypto.9

   1 .\"     $OpenBSD: crypto.9,v 1.19 2002/07/16 06:31:57 angelos Exp $
   2 .\"
   3 .\" The author of this manual page is Angelos D. Keromytis (angelos@cis.upenn.edu)
   4 .\"
   5 .\" Copyright (c) 2000, 2001 Angelos D. Keromytis
   6 .\"
   7 .\" Permission to use, copy, and modify this software with or without fee
   8 .\" is hereby granted, provided that this entire notice is included in
   9 .\" all source code copies of any software which is or includes a copy or
  10 .\" modification of this software.
  11 .\"
  12 .\" THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
  13 .\" IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
  14 .\" REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
  15 .\" MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
  16 .\" PURPOSE.
  17 .\"
  18 .\" $FreeBSD$
  19 .\"
  20 .Dd July 10, 2015
  21 .Dt CRYPTO 9
  22 .Os
  23 .Sh NAME
  24 .Nm crypto
  25 .Nd API for cryptographic services in the kernel
  26 .Sh SYNOPSIS
  27 .In opencrypto/cryptodev.h
  28 .Ft int32_t
  29 .Fn crypto_get_driverid device_t int
  30 .Ft int
  31 .Fn crypto_register uint32_t int uint16_t uint32_t "int \*[lp]*\*[rp]\*[lp]void *, uint32_t *, struct cryptoini *\*[rp]" "int \*[lp]*\*[rp]\*[lp]void *, uint64_t\*[rp]" "int \*[lp]*\*[rp]\*[lp]void *, struct cryptop *\*[rp]" "void *"
  32 .Ft int
  33 .Fn crypto_kregister uint32_t int uint32_t "int \*[lp]*\*[rp]\*[lp]void *, struct cryptkop *\*[rp]" "void *"
  34 .Ft int
  35 .Fn crypto_unregister uint32_t int
  36 .Ft int
  37 .Fn crypto_unregister_all uint32_t
  38 .Ft void
  39 .Fn crypto_done "struct cryptop *"
  40 .Ft void
  41 .Fn crypto_kdone "struct cryptkop *"
  42 .Ft int
  43 .Fn crypto_find_driver "const char *"
  44 .Ft int
  45 .Fn crypto_newsession "uint64_t *" "struct cryptoini *" int
  46 .Ft int
  47 .Fn crypto_freesession uint64_t
  48 .Ft int
  49 .Fn crypto_dispatch "struct cryptop *"
  50 .Ft int
  51 .Fn crypto_kdispatch "struct cryptkop *"
  52 .Ft int
  53 .Fn crypto_unblock uint32_t int
  54 .Ft "struct cryptop *"
  55 .Fn crypto_getreq int
  56 .Ft void
  57 .Fn crypto_freereq void
  58 .Bd -literal
  59 #define CRYPTO_SYMQ     0x1
  60 #define CRYPTO_ASYMQ    0x2
  61
  62 #define EALG_MAX_BLOCK_LEN      16
  63
  64 struct cryptoini {
  65         int                cri_alg;
  66         int                cri_klen;
  67         int                cri_mlen;
  68         caddr_t            cri_key;
  69         uint8_t            cri_iv[EALG_MAX_BLOCK_LEN];
  70         struct cryptoini  *cri_next;
  71 };
  72
  73 struct cryptodesc {
  74         int                crd_skip;
  75         int                crd_len;
  76         int                crd_inject;
  77         int                crd_flags;
  78         struct cryptoini   CRD_INI;
  79 #define crd_iv          CRD_INI.cri_iv
  80 #define crd_key         CRD_INI.cri_key
  81 #define crd_alg         CRD_INI.cri_alg
  82 #define crd_klen        CRD_INI.cri_klen
  83         struct cryptodesc *crd_next;
  84 };
  85
  86 struct cryptop {
  87         TAILQ_ENTRY(cryptop) crp_next;
  88         uint64_t           crp_sid;
  89         int                crp_ilen;
  90         int                crp_olen;
  91         int                crp_etype;
  92         int                crp_flags;
  93         caddr_t            crp_buf;
  94         caddr_t            crp_opaque;
  95         struct cryptodesc *crp_desc;
  96         int              (*crp_callback) (struct cryptop *);
  97         caddr_t            crp_mac;
  98 };
  99
 100 struct crparam {
 101         caddr_t         crp_p;
 102         u_int           crp_nbits;
 103 };
 104
 105 #define CRK_MAXPARAM    8
 106
 107 struct cryptkop {
 108         TAILQ_ENTRY(cryptkop) krp_next;
 109         u_int              krp_op;         /* ie. CRK_MOD_EXP or other */
 110         u_int              krp_status;     /* return status */
 111         u_short            krp_iparams;    /* # of input parameters */
 112         u_short            krp_oparams;    /* # of output parameters */
 113         uint32_t           krp_hid;
 114         struct crparam     krp_param[CRK_MAXPARAM];
 115         int               (*krp_callback)(struct cryptkop *);
 116 };
 117 .Ed
 118 .Sh DESCRIPTION
 119 .Nm
 120 is a framework for drivers of cryptographic hardware to register with
 121 the kernel so
 122 .Dq consumers
 123 (other kernel subsystems, and
 124 users through the
 125 .Pa /dev/crypto
 126 device) are able to make use of it.
 127 Drivers register with the framework the algorithms they support,
 128 and provide entry points (functions) the framework may call to
 129 establish, use, and tear down sessions.
 130 Sessions are used to cache cryptographic information in a particular driver
 131 (or associated hardware), so initialization is not needed with every request.
 132 Consumers of cryptographic services pass a set of
 133 descriptors that instruct the framework (and the drivers registered
 134 with it) of the operations that should be applied on the data (more
 135 than one cryptographic operation can be requested).
 136 .Pp
 137 Keying operations are supported as well.
 138 Unlike the symmetric operators described above,
 139 these sessionless commands perform mathematical operations using
 140 input and output parameters.
 141 .Pp
 142 Since the consumers may not be associated with a process, drivers may
 143 not
 144 .Xr sleep 9 .
 145 The same holds for the framework.
 146 Thus, a callback mechanism is used
 147 to notify a consumer that a request has been completed (the
 148 callback is specified by the consumer on a per-request basis).
 149 The callback is invoked by the framework whether the request was
 150 successfully completed or not.
 151 An error indication is provided in the latter case.
 152 A specific error code,
 153 .Er EAGAIN ,
 154 is used to indicate that a session number has changed and that the
 155 request may be re-submitted immediately with the new session number.
 156 Errors are only returned to the invoking function if not
 157 enough information to call the callback is available (meaning, there
 158 was a fatal error in verifying the arguments).
 159 For session initialization and teardown there is no callback mechanism used.
 160 .Pp
 161 The
 162 .Fn crypto_find_driver
 163 function may be called to return the specific id of the provided name.
 164 If the specified driver could not be found, the returned id is -1.
 165 .Pp
 166 The
 167 .Fn crypto_newsession
 168 routine is called by consumers of cryptographic services (such as the
 169 .Xr ipsec 4
 170 stack) that wish to establish a new session with the framework.
 171 The second argument contains all the necessary information for
 172 the driver to establish the session.
 173 The third argument is either a specific driver id, or one or both
 174 of
 175 .Dv CRYPTOCAP_F_HARDWARE ,
 176 to select hardware devices,
 177 or
 178 .Dv CRYPTOCAP_F_SOFTWARE ,
 179 to select software devices.
 180 If both are specified, a hardware device will be returned
 181 before a software device will be.
 182 On success, the value pointed to by the first argument will be the
 183 Session IDentifier (SID).
 184 The various fields in the
 185 .Vt cryptoini
 186 structure are:
 187 .Bl -tag -width ".Va cri_next"
 188 .It Va cri_alg
 189 Contains an algorithm identifier.
 190 Currently supported algorithms are:
 191 .Pp
 192 .Bl -tag -width ".Dv CRYPTO_RIPEMD160_HMAC" -compact
 193 .It Dv CRYPTO_AES_128_NIST_GMAC
 194 .It Dv CRYPTO_AES_192_NIST_GMAC
 195 .It Dv CRYPTO_AES_256_NIST_GMAC
 196 .It Dv CRYPTO_AES_CBC
 197 .It Dv CRYPTO_AES_ICM
 198 .It Dv CRYPTO_AES_NIST_GCM_16
 199 .It Dv CRYPTO_AES_NIST_GMAC
 200 .It Dv CRYPTO_AES_XTS
 201 .It Dv CRYPTO_ARC4
 202 .It Dv CRYPTO_BLF_CBC
 203 .It Dv CRYPTO_CAMELLIA_CBC
 204 .It Dv CRYPTO_CAST_CBC
 205 .It Dv CRYPTO_DEFLATE_COMP
 206 .It Dv CRYPTO_DES_CBC
 207 .It Dv CRYPTO_3DES_CBC
 208 .It Dv CRYPTO_MD5
 209 .It Dv CRYPTO_MD5_HMAC
 210 .It Dv CRYPTO_MD5_KPDK
 211 .It Dv CRYPTO_NULL_HMAC
 212 .It Dv CRYPTO_NULL_CBC
 213 .It Dv CRYPTO_RIPEMD160_HMAC
 214 .It Dv CRYPTO_SHA1
 215 .It Dv CRYPTO_SHA1_HMAC
 216 .It Dv CRYPTO_SHA1_KPDK
 217 .It Dv CRYPTO_SHA2_256_HMAC
 218 .It Dv CRYPTO_SHA2_384_HMAC
 219 .It Dv CRYPTO_SHA2_512_HMAC
 220 .It Dv CRYPTO_SKIPJACK_CBC
 221 .El
 222 .It Va cri_klen
 223 Specifies the length of the key in bits, for variable-size key
 224 algorithms.
 225 .It Va cri_mlen
 226 Specifies how many bytes from the calculated hash should be copied back.
 227 0 means entire hash.
 228 .It Va cri_key
 229 Contains the key to be used with the algorithm.
 230 .It Va cri_iv
 231 Contains an explicit initialization vector (IV), if it does not prefix
 232 the data.
 233 This field is ignored during initialization
 234 .Pq Nm crypto_newsession .
 235 If no IV is explicitly passed (see below on details), a random IV is used
 236 by the device driver processing the request.
 237 .It Va cri_next
 238 Contains a pointer to another
 239 .Vt cryptoini
 240 structure.
 241 Multiple such structures may be linked to establish multi-algorithm sessions
 242 .Xr ( ipsec 4
 243 is an example consumer of such a feature).
 244 .El
 245 .Pp
 246 The
 247 .Vt cryptoini
 248 structure and its contents will not be modified by the framework (or
 249 the drivers used).
 250 Subsequent requests for processing that use the
 251 SID returned will avoid the cost of re-initializing the hardware (in
 252 essence, SID acts as an index in the session cache of the driver).
 253 .Pp
 254 .Fn crypto_freesession
 255 is called with the SID returned by
 256 .Fn crypto_newsession
 257 to disestablish the session.
 258 .Pp
 259 .Fn crypto_dispatch
 260 is called to process a request.
 261 The various fields in the
 262 .Vt cryptop
 263 structure are:
 264 .Bl -tag -width ".Va crp_callback"
 265 .It Va crp_sid
 266 Contains the SID.
 267 .It Va crp_ilen
 268 Indicates the total length in bytes of the buffer to be processed.
 269 .It Va crp_olen
 270 On return, contains the total length of the result.
 271 For symmetric crypto operations, this will be the same as the input length.
 272 This will be used if the framework needs to allocate a new
 273 buffer for the result (or for re-formatting the input).
 274 .It Va crp_callback
 275 This routine is invoked upon completion of the request, whether
 276 successful or not.
 277 It is invoked through the
 278 .Fn crypto_done
 279 routine.
 280 If the request was not successful, an error code is set in the
 281 .Va crp_etype
 282 field.
 283 It is the responsibility of the callback routine to set the appropriate
 284 .Xr spl 9
 285 level.
 286 .It Va crp_etype
 287 Contains the error type, if any errors were encountered, or zero if
 288 the request was successfully processed.
 289 If the
 290 .Er EAGAIN
 291 error code is returned, the SID has changed (and has been recorded in the
 292 .Va crp_sid
 293 field).
 294 The consumer should record the new SID and use it in all subsequent requests.
 295 In this case, the request may be re-submitted immediately.
 296 This mechanism is used by the framework to perform
 297 session migration (move a session from one driver to another, because
 298 of availability, performance, or other considerations).
 299 .Pp
 300 Note that this field only makes sense when examined by
 301 the callback routine specified in
 302 .Va crp_callback .
 303 Errors are returned to the invoker of
 304 .Fn crypto_process
 305 only when enough information is not present to call the callback
 306 routine (i.e., if the pointer passed is
 307 .Dv NULL
 308 or if no callback routine was specified).
 309 .It Va crp_flags
 310 Is a bitmask of flags associated with this request.
 311 Currently defined flags are:
 312 .Bl -tag -width ".Dv CRYPTO_F_CBIFSYNC"
 313 .It Dv CRYPTO_F_IMBUF
 314 The buffer pointed to by
 315 .Va crp_buf
 316 is an mbuf chain.
 317 .It Dv CRYPTO_F_IOV
 318 The buffer pointed to by
 319 .Va crp_buf
 320 is an
 321 .Vt uio
 322 structure.
 323 .It Dv CRYPTO_F_BATCH
 324 Batch operation if possible.
 325 .It Dv CRYPTO_F_CBIMM
 326 Do callback immediately instead of doing it from a dedicated kernel thread.
 327 .It Dv CRYPTO_F_DONE
 328 Operation completed.
 329 .It Dv CRYPTO_F_CBIFSYNC
 330 Do callback immediately if operation is synchronous (that the driver
 331 specified the
 332 .Dv CRYPTOCAP_F_SYNC
 333 flag).
 334 .El
 335 .It Va crp_buf
 336 Points to the input buffer.
 337 On return (when the callback is invoked),
 338 it contains the result of the request.
 339 The input buffer may be an mbuf
 340 chain or a contiguous buffer,
 341 depending on
 342 .Va crp_flags .
 343 .It Va crp_opaque
 344 This is passed through the crypto framework untouched and is
 345 intended for the invoking application's use.
 346 .It Va crp_desc
 347 This is a linked list of descriptors.
 348 Each descriptor provides
 349 information about what type of cryptographic operation should be done
 350 on the input buffer.
 351 The various fields are:
 352 .Bl -tag -width ".Va crd_inject"
 353 .It Va crd_iv
 354 When the flag
 355 .Dv CRD_F_IV_EXPLICIT
 356 is set, this field contains the IV.
 357 .It Va crd_key
 358 When the
 359 .Dv CRD_F_KEY_EXPLICIT
 360 flag is set, the
 361 .Va crd_key
 362 points to a buffer with encryption or authentication key.
 363 .It Va crd_alg
 364 An algorithm to use.
 365 Must be the same as the one given at newsession time.
 366 .It Va crd_klen
 367 The
 368 .Va crd_key
 369 key length.
 370 .It Va crd_skip
 371 The offset in the input buffer where processing should start.
 372 .It Va crd_len
 373 How many bytes, after
 374 .Va crd_skip ,
 375 should be processed.
 376 .It Va crd_inject
 377 The
 378 .Va crd_inject
 379 field specifies an offset in bytes from the beginning of the buffer.
 380 For encryption algorithms, this may be where the IV will be inserted
 381 when encrypting or where the IV may be found for
 382 decryption (subject to
 383 .Va crd_flags ) .
 384 For MAC algorithms, this is where the result of the keyed hash will be
 385 inserted.
 386 .It Va crd_flags
 387 The following flags are defined:
 388 .Bl -tag -width 3n
 389 .It Dv CRD_F_ENCRYPT
 390 For encryption algorithms, this bit is set when encryption is required
 391 (when not set, decryption is performed).
 392 .It Dv CRD_F_IV_PRESENT
 393 .\" This flag name has nothing to do w/ it's behavior, fix the name.
 394 For encryption, if this bit is not set the IV used to encrypt the packet
 395 will be written at the location pointed to by
 396 .Va crd_inject .
 397 The IV length is assumed to be equal to the blocksize of the
 398 encryption algorithm.
 399 For encryption, if this bit is set, nothing is done.
 400 For decryption, this flag has no meaning.
 401 Applications that do special
 402 .Dq "IV cooking" ,
 403 such as the half-IV mode in
 404 .Xr ipsec 4 ,
 405 can use this flag to indicate that the IV should not be written on the packet.
 406 This flag is typically used in conjunction with the
 407 .Dv CRD_F_IV_EXPLICIT
 408 flag.
 409 .It Dv CRD_F_IV_EXPLICIT
 410 This bit is set when the IV is explicitly
 411 provided by the consumer in the
 412 .Va crd_iv
 413 field.
 414 Otherwise, for encryption operations the IV is provided for by
 415 the driver used to perform the operation, whereas for decryption
 416 operations the offset of the IV is provided by the
 417 .Va crd_inject
 418 field.
 419 This flag is typically used when the IV is calculated
 420 .Dq "on the fly"
 421 by the consumer, and does not precede the data (some
 422 .Xr ipsec 4
 423 configurations, and the encrypted swap are two such examples).
 424 .It Dv CRD_F_KEY_EXPLICIT
 425 For encryption and authentication (MAC) algorithms, this bit is set when the key
 426 is explicitly provided by the consumer in the
 427 .Va crd_key
 428 field for the given operation.
 429 Otherwise, the key is taken at newsession time from the
 430 .Va cri_key
 431 field.
 432 As calculating the key schedule may take a while, it is recommended that often
 433 used keys are given their own session.
 434 .It Dv CRD_F_COMP
 435 For compression algorithms, this bit is set when compression is required (when
 436 not set, decompression is performed).
 437 .El
 438 .It Va CRD_INI
 439 This
 440 .Vt cryptoini
 441 structure will not be modified by the framework or the device drivers.
 442 Since this information accompanies every cryptographic
 443 operation request, drivers may re-initialize state on-demand
 444 (typically an expensive operation).
 445 Furthermore, the cryptographic
 446 framework may re-route requests as a result of full queues or hardware
 447 failure, as described above.
 448 .It Va crd_next
 449 Point to the next descriptor.
 450 Linked operations are useful in protocols such as
 451 .Xr ipsec 4 ,
 452 where multiple cryptographic transforms may be applied on the same
 453 block of data.
 454 .El
 455 .El
 456 .Pp
 457 .Fn crypto_getreq
 458 allocates a
 459 .Vt cryptop
 460 structure with a linked list of as many
 461 .Vt cryptodesc
 462 structures as were specified in the argument passed to it.
 463 .Pp
 464 .Fn crypto_freereq
 465 deallocates a structure
 466 .Vt cryptop
 467 and any
 468 .Vt cryptodesc
 469 structures linked to it.
 470 Note that it is the responsibility of the
 471 callback routine to do the necessary cleanups associated with the
 472 opaque field in the
 473 .Vt cryptop
 474 structure.
 475 .Pp
 476 .Fn crypto_kdispatch
 477 is called to perform a keying operation.
 478 The various fields in the
 479 .Vt cryptkop
 480 structure are:
 481 .Bl -tag -width ".Va krp_callback"
 482 .It Va krp_op
 483 Operation code, such as
 484 .Dv CRK_MOD_EXP .
 485 .It Va krp_status
 486 Return code.
 487 This
 488 .Va errno Ns -style
 489 variable indicates whether lower level reasons
 490 for operation failure.
 491 .It Va krp_iparams
 492 Number if input parameters to the specified operation.
 493 Note that each operation has a (typically hardwired) number of such parameters.
 494 .It Va krp_oparams
 495 Number if output parameters from the specified operation.
 496 Note that each operation has a (typically hardwired) number of such parameters.
 497 .It Va krp_kvp
 498 An array of kernel memory blocks containing the parameters.
 499 .It Va krp_hid
 500 Identifier specifying which low-level driver is being used.
 501 .It Va krp_callback
 502 Callback called on completion of a keying operation.
 503 .El
 504 .Sh DRIVER-SIDE API
 505 The
 506 .Fn crypto_get_driverid ,
 507 .Fn crypto_register ,
 508 .Fn crypto_kregister ,
 509 .Fn crypto_unregister ,
 510 .Fn crypto_unblock ,
 511 and
 512 .Fn crypto_done
 513 routines are used by drivers that provide support for cryptographic
 514 primitives to register and unregister with the kernel crypto services
 515 framework.
 516 .Pp
 517 Drivers must first use the
 518 .Fn crypto_get_driverid
 519 function to acquire a driver identifier, specifying the
 520 .Fa flags
 521 as an argument.
 522 One of
 523 .Dv CRYPTOCAP_F_SOFTWARE
 524 or
 525 .Dv CRYPTOCAP_F_HARDWARE
 526 must be specified.
 527 The
 528 .Dv CRYPTOCAP_F_SYNC
 529 may also be specified, and should be specified if the driver does all of
 530 it's operations synchronously.
 531 .Pp
 532 For each algorithm the driver supports, it must then call
 533 .Fn crypto_register .
 534 The first two arguments are the driver and algorithm identifiers.
 535 The next two arguments specify the largest possible operator length (in bits,
 536 important for public key operations) and flags for this algorithm.
 537 The last four arguments must be provided in the first call to
 538 .Fn crypto_register
 539 and are ignored in all subsequent calls.
 540 They are pointers to three
 541 driver-provided functions that the framework may call to establish new
 542 cryptographic context with the driver, free already established
 543 context, and ask for a request to be processed (encrypt, decrypt,
 544 etc.); and an opaque parameter to pass when calling each of these routines.
 545 .Pp
 546 .Fn crypto_unregister
 547 is called by drivers that wish to withdraw support for an algorithm.
 548 The two arguments are the driver and algorithm identifiers, respectively.
 549 Typically, drivers for
 550 PCMCIA
 551 crypto cards that are being ejected will invoke this routine for all
 552 algorithms supported by the card.
 553 .Fn crypto_unregister_all
 554 will unregister all algorithms registered by a driver
 555 and the driver will be disabled (no new sessions will be allocated on
 556 that driver, and any existing sessions will be migrated to other
 557 drivers).
 558 The same will be done if all algorithms associated with a driver are
 559 unregistered one by one.
 560 After a call to
 561 .Fn crypto_unregister_all
 562 there will be no threads in either the newsession or freesession function
 563 of the driver.
 564 .Pp
 565 The calling convention for the three driver-supplied routines are:
 566 .Pp
 567 .Bl -item -compact
 568 .It
 569 .Ft int
 570 .Fn \*[lp]*newsession\*[rp] "device_t" "uint32_t *" "struct cryptoini *" ;
 571 .It
 572 .Ft int
 573 .Fn \*[lp]*freesession\*[rp] "device_t" "uint64_t" ;
 574 .It
 575 .Ft int
 576 .Fn \*[lp]*process\*[rp] "device_t" "struct cryptop *" "int" ;
 577 .It
 578 .Ft int
 579 .Fn \*[lp]*kprocess\*[rp] "device_t" "struct cryptkop *" "int" ;
 580 .El
 581 .Pp
 582 On invocation, the first argument to
 583 all routines is the
 584 .Fa device_t
 585 that was provided to
 586 .Fn crypto_get_driverid .
 587 The second argument to
 588 .Fn newsession
 589 contains the driver identifier obtained via
 590 .Fn crypto_get_driverid .
 591 On successful return, it should contain a driver-specific session
 592 identifier.
 593 The third argument is identical to that of
 594 .Fn crypto_newsession .
 595 .Pp
 596 The
 597 .Fn freesession
 598 routine takes as arguments the opaque data value and the SID
 599 (which is the concatenation of the
 600 driver identifier and the driver-specific session identifier).
 601 It should clear any context associated with the session (clear hardware
 602 registers, memory, etc.).
 603 .Pp
 604 The
 605 .Fn process
 606 routine is invoked with a request to perform crypto processing.
 607 This routine must not block or sleep, but should queue the request and return
 608 immediately or process the request to completion.
 609 In case of an unrecoverable error, the error indication must be placed in the
 610 .Va crp_etype
 611 field of the
 612 .Vt cryptop
 613 structure.
 614 When the request is completed, or an error is detected, the
 615 .Fn process
 616 routine must invoke
 617 .Fn crypto_done .
 618 Session migration may be performed, as mentioned previously.
 619 .Pp
 620 In case of a temporary resource exhaustion, the
 621 .Fn process
 622 routine may return
 623 .Er ERESTART
 624 in which case the crypto services will requeue the request, mark the driver
 625 as
 626 .Dq blocked ,
 627 and stop submitting requests for processing.
 628 The driver is then responsible for notifying the crypto services
 629 when it is again able to process requests through the
 630 .Fn crypto_unblock
 631 routine.
 632 This simple flow control mechanism should only be used for short-lived
 633 resource exhaustion as it causes operations to be queued in the crypto
 634 layer.
 635 Doing so is preferable to returning an error in such cases as
 636 it can cause network protocols to degrade performance by treating the
 637 failure much like a lost packet.
 638 .Pp
 639 The
 640 .Fn kprocess
 641 routine is invoked with a request to perform crypto key processing.
 642 This routine must not block, but should queue the request and return
 643 immediately.
 644 Upon processing the request, the callback routine should be invoked.
 645 In case of an unrecoverable error, the error indication must be placed in the
 646 .Va krp_status
 647 field of the
 648 .Vt cryptkop
 649 structure.
 650 When the request is completed, or an error is detected, the
 651 .Fn kprocess
 652 routine should invoked
 653 .Fn crypto_kdone .
 654 .Sh RETURN VALUES
 655 .Fn crypto_register ,
 656 .Fn crypto_kregister ,
 657 .Fn crypto_unregister ,
 658 .Fn crypto_newsession ,
 659 .Fn crypto_freesession ,
 660 and
 661 .Fn crypto_unblock
 662 return 0 on success, or an error code on failure.
 663 .Fn crypto_get_driverid
 664 returns a non-negative value on error, and \-1 on failure.
 665 .Fn crypto_getreq
 666 returns a pointer to a
 667 .Vt cryptop
 668 structure and
 669 .Dv NULL
 670 on failure.
 671 .Fn crypto_dispatch
 672 returns
 673 .Er EINVAL
 674 if its argument or the callback function was
 675 .Dv NULL ,
 676 and 0 otherwise.
 677 The callback is provided with an error code in case of failure, in the
 678 .Va crp_etype
 679 field.
 680 .Sh FILES
 681 .Bl -tag -width ".Pa sys/opencrypto/crypto.c"
 682 .It Pa sys/opencrypto/crypto.c
 683 most of the framework code
 684 .El
 685 .Sh SEE ALSO
 686 .Xr crypto 4 ,
 687 .Xr ipsec 4 ,
 688 .Xr crypto 7 ,
 689 .Xr malloc 9 ,
 690 .Xr sleep 9
 691 .Sh HISTORY
 692 The cryptographic framework first appeared in
 693 .Ox 2.7
 694 and was written by
 695 .An Angelos D. Keromytis Aq Mt angelos@openbsd.org .
 696 .Sh BUGS
 697 The framework currently assumes that all the algorithms in a
 698 .Fn crypto_newsession
 699 operation must be available by the same driver.
 700 If that is not the case, session initialization will fail.
 701 .Pp
 702 The framework also needs a mechanism for determining which driver is
 703 best for a specific set of algorithms associated with a session.
 704 Some type of benchmarking is in order here.
 705 .Pp
 706 Multiple instances of the same algorithm in the same session are not
 707 supported.
 708 Note that 3DES is considered one algorithm (and not three
 709 instances of DES).
 710 Thus, 3DES and DES could be mixed in the same request.