Skip to content

Commit 85c811e

Browse files
committed
CHB: add po discharge for trusted-os-cmd-fmt-arg-string
1 parent b4cc07c commit 85c811e

5 files changed

Lines changed: 179 additions & 31 deletions

File tree

‎CodeHawk/CHB/bchlib/bCHFloc.ml‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,17 @@ object (self)
188188
finfo#update_summary
189189
(finfo#get_summary#add_register_parameter_location
190190
reg btype 4) in
191-
let ftspar = finfo#get_summary#get_parameter_for_register reg in
192-
Some (ArgValue ftspar))
191+
TR.tfold
192+
~ok:(fun ftspar -> Some (ArgValue ftspar))
193+
~error:(fun e ->
194+
begin
195+
log_error_result
196+
~tag:"xpr_to_bterm"
197+
__FILE__ __LINE__
198+
["v: " ^ (p2s v#toPretty); String.concat ", " e];
199+
None
200+
end)
201+
(finfo#get_summary#get_parameter_for_register reg))
193202
~error:(fun e ->
194203
begin
195204
log_error_result
@@ -232,15 +241,23 @@ object (self)
232241
match xpr with
233242
| XConst (IntConst n) -> Some (NumConstant n)
234243
| XVar v when self#finfo#env#is_initial_register_value v ->
235-
log_tfold
236-
(log_error "xpr_to_bterm" "invalid register")
244+
TR.tfold
237245
~ok:(fun reg ->
238246
let _ =
239247
self#finfo#update_summary
240248
(self#finfo#get_summary#add_register_parameter_location
241249
reg btype 4) in
242-
let ftspar = self#finfo#get_summary#get_parameter_for_register reg in
243-
Some (ArgValue ftspar))
250+
TR.tfold
251+
~ok:(fun ftspar -> Some (ArgValue ftspar))
252+
~error:(fun e ->
253+
begin
254+
log_error_result
255+
~tag:"xpr_to_bterm"
256+
__FILE__ __LINE__
257+
["v: " ^ (p2s v#toPretty); String.concat ", " e];
258+
None
259+
end)
260+
(self#finfo#get_summary#get_parameter_for_register reg))
244261
~error:(fun _ -> None)
245262
(self#finfo#env#get_initial_register_value_register v)
246263
| XVar v when self#finfo#env#is_stack_parameter_value v ->
@@ -2312,8 +2329,10 @@ object (self)
23122329
~msg:(eloc __LINE__)
23132330
(fun reg ->
23142331
if self#f#get_summary#has_parameter_for_register reg then
2315-
let param = self#f#get_summary#get_parameter_for_register reg in
2316-
Ok param.apar_type
2332+
TR.tbind
2333+
~msg:(eloc __LINE__)
2334+
(fun param -> Ok param.apar_type)
2335+
(self#f#get_summary#get_parameter_for_register reg)
23172336
else
23182337
let ty = self#env#get_variable_type v in
23192338
match ty with

‎CodeHawk/CHB/bchlib/bCHFunctionPODischarge.ml‎

Lines changed: 137 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -397,12 +397,12 @@ let trusted_os_cmd_fmt_arg_string_constant_string_stmt
397397
postcondition on the call that produced [x] as its return value. *)
398398
let trusted_os_cmd_fmt_arg_string_return_value_postcondition
399399
(finfo: function_info_int)
400-
(_loc: location_int)
400+
(loc: location_int)
401401
(x: xpr_t)
402402
(_quotes: quote_status_t)
403403
(_optlen: int option): po_status_t =
404404
match x with
405-
| XVar v when finfo#env#is_return_value v || finfo#env#is_sideeffect_value v ->
405+
| XVar v when finfo#env#is_return_value v ->
406406
TR.tfold
407407
~ok:(fun callsite ->
408408
let ctinfo = finfo#get_call_target callsite in
@@ -421,9 +421,104 @@ let trusted_os_cmd_fmt_arg_string_return_value_postcondition
421421
Violated ("return value of " ^ ctinfo#get_name ^ " is potentially tainted")
422422
else
423423
Open)
424-
~error:(fun _ -> Open)
424+
~error:(fun e ->
425+
begin
426+
log_error_result
427+
~tag:"trusted_os_cmd_fmt_arg_string_return_value_postcondition"
428+
~msg:(p2s loc#toPretty)
429+
__FILE__ __LINE__
430+
["x: " ^ (x2s x); String.concat "; " e];
431+
Open
432+
end)
425433
(finfo#env#get_call_site v)
426-
| _ -> Open
434+
| _ ->
435+
Open
436+
437+
438+
let trusted_os_cmd_fmt_arg_string_parameter_postcondition
439+
(finfo: function_info_int)
440+
(loc: location_int)
441+
(x: xpr_t)
442+
(quotes: quote_status_t)
443+
(_optlen: int option): po_status_t =
444+
let floc = BCHFloc.get_finfo_floc finfo loc in
445+
let tag = "trusted_os_cmd_fmt_arg_string_parameter_postcondition" in
446+
if not floc#has_call_target then
447+
begin
448+
log_diagnostics_result
449+
~tag
450+
~msg:(p2s loc#toPretty)
451+
__FILE__ __LINE__
452+
["x: " ^ (x2s x); "not a call site"];
453+
Open
454+
end
455+
else
456+
let ctinfo = floc#get_call_target in
457+
match floc#get_bterm_evaluator with
458+
| None ->
459+
begin
460+
log_diagnostics_result
461+
~tag
462+
~msg:(p2s loc#toPretty)
463+
__FILE__ __LINE__
464+
["x: " ^ (x2s x); "no bterm evaluator found"];
465+
Open
466+
end
467+
| Some btermev ->
468+
let check_bterm (bterm: bterm_t): bool =
469+
match btermev#bterm_xpr bterm with
470+
| Some xpost ->
471+
let xpost' = floc#inv#rewrite_expr xpost in
472+
(match simplify_xpr (XOp (XMinus, [xpost'; x])) with
473+
| XConst (IntConst n) -> n#equal CHNumerical.numerical_zero
474+
| _ -> false)
475+
| _ -> false in
476+
List.fold_left (fun status post ->
477+
match status with
478+
| Open ->
479+
(match post with
480+
| XXTrustedOsCmdString bterm
481+
| XXTrustedString bterm ->
482+
if check_bterm bterm then
483+
Discharged (
484+
"trusted-os-cmd-string postcondition from "
485+
^ ctinfo#get_name)
486+
else
487+
begin
488+
log_diagnostics_result
489+
~tag
490+
~msg:(p2s loc#toPretty)
491+
__FILE__ __LINE__
492+
["x: " ^ (x2s x); "xpr does not match term"];
493+
Open
494+
end
495+
| XXTrustedOsCmdFmtArgString (bterm, q, _) when q = quotes ->
496+
if check_bterm bterm then
497+
Discharged (
498+
"trusted-os-cmd-fmt-arg-string postcondition from "
499+
^ ctinfo#get_name)
500+
else
501+
begin
502+
log_diagnostics_result
503+
~tag
504+
~msg:(p2s loc#toPretty)
505+
__FILE__ __LINE__
506+
["x: " ^ (x2s x); "xpr do not match"];
507+
Open
508+
end
509+
| p ->
510+
begin
511+
log_diagnostics_result
512+
~tag
513+
~msg:(p2s loc#toPretty)
514+
__FILE__ __LINE__
515+
["x: " ^ (x2s x);
516+
"pred: " ^ (p2s (xxpredicate_to_pretty p))];
517+
Open
518+
end)
519+
520+
| _ ->
521+
status) Open ctinfo#get_postconditions
427522

428523

429524
let trusted_os_cmd_fmt_arg_string_delegate_local
@@ -468,6 +563,12 @@ let discharge_trusted_os_cmd_fmt_arg_string
468563
trusted_os_cmd_fmt_arg_string_return_value_postcondition
469564
finfo loc x quotes optlen
470565
| _ -> status in
566+
let status =
567+
match status with
568+
| Open ->
569+
trusted_os_cmd_fmt_arg_string_parameter_postcondition
570+
finfo loc x quotes optlen
571+
| _ -> status in
471572
let status =
472573
match status with
473574
| Open ->
@@ -500,11 +601,22 @@ let output_format_string_delegate
500601
~ok:(fun reg ->
501602
let _ =
502603
finfo#add_register_parameter_location reg BCHBCTypeUtil.t_charptr 4 in
503-
let ftspar = finfo#get_summary#get_parameter_for_register reg in
504-
let dst = ArgValue ftspar in
505-
let xpred = XXOutputFormatString dst in
506-
let _ = finfo#add_precondition xpred in
507-
Delegated xpred)
604+
TR.tfold
605+
~ok:(fun ftspar ->
606+
let dst = ArgValue ftspar in
607+
let xpred = XXOutputFormatString dst in
608+
let _ = finfo#add_precondition xpred in
609+
Delegated xpred)
610+
~error:(fun e ->
611+
begin
612+
log_error_result
613+
~tag:"discharge_output_format_string"
614+
~msg:(p2s loc#toPretty)
615+
__FILE__ __LINE__
616+
["v: " ^ (p2s v#toPretty); String.concat ", " e];
617+
Open
618+
end)
619+
(finfo#get_summary#get_parameter_for_register reg))
508620
~error:(fun e ->
509621
begin
510622
log_error_result
@@ -589,11 +701,22 @@ let restricted_output_format_string_delegate
589701
~ok:(fun reg ->
590702
let _ =
591703
finfo#add_register_parameter_location reg BCHBCTypeUtil.t_charptr 4 in
592-
let ftspar = finfo#get_summary#get_parameter_for_register reg in
593-
let dst = ArgValue ftspar in
594-
let xpred = XXRestrictedOutputFormatString (dst, sl) in
595-
let _ = finfo#add_precondition xpred in
596-
Delegated xpred)
704+
TR.tfold
705+
~ok:(fun ftspar ->
706+
let dst = ArgValue ftspar in
707+
let xpred = XXRestrictedOutputFormatString (dst, sl) in
708+
let _ = finfo#add_precondition xpred in
709+
Delegated xpred)
710+
~error:(fun e ->
711+
begin
712+
log_error_result
713+
~tag:"discharge_restricted_output_format_string"
714+
~msg:(p2s loc#toPretty)
715+
__FILE__ __LINE__
716+
["v: " ^ (p2s v#toPretty); String.concat ", " e];
717+
Open
718+
end)
719+
(finfo#get_summary#get_parameter_for_register reg))
597720
~error:(fun e ->
598721
begin
599722
log_error_result

‎CodeHawk/CHB/bchlib/bCHFunctionSummary.ml‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
Copyright (c) 2005-2020 Kestrel Technology LLC
88
Copyright (c) 2020 Henny Sipma
9-
Copyright (c) 2021-2025 Aarno Labs LLC
9+
Copyright (c) 2021-2026 Aarno Labs LLC
1010
1111
Permission is hereby granted, free of charge, to any person obtaining a copy
1212
of this software and associated documentation files (the "Software"), to deal
@@ -33,6 +33,7 @@ open CHPretty
3333
(* chutil *)
3434
open CHLogger
3535
open CHPrettyUtil
36+
open CHTraceResult
3637
open CHXmlDocument
3738
open CHXmlReader
3839

@@ -47,6 +48,9 @@ open BCHFunctionSemantics
4748
open BCHLibTypes
4849

4950

51+
let eloc (line: int): string = __FILE__ ^ ":" ^ (string_of_int line)
52+
let elocm (line: int): string = (eloc line) ^ ": "
53+
5054
let raise_xml_error (node:xml_element_int) (msg:pretty_t) =
5155
let error_msg =
5256
LBLOCK [
@@ -137,14 +141,16 @@ object (self:'a)
137141

138142
method get_parameters = get_fts_parameters self#get_function_interface
139143

140-
method get_parameter_for_register (reg: register_t): fts_parameter_t =
144+
(* This operation may fail in the first few analysis rounds if the parameter
145+
is a variadic parameter and the full signature has not been constructed
146+
from the format string.*)
147+
method get_parameter_for_register (reg: register_t): fts_parameter_t traceresult =
141148
let rpar = get_register_parameter_for_register self#get_function_interface reg in
142149
match rpar with
143-
| Some p -> p
150+
| Some p -> Ok p
144151
| _ ->
145-
raise
146-
(BCH_failure
147-
(LBLOCK [STR "Internal error: get_parameter_for_register"]))
152+
Error [(elocm __LINE__)
153+
^ "get_parameter_for_register: " ^ (register_to_string reg)]
148154

149155
method has_parameter_for_register (reg: register_t): bool =
150156
Option.is_some

‎CodeHawk/CHB/bchlib/bCHLibTypes.mli‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2547,7 +2547,7 @@ object ('a)
25472547

25482548
method get_parameters: fts_parameter_t list
25492549

2550-
method get_parameter_for_register: register_t -> fts_parameter_t
2550+
method get_parameter_for_register: register_t -> fts_parameter_t traceresult
25512551

25522552
method has_parameter_for_register: register_t -> bool
25532553

‎CodeHawk/CHB/bchlib/bCHVersion.ml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ end
9595

9696

9797
let version = new version_info_t
98-
~version:"0.6.0_20260622"
99-
~date:"2026-06-22"
98+
~version:"0.6.0_20260625"
99+
~date:"2026-06-25"
100100
~licensee: None
101101
~maxfilesize: None
102102
()

0 commit comments

Comments
 (0)