xref: /freebsd/share/man/man9/ieee80211_crypto.9 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
1.\"
2.\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
3.\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\" $Id: ieee80211_crypto.9,v 1.3 2004/03/04 10:42:56 bruce Exp $
29.\"
30.Dd March 2, 2004
31.Dt ieee80211_crypto 9
32.Os
33.Sh NAME
34.Nm ieee80211_crypto
35.Nd 802.11 WEP encryption functions
36.Sh SYNOPSIS
37.Ft void
38.Fn ieee80211_crypto_attach "struct ifnet *ifp"
39.Ft void
40.Fn ieee80211_crypto_detach "struct ifnet *ifp"
41.Ft struct mbuf *
42.Fn ieee80211_wep_crypt "struct ifnet *ifp" "struct mbuf *m0" "int txflag"
43.Sh DESCRIPTION
44The
45.Nm
46collection of functions provide software encryption support
47for 802.11 device drivers.
48.Pp
49.\"
50The
51.Fn ieee80211_crypto_attach
52function initializes crypto support for the interface
53.Fa ifp ,
54and sets the initialization vector (IV) for WEP encryption to
55a random number derived from a secure PRNG.
56.Pp
57.\"
58The
59.Fn ieee80211_crypto_detach
60function frees data structures associated with crypto support
61for the interface
62.Fa ifp .
63.Pp
64.\"
65The
66.Fn ieee80211_wep_crypt
67function runs the appropriate WEP encryption algorithm over the 802.11
68encapsulated frame held in the mbuf chain
69.Fa m0 ,
70for transmission or reception on the interface
71.Fa ifp .
72The
73.Fa txflag
74argument specifies whether the frame is being received or transmitted.
75A value of 0 indicates that the frame is being received and should
76therefore be decrypted; a non-zero value indicates that the frame
77and should be encrypted.
78.\"
79.Sh IMPLEMENTATION NOTES
80The
81.Fn ieee80211_wep_crypt
82function stores its IV in the interface's embedded
83.Vt struct ieee80211com
84instance.
85.Sh SEE ALSO
86.Xr awi 4 ,
87.Xr wi 4 ,
88.Xr arc4random 9 ,
89.Xr ieee80211 9 ,
90.Xr ifnet 9
91.Sh HISTORY
92The
93.Nm
94series of functions first appeared in
95.Nx 1.5 ,
96and were later ported to
97.Fx 4.6 .
98.Sh AUTHORS
99This man page was written by
100.An Bruce M. Simpson Aq bms@FreeBSD.org
101and
102.An Darron Broad Aq darron@kewl.org .
103