share/man/man4/ubsec.4

   1 .\"     $OpenBSD: ubsec.4,v 1.18 2002/09/26 07:55:41 miod Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Jason L. Wright (jason@thought.net)
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by Jason L. Wright
  17 .\" 4. The name of the author may not be used to endorse or promote products
  18 .\"    derived from this software without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  24 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  25 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  26 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  28 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  29 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 .\" POSSIBILITY OF SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd February 28, 2003
  35 .Dt UBSEC 4
  36 .Os
  37 .Sh NAME
  38 .Nm ubsec
  39 .Nd Broadcom and BlueSteel uBsec 5x0x crypto accelerator
  40 .Sh SYNOPSIS
  41 .Cd device ubsec
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver supports cards containing any of the following chips:
  46 .Bl -tag -width "Broadcom BCM5822" -offset indent
  47 .It Bluesteel 5501
  48 The original chipset, no longer made.
  49 This extremely rare unit
  50 was not very fast, lacked a RNG, and had a number of other bugs.
  51 .It Bluesteel 5601
  52 A faster and fixed version of the original, with a random number
  53 unit and large number engine added.
  54 .It Broadcom BCM5801
  55 A BCM5805 without public key engine or random number generator.
  56 .It Broadcom BCM5802
  57 A slower version of the BCM5805.
  58 .It Broadcom BCM5805
  59 Faster version of Bluesteel 5601.
  60 .It Broadcom BCM5820
  61 64 bit version of the chip, and significantly more advanced.
  62 .It Broadcom BCM5821
  63 Faster version of the BCM5820.
  64 .It Broadcom BCM5822
  65 Faster version of the BCM5820.
  66 .It Broadcom BCM5823
  67 A BCM5822 with AES capability.
  68 .El
  69 .Pp
  70 The
  71 .Nm
  72 driver registers itself to accelerate DES, Triple-DES, MD5-HMAC,
  73 and SHA1-HMAC operations for
  74 .Xr ipsec 4
  75 and
  76 .Xr crypto 4 .
  77 .Pp
  78 On those models which contain a public key engine (almost all of the
  79 more recent ones), this feature is registered with the
  80 .Xr crypto 4
  81 subsystem.
  82 .Pp
  83 On all models except the Bluesteel 5501 and Broadcom 5801, the driver
  84 registers itself to provide random data to the
  85 .Xr random 4
  86 subsystem.
  87 .Sh SEE ALSO
  88 .Xr crypt 3 ,
  89 .Xr crypto 4 ,
  90 .Xr intro 4 ,
  91 .Xr ipsec 4 ,
  92 .Xr random 4 ,
  93 .Xr crypto 9
  94 .Sh HISTORY
  95 The
  96 .Nm
  97 device driver appeared in
  98 .Ox 2.8 .
  99 The
 100 .Nm
 101 device driver was imported to
 102 .Fx 5.0 .
 103 .Sh BUGS
 104 The BCM5801 and BCM5802 have not actually been tested.
 105 The AES capability of the BCM5823 is not yet supported; it is awaiting
 106 public disclosure of programming information from Broadcom.