LCOV - code coverage report
Current view: top level - src/client - main.c (source / functions) Hit Total Coverage
Test: burp-coverage-clean.info Lines: 0 217 0.0 %
Date: 2016-07-02 Functions: 0 8 0.0 %

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

Generated by: LCOV version 1.10