share/man/man4/ubsec.4

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