1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>paramiko.server</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="paramiko-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="paramiko-module.html">Package paramiko</a> ::
Module server
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="paramiko.server-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="paramiko.server-module.html" onclick="show_private();">Module paramiko.server</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2003-2007 Robey Pointer <robey@lag.net></tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># This file is part of paramiko.</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Paramiko is free software; you can redistribute it and/or modify it under the</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># terms of the GNU Lesser General Public License as published by the Free</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Software Foundation; either version 2.1 of the License, or (at your option)</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># any later version.</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Paramiko is distrubuted in the hope that it will be useful, but WITHOUT ANY</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># details.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># You should have received a copy of the GNU Lesser General Public License</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># along with Paramiko; if not, write to the Free Software Foundation, Inc.,</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">L{ServerInterface} is an interface to override for server support.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">threading</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package paramiko=paramiko-module.html"><a title="paramiko" class="py-name" href="#" onclick="return doclink('link-0', 'paramiko', 'link-0');">paramiko</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module paramiko.common=paramiko.common-module.html"><a title="paramiko.common" class="py-name" href="#" onclick="return doclink('link-1', 'common', 'link-1');">common</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="paramiko" class="py-name" href="#" onclick="return doclink('link-2', 'paramiko', 'link-0');">paramiko</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Module paramiko.util=paramiko.util-module.html"><a title="paramiko.util" class="py-name" href="#" onclick="return doclink('link-3', 'util', 'link-3');">util</a></tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> </tt>
<a name="InteractiveQuery"></a><div id="InteractiveQuery-def"><a name="L28"></a><tt class="py-lineno"> 28</tt> <a class="py-toggle" href="#" id="InteractiveQuery-toggle" onclick="return toggle('InteractiveQuery');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="paramiko.server.InteractiveQuery-class.html">InteractiveQuery</a> <tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveQuery-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InteractiveQuery-expanded"><a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> A query (set of prompts) for a user during interactive authentication.</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> </tt>
<a name="InteractiveQuery.__init__"></a><div id="InteractiveQuery.__init__-def"><a name="L33"></a><tt class="py-lineno"> 33</tt> <a class="py-toggle" href="#" id="InteractiveQuery.__init__-toggle" onclick="return toggle('InteractiveQuery.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.InteractiveQuery-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-param">instructions</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">prompts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveQuery.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveQuery.__init__-expanded"><a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> Create a new interactive query to send to the client. The name and</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> instructions are optional, but are generally displayed to the end</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> user. A list of prompts may be included, or they may be added via</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> the L{add_prompt} method.</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> @param name: name of this query</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> @type name: str</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> @param instructions: user instructions (usually short) about this query</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> @type instructions: str</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> @param prompts: one or more authentication prompts</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> @type prompts: str</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable paramiko.kex_gex.KexGex.name=paramiko.kex_gex.KexGex-class.html#name,Variable paramiko.kex_group1.KexGroup1.name=paramiko.kex_group1.KexGroup1-class.html#name"><a title="paramiko.kex_gex.KexGex.name
paramiko.kex_group1.KexGroup1.name" class="py-name" href="#" onclick="return doclink('link-4', 'name', 'link-4');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name"><a title="paramiko.kex_gex.KexGex.name
paramiko.kex_group1.KexGroup1.name" class="py-name" href="#" onclick="return doclink('link-5', 'name', 'link-4');">name</a></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">instructions</tt> <tt class="py-op">=</tt> <tt class="py-name">instructions</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prompts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">x</tt> <tt class="py-keyword">in</tt> <tt class="py-name">prompts</tt><tt class="py-op">:</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">add_prompt</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">)</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">add_prompt</tt><tt class="py-op">(</tt><tt class="py-name">x</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">x</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
<a name="InteractiveQuery.add_prompt"></a><div id="InteractiveQuery.add_prompt-def"><a name="L56"></a><tt class="py-lineno"> 56</tt> <a class="py-toggle" href="#" id="InteractiveQuery.add_prompt-toggle" onclick="return toggle('InteractiveQuery.add_prompt');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.InteractiveQuery-class.html#add_prompt">add_prompt</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">prompt</tt><tt class="py-op">,</tt> <tt class="py-param">echo</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InteractiveQuery.add_prompt-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InteractiveQuery.add_prompt-expanded"><a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> Add a prompt to this query. The prompt should be a (reasonably short)</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> string. Multiple prompts can be added to the same query.</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> @param prompt: the user prompt</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> @type prompt: str</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> @param echo: C{True} (default) if the user's response should be echoed;</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> C{False} if not (for a password or similar)</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> @type echo: bool</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">prompts</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">prompt</tt><tt class="py-op">,</tt> <tt class="py-name">echo</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
<a name="ServerInterface"></a><div id="ServerInterface-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="ServerInterface-toggle" onclick="return toggle('ServerInterface');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html">ServerInterface</a> <tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ServerInterface-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> This class defines an interface for controlling the behavior of paramiko</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> in server mode.</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> Methods on this class are called from paramiko's primary thread, so you</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> shouldn't do too much work in them. (Certainly nothing that blocks or</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> sleeps.)</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_request"></a><div id="ServerInterface.check_channel_request-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_request-toggle" onclick="return toggle('ServerInterface.check_channel_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_request">check_channel_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">kind</tt><tt class="py-op">,</tt> <tt class="py-param">chanid</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_request-expanded"><a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a channel request of a given type will be granted, and</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> return C{OPEN_SUCCEEDED} or an error code. This method is</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> called in server mode when the client requests a channel, after</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> authentication is complete.</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> If you allow channel requests (and an ssh server that didn't would be</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> useless), you should also override some of the channel request methods</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> below, which are used to determine which services will be allowed on</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> a given channel:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> - L{check_channel_pty_request}</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> - L{check_channel_shell_request}</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> - L{check_channel_subsystem_request}</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> - L{check_channel_window_change_request}</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> - L{check_channel_x11_request}</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> The C{chanid} parameter is a small number that uniquely identifies the</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> channel within a L{Transport}. A L{Channel} object is not created</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> unless this method returns C{OPEN_SUCCEEDED} -- once a</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> L{Channel} object is created, you can call L{Channel.get_id} to</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> retrieve the channel ID.</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> The return value should either be C{OPEN_SUCCEEDED} (or</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> C{0}) to allow the channel request, or one of the following error</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> codes to reject it:</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_CONNECT_FAILED}</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE}</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_RESOURCE_SHORTAGE}</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}.</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> @param kind: the kind of channel the client would like to open</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> (usually C{"session"}).</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"> @type kind: str</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> @param chanid: ID of the channel</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> @type chanid: int</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> @return: a success or failure code (listed above)</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-6" class="py-name" targets="Variable paramiko.auth_handler.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.auth_handler-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.channel.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.channel-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.client-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.common.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.common-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.dsskey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.dsskey-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.hostkeys.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.hostkeys-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.kex_gex.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.kex_gex-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.kex_group1.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.kex_group1-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.packet.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.packet-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.pkey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.pkey-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.rsakey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.rsakey-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.server-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_attr.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_attr-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_client-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_file.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_file-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_handle.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_handle-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_server-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.sftp_si.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.sftp_si-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.transport.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.transport-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED,Variable paramiko.util.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED=paramiko.util-module.html#OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED"><a title="paramiko.auth_handler.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.channel.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.common.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.dsskey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.hostkeys.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.kex_gex.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.kex_group1.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.packet.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.pkey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.rsakey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_attr.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_file.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_handle.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_si.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.transport.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.util.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED" class="py-name" href="#" onclick="return doclink('link-6', 'OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED', 'link-6');">OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED</a></tt> </tt>
</div><a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.get_allowed_auths"></a><div id="ServerInterface.get_allowed_auths-def"><a name="L124"></a><tt class="py-lineno">124</tt> <a class="py-toggle" href="#" id="ServerInterface.get_allowed_auths-toggle" onclick="return toggle('ServerInterface.get_allowed_auths');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#get_allowed_auths">get_allowed_auths</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.get_allowed_auths-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.get_allowed_auths-expanded"><a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of authentication methods supported by the server.</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> This list is sent to clients attempting to authenticate, to inform them</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> of authentication methods that might be successful.</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> The "list" is actually a string of comma-separated names of types of</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> authentication. Possible values are C{"password"}, C{"publickey"},</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> and C{"none"}.</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{"password"}.</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> @param username: the username requesting authentication.</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-docstring"> @type username: str</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-docstring"> @return: a comma-separated list of authentication types</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: str</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'password'</tt> </tt>
</div><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_auth_none"></a><div id="ServerInterface.check_auth_none-def"><a name="L143"></a><tt class="py-lineno">143</tt> <a class="py-toggle" href="#" id="ServerInterface.check_auth_none-toggle" onclick="return toggle('ServerInterface.check_auth_none');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_auth_none">check_auth_none</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_auth_none-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_auth_none-expanded"><a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a client may open channels with no (further)</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> authentication.</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"> Return L{AUTH_FAILED} if the client must authenticate, or</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if it's okay for the client to not</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> authenticate.</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns L{AUTH_FAILED}.</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> @param username: the username of the client.</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-docstring"> @type username: str</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"> @return: L{AUTH_FAILED} if the authentication fails;</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if it succeeds.</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-7" class="py-name" targets="Variable paramiko.auth_handler.AUTH_FAILED=paramiko.auth_handler-module.html#AUTH_FAILED,Variable paramiko.channel.AUTH_FAILED=paramiko.channel-module.html#AUTH_FAILED,Variable paramiko.client.AUTH_FAILED=paramiko.client-module.html#AUTH_FAILED,Variable paramiko.common.AUTH_FAILED=paramiko.common-module.html#AUTH_FAILED,Variable paramiko.dsskey.AUTH_FAILED=paramiko.dsskey-module.html#AUTH_FAILED,Variable paramiko.hostkeys.AUTH_FAILED=paramiko.hostkeys-module.html#AUTH_FAILED,Variable paramiko.kex_gex.AUTH_FAILED=paramiko.kex_gex-module.html#AUTH_FAILED,Variable paramiko.kex_group1.AUTH_FAILED=paramiko.kex_group1-module.html#AUTH_FAILED,Variable paramiko.packet.AUTH_FAILED=paramiko.packet-module.html#AUTH_FAILED,Variable paramiko.pkey.AUTH_FAILED=paramiko.pkey-module.html#AUTH_FAILED,Variable paramiko.rsakey.AUTH_FAILED=paramiko.rsakey-module.html#AUTH_FAILED,Variable paramiko.server.AUTH_FAILED=paramiko.server-module.html#AUTH_FAILED,Variable paramiko.sftp.AUTH_FAILED=paramiko.sftp-module.html#AUTH_FAILED,Variable paramiko.sftp_attr.AUTH_FAILED=paramiko.sftp_attr-module.html#AUTH_FAILED,Variable paramiko.sftp_client.AUTH_FAILED=paramiko.sftp_client-module.html#AUTH_FAILED,Variable paramiko.sftp_file.AUTH_FAILED=paramiko.sftp_file-module.html#AUTH_FAILED,Variable paramiko.sftp_handle.AUTH_FAILED=paramiko.sftp_handle-module.html#AUTH_FAILED,Variable paramiko.sftp_server.AUTH_FAILED=paramiko.sftp_server-module.html#AUTH_FAILED,Variable paramiko.sftp_si.AUTH_FAILED=paramiko.sftp_si-module.html#AUTH_FAILED,Variable paramiko.transport.AUTH_FAILED=paramiko.transport-module.html#AUTH_FAILED,Variable paramiko.util.AUTH_FAILED=paramiko.util-module.html#AUTH_FAILED"><a title="paramiko.auth_handler.AUTH_FAILED
paramiko.channel.AUTH_FAILED
paramiko.client.AUTH_FAILED
paramiko.common.AUTH_FAILED
paramiko.dsskey.AUTH_FAILED
paramiko.hostkeys.AUTH_FAILED
paramiko.kex_gex.AUTH_FAILED
paramiko.kex_group1.AUTH_FAILED
paramiko.packet.AUTH_FAILED
paramiko.pkey.AUTH_FAILED
paramiko.rsakey.AUTH_FAILED
paramiko.server.AUTH_FAILED
paramiko.sftp.AUTH_FAILED
paramiko.sftp_attr.AUTH_FAILED
paramiko.sftp_client.AUTH_FAILED
paramiko.sftp_file.AUTH_FAILED
paramiko.sftp_handle.AUTH_FAILED
paramiko.sftp_server.AUTH_FAILED
paramiko.sftp_si.AUTH_FAILED
paramiko.transport.AUTH_FAILED
paramiko.util.AUTH_FAILED" class="py-name" href="#" onclick="return doclink('link-7', 'AUTH_FAILED', 'link-7');">AUTH_FAILED</a></tt> </tt>
</div><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_auth_password"></a><div id="ServerInterface.check_auth_password-def"><a name="L162"></a><tt class="py-lineno">162</tt> <a class="py-toggle" href="#" id="ServerInterface.check_auth_password-toggle" onclick="return toggle('ServerInterface.check_auth_password');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_auth_password">check_auth_password</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_auth_password-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_auth_password-expanded"><a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a given username and password supplied by the client is</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"> acceptable for use in authentication.</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> Return L{AUTH_FAILED} if the password is not accepted,</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if the password is accepted and completes</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> authentication is stateful, and this key is accepted for</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> authentication, but more authentication is required. (In this latter</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> case, L{get_allowed_auths} will be called to report to the client what</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> options it has for continuing the authentication.)</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns L{AUTH_FAILED}.</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> @param username: the username of the authenticating client.</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> @type username: str</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> @param password: the password given by the client.</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"><tt class="py-docstring"> @type password: str</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"><tt class="py-docstring"> @return: L{AUTH_FAILED} if the authentication fails;</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if it succeeds;</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_PARTIALLY_SUCCESSFUL} if the password auth is</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-docstring"> successful, but authentication must continue.</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-8" class="py-name"><a title="paramiko.auth_handler.AUTH_FAILED
paramiko.channel.AUTH_FAILED
paramiko.client.AUTH_FAILED
paramiko.common.AUTH_FAILED
paramiko.dsskey.AUTH_FAILED
paramiko.hostkeys.AUTH_FAILED
paramiko.kex_gex.AUTH_FAILED
paramiko.kex_group1.AUTH_FAILED
paramiko.packet.AUTH_FAILED
paramiko.pkey.AUTH_FAILED
paramiko.rsakey.AUTH_FAILED
paramiko.server.AUTH_FAILED
paramiko.sftp.AUTH_FAILED
paramiko.sftp_attr.AUTH_FAILED
paramiko.sftp_client.AUTH_FAILED
paramiko.sftp_file.AUTH_FAILED
paramiko.sftp_handle.AUTH_FAILED
paramiko.sftp_server.AUTH_FAILED
paramiko.sftp_si.AUTH_FAILED
paramiko.transport.AUTH_FAILED
paramiko.util.AUTH_FAILED" class="py-name" href="#" onclick="return doclink('link-8', 'AUTH_FAILED', 'link-7');">AUTH_FAILED</a></tt> </tt>
</div><a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_auth_publickey"></a><div id="ServerInterface.check_auth_publickey-def"><a name="L189"></a><tt class="py-lineno">189</tt> <a class="py-toggle" href="#" id="ServerInterface.check_auth_publickey-toggle" onclick="return toggle('ServerInterface.check_auth_publickey');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_auth_publickey">check_auth_publickey</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_auth_publickey-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_auth_publickey-expanded"><a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a given key supplied by the client is acceptable for use</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"> in authentication. You should override this method in server mode to</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> check the username and key and decide if you would accept a signature</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"> made using this key.</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> Return L{AUTH_FAILED} if the key is not accepted,</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if the key is accepted and completes the</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> authentication is stateful, and this password is accepted for</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> authentication, but more authentication is required. (In this latter</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> case, L{get_allowed_auths} will be called to report to the client what</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"> options it has for continuing the authentication.)</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"> Note that you don't have to actually verify any key signtature here.</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-docstring"> If you're willing to accept the key, paramiko will do the work of</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-docstring"> verifying the client's signature.</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns L{AUTH_FAILED}.</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"><tt class="py-docstring"> @param username: the username of the authenticating client</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"><tt class="py-docstring"> @type username: str</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"><tt class="py-docstring"> @param key: the key object provided by the client</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"><tt class="py-docstring"> @type key: L{PKey <pkey.PKey>}</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"><tt class="py-docstring"> @return: L{AUTH_FAILED} if the client can't authenticate</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"><tt class="py-docstring"> with this key; L{AUTH_SUCCESSFUL} if it can;</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_PARTIALLY_SUCCESSFUL} if it can authenticate with</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"><tt class="py-docstring"> this key but must continue with authentication</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-9" class="py-name"><a title="paramiko.auth_handler.AUTH_FAILED
paramiko.channel.AUTH_FAILED
paramiko.client.AUTH_FAILED
paramiko.common.AUTH_FAILED
paramiko.dsskey.AUTH_FAILED
paramiko.hostkeys.AUTH_FAILED
paramiko.kex_gex.AUTH_FAILED
paramiko.kex_group1.AUTH_FAILED
paramiko.packet.AUTH_FAILED
paramiko.pkey.AUTH_FAILED
paramiko.rsakey.AUTH_FAILED
paramiko.server.AUTH_FAILED
paramiko.sftp.AUTH_FAILED
paramiko.sftp_attr.AUTH_FAILED
paramiko.sftp_client.AUTH_FAILED
paramiko.sftp_file.AUTH_FAILED
paramiko.sftp_handle.AUTH_FAILED
paramiko.sftp_server.AUTH_FAILED
paramiko.sftp_si.AUTH_FAILED
paramiko.transport.AUTH_FAILED
paramiko.util.AUTH_FAILED" class="py-name" href="#" onclick="return doclink('link-9', 'AUTH_FAILED', 'link-7');">AUTH_FAILED</a></tt> </tt>
</div><a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_auth_interactive"></a><div id="ServerInterface.check_auth_interactive-def"><a name="L222"></a><tt class="py-lineno">222</tt> <a class="py-toggle" href="#" id="ServerInterface.check_auth_interactive-toggle" onclick="return toggle('ServerInterface.check_auth_interactive');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_auth_interactive">check_auth_interactive</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">username</tt><tt class="py-op">,</tt> <tt class="py-param">submethods</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_auth_interactive-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_auth_interactive-expanded"><a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"><tt class="py-docstring"> Begin an interactive authentication challenge, if supported. You</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"><tt class="py-docstring"> should override this method in server mode if you want to support the</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-docstring"> C{"keyboard-interactive"} auth type, which requires you to send a</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"><tt class="py-docstring"> series of questions for the client to answer.</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"><tt class="py-docstring"> Return L{AUTH_FAILED} if this auth method isn't supported. Otherwise,</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"><tt class="py-docstring"> you should return an L{InteractiveQuery} object containing the prompts</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"><tt class="py-docstring"> and instructions for the user. The response will be sent via a call</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"> to L{check_auth_interactive_response}.</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns L{AUTH_FAILED}.</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"> @param username: the username of the authenticating client</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"><tt class="py-docstring"> @type username: str</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"><tt class="py-docstring"> @param submethods: a comma-separated list of methods preferred by the</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"><tt class="py-docstring"> client (usually empty)</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> @type submethods: str</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> @return: L{AUTH_FAILED} if this auth method isn't supported; otherwise</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> an object containing queries for the user</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int or L{InteractiveQuery}</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-10" class="py-name"><a title="paramiko.auth_handler.AUTH_FAILED
paramiko.channel.AUTH_FAILED
paramiko.client.AUTH_FAILED
paramiko.common.AUTH_FAILED
paramiko.dsskey.AUTH_FAILED
paramiko.hostkeys.AUTH_FAILED
paramiko.kex_gex.AUTH_FAILED
paramiko.kex_group1.AUTH_FAILED
paramiko.packet.AUTH_FAILED
paramiko.pkey.AUTH_FAILED
paramiko.rsakey.AUTH_FAILED
paramiko.server.AUTH_FAILED
paramiko.sftp.AUTH_FAILED
paramiko.sftp_attr.AUTH_FAILED
paramiko.sftp_client.AUTH_FAILED
paramiko.sftp_file.AUTH_FAILED
paramiko.sftp_handle.AUTH_FAILED
paramiko.sftp_server.AUTH_FAILED
paramiko.sftp_si.AUTH_FAILED
paramiko.transport.AUTH_FAILED
paramiko.util.AUTH_FAILED" class="py-name" href="#" onclick="return doclink('link-10', 'AUTH_FAILED', 'link-7');">AUTH_FAILED</a></tt> </tt>
</div><a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_auth_interactive_response"></a><div id="ServerInterface.check_auth_interactive_response-def"><a name="L247"></a><tt class="py-lineno">247</tt> <a class="py-toggle" href="#" id="ServerInterface.check_auth_interactive_response-toggle" onclick="return toggle('ServerInterface.check_auth_interactive_response');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_auth_interactive_response">check_auth_interactive_response</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">responses</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_auth_interactive_response-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_auth_interactive_response-expanded"><a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-docstring"> Continue or finish an interactive authentication challenge, if</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"><tt class="py-docstring"> supported. You should override this method in server mode if you want</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"><tt class="py-docstring"> to support the C{"keyboard-interactive"} auth type.</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"><tt class="py-docstring"> Return L{AUTH_FAILED} if the responses are not accepted,</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if the responses are accepted and complete</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"><tt class="py-docstring"> the authentication, or L{AUTH_PARTIALLY_SUCCESSFUL} if your</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"><tt class="py-docstring"> authentication is stateful, and this set of responses is accepted for</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"> authentication, but more authentication is required. (In this latter</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> case, L{get_allowed_auths} will be called to report to the client what</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"> options it has for continuing the authentication.)</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> If you wish to continue interactive authentication with more questions,</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> you may return an L{InteractiveQuery} object, which should cause the</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"><tt class="py-docstring"> client to respond with more answers, calling this method again. This</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"><tt class="py-docstring"> cycle can continue indefinitely.</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns L{AUTH_FAILED}.</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-docstring"> @param responses: list of responses from the client</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-docstring"> @type responses: list(str)</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"> @return: L{AUTH_FAILED} if the authentication fails;</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_SUCCESSFUL} if it succeeds;</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"> L{AUTH_PARTIALLY_SUCCESSFUL} if the interactive auth is</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> successful, but authentication must continue; otherwise an object</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> containing queries for the user</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int or L{InteractiveQuery}</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-11" class="py-name"><a title="paramiko.auth_handler.AUTH_FAILED
paramiko.channel.AUTH_FAILED
paramiko.client.AUTH_FAILED
paramiko.common.AUTH_FAILED
paramiko.dsskey.AUTH_FAILED
paramiko.hostkeys.AUTH_FAILED
paramiko.kex_gex.AUTH_FAILED
paramiko.kex_group1.AUTH_FAILED
paramiko.packet.AUTH_FAILED
paramiko.pkey.AUTH_FAILED
paramiko.rsakey.AUTH_FAILED
paramiko.server.AUTH_FAILED
paramiko.sftp.AUTH_FAILED
paramiko.sftp_attr.AUTH_FAILED
paramiko.sftp_client.AUTH_FAILED
paramiko.sftp_file.AUTH_FAILED
paramiko.sftp_handle.AUTH_FAILED
paramiko.sftp_server.AUTH_FAILED
paramiko.sftp_si.AUTH_FAILED
paramiko.transport.AUTH_FAILED
paramiko.util.AUTH_FAILED" class="py-name" href="#" onclick="return doclink('link-11', 'AUTH_FAILED', 'link-7');">AUTH_FAILED</a></tt> </tt>
</div><a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_port_forward_request"></a><div id="ServerInterface.check_port_forward_request-def"><a name="L279"></a><tt class="py-lineno">279</tt> <a class="py-toggle" href="#" id="ServerInterface.check_port_forward_request-toggle" onclick="return toggle('ServerInterface.check_port_forward_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_port_forward_request">check_port_forward_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">,</tt> <tt class="py-param">port</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_port_forward_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_port_forward_request-expanded"><a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"><tt class="py-docstring"> Handle a request for port forwarding. The client is asking that</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"><tt class="py-docstring"> connections to the given address and port be forwarded back across</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"><tt class="py-docstring"> this ssh connection. An address of C{"0.0.0.0"} indicates a global</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> address (any address associated with this server) and a port of C{0}</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"> indicates that no specific port is requested (usually the OS will pick</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"> a port).</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}, rejecting the</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"><tt class="py-docstring"> port forwarding request. If the request is accepted, you should return</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"><tt class="py-docstring"> the port opened for listening.</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"><tt class="py-docstring"> @param address: the requested address</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"><tt class="py-docstring"> @type address: str</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"><tt class="py-docstring"> @param port: the requested port</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"><tt class="py-docstring"> @type port: int</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"><tt class="py-docstring"> @return: the port number that was opened for listening, or C{False} to</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"><tt class="py-docstring"> reject</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.cancel_port_forward_request"></a><div id="ServerInterface.cancel_port_forward_request-def"><a name="L302"></a><tt class="py-lineno">302</tt> <a class="py-toggle" href="#" id="ServerInterface.cancel_port_forward_request-toggle" onclick="return toggle('ServerInterface.cancel_port_forward_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#cancel_port_forward_request">cancel_port_forward_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">address</tt><tt class="py-op">,</tt> <tt class="py-param">port</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.cancel_port_forward_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.cancel_port_forward_request-expanded"><a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"><tt class="py-docstring"> The client would like to cancel a previous port-forwarding request.</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-docstring"> If the given address and port is being forwarded across this ssh</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"><tt class="py-docstring"> connection, the port should be closed.</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"><tt class="py-docstring"> @param address: the forwarded address</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> @type address: str</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"> @param port: the forwarded port</tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> @type port: int</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_global_request"></a><div id="ServerInterface.check_global_request-def"><a name="L315"></a><tt class="py-lineno">315</tt> <a class="py-toggle" href="#" id="ServerInterface.check_global_request-toggle" onclick="return toggle('ServerInterface.check_global_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_global_request">check_global_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">kind</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_global_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_global_request-expanded"><a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"><tt class="py-docstring"> Handle a global request of the given C{kind}. This method is called</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"><tt class="py-docstring"> in server mode and client mode, whenever the remote host makes a global</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt class="py-docstring"> request. If there are any arguments to the request, they will be in</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> C{msg}.</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"><tt class="py-docstring"> There aren't any useful global requests defined, aside from port</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"><tt class="py-docstring"> forwarding, so usually this type of request is an extension to the</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"><tt class="py-docstring"> protocol.</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"><tt class="py-docstring"> If the request was successful and you would like to return contextual</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"><tt class="py-docstring"> data to the remote host, return a tuple. Items in the tuple will be</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"><tt class="py-docstring"> sent back with the successful result. (Note that the items in the</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"><tt class="py-docstring"> tuple can only be strings, ints, longs, or bools.)</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}, indicating that it</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"> does not support any global requests.</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"><tt class="py-docstring"> @note: Port forwarding requests are handled separately, in</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-docstring"> L{check_port_forward_request}.</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"><tt class="py-docstring"> @param kind: the kind of global request being made.</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"><tt class="py-docstring"> @type kind: str</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"><tt class="py-docstring"> @param msg: any extra arguments to the request.</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"><tt class="py-docstring"> @type msg: L{Message}</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} or a tuple of data if the request was granted;</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"><tt class="py-docstring"> C{False} otherwise.</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> <tt class="py-comment">### Channel requests</tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_pty_request"></a><div id="ServerInterface.check_channel_pty_request-def"><a name="L351"></a><tt class="py-lineno">351</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_pty_request-toggle" onclick="return toggle('ServerInterface.check_channel_pty_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_pty_request">check_channel_pty_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">term</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">,</tt> <tt class="py-param">height</tt><tt class="py-op">,</tt> <tt class="py-param">pixelwidth</tt><tt class="py-op">,</tt> <tt class="py-param">pixelheight</tt><tt class="py-op">,</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-param">modes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_pty_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_pty_request-expanded"><a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a pseudo-terminal of the given dimensions (usually</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"><tt class="py-docstring"> requested for shell access) can be provided on the given channel.</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}.</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the pty request arrived on.</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"><tt class="py-docstring"> @param term: type of terminal requested (for example, C{"vt100"}).</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"><tt class="py-docstring"> @type term: str</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"><tt class="py-docstring"> @param width: width of screen in characters.</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"><tt class="py-docstring"> @type width: int</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"><tt class="py-docstring"> @param height: height of screen in characters.</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"><tt class="py-docstring"> @type height: int</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"><tt class="py-docstring"> @param pixelwidth: width of screen in pixels, if known (may be C{0} if</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"><tt class="py-docstring"> unknown).</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt> <tt class="py-line"><tt class="py-docstring"> @type pixelwidth: int</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"><tt class="py-docstring"> @param pixelheight: height of screen in pixels, if known (may be C{0}</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"><tt class="py-docstring"> if unknown).</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"> @type pixelheight: int</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if the psuedo-terminal has been allocated; C{False}</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"><tt class="py-docstring"> otherwise.</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_shell_request"></a><div id="ServerInterface.check_channel_shell_request-def"><a name="L379"></a><tt class="py-lineno">379</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_shell_request-toggle" onclick="return toggle('ServerInterface.check_channel_shell_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_shell_request">check_channel_shell_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_shell_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_shell_request-expanded"><a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a shell will be provided to the client on the given</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"><tt class="py-docstring"> channel. If this method returns C{True}, the channel should be</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"><tt class="py-docstring"> connected to the stdin/stdout of a shell (or something that acts like</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"><tt class="py-docstring"> a shell).</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}.</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the request arrived on.</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if this channel is now hooked up to a shell; C{False}</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"><tt class="py-docstring"> if a shell can't or won't be provided.</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_exec_request"></a><div id="ServerInterface.check_channel_exec_request-def"><a name="L396"></a><tt class="py-lineno">396</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_exec_request-toggle" onclick="return toggle('ServerInterface.check_channel_exec_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_exec_request">check_channel_exec_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">command</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_exec_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_exec_request-expanded"><a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a shell command will be executed for the client. If this</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"><tt class="py-docstring"> method returns C{True}, the channel should be connected to the stdin,</tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"><tt class="py-docstring"> stdout, and stderr of the shell command.</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}.</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the request arrived on.</tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"><tt class="py-docstring"> @param command: the command to execute.</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"><tt class="py-docstring"> @type command: str</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if this channel is now hooked up to the stdin,</tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"><tt class="py-docstring"> stdout, and stderr of the executing command; C{False} if the</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"><tt class="py-docstring"> command will not be executed.</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"><tt class="py-docstring"> @since: 1.1</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_subsystem_request"></a><div id="ServerInterface.check_channel_subsystem_request-def"><a name="L417"></a><tt class="py-lineno">417</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_subsystem_request-toggle" onclick="return toggle('ServerInterface.check_channel_subsystem_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_subsystem_request">check_channel_subsystem_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_subsystem_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_subsystem_request-expanded"><a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a requested subsystem will be provided to the client on</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"><tt class="py-docstring"> the given channel. If this method returns C{True}, all future I/O</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"><tt class="py-docstring"> through this channel will be assumed to be connected to the requested</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"><tt class="py-docstring"> subsystem. An example of a subsystem is C{sftp}.</tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation checks for a subsystem handler assigned via</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"><tt class="py-docstring"> L{Transport.set_subsystem_handler}.</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"><tt class="py-docstring"> If one has been set, the handler is invoked and this method returns</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"><tt class="py-docstring"> C{True}. Otherwise it returns C{False}.</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"><tt class="py-docstring"> @note: Because the default implementation uses the L{Transport} to</tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"><tt class="py-docstring"> identify valid subsystems, you probably won't need to override this</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"><tt class="py-docstring"> method.</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the pty request arrived on.</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"><tt class="py-docstring"> @param name: name of the requested subsystem.</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"><tt class="py-docstring"> @type name: str</tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if this channel is now hooked up to the requested</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"><tt class="py-docstring"> subsystem; C{False} if that subsystem can't or won't be provided.</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-name">handler_class</tt><tt class="py-op">,</tt> <tt class="py-name">larg</tt><tt class="py-op">,</tt> <tt class="py-name">kwarg</tt> <tt class="py-op">=</tt> <tt id="link-12" class="py-name" targets="Module paramiko.channel=paramiko.channel-module.html"><a title="paramiko.channel" class="py-name" href="#" onclick="return doclink('link-12', 'channel', 'link-12');">channel</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method paramiko.Channel.get_transport()=paramiko.Channel-class.html#get_transport,Method paramiko.SSHClient.get_transport()=paramiko.SSHClient-class.html#get_transport"><a title="paramiko.Channel.get_transport
paramiko.SSHClient.get_transport" class="py-name" href="#" onclick="return doclink('link-13', 'get_transport', 'link-13');">get_transport</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">_get_subsystem_handler</tt><tt class="py-op">(</tt><tt id="link-14" class="py-name"><a title="paramiko.kex_gex.KexGex.name
paramiko.kex_group1.KexGroup1.name" class="py-name" href="#" onclick="return doclink('link-14', 'name', 'link-4');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">handler_class</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"> <tt class="py-name">handler</tt> <tt class="py-op">=</tt> <tt class="py-name">handler_class</tt><tt class="py-op">(</tt><tt id="link-15" class="py-name"><a title="paramiko.channel" class="py-name" href="#" onclick="return doclink('link-15', 'channel', 'link-12');">channel</a></tt><tt class="py-op">,</tt> <tt id="link-16" class="py-name"><a title="paramiko.kex_gex.KexGex.name
paramiko.kex_group1.KexGroup1.name" class="py-name" href="#" onclick="return doclink('link-16', 'name', 'link-4');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">larg</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwarg</tt><tt class="py-op">)</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"> <tt class="py-name">handler</tt><tt class="py-op">.</tt><tt class="py-name">start</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_window_change_request"></a><div id="ServerInterface.check_channel_window_change_request-def"><a name="L448"></a><tt class="py-lineno">448</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_window_change_request-toggle" onclick="return toggle('ServerInterface.check_channel_window_change_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_window_change_request">check_channel_window_change_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">,</tt> <tt class="py-param">height</tt><tt class="py-op">,</tt> <tt class="py-param">pixelwidth</tt><tt class="py-op">,</tt> <tt class="py-param">pixelheight</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_window_change_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_window_change_request-expanded"><a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"><tt class="py-docstring"> Determine if the pseudo-terminal on the given channel can be resized.</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"><tt class="py-docstring"> This only makes sense if a pty was previously allocated on it.</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}.</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the pty request arrived on.</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"><tt class="py-docstring"> @param width: width of screen in characters.</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"><tt class="py-docstring"> @type width: int</tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"><tt class="py-docstring"> @param height: height of screen in characters.</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"><tt class="py-docstring"> @type height: int</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"><tt class="py-docstring"> @param pixelwidth: width of screen in pixels, if known (may be C{0} if</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"><tt class="py-docstring"> unknown).</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"><tt class="py-docstring"> @type pixelwidth: int</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"><tt class="py-docstring"> @param pixelheight: height of screen in pixels, if known (may be C{0}</tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"><tt class="py-docstring"> if unknown).</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"><tt class="py-docstring"> @type pixelheight: int</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if the terminal was resized; C{False} if not.</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_x11_request"></a><div id="ServerInterface.check_channel_x11_request-def"><a name="L472"></a><tt class="py-lineno">472</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_x11_request-toggle" onclick="return toggle('ServerInterface.check_channel_x11_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_x11_request">check_channel_x11_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">single_connection</tt><tt class="py-op">,</tt> <tt class="py-param">auth_protocol</tt><tt class="py-op">,</tt> <tt class="py-param">auth_cookie</tt><tt class="py-op">,</tt> <tt class="py-param">screen_number</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_x11_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_x11_request-expanded"><a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"><tt class="py-docstring"> Determine if the client will be provided with an X11 session. If this</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"><tt class="py-docstring"> method returns C{True}, X11 applications should be routed through new</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"><tt class="py-docstring"> SSH channels, using L{Transport.open_x11_channel}.</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns C{False}.</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the L{Channel} the X11 request arrived on</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"><tt class="py-docstring"> @param single_connection: C{True} if only a single X11 channel should</tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"><tt class="py-docstring"> be opened</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"><tt class="py-docstring"> @type single_connection: bool</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"><tt class="py-docstring"> @param auth_protocol: the protocol used for X11 authentication</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"><tt class="py-docstring"> @type auth_protocol: str</tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"><tt class="py-docstring"> @param auth_cookie: the cookie used to authenticate to X11</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"><tt class="py-docstring"> @type auth_cookie: str</tt> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"><tt class="py-docstring"> @param screen_number: the number of the X11 screen to connect to</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"><tt class="py-docstring"> @type screen_number: int</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{True} if the X11 session was opened; C{False} if not</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: bool</tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"> </tt>
<a name="ServerInterface.check_channel_direct_tcpip_request"></a><div id="ServerInterface.check_channel_direct_tcpip_request-def"><a name="L496"></a><tt class="py-lineno">496</tt> <a class="py-toggle" href="#" id="ServerInterface.check_channel_direct_tcpip_request-toggle" onclick="return toggle('ServerInterface.check_channel_direct_tcpip_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.ServerInterface-class.html#check_channel_direct_tcpip_request">check_channel_direct_tcpip_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">chanid</tt><tt class="py-op">,</tt> <tt class="py-param">origin</tt><tt class="py-op">,</tt> <tt class="py-param">destination</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerInterface.check_channel_direct_tcpip_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ServerInterface.check_channel_direct_tcpip_request-expanded"><a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"><tt class="py-docstring"> Determine if a local port forwarding channel will be granted, and</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"><tt class="py-docstring"> return C{OPEN_SUCCEEDED} or an error code. This method is</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"><tt class="py-docstring"> called in server mode when the client requests a channel, after</tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"><tt class="py-docstring"> authentication is complete.</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"><tt class="py-docstring"> The C{chanid} parameter is a small number that uniquely identifies the</tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"><tt class="py-docstring"> channel within a L{Transport}. A L{Channel} object is not created</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"><tt class="py-docstring"> unless this method returns C{OPEN_SUCCEEDED} -- once a</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"><tt class="py-docstring"> L{Channel} object is created, you can call L{Channel.get_id} to</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"><tt class="py-docstring"> retrieve the channel ID.</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"><tt class="py-docstring"> The origin and destination parameters are (ip_address, port) tuples</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"><tt class="py-docstring"> that correspond to both ends of the TCP connection in the forwarding</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"><tt class="py-docstring"> tunnel.</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"><tt class="py-docstring"> The return value should either be C{OPEN_SUCCEEDED} (or</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"><tt class="py-docstring"> C{0}) to allow the channel request, or one of the following error</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"><tt class="py-docstring"> codes to reject it:</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_CONNECT_FAILED}</tt> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_UNKNOWN_CHANNEL_TYPE}</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"><tt class="py-docstring"> - C{OPEN_FAILED_RESOURCE_SHORTAGE}</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"><tt class="py-docstring"> The default implementation always returns</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"><tt class="py-docstring"> C{OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED}.</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"><tt class="py-docstring"> @param chanid: ID of the channel</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"><tt class="py-docstring"> @type chanid: int</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"><tt class="py-docstring"> @param origin: 2-tuple containing the IP address and port of the</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"><tt class="py-docstring"> originator (client side)</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"><tt class="py-docstring"> @type origin: tuple</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"><tt class="py-docstring"> @param destination: 2-tuple containing the IP address and port of the</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"><tt class="py-docstring"> destination (server side)</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"><tt class="py-docstring"> @type destination: tuple</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"><tt class="py-docstring"> @return: a success or failure code (listed above)</tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: int</tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-17" class="py-name"><a title="paramiko.auth_handler.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.channel.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.common.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.dsskey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.hostkeys.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.kex_gex.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.kex_group1.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.packet.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.pkey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.rsakey.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_attr.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_client.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_file.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_handle.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_server.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.sftp_si.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.transport.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED
paramiko.util.OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED" class="py-name" href="#" onclick="return doclink('link-17', 'OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED', 'link-6');">OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED</a></tt> </tt>
</div></div><a name="L536"></a><tt class="py-lineno">536</tt> <tt class="py-line"> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt> <tt class="py-line"> </tt>
<a name="SubsystemHandler"></a><div id="SubsystemHandler-def"><a name="L538"></a><tt class="py-lineno">538</tt> <a class="py-toggle" href="#" id="SubsystemHandler-toggle" onclick="return toggle('SubsystemHandler');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html">SubsystemHandler</a> <tt class="py-op">(</tt><tt class="py-base-class">threading</tt><tt class="py-op">.</tt><tt class="py-base-class">Thread</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="SubsystemHandler-expanded"><a name="L539"></a><tt class="py-lineno">539</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt> <tt class="py-line"><tt class="py-docstring"> Handler for a subsytem in server mode. If you create a subclass of this</tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt> <tt class="py-line"><tt class="py-docstring"> class and pass it to</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt> <tt class="py-line"><tt class="py-docstring"> L{Transport.set_subsystem_handler},</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt> <tt class="py-line"><tt class="py-docstring"> an object of this</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt> <tt class="py-line"><tt class="py-docstring"> class will be created for each request for this subsystem. Each new object</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt> <tt class="py-line"><tt class="py-docstring"> will be executed within its own new thread by calling L{start_subsystem}.</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt> <tt class="py-line"><tt class="py-docstring"> When that method completes, the channel is closed.</tt> </tt>
<a name="L547"></a><tt class="py-lineno">547</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt> <tt class="py-line"><tt class="py-docstring"> For example, if you made a subclass C{MP3Handler} and registered it as the</tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt> <tt class="py-line"><tt class="py-docstring"> handler for subsystem C{"mp3"}, then whenever a client has successfully</tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt> <tt class="py-line"><tt class="py-docstring"> authenticated and requests subsytem C{"mp3"}, an object of class</tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt> <tt class="py-line"><tt class="py-docstring"> C{MP3Handler} will be created, and L{start_subsystem} will be called on</tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt> <tt class="py-line"><tt class="py-docstring"> it from a new thread.</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="SubsystemHandler.__init__"></a><div id="SubsystemHandler.__init__-def"><a name="L554"></a><tt class="py-lineno">554</tt> <a class="py-toggle" href="#" id="SubsystemHandler.__init__-toggle" onclick="return toggle('SubsystemHandler.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">server</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SubsystemHandler.__init__-expanded"><a name="L555"></a><tt class="py-lineno">555</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L556"></a><tt class="py-lineno">556</tt> <tt class="py-line"><tt class="py-docstring"> Create a new handler for a channel. This is used by L{ServerInterface}</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt> <tt class="py-line"><tt class="py-docstring"> to start up a new handler when a channel requests this subsystem. You</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt> <tt class="py-line"><tt class="py-docstring"> don't need to override this method, but if you do, be sure to pass the</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt> <tt class="py-line"><tt class="py-docstring"> C{channel} and C{name} parameters through to the original C{__init__}</tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt> <tt class="py-line"><tt class="py-docstring"> method here.</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the channel associated with this subsystem request.</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt> <tt class="py-line"><tt class="py-docstring"> @param name: name of the requested subsystem.</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt> <tt class="py-line"><tt class="py-docstring"> @type name: str</tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt> <tt class="py-line"><tt class="py-docstring"> @param server: the server object for the session that started this</tt> </tt>
<a name="L567"></a><tt class="py-lineno">567</tt> <tt class="py-line"><tt class="py-docstring"> subsystem</tt> </tt>
<a name="L568"></a><tt class="py-lineno">568</tt> <tt class="py-line"><tt class="py-docstring"> @type server: L{ServerInterface}</tt> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt> <tt class="py-line"> <tt class="py-name">threading</tt><tt class="py-op">.</tt><tt class="py-name">Thread</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Method paramiko.Agent.__init__()=paramiko.Agent-class.html#__init__,Method paramiko.AgentKey.__init__()=paramiko.AgentKey-class.html#__init__,Method paramiko.BadAuthenticationType.__init__()=paramiko.BadAuthenticationType-class.html#__init__,Method paramiko.BadHostKeyException.__init__()=paramiko.BadHostKeyException-class.html#__init__,Method paramiko.BufferedFile.__init__()=paramiko.BufferedFile-class.html#__init__,Method paramiko.Channel.__init__()=paramiko.Channel-class.html#__init__,Method paramiko.ChannelException.__init__()=paramiko.ChannelException-class.html#__init__,Method paramiko.DSSKey.__init__()=paramiko.DSSKey-class.html#__init__,Method paramiko.HostKeys.__init__()=paramiko.HostKeys-class.html#__init__,Method paramiko.Message.__init__()=paramiko.Message-class.html#__init__,Method paramiko.PKey.__init__()=paramiko.PKey-class.html#__init__,Method paramiko.RSAKey.__init__()=paramiko.RSAKey-class.html#__init__,Method paramiko.SFTPAttributes.__init__()=paramiko.SFTPAttributes-class.html#__init__,Method paramiko.SFTPClient.__init__()=paramiko.SFTPClient-class.html#__init__,Method paramiko.SFTPFile.__init__()=paramiko.SFTPFile-class.html#__init__,Method paramiko.SFTPHandle.__init__()=paramiko.SFTPHandle-class.html#__init__,Method paramiko.SFTPServer.__init__()=paramiko.SFTPServer-class.html#__init__,Method paramiko.SFTPServerInterface.__init__()=paramiko.SFTPServerInterface-class.html#__init__,Method paramiko.SSHClient.__init__()=paramiko.SSHClient-class.html#__init__,Method paramiko.SSHConfig.__init__()=paramiko.SSHConfig-class.html#__init__,Method paramiko.SecurityOptions.__init__()=paramiko.SecurityOptions-class.html#__init__,Method paramiko.SubsystemHandler.__init__()=paramiko.SubsystemHandler-class.html#__init__,Method paramiko.Transport.__init__()=paramiko.Transport-class.html#__init__,Method paramiko.ber.BER.__init__()=paramiko.ber.BER-class.html#__init__,Method paramiko.buffered_pipe.BufferedPipe.__init__()=paramiko.buffered_pipe.BufferedPipe-class.html#__init__,Method paramiko.channel.ChannelStderrFile.__init__()=paramiko.channel.ChannelStderrFile-class.html#__init__,Method paramiko.compress.ZlibCompressor.__init__()=paramiko.compress.ZlibCompressor-class.html#__init__,Method paramiko.compress.ZlibDecompressor.__init__()=paramiko.compress.ZlibDecompressor-class.html#__init__,Method paramiko.hostkeys.HostKeyEntry.__init__()=paramiko.hostkeys.HostKeyEntry-class.html#__init__,Method paramiko.kex_gex.KexGex.__init__()=paramiko.kex_gex.KexGex-class.html#__init__,Method paramiko.kex_group1.KexGroup1.__init__()=paramiko.kex_group1.KexGroup1-class.html#__init__,Method paramiko.logging22.Formatter.__init__()=paramiko.logging22.Formatter-class.html#__init__,Method paramiko.logging22.StreamHandler.__init__()=paramiko.logging22.StreamHandler-class.html#__init__,Method paramiko.logging22.logger.__init__()=paramiko.logging22.logger-class.html#__init__,Method paramiko.pipe.OrPipe.__init__()=paramiko.pipe.OrPipe-class.html#__init__,Method paramiko.pipe.PosixPipe.__init__()=paramiko.pipe.PosixPipe-class.html#__init__,Method paramiko.pipe.WindowsPipe.__init__()=paramiko.pipe.WindowsPipe-class.html#__init__,Method paramiko.primes.ModulusPack.__init__()=paramiko.primes.ModulusPack-class.html#__init__,Method paramiko.rng.StrongLockingRandomPool.__init__()=paramiko.rng.StrongLockingRandomPool-class.html#__init__,Method paramiko.ssh_exception.PartialAuthentication.__init__()=paramiko.ssh_exception.PartialAuthentication-class.html#__init__,Method paramiko.transport.ChannelMap.__init__()=paramiko.transport.ChannelMap-class.html#__init__,Method paramiko.util.enumerate.__init__()=paramiko.util.enumerate-class.html#__init__,Method paramiko.win_pageant.PageantConnection.__init__()=paramiko.win_pageant.PageantConnection-class.html#__init__"><a title="paramiko.Agent.__init__
paramiko.AgentKey.__init__
paramiko.BadAuthenticationType.__init__
paramiko.BadHostKeyException.__init__
paramiko.BufferedFile.__init__
paramiko.Channel.__init__
paramiko.ChannelException.__init__
paramiko.DSSKey.__init__
paramiko.HostKeys.__init__
paramiko.Message.__init__
paramiko.PKey.__init__
paramiko.RSAKey.__init__
paramiko.SFTPAttributes.__init__
paramiko.SFTPClient.__init__
paramiko.SFTPFile.__init__
paramiko.SFTPHandle.__init__
paramiko.SFTPServer.__init__
paramiko.SFTPServerInterface.__init__
paramiko.SSHClient.__init__
paramiko.SSHConfig.__init__
paramiko.SecurityOptions.__init__
paramiko.SubsystemHandler.__init__
paramiko.Transport.__init__
paramiko.ber.BER.__init__
paramiko.buffered_pipe.BufferedPipe.__init__
paramiko.channel.ChannelStderrFile.__init__
paramiko.compress.ZlibCompressor.__init__
paramiko.compress.ZlibDecompressor.__init__
paramiko.hostkeys.HostKeyEntry.__init__
paramiko.kex_gex.KexGex.__init__
paramiko.kex_group1.KexGroup1.__init__
paramiko.logging22.Formatter.__init__
paramiko.logging22.StreamHandler.__init__
paramiko.logging22.logger.__init__
paramiko.pipe.OrPipe.__init__
paramiko.pipe.PosixPipe.__init__
paramiko.pipe.WindowsPipe.__init__
paramiko.primes.ModulusPack.__init__
paramiko.rng.StrongLockingRandomPool.__init__
paramiko.ssh_exception.PartialAuthentication.__init__
paramiko.transport.ChannelMap.__init__
paramiko.util.enumerate.__init__
paramiko.win_pageant.PageantConnection.__init__" class="py-name" href="#" onclick="return doclink('link-18', '__init__', 'link-18');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_run</tt><tt class="py-op">)</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__channel</tt> <tt class="py-op">=</tt> <tt id="link-19" class="py-name"><a title="paramiko.channel" class="py-name" href="#" onclick="return doclink('link-19', 'channel', 'link-12');">channel</a></tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__transport</tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="paramiko.channel" class="py-name" href="#" onclick="return doclink('link-20', 'channel', 'link-12');">channel</a></tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="paramiko.Channel.get_transport
paramiko.SSHClient.get_transport" class="py-name" href="#" onclick="return doclink('link-21', 'get_transport', 'link-13');">get_transport</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__name</tt> <tt class="py-op">=</tt> <tt id="link-22" class="py-name"><a title="paramiko.kex_gex.KexGex.name
paramiko.kex_group1.KexGroup1.name" class="py-name" href="#" onclick="return doclink('link-22', 'name', 'link-4');">name</a></tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__server</tt> <tt class="py-op">=</tt> <tt id="link-23" class="py-name" targets="Module paramiko.server=paramiko.server-module.html"><a title="paramiko.server" class="py-name" href="#" onclick="return doclink('link-23', 'server', 'link-23');">server</a></tt> </tt>
</div><a name="L575"></a><tt class="py-lineno">575</tt> <tt class="py-line"> </tt>
<a name="SubsystemHandler.get_server"></a><div id="SubsystemHandler.get_server-def"><a name="L576"></a><tt class="py-lineno">576</tt> <a class="py-toggle" href="#" id="SubsystemHandler.get_server-toggle" onclick="return toggle('SubsystemHandler.get_server');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html#get_server">get_server</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler.get_server-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SubsystemHandler.get_server-expanded"><a name="L577"></a><tt class="py-lineno">577</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L578"></a><tt class="py-lineno">578</tt> <tt class="py-line"><tt class="py-docstring"> Return the L{ServerInterface} object associated with this channel and</tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt> <tt class="py-line"><tt class="py-docstring"> subsystem.</tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L581"></a><tt class="py-lineno">581</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ServerInterface}</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__server</tt> </tt>
</div><a name="L584"></a><tt class="py-lineno">584</tt> <tt class="py-line"> </tt>
<a name="SubsystemHandler._run"></a><div id="SubsystemHandler._run-def"><a name="L585"></a><tt class="py-lineno">585</tt> <a class="py-toggle" href="#" id="SubsystemHandler._run-toggle" onclick="return toggle('SubsystemHandler._run');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html#_run">_run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler._run-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SubsystemHandler._run-expanded"><a name="L586"></a><tt class="py-lineno">586</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__transport</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">(</tt><tt id="link-24" class="py-name" targets="Variable paramiko.auth_handler.DEBUG=paramiko.auth_handler-module.html#DEBUG,Variable paramiko.channel.DEBUG=paramiko.channel-module.html#DEBUG,Variable paramiko.client.DEBUG=paramiko.client-module.html#DEBUG,Variable paramiko.common.DEBUG=paramiko.common-module.html#DEBUG,Variable paramiko.dsskey.DEBUG=paramiko.dsskey-module.html#DEBUG,Variable paramiko.hostkeys.DEBUG=paramiko.hostkeys-module.html#DEBUG,Variable paramiko.kex_gex.DEBUG=paramiko.kex_gex-module.html#DEBUG,Variable paramiko.kex_group1.DEBUG=paramiko.kex_group1-module.html#DEBUG,Variable paramiko.logging22.DEBUG=paramiko.logging22-module.html#DEBUG,Variable paramiko.packet.DEBUG=paramiko.packet-module.html#DEBUG,Variable paramiko.pkey.DEBUG=paramiko.pkey-module.html#DEBUG,Variable paramiko.rsakey.DEBUG=paramiko.rsakey-module.html#DEBUG,Variable paramiko.server.DEBUG=paramiko.server-module.html#DEBUG,Variable paramiko.sftp.DEBUG=paramiko.sftp-module.html#DEBUG,Variable paramiko.sftp_attr.DEBUG=paramiko.sftp_attr-module.html#DEBUG,Variable paramiko.sftp_client.DEBUG=paramiko.sftp_client-module.html#DEBUG,Variable paramiko.sftp_file.DEBUG=paramiko.sftp_file-module.html#DEBUG,Variable paramiko.sftp_handle.DEBUG=paramiko.sftp_handle-module.html#DEBUG,Variable paramiko.sftp_server.DEBUG=paramiko.sftp_server-module.html#DEBUG,Variable paramiko.sftp_si.DEBUG=paramiko.sftp_si-module.html#DEBUG,Variable paramiko.transport.DEBUG=paramiko.transport-module.html#DEBUG,Variable paramiko.util.DEBUG=paramiko.util-module.html#DEBUG"><a title="paramiko.auth_handler.DEBUG
paramiko.channel.DEBUG
paramiko.client.DEBUG
paramiko.common.DEBUG
paramiko.dsskey.DEBUG
paramiko.hostkeys.DEBUG
paramiko.kex_gex.DEBUG
paramiko.kex_group1.DEBUG
paramiko.logging22.DEBUG
paramiko.packet.DEBUG
paramiko.pkey.DEBUG
paramiko.rsakey.DEBUG
paramiko.server.DEBUG
paramiko.sftp.DEBUG
paramiko.sftp_attr.DEBUG
paramiko.sftp_client.DEBUG
paramiko.sftp_file.DEBUG
paramiko.sftp_handle.DEBUG
paramiko.sftp_server.DEBUG
paramiko.sftp_si.DEBUG
paramiko.transport.DEBUG
paramiko.util.DEBUG" class="py-name" href="#" onclick="return doclink('link-24', 'DEBUG', 'link-24');">DEBUG</a></tt><tt class="py-op">,</tt> <tt class="py-string">'Starting handler for subsystem %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__name</tt><tt class="py-op">)</tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method paramiko.SFTPServer.start_subsystem()=paramiko.SFTPServer-class.html#start_subsystem,Method paramiko.SubsystemHandler.start_subsystem()=paramiko.SubsystemHandler-class.html#start_subsystem"><a title="paramiko.SFTPServer.start_subsystem
paramiko.SubsystemHandler.start_subsystem" class="py-name" href="#" onclick="return doclink('link-25', 'start_subsystem', 'link-25');">start_subsystem</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__name</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__transport</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__channel</tt><tt class="py-op">)</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__transport</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">(</tt><tt id="link-26" class="py-name" targets="Variable paramiko.auth_handler.ERROR=paramiko.auth_handler-module.html#ERROR,Variable paramiko.channel.ERROR=paramiko.channel-module.html#ERROR,Variable paramiko.client.ERROR=paramiko.client-module.html#ERROR,Variable paramiko.common.ERROR=paramiko.common-module.html#ERROR,Variable paramiko.dsskey.ERROR=paramiko.dsskey-module.html#ERROR,Variable paramiko.hostkeys.ERROR=paramiko.hostkeys-module.html#ERROR,Variable paramiko.kex_gex.ERROR=paramiko.kex_gex-module.html#ERROR,Variable paramiko.kex_group1.ERROR=paramiko.kex_group1-module.html#ERROR,Variable paramiko.logging22.ERROR=paramiko.logging22-module.html#ERROR,Variable paramiko.packet.ERROR=paramiko.packet-module.html#ERROR,Variable paramiko.pkey.ERROR=paramiko.pkey-module.html#ERROR,Variable paramiko.rsakey.ERROR=paramiko.rsakey-module.html#ERROR,Variable paramiko.server.ERROR=paramiko.server-module.html#ERROR,Variable paramiko.sftp.ERROR=paramiko.sftp-module.html#ERROR,Variable paramiko.sftp_attr.ERROR=paramiko.sftp_attr-module.html#ERROR,Variable paramiko.sftp_client.ERROR=paramiko.sftp_client-module.html#ERROR,Variable paramiko.sftp_file.ERROR=paramiko.sftp_file-module.html#ERROR,Variable paramiko.sftp_handle.ERROR=paramiko.sftp_handle-module.html#ERROR,Variable paramiko.sftp_server.ERROR=paramiko.sftp_server-module.html#ERROR,Variable paramiko.sftp_si.ERROR=paramiko.sftp_si-module.html#ERROR,Variable paramiko.transport.ERROR=paramiko.transport-module.html#ERROR,Variable paramiko.util.ERROR=paramiko.util-module.html#ERROR"><a title="paramiko.auth_handler.ERROR
paramiko.channel.ERROR
paramiko.client.ERROR
paramiko.common.ERROR
paramiko.dsskey.ERROR
paramiko.hostkeys.ERROR
paramiko.kex_gex.ERROR
paramiko.kex_group1.ERROR
paramiko.logging22.ERROR
paramiko.packet.ERROR
paramiko.pkey.ERROR
paramiko.rsakey.ERROR
paramiko.server.ERROR
paramiko.sftp.ERROR
paramiko.sftp_attr.ERROR
paramiko.sftp_client.ERROR
paramiko.sftp_file.ERROR
paramiko.sftp_handle.ERROR
paramiko.sftp_server.ERROR
paramiko.sftp_si.ERROR
paramiko.transport.ERROR
paramiko.util.ERROR" class="py-name" href="#" onclick="return doclink('link-26', 'ERROR', 'link-26');">ERROR</a></tt><tt class="py-op">,</tt> <tt class="py-string">'Exception in subsystem handler for "%s": %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L591"></a><tt class="py-lineno">591</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__name</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__transport</tt><tt class="py-op">.</tt><tt class="py-name">_log</tt><tt class="py-op">(</tt><tt id="link-27" class="py-name"><a title="paramiko.auth_handler.ERROR
paramiko.channel.ERROR
paramiko.client.ERROR
paramiko.common.ERROR
paramiko.dsskey.ERROR
paramiko.hostkeys.ERROR
paramiko.kex_gex.ERROR
paramiko.kex_group1.ERROR
paramiko.logging22.ERROR
paramiko.packet.ERROR
paramiko.pkey.ERROR
paramiko.rsakey.ERROR
paramiko.server.ERROR
paramiko.sftp.ERROR
paramiko.sftp_attr.ERROR
paramiko.sftp_client.ERROR
paramiko.sftp_file.ERROR
paramiko.sftp_handle.ERROR
paramiko.sftp_server.ERROR
paramiko.sftp_si.ERROR
paramiko.transport.ERROR
paramiko.util.ERROR" class="py-name" href="#" onclick="return doclink('link-27', 'ERROR', 'link-26');">ERROR</a></tt><tt class="py-op">,</tt> <tt id="link-28" class="py-name"><a title="paramiko.util" class="py-name" href="#" onclick="return doclink('link-28', 'util', 'link-3');">util</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name" targets="Function paramiko.util.tb_strings()=paramiko.util-module.html#tb_strings"><a title="paramiko.util.tb_strings" class="py-name" href="#" onclick="return doclink('link-29', 'tb_strings', 'link-29');">tb_strings</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Method paramiko.SFTPServer.finish_subsystem()=paramiko.SFTPServer-class.html#finish_subsystem,Method paramiko.SubsystemHandler.finish_subsystem()=paramiko.SubsystemHandler-class.html#finish_subsystem"><a title="paramiko.SFTPServer.finish_subsystem
paramiko.SubsystemHandler.finish_subsystem" class="py-name" href="#" onclick="return doclink('link-30', 'finish_subsystem', 'link-30');">finish_subsystem</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L597"></a><tt class="py-lineno">597</tt> <tt class="py-line"> </tt>
<a name="SubsystemHandler.start_subsystem"></a><div id="SubsystemHandler.start_subsystem-def"><a name="L598"></a><tt class="py-lineno">598</tt> <a class="py-toggle" href="#" id="SubsystemHandler.start_subsystem-toggle" onclick="return toggle('SubsystemHandler.start_subsystem');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html#start_subsystem">start_subsystem</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">transport</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler.start_subsystem-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SubsystemHandler.start_subsystem-expanded"><a name="L599"></a><tt class="py-lineno">599</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L600"></a><tt class="py-lineno">600</tt> <tt class="py-line"><tt class="py-docstring"> Process an ssh subsystem in server mode. This method is called on a</tt> </tt>
<a name="L601"></a><tt class="py-lineno">601</tt> <tt class="py-line"><tt class="py-docstring"> new object (and in a new thread) for each subsystem request. It is</tt> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt> <tt class="py-line"><tt class="py-docstring"> assumed that all subsystem logic will take place here, and when the</tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt> <tt class="py-line"><tt class="py-docstring"> subsystem is finished, this method will return. After this method</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt> <tt class="py-line"><tt class="py-docstring"> returns, the channel is closed.</tt> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L606"></a><tt class="py-lineno">606</tt> <tt class="py-line"><tt class="py-docstring"> The combination of C{transport} and C{channel} are unique; this handler</tt> </tt>
<a name="L607"></a><tt class="py-lineno">607</tt> <tt class="py-line"><tt class="py-docstring"> corresponds to exactly one L{Channel} on one L{Transport}.</tt> </tt>
<a name="L608"></a><tt class="py-lineno">608</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L609"></a><tt class="py-lineno">609</tt> <tt class="py-line"><tt class="py-docstring"> @note: It is the responsibility of this method to exit if the</tt> </tt>
<a name="L610"></a><tt class="py-lineno">610</tt> <tt class="py-line"><tt class="py-docstring"> underlying L{Transport} is closed. This can be done by checking</tt> </tt>
<a name="L611"></a><tt class="py-lineno">611</tt> <tt class="py-line"><tt class="py-docstring"> L{Transport.is_active} or noticing an EOF</tt> </tt>
<a name="L612"></a><tt class="py-lineno">612</tt> <tt class="py-line"><tt class="py-docstring"> on the L{Channel}. If this method loops forever without checking</tt> </tt>
<a name="L613"></a><tt class="py-lineno">613</tt> <tt class="py-line"><tt class="py-docstring"> for this case, your python interpreter may refuse to exit because</tt> </tt>
<a name="L614"></a><tt class="py-lineno">614</tt> <tt class="py-line"><tt class="py-docstring"> this thread will still be running.</tt> </tt>
<a name="L615"></a><tt class="py-lineno">615</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L616"></a><tt class="py-lineno">616</tt> <tt class="py-line"><tt class="py-docstring"> @param name: name of the requested subsystem.</tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt> <tt class="py-line"><tt class="py-docstring"> @type name: str</tt> </tt>
<a name="L618"></a><tt class="py-lineno">618</tt> <tt class="py-line"><tt class="py-docstring"> @param transport: the server-mode L{Transport}.</tt> </tt>
<a name="L619"></a><tt class="py-lineno">619</tt> <tt class="py-line"><tt class="py-docstring"> @type transport: L{Transport}</tt> </tt>
<a name="L620"></a><tt class="py-lineno">620</tt> <tt class="py-line"><tt class="py-docstring"> @param channel: the channel associated with this subsystem request.</tt> </tt>
<a name="L621"></a><tt class="py-lineno">621</tt> <tt class="py-line"><tt class="py-docstring"> @type channel: L{Channel}</tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L623"></a><tt class="py-lineno">623</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L624"></a><tt class="py-lineno">624</tt> <tt class="py-line"> </tt>
<a name="SubsystemHandler.finish_subsystem"></a><div id="SubsystemHandler.finish_subsystem-def"><a name="L625"></a><tt class="py-lineno">625</tt> <a class="py-toggle" href="#" id="SubsystemHandler.finish_subsystem-toggle" onclick="return toggle('SubsystemHandler.finish_subsystem');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="paramiko.server.SubsystemHandler-class.html#finish_subsystem">finish_subsystem</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SubsystemHandler.finish_subsystem-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SubsystemHandler.finish_subsystem-expanded"><a name="L626"></a><tt class="py-lineno">626</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt> <tt class="py-line"><tt class="py-docstring"> Perform any cleanup at the end of a subsystem. The default</tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt> <tt class="py-line"><tt class="py-docstring"> implementation just closes the channel.</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L630"></a><tt class="py-lineno">630</tt> <tt class="py-line"><tt class="py-docstring"> @since: 1.1</tt> </tt>
<a name="L631"></a><tt class="py-lineno">631</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L632"></a><tt class="py-lineno">632</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__channel</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Method paramiko.Agent.close()=paramiko.Agent-class.html#close,Method paramiko.BufferedFile.close()=paramiko.BufferedFile-class.html#close,Method paramiko.Channel.close()=paramiko.Channel-class.html#close,Method paramiko.SFTPClient.close()=paramiko.SFTPClient-class.html#close,Method paramiko.SFTPFile.close()=paramiko.SFTPFile-class.html#close,Method paramiko.SFTPHandle.close()=paramiko.SFTPHandle-class.html#close,Method paramiko.SSHClient.close()=paramiko.SSHClient-class.html#close,Method paramiko.Transport.close()=paramiko.Transport-class.html#close,Method paramiko.buffered_pipe.BufferedPipe.close()=paramiko.buffered_pipe.BufferedPipe-class.html#close,Method paramiko.pipe.PosixPipe.close()=paramiko.pipe.PosixPipe-class.html#close,Method paramiko.pipe.WindowsPipe.close()=paramiko.pipe.WindowsPipe-class.html#close,Method paramiko.win_pageant.PageantConnection.close()=paramiko.win_pageant.PageantConnection-class.html#close"><a title="paramiko.Agent.close
paramiko.BufferedFile.close
paramiko.Channel.close
paramiko.SFTPClient.close
paramiko.SFTPFile.close
paramiko.SFTPHandle.close
paramiko.SSHClient.close
paramiko.Transport.close
paramiko.buffered_pipe.BufferedPipe.close
paramiko.pipe.PosixPipe.close
paramiko.pipe.WindowsPipe.close
paramiko.win_pageant.PageantConnection.close" class="py-name" href="#" onclick="return doclink('link-31', 'close', 'link-31');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L633"></a><tt class="py-lineno">633</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="paramiko-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun Jul 6 18:30:38 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|