LCOV - code coverage report
Current view: top level - src/client - main.c (source / functions) Hit Total Coverage
Test: burp-coverage-clean.info Lines: 0 231 0.0 %
Date: 2018-05-06 01:36:20 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             : #include "main.h"
      24             : 
      25             : #ifndef HAVE_WIN32
      26             : #include <sys/utsname.h>
      27             : #endif
      28             : 
      29             : // These will also be used as the exit codes of the program and are therefore
      30             : // unsigned integers.
      31             : // Remember to update the man page if you update these.
      32             : enum cliret
      33             : {
      34             :         CLIENT_OK=0,
      35             :         CLIENT_ERROR=1,
      36             :         CLIENT_RESTORE_WARNINGS=2,
      37             :         CLIENT_SERVER_TIMER_NOT_MET=3,
      38             :         CLIENT_COULD_NOT_CONNECT=4,
      39             :         // This one happens after a successful certificate signing request so
      40             :         // that it connects again straight away with the new key/certificate.
      41             :         CLIENT_RECONNECT=100
      42             : };
      43             : 
      44             : struct tchk
      45             : {
      46             :         int resume;
      47             :         enum cliret ret;
      48             : };
      49             : 
      50           0 : static enum asl_ret maybe_check_timer_func(struct asfd *asfd,
      51             :         struct conf **confs, void *param)
      52             : {
      53           0 :         int complen=0;
      54           0 :         struct tchk *tchk=(struct tchk *)param;
      55             : 
      56           0 :         if(!strcmp(asfd->rbuf->buf, "timer conditions not met"))
      57             :         {
      58           0 :                 logp("Timer conditions on the server were not met\n");
      59           0 :                 tchk->ret=CLIENT_SERVER_TIMER_NOT_MET;
      60           0 :                 return ASL_END_OK;
      61             :         }
      62           0 :         else if(!strcmp(asfd->rbuf->buf, "timer conditions met"))
      63             :         {
      64             :                 // Only happens on 'timer check only'.
      65           0 :                 logp("Timer conditions on the server were met\n");
      66           0 :                 tchk->ret=CLIENT_OK;
      67           0 :                 return ASL_END_OK;
      68             :         }
      69             : 
      70           0 :         if(!strncmp_w(asfd->rbuf->buf, "ok"))
      71             :                 complen=3;
      72           0 :         else if(!strncmp_w(asfd->rbuf->buf, "resume"))
      73             :         {
      74           0 :                 complen=7;
      75           0 :                 tchk->resume=1;
      76           0 :                 logp("server wants to resume previous backup.\n");
      77             :         }
      78             :         else
      79             :         {
      80           0 :                 iobuf_log_unexpected(asfd->rbuf, __func__);
      81           0 :                 return ASL_END_ERROR;
      82             :         }
      83             : 
      84             :         // The server now tells us the compression level in the OK response.
      85           0 :         if(strlen(asfd->rbuf->buf)>3)
      86           0 :                 set_int(confs[OPT_COMPRESSION], atoi(asfd->rbuf->buf+complen));
      87           0 :         logp("Compression level: %d\n",
      88             :                 get_int(confs[OPT_COMPRESSION]));
      89             : 
      90           0 :         return ASL_END_OK;
      91             : }
      92             : 
      93           0 : static enum cliret maybe_check_timer(struct asfd *asfd,
      94             :         const char *phase1str, 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             :                 return CLIENT_ERROR;
     100             : 
     101           0 :         if(asfd->simple_loop(asfd, confs, &tchk,
     102             :                 __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, 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             :                         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 :                 args[a++]=b_script_post;
     175           0 :                 if(get_int(confs[OPT_B_SCRIPT_RESERVED_ARGS]))
     176             :                 {
     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             :                         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             :         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 :         int port=-1;
     208           0 :         char portstr[8]="";
     209           0 :         BIO *sbio=NULL;
     210           0 :         ssl_load_globals();
     211           0 :         if(!(*ctx=ssl_initialise_ctx(confs)))
     212             :         {
     213           0 :                 logp("error initialising ssl ctx\n");
     214           0 :                 return -1;
     215             :         }
     216             : 
     217           0 :         SSL_CTX_set_session_id_context(*ctx,
     218             :                 (const uint8_t *)&s_server_session_id_context,
     219             :                 sizeof(s_server_session_id_context));
     220             : 
     221           0 :         switch(action)
     222             :         {
     223             :                 case ACTION_BACKUP:
     224             :                 case ACTION_BACKUP_TIMED:
     225             :                 case ACTION_TIMER_CHECK:
     226           0 :                         port=get_int(confs[OPT_PORT_BACKUP]);
     227           0 :                         break;
     228             :                 case ACTION_RESTORE:
     229           0 :                         port=get_int(confs[OPT_PORT_RESTORE]);
     230           0 :                         break;
     231             :                 case ACTION_VERIFY:
     232           0 :                         port=get_int(confs[OPT_PORT_VERIFY]);
     233           0 :                         break;
     234             :                 case ACTION_LIST:
     235             :                 case ACTION_LIST_LONG:
     236             :                 case ACTION_DIFF:
     237             :                 case ACTION_DIFF_LONG:
     238           0 :                         port=get_int(confs[OPT_PORT_LIST]);
     239           0 :                         break;
     240             :                 case ACTION_DELETE:
     241           0 :                         port=get_int(confs[OPT_PORT_DELETE]);
     242           0 :                         break;
     243             :                 case ACTION_MONITOR:
     244             :                 {
     245             :                         struct strlist *s;
     246           0 :                         if(!(s=get_strlist(confs[OPT_STATUS_PORT])))
     247             :                         {
     248           0 :                                 logp("%s not set\n",
     249           0 :                                         confs[OPT_STATUS_PORT]->field);
     250           0 :                                 return -1;
     251             :                         }
     252           0 :                         port=atoi(s->path);
     253           0 :                         break;
     254             :                 }
     255             :                 case ACTION_CHAMP_CHOOSER:
     256             :                 case ACTION_ESTIMATE:
     257             :                 case ACTION_STATUS:
     258             :                 case ACTION_STATUS_SNAPSHOT:
     259           0 :                         logp("Unexpected action in %s: %d\n",
     260             :                                 __func__, action);
     261           0 :                         return -1;
     262             :         }
     263             : 
     264           0 :         snprintf(portstr, sizeof(portstr), "%d", port);
     265           0 :         if((*rfd=init_client_socket(get_string(confs[OPT_SERVER]), portstr))<0)
     266             :                 return -1;
     267             : 
     268           0 :         if(!(*ssl=SSL_new(*ctx))
     269           0 :           || !(sbio=BIO_new_socket(*rfd, BIO_NOCLOSE)))
     270             :         {
     271           0 :                 logp_ssl_err("Problem joining SSL to the socket\n");
     272           0 :                 return -1;
     273             :         }
     274           0 :         SSL_set_bio(*ssl, sbio, sbio);
     275           0 :         if(SSL_connect(*ssl)<=0)
     276             :         {
     277           0 :                 logp_ssl_err("SSL connect error\n");
     278           0 :                 return -1;
     279             :         }
     280             :         return 0;
     281             : }
     282             : 
     283           0 : static enum cliret initial_comms(struct async *as,
     284             :         enum action *action, char **incexc, struct conf **confs)
     285             : {
     286             :         struct asfd *asfd;
     287           0 :         char *server_version=NULL;
     288           0 :         enum cliret ret=CLIENT_OK;
     289           0 :         asfd=as->asfd;
     290             : 
     291           0 :         if(authorise_client(asfd, &server_version,
     292           0 :           get_string(confs[OPT_CNAME]),
     293           0 :           get_string(confs[OPT_PASSWORD]),
     294             :           get_cntr(confs)))
     295             :                 goto error;
     296             : 
     297           0 :         if(server_version)
     298             :         {
     299           0 :                 logp("Server version: %s\n", server_version);
     300             :                 // Servers before 1.3.2 did not tell us their versions.
     301             :                 // 1.3.2 and above can do the automatic CA stuff that
     302             :                 // follows.
     303           0 :                 switch(ca_client_setup(asfd, confs))
     304             :                 {
     305             :                         case 0:
     306             :                                 break; // All OK.
     307             :                         case 1:
     308             :                                 // Certificate signed successfully.
     309             :                                 // Everything is OK, but we will reconnect now,
     310             :                                 // in order to use the new keys/certificates.
     311             :                                 goto reconnect;
     312             :                         default:
     313           0 :                                 logp("Error with cert signing request\n");
     314           0 :                                 goto error;
     315             :                 }
     316             :         }
     317             : 
     318           0 :         if(ssl_check_cert(asfd->ssl, NULL, confs))
     319             :         {
     320           0 :                 logp("check cert failed\n");
     321           0 :                 goto error;
     322             :         }
     323             : 
     324           0 :         if(extra_comms_client(as, confs, action, incexc))
     325             :         {
     326           0 :                 logp("extra comms failed\n");
     327           0 :                 goto error;
     328             :         }
     329             : 
     330             :         ret=CLIENT_OK; goto end;
     331             : error:
     332             :         ret=CLIENT_ERROR; goto end;
     333             : reconnect:
     334             :         ret=CLIENT_RECONNECT; goto end;
     335             : end:
     336           0 :         free_w(&server_version);
     337           0 :         return ret;
     338             : }
     339             : 
     340           0 : static enum cliret restore_wrapper(struct asfd *asfd, enum action action,
     341             :         int vss_restore, struct conf **confs)
     342             : {
     343           0 :         enum cliret ret=CLIENT_OK;
     344           0 :         const char *r_script_pre=get_string(confs[OPT_R_SCRIPT_PRE]);
     345           0 :         const char *r_script_post=get_string(confs[OPT_R_SCRIPT_POST]);
     346             : 
     347           0 :         if(r_script_pre)
     348             :         {
     349           0 :                 int a=0;
     350             :                 const char *args[12];
     351           0 :                 args[a++]=r_script_pre;
     352           0 :                 if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
     353             :                 {
     354           0 :                         args[a++]="pre";
     355           0 :                         args[a++]="reserved2";
     356           0 :                         args[a++]="reserved3";
     357           0 :                         args[a++]="reserved4";
     358           0 :                         args[a++]="reserved5";
     359             :                 }
     360           0 :                 args[a++]=NULL;
     361           0 :                 if(run_script(asfd,
     362             :                         args, get_strlist(confs[OPT_R_SCRIPT_PRE_ARG]),
     363             :                         confs, 1, 1, 1))
     364           0 :                                 ret=CLIENT_ERROR;
     365             :         }
     366           0 :         if(ret==CLIENT_OK)
     367             :         {
     368           0 :                 if(do_restore_client(asfd, confs,
     369           0 :                         action, vss_restore)) ret=CLIENT_ERROR;
     370             :         }
     371           0 :         if((ret==CLIENT_OK || get_int(confs[OPT_R_SCRIPT_POST_RUN_ON_FAIL]))
     372           0 :           && r_script_post)
     373             :         {
     374           0 :                 int a=0;
     375             :                 const char *args[12];
     376           0 :                 args[a++]=r_script_post;
     377           0 :                 if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
     378             :                 {
     379           0 :                         args[a++]="post";
     380             :                         // Tell post script whether the restore failed.
     381           0 :                         args[a++]=ret?"1":"0";
     382           0 :                         args[a++]="reserved3";
     383           0 :                         args[a++]="reserved4";
     384           0 :                         args[a++]="reserved5";
     385             :                 }
     386           0 :                 args[a++]=NULL;
     387           0 :                 if(run_script(asfd,
     388             :                         args, get_strlist(confs[OPT_R_SCRIPT_POST_ARG]),
     389             :                         confs, 1, 1, 1))
     390           0 :                                 ret=CLIENT_ERROR;
     391             :         }
     392             : 
     393             :         // Return non-zero if there were warnings,
     394             :         // so that the test script can easily check.
     395           0 :         if(ret==CLIENT_OK && get_cntr(confs)->ent[CMD_WARNING]->count)
     396           0 :                 ret=CLIENT_RESTORE_WARNINGS;
     397             : 
     398           0 :         return ret;
     399             : }
     400             : 
     401           0 : static enum cliret do_client(struct conf **confs,
     402             :         enum action action, int vss_restore)
     403             : {
     404           0 :         enum cliret ret=CLIENT_OK;
     405           0 :         int rfd=-1;
     406           0 :         SSL *ssl=NULL;
     407           0 :         SSL_CTX *ctx=NULL;
     408           0 :         struct cntr *cntr=NULL;
     409           0 :         char *incexc=NULL;
     410           0 :         enum action act=action;
     411           0 :         struct async *as=NULL;
     412           0 :         struct asfd *asfd=NULL;
     413             : 
     414             : //      as->settimers(0, 100);
     415             : 
     416             : //      logp("begin client\n");
     417             : //      logp("action %d\n", action);
     418             : 
     419             :         // Status monitor forks a child process instead of connecting to
     420             :         // the server directly.
     421           0 :         if(action==ACTION_STATUS
     422           0 :           || action==ACTION_STATUS_SNAPSHOT)
     423             :         {
     424             : #ifdef HAVE_WIN32
     425             :                 logp("Status mode not implemented on Windows.\n");
     426             :                 goto error;
     427             : #endif
     428           0 :                 if(status_client_ncurses_init(act)
     429           0 :                   || status_client_ncurses(confs)) ret=CLIENT_ERROR;
     430             :                 goto end;
     431             :         }
     432             : 
     433           0 :         if(!(cntr=cntr_alloc())
     434           0 :           || cntr_init(cntr, get_string(confs[OPT_CNAME]), getpid()))
     435             :                 goto error;
     436           0 :         set_cntr(confs[OPT_CNTR], cntr);
     437             : 
     438           0 :         if(act!=ACTION_ESTIMATE)
     439             :         {
     440           0 :                 if(ssl_setup(&rfd, &ssl, &ctx, action, confs))
     441             :                         goto could_not_connect;
     442             : 
     443           0 :                 if(!(as=async_alloc())
     444           0 :                   || as->init(as, act==ACTION_ESTIMATE)
     445           0 :                   || !(asfd=setup_asfd_ssl(as, "main socket", &rfd, ssl)))
     446             :                         goto end;
     447           0 :                 asfd->set_timeout(asfd, get_int(confs[OPT_NETWORK_TIMEOUT]));
     448           0 :                 asfd->ratelimit=get_float(confs[OPT_RATELIMIT]);
     449             : 
     450             :                 // Set quality of service bits on backup packets.
     451           0 :                 if(act==ACTION_BACKUP
     452           0 :                                 || act==ACTION_BACKUP_TIMED
     453           0 :                                 || act==ACTION_TIMER_CHECK)
     454           0 :                         as->asfd->set_bulk_packets(as->asfd);
     455             : 
     456           0 :                 if((ret=initial_comms(as, &act, &incexc, confs)))
     457             :                         goto end;
     458             :         }
     459             : 
     460           0 :         rfd=-1;
     461           0 :         switch(act)
     462             :         {
     463             :                 case ACTION_BACKUP:
     464           0 :                         ret=backup_wrapper(asfd, act, "backupphase1",
     465             :                           incexc, confs);
     466           0 :                         break;
     467             :                 case ACTION_BACKUP_TIMED:
     468           0 :                         ret=backup_wrapper(asfd, act, "backupphase1timed",
     469             :                           incexc, confs);
     470           0 :                         break;
     471             :                 case ACTION_TIMER_CHECK:
     472           0 :                         ret=backup_wrapper(asfd, act, "backupphase1timedcheck",
     473             :                           incexc, confs);
     474           0 :                         break;
     475             :                 case ACTION_RESTORE:
     476             :                 case ACTION_VERIFY:
     477           0 :                         ret=restore_wrapper(asfd, act, vss_restore, confs);
     478           0 :                         break;
     479             :                 case ACTION_ESTIMATE:
     480           0 :                         if(do_backup_client(asfd, confs, act, 0))
     481             :                                 goto error;
     482             :                         break;
     483             :                 case ACTION_DELETE:
     484           0 :                         if(do_delete_client(asfd, confs))
     485             :                                 goto error;
     486             :                         break;
     487             :                 case ACTION_MONITOR:
     488           0 :                         if(do_monitor_client(asfd))
     489             :                                 goto error;
     490             :                         break;
     491             :                 case ACTION_DIFF:
     492             :                 case ACTION_DIFF_LONG:
     493             : /*
     494             :                         if(!strcmp(get_string(confs[OPT_BACKUP2]), "n"))
     495             :                                 // Do a phase1 scan and diff that.
     496             :                                 ret=backup_wrapper(asfd, act,
     497             :                                         "backupphase1diff", incexc, confs);
     498             :                         else
     499             : */
     500             :                         // Diff two backups that already exist.
     501             :                         // Fall through, the list code is all we need
     502             :                         // for simple diffs on the client side.
     503             :                 case ACTION_LIST:
     504             :                 case ACTION_LIST_LONG:
     505             :                 default:
     506           0 :                         if(do_list_client(asfd, act, confs)) goto error;
     507             :                         break;
     508             :         }
     509             : 
     510           0 :         if(asfd_flush_asio(asfd))
     511           0 :                 ret=CLIENT_ERROR;
     512             : 
     513             :         goto end;
     514             : error:
     515             :         ret=CLIENT_ERROR; goto end;
     516             : could_not_connect:
     517             :         ret=CLIENT_COULD_NOT_CONNECT;
     518             : end:
     519           0 :         close_fd(&rfd);
     520           0 :         async_free(&as);
     521           0 :         asfd_free(&asfd);
     522           0 :         if(ctx) ssl_destroy_ctx(ctx);
     523           0 :         free_w(&incexc);
     524           0 :         set_cntr(confs[OPT_CNTR], NULL);
     525           0 :         cntr_free(&cntr);
     526             : 
     527             :         //logp("end client\n");
     528           0 :         return ret;
     529             : }
     530             : 
     531           0 : int client(struct conf **confs, enum action action, int vss_restore)
     532             : {
     533           0 :         enum cliret ret=CLIENT_OK;
     534             : 
     535           0 :         if(!get_int(confs[OPT_ENABLED]))
     536             :         {
     537           0 :                 logp("Client not enabled\n");
     538           0 :                 return ret;
     539             :         }
     540             : 
     541             : #ifdef HAVE_WIN32
     542             :         // prevent sleep when idle
     543             :         SetThreadExecutionState(ES_CONTINUOUS | ES_SYSTEM_REQUIRED);
     544             : #endif
     545             : 
     546           0 :         switch((ret=do_client(confs, action, vss_restore)))
     547             :         {
     548             :                 case CLIENT_RECONNECT:
     549           0 :                         logp("Re-opening connection to server\n");
     550           0 :                         sleep(5);
     551           0 :                         ret=do_client(confs, action, vss_restore);
     552             :                 default:
     553             :                         break;
     554             :         }
     555             : 
     556             : #ifdef HAVE_WIN32
     557             :         // allow sleep when idle
     558             :         SetThreadExecutionState(ES_CONTINUOUS);
     559             : #endif
     560             : 
     561             :         // See enum cliret for return codes.
     562           0 :         return (int)ret;
     563             : }

Generated by: LCOV version 1.13