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

          Line data    Source code
       1             : #include "../burp.h"
       2             : #include "../action.h"
       3             : #include "../asfd.h"
       4             : #include "../async.h"
       5             : #include "../cmd.h"
       6             : #include "../cntr.h"
       7             : #include "../fsops.h"
       8             : #include "../handy.h"
       9             : #include "../iobuf.h"
      10             : #include "../log.h"
      11             : #include "../run_script.h"
      12             : #include "auth.h"
      13             : #include "backup.h"
      14             : #include "ca.h"
      15             : #include "delete.h"
      16             : #include "diff.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           0 :                 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           0 :         memset(&tchk, 0, sizeof(tchk));
      98           0 :         if(asfd->write_str(asfd, CMD_GEN, phase1str))
      99           0 :                 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           0 :                         break;
     134             :                 case CLIENT_SERVER_TIMER_NOT_MET:
     135           0 :                         goto timer_not_met;
     136             :                 default:
     137           0 :                         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           0 :                         args, get_strlist(confs[OPT_B_SCRIPT_PRE_ARG]),
     156           0 :                         confs, 1, 1, 1))
     157           0 :                                  ret=CLIENT_ERROR;
     158             :         }
     159             : 
     160           0 :         if(ret==CLIENT_OK && do_backup_client(asfd,
     161           0 :                 confs, action, resume)) ret=CLIENT_ERROR;
     162             : 
     163           0 :         if((ret==CLIENT_OK || get_int(confs[OPT_B_SCRIPT_POST_RUN_ON_FAIL]))
     164           0 :           && b_script_post)
     165             :         {
     166           0 :                 int a=0;
     167             :                 const char *args[12];
     168           0 :                 if(get_int(confs[OPT_B_SCRIPT_RESERVED_ARGS]))
     169             :                 {
     170           0 :                         args[a++]=b_script_post;
     171           0 :                         args[a++]="post";
     172             :                         // Tell post script whether the restore failed.
     173           0 :                         args[a++]=ret?"1":"0";
     174           0 :                         args[a++]="reserved3";
     175           0 :                         args[a++]="reserved4";
     176           0 :                         args[a++]="reserved5";
     177             :                 }
     178           0 :                 args[a++]=NULL;
     179           0 :                 if(run_script(asfd,
     180           0 :                         args, get_strlist(confs[OPT_B_SCRIPT_POST_ARG]),
     181           0 :                         confs, 1, 1, 1))
     182           0 :                                 ret=CLIENT_ERROR;
     183             :         }
     184             : 
     185           0 :         if(ret==CLIENT_OK) logp("backup finished ok\n");
     186             : 
     187             : end:
     188           0 :         return ret;
     189             : error:
     190           0 :         logp("error in backup\n");
     191           0 :         return CLIENT_ERROR;
     192             : timer_not_met:
     193           0 :         return CLIENT_SERVER_TIMER_NOT_MET;
     194             : }
     195             : 
     196             : static int s_server_session_id_context=1;
     197             : 
     198           0 : static int ssl_setup(int *rfd, SSL **ssl, SSL_CTX **ctx,
     199             :         enum action action, struct conf **confs)
     200             : {
     201           0 :         BIO *sbio=NULL;
     202           0 :         ssl_load_globals();
     203           0 :         if(!(*ctx=ssl_initialise_ctx(confs)))
     204             :         {
     205           0 :                 logp("error initialising ssl ctx\n");
     206           0 :                 return -1;
     207             :         }
     208             : 
     209             :         SSL_CTX_set_session_id_context(*ctx,
     210             :                 (const uint8_t *)&s_server_session_id_context,
     211           0 :                 sizeof(s_server_session_id_context));
     212             : 
     213           0 :         if((*rfd=init_client_socket(get_string(confs[OPT_SERVER]),
     214             :           action==ACTION_MONITOR?
     215           0 :           get_string(confs[OPT_STATUS_PORT]):get_string(confs[OPT_PORT])))<0)
     216           0 :                 return -1;
     217             : 
     218           0 :         if(!(*ssl=SSL_new(*ctx))
     219           0 :           || !(sbio=BIO_new_socket(*rfd, BIO_NOCLOSE)))
     220             :         {
     221           0 :                 logp_ssl_err("Problem joining SSL to the socket\n");
     222           0 :                 return -1;
     223             :         }
     224           0 :         SSL_set_bio(*ssl, sbio, sbio);
     225           0 :         if(SSL_connect(*ssl)<=0)
     226             :         {
     227           0 :                 logp_ssl_err("SSL connect error\n");
     228           0 :                 return -1;
     229             :         }
     230           0 :         return 0;
     231             : }
     232             : 
     233           0 : static enum cliret initial_comms(struct async *as,
     234             :         enum action *action, char **incexc, struct conf **confs)
     235             : {
     236             :         struct asfd *asfd;
     237           0 :         char *server_version=NULL;
     238           0 :         enum cliret ret=CLIENT_OK;
     239           0 :         asfd=as->asfd;
     240             : 
     241           0 :         if(authorise_client(asfd, &server_version,
     242           0 :           get_string(confs[OPT_CNAME]),
     243           0 :           get_string(confs[OPT_PASSWORD]),
     244           0 :           get_cntr(confs)))
     245           0 :                 goto error;
     246             : 
     247           0 :         if(server_version)
     248             :         {
     249           0 :                 logp("Server version: %s\n", server_version);
     250             :                 // Servers before 1.3.2 did not tell us their versions.
     251             :                 // 1.3.2 and above can do the automatic CA stuff that
     252             :                 // follows.
     253           0 :                 switch(ca_client_setup(asfd, confs))
     254             :                 {
     255             :                         case 0:
     256           0 :                                 break; // All OK.
     257             :                         case 1:
     258             :                                 // Certificate signed successfully.
     259             :                                 // Everything is OK, but we will reconnect now,
     260             :                                 // in order to use the new keys/certificates.
     261           0 :                                 goto reconnect;
     262             :                         default:
     263           0 :                                 logp("Error with cert signing request\n");
     264           0 :                                 goto error;
     265             :                 }
     266             :         }
     267             : 
     268           0 :         set_non_blocking(asfd->fd);
     269             : 
     270           0 :         if(ssl_check_cert(asfd->ssl, NULL, confs))
     271             :         {
     272           0 :                 logp("check cert failed\n");
     273           0 :                 goto error;
     274             :         }
     275             : 
     276           0 :         if(extra_comms(as, confs, action, incexc))
     277             :         {
     278           0 :                 logp("extra comms failed\n");
     279           0 :                 goto error;
     280             :         }
     281             : 
     282           0 :         ret=CLIENT_OK; goto end;
     283             : error:
     284           0 :         ret=CLIENT_ERROR; goto end;
     285             : reconnect:
     286           0 :         ret=CLIENT_RECONNECT; goto end;
     287             : end:
     288           0 :         if(server_version) free(server_version);
     289           0 :         return ret;
     290             : }
     291             : 
     292           0 : static enum cliret restore_wrapper(struct asfd *asfd, enum action action,
     293             :         int vss_restore, struct conf **confs)
     294             : {
     295           0 :         enum cliret ret=CLIENT_OK;
     296           0 :         const char *r_script_pre=get_string(confs[OPT_R_SCRIPT_PRE]);
     297           0 :         const char *r_script_post=get_string(confs[OPT_R_SCRIPT_POST]);
     298             : 
     299           0 :         if(r_script_pre)
     300             :         {
     301           0 :                 int a=0;
     302             :                 const char *args[12];
     303           0 :                 args[a++]=r_script_pre;
     304           0 :                 if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
     305             :                 {
     306           0 :                         args[a++]="pre";
     307           0 :                         args[a++]="reserved2";
     308           0 :                         args[a++]="reserved3";
     309           0 :                         args[a++]="reserved4";
     310           0 :                         args[a++]="reserved5";
     311             :                 }
     312           0 :                 args[a++]=NULL;
     313           0 :                 if(run_script(asfd,
     314           0 :                         args, get_strlist(confs[OPT_R_SCRIPT_PRE_ARG]),
     315           0 :                         confs, 1, 1, 1))
     316           0 :                                 ret=CLIENT_ERROR;
     317             :         }
     318           0 :         if(ret==CLIENT_OK)
     319             :         {
     320           0 :                 if(do_restore_client(asfd, confs,
     321           0 :                         action, vss_restore)) ret=CLIENT_ERROR;
     322             :         }
     323           0 :         if((ret==CLIENT_OK || get_int(confs[OPT_R_SCRIPT_POST_RUN_ON_FAIL]))
     324           0 :           && r_script_post)
     325             :         {
     326           0 :                 int a=0;
     327             :                 const char *args[12];
     328           0 :                 args[a++]=r_script_pre;
     329           0 :                 if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
     330             :                 {
     331           0 :                         args[a++]="post";
     332             :                         // Tell post script whether the restore failed.
     333           0 :                         args[a++]=ret?"1":"0";
     334           0 :                         args[a++]="reserved3";
     335           0 :                         args[a++]="reserved4";
     336           0 :                         args[a++]="reserved5";
     337             :                 }
     338           0 :                 args[a++]=NULL;
     339           0 :                 if(run_script(asfd,
     340           0 :                         args, get_strlist(confs[OPT_R_SCRIPT_POST_ARG]),
     341           0 :                         confs, 1, 1, 1))
     342           0 :                                 ret=CLIENT_ERROR;
     343             :         }
     344             : 
     345             :         // Return non-zero if there were warnings,
     346             :         // so that the test script can easily check.
     347           0 :         if(ret==CLIENT_OK && get_cntr(confs)->ent[CMD_WARNING]->count)
     348           0 :                 ret=CLIENT_RESTORE_WARNINGS;
     349             : 
     350           0 :         return ret;
     351             : }
     352             : 
     353           0 : static enum cliret do_client(struct conf **confs,
     354             :         enum action action, int vss_restore, int json)
     355             : {
     356           0 :         enum cliret ret=CLIENT_OK;
     357           0 :         int rfd=-1;
     358           0 :         SSL *ssl=NULL;
     359           0 :         SSL_CTX *ctx=NULL;
     360           0 :         struct cntr *cntr=NULL;
     361           0 :         char *incexc=NULL;
     362           0 :         enum action act=action;
     363           0 :         struct async *as=NULL;
     364           0 :         struct asfd *asfd=NULL;
     365             : 
     366             : //      as->settimers(0, 100);
     367             : 
     368             : //      logp("begin client\n");
     369             : //      logp("action %d\n", action);
     370             : 
     371             :         // Status monitor forks a child process instead of connecting to
     372             :         // the server directly.
     373           0 :         if(action==ACTION_STATUS
     374           0 :           || action==ACTION_STATUS_SNAPSHOT)
     375             :         {
     376             : #ifdef HAVE_WIN32
     377             :                 logp("Status mode not implemented on Windows.\n");
     378             :                 goto error;
     379             : #endif
     380           0 :                 if(status_client_ncurses(act, confs)) ret=CLIENT_ERROR;
     381           0 :                 goto end;
     382             :         }
     383             : 
     384           0 :         if(!(cntr=cntr_alloc())
     385           0 :           || cntr_init(cntr, get_string(confs[OPT_CNAME]))) goto error;
     386           0 :         set_cntr(confs[OPT_CNTR], cntr);
     387             : 
     388           0 :         if(act!=ACTION_ESTIMATE
     389           0 :           && ssl_setup(&rfd, &ssl, &ctx, action, confs))
     390           0 :                 goto could_not_connect;
     391             : 
     392           0 :         if(!(as=async_alloc())
     393           0 :           || !(asfd=asfd_alloc())
     394           0 :           || as->init(as, act==ACTION_ESTIMATE)
     395           0 :           || asfd->init(asfd, "main socket", as, rfd, ssl,
     396           0 :                 ASFD_STREAM_STANDARD, confs))
     397           0 :                         goto end;
     398           0 :         as->asfd_add(as, asfd);
     399             : 
     400             :         // Set quality of service bits on backup packets.
     401           0 :         if(act==ACTION_BACKUP
     402           0 :           || act==ACTION_BACKUP_TIMED
     403           0 :           || act==ACTION_TIMER_CHECK)
     404           0 :                 as->asfd->set_bulk_packets(as->asfd);
     405             : 
     406           0 :         if(act!=ACTION_ESTIMATE)
     407             :         {
     408           0 :                 if((ret=initial_comms(as, &act, &incexc, confs)))
     409           0 :                         goto end;
     410             :         }
     411             : 
     412           0 :         rfd=-1;
     413           0 :         switch(act)
     414             :         {
     415             :                 case ACTION_BACKUP:
     416             :                         ret=backup_wrapper(asfd, act, "backupphase1",
     417           0 :                           incexc, confs);
     418           0 :                         break;
     419             :                 case ACTION_BACKUP_TIMED:
     420             :                         ret=backup_wrapper(asfd, act, "backupphase1timed",
     421           0 :                           incexc, confs);
     422           0 :                         break;
     423             :                 case ACTION_TIMER_CHECK:
     424             :                         ret=backup_wrapper(asfd, act, "backupphase1timedcheck",
     425           0 :                           incexc, confs);
     426           0 :                         break;
     427             :                 case ACTION_RESTORE:
     428             :                 case ACTION_VERIFY:
     429           0 :                         ret=restore_wrapper(asfd, act, vss_restore, confs);
     430           0 :                         break;
     431             :                 case ACTION_ESTIMATE:
     432           0 :                         if(do_backup_client(asfd, confs, act, 0))
     433           0 :                                 goto error;
     434           0 :                         break;
     435             :                 case ACTION_DELETE:
     436           0 :                         if(do_delete_client(asfd, confs)) goto error;
     437           0 :                         break;
     438             :                 case ACTION_DIFF:
     439             :                 case ACTION_DIFF_LONG:
     440           0 :                         if(!strcmp(get_string(confs[OPT_BACKUP2]), "n"))
     441             :                                 // Do a phase1 scan and diff that.
     442             :                                 ret=backup_wrapper(asfd, act,
     443           0 :                                         "backupphase1diff", incexc, confs);
     444             :                         else
     445             :                                 // Diff two backups that already exist.
     446           0 :                                 if(do_diff_client(asfd, act, json, confs))
     447           0 :                                         goto error;
     448           0 :                         break;
     449             :                 case ACTION_MONITOR:
     450           0 :                         if(do_monitor_client(asfd, confs)) goto error;
     451           0 :                         break;
     452             :                 case ACTION_LIST:
     453             :                 case ACTION_LIST_LONG:
     454             :                 default:
     455           0 :                         if(do_list_client(asfd, act, json, confs)) goto error;
     456           0 :                         break;
     457             :         }
     458             : 
     459           0 :         goto end;
     460             : error:
     461           0 :         ret=CLIENT_ERROR; goto end;
     462             : could_not_connect:
     463           0 :         ret=CLIENT_COULD_NOT_CONNECT;
     464             : end:
     465           0 :         close_fd(&rfd);
     466           0 :         async_free(&as);
     467           0 :         asfd_free(&asfd);
     468           0 :         if(ctx) ssl_destroy_ctx(ctx);
     469           0 :         if(incexc) free(incexc);
     470           0 :         set_cntr(confs[OPT_CNTR], NULL);
     471           0 :         if(cntr) cntr_free(&cntr);
     472             : 
     473             :         //logp("end client\n");
     474           0 :         return ret;
     475             : }
     476             : 
     477           0 : int client(struct conf **confs, enum action action, int vss_restore, int json)
     478             : {
     479           0 :         enum cliret ret=CLIENT_OK;
     480             :         
     481             : #ifdef HAVE_WIN32
     482             :         // prevent sleep when idle
     483             :         SetThreadExecutionState(ES_CONTINUOUS | ES_SYSTEM_REQUIRED);
     484             : #endif
     485             :         
     486           0 :         switch((ret=do_client(confs, action, vss_restore, json)))
     487             :         {
     488             :                 case CLIENT_RECONNECT:
     489           0 :                         logp("Re-opening connection to server\n");
     490           0 :                         sleep(5);
     491           0 :                         ret=do_client(confs, action, vss_restore, json);
     492             :                 default:
     493           0 :                         break;
     494             :         }
     495             :         
     496             : #ifdef HAVE_WIN32
     497             :         // allow sleep when idle
     498             :         SetThreadExecutionState(ES_CONTINUOUS);
     499             : #endif
     500             : 
     501             :         // See enum cliret for return codes.
     502           0 :         return (int)ret;
     503             : }

Generated by: LCOV version 1.10