-
Notifications
You must be signed in to change notification settings - Fork 375
/
xccdf_policy.c
2292 lines (1964 loc) · 87 KB
/
xccdf_policy.c
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
/*
* xccdf_policy.c
*
* Copyright 2009--2014 Red Hat Inc., Durham, North Carolina.
* All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Created on: Dec 16, 2009
* Author: David Niemoller
* Maros Barabas <mbarabas@redhat.com>
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "xccdf_policy_priv.h"
#include "xccdf_policy_model_priv.h"
#include "xccdf_policy_engine_priv.h"
#include "reporter_priv.h"
#include "public/xccdf_policy.h"
#include "public/xccdf_benchmark.h"
#include "public/oscap_text.h"
#include "CPE/cpelang_priv.h"
#include "CPE/cpe_session_priv.h"
#include "CPE/cpedict_priv.h"
#include "oscap_source.h"
#include "oval_agent_api.h"
#include "item.h"
#include "helpers.h"
#include "common/list.h"
#include "common/_error.h"
#include "common/debug_priv.h"
#include "common/text_priv.h"
#include "XCCDF/result_scoring_priv.h"
#include "xccdf_policy_resolve.h"
#include "oscap_helpers.h"
/* Macros to generate iterators, getters and setters */
OSCAP_GETTER(struct xccdf_benchmark *, xccdf_policy_model, benchmark)
OSCAP_IGETINS_GEN(xccdf_policy, xccdf_policy_model, policies, policy)
/* Macros to generate iterators, getters and setters */
OSCAP_GETTER(struct xccdf_policy_model *, xccdf_policy, model)
OSCAP_GETTER(struct xccdf_profile *, xccdf_policy, profile)
OSCAP_IGETTER(xccdf_select, xccdf_policy, selects)
OSCAP_IGETINS_GEN(xccdf_value_binding, xccdf_policy, values, value)
OSCAP_IGETINS(xccdf_result, xccdf_policy, results, result)
/**
* XCCDF value binding structure is binding between Refine values, Set values,
* Value element and Check export element of benchmark. These structures are
* binded together for exporting values to checking engine.
*
* These bindings are set during the preprocessing of profile, when policies
* are beeing created.
*/
struct xccdf_value_binding {
char * name; ///< The name of OVAL Variable
xccdf_value_type_t type; ///< Type of Variable
char * value; ///< Value of variable
char * setvalue; ///< Set value if defined or NULL
xccdf_operator_t operator; ///< Operator of Value
};
/* Macros to generate iterators, getters and setters */
OSCAP_GETTER(xccdf_value_type_t, xccdf_value_binding, type)
OSCAP_GETTER(char *, xccdf_value_binding, name)
OSCAP_GETTER(char *, xccdf_value_binding, value)
OSCAP_GETTER(char *, xccdf_value_binding, setvalue)
OSCAP_GETTER(xccdf_operator_t, xccdf_value_binding, operator)
/*==========================================================================*/
/* Declaration of static (private to this file) functions
* These function shoud not be called from outside. For exporting these
* elements has to call parent element's
*/
/**
* Filter function returning true if the item is selected, false otherwise
*/
static bool xccdf_policy_filter_selected(void *item, void *policy)
{
struct xccdf_benchmark * benchmark
= xccdf_policy_model_get_benchmark(xccdf_policy_get_model((struct xccdf_policy *) policy));
struct xccdf_item * titem = xccdf_benchmark_get_item(benchmark, xccdf_select_get_item((struct xccdf_select *) item));
if (titem == NULL) {
dE("Item \"%s\" does not exist. Remove it from Profile !", xccdf_select_get_item((struct xccdf_select *) item));
return false;
}
return ((xccdf_item_get_type(titem) == XCCDF_RULE) &&
(xccdf_select_get_selected((struct xccdf_select *) item)));
}
/**
* Get callbacks that match sysname. Call this function to get iterator over list of callbacks
* that have the same system name
*/
static struct oscap_iterator *
_xccdf_policy_get_callbacks_by_sysname(struct xccdf_policy * policy, const char * sysname)
{
return oscap_iterator_new_filter( policy->model->callbacks, (oscap_filter_func) xccdf_policy_engine_filter, (void *) sysname);
}
/**
* Get the checking engines that match the sysname.
*/
static struct oscap_iterator *_xccdf_policy_get_engines_by_sysname(struct xccdf_policy *policy, const char *sysname)
{
return oscap_iterator_new_filter(policy->model->engines, (oscap_filter_func) xccdf_policy_engine_filter, (void *) sysname);
}
char *xccdf_policy_get_readable_item_title(struct xccdf_policy *policy, struct xccdf_item *item, const char *preferred_lang)
{
struct oscap_text_iterator *title_it = xccdf_item_get_title(item);
char *unresolved = oscap_textlist_get_preferred_plaintext(title_it, preferred_lang);
oscap_text_iterator_free(title_it);
if (!unresolved)
return oscap_strdup("");
char *resolved = xccdf_policy_substitute(unresolved, policy);
free(unresolved);
return resolved;
}
char *xccdf_policy_get_readable_item_description(struct xccdf_policy *policy, struct xccdf_item *item, const char *preferred_lang)
{
/* Get description in prefered language */
struct oscap_text_iterator *description_it = xccdf_item_get_description(item);
struct oscap_text *unresolved_text = oscap_textlist_get_preferred_text(description_it, preferred_lang);
oscap_text_iterator_free(description_it);
if (!unresolved_text)
return oscap_strdup("");
const char *unresolved = oscap_text_get_text(unresolved_text);
/* Resolve <xccdf:sub> elements */
char *resolved = xccdf_policy_substitute(unresolved, policy);
/* Get a rid of xhtml elements */
char *plaintext = _xhtml_to_plaintext(resolved);
free(resolved);
return plaintext;
}
/**
* Get last setvalue from policy that match specified id
*/
static struct xccdf_setvalue * xccdf_policy_get_setvalue(struct xccdf_policy * policy, const char * id)
{
/* return NULL if id or policy is NULL but don't use
* __attribute_not_null__ here, it will cause abort
* which is not desired
*/
if (id == NULL) return NULL;
if (policy == NULL) return NULL;
struct xccdf_setvalue_iterator * s_value_it;
struct xccdf_setvalue * s_value;
struct xccdf_profile * profile = xccdf_policy_get_profile(policy);;
/* If profile is NULL we don't have setvalue's
* and we return NULL, otherwise we could cause SIGSEG
* with accessing NULL structure
*/
if (profile == NULL) return NULL;
/* We need to return *LAST* setvalue in Profile.
* and iterate to the end of setvalue list
*/
struct xccdf_setvalue * final = NULL;
s_value_it = xccdf_profile_get_setvalues(profile);
while (xccdf_setvalue_iterator_has_more(s_value_it)) {
s_value = xccdf_setvalue_iterator_next(s_value_it);
if (!strcmp(id, xccdf_setvalue_get_item(s_value))) {
final = s_value;
}
}
xccdf_setvalue_iterator_free(s_value_it);
return final;
}
static struct xccdf_refine_value * xccdf_policy_get_refine_value(struct xccdf_policy * policy, const char * id)
{
/* return NULL if id or policy is NULL but don't use
* __attribute_not_null__ here, it will cause abort
* which is not desired
*/
if (id == NULL) return NULL;
if (policy == NULL) return NULL;
struct xccdf_refine_value_iterator * r_value_it;
struct xccdf_refine_value * r_value;
struct xccdf_profile * profile = xccdf_policy_get_profile(policy);;
/* If profile is NULL we don't have setvalue's
* and we return NULL, otherwise we could cause SIGSEG
* with accessing NULL structure
*/
if (profile == NULL) return NULL;
/* We need to return *LAST* setvalue in Profile.
* and iterate to the end of setvalue list
*/
struct xccdf_refine_value * final = NULL;
r_value_it = xccdf_profile_get_refine_values(profile);
while (xccdf_refine_value_iterator_has_more(r_value_it)) {
r_value = xccdf_refine_value_iterator_next(r_value_it);
if (!strcmp(id, xccdf_refine_value_get_item(r_value))) {
final = r_value;
}
}
xccdf_refine_value_iterator_free(r_value_it);
return final;
}
/**
* Function resolves two operations:
* P - PASS
* F - FAIL
* U - UNKNOWN
* E - ERROR
* N - NOT CHECKED, NOT SELECTED, NOT APPLICABLE
*
* ***************************************************************
* AND P F U E N OR P F U E N P F U E N *
* P P F U E P P P P P P P neg F P U E N *
* F F F F F F F P F U E F *
* U U F U U U U P U U U U *
* E E F U E E E P E U E E *
* N P F U E N N P F U E N *
* ***************************************************************
*
*/
static xccdf_test_result_type_t _resolve_operation(int A, int B, xccdf_bool_operator_t oper)
{
xccdf_test_result_type_t value = 0;
static const xccdf_test_result_type_t RESULT_TABLE_AND[9][9] = {
/* P F E U N K S I */
{0, 0, 0, 0, 0, 0, 0, 0, 0},
{0, 1, 2, 3, 4, 1, 1, 1, 1}, /* P (pass)*/
{0, 2, 2, 2, 2, 2, 2, 2, 2}, /* F (fail) */
{0, 4, 2, 4, 4, 4, 4, 4, 4}, /* E (error) */
{0, 3, 2, 3, 4, 3, 3, 3, 3}, /* U (unknown) */
{0, 1, 2, 3, 4, 5, 5, 5, 5}, /* N (notapplicable) */
{0, 1, 2, 3, 4, 5, 6, 6, 6}, /* K (notchecked) */
{0, 1, 2, 3, 4, 5, 6, 7, 7}, /* S (notselected) */
{0, 1, 2, 3, 4, 5, 6, 7, 8}};/* I (informational) */
static const xccdf_test_result_type_t RESULT_TABLE_OR[9][9] = {
/* P F E U N K S I */
{0, 0, 0, 0, 0, 0, 0, 0, 0},
{0, 1, 1, 1, 1, 1, 1, 1, 1}, /* P (pass)*/
{0, 1, 2, 3, 4, 2, 2, 2, 2}, /* F (fail) */
{0, 1, 4, 4, 4, 4, 4, 4, 4}, /* E (error) */
{0, 1, 3, 3, 4, 3, 3, 3, 3}, /* U (unknown) */
{0, 1, 2, 3, 4, 5, 5, 5, 5}, /* N (notapplicable) */
{0, 1, 2, 3, 4, 5, 6, 6, 6}, /* K (notchecked) */
{0, 1, 2, 3, 4, 5, 6, 7, 7}, /* S (notselected) */
{0, 1, 2, 3, 4, 5, 6, 7, 8}};/* I (informational) */
/* No test result can end with 0
*/
if ((A == 0) || (B == 0)
|| A > XCCDF_RESULT_INFORMATIONAL || B > XCCDF_RESULT_INFORMATIONAL) {
dE("Bad test results %d, %d.", A, B);
return 0;
}
switch (oper) {
case XCCDF_OPERATOR_AND: /* AND */
value = (xccdf_test_result_type_t) RESULT_TABLE_AND[A][B];
break;
case XCCDF_OPERATOR_OR: /* OR */
value = (xccdf_test_result_type_t) RESULT_TABLE_OR[A][B];
break;
default:
dE("Operation not supported.");
return 0;
break;
}
return value;
}
xccdf_test_result_type_t xccdf_test_result_resolve_and_operation(xccdf_test_result_type_t A, xccdf_test_result_type_t B)
{
return _resolve_operation((int)A, (int)B, XCCDF_OPERATOR_AND);
}
/**
* Handle the negation="true" paramter of xccdf:complex-check.
* Shall be run only once per a complex-check.
*/
static xccdf_test_result_type_t _resolve_negate(xccdf_test_result_type_t value, const struct xccdf_check *check)
{
if (xccdf_check_get_negate(check)) {
if (value == XCCDF_RESULT_PASS) return XCCDF_RESULT_FAIL;
else if (value == XCCDF_RESULT_FAIL) return XCCDF_RESULT_PASS;
}
return value;
}
static void _xccdf_policy_modify_selected_final(struct xccdf_policy *policy, const char *id, bool selected)
{
static bool TRUE0 = true;
static bool FALSE0 = false;
oscap_htable_detach(policy->selected_final, id);
oscap_htable_add(policy->selected_final, id, selected ? &TRUE0 : &FALSE0);
}
/**
* Resolve the xccdf item. Parameter selected indicates parents selection attribute
* It is used to decide the final selection attribute of item
*
* If parent's group of rule item has attribute selected = FALSE, It should not be processed, neither
* its children. This selected attribute is iterativly passed to each child of group to set their selected
* attribute to false no matter of profile setting.
*/
static void xccdf_policy_resolve_item(struct xccdf_policy * policy, struct xccdf_item * item, bool selected)
{
__attribute__nonnull__(policy);
__attribute__nonnull__(item);
bool result;
const char *id = xccdf_item_get_id(item);
if (!selected)
result = false;
else {
struct xccdf_select *sel = xccdf_policy_get_select_by_id(policy, id);
result = (sel != NULL) ? xccdf_select_get_selected(sel) : xccdf_item_get_selected(item);
}
if (xccdf_item_get_type(item) == XCCDF_GROUP) {
struct xccdf_item_iterator *child_it = xccdf_group_get_content((const struct xccdf_group *)item);
while (xccdf_item_iterator_has_more(child_it))
xccdf_policy_resolve_item(policy, xccdf_item_iterator_next(child_it), selected);
xccdf_item_iterator_free(child_it);
}
_xccdf_policy_modify_selected_final(policy, id, result);
}
/**
* Evaluate the policy check with given checking system
*/
static int
xccdf_policy_evaluate_cb(struct xccdf_policy * policy, const char * sysname, const char * content, const char * href,
struct oscap_list * bindings, struct xccdf_check_import_iterator * check_import_it)
{
xccdf_test_result_type_t retval = XCCDF_RESULT_NOT_CHECKED;
struct oscap_iterator * cb_it = _xccdf_policy_get_engines_by_sysname(policy, sysname);
while (oscap_iterator_has_more(cb_it)) {
struct xccdf_policy_engine *engine = (struct xccdf_policy_engine *) oscap_iterator_next(cb_it);
retval = xccdf_policy_engine_eval(engine, policy, content, href, bindings, check_import_it);
if (retval != XCCDF_RESULT_NOT_CHECKED) break;
}
oscap_iterator_free(cb_it);
return retval;
}
/**
* Find all possible names for given check-content-ref/@href, considering also the check/@system.
* This is useful for multi-check="true" feature.
* @return list of OVAL definitions if the given href found, NULL otherwise.
*/
static struct oscap_list *_xccdf_policy_get_oval_definitions_for_href(struct xccdf_policy *policy, const char *sysname, const char *href)
{
struct oscap_iterator *cb_it = _xccdf_policy_get_engines_by_sysname(policy, sysname);
struct oscap_list *result = NULL;
while (oscap_iterator_has_more(cb_it) && result == NULL) {
struct xccdf_policy_engine *engine = (struct xccdf_policy_engine *) oscap_iterator_next(cb_it);
if (engine == NULL)
break;
result = xccdf_policy_engine_query(engine, POLICY_ENGINE_QUERY_OVAL_DEFS_FOR_HREF, (void *) href);
}
oscap_iterator_free(cb_it);
return result;
}
int xccdf_policy_report_cb(struct xccdf_policy *policy, const char *sysname, void *rule)
{
int retval = 0;
struct oscap_iterator * cb_it = _xccdf_policy_get_callbacks_by_sysname(policy, sysname);
while (oscap_iterator_has_more(cb_it)) {
struct reporter *cb = (struct reporter *) oscap_iterator_next(cb_it);
retval = reporter_send_simple(cb, rule);
/* We still want to stop evaluation if user cancel it
* TODO: We should have a way to stop evaluation of current item
*/
if (retval != 0) break;
}
oscap_iterator_free(cb_it);
return retval;
}
static struct oscap_list * xccdf_policy_check_get_value_bindings(struct xccdf_policy * policy, struct xccdf_check_export_iterator * check_it)
{
__attribute__nonnull__(check_it);
struct xccdf_check_export * check;
struct xccdf_value * value;
struct xccdf_benchmark * benchmark;
struct xccdf_value_binding * binding;
struct xccdf_policy_model * model;
struct xccdf_refine_value * r_value;
struct xccdf_setvalue * s_value;
struct oscap_list * list = oscap_list_new();
model = xccdf_policy_get_model(policy);
benchmark = xccdf_policy_model_get_benchmark(model);
while (xccdf_check_export_iterator_has_more(check_it)) {
check = xccdf_check_export_iterator_next(check_it);
value = (struct xccdf_value *) xccdf_benchmark_get_item(benchmark, xccdf_check_export_get_value(check));
if (value == NULL) {
oscap_seterr(OSCAP_EFAMILY_XCCDF, "Value \"%s\" does not exist in benchmark", xccdf_check_export_get_value(check));
oscap_list_free(list, free);
return NULL;
}
binding = xccdf_value_binding_new();
/* Apply related setvalue from policy profile */
s_value = xccdf_policy_get_setvalue(policy, xccdf_value_get_id(value));
if (s_value != NULL) binding->setvalue = oscap_strdup((char *) xccdf_setvalue_get_value(s_value));
/* Apply related refine value from policy profile */
const char * selector = NULL;
r_value = xccdf_policy_get_refine_value(policy, xccdf_value_get_id(value));
if (r_value != NULL) {
selector = xccdf_refine_value_get_selector(r_value);
/* This refine value changes the value content */
if ((int)xccdf_refine_value_get_oper(r_value) > 0) {
binding->operator = xccdf_refine_value_get_oper(r_value);
} else binding->operator = xccdf_value_get_oper(value);
} else binding->operator = xccdf_value_get_oper(value);
const struct xccdf_value_instance * val = xccdf_value_get_instance_by_selector(value, selector);
if (val == NULL) {
oscap_seterr(OSCAP_EFAMILY_XCCDF, "Attempt to get non-existent selector \"%s\" from variable \"%s\"", selector, xccdf_value_get_id(value));
oscap_list_free(list, free);
xccdf_value_binding_free(binding);
return NULL;
}
binding->value = oscap_strdup(xccdf_value_instance_get_value(val));
binding->name = oscap_strdup((char *) xccdf_check_export_get_name(check));
binding->type = xccdf_value_get_type(value);
oscap_list_add(list, binding);
}
xccdf_check_export_iterator_free(check_it);
return list;
}
int xccdf_policy_check_evaluate(struct xccdf_policy * policy, struct xccdf_check * check)
{
struct xccdf_check_iterator * child_it;
struct xccdf_check * child;
struct xccdf_check_content_ref_iterator * content_it;
struct xccdf_check_content_ref * content;
const char * content_name;
const char * system_name;
const char * href;
struct oscap_list * bindings;
int ret = 0;
int ret2 = 0;
/* At least one of check-content or check-content-ref must
* appear in each check element. */
if (xccdf_check_get_complex(check)) { /* we have complex subtree */
child_it = xccdf_check_get_children(check);
while (xccdf_check_iterator_has_more(child_it)) {
child = xccdf_check_iterator_next(child_it);
ret2 = xccdf_policy_check_evaluate(policy, child);
if (ret2 == -1) {
xccdf_check_iterator_free(child_it);
return -1;
}
if (ret == 0) ret = ret2;
else {
ret = (int) _resolve_operation((xccdf_test_result_type_t) ret, (xccdf_test_result_type_t) ret2, xccdf_check_get_oper(check));
}
}
xccdf_check_iterator_free(child_it);
} else { /* This is <check> element */
/* It depends on what operation we process - we do only Compliance Check */
content_it = xccdf_check_get_content_refs(check);
system_name = xccdf_check_get_system(check);
bindings = xccdf_policy_check_get_value_bindings(policy, xccdf_check_get_exports(check));
if (bindings == NULL) {
xccdf_check_content_ref_iterator_free(content_it);
return XCCDF_RESULT_UNKNOWN;
}
while (xccdf_check_content_ref_iterator_has_more(content_it)) {
content = xccdf_check_content_ref_iterator_next(content_it);
content_name = xccdf_check_content_ref_get_name(content);
href = xccdf_check_content_ref_get_href(content);
struct xccdf_check_import_iterator * check_import_it = xccdf_check_get_imports(check);
ret = xccdf_policy_evaluate_cb(policy, system_name, content_name, href, bindings, check_import_it);
// the evaluation has filled check imports at this point, we can simply free the iterator
xccdf_check_import_iterator_free(check_import_it);
// the content references are basically alternatives according to the specification
// we should go through them in the order they are defined and we are done as soon
// as we process one of them successfully
if ((xccdf_test_result_type_t) ret != XCCDF_RESULT_NOT_CHECKED) {
xccdf_check_inject_content_ref(check, content, NULL);
break;
}
}
xccdf_check_content_ref_iterator_free(content_it);
oscap_list_free(bindings, (oscap_destruct_func) xccdf_value_binding_free);
}
/* Negate only once */
ret = _resolve_negate(ret, check);
return ret;
}
static inline bool
_xccdf_policy_is_engine_registered(struct xccdf_policy *policy, char *sysname)
{
return oscap_list_contains(policy->model->engines, (void *) sysname, (oscap_cmp_func) xccdf_policy_engine_filter);
}
static struct xccdf_check *
_xccdf_policy_rule_get_applicable_check(struct xccdf_policy *policy, struct xccdf_item *rule)
{
// Citations inline come from NISTIR-7275r4.
struct xccdf_check *result = NULL;
{
// If an <xccdf:Rule> contains an <xccdf:complex-check>, then the benchmark consumer MUST process
// it and MUST ignore any <xccdf:check> elements that are also contained by the <xccdf:Rule>.
struct xccdf_check_iterator *check_it = xccdf_rule_get_complex_checks(rule);
if (xccdf_check_iterator_has_more(check_it))
result = xccdf_check_iterator_next(check_it);
xccdf_check_iterator_free(check_it);
}
if (result == NULL) {
// Check Processing Algorithm -- Check.Initialize
// Check Processing Algorithm -- Check.Selector
struct xccdf_refine_rule_internal *r_rule = xccdf_policy_get_refine_rule_by_item(policy, rule);
char *selector = (r_rule == NULL) ? NULL : xccdf_refine_rule_internal_get_selector(r_rule);
struct xccdf_check_iterator *candidate_it = xccdf_rule_get_checks_filtered(rule, selector);
if (selector != NULL && !xccdf_check_iterator_has_more(candidate_it)) {
xccdf_check_iterator_free(candidate_it);
// If the refined selector does not match, checks without selector shall be used.
candidate_it = xccdf_rule_get_checks_filtered(rule, NULL);
}
bool print_general_warning = false;
bool print_oval_warning = false;
char *warning_check_system = NULL;
// Check Processing Algorithm -- Check.System
while (xccdf_check_iterator_has_more(candidate_it)) {
struct xccdf_check *check = xccdf_check_iterator_next(candidate_it);
if (_xccdf_policy_is_engine_registered(policy, (char *) xccdf_check_get_system(check))) {
result = check;
} else if (strcmp("http://oval.mitre.org/XMLSchema/oval-definitions-5", check->system) == 0) {
print_oval_warning = true;
} else if (strcmp("http://scap.nist.gov/schema/ocil/2", check->system) == 0) {
dI("This rule requires an OCIL check. OCIL checks are not supported by OpenSCAP.");
} else if (strcmp("http://open-scap.org/page/SCE", check->system) == 0) {
dI("This rule requires a SCE check but the SCE plugin was disabled.");
} else {
print_general_warning = true;
warning_check_system = check->system;
}
}
// Only print a warning if we didn't select a check but could've otherwise.
if (print_oval_warning) {
dW("Skipping rule that uses OVAL but is possibly malformed; "
"an incorrect content reference prevents this check from being evaluated.\n");
} else if (print_general_warning && result == NULL) {
dW("Skipping rule that requires an unregistered check system "
"or incorrect content reference to evaluate. "
"Please consider providing a valid SCAP/OVAL instead of %s\n",
warning_check_system);
}
xccdf_check_iterator_free(candidate_it);
}
// A tool processing the Benchmark for compliance checking must pick at most one check or
// complex-check element to process for each Rule.
return result;
}
bool
xccdf_policy_is_item_selected(struct xccdf_policy *policy, const char *id)
{
const bool *tmp = (const bool*) oscap_htable_get(policy->selected_final, id);
if (tmp == NULL) {
/* This shall really never happen. All valid IDs of any
* xccdf:Item shall be stored in the dictionery. However,
* we shall not to segfault. */
assert(false);
return false;
}
return *tmp;
}
int xccdf_policy_get_selected_rules_count(struct xccdf_policy *policy)
{
int ret = 0;
struct xccdf_policy_model *model = xccdf_policy_get_model(policy);
struct xccdf_benchmark *benchmark = xccdf_policy_model_get_benchmark(model);
struct oscap_htable_iterator *it = oscap_htable_iterator_new(policy->selected_final);
while (oscap_htable_iterator_has_more(it)) {
const char *key = NULL;
void *value = NULL;
oscap_htable_iterator_next_kv(it, &key, &value);
if (!value || !*(bool*)value)
continue;
if (!key)
continue;
struct xccdf_item *item = xccdf_benchmark_get_member(benchmark, XCCDF_ITEM, key);
if (!item)
continue;
if (xccdf_item_get_type(item) == XCCDF_RULE)
++ret;
}
oscap_htable_iterator_free(it);
return ret;
}
static struct xccdf_rule_result * _xccdf_rule_result_new_from_rule(const struct xccdf_policy *policy, const struct xccdf_rule *rule,
struct xccdf_check *check,
xccdf_test_result_type_t eval_result,
const char *message)
{
const char* rule_id = xccdf_rule_get_id(rule);
struct xccdf_rule_result *rule_ritem = xccdf_rule_result_new();
struct xccdf_refine_rule_internal* r_rule = oscap_htable_get(policy->refine_rules_internal, rule_id);
/* --Set rule-- */
xccdf_rule_result_set_result(rule_ritem, eval_result);
xccdf_rule_result_set_idref(rule_ritem, xccdf_rule_get_id(rule));
xccdf_rule_result_set_weight(rule_ritem, xccdf_get_final_weight(rule, r_rule));
xccdf_rule_result_set_version(rule_ritem, xccdf_rule_get_version(rule));
xccdf_rule_result_set_severity(rule_ritem, xccdf_get_final_severity(rule, r_rule));
xccdf_rule_result_set_role(rule_ritem, xccdf_get_final_role(rule, r_rule));
xccdf_rule_result_set_time_current(rule_ritem);
/* --Ident-- */
struct xccdf_ident_iterator * ident_it = xccdf_rule_get_idents(rule);
while (xccdf_ident_iterator_has_more(ident_it)){
struct xccdf_ident * ident = xccdf_ident_iterator_next(ident_it);
xccdf_rule_result_add_ident(rule_ritem, xccdf_ident_clone(ident));
}
xccdf_ident_iterator_free(ident_it);
if (check != NULL)
xccdf_rule_result_add_check(rule_ritem, check);
if (message != NULL) {
struct xccdf_message *msg = xccdf_message_new();
xccdf_message_set_content(msg, message);
xccdf_message_set_severity(msg, XCCDF_MSG_INFO);
xccdf_rule_result_add_message(rule_ritem, msg);
}
return rule_ritem;
}
static bool _user_specified_rule_mode(struct xccdf_policy *policy) {
return oscap_htable_itemcount(policy->rules) > 0;
}
static int _xccdf_policy_report_rule_result(struct xccdf_policy *policy,
struct xccdf_result *result,
const struct xccdf_rule *rule,
struct xccdf_check *check,
int res,
const char *message)
{
struct xccdf_rule_result * rule_result = NULL;
int ret=0;
if (res == -1)
return res;
if (result != NULL) {
/* Add result to policy */
/* TODO: instance */
rule_result = _xccdf_rule_result_new_from_rule(policy, rule, check, res, message);
xccdf_result_add_rule_result(result, rule_result);
} else
xccdf_check_free(check);
/* If at least one --rule option has been provided by the user on the
* command line skip reporting for the other rules - only the selected
* rule(s) will be reported. */
if (_user_specified_rule_mode(policy) > 0) {
const char* rule_id = xccdf_rule_get_id(rule);
if (oscap_htable_get(policy->rules, rule_id) == NULL)
return ret;
}
ret = xccdf_policy_report_cb(policy, XCCDF_POLICY_OUTCB_END, (void *) rule_result);
return ret;
}
struct cpe_check_cb_usr
{
struct xccdf_policy_model* model;
struct cpe_dict_model* dict;
struct cpe_lang_model* lang_model;
};
/**
* Return true if path starts with '.' or './'
*/
static bool is_path_relative_subdir(const char* path) {
if ( path[0] == '.' ) {
if ( path[1] == '/' || path[1] == '\0' ) return true;
}
return false;
}
static char *_cpe_get_oval_href(struct cpe_dict_model *dict, struct cpe_lang_model *lang_model, const char *oval_relative_href)
{
char *oval_href = NULL;
if (dict != NULL || lang_model != NULL) {
char* origin_file = NULL;
const char* origin_file_c = NULL;
if (dict != NULL) {
// the href path is relative to the CPE dictionary, we need to figure out
// a "prefixed path" to deal with the case where CPE dict is not in CWD
origin_file_c = cpe_dict_model_get_origin_file(dict);
} else {
// the href path is relative to the CPE2 dictionary, we need to figure out
// a "prefixed path" to deal with the case where CPE2 dict is not in CWD
origin_file_c = cpe_lang_model_get_origin_file(lang_model);
}
// we need to strdup because dirname potentially alters the string
origin_file = oscap_strdup(origin_file_c ? origin_file_c : "");
char *prefix_dirname = oscap_dirname(origin_file);
if (is_path_relative_subdir(prefix_dirname)) {
// The path is relative. Do not overide it.
// Chances are that ds_sds_session expects the very same href
oval_href = oscap_strdup(oval_relative_href);
} else {
oval_href = oscap_sprintf("%s/%s", prefix_dirname, oval_relative_href);
}
free(prefix_dirname);
free(origin_file);
}
return oval_href;
}
static bool _xccdf_policy_cpe_check_cb(const char* sys, const char* href, const char* name, void* usr)
{
// FIXME: Check that sys is OVAL
struct cpe_check_cb_usr* cb_usr = (struct cpe_check_cb_usr*)usr;
struct xccdf_policy_model* model = cb_usr->model;
char* prefixed_href = _cpe_get_oval_href(cb_usr->dict, cb_usr->lang_model, href);
struct oval_agent_session *session = cpe_session_lookup_oval_session(model->cpe, prefixed_href);
free(prefixed_href);
if (session == NULL) {
return false;
}
oval_agent_eval_definition(session, name);
oval_result_t result = OVAL_RESULT_NOT_EVALUATED;
if (oval_agent_get_definition_result(session, name, &result) != 0)
{
// error message should already be set in the function
}
return result == OVAL_RESULT_TRUE;
}
static bool _xccdf_policy_cpe_dict_cb(struct cpe_name* name, void* usr)
{
struct cpe_check_cb_usr* cb_usr = (struct cpe_check_cb_usr*)usr;
// We have to check all CPE1 dicts in the model.
// cb_usr->dict has nothing to do with this callback! Do NOT touch it here.
struct xccdf_policy_model* model = cb_usr->model;
struct xccdf_benchmark* benchmark = xccdf_policy_model_get_benchmark(model);
bool ret = false;
struct cpe_dict_model* embedded_dict = xccdf_benchmark_get_cpe_list(benchmark);
if (embedded_dict != NULL) {
ret = cpe_name_applicable_dict(name, embedded_dict, (cpe_check_fn) _xccdf_policy_cpe_check_cb, usr);
}
if (ret)
return true;
struct oscap_iterator* dicts = oscap_iterator_new(model->cpe->dicts);
while (!ret && oscap_iterator_has_more(dicts)) {
struct cpe_dict_model *dict = (struct cpe_dict_model*)oscap_iterator_next(dicts);
ret = cpe_name_applicable_dict(name, dict, (cpe_check_fn) _xccdf_policy_cpe_check_cb, usr);
}
oscap_iterator_free(dicts);
return ret;
}
static bool xccdf_policy_model_platforms_are_applicable_dict(struct xccdf_policy_model *model, struct cpe_dict_model *dict, struct oscap_string_iterator *platforms)
{
// at this point we know that the item has 1 or more platforms specified
bool ret = false;
while (oscap_string_iterator_has_more(platforms))
{
const char* platform = oscap_string_iterator_next(platforms);
// Platform could be a reference to CPE2 platform, skip the ones
// that aren't valid CPE names.
if (!cpe_name_check(platform))
continue;
struct cpe_name* name = cpe_name_new(platform);
struct cpe_check_cb_usr* usr = malloc(sizeof(struct cpe_check_cb_usr));
usr->model = model;
usr->dict = dict;
usr->lang_model = NULL;
const bool applicable = cpe_name_applicable_dict(name, dict, (cpe_check_fn) _xccdf_policy_cpe_check_cb, usr);
free(usr);
cpe_name_free(name);
if (applicable)
{
ret = true;
if (oscap_htable_get(model->cpe->applicable_platforms, platform) == NULL) {
oscap_htable_add(model->cpe->applicable_platforms, platform, 0);
}
}
}
oscap_string_iterator_reset(platforms);
return ret;
}
static bool xccdf_policy_model_platforms_are_applicable_lang_model(struct xccdf_policy_model *model, struct cpe_lang_model *lang_model, struct oscap_string_iterator *platforms)
{
// at this point we know that the item has 1 or more platforms specified
bool ret = false;
while (oscap_string_iterator_has_more(platforms))
{
const char* platform = oscap_string_iterator_next(platforms);
// Specification says that platform should begin with "#" if it is
// a reference to a CPE2 platform. However content exists where this
// is not strictly followed so we support both with and without "#"
// references.
const char* platform_shifted = platform;
if (strlen(platform_shifted) >= 1 && *platform_shifted == '#')
{
// skip the "#" character
platform_shifted++;
}
struct cpe_check_cb_usr* usr = malloc(sizeof(struct cpe_check_cb_usr));
usr->model = model;
usr->dict = NULL;
usr->lang_model = lang_model;
const bool applicable = cpe_platform_applicable_lang_model(platform_shifted, lang_model, (cpe_check_fn)_xccdf_policy_cpe_check_cb, (cpe_dict_fn)_xccdf_policy_cpe_dict_cb, usr);
free(usr);
if (applicable)
{
ret = true;
if (oscap_htable_get(model->cpe->applicable_platforms, platform) == NULL) {
oscap_htable_add(model->cpe->applicable_platforms, platform, 0);
}
}
}
oscap_string_iterator_reset(platforms);
return ret;
}
bool xccdf_policy_model_platforms_are_applicable(struct xccdf_policy_model *model, struct oscap_string_iterator *platforms)
{
// we have to check whether the item has any platforms at all, if it has none
// it should be applicable to all platforms
if (!oscap_string_iterator_has_more(platforms))
return true;
bool ret = false;
// We do not check whether the platform entries are valid platform refs
// or CPE names. We let the policy_model methods do that instead.
// Therefore we check all 4 (!) places where a platform may match.
// CPE2 takes precedence over CPE1 in this implementation. This is not
// dictated by the specification, it's an arbitrary choice.
struct xccdf_benchmark* benchmark = xccdf_policy_model_get_benchmark(model);
struct cpe_lang_model *embedded_lang_model = xccdf_benchmark_get_cpe_lang_model(benchmark);
if (embedded_lang_model != NULL) {
if (xccdf_policy_model_platforms_are_applicable_lang_model(model, embedded_lang_model, platforms))
ret = true;
}
struct oscap_iterator *lang_models = oscap_iterator_new(model->cpe->lang_models);
while (oscap_iterator_has_more(lang_models)) {
struct cpe_lang_model *lang_model = (struct cpe_lang_model *) oscap_iterator_next(lang_models);
if (xccdf_policy_model_platforms_are_applicable_lang_model(model, lang_model, platforms))
ret = true;
}
oscap_iterator_free(lang_models);
struct cpe_dict_model *embedded_dict = xccdf_benchmark_get_cpe_list(benchmark);
if (embedded_dict != NULL) {
if (xccdf_policy_model_platforms_are_applicable_dict(model, embedded_dict, platforms))
ret = true;
}
struct oscap_iterator *dicts = oscap_iterator_new(model->cpe->dicts);
while (oscap_iterator_has_more(dicts)) {
struct cpe_dict_model *dict = (struct cpe_dict_model *) oscap_iterator_next(dicts);
if (xccdf_policy_model_platforms_are_applicable_dict(model, dict, platforms))
ret = true;
}
oscap_iterator_free(dicts);
return ret;
}
bool xccdf_policy_model_item_is_applicable(struct xccdf_policy_model *model, struct xccdf_item *item)
{
struct xccdf_item* parent = xccdf_item_get_parent(item);
if (!parent || xccdf_policy_model_item_is_applicable(model, parent))
{
struct oscap_string_iterator* platforms = xccdf_item_get_platforms(item);
bool ret = xccdf_policy_model_platforms_are_applicable(model, platforms);
oscap_string_iterator_free(platforms);
return ret;
}
else
{
// parent is not applicable
return false;
}
}
static bool _xccdf_policy_item_is_in_conflict(struct xccdf_policy *policy, const struct xccdf_item *item) {
bool in_conflict = false;
struct oscap_string_iterator *item_conflicts_it = xccdf_item_get_conflicts(item);
while (oscap_string_iterator_has_more(item_conflicts_it)) {
const char *conflict_id = oscap_string_iterator_next(item_conflicts_it);
if (xccdf_policy_is_item_selected(policy, conflict_id)) {
in_conflict = true;
break;
}
}
oscap_string_iterator_free(item_conflicts_it);
return in_conflict;
}
static bool _xccdf_policy_item_has_all_requirements(struct xccdf_policy *policy, const struct xccdf_item *item) {
bool has_all_requirements = true;