static enum cliret restore_wrapper(struct asfd *asfd, enum action action,
int vss_restore, struct conf **confs)
{
enum cliret ret=CLIENT_OK;
const char *r_script_pre=get_string(confs[OPT_R_SCRIPT_PRE]);
const char *r_script_post=get_string(confs[OPT_R_SCRIPT_POST]);
if(r_script_pre)
{
int a=0;
const char *args[12];
args[a++]=r_script_pre;
if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
{
args[a++]="pre";
args[a++]="reserved2";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
}
args[a++]=NULL;
if(run_script(asfd,
args, get_strlist(confs[OPT_R_SCRIPT_PRE_ARG]),
confs, 1, 1, 1))
ret=CLIENT_ERROR;
}
if(ret==CLIENT_OK)
{
if(do_restore_client(asfd, confs,
action, vss_restore)) ret=CLIENT_ERROR;
}
if((ret==CLIENT_OK || get_int(confs[OPT_R_SCRIPT_POST_RUN_ON_FAIL]))
&& r_script_post)
{
int a=0;
const char *args[12];
args[a++]=r_script_pre;
if(get_int(confs[OPT_R_SCRIPT_RESERVED_ARGS]))
{
args[a++]="post";
// Tell post script whether the restore failed.
args[a++]=ret?"1":"0";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
}
args[a++]=NULL;
if(run_script(asfd,
args, get_strlist(confs[OPT_R_SCRIPT_POST_ARG]),
confs, 1, 1, 1))
ret=CLIENT_ERROR;
}
// Return non-zero if there were warnings,
// so that the test script can easily check.
if(ret==CLIENT_OK && get_cntr(confs)->ent[CMD_WARNING]->count)
ret=CLIENT_RESTORE_WARNINGS;
return ret;
}
static void run_test(int expected_ret,
int slist_entries,
enum protocol protocol,
void setup_callback(struct asfd *asfd, struct slist *slist))
{
int result;
struct slist *slist=NULL;
const char *conffile=BASE "/burp.conf";
struct asfd *asfd;
struct conf **confs;
const char *buf;
if(protocol==PROTO_1)
buf=MIN_CLIENT_CONF "protocol=1\n";
else
buf=MIN_CLIENT_CONF "protocol=2\n";
base64_init();
asfd=asfd_mock_setup(&reads, &writes);
confs=setup_conf();
fail_unless(recursive_delete(BASE)==0);
build_file(conffile, buf);
fail_unless(!conf_load_global_only(conffile, confs));
if(slist_entries)
slist=build_slist_phase1(BASE, protocol, slist_entries);
setup_callback(asfd, slist);
result=do_restore_client(asfd, confs,
ACTION_RESTORE, 0 /* vss_restore */);
fail_unless(result==expected_ret);
slist_free(&slist);
tear_down(&asfd, &confs);
}
/* May return 1 to mean try again. This happens after a successful certificate
signing request so that it connects again straight away with the new
key/certificate.
Returns 2 if there were restore/verify warnings.
Returns 3 if timer conditions were not met.
*/
static int do_client(struct config *conf, enum action act, int vss_restore, int json)
{
int ret=0;
int rfd=-1;
int resume=0;
SSL *ssl=NULL;
BIO *sbio=NULL;
char buf[256]="";
SSL_CTX *ctx=NULL;
struct cntr cntr;
struct cntr p1cntr;
char *incexc=NULL;
char *server_version=NULL;
const char *phase1str="backupphase1";
reset_filecounter(&p1cntr, time(NULL));
reset_filecounter(&cntr, time(NULL));
setup_signals_client();
// settimers(0, 100);
logp("begin client\n");
if(act!=ACTION_ESTIMATE)
{
ssl_load_globals();
if(!(ctx=ssl_initialise_ctx(conf)))
{
logp("error initialising ssl ctx\n");
ret=-1;
goto end;
}
SSL_CTX_set_session_id_context(ctx,
(const unsigned char *)&s_server_session_id_context,
sizeof(s_server_session_id_context));
if((rfd=init_client_socket(conf->server, conf->port))<0)
{
ret=-1;
goto end;
}
if(!(ssl=SSL_new(ctx))
|| !(sbio=BIO_new_socket(rfd, BIO_NOCLOSE)))
{
ERR_error_string_n(ERR_get_error(), buf, sizeof(buf));
logp("Problem joining SSL to the socket: %s\n", buf);
ret=-1;
goto end;
}
SSL_set_bio(ssl, sbio, sbio);
if(SSL_connect(ssl)<=0)
{
ERR_error_string_n(ERR_get_error(), buf, sizeof(buf));
logp("SSL connect error: %s\n", buf);
ret=-1;
goto end;
}
}
if((ret=async_init(rfd, ssl, conf, act==ACTION_ESTIMATE)))
goto end;
// Set quality of service bits on backup packets.
if(act==ACTION_BACKUP || act==ACTION_BACKUP_TIMED)
set_bulk_packets();
if(act!=ACTION_ESTIMATE)
{
char cmd=0;
size_t len=0;
char *feat=NULL;
int ca_ret=0;
if((ret=authorise_client(conf, &server_version, &p1cntr)))
goto end;
if(server_version)
{
logp("Server version: %s\n", server_version);
// Servers before 1.3.2 did not tell us their versions.
// 1.3.2 and above can do the automatic CA stuff that
// follows.
if((ca_ret=ca_client_setup(conf, &p1cntr))<0)
{
// Error
logp("Error with certificate signing request\n");
ret=-1;
goto end;
}
else if(ca_ret>0)
{
// Certificate signed successfully.
// Everything is OK, but we will reconnect now, in
// order to use the new keys/certificates.
ret=1;
goto end;
}
}
set_non_blocking(rfd);
if((ret=ssl_check_cert(ssl, conf)))
{
logp("check cert failed\n");
goto end;
}
if((ret=async_write_str(CMD_GEN, "extra_comms_begin")))
{
logp("Problem requesting extra_comms_begin\n");
goto end;
}
// Servers greater than 1.3.0 will list the extra_comms
// features they support.
else if((ret=async_read(&cmd, &feat, &len)))
{
logp("Problem reading response to extra_comms_begin\n");
goto end;
}
else if(cmd!=CMD_GEN)
{
logp("Unexpected command from server when reading response to extra_comms_begin: %c:%s\n", cmd, feat);
ret=-1;
goto end;
}
else if(strncmp(feat,
"extra_comms_begin ok", strlen("extra_comms_begin ok")))
{
logp("Unexpected response from server when reading response to extra_comms_begin: %c:%s\n", cmd, feat);
ret=-1;
goto end;
}
// Can add extra bits here. The first extra bit is the
// autoupgrade stuff.
if(server_supports_autoupgrade(feat))
{
if(conf->autoupgrade_dir && conf->autoupgrade_os
&& (ret=autoupgrade_client(conf, &p1cntr)))
goto end;
}
// :srestore: means that the server wants to do a restore.
if(server_supports(feat, ":srestore:"))
{
if(conf->server_can_restore)
{
logp("Server is initiating a restore\n");
if(incexc) { free(incexc); incexc=NULL; }
if((ret=incexc_recv_client_restore(&incexc,
conf, &p1cntr)))
goto end;
if(incexc)
{
if((ret=parse_incexcs_buf(conf,
incexc))) goto end;
act=ACTION_RESTORE;
log_restore_settings(conf, 1);
}
}
else
{
logp("Server wants to initiate a restore\n");
logp("Client configuration says no\n");
if(async_write_str(CMD_GEN, "srestore not ok"))
{
ret=-1;
goto end;
}
}
}
if(conf->orig_client)
{
char str[512]="";
snprintf(str, sizeof(str),
"orig_client=%s", conf->orig_client);
if(!server_supports(feat, ":orig_client:"))
{
logp("Server does not support switching client.\n");
ret=-1;
goto end;
}
if((ret=async_write_str(CMD_GEN, str))
|| (ret=async_read_expect(CMD_GEN, "orig_client ok")))
{
logp("Problem requesting %s\n", str);
ret=-1;
goto end;
}
logp("Switched to client %s\n", conf->orig_client);
}
// :sincexc: is for the server giving the client the
// incexc config.
if(act==ACTION_BACKUP
|| act==ACTION_BACKUP_TIMED)
{
if(!incexc && server_supports(feat, ":sincexc:"))
{
logp("Server is setting includes/excludes.\n");
if(incexc) { free(incexc); incexc=NULL; }
if((ret=incexc_recv_client(&incexc,
conf, &p1cntr))) goto end;
if(incexc && (ret=parse_incexcs_buf(conf,
incexc))) goto end;
}
}
if(server_supports(feat, ":counters:"))
{
if(async_write_str(CMD_GEN, "countersok"))
goto end;
conf->send_client_counters=1;
}
// :incexc: is for the client sending the server the
// incexc config so that it better knows what to do on
// resume.
if(server_supports(feat, ":incexc:")
&& (ret=incexc_send_client(conf, &p1cntr)))
goto end;
if((ret=async_write_str(CMD_GEN, "extra_comms_end"))
|| (ret=async_read_expect(CMD_GEN, "extra_comms_end ok")))
{
logp("Problem requesting extra_comms_end\n");
goto end;
}
if(feat) free(feat);
}
rfd=-1;
switch(act)
{
case ACTION_BACKUP_TIMED:
phase1str="backupphase1timed";
case ACTION_BACKUP:
{
// Set bulk packets quality of service flags on backup.
if(incexc)
{
logp("Server is overriding the configuration\n");
logp("with the following settings:\n");
if(log_incexcs_buf(incexc))
{
ret=-1;
goto end;
}
}
if(!conf->sdcount)
{
logp("Found no include paths!\n");
ret=-1;
goto end;
}
if(!(ret=maybe_check_timer(phase1str,
conf, &resume)))
{
if(conf->backup_script_pre)
{
int a=0;
const char *args[12];
args[a++]=conf->backup_script_pre;
args[a++]="pre";
args[a++]="reserved2";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(args,
conf->backup_script_pre_arg,
conf->bprecount,
&p1cntr, 1, 1)) ret=-1;
}
if(!ret && do_backup_client(conf,
resume, 0, &p1cntr, &cntr))
ret=-1;
if((conf->backup_script_post_run_on_fail
|| !ret) && conf->backup_script_post)
{
int a=0;
const char *args[12];
args[a++]=conf->backup_script_post;
args[a++]="post";
// Tell post script whether the restore
// failed.
args[a++]=ret?"1":"0";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(args,
conf->backup_script_post_arg,
conf->bpostcount,
&cntr, 1, 1)) ret=-1;
}
}
if(ret<0)
logp("error in backup\n");
else if(ret>0)
{
// Timer script said no.
// Have a distinct return value to
// differentiate between other cases
// (ssl reconnection and restore/verify
// warnings).
ret=3;
}
else
logp("backup finished ok\n");
break;
}
case ACTION_RESTORE:
case ACTION_VERIFY:
{
if(conf->restore_script_pre)
{
int a=0;
const char *args[12];
args[a++]=conf->restore_script_pre;
args[a++]="pre";
args[a++]="reserved2";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(args,
conf->restore_script_pre_arg,
conf->rprecount, &cntr, 1, 1)) ret=-1;
}
if(!ret && do_restore_client(conf,
act, vss_restore, &p1cntr, &cntr)) ret=-1;
if((conf->restore_script_post_run_on_fail
|| !ret) && conf->restore_script_post)
{
int a=0;
const char *args[12];
args[a++]=conf->restore_script_pre;
args[a++]="post";
// Tell post script whether the restore
// failed.
args[a++]=ret?"1":"0";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(args,
conf->restore_script_post_arg,
conf->rpostcount, &cntr, 1, 1)) ret=-1;
}
// Return non-zero if there were warnings,
// so that the test script can easily check.
if(p1cntr.warning+cntr.warning)
ret=2;
break;
}
case ACTION_ESTIMATE:
if(!ret) ret=do_backup_client(conf, 0, 1,
&p1cntr, &cntr);
break;
case ACTION_DELETE:
if(!ret) ret=do_delete_client(conf);
break;
case ACTION_LIST:
case ACTION_LONG_LIST:
default:
ret=do_list_client(conf, act, json);
break;
}
end:
close_fd(&rfd);
async_free();
if(act!=ACTION_ESTIMATE) ssl_destroy_ctx(ctx);
if(incexc) free(incexc);
if(server_version) free(server_version);
//logp("end client\n");
return ret;
}
static enum cliret restore_wrapper(struct asfd *asfd, enum action action,
int vss_restore, struct conf *conf)
{
enum cliret ret=CLIENT_OK;
if(conf->r_script_pre)
{
int a=0;
const char *args[12];
args[a++]=conf->r_script_pre;
args[a++]="pre";
args[a++]="reserved2";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(asfd, args,
conf->r_script_pre_arg, conf, 1, 1, 1))
ret=CLIENT_ERROR;
}
if(ret==CLIENT_OK)
{
// FIX THIS: Really need to abstract these
// functions to be a single pointer.
if(conf->protocol==PROTO_BURP1)
{
if(do_restore_client_burp1(asfd, conf,
action, vss_restore)) ret=CLIENT_ERROR;
}
else
{
if(do_restore_client(asfd, conf,
action, vss_restore)) ret=CLIENT_ERROR;
}
}
if((ret==CLIENT_OK || conf->r_script_post_run_on_fail)
&& conf->r_script_post)
{
int a=0;
const char *args[12];
args[a++]=conf->r_script_pre;
args[a++]="post";
// Tell post script whether the restore
// failed.
args[a++]=ret?"1":"0";
args[a++]="reserved3";
args[a++]="reserved4";
args[a++]="reserved5";
args[a++]=NULL;
if(run_script(asfd, args,
conf->r_script_post_arg, conf, 1, 1, 1))
ret=CLIENT_ERROR;
}
// Return non-zero if there were warnings,
// so that the test script can easily check.
if(conf->cntr->ent[CMD_WARNING]->count)
ret=CLIENT_RESTORE_WARNINGS;
return ret;
}