xref: /netbsd-src/share/man/man9/ieee80211_crypto.9 (revision 6cb10275d08f045e872662c371fe2f2724f2f6e6)
1.\" $NetBSD: ieee80211_crypto.9,v 1.5 2014/03/18 18:20:40 riastradh Exp $
2.\"
3.\" Copyright (c) 2004 Bruce M. Simpson <bms@spc.org>
4.\" Copyright (c) 2004 Darron Broad <darron@kewl.org>
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man9/ieee80211_crypto.9,v 1.2 2004/07/07 12:59:39 ru Exp $
29.\"
30.Dd September 12, 2006
31.Dt IEEE80211_CRYPTO 9
32.Os
33.Sh NAME
34.Nm ieee80211_crypto_attach , ieee80211_crypto_detach , ieee80211_crypto_encap
35.Nd 802.11 WEP encryption functions
36.Sh SYNOPSIS
37.Ft void
38.Fn ieee80211_crypto_attach "struct ieee80211com *ic"
39.Ft void
40.Fn ieee80211_crypto_detach "struct ieee80211com *ic"
41.Ft struct ieee80211_key *
42.Fo ieee80211_crypto_encap
43.Fa "struct ieee80211com *ic" "struct ieee80211_node *ni" "struct mbuf *m0"
44.Fc
45.Sh DESCRIPTION
46These functions provide encryption support for 802.11 device drivers.
47.Pp
48.\"
49The
50.Fn ieee80211_crypto_attach
51function initializes crypto support for the interface
52.Fa ic .
53The default is null crypto.
54.Pp
55.\"
56The
57.Fn ieee80211_crypto_detach
58function frees data structures associated with crypto support
59for the interface
60.Fa ic .
61.Pp
62.\"
63The two above functions are automatically called by the interface
64attach and detach routines, respectively.
65.Pp
66.\"
67The
68.Fn ieee80211_crypto_encap
69function encapsulates the packet supplied in mbuf
70.Fa m0 ,
71with the crypto headers given the for node
72.Fa ni .
73Software encryption is possibly performed.
74In case of no specified key for
75.Fa ni
76or multicast traffic, the default key for the interface
77.Fa ic
78is used for encapsulation.
79The key is returned in the case of successful encapsulation,
80otherwise
81.Dv NULL
82is returned.
83.\"
84.Sh SEE ALSO
85.Xr ieee80211 9
86.Sh HISTORY
87The
88.Nm ieee80211
89series of functions first appeared in
90.Nx 1.5 ,
91and were later ported to
92.Fx 4.6 .
93.Sh AUTHORS
94.An -nosplit
95This man page was written by
96.An Bruce M. Simpson Aq Mt bms@FreeBSD.org
97and
98.An Darron Broad Aq Mt darron@kewl.org .
99