FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
codeql/python/ql/src/Resources/FileOpen.qll at codeql-cli/v2.27.1 · github/codeql · GitHub
github
codeql
Repository navigation
Code
Issues
1k
(1k)
Pull requests
487
(487)
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
codeql
/
python
/
ql
/
src
/
Resources
/
FileOpen.qll
Copy path
More file actions
More file actions
Latest commit
History
History
History
163 lines (148 loc) · 5.2 KB
Breadcrumbs
codeql
/
python
/
ql
/
src
/
Resources
/
FileOpen.qll
Copy path
File metadata and controls
163 lines (148 loc) · 5.2 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
/**
* DEPRECATED: Use FileNotAlwaysClosedQuery instead.
* Contains predicates concerning when and where files are opened and closed.
*/
deprecated
module
;
import
python
import
semmle.python.pointsto.Filters
/** Holds if `open` is a call that returns a newly opened file */
predicate
call_to_open
(
ControlFlowNode
open
)
{
exists
(
FunctionValue
f
|
function_opens_file
(
f
)
and
f
.
getACall
(
)
=
open
)
and
/* If in `with` statement, then it will be automatically closed. So just treat as not opened */
not
exists
(
With
w
|
w
.
getContextExpr
(
)
=
open
.
getNode
(
)
)
}
/** Holds if `n` refers to a file opened at `open` */
predicate
expr_is_open
(
ControlFlowNode
n
,
ControlFlowNode
open
)
{
call_to_open
(
open
)
and
open
=
n
or
exists
(
EssaVariable
v
|
n
instanceof
NameNode
and
var_is_open
(
v
,
open
)
|
n
=
v
.
getAUse
(
)
or
wraps_file
(
n
,
v
)
)
}
/** Holds if `call` wraps the object referred to by `v` and returns it */
private
predicate
wraps_file
(
CallNode
call
,
EssaVariable
v
)
{
exists
(
ClassValue
cls
|
call
=
cls
.
getACall
(
)
and
call
.
getAnArg
(
)
=
v
.
getAUse
(
)
)
}
/** Holds if `var` refers to a file opened at `open` */
predicate
var_is_open
(
EssaVariable
v
,
ControlFlowNode
open
)
{
def_is_open
(
v
.
getDefinition
(
)
,
open
)
and
/* If use in context expression in `with` statement, then it will be automatically closed. */
not
exists
(
With
w
|
w
.
getContextExpr
(
)
=
v
.
getAUse
(
)
.
getNode
(
)
)
}
/** Holds if `test` will pass through an open file in variable `v` for the `sense` successor */
predicate
passes_open_files
(
Variable
v
,
ControlFlowNode
test
,
boolean
sense
)
{
// `if fd.closed:`
exists
(
AttrNode
closed
|
closed
=
test
and
closed
.
getObject
(
"closed"
)
=
v
.
getAUse
(
)
)
and
sense
=
false
or
// `if fd ==/is ...:` most commonly `if fd is None:`
equality_test
(
test
,
v
.
getAUse
(
)
,
sense
.
booleanNot
(
)
,
_
)
or
// `if fd:`
test
=
v
.
getAUse
(
)
and
sense
=
true
or
exists
(
UnaryExprNode
n
|
n
=
test
and
n
.
getNode
(
)
.
getOp
(
)
instanceof
Not
|
passes_open_files
(
v
,
n
.
getOperand
(
)
,
sense
.
booleanNot
(
)
)
)
}
// Helper for `def_is_open` to give better join order
private
predicate
passes_open_files
(
PyEdgeRefinement
refinement
)
{
passes_open_files
(
refinement
.
getSourceVariable
(
)
,
refinement
.
getPredecessor
(
)
.
getLastNode
(
)
,
refinement
.
getSense
(
)
)
}
/** Holds if `def` refers to a file opened at `open` */
predicate
def_is_open
(
EssaDefinition
def
,
ControlFlowNode
open
)
{
expr_is_open
(
def
.
(
AssignmentDefinition
)
.
getValue
(
)
,
open
)
or
exists
(
PyEdgeRefinement
refinement
|
refinement
=
def
|
var_is_open
(
refinement
.
getInput
(
)
,
open
)
and
passes_open_files
(
refinement
)
)
or
exists
(
EssaNodeRefinement
refinement
|
refinement
=
def
|
not
closes_file
(
def
)
and
not
wraps_file
(
refinement
.
getDefiningNode
(
)
,
refinement
.
getInput
(
)
)
and
var_is_open
(
refinement
.
getInput
(
)
,
open
)
)
or
var_is_open
(
def
.
(
PhiFunction
)
.
getAnInput
(
)
,
open
)
}
/** Holds if `call` closes a file */
predicate
closes_file
(
EssaNodeRefinement
call
)
{
closes_arg
(
call
.
(
ArgumentRefinement
)
.
getDefiningNode
(
)
,
call
.
getSourceVariable
(
)
)
or
close_method_call
(
call
.
(
MethodCallsiteRefinement
)
.
getCall
(
)
,
call
.
getSourceVariable
(
)
.
(
Variable
)
.
getAUse
(
)
)
}
/** Holds if `call` closes its argument, which is an open file referred to by `v` */
predicate
closes_arg
(
CallNode
call
,
Variable
v
)
{
call
.
getAnArg
(
)
=
v
.
getAUse
(
)
and
(
exists
(
FunctionValue
close
|
call
=
close
.
getACall
(
)
and
function_closes_file
(
close
)
)
or
call
.
getFunction
(
)
.
(
NameNode
)
.
getId
(
)
=
"close"
)
}
/** Holds if `call` closes its 'self' argument, which is an open file referred to by `v` */
predicate
close_method_call
(
CallNode
call
,
ControlFlowNode
self
)
{
call
.
getFunction
(
)
.
(
AttrNode
)
.
getObject
(
)
=
self
and
exists
(
FunctionValue
close
|
call
=
close
.
getACall
(
)
and
function_closes_file
(
close
)
)
or
call
.
getFunction
(
)
.
(
AttrNode
)
.
getObject
(
"close"
)
=
self
}
/** Holds if `close` is a function that appears to close files that are passed to it as an argument. */
predicate
function_closes_file
(
FunctionValue
close
)
{
close
=
Value
::
named
(
"os.close"
)
or
function_should_close_parameter
(
close
.
getScope
(
)
)
}
/** INTERNAL - Helper predicate for `function_closes_file` */
predicate
function_should_close_parameter
(
Function
func
)
{
exists
(
EssaDefinition
def
|
closes_file
(
def
)
and
def
.
getSourceVariable
(
)
.
(
Variable
)
.
getScope
(
)
=
func
)
}
/** Holds if the function `f` opens a file, either directly or indirectly. */
predicate
function_opens_file
(
FunctionValue
f
)
{
f
=
Value
::
named
(
"open"
)
or
exists
(
EssaVariable
v
,
Return
ret
|
ret
.
getScope
(
)
=
f
.
getScope
(
)
|
v
.
getNode
(
)
=
ret
.
getValue
(
)
.
getAUse
(
)
and
var_is_open
(
v
,
_
)
)
or
exists
(
Return
ret
,
FunctionValue
callee
|
ret
.
getScope
(
)
=
f
.
getScope
(
)
|
callee
.
getNode
(
)
=
ret
.
getValue
(
)
.
getACall
(
)
and
function_opens_file
(
callee
)
)
}
/** Holds if the variable `v` refers to a file opened at `open` which is subsequently returned from a function. */
predicate
file_is_returned
(
EssaVariable
v
,
ControlFlowNode
open
)
{
exists
(
NameNode
n
,
Return
ret
|
var_is_open
(
v
,
open
)
and
v
.
getAUse
(
)
=
n
|
ret
.
getValue
(
)
=
n
.
getNode
(
)
or
ret
.
getValue
(
)
.
(
Tuple
)
.
getAnElt
(
)
=
n
.
getNode
(
)
or
ret
.
getValue
(
)
.
(
List
)
.
getAnElt
(
)
=
n
.
getNode
(
)
)
}
Back
|
FazBrowse Home
|
New Git URL