root/docs/config/modules/ssh2.xml

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 8.9 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

pull docs into master

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>ssh2</title>
4   <para>The ssh2 module allows reconnoiter to connect to servers over ssh protocol 2 and test the fingerprint.</para>
5   <variablelist>
6     <varlistentry>
7       <term>loader</term>
8       <listitem>
9         <para>C</para>
10       </listitem>
11     </varlistentry>
12     <varlistentry>
13       <term>image</term>
14       <listitem>
15         <para>ssh2.so</para>
16       </listitem>
17     </varlistentry>
18   </variablelist>
19   <section>
20     <title>Module Configuration</title>
21   </section>
22   <section>
23     <title>Check Configuration</title>
24     <variablelist>
25       <varlistentry>
26         <term>port</term>
27         <listitem>
28           <variablelist>
29             <varlistentry>
30               <term>required</term>
31               <listitem>
32                 <para>optional</para>
33               </listitem>
34             </varlistentry>
35             <varlistentry>
36               <term>default</term>
37               <listitem>
38                 <para>22</para>
39               </listitem>
40             </varlistentry>
41             <varlistentry>
42               <term>allowed</term>
43               <listitem>
44                 <para>\d+</para>
45               </listitem>
46             </varlistentry>
47           </variablelist>
48           <para>The TCP port on which the remote server's ssh service is running.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52     <variablelist>
53       <varlistentry>
54         <term>method_kex</term>
55         <listitem>
56           <variablelist>
57             <varlistentry>
58               <term>required</term>
59               <listitem>
60                 <para>optional</para>
61               </listitem>
62             </varlistentry>
63             <varlistentry>
64               <term>default</term>
65               <listitem>
66                 <para/>
67               </listitem>
68             </varlistentry>
69             <varlistentry>
70               <term>allowed</term>
71               <listitem>
72                 <para>^diffie-hellman-(?:group1-sha1|group14-sha1|group-exchange-sha1)$</para>
73               </listitem>
74             </varlistentry>
75           </variablelist>
76           <para>The key exchange method to use.</para>
77         </listitem>
78       </varlistentry>
79     </variablelist>
80     <variablelist>
81       <varlistentry>
82         <term>method_hostkey</term>
83         <listitem>
84           <variablelist>
85             <varlistentry>
86               <term>required</term>
87               <listitem>
88                 <para>optional</para>
89               </listitem>
90             </varlistentry>
91             <varlistentry>
92               <term>default</term>
93               <listitem>
94                 <para/>
95               </listitem>
96             </varlistentry>
97             <varlistentry>
98               <term>allowed</term>
99               <listitem>
100                 <para>^(?:ssh-dss|ssh-rsa)$</para>
101               </listitem>
102             </varlistentry>
103           </variablelist>
104           <para>The host key algorithm supported.</para>
105         </listitem>
106       </varlistentry>
107     </variablelist>
108     <variablelist>
109       <varlistentry>
110         <term>method_crypt_cs</term>
111         <listitem>
112           <variablelist>
113             <varlistentry>
114               <term>required</term>
115               <listitem>
116                 <para>optional</para>
117               </listitem>
118             </varlistentry>
119             <varlistentry>
120               <term>default</term>
121               <listitem>
122                 <para/>
123               </listitem>
124             </varlistentry>
125             <varlistentry>
126               <term>allowed</term>
127               <listitem>
128                 <para>^(?:aes256-ctr|aes192-ctr|aes128-ctr|aes256-cbc|aes192-cbc|aes128-cbc|blowfish-cbc|arcfour128|arcfour|cast128-cbc|3des-cbc|none)$</para>
129               </listitem>
130             </varlistentry>
131           </variablelist>
132           <para>The encryption algorithm used from client to server.</para>
133         </listitem>
134       </varlistentry>
135     </variablelist>
136     <variablelist>
137       <varlistentry>
138         <term>method_crypt_sc</term>
139         <listitem>
140           <variablelist>
141             <varlistentry>
142               <term>required</term>
143               <listitem>
144                 <para>optional</para>
145               </listitem>
146             </varlistentry>
147             <varlistentry>
148               <term>default</term>
149               <listitem>
150                 <para/>
151               </listitem>
152             </varlistentry>
153             <varlistentry>
154               <term>allowed</term>
155               <listitem>
156                 <para>^(?:aes256-ctr|aes192-ctr|aes128-ctr|aes256-cbc|aes192-cbc|aes128-cbc|blowfish-cbc|arcfour128|arcfour|cast128-cbc|3des-cbc|none)$</para>
157               </listitem>
158             </varlistentry>
159           </variablelist>
160           <para>The encryption algorithm used from server to client.</para>
161         </listitem>
162       </varlistentry>
163     </variablelist>
164     <variablelist>
165       <varlistentry>
166         <term>method_mac_cs</term>
167         <listitem>
168           <variablelist>
169             <varlistentry>
170               <term>required</term>
171               <listitem>
172                 <para>optional</para>
173               </listitem>
174             </varlistentry>
175             <varlistentry>
176               <term>default</term>
177               <listitem>
178                 <para/>
179               </listitem>
180             </varlistentry>
181             <varlistentry>
182               <term>allowed</term>
183               <listitem>
184                 <para>^(?:hmac-sha1|hmac-sha1-96|hmac-md5|hmac-md5-96|hmac-ripemd160|none)$</para>
185               </listitem>
186             </varlistentry>
187           </variablelist>
188           <para>The message authentication code algorithm used from client to server.</para>
189         </listitem>
190       </varlistentry>
191     </variablelist>
192     <variablelist>
193       <varlistentry>
194         <term>method_mac_sc</term>
195         <listitem>
196           <variablelist>
197             <varlistentry>
198               <term>required</term>
199               <listitem>
200                 <para>optional</para>
201               </listitem>
202             </varlistentry>
203             <varlistentry>
204               <term>default</term>
205               <listitem>
206                 <para/>
207               </listitem>
208             </varlistentry>
209             <varlistentry>
210               <term>allowed</term>
211               <listitem>
212                 <para>^(?:hmac-sha1|hmac-sha1-96|hmac-md5|hmac-md5-96|hmac-ripemd160|none)$</para>
213               </listitem>
214             </varlistentry>
215           </variablelist>
216           <para>The message authentication code algorithm used from server to client.</para>
217         </listitem>
218       </varlistentry>
219     </variablelist>
220     <variablelist>
221       <varlistentry>
222         <term>method_comp_cs</term>
223         <listitem>
224           <variablelist>
225             <varlistentry>
226               <term>required</term>
227               <listitem>
228                 <para>optional</para>
229               </listitem>
230             </varlistentry>
231             <varlistentry>
232               <term>default</term>
233               <listitem>
234                 <para>none</para>
235               </listitem>
236             </varlistentry>
237             <varlistentry>
238               <term>allowed</term>
239               <listitem>
240                 <para>^(?:zlib|none)$</para>
241               </listitem>
242             </varlistentry>
243           </variablelist>
244           <para>The compress algorithm used from client to server.</para>
245         </listitem>
246       </varlistentry>
247     </variablelist>
248     <variablelist>
249       <varlistentry>
250         <term>method_comp_sc</term>
251         <listitem>
252           <variablelist>
253             <varlistentry>
254               <term>required</term>
255               <listitem>
256                 <para>optional</para>
257               </listitem>
258             </varlistentry>
259             <varlistentry>
260               <term>default</term>
261               <listitem>
262                 <para>none</para>
263               </listitem>
264             </varlistentry>
265             <varlistentry>
266               <term>allowed</term>
267               <listitem>
268                 <para>^(?:zlib|none)$</para>
269               </listitem>
270             </varlistentry>
271           </variablelist>
272           <para>The compress algorithm used from server to client.</para>
273         </listitem>
274       </varlistentry>
275     </variablelist>
276   </section>
277   <example>
278     <title>Simple ssh polling of 4 machines</title>
279     <para>The following checks ssh on 10.1.2.{3,4,5,6}</para>
280     <programlisting>
281       &lt;noit&gt;
282         &lt;modules&gt;
283           &lt;module image="ssh2" name="ssh2"/&gt;
284         &lt;/modules&gt;
285         &lt;checks&gt;
286           &lt;ssh module="ssh2"&gt;
287             &lt;check uuid="1cddb2a8-76ff-11dd-83c8-f75cb8b93bd9" target="10.1.2.3"/&gt;
288             &lt;check uuid="1dd79110-76ff-11dd-9b54-739adc274a93" target="10.1.2.4"/&gt;
289             &lt;check uuid="4627560a-76ff-11dd-941f-4b75679cb908" target="10.1.2.5"/&gt;
290             &lt;check uuid="4fdcb8de-76ff-11dd-ae16-2740afc178ae" target="10.1.2.6"/&gt;
291           &lt;/ssh&gt;
292         &lt;/checks&gt;
293       &lt;/noit&gt;
294     </programlisting>
295   </example>
296 </section>
Note: See TracBrowser for help on using the browser.