Lines 1-446
Link Here
|
1 |
package Koha::SFTP::Server; |
|
|
2 |
|
3 |
# This file is part of Koha. |
4 |
# |
5 |
# Koha is free software; you can redistribute it and/or modify it |
6 |
# under the terms of the GNU General Public License as published by |
7 |
# the Free Software Foundation; either version 3 of the License, or |
8 |
# (at your option) any later version. |
9 |
# |
10 |
# Koha is distributed in the hope that it will be useful, but |
11 |
# WITHOUT ANY WARRANTY; without even the implied warranty of |
12 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 |
# GNU General Public License for more details. |
14 |
# |
15 |
# You should have received a copy of the GNU General Public License |
16 |
# along with Koha; if not, see <http://www.gnu.org/licenses>. |
17 |
|
18 |
use Modern::Perl; |
19 |
|
20 |
use Koha::Database; |
21 |
use Koha::Exceptions::Object; |
22 |
use Koha::Encryption; |
23 |
use Koha::Logger; |
24 |
use Koha::SFTP::Servers; |
25 |
|
26 |
use Try::Tiny qw( catch try ); |
27 |
use Mojo::JSON; |
28 |
use Net::SFTP::Foreign; |
29 |
use Net::FTP; |
30 |
use File::Spec; |
31 |
use IO::File; |
32 |
|
33 |
use base qw(Koha::Object); |
34 |
|
35 |
=head1 NAME |
36 |
|
37 |
Koha::SFTP::Server - Koha SFTP Server Object class |
38 |
|
39 |
=head1 API |
40 |
|
41 |
=head2 Class methods |
42 |
|
43 |
=head3 store |
44 |
|
45 |
$server->store; |
46 |
|
47 |
Overloaded store method that ensures directory paths end with a forward slash. |
48 |
|
49 |
=cut |
50 |
|
51 |
sub store { |
52 |
my ($self) = @_; |
53 |
|
54 |
for my $dir_field (qw( download_directory upload_directory )) { |
55 |
my $dir = $self->$dir_field; |
56 |
next unless $dir && $dir ne ''; |
57 |
|
58 |
$self->$dir_field( $dir . '/' ) unless substr( $dir, -1 ) eq '/'; |
59 |
} |
60 |
|
61 |
return $self->SUPER::store; |
62 |
} |
63 |
|
64 |
=head3 to_api |
65 |
|
66 |
my $json = $sftp_server->to_api; |
67 |
|
68 |
Returns a JSON representation of the object suitable for API output, |
69 |
excluding sensitive data. |
70 |
|
71 |
=cut |
72 |
|
73 |
sub to_api { |
74 |
my ( $self, $params ) = @_; |
75 |
|
76 |
my $json_sftp = $self->SUPER::to_api($params) or return; |
77 |
delete $json_sftp->{password}; |
78 |
delete $json_sftp->{key_file}; |
79 |
|
80 |
return $json_sftp; |
81 |
} |
82 |
|
83 |
=head3 to_api_mapping |
84 |
|
85 |
This method returns the mapping for representing a Koha::SFTP::Server object |
86 |
on the API. |
87 |
|
88 |
=cut |
89 |
|
90 |
sub to_api_mapping { |
91 |
return { id => 'sftp_server_id' }; |
92 |
} |
93 |
|
94 |
=head3 plain_text_password |
95 |
|
96 |
my $password = $server->plain_text_password; |
97 |
|
98 |
Returns the decrypted plaintext password. |
99 |
|
100 |
=cut |
101 |
|
102 |
sub plain_text_password { |
103 |
my ($self) = @_; |
104 |
return unless $self->password; |
105 |
return Koha::Encryption->new->decrypt_hex( $self->password ); |
106 |
} |
107 |
|
108 |
=head3 plain_text_key |
109 |
|
110 |
my $key = $server->plain_text_key; |
111 |
|
112 |
Returns the decrypted plaintext key file. |
113 |
|
114 |
=cut |
115 |
|
116 |
sub plain_text_key { |
117 |
my ($self) = @_; |
118 |
return unless $self->key_file; |
119 |
return Koha::Encryption->new->decrypt_hex( $self->key_file ) . "\n"; |
120 |
} |
121 |
|
122 |
=head3 write_key_file |
123 |
|
124 |
my $success = $server->write_key_file; |
125 |
|
126 |
Writes the keyfile from the db into a file. |
127 |
|
128 |
Returns 1 on success, undef on failure. |
129 |
|
130 |
=cut |
131 |
|
132 |
sub write_key_file { |
133 |
my ($self) = @_; |
134 |
|
135 |
my $upload_path = C4::Context->config('upload_path') or return; |
136 |
my $logger = Koha::Logger->get; |
137 |
my $key_path = File::Spec->catdir( $upload_path, 'ssh_keys' ); |
138 |
my $key_file = File::Spec->catfile( $key_path, 'id_ssh_' . $self->id ); |
139 |
|
140 |
mkdir $key_path unless -d $key_path; |
141 |
unlink $key_file if -f $key_file; |
142 |
|
143 |
my $fh = IO::File->new( $key_file, 'w' ) or return; |
144 |
|
145 |
try { |
146 |
chmod 0600, $key_file if -f $key_file; |
147 |
print $fh $self->plain_text_key; |
148 |
close $fh or $logger->warn("Failed to close key file: $!"); |
149 |
return 1; |
150 |
} catch { |
151 |
$logger->warn("Error writing key file: $_"); |
152 |
close $fh; |
153 |
return; |
154 |
}; |
155 |
} |
156 |
|
157 |
=head3 locate_key_file |
158 |
|
159 |
my $path = $server->locate_key_file; |
160 |
|
161 |
Returns the keyfile's path if it exists, undef otherwise. |
162 |
|
163 |
=cut |
164 |
|
165 |
sub locate_key_file { |
166 |
my ($self) = @_; |
167 |
|
168 |
my $upload_path = C4::Context->config('upload_path') or return; |
169 |
my $key_file = File::Spec->catfile( |
170 |
$upload_path, |
171 |
'ssh_keys', |
172 |
'id_ssh_' . $self->id |
173 |
); |
174 |
|
175 |
return ( -f $key_file ) ? $key_file : undef; |
176 |
} |
177 |
|
178 |
=head3 update_password |
179 |
|
180 |
my $success = $server->update_password; |
181 |
|
182 |
Update the server's encrypted password. |
183 |
|
184 |
=cut |
185 |
|
186 |
sub update_password { |
187 |
my ( $self, $value ) = @_; |
188 |
return unless defined $value; |
189 |
|
190 |
$self->password( Koha::Encryption->new->encrypt_hex($value) ); |
191 |
return $self->SUPER::store; |
192 |
} |
193 |
|
194 |
=head3 update_key_file |
195 |
|
196 |
my $success = $server->update_key_file($new_key_file); |
197 |
|
198 |
Update the server's encrypted key file. |
199 |
|
200 |
=cut |
201 |
|
202 |
sub update_key_file { |
203 |
my ( $self, $value ) = @_; |
204 |
return unless defined $value; |
205 |
|
206 |
$self->key_file( Koha::Encryption->new->encrypt_hex( _dos2unix($value) ) ); |
207 |
return $self->SUPER::store; |
208 |
} |
209 |
|
210 |
=head3 update_status |
211 |
|
212 |
my $success = $server->update_status($new_status); |
213 |
|
214 |
Update the server's status |
215 |
|
216 |
=cut |
217 |
|
218 |
sub update_status { |
219 |
my ( $self, $value ) = @_; |
220 |
return unless defined $value; |
221 |
|
222 |
return $self->set( { status => $value } )->store; |
223 |
} |
224 |
|
225 |
=head3 test_conn |
226 |
|
227 |
my ($success, $results) = $server->test_conn; |
228 |
|
229 |
Tests connection to the server. Returns success flag and detailed test results. |
230 |
|
231 |
=cut |
232 |
|
233 |
sub test_conn { |
234 |
my ($self) = @_; |
235 |
my $default_result = { |
236 |
passed => Mojo::JSON->false, |
237 |
err => undef, |
238 |
msg => undef, |
239 |
}; |
240 |
my $sftp_test_results; |
241 |
|
242 |
if ( $self->transport eq 'sftp' ) { |
243 |
$sftp_test_results->{'1_sftp_conn'} = {%$default_result}; |
244 |
my $sftp = Net::SFTP::Foreign->new( |
245 |
host => $self->host, |
246 |
user => $self->user_name, |
247 |
password => $self->plain_text_password, |
248 |
key_path => $self->locate_key_file, |
249 |
port => $self->port, |
250 |
timeout => 10, |
251 |
more => [ |
252 |
qw(-vv), |
253 |
qw(-o StrictHostKeyChecking=no), |
254 |
], |
255 |
); |
256 |
unless ( $sftp->error ) { |
257 |
$sftp_test_results->{'1_sftp_conn'}->{'passed'} = Mojo::JSON->true; |
258 |
$sftp_test_results->{'1_sftp_conn'}->{'msg'} = $sftp->status; |
259 |
} else { |
260 |
$sftp_test_results->{'1_sftp_conn'}->{'err'} = $sftp->error; |
261 |
} |
262 |
|
263 |
unless ( $sftp->error ) { |
264 |
unless ( $self->download_directory eq '' ) { |
265 |
$sftp_test_results->{'2a_sftp_cwd_dl'} = {%$default_result}; |
266 |
$sftp->setcwd( $self->download_directory ); |
267 |
unless ( $sftp->error ) { |
268 |
$sftp_test_results->{'2a_sftp_cwd_dl'}->{'passed'} = Mojo::JSON->true; |
269 |
$sftp_test_results->{'2a_sftp_cwd_dl'}->{'msg'} = $sftp->status; |
270 |
} else { |
271 |
$sftp_test_results->{'2a_sftp_cwd_dl'}->{'err'} = $sftp->error; |
272 |
} |
273 |
} |
274 |
|
275 |
$sftp_test_results->{'2b_sftp_ls_dl'} = {%$default_result}; |
276 |
$sftp->ls(); |
277 |
unless ( $sftp->error ) { |
278 |
$sftp_test_results->{'2b_sftp_ls_dl'}->{'passed'} = Mojo::JSON->true; |
279 |
$sftp_test_results->{'2b_sftp_ls_dl'}->{'msg'} = $sftp->status; |
280 |
} else { |
281 |
$sftp_test_results->{'2b_sftp_ls_dl'}->{'err'} = $sftp->error; |
282 |
} |
283 |
|
284 |
unless ( $self->upload_directory eq '' ) { |
285 |
$sftp_test_results->{'2c_sftp_cwd_ul'} = {%$default_result}; |
286 |
$sftp->setcwd( $self->upload_directory ); |
287 |
unless ( $sftp->error ) { |
288 |
$sftp_test_results->{'2c_sftp_cwd_ul'}->{'passed'} = Mojo::JSON->true; |
289 |
$sftp_test_results->{'2c_sftp_cwd_ul'}->{'msg'} = $sftp->status; |
290 |
} else { |
291 |
$sftp_test_results->{'2c_sftp_cwd_ul'}->{'err'} = $sftp->error; |
292 |
} |
293 |
} |
294 |
|
295 |
$sftp_test_results->{'2d_sftp_ls_ul'} = {%$default_result}; |
296 |
$sftp->ls( $self->upload_directory ); |
297 |
unless ( $sftp->error ) { |
298 |
$sftp_test_results->{'2d_sftp_ls_ul'}->{'passed'} = Mojo::JSON->true; |
299 |
$sftp_test_results->{'2d_sftp_ls_ul'}->{'msg'} = $sftp->status; |
300 |
} else { |
301 |
$sftp_test_results->{'2d_sftp_ls_ul'}->{'err'} = $sftp->error; |
302 |
} |
303 |
|
304 |
$sftp_test_results->{'3_sftp_write'} = {%$default_result}; |
305 |
open my $fh, '<', \"Hello, world!\n"; |
306 |
close $fh if ( $sftp->put( $fh, $self->upload_directory . '.koha_test_file' ) ); |
307 |
unless ( $sftp->error ) { |
308 |
$sftp_test_results->{'3_sftp_write'}->{'passed'} = Mojo::JSON->true; |
309 |
$sftp_test_results->{'3_sftp_write'}->{'msg'} = $sftp->status; |
310 |
} else { |
311 |
$sftp_test_results->{'3_sftp_write'}->{'err'} = $sftp->error; |
312 |
} |
313 |
|
314 |
$sftp_test_results->{'4_sftp_del'} = {%$default_result}; |
315 |
$sftp->remove( $self->upload_directory . '.koha_test_file' ); |
316 |
unless ( $sftp->error ) { |
317 |
$sftp_test_results->{'4_sftp_del'}->{'passed'} = Mojo::JSON->true; |
318 |
$sftp_test_results->{'4_sftp_del'}->{'msg'} = $sftp->status; |
319 |
} else { |
320 |
$sftp_test_results->{'4_sftp_del'}->{'err'} = $sftp->error; |
321 |
} |
322 |
} |
323 |
} elsif ( $self->transport eq 'ftp' ) { |
324 |
$sftp_test_results->{'1_ftp_conn'} = {%$default_result}; |
325 |
my $ftp = Net::FTP->new( |
326 |
$self->host, |
327 |
Port => $self->port, |
328 |
Timeout => 10, |
329 |
Passive => ( scalar $self->passive ) ? 1 : 0, |
330 |
); |
331 |
if ($ftp) { |
332 |
$sftp_test_results->{'1_ftp_conn'}->{'passed'} = Mojo::JSON->true; |
333 |
$sftp_test_results->{'1_ftp_conn'}->{'msg'} = $ftp->message; |
334 |
} else { |
335 |
$sftp_test_results->{'1_ftp_conn'}->{'err'} = 'cannot connect to ' . $self->host . ': ' . $@; |
336 |
} |
337 |
|
338 |
if ($ftp) { |
339 |
$sftp_test_results->{'2_ftp_login'} = {%$default_result}; |
340 |
my $login = $ftp->login( |
341 |
$self->user_name, |
342 |
$self->plain_text_password, |
343 |
); |
344 |
if ($login) { |
345 |
$sftp_test_results->{'2_ftp_login'}->{'passed'} = Mojo::JSON->true; |
346 |
$sftp_test_results->{'2_ftp_login'}->{'msg'} = $ftp->message; |
347 |
} else { |
348 |
$sftp_test_results->{'2_ftp_login'}->{'err'} = $ftp->message; |
349 |
} |
350 |
|
351 |
unless ( $self->download_directory eq '' ) { |
352 |
$sftp_test_results->{'3a_ftp_cwd_dl'} = {%$default_result}; |
353 |
my $cwd_dl = $ftp->cwd( $self->download_directory ); |
354 |
if ($cwd_dl) { |
355 |
$sftp_test_results->{'3a_ftp_cwd_dl'}->{'passed'} = Mojo::JSON->true; |
356 |
$sftp_test_results->{'3a_ftp_cwd_dl'}->{'msg'} = $ftp->message; |
357 |
} else { |
358 |
$sftp_test_results->{'3a_ftp_cwd_dl'}->{'err'} = $ftp->message; |
359 |
} |
360 |
} |
361 |
|
362 |
$sftp_test_results->{'3b_ftp_ls_dl'} = {%$default_result}; |
363 |
my $ls_dl = $ftp->ls(); |
364 |
if ($ls_dl) { |
365 |
$sftp_test_results->{'3b_ftp_ls_dl'}->{'passed'} = Mojo::JSON->true; |
366 |
$sftp_test_results->{'3b_ftp_ls_dl'}->{'msg'} = $ftp->message; |
367 |
} else { |
368 |
$sftp_test_results->{'3b_ftp_ls_dl'}->{'err'} = $ftp->message; |
369 |
} |
370 |
|
371 |
unless ( $self->upload_directory eq '' ) { |
372 |
$sftp_test_results->{'3c_ftp_cwd_ul'} = {%$default_result}; |
373 |
my $cwd_ul = $ftp->cwd( $self->upload_directory ); |
374 |
if ($cwd_ul) { |
375 |
$sftp_test_results->{'3c_ftp_cwd_ul'}->{'passed'} = Mojo::JSON->true; |
376 |
$sftp_test_results->{'3c_ftp_cwd_ul'}->{'msg'} = $ftp->message; |
377 |
} else { |
378 |
$sftp_test_results->{'3c_ftp_cwd_ul'}->{'err'} = $ftp->message; |
379 |
} |
380 |
} |
381 |
|
382 |
$sftp_test_results->{'3d_ftp_ls_ul'} = {%$default_result}; |
383 |
my $ls_ul = $ftp->ls(); |
384 |
if ($ls_ul) { |
385 |
$sftp_test_results->{'3d_ftp_ls_ul'}->{'passed'} = Mojo::JSON->true; |
386 |
$sftp_test_results->{'3d_ftp_ls_ul'}->{'msg'} = $ftp->message; |
387 |
} else { |
388 |
$sftp_test_results->{'3d_ftp_ls_ul'}->{'err'} = $ftp->message; |
389 |
} |
390 |
|
391 |
$sftp_test_results->{'4_ftp_write'} = {%$default_result}; |
392 |
open my $fh, '<', \"Hello, world!\n"; |
393 |
close $fh if ( my $put = $ftp->put( $fh, $self->upload_directory . '.koha_test_file' ) ); |
394 |
if ($put) { |
395 |
$sftp_test_results->{'4_ftp_write'}->{'passed'} = Mojo::JSON->true; |
396 |
$sftp_test_results->{'4_ftp_write'}->{'msg'} = $ftp->message; |
397 |
} else { |
398 |
$sftp_test_results->{'4_ftp_write'}->{'err'} = $ftp->message; |
399 |
} |
400 |
|
401 |
$sftp_test_results->{'5_ftp_del'} = {%$default_result}; |
402 |
my $delete = $ftp->delete( $self->upload_directory . '.koha_test_file' ); |
403 |
if ($delete) { |
404 |
$sftp_test_results->{'5_ftp_del'}->{'passed'} = Mojo::JSON->true; |
405 |
$sftp_test_results->{'5_ftp_del'}->{'msg'} = $ftp->message; |
406 |
} else { |
407 |
$sftp_test_results->{'5_ftp_del'}->{'err'} = $ftp->message; |
408 |
} |
409 |
} |
410 |
} |
411 |
|
412 |
# $self->update_status('tests_ok'); |
413 |
# foreach my $val ( values %$sftp_test_results ) { |
414 |
# if ( defined $val->{'err'} ) { |
415 |
# $self->update_status('tests_failed'); |
416 |
# } |
417 |
# } |
418 |
|
419 |
return ( 1, $sftp_test_results ); |
420 |
} |
421 |
|
422 |
=head2 Internal methods |
423 |
|
424 |
=head3 _dos2unix |
425 |
|
426 |
Return a CR-free string from an input |
427 |
|
428 |
=cut |
429 |
|
430 |
sub _dos2unix { |
431 |
my $dosStr = shift; |
432 |
|
433 |
return $dosStr =~ s/\015\012/\012/gr; |
434 |
} |
435 |
|
436 |
=head3 _type |
437 |
|
438 |
Return type of Object relating to Schema ResultSet |
439 |
|
440 |
=cut |
441 |
|
442 |
sub _type { |
443 |
return 'SftpServer'; |
444 |
} |
445 |
|
446 |
1; |