|ssh-askpass(1)||General Commands Manual||ssh-askpass(1)|
ssh-askpass — an
X11-based pass-phrase dialog for use with OpenSSH
ssh-askpass is an X11-based pass-phrase
dialog for use with OpenSSH. It is intended to be called from the
ssh-add(1) program and not invoked
ssh-askpass supports most standard Toolkit
command line arguments, with the exception of
-iconic, -rv, and
-title. See X(7).
If exactly one non-option argument is provided on the command line, it is displayed in the dialog instead of the default label. If the argument contains newline characters ('\n'), each line of text is displayed on a separate line in the dialog.
The features of
ssh-askpass are as
The user interface is somewhat different than most password/pass-phrase dialogs and more similar to the X11-based pass-phrase dialog that accompanies the regular SSH distribution. Instead of a text field that fills with asterisks or some other character as the user enters the pass-phrase, a series of LED-like areas light up one-by-one with each pass-phrase character entered, beginning from the left-hand edge of the dialog. When they reach the right-hand edge, they go dark one-by-one again, and so on. This gives the user feedback that pass-phrase characters have been entered, but does not provide onlookers with a cue as to the length of the pass-phrase.
Pressing the ‘OK’ button accepts the pass-phrase (even if it is empty), which is printed on the standard output, and the dialog exits with a status of zero (success). Pressing the ‘Cancel’ button discards the pass-phrase, and the dialog exits with non-zero status.
The following keystrokes work as expected:
The main window of
ssh-askpass has the
widget hierarchy indicated below. The widget class name is given first,
followed by the instance name.
The following resources are used to customize the application globally:
ssh-askpassshould wait for a key or button press before it gives up and exits. A timeout of “0” means wait forever.
/) and a one- or two-character unit abbreviation. Valid units are inches (
i) and meters (
defaultXResolutionbeyond which some widgets will be stretched or shrunk horizontally to fit the current actual horizontal resolution. Valid values are the same as for
defaultXResolution. For example, if the default X resolution is “75/in”, and the X resolution fuzz is “50/in”, then widgets won't be scaled horizontally unless the actual horizontal resolution is less than 25 pixels per inch or greater than 125 pixels per inch.
defaultYResolutionbeyond which some widgets will be stretched or shrunk vertically to fit the current actual vertical resolution. Valid values are the same as for
The following resources are recognized by the Dialog widget:
The following Resources are recognized by the dialog, button, and indicator widgets and the main widget to customize the 3D appearance (all measurements are in pixels):
The following resources are recognized by the indicator widgets:
Each button uses the following resources to customize its label:
Some portions of
ssh-askpass are derived
directly or indirectly from portions of xscreensaver by Jamie Zawinski
⟨email@example.com⟩, while others are original works.
xscreensaver, Copyright © 1991-1999 Jamie Zawinski ⟨firstname.lastname@example.org⟩
Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
The remaining portions fall under the following copyright and license:
ssh-askpass by Jim Knoble
⟨email@example.com⟩ Copyright © 1999,2000,2001 Jim
Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation.
|February 14, 2001||Version 1.2.0|