net-sftp 1.1.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +23 -0
- data/Manifest +55 -0
- data/README.rdoc +96 -0
- data/Rakefile +30 -0
- data/lib/net/sftp.rb +53 -38
- data/lib/net/sftp/constants.rb +187 -0
- data/lib/net/sftp/errors.rb +34 -20
- data/lib/net/sftp/operations/dir.rb +93 -0
- data/lib/net/sftp/operations/download.rb +364 -0
- data/lib/net/sftp/operations/file.rb +176 -0
- data/lib/net/sftp/operations/file_factory.rb +60 -0
- data/lib/net/sftp/operations/upload.rb +387 -0
- data/lib/net/sftp/packet.rb +21 -0
- data/lib/net/sftp/protocol.rb +32 -0
- data/lib/net/sftp/protocol/01/attributes.rb +265 -96
- data/lib/net/sftp/protocol/01/base.rb +268 -0
- data/lib/net/sftp/protocol/01/name.rb +43 -0
- data/lib/net/sftp/protocol/02/base.rb +31 -0
- data/lib/net/sftp/protocol/03/base.rb +35 -0
- data/lib/net/sftp/protocol/04/attributes.rb +120 -195
- data/lib/net/sftp/protocol/04/base.rb +94 -0
- data/lib/net/sftp/protocol/04/name.rb +67 -0
- data/lib/net/sftp/protocol/05/base.rb +66 -0
- data/lib/net/sftp/protocol/06/attributes.rb +107 -0
- data/lib/net/sftp/protocol/06/base.rb +63 -0
- data/lib/net/sftp/protocol/base.rb +50 -0
- data/lib/net/sftp/request.rb +91 -0
- data/lib/net/sftp/response.rb +76 -0
- data/lib/net/sftp/session.rb +914 -238
- data/lib/net/sftp/version.rb +14 -21
- data/net-sftp.gemspec +60 -0
- data/setup.rb +1331 -0
- data/test/common.rb +173 -0
- data/test/protocol/01/test_attributes.rb +97 -0
- data/test/protocol/01/test_base.rb +210 -0
- data/test/protocol/01/test_name.rb +27 -0
- data/test/protocol/02/test_base.rb +26 -0
- data/test/protocol/03/test_base.rb +27 -0
- data/test/protocol/04/test_attributes.rb +148 -0
- data/test/protocol/04/test_base.rb +74 -0
- data/test/protocol/04/test_name.rb +49 -0
- data/test/protocol/05/test_base.rb +62 -0
- data/test/protocol/06/test_attributes.rb +124 -0
- data/test/protocol/06/test_base.rb +51 -0
- data/test/protocol/test_base.rb +42 -0
- data/test/test_all.rb +3 -0
- data/test/test_dir.rb +47 -0
- data/test/test_download.rb +252 -0
- data/test/test_file.rb +159 -0
- data/test/test_file_factory.rb +48 -0
- data/test/test_packet.rb +9 -0
- data/test/test_protocol.rb +17 -0
- data/test/test_request.rb +71 -0
- data/test/test_response.rb +53 -0
- data/test/test_session.rb +741 -0
- data/test/test_upload.rb +219 -0
- metadata +59 -111
- data/doc/LICENSE-BSD +0 -27
- data/doc/LICENSE-GPL +0 -280
- data/doc/LICENSE-RUBY +0 -56
- data/doc/faq/faq.html +0 -298
- data/doc/faq/faq.rb +0 -154
- data/doc/faq/faq.yml +0 -183
- data/examples/asynchronous.rb +0 -57
- data/examples/get-put.rb +0 -45
- data/examples/sftp-open-uri.rb +0 -30
- data/examples/ssh-service.rb +0 -30
- data/examples/synchronous.rb +0 -131
- data/lib/net/sftp/operations/abstract.rb +0 -108
- data/lib/net/sftp/operations/close.rb +0 -31
- data/lib/net/sftp/operations/errors.rb +0 -76
- data/lib/net/sftp/operations/fsetstat.rb +0 -36
- data/lib/net/sftp/operations/fstat.rb +0 -32
- data/lib/net/sftp/operations/lstat.rb +0 -31
- data/lib/net/sftp/operations/mkdir.rb +0 -33
- data/lib/net/sftp/operations/open.rb +0 -32
- data/lib/net/sftp/operations/opendir.rb +0 -32
- data/lib/net/sftp/operations/read.rb +0 -88
- data/lib/net/sftp/operations/readdir.rb +0 -55
- data/lib/net/sftp/operations/realpath.rb +0 -37
- data/lib/net/sftp/operations/remove.rb +0 -31
- data/lib/net/sftp/operations/rename.rb +0 -32
- data/lib/net/sftp/operations/rmdir.rb +0 -31
- data/lib/net/sftp/operations/services.rb +0 -42
- data/lib/net/sftp/operations/setstat.rb +0 -33
- data/lib/net/sftp/operations/stat.rb +0 -31
- data/lib/net/sftp/operations/write.rb +0 -63
- data/lib/net/sftp/protocol/01/impl.rb +0 -251
- data/lib/net/sftp/protocol/01/packet-assistant.rb +0 -82
- data/lib/net/sftp/protocol/01/services.rb +0 -47
- data/lib/net/sftp/protocol/02/impl.rb +0 -39
- data/lib/net/sftp/protocol/02/packet-assistant.rb +0 -32
- data/lib/net/sftp/protocol/02/services.rb +0 -44
- data/lib/net/sftp/protocol/03/impl.rb +0 -42
- data/lib/net/sftp/protocol/03/packet-assistant.rb +0 -35
- data/lib/net/sftp/protocol/03/services.rb +0 -44
- data/lib/net/sftp/protocol/04/impl.rb +0 -86
- data/lib/net/sftp/protocol/04/packet-assistant.rb +0 -45
- data/lib/net/sftp/protocol/04/services.rb +0 -44
- data/lib/net/sftp/protocol/05/impl.rb +0 -90
- data/lib/net/sftp/protocol/05/packet-assistant.rb +0 -34
- data/lib/net/sftp/protocol/05/services.rb +0 -44
- data/lib/net/sftp/protocol/constants.rb +0 -60
- data/lib/net/sftp/protocol/driver.rb +0 -235
- data/lib/net/sftp/protocol/packet-assistant.rb +0 -84
- data/lib/net/sftp/protocol/services.rb +0 -55
- data/lib/uri/open-sftp.rb +0 -54
- data/lib/uri/sftp.rb +0 -42
- data/test/ALL-TESTS.rb +0 -23
- data/test/operations/tc_abstract.rb +0 -124
- data/test/operations/tc_close.rb +0 -40
- data/test/operations/tc_fsetstat.rb +0 -48
- data/test/operations/tc_fstat.rb +0 -40
- data/test/operations/tc_lstat.rb +0 -40
- data/test/operations/tc_mkdir.rb +0 -48
- data/test/operations/tc_open.rb +0 -42
- data/test/operations/tc_opendir.rb +0 -40
- data/test/operations/tc_read.rb +0 -103
- data/test/operations/tc_readdir.rb +0 -88
- data/test/operations/tc_realpath.rb +0 -54
- data/test/operations/tc_remove.rb +0 -40
- data/test/operations/tc_rmdir.rb +0 -40
- data/test/operations/tc_setstat.rb +0 -48
- data/test/operations/tc_stat.rb +0 -40
- data/test/operations/tc_write.rb +0 -91
- data/test/protocol/01/tc_attributes.rb +0 -138
- data/test/protocol/01/tc_impl.rb +0 -294
- data/test/protocol/01/tc_packet_assistant.rb +0 -81
- data/test/protocol/02/tc_impl.rb +0 -41
- data/test/protocol/02/tc_packet_assistant.rb +0 -31
- data/test/protocol/03/tc_impl.rb +0 -48
- data/test/protocol/03/tc_packet_assistant.rb +0 -34
- data/test/protocol/04/tc_attributes.rb +0 -174
- data/test/protocol/04/tc_impl.rb +0 -91
- data/test/protocol/04/tc_packet_assistant.rb +0 -38
- data/test/protocol/05/tc_impl.rb +0 -61
- data/test/protocol/05/tc_packet_assistant.rb +0 -32
- data/test/protocol/tc_driver.rb +0 -219
data/doc/LICENSE-GPL
DELETED
@@ -1,280 +0,0 @@
|
|
1
|
-
GNU GENERAL PUBLIC LICENSE
|
2
|
-
Version 2, June 1991
|
3
|
-
|
4
|
-
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
5
|
-
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
6
|
-
Everyone is permitted to copy and distribute verbatim copies
|
7
|
-
of this license document, but changing it is not allowed.
|
8
|
-
|
9
|
-
Preamble
|
10
|
-
|
11
|
-
The licenses for most software are designed to take away your
|
12
|
-
freedom to share and change it. By contrast, the GNU General Public
|
13
|
-
License is intended to guarantee your freedom to share and change free
|
14
|
-
software--to make sure the software is free for all its users. This
|
15
|
-
General Public License applies to most of the Free Software
|
16
|
-
Foundation's software and to any other program whose authors commit to
|
17
|
-
using it. (Some other Free Software Foundation software is covered by
|
18
|
-
the GNU Library General Public License instead.) You can apply it to
|
19
|
-
your programs, too.
|
20
|
-
|
21
|
-
When we speak of free software, we are referring to freedom, not
|
22
|
-
price. Our General Public Licenses are designed to make sure that you
|
23
|
-
have the freedom to distribute copies of free software (and charge for
|
24
|
-
this service if you wish), that you receive source code or can get it
|
25
|
-
if you want it, that you can change the software or use pieces of it
|
26
|
-
in new free programs; and that you know you can do these things.
|
27
|
-
|
28
|
-
To protect your rights, we need to make restrictions that forbid
|
29
|
-
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
-
These restrictions translate to certain responsibilities for you if you
|
31
|
-
distribute copies of the software, or if you modify it.
|
32
|
-
|
33
|
-
For example, if you distribute copies of such a program, whether
|
34
|
-
gratis or for a fee, you must give the recipients all the rights that
|
35
|
-
you have. You must make sure that they, too, receive or can get the
|
36
|
-
source code. And you must show them these terms so they know their
|
37
|
-
rights.
|
38
|
-
|
39
|
-
We protect your rights with two steps: (1) copyright the software, and
|
40
|
-
(2) offer you this license which gives you legal permission to copy,
|
41
|
-
distribute and/or modify the software.
|
42
|
-
|
43
|
-
Also, for each author's protection and ours, we want to make certain
|
44
|
-
that everyone understands that there is no warranty for this free
|
45
|
-
software. If the software is modified by someone else and passed on, we
|
46
|
-
want its recipients to know that what they have is not the original, so
|
47
|
-
that any problems introduced by others will not reflect on the original
|
48
|
-
authors' reputations.
|
49
|
-
|
50
|
-
Finally, any free program is threatened constantly by software
|
51
|
-
patents. We wish to avoid the danger that redistributors of a free
|
52
|
-
program will individually obtain patent licenses, in effect making the
|
53
|
-
program proprietary. To prevent this, we have made it clear that any
|
54
|
-
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
-
|
56
|
-
The precise terms and conditions for copying, distribution and
|
57
|
-
modification follow.
|
58
|
-
|
59
|
-
GNU GENERAL PUBLIC LICENSE
|
60
|
-
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
-
|
62
|
-
0. This License applies to any program or other work which contains
|
63
|
-
a notice placed by the copyright holder saying it may be distributed
|
64
|
-
under the terms of this General Public License. The "Program", below,
|
65
|
-
refers to any such program or work, and a "work based on the Program"
|
66
|
-
means either the Program or any derivative work under copyright law:
|
67
|
-
that is to say, a work containing the Program or a portion of it,
|
68
|
-
either verbatim or with modifications and/or translated into another
|
69
|
-
language. (Hereinafter, translation is included without limitation in
|
70
|
-
the term "modification".) Each licensee is addressed as "you".
|
71
|
-
|
72
|
-
Activities other than copying, distribution and modification are not
|
73
|
-
covered by this License; they are outside its scope. The act of
|
74
|
-
running the Program is not restricted, and the output from the Program
|
75
|
-
is covered only if its contents constitute a work based on the
|
76
|
-
Program (independent of having been made by running the Program).
|
77
|
-
Whether that is true depends on what the Program does.
|
78
|
-
|
79
|
-
1. You may copy and distribute verbatim copies of the Program's
|
80
|
-
source code as you receive it, in any medium, provided that you
|
81
|
-
conspicuously and appropriately publish on each copy an appropriate
|
82
|
-
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
-
notices that refer to this License and to the absence of any warranty;
|
84
|
-
and give any other recipients of the Program a copy of this License
|
85
|
-
along with the Program.
|
86
|
-
|
87
|
-
You may charge a fee for the physical act of transferring a copy, and
|
88
|
-
you may at your option offer warranty protection in exchange for a fee.
|
89
|
-
|
90
|
-
2. You may modify your copy or copies of the Program or any portion
|
91
|
-
of it, thus forming a work based on the Program, and copy and
|
92
|
-
distribute such modifications or work under the terms of Section 1
|
93
|
-
above, provided that you also meet all of these conditions:
|
94
|
-
|
95
|
-
a) You must cause the modified files to carry prominent notices
|
96
|
-
stating that you changed the files and the date of any change.
|
97
|
-
|
98
|
-
b) You must cause any work that you distribute or publish, that in
|
99
|
-
whole or in part contains or is derived from the Program or any
|
100
|
-
part thereof, to be licensed as a whole at no charge to all third
|
101
|
-
parties under the terms of this License.
|
102
|
-
|
103
|
-
c) If the modified program normally reads commands interactively
|
104
|
-
when run, you must cause it, when started running for such
|
105
|
-
interactive use in the most ordinary way, to print or display an
|
106
|
-
announcement including an appropriate copyright notice and a
|
107
|
-
notice that there is no warranty (or else, saying that you provide
|
108
|
-
a warranty) and that users may redistribute the program under
|
109
|
-
these conditions, and telling the user how to view a copy of this
|
110
|
-
License. (Exception: if the Program itself is interactive but
|
111
|
-
does not normally print such an announcement, your work based on
|
112
|
-
the Program is not required to print an announcement.)
|
113
|
-
|
114
|
-
These requirements apply to the modified work as a whole. If
|
115
|
-
identifiable sections of that work are not derived from the Program,
|
116
|
-
and can be reasonably considered independent and separate works in
|
117
|
-
themselves, then this License, and its terms, do not apply to those
|
118
|
-
sections when you distribute them as separate works. But when you
|
119
|
-
distribute the same sections as part of a whole which is a work based
|
120
|
-
on the Program, the distribution of the whole must be on the terms of
|
121
|
-
this License, whose permissions for other licensees extend to the
|
122
|
-
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
-
|
124
|
-
Thus, it is not the intent of this section to claim rights or contest
|
125
|
-
your rights to work written entirely by you; rather, the intent is to
|
126
|
-
exercise the right to control the distribution of derivative or
|
127
|
-
collective works based on the Program.
|
128
|
-
|
129
|
-
In addition, mere aggregation of another work not based on the Program
|
130
|
-
with the Program (or with a work based on the Program) on a volume of
|
131
|
-
a storage or distribution medium does not bring the other work under
|
132
|
-
the scope of this License.
|
133
|
-
|
134
|
-
3. You may copy and distribute the Program (or a work based on it,
|
135
|
-
under Section 2) in object code or executable form under the terms of
|
136
|
-
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
-
|
138
|
-
a) Accompany it with the complete corresponding machine-readable
|
139
|
-
source code, which must be distributed under the terms of Sections
|
140
|
-
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
-
|
142
|
-
b) Accompany it with a written offer, valid for at least three
|
143
|
-
years, to give any third party, for a charge no more than your
|
144
|
-
cost of physically performing source distribution, a complete
|
145
|
-
machine-readable copy of the corresponding source code, to be
|
146
|
-
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
-
customarily used for software interchange; or,
|
148
|
-
|
149
|
-
c) Accompany it with the information you received as to the offer
|
150
|
-
to distribute corresponding source code. (This alternative is
|
151
|
-
allowed only for noncommercial distribution and only if you
|
152
|
-
received the program in object code or executable form with such
|
153
|
-
an offer, in accord with Subsection b above.)
|
154
|
-
|
155
|
-
The source code for a work means the preferred form of the work for
|
156
|
-
making modifications to it. For an executable work, complete source
|
157
|
-
code means all the source code for all modules it contains, plus any
|
158
|
-
associated interface definition files, plus the scripts used to
|
159
|
-
control compilation and installation of the executable. However, as a
|
160
|
-
special exception, the source code distributed need not include
|
161
|
-
anything that is normally distributed (in either source or binary
|
162
|
-
form) with the major components (compiler, kernel, and so on) of the
|
163
|
-
operating system on which the executable runs, unless that component
|
164
|
-
itself accompanies the executable.
|
165
|
-
|
166
|
-
If distribution of executable or object code is made by offering
|
167
|
-
access to copy from a designated place, then offering equivalent
|
168
|
-
access to copy the source code from the same place counts as
|
169
|
-
distribution of the source code, even though third parties are not
|
170
|
-
compelled to copy the source along with the object code.
|
171
|
-
|
172
|
-
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
-
except as expressly provided under this License. Any attempt
|
174
|
-
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
-
void, and will automatically terminate your rights under this License.
|
176
|
-
However, parties who have received copies, or rights, from you under
|
177
|
-
this License will not have their licenses terminated so long as such
|
178
|
-
parties remain in full compliance.
|
179
|
-
|
180
|
-
5. You are not required to accept this License, since you have not
|
181
|
-
signed it. However, nothing else grants you permission to modify or
|
182
|
-
distribute the Program or its derivative works. These actions are
|
183
|
-
prohibited by law if you do not accept this License. Therefore, by
|
184
|
-
modifying or distributing the Program (or any work based on the
|
185
|
-
Program), you indicate your acceptance of this License to do so, and
|
186
|
-
all its terms and conditions for copying, distributing or modifying
|
187
|
-
the Program or works based on it.
|
188
|
-
|
189
|
-
6. Each time you redistribute the Program (or any work based on the
|
190
|
-
Program), the recipient automatically receives a license from the
|
191
|
-
original licensor to copy, distribute or modify the Program subject to
|
192
|
-
these terms and conditions. You may not impose any further
|
193
|
-
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
-
You are not responsible for enforcing compliance by third parties to
|
195
|
-
this License.
|
196
|
-
|
197
|
-
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
-
infringement or for any other reason (not limited to patent issues),
|
199
|
-
conditions are imposed on you (whether by court order, agreement or
|
200
|
-
otherwise) that contradict the conditions of this License, they do not
|
201
|
-
excuse you from the conditions of this License. If you cannot
|
202
|
-
distribute so as to satisfy simultaneously your obligations under this
|
203
|
-
License and any other pertinent obligations, then as a consequence you
|
204
|
-
may not distribute the Program at all. For example, if a patent
|
205
|
-
license would not permit royalty-free redistribution of the Program by
|
206
|
-
all those who receive copies directly or indirectly through you, then
|
207
|
-
the only way you could satisfy both it and this License would be to
|
208
|
-
refrain entirely from distribution of the Program.
|
209
|
-
|
210
|
-
If any portion of this section is held invalid or unenforceable under
|
211
|
-
any particular circumstance, the balance of the section is intended to
|
212
|
-
apply and the section as a whole is intended to apply in other
|
213
|
-
circumstances.
|
214
|
-
|
215
|
-
It is not the purpose of this section to induce you to infringe any
|
216
|
-
patents or other property right claims or to contest validity of any
|
217
|
-
such claims; this section has the sole purpose of protecting the
|
218
|
-
integrity of the free software distribution system, which is
|
219
|
-
implemented by public license practices. Many people have made
|
220
|
-
generous contributions to the wide range of software distributed
|
221
|
-
through that system in reliance on consistent application of that
|
222
|
-
system; it is up to the author/donor to decide if he or she is willing
|
223
|
-
to distribute software through any other system and a licensee cannot
|
224
|
-
impose that choice.
|
225
|
-
|
226
|
-
This section is intended to make thoroughly clear what is believed to
|
227
|
-
be a consequence of the rest of this License.
|
228
|
-
|
229
|
-
8. If the distribution and/or use of the Program is restricted in
|
230
|
-
certain countries either by patents or by copyrighted interfaces, the
|
231
|
-
original copyright holder who places the Program under this License
|
232
|
-
may add an explicit geographical distribution limitation excluding
|
233
|
-
those countries, so that distribution is permitted only in or among
|
234
|
-
countries not thus excluded. In such case, this License incorporates
|
235
|
-
the limitation as if written in the body of this License.
|
236
|
-
|
237
|
-
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
-
of the General Public License from time to time. Such new versions will
|
239
|
-
be similar in spirit to the present version, but may differ in detail to
|
240
|
-
address new problems or concerns.
|
241
|
-
|
242
|
-
Each version is given a distinguishing version number. If the Program
|
243
|
-
specifies a version number of this License which applies to it and "any
|
244
|
-
later version", you have the option of following the terms and conditions
|
245
|
-
either of that version or of any later version published by the Free
|
246
|
-
Software Foundation. If the Program does not specify a version number of
|
247
|
-
this License, you may choose any version ever published by the Free Software
|
248
|
-
Foundation.
|
249
|
-
|
250
|
-
10. If you wish to incorporate parts of the Program into other free
|
251
|
-
programs whose distribution conditions are different, write to the author
|
252
|
-
to ask for permission. For software which is copyrighted by the Free
|
253
|
-
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
-
make exceptions for this. Our decision will be guided by the two goals
|
255
|
-
of preserving the free status of all derivatives of our free software and
|
256
|
-
of promoting the sharing and reuse of software generally.
|
257
|
-
|
258
|
-
NO WARRANTY
|
259
|
-
|
260
|
-
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
-
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
-
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
-
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
-
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
-
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
-
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
-
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
-
REPAIR OR CORRECTION.
|
269
|
-
|
270
|
-
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
-
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
-
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
-
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
-
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
-
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
-
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
-
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
-
POSSIBILITY OF SUCH DAMAGES.
|
279
|
-
|
280
|
-
END OF TERMS AND CONDITIONS
|
data/doc/LICENSE-RUBY
DELETED
@@ -1,56 +0,0 @@
|
|
1
|
-
Net::SFTP is copyrighted free software by Jamis Buck <jamis@37signals.com>.
|
2
|
-
You can redistribute it and/or modify it under either the terms of the GPL
|
3
|
-
(see the file GPL), or the conditions below:
|
4
|
-
|
5
|
-
1. You may make and give away verbatim copies of the source form of the
|
6
|
-
software without restriction, provided that you duplicate all of the
|
7
|
-
original copyright notices and associated disclaimers.
|
8
|
-
|
9
|
-
2. You may modify your copy of the software in any way, provided that
|
10
|
-
you do at least ONE of the following:
|
11
|
-
|
12
|
-
a) place your modifications in the Public Domain or otherwise
|
13
|
-
make them Freely Available, such as by posting said
|
14
|
-
modifications to Usenet or an equivalent medium, or by allowing
|
15
|
-
the author to include your modifications in the software.
|
16
|
-
|
17
|
-
b) use the modified software only within your corporation or
|
18
|
-
organization.
|
19
|
-
|
20
|
-
c) give non-standard binaries non-standard names, with
|
21
|
-
instructions on where to get the original software distribution.
|
22
|
-
|
23
|
-
d) make other distribution arrangements with the author.
|
24
|
-
|
25
|
-
3. You may distribute the software in object code or binary form,
|
26
|
-
provided that you do at least ONE of the following:
|
27
|
-
|
28
|
-
a) distribute the binaries and library files of the software,
|
29
|
-
together with instructions (in the manual page or equivalent)
|
30
|
-
on where to get the original distribution.
|
31
|
-
|
32
|
-
b) accompany the distribution with the machine-readable source of
|
33
|
-
the software.
|
34
|
-
|
35
|
-
c) give non-standard binaries non-standard names, with
|
36
|
-
instructions on where to get the original software distribution.
|
37
|
-
|
38
|
-
d) make other distribution arrangements with the author.
|
39
|
-
|
40
|
-
4. You may modify and include the part of the software into any other
|
41
|
-
software (possibly commercial). But some files in the distribution
|
42
|
-
are not written by the author, so that they are not under these terms.
|
43
|
-
|
44
|
-
For the list of those files and their copying conditions, see the
|
45
|
-
file LEGAL.
|
46
|
-
|
47
|
-
5. The scripts and library files supplied as input to or produced as
|
48
|
-
output from the software do not automatically fall under the
|
49
|
-
copyright of the software, but belong to whomever generated them,
|
50
|
-
and may be sold commercially, and may be aggregated with this
|
51
|
-
software.
|
52
|
-
|
53
|
-
6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
|
54
|
-
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
|
55
|
-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
56
|
-
PURPOSE.
|
data/doc/faq/faq.html
DELETED
@@ -1,298 +0,0 @@
|
|
1
|
-
<html>
|
2
|
-
<head>
|
3
|
-
<title>Net::SFTP FAQ</title>
|
4
|
-
<style type="text/css">
|
5
|
-
a, a:visited, a:active {
|
6
|
-
color: #00F;
|
7
|
-
text-decoration: none;
|
8
|
-
}
|
9
|
-
|
10
|
-
a:hover {
|
11
|
-
text-decoration: underline;
|
12
|
-
}
|
13
|
-
|
14
|
-
.faq-list {
|
15
|
-
color: #000;
|
16
|
-
font-family: vera-sans, verdana, arial, sans-serif;
|
17
|
-
}
|
18
|
-
|
19
|
-
.faq-title {
|
20
|
-
background: #007;
|
21
|
-
color: #FFF;
|
22
|
-
font-family: vera-sans, verdana, arial, sans-serif;
|
23
|
-
padding-left: 1em;
|
24
|
-
padding-top: 0.5em;
|
25
|
-
padding-bottom: 0.5em;
|
26
|
-
font-weight: bold;
|
27
|
-
font-size: large;
|
28
|
-
border: 1px solid #000;
|
29
|
-
}
|
30
|
-
|
31
|
-
.faq-answer {
|
32
|
-
margin-left: 1em;
|
33
|
-
color: #000;
|
34
|
-
font-family: vera-sans, verdana, arial, sans-serif;
|
35
|
-
}
|
36
|
-
|
37
|
-
.faq-answer pre {
|
38
|
-
margin-left: 1em;
|
39
|
-
color: #000;
|
40
|
-
background: #FFE;
|
41
|
-
font-size: normal;
|
42
|
-
border: 1px dotted #CCC;
|
43
|
-
padding: 1em;
|
44
|
-
}
|
45
|
-
|
46
|
-
h1 {
|
47
|
-
background: #005;
|
48
|
-
color: #FFF;
|
49
|
-
font-family: vera-sans, verdana, arial, sans-serif;
|
50
|
-
padding-left: 1em;
|
51
|
-
padding-top: 1em;
|
52
|
-
padding-bottom: 1em;
|
53
|
-
font-weight: bold;
|
54
|
-
font-size: x-large;
|
55
|
-
border: 1px solid #00F;
|
56
|
-
}
|
57
|
-
</style>
|
58
|
-
</head>
|
59
|
-
<body>
|
60
|
-
<h1>Net::SFTP FAQ</h1>
|
61
|
-
<div class="faq-list">
|
62
|
-
<ul>
|
63
|
-
<li><a href='#3145900'>What is Net::SFTP?</a></li>
|
64
|
-
<li>How do I…
|
65
|
-
<ul>
|
66
|
-
<li>...connect to an <span class="caps">SFTP</span> server?
|
67
|
-
<ul>
|
68
|
-
<li><a href='#3145750'>I’d like to connect without first getting a Net::SSH connection…</a></li>
|
69
|
-
<li><a href='#3145670'>I already have an open Net::SSH connection…</a></li>
|
70
|
-
</ul>
|
71
|
-
</li>
|
72
|
-
<li>...upload data?
|
73
|
-
<ul>
|
74
|
-
<li><a href='#3145440'>I want to upload an entire file on disk…</a></li>
|
75
|
-
<li><a href='#3145310'>I want to upload bytes from a string or other object…</a></li>
|
76
|
-
</ul>
|
77
|
-
</li>
|
78
|
-
<li>...download data?
|
79
|
-
<ul>
|
80
|
-
<li><a href='#3145130'>I want to download directly to a local file…</a></li>
|
81
|
-
<li><a href='#3142470'>I want to download to a string in memory…</a></li>
|
82
|
-
<li><a href='#3142380'>I want to be notified of the progress of the download…</a></li>
|
83
|
-
</ul>
|
84
|
-
</li>
|
85
|
-
<li>...manage file permissions?
|
86
|
-
<ul>
|
87
|
-
<li><a href='#3142190'>I want to query a file’s permissions…</a></li>
|
88
|
-
<li><a href='#3142110'>I want to change a file’s permissions…</a></li>
|
89
|
-
<li><a href='#3142040'>I already have an open handle for the remote file…</a></li>
|
90
|
-
</ul>
|
91
|
-
</li>
|
92
|
-
<li>...manage directories?
|
93
|
-
<ul>
|
94
|
-
<li><a href='#3141850'>I want to query the contents of a directory…</a></li>
|
95
|
-
<li><a href='#3141770'>I want to create a directory…</a></li>
|
96
|
-
<li><a href='#3141690'>I want to remove a directory…</a></li>
|
97
|
-
</ul>
|
98
|
-
</li>
|
99
|
-
<li><a href='#3141560'>...delete a file?</a></li>
|
100
|
-
<li><a href='#3141480'>...rename a file?</a></li>
|
101
|
-
</ul>
|
102
|
-
</li>
|
103
|
-
</ul>
|
104
|
-
</div>
|
105
|
-
<a name='3145900'></a>
|
106
|
-
<div class='faq-title'>What is Net::SFTP?</div>
|
107
|
-
<div class='faq-answer'><p>Net::SFTP is a pure-Ruby implementation of the <span class="caps">SFTP</span> protocol. That’s
|
108
|
-
“SFTP” as in “Secure File Transfer Protocol”, as defined as an adjuct to the
|
109
|
-
<span class="caps">SSH</span> specification. <em>Not</em> “SFTP” as in “Secure <span class="caps">FTP</span>” (a <em>completely</em> different
|
110
|
-
beast). Nor is it an implementation of the “Simple File Transfer Protocol”
|
111
|
-
(which is in no way secure).</p></div>
|
112
|
-
<a name='3145750'></a>
|
113
|
-
<div class='faq-title'>How do I… ...connect to an <span class="caps">SFTP</span> server? I’d like to connect without first getting a Net::SSH connection…</div>
|
114
|
-
<div class='faq-answer'><p>Something like this:</p>
|
115
|
-
|
116
|
-
|
117
|
-
<code><pre>
|
118
|
-
require 'net/sftp'
|
119
|
-
|
120
|
-
Net::SFTP.start(host, user, password) do |sftp|
|
121
|
-
...
|
122
|
-
end
|
123
|
-
</pre></code>
|
124
|
-
|
125
|
-
<p><code>Net::SFTP.start</code> accepts the same parameters as <code>Net::SSH.start</code>,
|
126
|
-
so I’ll direct you to that documentation for all the particulars.</p></div>
|
127
|
-
<a name='3145670'></a>
|
128
|
-
<div class='faq-title'>How do I… ...connect to an <span class="caps">SFTP</span> server? I already have an open Net::SSH connection…</div>
|
129
|
-
<div class='faq-answer'><p>You can piggy-back an <span class="caps">SFTP</span> connection on an existing Net::SSH
|
130
|
-
connection, which can be useful if you’ve already got an <span class="caps">SSH</span>
|
131
|
-
connection that you’re using for port forwarding or whatever.</p>
|
132
|
-
|
133
|
-
|
134
|
-
<code><pre>
|
135
|
-
require 'net/ssh'
|
136
|
-
require 'net/sftp'
|
137
|
-
|
138
|
-
Net::SSH.start(host, user, password) do |ssh|
|
139
|
-
...
|
140
|
-
ssh.sftp.connect do |sftp|
|
141
|
-
...
|
142
|
-
end
|
143
|
-
...
|
144
|
-
end
|
145
|
-
</pre></code></div>
|
146
|
-
<a name='3145440'></a>
|
147
|
-
<div class='faq-title'>How do I… ...upload data? I want to upload an entire file on disk…</div>
|
148
|
-
<div class='faq-answer'><p>Assuming you already have an <span class="caps">SFTP</span> connection:</p>
|
149
|
-
|
150
|
-
|
151
|
-
<code><pre>
|
152
|
-
sftp.put_file "/path/to/local.file", "/path/to/remote.file"
|
153
|
-
</pre></code></div>
|
154
|
-
<a name='3145310'></a>
|
155
|
-
<div class='faq-title'>How do I… ...upload data? I want to upload bytes from a string or other object…</div>
|
156
|
-
<div class='faq-answer'><p>Assuming you already have an <span class="caps">SFTP</span> connection, and your data is stored
|
157
|
-
in a string named <code>data</code>:</p>
|
158
|
-
|
159
|
-
|
160
|
-
<code><pre>
|
161
|
-
sftp.open_handle("/path/to/remote.file", "w") do |handle|
|
162
|
-
result = sftp.write(handle, data)
|
163
|
-
puts result.code # the result of the operation
|
164
|
-
end
|
165
|
-
</pre></code>
|
166
|
-
|
167
|
-
<p>If (for whatever reason) you’d rather not use blocks, you can do
|
168
|
-
without, but be sure to call <code>close_handle</code> when you’re done:</p>
|
169
|
-
|
170
|
-
|
171
|
-
<code><pre>
|
172
|
-
handle = sftp.open_handle("/path/to/remote.file", "w")
|
173
|
-
result = sftp.write(handle, data)
|
174
|
-
puts result.code # the result of the operation
|
175
|
-
sftp.close_handle(handle)
|
176
|
-
</pre></code></div>
|
177
|
-
<a name='3145130'></a>
|
178
|
-
<div class='faq-title'>How do I… ...download data? I want to download directly to a local file…</div>
|
179
|
-
<div class='faq-answer'><p>Assuming you already have an <span class="caps">SFTP</span> connection:</p>
|
180
|
-
|
181
|
-
|
182
|
-
<code><pre>
|
183
|
-
sftp.get_file "/path/to/remote.file", "/path/to/local.file"
|
184
|
-
</pre></code></div>
|
185
|
-
<a name='3142470'></a>
|
186
|
-
<div class='faq-title'>How do I… ...download data? I want to download to a string in memory…</div>
|
187
|
-
<div class='faq-answer'><p>Assuming you already have an <span class="caps">SFTP</span> connection:</p>
|
188
|
-
|
189
|
-
|
190
|
-
<code><pre>
|
191
|
-
data = nil
|
192
|
-
sftp.open_handle("/path/to/remote.file") do |handle|
|
193
|
-
data = sftp.read(handle)
|
194
|
-
end
|
195
|
-
</pre></code></div>
|
196
|
-
<a name='3142380'></a>
|
197
|
-
<div class='faq-title'>How do I… ...download data? I want to be notified of the progress of the download…</div>
|
198
|
-
<div class='faq-answer'><p>You can specify both a “chunk size” and a “progress callback”. The
|
199
|
-
callback will be invoked for every “chunk size” bytes that are
|
200
|
-
received:</p>
|
201
|
-
|
202
|
-
|
203
|
-
<code><pre>
|
204
|
-
sftp.open_handle("/path/to/remote.file") do |handle|
|
205
|
-
begin
|
206
|
-
STDOUT.sync = true
|
207
|
-
data = sftp.read(handle, :chunk_size => 4096,
|
208
|
-
:progress_callback => lambda { |data| print "." })
|
209
|
-
puts
|
210
|
-
ensure
|
211
|
-
STDOUT.sync = false
|
212
|
-
end
|
213
|
-
end
|
214
|
-
</pre></code></div>
|
215
|
-
<a name='3142190'></a>
|
216
|
-
<div class='faq-title'>How do I… ...manage file permissions? I want to query a file’s permissions…</div>
|
217
|
-
<div class='faq-answer'><p>File permissions are one of the <code>stat</code> attributes of files and
|
218
|
-
directories:</p>
|
219
|
-
|
220
|
-
|
221
|
-
<code><pre>
|
222
|
-
p sftp.stat("/path/to/remote.file").permissions
|
223
|
-
</pre></code></div>
|
224
|
-
<a name='3142110'></a>
|
225
|
-
<div class='faq-title'>How do I… ...manage file permissions? I want to change a file’s permissions…</div>
|
226
|
-
<div class='faq-answer'><p>Just use <code>setstat</code> to change the permissions of an existing file:</p>
|
227
|
-
|
228
|
-
|
229
|
-
<code><pre>
|
230
|
-
sftp.setstat("/path/to/remote.file", :permissions => 0644)
|
231
|
-
</pre></code></div>
|
232
|
-
<a name='3142040'></a>
|
233
|
-
<div class='faq-title'>How do I… ...manage file permissions? I already have an open handle for the remote file…</div>
|
234
|
-
<div class='faq-answer'><p>If you have a handle for the remote file, you can use <code>fstat</code> and
|
235
|
-
<code>fsetstat</code> to query and set the permissions:</p>
|
236
|
-
|
237
|
-
|
238
|
-
<code><pre>
|
239
|
-
sftp.open_handle("/path/to/remote.file") do |handle|
|
240
|
-
permissions = sftp.fstat(handle)
|
241
|
-
sftp.fsetstat(handle, :permissions => permissions | 0444)
|
242
|
-
end
|
243
|
-
</pre></code></div>
|
244
|
-
<a name='3141850'></a>
|
245
|
-
<div class='faq-title'>How do I… ...manage directories? I want to query the contents of a directory…</div>
|
246
|
-
<div class='faq-answer'><p>You query the contents of a directory by calling <code>opendir</code> to obtain
|
247
|
-
a handle to the directory, and then using <code>readdir</code> on the handle to
|
248
|
-
obtain a list of directory entries. Be sure to close the handle when
|
249
|
-
you’re done:</p>
|
250
|
-
|
251
|
-
|
252
|
-
<code><pre>
|
253
|
-
handle = sftp.opendir("/usr/lib")
|
254
|
-
items = sftp.readdir(handle)
|
255
|
-
items.each do |item|
|
256
|
-
puts item.filename
|
257
|
-
puts item.longname
|
258
|
-
p item.attributes # permissions, atime, etc.
|
259
|
-
end
|
260
|
-
sftp.close_handle(handle)
|
261
|
-
</pre></code></div>
|
262
|
-
<a name='3141770'></a>
|
263
|
-
<div class='faq-title'>How do I… ...manage directories? I want to create a directory…</div>
|
264
|
-
<div class='faq-answer'><p>Use <code>mkdir</code>:</p>
|
265
|
-
|
266
|
-
|
267
|
-
<code><pre>
|
268
|
-
sftp.mkdir("/path/to/remote/dir", :permissions => 0500)
|
269
|
-
</pre></code></div>
|
270
|
-
<a name='3141690'></a>
|
271
|
-
<div class='faq-title'>How do I… ...manage directories? I want to remove a directory…</div>
|
272
|
-
<div class='faq-answer'><p>Use <code>rmdir</code>:</p>
|
273
|
-
|
274
|
-
|
275
|
-
<code><pre>
|
276
|
-
sftp.rmdir("/path/to/remote/dir")
|
277
|
-
</pre></code></div>
|
278
|
-
<a name='3141560'></a>
|
279
|
-
<div class='faq-title'>How do I… ...delete a file?</div>
|
280
|
-
<div class='faq-answer'><p>Use <code>remove</code>:</p>
|
281
|
-
|
282
|
-
|
283
|
-
<code><pre>
|
284
|
-
sftp.remove("/path/to/remote.file")
|
285
|
-
</pre></code></div>
|
286
|
-
<a name='3141480'></a>
|
287
|
-
<div class='faq-title'>How do I… ...rename a file?</div>
|
288
|
-
<div class='faq-answer'><p>Use <code>rename</code>:</p>
|
289
|
-
|
290
|
-
|
291
|
-
<code><pre>
|
292
|
-
sftp.rename("/path/to/remote.file", "/path/to/new.file")
|
293
|
-
</pre></code>
|
294
|
-
|
295
|
-
<p>It should be noted that <code>rename</code> is only supported by version 2 or
|
296
|
-
later of the <span class="caps">SFTP</span> protocol, so if you’re using an older <span class="caps">SFTP</span> server you
|
297
|
-
might not be able to use this operation.</p></div>
|
298
|
-
</body></html>
|