Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
codeql-jupyter-kernel/codeql_kernel/codeql.py at main · GitHubSecurityLab/codeql-jupyter-kernel · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
GitHubSecurityLab
/
codeql-jupyter-kernel
Public
Notifications
You must be signed in to change notification settings
Fork
1
Star
15
Code
Issues
0
Pull requests
4
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
codeql-jupyter-kernel
/
codeql_kernel
/
codeql.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
220 lines (190 loc) · 7.27 KB
main
Breadcrumbs
codeql-jupyter-kernel
/
codeql_kernel
/
codeql.py
Copy path
Top
File metadata and controls
Code
Blame
220 lines (190 loc) · 7.27 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
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
import
logging
import
os
import
tempfile
import
time
from
subprocess
import
PIPE
,
Popen
from
typing
import
Optional
,
Tuple
from
.
jsonrpc
import
RPC
as
JSONRPC
from
.
rawrpc
import
RPC
as
RawRPC
class
CLIClient
:
"""
Represents a JSONRPC client to connect to CodeQL CLI Server
"""
def
__init__
(
self
):
self
.
cache
=
{
"ram"
: []}
self
.
conn
=
RawRPC
(
[
"codeql"
,
"execute"
,
"cli-server"
,
"--logdir"
,
"/tmp/codeql_kernel_cliserver"
,
]
)
def
stop
(
self
):
self
.
conn
.
stop
()
def
resolve_ram
(
self
)
->
Tuple
[
Optional
[
str
],
Optional
[
list
]]:
if
self
.
cache
.
get
(
"ram"
):
return
(
None
,
self
.
cache
.
get
(
"ram"
))
else
:
cmd
=
[
"resolve"
,
"ram"
,
"--format=json"
]
(
err
,
result
)
=
self
.
conn
.
request
(
cmd
)
if
err
:
return
(
err
,
None
)
self
.
cache
[
"ram"
]
=
[
x
for
x
in
result
if
x
.
startswith
(
"-J"
)]
return
(
None
,
self
.
cache
.
get
(
"ram"
))
def
resolve_metadata
(
self
,
query
)
->
Tuple
[
Optional
[
str
],
dict
]:
cmd
=
[
"resolve"
,
"metadata"
,
"--format=json"
,
query
]
return
self
.
conn
.
request
(
cmd
)
def
resolve_database
(
self
,
db_path
)
->
Tuple
[
Optional
[
str
],
dict
]:
cmd
=
[
"resolve"
,
"database"
,
"--format=json"
,
db_path
]
return
self
.
conn
.
request
(
cmd
)
def
resolve_library_path
(
self
,
query
)
->
Tuple
[
Optional
[
str
],
Optional
[
dict
]]:
cmd
=
[
"resolve"
,
"library-path"
,
"--format=json"
,
"--query"
,
query
]
return
self
.
conn
.
request
(
cmd
)
def
bqrs_info
(
self
,
bqrs_path
)
->
Tuple
[
Optional
[
str
],
dict
]:
cmd
=
[
"bqrs"
,
"info"
,
"--format=json"
,
bqrs_path
]
return
self
.
conn
.
request
(
cmd
)
def
bqrs_decode
(
self
,
bqrs_path
)
->
Tuple
[
Optional
[
str
],
Optional
[
str
]]:
(
err
,
ram_opts
)
=
self
.
resolve_ram
()
if
err
or
not
ram_opts
:
return
(
f"Error resolving ram options
{
err
}
"
,
None
)
results_path
=
tempfile
.
NamedTemporaryFile
(
delete
=
False
)
cmd
=
[
"bqrs"
,
"decode"
,
"--format=csv"
,
f"-o=
{
results_path
.
name
}
"
,
"--entities=string,url"
,
bqrs_path
,
]
cmd
.
extend
(
ram_opts
)
(
err
,
_
)
=
self
.
conn
.
request
(
cmd
)
if
err
:
return
(
f"Error decoding bqrs file
{
err
}
"
,
None
)
if
os
.
path
.
exists
(
results_path
.
name
):
with
open
(
results_path
.
name
,
"r"
)
as
f
:
data
=
f
.
read
()
# return json.loads(data)
return
(
None
,
data
)
else
:
return
(
"Error decoding results"
,
None
)
class
QueryClient
:
"""
Represents a JSONRPC client to connect to CodeQL Query Server
"""
def
__init__
(
self
,
on_progress
=
None
,
on_result
=
None
):
self
.
_cli_client
:
CLIClient
=
CLIClient
()
cmd
=
[
"codeql"
,
"execute"
,
"query-server2"
,
"--threads=0"
,
"--evaluator-log-level"
,
"5"
]
# debug
# cmd.extend(["--debug", "--tuple-counting", "-v", "--log-to-stderr"])
# --save-cache --max-disk-cache XX
(
err
,
ram_opts
)
=
self
.
_cli_client
.
resolve_ram
()
if
err
or
not
ram_opts
:
return
(
f"Error resolving ram options
{
err
}
"
,
None
)
cmd
.
extend
(
ram_opts
)
self
.
_proc
=
Popen
(
cmd
,
stdin
=
PIPE
,
stdout
=
PIPE
,
stderr
=
PIPE
)
handlers
=
{}
if
on_progress
:
handlers
[
"ql/progressUpdated"
]
=
on_progress
self
.
_conn
=
JSONRPC
(
handlers
=
handlers
,
stdout
=
self
.
_proc
.
stdin
,
stdin
=
self
.
_proc
.
stdout
)
self
.
_progress_id
=
0
self
.
_evaluate_id
=
0
self
.
_db_metadata
=
{}
# TODO: wait for query server to be ready
time
.
sleep
(
2
)
def
stop
(
self
):
if
self
.
_proc
.
stdin
:
self
.
_proc
.
stdin
.
close
()
if
self
.
_proc
.
stdout
:
self
.
_proc
.
stdout
.
close
()
self
.
_proc
.
terminate
()
self
.
_proc
.
wait
()
if
self
.
_cli_client
:
self
.
_cli_client
.
stop
()
def
next_progress_id
(
self
)
->
int
:
self
.
_progress_id
+=
1
return
self
.
_progress_id
def
next_evaluate_id
(
self
)
->
int
:
self
.
_evaluate_id
+=
1
return
self
.
_evaluate_id
def
register_database
(
self
,
db_path
)
->
Optional
[
str
]:
"""
Register a database with the query server
"""
if
not
db_path
.
endswith
(
"/"
):
db_path
=
db_path
+
"/"
if
not
os
.
path
.
isdir
(
db_path
):
return
f"Database path
{
db_path
}
is not a directory"
(
err
,
db_metadata
)
=
self
.
_cli_client
.
resolve_database
(
db_path
)
if
err
:
return
"Failed to resolve database metadata"
# TODO: implement on-the-fly query patching
params
=
{
"body"
: {
"databases"
: [
db_path
],
"progressId"
:
self
.
next_progress_id
(),
}
}
(
err
,
_
)
=
self
.
_conn
.
request
(
"evaluation/registerDatabases"
,
args
=
params
)
if
err
:
return
err
self
.
_db_metadata
=
db_metadata
self
.
_db_metadata
[
"path"
]
=
db_path
return
None
def
run_query
(
self
,
query_path
,
quick_eval
=
{}
)
->
Tuple
[
Optional
[
str
],
Optional
[
str
]]:
logging
.
info
(
f"Running query
{
query_path
}
"
)
bqrs_path
=
tempfile
.
NamedTemporaryFile
(
suffix
=
".bqrs"
).
name
target
=
{
"query"
: {
"xx"
:
""
}}
if
bool
(
quick_eval
):
target
=
{
"quickEval"
: {
"quickEvalPos"
: {
"fileName"
:
query_path
,
"line"
:
quick_eval
.
get
(
"startLine"
),
"column"
:
quick_eval
.
get
(
"startColumn"
),
"endLine"
:
quick_eval
.
get
(
"endLine"
),
"endColumn"
:
quick_eval
.
get
(
"endColumn"
),
}
}
}
run_queries_params
=
{
"body"
: {
"db"
:
self
.
_db_metadata
[
"path"
],
# TODO: get additional packs from ENV, command, config, etc.
"additionalPacks"
: [
"/Users/pwntester/src/github.com/github/codeql"
],
"externalInputs"
: [],
"singletonExternalInputs"
: [],
# opts.templateValues or {},
"outputPath"
:
bqrs_path
,
"queryPath"
:
query_path
,
"target"
:
target
,
},
"progressId"
:
self
.
next_progress_id
(),
}
(
err
,
resp
)
=
self
.
_conn
.
request
(
"evaluation/runQuery"
,
args
=
run_queries_params
)
if
resp
and
resp
[
"resultType"
]
!=
0
:
return
(
resp
[
"message"
],
None
)
if
err
:
return
(
str
(
err
),
None
)
if
os
.
path
.
exists
(
bqrs_path
):
(
err
,
bqrs_info
)
=
self
.
_cli_client
.
bqrs_info
(
bqrs_path
)
if
err
:
return
(
err
,
""
)
if
not
bqrs_info
or
not
bqrs_info
[
"result-sets"
]:
return
(
"Failed to get bqrs info"
,
""
)
count
=
bqrs_info
[
"result-sets"
][
0
][
"rows"
]
for
result_set
in
bqrs_info
[
"result-sets"
]:
if
result_set
[
"name"
]
==
"#select"
:
count
=
result_set
[
"rows"
]
if
count
>
0
:
return
self
.
_cli_client
.
bqrs_decode
(
bqrs_path
)
else
:
return
(
None
,
"No results"
)
else
:
return
(
f"Failed to find results file at
{
bqrs_path
}
"
,
""
)
You can’t perform that action at this time.