source: postlfs/security/ssh-askpass.xml@ 295ca00

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY ssh-askpass-download-http
    "http://ftp.openbsd.org/pub/OpenBSD/OpenSSH/portable/openssh-&ssh-askpass-version;.tar.gz">
  <!ENTITY ssh-askpass-download-ftp
    "ftp://ftp.openbsd.org/pub/OpenBSD/OpenSSH/portable/openssh-&ssh-askpass-version;.tar.gz">
  <!ENTITY ssh-askpass-md5sum        "4d8547670e2a220d5ef805ad9e47acf2">
  <!ENTITY ssh-askpass-size          "1.5 MB">
  <!ENTITY ssh-askpass-buildsize     "8.2  MB">
  <!ENTITY ssh-askpass-time          "less than 0.1 SBU">
]>

<sect1 id="ssh-askpass" xreflabel="ssh-askpass-&ssh-askpass-version;">
  <?dbhtml filename="ssh-askpass.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>ssh-askpass-&ssh-askpass-version;</title>

  <indexterm zone="ssh-askpass">
    <primary sortas="a-ssh-askpass">ssh-askpass</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ssh-askpass</title>

  <para>
    The <application>ssh-askpass</application> is a generic executable name for
    many packages, with similar names, that provide a interactive X service to
    grab password for packages requiring administrative privileges to be run.
    It prompts the user with a window box where the necessary password can be
    inserted. Here, we choose Damien Miller's package distributed in the
    <application>OpenSSH</application> tarball.</para>

    &lfs77_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&ssh-askpass-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&ssh-askpass-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &ssh-askpass-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &ssh-askpass-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &ssh-askpass-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &ssh-askpass-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">ssh-askpass Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="gtk2"/>,
    <xref linkend="sudo"/> (runtime),
    <xref linkend="xorg7-lib"/>, and
    <xref linkend="x-window-system"/> (runtime)</para>

    <para condition="html" role="usernotes">
        User Notes: <ulink url='&blfs-wiki;/ssh-askpass'/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of ssh-askpass</title>

    <para>
      Install <application>ssh-askpass</application> by running the following
      commands:
    </para>

<screen><userinput>cd contrib &amp;&amp;
make gnome-ssh-askpass2</userinput></screen>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>install -v -d -m755                  /usr/libexec/openssh/contrib     &amp;&amp;
install -v -m755  gnome-ssh-askpass2 /usr/libexec/openssh/contrib     &amp;&amp;
ln -sv -f contrib/gnome-ssh-askpass2 /usr/libexec/openssh/ssh-askpass</userinput></screen>

    <para>
     The use of /usr/libexec/openssh/contrib and a symlink is justified by the
     eventual necessity of a different program for that service.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring ssh-askpass</title>

    <sect3 id="ssh-askpass-config">
      <title>Configuration Information</title>

        <para>
          As the <systemitem class="username">root</systemitem> user, configure
          <xref linkend="sudo"/> to use <application>ssh-askpass</application>:
        </para>

<screen role="root"><userinput>cat &gt;&gt; /etc/sudo.conf &lt;&lt; "EOF" &amp;&amp;
<literal># Path to askpass helper program
Path askpass /usr/libexec/openssh/ssh-askpass</literal>
EOF
chmod -v 0644 /etc/sudo.conf</userinput></screen>

        <para>
          If a given graphical &lt;application&gt; requires administrative
          privileges, use <command>sudo -A &lt;application&gt;</command> from an
          x-terminal, from a Window Manager menu and/or replace
          "Exec=&lt;application&gt; ..." by
          "Exec=sudo -A &lt;application&gt; ..." in the
          &lt;application&gt;.desktop file.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          ssh-askpass (symlink)
          and gnome-ssh-askpass2 in /usr/libexec/openssh.
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/libexec/openssh/contrib
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gnome-ssh-askpass2-prog">
        <term><command>gnome-ssh-askpass2</command></term>
        <listitem>
          <para>
            is the program helper agent used to grab a password.
          </para>
          <indexterm zone="ssh-askpass gnome-ssh-askpass2-prog">
            <primary sortas="b-gnome-ssh-askpass2">scp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ssh-askpass-prog">
        <term><command>ssh-askpass</command></term>
        <listitem>
          <para>
            is a symlink to the program helper agent used to grab a password.
          </para>
          <indexterm zone="ssh-askpass ssh-askpass-prog">
            <primary sortas="b-ssh-askpass">scp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>