xref: /src/external/bsd/wpa/dist/wpa_supplicant/doc/docbook/wpa_passphrase.sgml

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

<refentry>
  <refentryinfo>
    <date>07 August 2019</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>wpa_passphrase</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>wpa_passphrase</refname>
    <refpurpose>Generate a WPA PSK from an ASCII passphrase for a SSID</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>wpa_passphrase</command>
      <arg><replaceable>ssid</replaceable></arg>
      <arg><replaceable>passphrase</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Overview</title>

    <para><command>wpa_passphrase</command> pre-computes PSK entries for
    network configuration blocks of a
    <filename>wpa_supplicant.conf</filename> file. An ASCII passphrase
    and SSID are used to generate a 256-bit PSK.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
	<term>ssid</term>
	<listitem>
	  <para>The SSID whose passphrase should be derived.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>passphrase</term>
	<listitem>
	  <para>The passphrase to use. If not included on the command line,
	  passphrase will be read from standard input.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry>
	<refentrytitle>wpa_supplicant.conf</refentrytitle>
	<manvolnum>5</manvolnum>
      </citerefentry>
      <citerefentry>
	<refentrytitle>wpa_supplicant</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>
    </para>

  </refsect1>
  <refsect1>
    <title>Legal</title>
    <para>wpa_supplicant is copyright (c) 2003-2022,
    Jouni Malinen <email>j (a] w1.fi</email> and
    contributors.
    All Rights Reserved.</para>

    <para>This program is licensed under the BSD license (the one with
    advertisement clause removed).</para>
  </refsect1>
</refentry>