1x11-ssh-askpass(1) BSD General Commands Manual x11-ssh-askpass(1)
2
4 x11-ssh-askpass — an X11-based pass-phrase dialog for use with OpenSSH
5
7 x11-ssh-askpass [options] [label]
8
10 x11-ssh-askpass is an X11-based pass-phrase dialog for use with OpenSSH.
11 It is intended to be called from the ssh-add(1) program and not invoked
12 directly.
13 x11-ssh-askpass supports most standard Toolkit command line arguments,
15 with the exception of -geometry, -borderwidth, -iconic, -rv, and -title.
16 See X(1).
17 If exactly one non-option argument is provided on the command line, it is
19 displayed in the dialog instead of the default label. If the argument
20 contains newline characters ('\n'), each line of text is displayed on a
21 separate line in the dialog.
22 The features of x11-ssh-askpass are as follows:
24 - Configurable via the standard X resource mechanisms
26 /usr/X11R6/lib/X11/app-defaults, ~/.Xdefaults, xrdb(1), etc.
27 - Requires only stock X11 libraries (libXt, libX11, libSM,
29 libICE).
30 - Can be configured to grab the keyboard and/or pointer (grabs
32 the keyboard by default, not the pointer).
33 The user interface is somewhat different than most password/pass-phrase
35 dialogs and more similar to the X11-based pass-phrase dialog that accom‐
36 panies the regular SSH distribution. Instead of a text field that fills
37 with asterisks or some other character as the user enters the pass-
38 phrase, a series of LED-like areas light up one-by-one with each pass-
39 phrase character entered, beginning from the left-hand edge of the dia‐
40 log. When they reach the right-hand edge, they go dark one-by-one again,
41 and so on. This gives the user feedback that pass-phrase characters have
42 been entered, but does not provide onlookers with a cue as to the length
43 of the pass-phrase.
44 Pressing the ‘OK’ button accepts the pass-phrase (even if it is empty),
46 which is printed on the standard output, and the dialog exits with a sta‐
47 tus of zero (success). Pressing the ‘Cancel’ button discards the pass-
48 phrase, and the dialog exits with non-zero status.
49 The following keystrokes work as expected:
51 [Backspace]
53 [Delete] Erase previous character
54 [Control+U]
56 [Control+X] Erase entire pass-phrase
57 [Enter]
59 [Control+M]
60 [Control+J] Accept pass-phrase (OK)
61 [Escape] Discard pass-phrase (Cancel)
63
65 The main window of x11-ssh-askpass has the widget hierarchy indicated
66 below. The widget class name is given first, followed by the instance
67 name.
68 Dialog dialog
70 Indicator indicator
72 Button okButton
73 Button cancelButton
74
76 The following resources are used to customize the application globally:
77 grabKeyboard (class GrabKeyboard)
79 specifies if the application should grab the keyboard.
80 Default value: “True”.
81 grabPointer (class GrabPointer)
83 specifies if the application should grab the pointer.
84 Default value: “False”.
85 grabServer (class GrabServer)
87 specifies if the application should grab the server.
88 Default value: “False”.
89 inputTimeout (class InputTimeout)
91 the number of seconds x11-ssh-askpass should wait for a key or
92 button press before it gives up and exits. A timeout of “0”
93 means wait forever.
94 Default value: “0”.
95 defaultXResolution (class DefaultXResolution)
97 the number of pixels per unit length that horizontal spacing
98 and width values are intended for. If the actual horizontal
99 (x) resolution of the X server is significantly greater or less
100 than this value, portions of the dialog, indicator, and button
101 widgets are stretched or shrunk horizontally to take the dif‐
102 ference into account. The value is a positive integer, followed
103 by a slash (/) and a one- or two-character unit abbreviation.
104 Valid units are inches (in or i) and meters (m).
105 Default value: “75/in” (75 pixels per inch).
106 defaultYResolution (class DefaultYResolution)
108 the number of pixels per unit length that vertical spacing and
109 height values are intended for. If the actual vertical (y)
110 resolution of the X server is significantly greater or less
111 than this value, portions of the dialog, indicator, and button
112 widgets are stretched or shrunk vertically to take the differ‐
113 ence into account. Valid values are the same as for
114 defaultXResolution above.
115 Default value: “75/in” (75 pixels per inch).
116 xResolutionFuzz (class XResolutionFuzz)
118 the range of “fuzz” around the value of defaultXResolution
119 beyond which some widgets will be stretched or shrunk horizon‐
120 tally to fit the current actual horizontal resolution. Valid
121 values are the same as for defaultXResolution. For example, if
122 the default X resolution is “75/in”, and the X resolution fuzz
123 is “50/in”, then widgets won't be scaled horizontally unless
124 the actual horizontal resolution is less than 25 pixels per
125 inch or greater than 125 pixels per inch.
126 Default value: “20/in” (20 pixels per inch).
127 yResolutionFuzz (class YResolutionFuzz)
129 the range of “fuzz” around the value of defaultYResolution
130 beyond which some widgets will be stretched or shrunk verti‐
131 cally to fit the current actual vertical resolution. Valid val‐
132 ues are the same as for defaultXResolution above.
133 Default value: “20/in” (20 pixels per inch).
134 randCount (class RandCount)
136 specifies the maximum amount of additional, random units which
137 can be generated per password character. A non-zero value helps
138 to hide the length of the typed passphrase.
139 Default value: “2”.
140 The following resources are recognized by the Dialog widget:
142 title (class Title)
144 The title of the application as specified to the window man‐
145 ager.
146 label (class Label)
148 The label displayed above the led indicators.
149 font (class Font)
151 The font to be used to display the label.
152 The following Resources are recognized by the dialog, button, and indica‐
154 tor widgets and the main widget to customize the 3D appearance (all mea‐
155 surements are in pixels):
156 foreground (class Foreground)
158 The foreground color of the widget. This is the text color of
159 the label for buttons and dialog and the color of the active
160 led for the indicator.
161 background (class Background)
163 The background color of the widget. In the case of the indica‐
164 tor this is the color of the inactive led.
165 topShadowColor (class TopShadowColor)
167 The color used by the sides of the widget exposed to the light
168 (top and left).
169 bottomShadowColor (class BottomShadowColor)
171 The color used by the sides of the widget in the shadow (right
172 and bottom).
173 shadowThickness (class ShadowTickness)
175 The thickness of the 3D border of the widget.
176 borderColor (class BorderColor)
178 The color of the border around the widget.
179 borderWidth (class BorderWidth)
181 The width of the border around the widget.
182 horizontalSpacing (class HorizontalSpacing)
184 The space to leave on left and right sides of the widget.
185 verticalSpacing (class VerticalSpacing)
187 The space to leave on top and bottom sides of the widget.
188 The following resources are recognized by the indicator widgets:
190 minimumCount (class MinimumCount)
192 The minimum number of indicators to display in the dialog.
193 maximumCount (class MaximumCount)
195 The maximum number of indicators to display in the dialog.
196 Each button uses the following resources to customize its label:
198 label (class Label)
200 the string to display on the button.
201 font (class Font)
203 the font to use for this button label.
204
206 /usr/X11R6/lib/X11/app-defaults/SshAskpass
207
209 X(1), ssh(1), ssh-agent(1)
210
212 Some portions of x11-ssh-askpass are derived directly or indirectly from
213 portions of xscreensaver by Jamie Zawinski <jwz@jwz.org>, while others
214 are original works.
215 xscreensaver, Copyright © 1991-1999 Jamie Zawinski ⟨jwz@jwz.org⟩
217 Permission to use, copy, modify, distribute, and sell this software and
219 its documentation for any purpose is hereby granted without fee, provided
220 that the above copyright notice appear in all copies and that both that
221 copyright notice and this permission notice appear in supporting documen‐
222 tation. No representations are made about the suitability of this soft‐
223 ware for any purpose. It is provided "as is" without express or implied
224 warranty.
225 The remaining portions fall under the following copyright and license:
227 x11-ssh-askpass by Jim Knoble ⟨jmknoble@pobox.com⟩ Copyright ©
229 1999,2000,2001 Jim Knoble
230 Permission to use, copy, modify, distribute, and sell this software and
232 its documentation for any purpose is hereby granted without fee, provided
233 that the above copyright notice appear in all copies and that both that
234 copyright notice and this permission notice appear in supporting documen‐
235 tation.
236Version 1.2.4.1 September 17, 2001 Version 1.2.4.1