Line data Source code
1 : #include "../burp.h"
2 : #include "../conffile.h"
3 : #include "../action.h"
4 : #include "../asfd.h"
5 : #include "../async.h"
6 : #include "../cmd.h"
7 : #include "../cntr.h"
8 : #include "../fsops.h"
9 : #include "../handy.h"
10 : #include "../iobuf.h"
11 : #include "../log.h"
12 : #include "../run_script.h"
13 : #include "auth.h"
14 : #include "backup.h"
15 : #include "ca.h"
16 : #include "delete.h"
17 : #include "extra_comms.h"
18 : #include "list.h"
19 : #include "monitor.h"
20 : #include "find_logic.h"
21 : #include "monitor/status_client_ncurses.h"
22 : #include "protocol2/restore.h"
23 : #include "restore.h"
24 : #include "main.h"
25 :
26 : #ifndef HAVE_WIN32
27 : #include <sys/utsname.h>
28 : #endif
29 :
30 : // These will also be used as the exit codes of the program and are therefore
31 : // unsigned integers.
32 : // Remember to update the man page if you update these.
33 : enum cliret
34 : {
35 : CLIENT_OK=0,
36 : CLIENT_ERROR=1,
37 : CLIENT_RESTORE_WARNINGS=2,
38 : CLIENT_SERVER_TIMER_NOT_MET=3,
39 : CLIENT_COULD_NOT_CONNECT=4,
40 : // This one happens after a successful certificate signing request so
41 : // that it connects again straight away with the new key/certificate.
42 : CLIENT_RECONNECT=100
43 : };
44 :
45 : struct tchk
46 : {
47 : int resume;
48 : enum cliret ret;
49 : };
50 :
51 0 : static enum asl_ret maybe_check_timer_func(struct asfd *asfd,
52 : struct conf **confs, void *param)
53 : {
54 0 : int complen=0;
55 0 : struct tchk *tchk=(struct tchk *)param;
56 :
57 0 : if(!strcmp(asfd->rbuf->buf, "timer conditions not met"))
58 : {
59 0 : logp("Timer conditions on the server were not met\n");
60 0 : tchk->ret=CLIENT_SERVER_TIMER_NOT_MET;
61 0 : return ASL_END_OK;
62 : }
63 0 : else if(!strcmp(asfd->rbuf->buf, "timer conditions met"))
64 : {
65 : // Only happens on 'timer check only'.
66 0 : logp("Timer conditions on the server were met\n");
67 0 : tchk->ret=CLIENT_OK;
68 0 : return ASL_END_OK;
69 : }
70 :
71 0 : if(!strncmp_w(asfd->rbuf->buf, "ok"))
72 : complen=3;
73 0 : else if(!strncmp_w(asfd->rbuf->buf, "resume"))
74 : {
75 0 : complen=7;
76 0 : tchk->resume=1;
77 0 : logp("server wants to resume previous backup.\n");
78 : }
79 : else
80 : {
81 0 : iobuf_log_unexpected(asfd->rbuf, __func__);
82 0 : return ASL_END_ERROR;
83 : }
84 :
85 : // The server now tells us the compression level in the OK response.
86 0 : if(strlen(asfd->rbuf->buf)>3)
87 0 : set_int(confs[OPT_COMPRESSION], atoi(asfd->rbuf->buf+complen));
88 0 : logp("Compression level: %d\n",
89 : get_int(confs[OPT_COMPRESSION]));
90 :
91 0 : return ASL_END_OK;
92 : }
93 :
94 0 : static enum cliret maybe_check_timer(struct asfd *asfd,
95 : const char *phase1str, struct conf **confs, int *resume)
96 : {
97 : struct tchk tchk;
98 0 : memset(&tchk, 0, sizeof(tchk));
99 0 : if(asfd->write_str(asfd, CMD_GEN, phase1str))
100 : return CLIENT_ERROR;
101 :
102 0 : if(asfd->simple_loop(asfd, confs, &tchk,
103 : __func__, maybe_check_timer_func)) return CLIENT_ERROR;
104 0 : *resume=tchk.resume;
105 0 : return tchk.ret;
106 : }
107 :
108 0 : static enum cliret backup_wrapper(struct asfd *asfd,
109 : enum action action, const char *phase1str,
110 : const char *incexc, struct conf **confs)
111 : {
112 0 : int resume=0;
113 0 : enum cliret ret=CLIENT_OK;
114 0 : const char *b_script_pre=get_string(confs[OPT_B_SCRIPT_PRE]);
115 0 : const char *b_script_post=get_string(confs[OPT_B_SCRIPT_POST]);
116 :
117 : // Set bulk packets quality of service flags on backup.
118 0 : if(incexc)
119 : {
120 0 : logp("Server is overriding the configuration\n");
121 0 : logp("with the following settings:\n");
122 0 : if(log_incexcs_buf(incexc)) goto error;
123 : }
124 0 : if(!get_strlist(confs[OPT_STARTDIR]))
125 : {
126 0 : logp("Found no include paths!\n");
127 0 : goto error;
128 : }
129 :
130 0 : switch(maybe_check_timer(asfd, phase1str, confs, &resume))
131 : {
132 : case CLIENT_OK:
133 0 : if(action==ACTION_TIMER_CHECK) goto end;
134 : break;
135 : case CLIENT_SERVER_TIMER_NOT_MET:
136 : goto timer_not_met;
137 : default:
138 : goto error;
139 : }
140 :
141 0 : if(b_script_pre)
142 : {
143 0 : int a=0;
144 : const char *args[12];
145 0 : args[a++]=b_script_pre;
146 0 : if(get_int(confs[OPT_B_SCRIPT_RESERVED_ARGS]))
147 : {
148 0 : args[a++]="pre";
149 0 : args[a++]="reserved2";
150 0 : args[a++]="reserved3";
151 0 : args[a++]="reserved4";
152 0 : args[a++]="reserved5";
153 : }
154 0 : args[a++]=NULL;
155 0 : if(run_script(asfd,
156 : args, get_strlist(confs[OPT_B_SCRIPT_PRE_ARG]),
157 : confs, 1, 1, 1))
158 0 : ret=CLIENT_ERROR;
159 :
160 0 : if(get_int(confs[OPT_GLOB_AFTER_SCRIPT_PRE]))
161 : {
162 0 : if(reeval_glob(confs))
163 0 : ret=CLIENT_ERROR;
164 : }
165 : }
166 :
167 0 : if(ret==CLIENT_OK && do_backup_client(asfd,
168 0 : confs, action, resume)) ret=CLIENT_ERROR;
169 :
170 0 : if((ret==CLIENT_OK || get_int(confs[OPT_B_SCRIPT_POST_RUN_ON_FAIL]))
171 0 : && b_script_post)
172 : {
173 0 : int a=0;
174 : const char *args[12];
175 0 : args[a++]=b_script_post;
176 0 : if(get_int(confs[OPT_B_SCRIPT_RESERVED_ARGS]))
177 : {
178 0 : args[a++]="post";
179 : // Tell post script whether the restore failed.
180 0 : args[a++]=ret?"1":"0";
181 0 : args[a++]="reserved3";
182 0 : args[a++]="reserved4";
183 0 : args[a++]="reserved5";
184 : }
185 0 : args[a++]=NULL;
186 : // At this point, the server may have closed the connection,
187 : // so cannot log remotely.
188 0 : if(run_script(asfd,
189 : args, get_strlist(confs[OPT_B_SCRIPT_POST_ARG]),
190 : confs, 1, 1, /*log_remote*/ 0))
191 0 : ret=CLIENT_ERROR;
192 : }
193 :
194 0 : if(ret==CLIENT_OK) logp("backup finished ok\n");
195 :
196 : end:
197 : // The include_logic/exclude_logic cache may have been populated
198 : // during backup so we clean it here
199 0 : free_logic_cache();
200 0 : return ret;
201 : error:
202 0 : logp("error in backup\n");
203 0 : return CLIENT_ERROR;
204 : timer_not_met:
205 : return CLIENT_SERVER_TIMER_NOT_MET;
206 : }
207 :
208 : static int s_server_session_id_context=1;
209 :
210 0 : static int ssl_setup(int *rfd, SSL **ssl, SSL_CTX **ctx,
211 : enum action action, struct conf **confs, const char *server,
212 : struct strlist *failover)
213 : {
214 0 : int ret=-1;
215 0 : int port=0;
216 0 : char portstr[8]="";
217 0 : BIO *sbio=NULL;
218 0 : ssl_load_globals();
219 0 : char *cp=NULL;
220 0 : char *server_copy=NULL;
221 :
222 0 : if(!(server_copy=strdup_w(server, __func__)))
223 : goto end;
224 :
225 0 : if(!(*ctx=ssl_initialise_ctx(confs)))
226 : {
227 0 : logp("error initialising ssl ctx\n");
228 : goto end;
229 : }
230 :
231 0 : if((cp=strrchr(server_copy, ':')))
232 : {
233 0 : *cp='\0';
234 0 : port=atoi(cp+1);
235 : }
236 :
237 0 : SSL_CTX_set_session_id_context(*ctx,
238 : (const uint8_t *)&s_server_session_id_context,
239 : sizeof(s_server_session_id_context));
240 :
241 0 : switch(action)
242 : {
243 : case ACTION_BACKUP:
244 : case ACTION_BACKUP_TIMED:
245 : case ACTION_TIMER_CHECK:
246 0 : if(get_int(confs[OPT_PORT_BACKUP]))
247 0 : port=get_int(confs[OPT_PORT_BACKUP]);
248 : break;
249 : case ACTION_RESTORE:
250 0 : if(get_int(confs[OPT_PORT_RESTORE]))
251 0 : port=get_int(confs[OPT_PORT_RESTORE]);
252 : break;
253 : case ACTION_VERIFY:
254 0 : if(get_int(confs[OPT_PORT_VERIFY]))
255 0 : port=get_int(confs[OPT_PORT_VERIFY]);
256 : break;
257 : case ACTION_LIST:
258 : case ACTION_LIST_LONG:
259 : case ACTION_DIFF:
260 : case ACTION_DIFF_LONG:
261 0 : if(get_int(confs[OPT_PORT_LIST]))
262 0 : port=get_int(confs[OPT_PORT_LIST]);
263 : break;
264 : case ACTION_DELETE:
265 0 : if(get_int(confs[OPT_PORT_DELETE]))
266 0 : port=get_int(confs[OPT_PORT_DELETE]);
267 : break;
268 : case ACTION_MONITOR:
269 : {
270 : struct strlist *s;
271 0 : if(!(s=get_strlist(confs[OPT_STATUS_PORT])))
272 : {
273 0 : logp("%s not set\n",
274 0 : confs[OPT_STATUS_PORT]->field);
275 : goto end;
276 : }
277 0 : port=atoi(s->path);
278 : break;
279 : }
280 : case ACTION_CHAMP_CHOOSER:
281 : case ACTION_ESTIMATE:
282 : case ACTION_STATUS:
283 : case ACTION_STATUS_SNAPSHOT:
284 0 : logp("Unexpected action in %s: %d\n",
285 : __func__, action);
286 : goto end;
287 : }
288 :
289 0 : snprintf(portstr, sizeof(portstr), "%d", port);
290 0 : if((*rfd=init_client_socket(server_copy, portstr))<0)
291 : goto end;
292 :
293 0 : if(!(*ssl=SSL_new(*ctx))
294 0 : || !(sbio=BIO_new_socket(*rfd, BIO_NOCLOSE)))
295 : {
296 0 : logp_ssl_err("Problem joining SSL to the socket\n");
297 : goto end;
298 : }
299 0 : SSL_set_bio(*ssl, sbio, sbio);
300 0 : if(SSL_connect(*ssl)<=0)
301 : {
302 0 : logp_ssl_err("SSL connect error\n");
303 : goto end;
304 : }
305 :
306 : ret=0;
307 : end:
308 0 : free_w(&server_copy);
309 0 : return ret;
310 : }
311 :
312 0 : static enum cliret initial_comms(struct async *as,
313 : enum action *action, char **incexc, struct conf **confs,
314 : struct strlist *failover)
315 : {
316 : struct asfd *asfd;
317 0 : char *server_version=NULL;
318 0 : enum cliret ret=CLIENT_OK;
319 0 : asfd=as->asfd;
320 :
321 0 : if(authorise_client(asfd, &server_version,
322 0 : get_string(confs[OPT_CNAME]),
323 0 : get_string(confs[OPT_PASSWORD]),
324 : get_cntr(confs)))
325 : goto error;
326 :
327 0 : if(server_version)
328 : {
329 0 : logp("Server version: %s\n", server_version);
330 : // Servers before 1.3.2 did not tell us their versions.
331 : // 1.3.2 and above can do the automatic CA stuff that
332 : // follows.
333 0 : switch(ca_client_setup(asfd, confs))
334 : {
335 : case 0:
336 : break; // All OK.
337 : case 1:
338 : // Certificate signed successfully.
339 : // Everything is OK, but we will reconnect now,
340 : // in order to use the new keys/certificates.
341 : goto reconnect;
342 : default:
343 0 : logp("Error with cert signing request\n");
344 0 : goto error;
345 : }
346 : }
347 :
348 0 : if(ssl_check_cert(asfd->ssl, NULL, confs))
349 : {
350 0 : logp("check cert failed\n");
351 0 : goto error;
352 : }
353 :
354 0 : if(extra_comms_client(as, confs, action, failover, incexc))
355 : {
356 0 : logp("extra comms failed\n");
357 0 : goto error;
358 : }
359 :
360 : ret=CLIENT_OK; goto end;
361 : error:
362 : ret=CLIENT_ERROR; goto end;
363 : reconnect:
364 : ret=CLIENT_RECONNECT; goto end;
365 : end:
366 0 : free_w(&server_version);
367 0 : return ret;
368 : }
369 :
370 0 : static enum cliret restore_wrapper(struct asfd *asfd, enum action action,
371 : struct conf **confs)
372 : {
373 0 : enum cliret ret=CLIENT_OK;
374 0 : const char *r_script_pre=get_string(confs[OPT_R_SCRIPT_PRE]);
375 0 : const char *r_script_post=get_string(confs[OPT_R_SCRIPT_POST]);
376 :
377 0 : if(r_script_pre)
378 : {
379 0 : int a=0;
380 : const char *args[12];
381 0 : args[a++]=r_script_pre;
382 0 : if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
383 : {
384 0 : args[a++]="pre";
385 0 : args[a++]="reserved2";
386 0 : args[a++]="reserved3";
387 0 : args[a++]="reserved4";
388 0 : args[a++]="reserved5";
389 : }
390 0 : args[a++]=NULL;
391 0 : if(run_script(asfd,
392 : args, get_strlist(confs[OPT_R_SCRIPT_PRE_ARG]),
393 : confs, 1, 1, 1))
394 0 : ret=CLIENT_ERROR;
395 : }
396 0 : if(ret==CLIENT_OK)
397 : {
398 0 : if(do_restore_client(asfd, confs,
399 0 : action)) ret=CLIENT_ERROR;
400 : }
401 0 : if((ret==CLIENT_OK || get_int(confs[OPT_R_SCRIPT_POST_RUN_ON_FAIL]))
402 0 : && r_script_post)
403 : {
404 0 : int a=0;
405 : const char *args[12];
406 0 : args[a++]=r_script_post;
407 0 : if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
408 : {
409 0 : args[a++]="post";
410 : // Tell post script whether the restore failed.
411 0 : args[a++]=ret?"1":"0";
412 0 : args[a++]="reserved3";
413 0 : args[a++]="reserved4";
414 0 : args[a++]="reserved5";
415 : }
416 0 : args[a++]=NULL;
417 0 : if(run_script(asfd,
418 : args, get_strlist(confs[OPT_R_SCRIPT_POST_ARG]),
419 : confs, 1, 1, /*log_remote*/ 0))
420 0 : ret=CLIENT_ERROR;
421 : }
422 :
423 : // Return non-zero if there were warnings,
424 : // so that the test script can easily check.
425 0 : if(ret==CLIENT_OK && get_cntr(confs)->ent[CMD_WARNING]->count)
426 0 : ret=CLIENT_RESTORE_WARNINGS;
427 :
428 0 : return ret;
429 : }
430 :
431 0 : static enum cliret do_client(struct conf **confs,
432 : enum action action, const char *server,
433 : struct strlist *failover)
434 : {
435 0 : enum cliret ret=CLIENT_OK;
436 0 : int rfd=-1;
437 0 : SSL *ssl=NULL;
438 0 : SSL_CTX *ctx=NULL;
439 0 : struct cntr *cntr=NULL;
440 0 : char *incexc=NULL;
441 0 : enum action act=action;
442 0 : struct async *as=NULL;
443 0 : struct asfd *asfd=NULL;
444 :
445 : // as->settimers(0, 100);
446 :
447 : // logp("begin client\n");
448 : // logp("action %d\n", action);
449 :
450 : // Status monitor forks a child process instead of connecting to
451 : // the server directly.
452 0 : if(action==ACTION_STATUS
453 0 : || action==ACTION_STATUS_SNAPSHOT)
454 : {
455 : #ifdef HAVE_WIN32
456 : logp("Status mode not implemented on Windows.\n");
457 : goto error;
458 : #endif
459 0 : if(status_client_ncurses_init(act)
460 0 : || status_client_ncurses(confs)) ret=CLIENT_ERROR;
461 : goto end;
462 : }
463 :
464 0 : if(!(cntr=cntr_alloc())
465 0 : || cntr_init(cntr, get_string(confs[OPT_CNAME]), getpid()))
466 : goto error;
467 0 : set_cntr(confs[OPT_CNTR], cntr);
468 :
469 0 : if(act!=ACTION_ESTIMATE)
470 : {
471 0 : if(ssl_setup(&rfd,
472 : &ssl, &ctx, action, confs, server, failover))
473 : goto could_not_connect;
474 :
475 0 : if(!(as=async_alloc())
476 0 : || as->init(as, act==ACTION_ESTIMATE)
477 0 : || !(asfd=setup_asfd_ssl(as, "main socket", &rfd, ssl)))
478 : goto end;
479 0 : asfd->set_timeout(asfd, get_int(confs[OPT_NETWORK_TIMEOUT]));
480 0 : asfd->ratelimit=get_float(confs[OPT_RATELIMIT]);
481 :
482 : // Set quality of service bits on backup packets.
483 0 : if(act==ACTION_BACKUP
484 0 : || act==ACTION_BACKUP_TIMED
485 0 : || act==ACTION_TIMER_CHECK)
486 0 : as->asfd->set_bulk_packets(as->asfd);
487 :
488 0 : if((ret=initial_comms(as, &act, &incexc, confs, failover)))
489 : goto end;
490 : }
491 :
492 0 : rfd=-1;
493 0 : switch(act)
494 : {
495 : case ACTION_BACKUP:
496 0 : ret=backup_wrapper(asfd, act, "backupphase1",
497 : incexc, confs);
498 0 : break;
499 : case ACTION_BACKUP_TIMED:
500 0 : ret=backup_wrapper(asfd, act, "backupphase1timed",
501 : incexc, confs);
502 0 : break;
503 : case ACTION_TIMER_CHECK:
504 0 : ret=backup_wrapper(asfd, act, "backupphase1timedcheck",
505 : incexc, confs);
506 0 : break;
507 : case ACTION_RESTORE:
508 : case ACTION_VERIFY:
509 0 : ret=restore_wrapper(asfd, act, confs);
510 0 : break;
511 : case ACTION_ESTIMATE:
512 0 : if(do_backup_client(asfd, confs, act, 0))
513 : goto error;
514 : break;
515 : case ACTION_DELETE:
516 0 : if(do_delete_client(asfd, confs))
517 : goto error;
518 : break;
519 : case ACTION_MONITOR:
520 0 : if(do_monitor_client(asfd))
521 : goto error;
522 : break;
523 : case ACTION_DIFF:
524 : case ACTION_DIFF_LONG:
525 : /*
526 : if(!strcmp(get_string(confs[OPT_BACKUP2]), "n"))
527 : // Do a phase1 scan and diff that.
528 : ret=backup_wrapper(asfd, act,
529 : "backupphase1diff", incexc, confs);
530 : else
531 : */
532 : // Diff two backups that already exist.
533 : // Fall through, the list code is all we need
534 : // for simple diffs on the client side.
535 : case ACTION_LIST:
536 : case ACTION_LIST_LONG:
537 : default:
538 0 : if(do_list_client(asfd, act, confs)) goto error;
539 : break;
540 : }
541 :
542 0 : if(asfd_flush_asio(asfd))
543 0 : ret=CLIENT_ERROR;
544 :
545 : goto end;
546 : error:
547 : ret=CLIENT_ERROR; goto end;
548 : could_not_connect:
549 : ret=CLIENT_COULD_NOT_CONNECT;
550 : end:
551 0 : close_fd(&rfd);
552 0 : async_free(&as);
553 0 : asfd_free(&asfd);
554 0 : if(ctx) ssl_destroy_ctx(ctx);
555 0 : free_w(&incexc);
556 0 : set_cntr(confs[OPT_CNTR], NULL);
557 0 : cntr_free(&cntr);
558 :
559 : //logp("end client\n");
560 0 : return ret;
561 : }
562 :
563 0 : int client(struct conf **confs,
564 : enum action action)
565 : {
566 0 : int finished=0;
567 0 : enum cliret ret=CLIENT_OK;
568 0 : const char *server=NULL;
569 0 : struct strlist *failover=NULL;
570 :
571 0 : if(!get_int(confs[OPT_ENABLED]))
572 : {
573 0 : logp("Client not enabled\n");
574 0 : return ret;
575 : }
576 :
577 : #ifdef HAVE_WIN32
578 : // prevent sleep when idle
579 : SetThreadExecutionState(ES_CONTINUOUS | ES_SYSTEM_REQUIRED);
580 : #endif
581 0 : server=get_string(confs[OPT_SERVER]);
582 0 : failover=get_strlist(confs[OPT_SERVER_FAILOVER]);
583 :
584 0 : while(!finished)
585 : {
586 0 : ret=do_client(confs,
587 : action, server, failover);
588 0 : if(ret==CLIENT_RECONNECT)
589 : {
590 0 : logp("Re-opening connection to %s\n", server);
591 0 : sleep(5);
592 0 : ret=do_client(confs,
593 : action, server, failover);
594 : }
595 0 : switch(ret)
596 : {
597 : case CLIENT_OK:
598 : case CLIENT_SERVER_TIMER_NOT_MET:
599 : case CLIENT_RESTORE_WARNINGS:
600 0 : finished=1;
601 0 : break;
602 : case CLIENT_ERROR:
603 0 : if(action!=ACTION_BACKUP
604 0 : && action!=ACTION_BACKUP_TIMED)
605 : {
606 : finished=1;
607 : break;
608 : }
609 0 : if(!get_int(
610 : confs[OPT_FAILOVER_ON_BACKUP_ERROR]))
611 : {
612 : finished=1;
613 : break;
614 : }
615 : // Fall through to failover.
616 : case CLIENT_COULD_NOT_CONNECT:
617 0 : if(!failover)
618 : {
619 : finished=1;
620 : break;
621 : }
622 0 : logp("Failing over\n");
623 : // Use a failover server.
624 0 : server=failover->path;
625 0 : failover=failover->next;
626 0 : break;
627 : case CLIENT_RECONNECT:
628 0 : logp("Multiple reconnect requests to %s- this should not happen!", server);
629 0 : finished=1;
630 0 : break;
631 : }
632 : }
633 :
634 : #ifdef HAVE_WIN32
635 : // allow sleep when idle
636 : SetThreadExecutionState(ES_CONTINUOUS);
637 : #endif
638 :
639 : // See enum cliret for return codes.
640 0 : return (int)ret;
641 : }
|
