xref: /dragonfly/share/man/man9/ieee80211_crypto.9 (revision f746689a)
1.\"
2.\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\" $DragonFly: src/share/man/man9/ieee80211_crypto.9,v 1.3 2006/06/28 19:41:59 swildner Exp $
32.\"
33.Dd June 28, 2006
34.Dt IEEE80211_CRYPTO 9
35.Os
36.Sh NAME
37.Nm ieee80211_crypto_encap
38.Nd 802.11 encryption function
39.Sh SYNOPSIS
40.In netproto/802_11/ieee80211_var.h
41.Ft struct ieee80211_key *
42.Fo ieee80211_crypto_encap
43.Fa "struct ieee80211com *ic" "struct ieee80211_node *ni" "struct mbuf *m"
44.Fc
45.Sh DESCRIPTION
46This function provides software encryption support
47for 802.11 device drivers.
48.Pp
49.\"
50The
51.Fn ieee80211_crypto_encap
52function runs the appropriate encryption algorithm over the 802.11
53encapsulated frame held in the mbuf chain
54.Fa m ,
55for transmission on the interface
56.Fa ic .
57The
58.Fa ni
59argument specifies the target to which the encrypted frame will be transmitted.
60It must not be
61.Dv NULL ,
62and is typically the return value of
63.Xr ieee80211_find_txnode 9 .
64.\"
65.Sh IMPLEMENTATION NOTES
66The key used to encrypt unicast frames is stored in
67.Fa ni .
68.\"
69.Sh RETURN VALUES
70If successful,
71the key used to encrypt the frame is returned.
72Otherwise,
73.Dv NULL
74is returned.
75.\"
76.Sh SEE ALSO
77.Xr ieee80211 9 ,
78.Xr ifnet 9
79.Sh HISTORY
80The
81.Nm ieee80211
82series of functions first appeared in
83.Nx 1.5 ,
84and were later ported to
85.Fx 4.6 .
86.Sh AUTHORS
87.An -nosplit
88This man page was written by
89.An Sepherosa Ziehau
90and
91.An Sascha Wildner .
92