Add the ieee80211(9) API manual pages.
[dragonfly.git] / share / man / man9 / ieee80211_crypto.9
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 .\" $DragonFly: src/share/man/man9/ieee80211_crypto.9,v 1.1 2004/07/27 14:50:56 hmp Exp $
29 .\" $Id: ieee80211_crypto.9,v 1.2 2004/07/07 12:59:39 ru Exp $
30 .\"
31 .Dd March 2, 2004
32 .Dt IEEE80211_CRYPTO 9
33 .Os
34 .Sh NAME
35 .Nm ieee80211_crypto_attach , ieee80211_crypto_detach , ieee80211_wep_crypt
36 .Nd 802.11 WEP encryption functions
37 .Sh SYNOPSIS
38 .Ft void
39 .Fn ieee80211_crypto_attach "struct ifnet *ifp"
40 .Ft void
41 .Fn ieee80211_crypto_detach "struct ifnet *ifp"
42 .Ft struct mbuf *
43 .Fn ieee80211_wep_crypt "struct ifnet *ifp" "struct mbuf *m0" "int txflag"
44 .Sh DESCRIPTION
45 These functions provide software encryption support
46 for 802.11 device drivers.
47 .Pp
48 .\"
49 The
50 .Fn ieee80211_crypto_attach
51 function initializes crypto support for the interface
52 .Fa ifp ,
53 and sets the initialization vector (IV) for WEP encryption to
54 a random number derived from a secure PRNG.
55 .Pp
56 .\"
57 The
58 .Fn ieee80211_crypto_detach
59 function frees data structures associated with crypto support
60 for the interface
61 .Fa ifp .
62 .Pp
63 .\"
64 The
65 .Fn ieee80211_wep_crypt
66 function runs the appropriate WEP encryption algorithm over the 802.11
67 encapsulated frame held in the mbuf chain
68 .Fa m0 ,
69 for transmission or reception on the interface
70 .Fa ifp .
71 The
72 .Fa txflag
73 argument specifies whether the frame is being received or transmitted.
74 A value of 0 indicates that the frame is being received and should
75 therefore be decrypted; a non-zero value indicates that the frame
76 is being transmitted
77 and should be encrypted.
78 .\"
79 .Sh IMPLEMENTATION NOTES
80 The
81 .Fn ieee80211_wep_crypt
82 function stores its IV in the interface's embedded
83 .Vt struct ieee80211com
84 instance.
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
92 The
93 .Nm ieee80211
94 series of functions first appeared in
95 .Nx 1.5 ,
96 and were later ported to
97 .Fx 4.6 .
98 .Sh AUTHORS
99 .An -nosplit
100 This man page was written by
101 .An Bruce M. Simpson Aq bms@FreeBSD.org
102 and
103 .An Darron Broad Aq darron@kewl.org .