xref: /freebsd/contrib/wpa/wpa_supplicant/doc/docbook/wpa_passphrase.sgml (revision d5b0e70f7e04d971691517ce1304d86a1e367e2e)
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2
3<refentry>
4  <refentryinfo>
5    <date>07 August 2019</date>
6  </refentryinfo>
7
8  <refmeta>
9    <refentrytitle>wpa_passphrase</refentrytitle>
10    <manvolnum>8</manvolnum>
11  </refmeta>
12  <refnamediv>
13    <refname>wpa_passphrase</refname>
14    <refpurpose>Generate a WPA PSK from an ASCII passphrase for a SSID</refpurpose>
15  </refnamediv>
16  <refsynopsisdiv>
17    <cmdsynopsis>
18      <command>wpa_passphrase</command>
19      <arg><replaceable>ssid</replaceable></arg>
20      <arg><replaceable>passphrase</replaceable></arg>
21    </cmdsynopsis>
22  </refsynopsisdiv>
23
24  <refsect1>
25    <title>Overview</title>
26
27    <para><command>wpa_passphrase</command> pre-computes PSK entries for
28    network configuration blocks of a
29    <filename>wpa_supplicant.conf</filename> file. An ASCII passphrase
30    and SSID are used to generate a 256-bit PSK.</para>
31  </refsect1>
32
33  <refsect1>
34    <title>Options</title>
35    <variablelist>
36      <varlistentry>
37	<term>ssid</term>
38	<listitem>
39	  <para>The SSID whose passphrase should be derived.</para>
40	</listitem>
41      </varlistentry>
42
43      <varlistentry>
44	<term>passphrase</term>
45	<listitem>
46	  <para>The passphrase to use. If not included on the command line,
47	  passphrase will be read from standard input.</para>
48	</listitem>
49      </varlistentry>
50    </variablelist>
51  </refsect1>
52
53  <refsect1>
54    <title>See Also</title>
55    <para>
56      <citerefentry>
57	<refentrytitle>wpa_supplicant.conf</refentrytitle>
58	<manvolnum>5</manvolnum>
59      </citerefentry>
60      <citerefentry>
61	<refentrytitle>wpa_supplicant</refentrytitle>
62	<manvolnum>8</manvolnum>
63      </citerefentry>
64    </para>
65
66  </refsect1>
67  <refsect1>
68    <title>Legal</title>
69    <para>wpa_supplicant is copyright (c) 2003-2022,
70    Jouni Malinen <email>j@w1.fi</email> and
71    contributors.
72    All Rights Reserved.</para>
73
74    <para>This program is licensed under the BSD license (the one with
75    advertisement clause removed).</para>
76  </refsect1>
77</refentry>
78