/
dir_cmd.cc
2534 lines (2173 loc) · 77 KB
/
dir_cmd.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2018 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/*
* Kern Sibbald, October MM
*/
/**
* @file
* This file handles accepting Director Commands
*/
#include "include/bareos.h"
#include "filed/filed.h"
#include "filed/filed_globals.h"
#include "include/ch.h"
#include "filed/authenticate.h"
#include "filed/dir_cmd.h"
#include "filed/estimate.h"
#include "filed/evaluate_job_command.h"
#include "filed/heartbeat.h"
#include "filed/fileset.h"
#include "filed/socket_server.h"
#include "filed/restore.h"
#include "filed/verify.h"
#include "findlib/enable_priv.h"
#include "findlib/shadowing.h"
#include "lib/bget_msg.h"
#include "lib/bnet.h"
#include "lib/edit.h"
#include "lib/path_list.h"
#include "lib/qualified_resource_name_type_converter.h"
#include "lib/tls_conf.h"
#if defined(WIN32_VSS)
#include "win32/findlib/win32.h"
#include "vss.h"
#endif
namespace filedaemon {
extern bool backup_only_mode;
extern bool restore_only_mode;
/**
* As Windows saves ACLs as part of the standard backup stream
* we just pretend here that is has implicit acl support.
*/
#if defined(HAVE_ACL) || defined(HAVE_WIN32)
const bool have_acl = true;
#else
const bool have_acl = false;
#endif
#if defined(HAVE_XATTR)
const bool have_xattr = true;
#else
const bool have_xattr = false;
#endif
#ifdef DATA_ENCRYPTION
const bool have_encryption = true;
#else
const bool have_encryption = false;
#endif
/* Global variables to handle Client Initiated Connections */
static bool quit_client_initiate_connection = false;
static alist *client_initiated_connection_threads = nullptr;
/* Imported functions */
extern bool AccurateCmd(JobControlRecord *jcr);
extern bool StatusCmd(JobControlRecord *jcr);
extern bool QstatusCmd(JobControlRecord *jcr);
extern "C" char *job_code_callback_filed(JobControlRecord *jcr, const char* param);
/* Forward referenced functions */
static bool BackupCmd(JobControlRecord *jcr);
static bool BootstrapCmd(JobControlRecord *jcr);
static bool CancelCmd(JobControlRecord *jcr);
static bool EndRestoreCmd(JobControlRecord *jcr);
static bool EstimateCmd(JobControlRecord *jcr);
#ifdef DEVELOPER
static bool exit_cmd(JobControlRecord *jcr);
#endif
static bool FilesetCmd(JobControlRecord *jcr);
static bool job_cmd(JobControlRecord *jcr);
static bool LevelCmd(JobControlRecord *jcr);
static bool PluginoptionsCmd(JobControlRecord *jcr);
static bool RunafterCmd(JobControlRecord *jcr);
static bool RunbeforenowCmd(JobControlRecord *jcr);
static bool RunbeforeCmd(JobControlRecord *jcr);
static bool RunscriptCmd(JobControlRecord *jcr);
static bool ResolveCmd(JobControlRecord *jcr);
static bool RestoreObjectCmd(JobControlRecord *jcr);
static bool RestoreCmd(JobControlRecord *jcr);
static bool SessionCmd(JobControlRecord *jcr);
static bool SecureerasereqCmd(JobControlRecord *jcr);
static bool SetauthorizationCmd(JobControlRecord *jcr);
static bool SetbandwidthCmd(JobControlRecord *jcr);
static bool SetdebugCmd(JobControlRecord *jcr);
static bool StorageCmd(JobControlRecord *jcr);
static bool SmDumpCmd(JobControlRecord *jcr);
static bool VerifyCmd(JobControlRecord *jcr);
static BareosSocket *connect_to_director(JobControlRecord *jcr, DirectorResource *dir_res, bool verbose);
static bool response(JobControlRecord *jcr, BareosSocket *sd, char *resp, const char *cmd);
static void FiledFreeJcr(JobControlRecord *jcr);
static bool OpenSdReadSession(JobControlRecord *jcr);
static void SetStorageAuthKeyAndTlsPolicy(JobControlRecord *jcr, char *key, TlsPolicy policy);
/* Exported functions */
struct s_cmds {
const char *cmd;
bool (*func)(JobControlRecord *);
bool monitoraccess; /* specify if monitors have access to this function */
};
/**
* The following are the recognized commands from the Director.
*
* Keywords are sorted first longest match when the keywords start with the same string.
*/
static struct s_cmds cmds[] = {
{ "accurate", AccurateCmd, false },
{ "backup", BackupCmd, false },
{ "bootstrap", BootstrapCmd, false },
{ "cancel", CancelCmd, false },
{ "endrestore", EndRestoreCmd, false },
{ "estimate", EstimateCmd, false },
#ifdef DEVELOPER
{ "exit", exit_cmd, false },
#endif
{ "fileset", FilesetCmd, false },
{ "JobId=", job_cmd, false },
{ "level = ", LevelCmd, false },
{ "pluginoptions", PluginoptionsCmd, false },
{ "RunAfterJob", RunafterCmd, false },
{ "RunBeforeNow", RunbeforenowCmd, false },
{ "RunBeforeJob", RunbeforeCmd, false },
{ "Run", RunscriptCmd, false },
{ "restoreobject", RestoreObjectCmd, false },
{ "restore ", RestoreCmd, false },
{ "resolve ", ResolveCmd, false },
{ "getSecureEraseCmd", SecureerasereqCmd, false},
{ "session", SessionCmd, false },
{ "setauthorization", SetauthorizationCmd, false },
{ "setbandwidth=", SetbandwidthCmd, false },
{ "setdebug=", SetdebugCmd, false },
{ "status", StatusCmd, true },
{ ".status", QstatusCmd, true },
{ "storage ", StorageCmd, false },
{ "sm_dump", SmDumpCmd, false },
{ "verify", VerifyCmd, false },
{nullptr, nullptr, false} /* list terminator */
};
/**
* Commands send to director
*/
static char hello_client[] = "Hello Client %s FdProtocolVersion=%d calling\n";
/**
* Responses received from the director
*/
static const char OKversion[] = "1000 OK: %s Version: %s (%u %s %u)";
/**
* Commands received from director that need scanning
*/
static char setauthorizationcmd[] = "setauthorization Authorization=%100s";
static char setbandwidthcmd[] = "setbandwidth=%lld Job=%127s";
static char setdebugv0cmd[] = "setdebug=%d trace=%d";
static char setdebugv1cmd[] = "setdebug=%d trace=%d hangup=%d";
static char setdebugv2cmd[] = "setdebug=%d trace=%d hangup=%d timestamp=%d";
static char storaddrv0cmd[] = "storage address=%s port=%d ssl=%d";
static char storaddrv1cmd[] = "storage address=%s port=%d ssl=%d Authorization=%100s";
static char sessioncmd[] = "session %127s %ld %ld %ld %ld %ld %ld\n";
static char restorecmd[] = "restore replace=%c prelinks=%d where=%s\n";
static char restorecmd1[] = "restore replace=%c prelinks=%d where=\n";
static char restorecmdR[] = "restore replace=%c prelinks=%d regexwhere=%s\n";
static char restoreobjcmd[] = "restoreobject JobId=%u %d,%d,%d,%d,%d,%d,%s";
static char restoreobjcmd1[] = "restoreobject JobId=%u %d,%d,%d,%d,%d,%d\n";
static char endrestoreobjectcmd[] = "restoreobject end\n";
static char pluginoptionscmd[] = "pluginoptions %s";
static char verifycmd[] = "verify level=%30s";
static char Estimatecmd[] = "estimate listing=%d";
static char runbeforecmd[] = "RunBeforeJob %s";
static char runaftercmd[] = "RunAfterJob %s";
static char runscriptcmd[] = "Run OnSuccess=%d OnFailure=%d AbortOnError=%d When=%d Command=%s";
static char resolvecmd[] = "resolve %s";
/**
* Responses sent to Director
*/
static char errmsg[] = "2999 Invalid command\n";
static char invalid_cmd[] = "2997 Invalid command for a Director with Monitor directive enabled.\n";
static char OkAuthorization[] = "2000 OK Authorization\n";
static char OKBandwidth[] = "2000 OK Bandwidth\n";
static char OKinc[] = "2000 OK include\n";
static char OKest[] = "2000 OK estimate files=%s bytes=%s\n";
static char OKlevel[] = "2000 OK level\n";
static char OKbackup[] = "2000 OK backup\n";
static char OKbootstrap[] = "2000 OK bootstrap\n";
static char OKverify[] = "2000 OK verify\n";
static char OKrestore[] = "2000 OK restore\n";
static char OKsecureerase[] = "2000 OK FDSecureEraseCmd %s\n";
static char OKsession[] = "2000 OK session\n";
static char OKstore[] = "2000 OK storage\n";
static char OKstoreend[] = "2000 OK storage end\n";
static char OKjob[] =
#if !defined(IS_BUILD_ON_OBS)
"2000 OK Job %s (%s) %s,%s,%s";
#else
"2000 OK Job %s (%s) %s,%s,%s,%s,%s";
#endif
static char OKsetdebugv0[] = "2000 OK setdebug=%d trace=%d hangup=%d tracefile=%s\n";
static char OKsetdebugv1[] = "2000 OK setdebug=%d trace=%d hangup=%d timestamp=%d tracefile=%s\n";
static char BADjob[] = "2901 Bad Job\n";
static char EndJob[] =
"2800 End Job TermCode=%d JobFiles=%u ReadBytes=%s"
" JobBytes=%s Errors=%u VSS=%d Encrypt=%d\n";
static char OKRunBefore[] = "2000 OK RunBefore\n";
static char OKRunBeforeNow[] = "2000 OK RunBeforeNow\n";
static char OKRunAfter[] = "2000 OK RunAfter\n";
static char OKRunScript[] = "2000 OK RunScript\n";
static char BadRunBeforeJob[] = "2905 Bad RunBeforeJob command.\n";
static char FailedRunScript[] = "2905 Failed RunScript\n";
static char BadRunAfterJob[] = "2905 Bad RunAfterJob command.\n";
static char BADcmd[] = "2902 Bad %s\n";
static char OKRestoreObject[] = "2000 OK ObjectRestored\n";
static char OKPluginOptions[] = "2000 OK PluginOptions\n";
static char BadPluginOptions[] = "2905 Bad PluginOptions command.\n";
/**
* Responses received from Storage Daemon
*/
static char OK_end[] = "3000 OK end\n";
static char OK_close[] = "3000 OK close Status = %d\n";
static char OK_open[] = "3000 OK open ticket = %d\n";
static char OK_data[] = "3000 OK data\n";
static char OK_append[] = "3000 OK append data\n";
/**
* Commands sent to Storage Daemon
*/
static char append_open[] = "append open session\n";
static char append_data[] = "append data %d\n";
static char append_end[] = "append end session %d\n";
static char append_close[] = "append close session %d\n";
static char read_open[] = "read open session = %s %ld %ld %ld %ld %ld %ld\n";
static char read_data[] = "read data %d\n";
static char read_close[] = "read close session %d\n";
/**
* See if we are allowed to execute the command issued.
*/
static bool ValidateCommand(JobControlRecord *jcr, const char *cmd, alist *allowed_job_cmds)
{
char *allowed_job_cmd = nullptr;
bool allowed = false;
/*
* If there is no explicit list of allowed cmds allow all cmds.
*/
if (!allowed_job_cmds) { return true; }
foreach_alist(allowed_job_cmd, allowed_job_cmds) {
if (Bstrcasecmp(cmd, allowed_job_cmd)) {
allowed = true;
break;
}
}
if (!allowed) {
Jmsg(jcr, M_FATAL, 0, _("Illegal \"%s\" command not allowed by Allowed Job Cmds setting of this filed.\n"),
cmd);
}
return allowed;
}
static inline void CleanupFileset(JobControlRecord *jcr)
{
findFILESET *fileset;
findIncludeExcludeItem *incexe;
findFOPTS *fo;
fileset = jcr->ff->fileset;
if (fileset) {
/*
* Delete FileSet Include lists
*/
for (int i = 0; i < fileset->include_list.size(); i++) {
incexe = (findIncludeExcludeItem *)fileset->include_list.get(i);
for (int j = 0; j < incexe->opts_list.size(); j++) {
fo = (findFOPTS *)incexe->opts_list.get(j);
if (fo->plugin) { free(fo->plugin); }
for (int k = 0; k < fo->regex.size(); k++) { regfree((regex_t *)fo->regex.get(k)); }
for (int k = 0; k < fo->regexdir.size(); k++) { regfree((regex_t *)fo->regexdir.get(k)); }
for (int k = 0; k < fo->regexfile.size(); k++) { regfree((regex_t *)fo->regexfile.get(k)); }
if (fo->size_match) { free(fo->size_match); }
fo->regex.destroy();
fo->regexdir.destroy();
fo->regexfile.destroy();
fo->wild.destroy();
fo->wilddir.destroy();
fo->wildfile.destroy();
fo->wildbase.destroy();
fo->base.destroy();
fo->fstype.destroy();
fo->Drivetype.destroy();
}
incexe->opts_list.destroy();
incexe->name_list.destroy();
incexe->plugin_list.destroy();
incexe->ignoredir.destroy();
}
fileset->include_list.destroy();
/*
* Delete FileSet Exclude lists
*/
for (int i = 0; i<fileset->exclude_list.size(); i++) {
incexe = (findIncludeExcludeItem *)fileset->exclude_list.get(i);
for (int j = 0; j<incexe->opts_list.size(); j++) {
fo = (findFOPTS *)incexe->opts_list.get(j);
if (fo->size_match) { free(fo->size_match); }
fo->regex.destroy();
fo->regexdir.destroy();
fo->regexfile.destroy();
fo->wild.destroy();
fo->wilddir.destroy();
fo->wildfile.destroy();
fo->wildbase.destroy();
fo->base.destroy();
fo->fstype.destroy();
fo->Drivetype.destroy();
}
incexe->opts_list.destroy();
incexe->name_list.destroy();
incexe->plugin_list.destroy();
incexe->ignoredir.destroy();
}
fileset->exclude_list.destroy();
free(fileset);
}
jcr->ff->fileset = nullptr;
}
static inline bool AreMaxConcurrentJobsExceeded()
{
JobControlRecord *jcr;
unsigned int cnt = 0;
foreach_jcr(jcr) {
cnt++;
}
endeach_jcr(jcr);
return (cnt >= me->MaxConcurrentJobs) ? true : false;
}
JobControlRecord *create_new_director_session(BareosSocket *dir)
{
JobControlRecord *jcr;
const char jobname[12] = "*Director*";
jcr = new_jcr(sizeof(JobControlRecord), FiledFreeJcr); /* create JobControlRecord */
jcr->dir_bsock = dir;
jcr->ff = init_find_files();
jcr->start_time = time(nullptr);
jcr->RunScripts = New(alist(10, not_owned_by_alist));
jcr->last_fname = GetPoolMemory(PM_FNAME);
jcr->last_fname[0] = 0;
jcr->client_name = GetMemory(strlen(my_name) + 1);
PmStrcpy(jcr->client_name, my_name);
bstrncpy(jcr->Job, jobname, sizeof(jobname)); /* dummy */
jcr->crypto.pki_sign = me->pki_sign;
jcr->crypto.pki_encrypt = me->pki_encrypt;
jcr->crypto.pki_keypair = me->pki_keypair;
jcr->crypto.pki_signers = me->pki_signers;
jcr->crypto.pki_recipients = me->pki_recipients;
if (dir) { dir->SetJcr(jcr); }
SetJcrInTsd(jcr);
EnableBackupPrivileges(nullptr, 1 /* ignore_errors */);
return jcr;
}
void *process_director_commands(void *p_jcr)
{
JobControlRecord *jcr = (JobControlRecord *)p_jcr;
return process_director_commands(jcr, jcr->dir_bsock);
}
void *process_director_commands(JobControlRecord *jcr, BareosSocket *dir)
{
bool found;
bool quit = false;
/**********FIXME******* add command handler error code */
while (jcr->authenticated && (!quit)) {
/*
* Read command
*/
if (dir->recv() < 0) { break; /* connection terminated */ }
dir->msg[dir->message_length] = 0;
Dmsg1(100, "<dird: %s\n", dir->msg);
found = false;
for (int i = 0; cmds[i].cmd; i++) {
if (bstrncmp(cmds[i].cmd, dir->msg, strlen(cmds[i].cmd))) {
found = true; /* indicate command found */
if ((!cmds[i].monitoraccess) && (jcr->director->monitor)) {
Dmsg1(100, "Command \"%s\" is invalid.\n", cmds[i].cmd);
dir->fsend(invalid_cmd);
dir->signal(BNET_EOD);
break;
}
Dmsg1(100, "Executing %s command.\n", cmds[i].cmd);
if (!cmds[i].func(jcr)) { /* do command */
quit = true; /* error or fully terminated, get out */
Dmsg1(100, "Quit command loop. Canceled=%d\n", JobCanceled(jcr));
}
break;
}
}
if (!found) { /* command not found */
dir->fsend(errmsg);
quit = true;
break;
}
}
/*
* Inform Storage daemon that we are done
*/
if (jcr->store_bsock) { jcr->store_bsock->signal(BNET_TERMINATE); }
/*
* Run the after job
*/
if (jcr->RunScripts) {
RunScripts(jcr, jcr->RunScripts, "ClientAfterJob",
(jcr->director && jcr->director->allowed_script_dirs) ? jcr->director->allowed_script_dirs
: me->allowed_script_dirs);
}
if (jcr->JobId) { /* send EndJob if running a job */
char ed1[50], ed2[50];
/*
* Send termination status back to Dir
*/
dir->fsend(EndJob, jcr->JobStatus, jcr->JobFiles, edit_uint64(jcr->ReadBytes, ed1),
edit_uint64(jcr->JobBytes, ed2), jcr->JobErrors, jcr->enable_vss, jcr->crypto.pki_encrypt);
Dmsg1(110, "End FD msg: %s\n", dir->msg);
}
GeneratePluginEvent(jcr, bEventJobEnd);
DequeueMessages(jcr); /* send any queued messages */
/*
* Inform Director that we are done
*/
dir->signal(BNET_TERMINATE);
FreePlugins(jcr); /* release instantiated plugins */
FreeAndNullPoolMemory(jcr->job_metadata);
/*
* Clean up fileset
*/
CleanupFileset(jcr);
FreeJcr(jcr); /* destroy JobControlRecord record */
Dmsg0(100, "Done with FreeJcr\n");
Dsm_check(100);
GarbageCollectMemoryPool();
#ifdef HAVE_WIN32
AllowOsSuspensions();
#endif
return nullptr;
}
/**
* Create a new thread to handle director connection.
*/
static bool StartProcessDirectorCommands(JobControlRecord *jcr)
{
int result = 0;
pthread_t thread;
if ((result = pthread_create(&thread, nullptr, process_director_commands, (void *)jcr)) != 0) {
BErrNo be;
Emsg1(M_ABORT, 0, _("Cannot create Director connect thread: %s\n"), be.bstrerror(result));
}
return (result == 0);
}
/**
* Connection request from an director.
*
* Accept commands one at a time from the Director and execute them.
*
* Concerning ClientRunBefore/After, the sequence of events is rather critical.
* If they are not done in the right order one can easily get FD->SD timeouts
* if the script runs a long time.
*
* The current sequence of events is:
* 1. Dir starts job with FD
* 2. Dir connects to SD
* 3. Dir connects to FD
* 4. FD connects to SD
* 5. FD gets/runs ClientRunBeforeJob and sends ClientRunAfterJob
* 6. Dir sends include/exclude
* 7. FD sends data to SD
* 8. SD/FD disconnects while SD despools data and attributes (optional)
* 9. FD runs ClientRunAfterJob
*/
void *handle_director_connection(BareosSocket *dir)
{
JobControlRecord *jcr;
#ifdef HAVE_WIN32
PreventOsSuspensions();
#endif
if (AreMaxConcurrentJobsExceeded()) {
Emsg0(M_ERROR, 0, _("Number of Jobs exhausted, please increase MaximumConcurrentJobs\n"));
return nullptr;
}
jcr = create_new_director_session(dir);
Dmsg0(120, "Calling Authenticate\n");
if (AuthenticateDirector(jcr)) { Dmsg0(120, "OK Authenticate\n"); }
return process_director_commands(jcr, dir);
}
static bool ParseOkVersion(const char *string)
{
char name[MAX_NAME_LENGTH];
char version[MAX_NAME_LENGTH];
unsigned int day = 0;
char month[100];
unsigned int year = 0;
int number = 0;
number = sscanf(string, OKversion, &name, &version, &day, &month, &year);
Dmsg2(120, "OK message: %s, Version: %s\n", name, version);
return (number == 5);
}
static void *handle_connection_to_director(void *director_resource)
{
DirectorResource *dir_res = (DirectorResource *)director_resource;
BareosSocket *dir_bsock = nullptr;
JobControlRecord *jcr = nullptr;
int data_available = 0;
int retry_period = 60;
const int timeout_data = 60;
while (!quit_client_initiate_connection) {
if (jcr) {
FreeJcr(jcr);
jcr = nullptr;
}
jcr = create_new_director_session(nullptr);
dir_bsock = connect_to_director(jcr, dir_res, true);
if (!dir_bsock) {
Emsg2(M_ERROR, 0, "Failed to connect to Director \"%s\". Retry in %ds.\n", dir_res->name(),
retry_period);
sleep(retry_period);
} else {
Dmsg1(120, "Connected to \"%s\".\n", dir_res->name());
/*
* Returns: 1 if data available, 0 if timeout, -1 if error
*/
data_available = 0;
while ((data_available == 0) && (!quit_client_initiate_connection)) {
Dmsg2(120, "Waiting for data from Director \"%s\" (timeout: %ds)\n", dir_res->name(), timeout_data);
data_available = dir_bsock->WaitDataIntr(timeout_data);
}
if (!quit_client_initiate_connection) {
if (data_available < 0) {
Emsg1(M_ABORT, 0, _("Failed while waiting for data from Director \"%s\"\n"), dir_res->name());
} else {
/*
* data is available
*/
dir_bsock->SetJcr(jcr);
jcr->dir_bsock = dir_bsock;
if (StartProcessDirectorCommands(jcr)) {
/*
* jcr (and dir_bsock) are now used by another thread.
*/
dir_bsock = nullptr;
jcr = nullptr;
}
}
}
}
}
Dmsg1(100, "Exiting Client Initiated Connection thread for %s\n", dir_res->name());
if (jcr) {
/*
* cleanup old data structures
*/
FreeJcr(jcr);
}
return nullptr;
}
bool StartConnectToDirectorThreads()
{
bool result = false;
DirectorResource *dir_res = nullptr;
int pthread_create_result = 0;
if (!client_initiated_connection_threads) { client_initiated_connection_threads = New(alist()); }
pthread_t *thread;
foreach_res(dir_res, R_DIRECTOR) {
if (dir_res->conn_from_fd_to_dir) {
if (!dir_res->address) {
Emsg1(M_ERROR, 0, "Failed to connect to Director \"%s\". The address config directive is missing.\n",
dir_res->name());
} else if (!dir_res->port) {
Emsg1(M_ERROR, 0, "Failed to connect to Director \"%s\". The port config directive is missing.\n",
dir_res->name());
} else {
Dmsg3(120, "Connecting to Director \"%s\", address %s:%d.\n", dir_res->name(), dir_res->address,
dir_res->port);
thread = (pthread_t *)bmalloc(sizeof(pthread_t));
if ((pthread_create_result =
pthread_create(thread, nullptr, handle_connection_to_director, (void *)dir_res)) == 0) {
client_initiated_connection_threads->append(thread);
} else {
BErrNo be;
Emsg1(M_ABORT, 0, _("Cannot create Director connect thread: %s\n"),
be.bstrerror(pthread_create_result));
}
}
}
}
return result;
}
bool StopConnectToDirectorThreads(bool wait)
{
bool result = true;
pthread_t *thread = nullptr;
quit_client_initiate_connection = true;
if (client_initiated_connection_threads) {
while(!client_initiated_connection_threads->empty()) {
thread = (pthread_t *)client_initiated_connection_threads->remove(0);
if (thread) {
pthread_kill(*thread, TIMEOUT_SIGNAL);
if (wait) {
if (pthread_join(*thread, nullptr) != 0) { result = false; }
}
bfree(thread);
}
}
delete(client_initiated_connection_threads);
}
return result;
}
static bool SmDumpCmd(JobControlRecord *jcr)
{
CloseMemoryPool();
sm_dump(false, true);
jcr->dir_bsock->fsend("2000 sm_dump OK\n");
return true;
}
/**
* Resolve a hostname
*/
static bool ResolveCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
dlist *addr_list;
const char *errstr;
char addresses[2048];
char hostname[2048];
sscanf(dir->msg, resolvecmd, &hostname);
if ((addr_list = BnetHost2IpAddrs(hostname, 0, &errstr)) == nullptr) {
dir->fsend(_("%s: Failed to resolve %s\n"), my_name, hostname);
goto bail_out;
}
dir->fsend(_("%s resolves %s to %s\n"),my_name, hostname,
BuildAddressesString(addr_list, addresses, sizeof(addresses), false));
FreeAddresses(addr_list);
bail_out:
dir->signal(BNET_EOD);
return true;
}
static bool SecureerasereqCmd(JobControlRecord *jcr)
{
const char *setting;
BareosSocket *dir = jcr->dir_bsock;
setting = me->secure_erase_cmdline ? me->secure_erase_cmdline : "*None*";
Dmsg1(200,"Secure Erase Cmd Request: %s\n", setting);
return dir->fsend(OKsecureerase, setting);
}
#ifdef DEVELOPER
static bool exit_cmd(JobControlRecord *jcr)
{
jcr->dir_bsock->fsend("2000 exit OK\n");
//terminate_filed(0);
StopSocketServer();
return false;
}
#endif
/**
* Cancel a Job
*/
static bool CancelCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
char Job[MAX_NAME_LENGTH];
JobControlRecord *cjcr;
if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
if (!(cjcr=get_jcr_by_full_name(Job))) {
dir->fsend(_("2901 Job %s not found.\n"), Job);
} else {
GeneratePluginEvent(cjcr, bEventCancelCommand, nullptr);
cjcr->setJobStatus(JS_Canceled);
if (cjcr->store_bsock) {
cjcr->store_bsock->SetTimedOut();
cjcr->store_bsock->SetTerminated();
}
cjcr->MyThreadSendSignal(TIMEOUT_SIGNAL);
FreeJcr(cjcr);
dir->fsend(_("2001 Job %s marked to be canceled.\n"), Job);
}
} else {
dir->fsend(_("2902 Error scanning cancel command.\n"));
}
dir->signal(BNET_EOD);
return true;
}
/**
* Set new authorization key as requested by the Director
*/
static bool SetauthorizationCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
PoolMem sd_auth_key(PM_MESSAGE);
sd_auth_key.check_size(dir->message_length);
if (sscanf(dir->msg, setauthorizationcmd, sd_auth_key.c_str()) != 1) {
dir->fsend(BADcmd, "setauthorization");
return false;
}
SetStorageAuthKeyAndTlsPolicy(jcr, sd_auth_key.c_str(), jcr->sd_tls_policy);
Dmsg2(120, "JobId=%d Auth=%s\n", jcr->JobId, jcr->sd_auth_key);
return dir->fsend(OkAuthorization);
}
/**
* Set bandwidth limit as requested by the Director
*/
static bool SetbandwidthCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
int64_t bw = 0;
JobControlRecord *cjcr;
char Job[MAX_NAME_LENGTH];
*Job = 0;
if (sscanf(dir->msg, setbandwidthcmd, &bw, Job) != 2 || bw < 0) {
PmStrcpy(jcr->errmsg, dir->msg);
dir->fsend(_("2991 Bad setbandwidth command: %s\n"), jcr->errmsg);
return false;
}
if (*Job) {
if (!(cjcr = get_jcr_by_full_name(Job))) {
dir->fsend(_("2901 Job %s not found.\n"), Job);
} else {
cjcr->max_bandwidth = bw;
if (cjcr->store_bsock) {
cjcr->store_bsock->SetBwlimit(bw);
if (me->allow_bw_bursting) { cjcr->store_bsock->SetBwlimitBursting(); }
}
FreeJcr(cjcr);
}
} else { /* No job requested, apply globally */
me->max_bandwidth_per_job = bw; /* Overwrite directive */
}
return dir->fsend(OKBandwidth);
}
/**
* Set debug level as requested by the Director
*/
static bool SetdebugCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
int32_t level, trace_flag, hangup_flag, timestamp_flag;
int scan;
Dmsg1(50, "SetdebugCmd: %s", dir->msg);
scan = sscanf(dir->msg, setdebugv2cmd, &level, &trace_flag, &hangup_flag, ×tamp_flag);
if (scan != 4) { scan = sscanf(dir->msg, setdebugv1cmd, &level, &trace_flag, &hangup_flag); }
if (scan != 3 && scan != 4) {
scan = sscanf(dir->msg, setdebugv0cmd, &level, &trace_flag);
if (scan != 2) {
PmStrcpy(jcr->errmsg, dir->msg);
dir->fsend(_("2991 Bad setdebug command: %s\n"), jcr->errmsg);
return false;
} else {
hangup_flag = -1;
}
}
PoolMem tracefilename(PM_FNAME);
Mmsg(tracefilename, "%s/%s.trace", TRACEFILEDIRECTORY, my_name);
if (level >= 0) { debug_level = level; }
SetTrace(trace_flag);
SetHangup(hangup_flag);
if (scan == 4) {
SetTimestamp(timestamp_flag);
Dmsg5(50, "level=%d trace=%d hangup=%d timestamp=%d tracefilename=%s\n", level, GetTrace(), GetHangup(),
GetTimestamp(), tracefilename.c_str());
return dir->fsend(OKsetdebugv1, level, GetTrace(), GetHangup(), GetTimestamp(), tracefilename.c_str());
} else {
Dmsg4(50, "level=%d trace=%d hangup=%d tracefilename=%s\n", level, GetTrace(), GetHangup(),
tracefilename.c_str());
return dir->fsend(OKsetdebugv0, level, GetTrace(), GetHangup(), tracefilename.c_str());
}
}
static bool EstimateCmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
char ed1[50], ed2[50];
/*
* See if we are allowed to run estimate cmds.
*/
if (!ValidateCommand(jcr, "estimate",
(jcr->director && jcr->director->allowed_job_cmds) ? jcr->director->allowed_job_cmds
: me->allowed_job_cmds)) {
dir->fsend(_("2992 Bad estimate command.\n"));
return 0;
}
if (sscanf(dir->msg, Estimatecmd, &jcr->listing) != 1) {
PmStrcpy(jcr->errmsg, dir->msg);
Jmsg(jcr, M_FATAL, 0, _("Bad estimate command: %s"), jcr->errmsg);
dir->fsend(_("2992 Bad estimate command.\n"));
return false;
}
MakeEstimate(jcr);
dir->fsend(OKest, edit_uint64_with_commas(jcr->num_files_examined, ed1),
edit_uint64_with_commas(jcr->JobBytes, ed2));
dir->signal(BNET_EOD);
return true;
}
/**
* Get JobId and Storage Daemon Authorization key from Director
*/
static bool job_cmd(JobControlRecord *jcr)
{
BareosSocket *dir = jcr->dir_bsock;
JobCommand command(dir->msg);
if (!command.EvaluationSuccesful()) {
PmStrcpy(jcr->errmsg, dir->msg);
Jmsg(jcr, M_FATAL, 0, _("Bad Job Command: %s"), jcr->errmsg);
dir->fsend(BADjob);
return false;
}
jcr->JobId = command.job_id_;
strncpy(jcr->Job, command.job_, sizeof(jcr->Job));
jcr->VolSessionId = command.vol_session_id_;
jcr->VolSessionTime = command.vol_session_time_;
TlsPolicy tls_policy = command.protocol_version_ == JobCommand::ProtocolVersion::KVersionBefore_18_2 ?
TlsPolicy::kBnetTlsNone : command.tls_policy_;
SetStorageAuthKeyAndTlsPolicy(jcr, command.sd_auth_key_, tls_policy);
Dmsg3(120, "JobId=%d Auth=%s TlsPolicy=%d\n", jcr->JobId, jcr->sd_auth_key, tls_policy);
Mmsg(jcr->errmsg, "JobId=%d Job=%s", jcr->JobId, jcr->Job);
NewPlugins(jcr); /* instantiate plugins for this jcr */
GeneratePluginEvent(jcr, bEventJobStart, (void *)jcr->errmsg);
const char *os_version;
#ifdef HAVE_WIN32
os_version = win_os;
#else
os_version = HOST_OS;
#endif
#if !defined(IS_BUILD_ON_OBS)
return dir->fsend(OKjob, VERSION, LSMDATE, os_version, DISTNAME, DISTVER);
#else
return dir->fsend(OKjob, VERSION, LSMDATE, os_version, DISTNAME, DISTVER, OBS_DISTRIBUTION, OBS_ARCH);
#endif
}
static bool RunbeforeCmd(JobControlRecord *jcr)
{
bool ok;
POOLMEM *cmd;
RunScript *script;
BareosSocket *dir = jcr->dir_bsock;
if (!me->compatible) {
dir->fsend(BadRunBeforeJob);
return false;
}
Dmsg1(100, "RunbeforeCmd: %s", dir->msg);
cmd = GetMemory(dir->message_length + 1);
if (sscanf(dir->msg, runbeforecmd, cmd) != 1) {
PmStrcpy(jcr->errmsg, dir->msg);
Jmsg1(jcr, M_FATAL, 0, _("Bad RunBeforeJob command: %s\n"), jcr->errmsg);
dir->fsend(BadRunBeforeJob);
FreeMemory(cmd);
return false;
}
UnbashSpaces(cmd);
/*
* Run the command now
*/
script = NewRunscript();
script->SetJobCodeCallback(job_code_callback_filed);
script->SetCommand(cmd);
script->when = SCRIPT_Before;
FreeMemory(cmd);
ok = script->run(jcr, "ClientRunBeforeJob");
FreeRunscript(script);
if (ok) {
dir->fsend(OKRunBefore);
return true;
} else {
dir->fsend(BadRunBeforeJob);
return false;
}
}