-
Notifications
You must be signed in to change notification settings - Fork 9
/
test_traces.py
362 lines (290 loc) · 17.2 KB
/
test_traces.py
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
# Unless explicitly stated otherwise all files in this repository are licensed under the the Apache License Version 2.0.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2021 Datadog, Inc.
import pytest
from tests.constants import PYTHON_RELEASE_PUBLIC_BETA, PYTHON_RELEASE_GA_1_1
from utils import (
weblog,
bug,
context,
coverage,
interfaces,
irrelevant,
released,
rfc,
missing_feature,
scenarios,
)
if context.library == "cpp":
pytestmark = pytest.mark.skip("not relevant")
RUNTIME_FAMILIES = ["nodejs", "ruby", "jvm", "dotnet", "go", "php", "python"]
@released(golang="1.37.0" if context.weblog_variant == "gin" else "1.36.0")
@released(dotnet="1.29.0", java="0.92.0", python="1.1.0rc2.dev")
@released(nodejs="2.0.0", php_appsec="0.1.0", ruby="0.54.2")
@bug(library="python@1.1.0", reason="a PR was not included in the release")
@missing_feature(weblog_variant="akka-http", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-payara", reason="No AppSec support")
@missing_feature(context.weblog_variant == "spring-boot-3-native", reason="GraalVM. Tracing support only")
@coverage.good
class Test_RetainTraces:
"""Retain trace (manual keep & appsec.event = true)"""
def setup_appsec_event_span_tags(self):
"""Send a bunch of attack, to be sure that something is done on AppSec side"""
weblog.get("/waf", params={"key": "\n :"}) # rules.http_protocol_violation.crs_921_160
weblog.get("/waf", headers={"random-key": "acunetix-user-agreement"}) # rules.security_scanner.crs_913_110
self.r = weblog.get("/waf/", headers={"User-Agent": "Arachni/v1"})
def test_appsec_event_span_tags(self):
"""
Spans with AppSec events should have the general AppSec span tags, along with the appsec.event and
_sampling_priority_v1 tags
"""
def validate_appsec_event_span_tags(span):
if span.get("parent_id") not in (0, None): # do nothing if not root span
return
if "appsec.event" not in span["meta"]:
raise Exception("Can't find appsec.event in span's meta")
if span["meta"]["appsec.event"] != "true":
raise Exception(f'appsec.event in span\'s meta should be "true", not {span["meta"]["appsec.event"]}')
if "_sampling_priority_v1" not in span["metrics"]:
raise Exception("Metric _sampling_priority_v1 should be set on traces that are manually kept")
MANUAL_KEEP = 2
if span["metrics"]["_sampling_priority_v1"] != MANUAL_KEEP:
raise Exception(f"Trace id {span['trace_id']} , sampling priority should be {MANUAL_KEEP}")
return True
interfaces.library.validate_spans(self.r, validate_appsec_event_span_tags)
@released(golang="1.37.0" if context.weblog_variant == "gin" else "1.36.0")
@released(dotnet="1.29.0", java="0.104.0", nodejs="2.0.0")
@released(php_appsec="0.1.0", python="0.58.5", ruby="0.54.2")
@missing_feature(weblog_variant="akka-http", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-payara", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-3-native", reason="GraalVM. Tracing support only")
@coverage.good
class Test_AppSecEventSpanTags:
"""AppSec correctly fill span tags."""
def setup_custom_span_tags(self):
weblog.get("/waf", params={"key": "\n :"}) # rules.http_protocol_violation.crs_921_160
weblog.get("/waf", headers={"random-key": "acunetix-user-agreement"}) # rules.security_scanner.crs_913_110
def test_custom_span_tags(self):
"""AppSec should store in all APM spans some tags when enabled."""
def validate_custom_span_tags(span):
if span.get("type") != "web":
return
if span.get("parent_id") not in (0, None): # do nothing if not root span
return
if "_dd.appsec.enabled" not in span["metrics"]:
raise Exception("Can't find _dd.appsec.enabled in span's metrics")
if "_dd.runtime_family" not in span["meta"]:
raise Exception("Can't find _dd.runtime_family in span's meta")
if span["metrics"]["_dd.appsec.enabled"] != 1:
raise Exception(
"_dd.appsec.enabled in span's metrics should be 1 or 1.0, "
f'not {span["metrics"]["_dd.appsec.enabled"]}'
)
if span["meta"]["_dd.runtime_family"] not in RUNTIME_FAMILIES:
raise Exception(f"_dd.runtime_family {span['_dd.runtime_family']}, should be in {RUNTIME_FAMILIES}")
return True
interfaces.library.validate_spans(validator=validate_custom_span_tags)
def setup_header_collection(self):
self.r = weblog.get("/headers", headers={"User-Agent": "Arachni/v1", "Content-Type": "text/plain"})
@bug(context.library < f"python@{PYTHON_RELEASE_GA_1_1}", reason="a PR was not included in the release")
@bug(context.library < "java@1.2.0", weblog_variant="spring-boot-openliberty", reason="APPSEC-6734")
@irrelevant(context.library not in ["golang", "nodejs", "java", "dotnet"], reason="test")
def test_header_collection(self):
"""
AppSec should collect some headers for http.request and http.response and store them in span tags.
Note that this test checks for collection, not data.
"""
def assertHeaderInSpanMeta(span, header):
if header not in span["meta"]:
raise Exception(f"Can't find {header} in span's meta")
def validate_request_headers(span):
for header in ["user-agent", "host", "content-type"]:
assertHeaderInSpanMeta(span, f"http.request.headers.{header}")
return True
def validate_response_headers(span):
for header in ["content-type", "content-length", "content-language"]:
assertHeaderInSpanMeta(span, f"http.response.headers.{header}")
return True
interfaces.library.validate_spans(self.r, validate_request_headers)
interfaces.library.validate_spans(self.r, validate_response_headers)
@bug(context.library < "java@0.93.0")
def test_root_span_coherence(self):
"""Appsec tags are not on span where type is not web"""
def validator(span):
if (
span.get("type") not in ["web", "http", "rpc"]
and "metrics" in span
and "_dd.appsec.enabled" in span["metrics"]
):
raise Exception("_dd.appsec.enabled should be present only when span type is web")
if (
span.get("type") not in ["web", "http", "rpc"]
and "meta" in span
and "_dd.runtime_family" in span["meta"]
):
raise Exception("_dd.runtime_family should be present only when span type is web")
return True
interfaces.library.validate_spans(validator=validator)
@rfc("https://datadoghq.atlassian.net/wiki/spaces/APS/pages/2365948382/Sensitive+Data+Obfuscation")
@released(golang="1.38.0", dotnet="2.7.0", java="0.113.0", nodejs="2.6.0")
@released(php_appsec="0.3.0", python=PYTHON_RELEASE_GA_1_1, ruby="1.0.0")
@missing_feature(weblog_variant="akka-http", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-payara", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-3-native", reason="GraalVM. Tracing support only")
@coverage.good
class Test_AppSecObfuscator:
"""AppSec obfuscates sensitive data."""
SECRET_VALUE_WITH_SENSITIVE_KEY = "this-is-a-very-secret-value-having-the-attack"
SECRET_VALUE_WITH_NON_SENSITIVE_KEY = "not-a-sensitive-cookie-value-having-an-select-pg_sleep-attack"
VALUE_WITH_SECRET = "BEARER lwqjedqwdoqwidmoqwndun32i"
SECRET_VALUE_WITH_SENSITIVE_KEY_CUSTOM = "this-is-a-very-sensitive-cookie-value-having-the-aaaa-attack"
SECRET_VALUE_WITH_NON_SENSITIVE_KEY_CUSTOM = "not-a-sensitive-cookie-value-having-an-bbbb-attack"
def setup_appsec_obfuscator_key(self):
self.r_key = weblog.get(
"/waf/",
headers={"Http-Api-Token": f"{self.SECRET_VALUE_WITH_SENSITIVE_KEY} acunetix-product"},
params={"pwd": f"{self.SECRET_VALUE_WITH_SENSITIVE_KEY} select pg_sleep"},
)
def test_appsec_obfuscator_key(self):
"""General obfuscation test of several attacks on several rule addresses."""
# Validate that the AppSec events do not contain the following secret value.
# Note that this value must contain an attack pattern in order to be part of the security event data
# that is expected to be obfuscated.
def validate_appsec_span_tags(span, appsec_data):
if self.SECRET_VALUE_WITH_SENSITIVE_KEY in span["meta"]["_dd.appsec.json"]:
raise Exception("The security events contain the secret value that should be obfuscated")
return True
interfaces.library.assert_waf_attack(self.r_key, address="server.request.headers.no_cookies")
interfaces.library.assert_waf_attack(self.r_key, address="server.request.query")
interfaces.library.validate_appsec(self.r_key, validate_appsec_span_tags)
def setup_appsec_obfuscator_cookies(self):
cookies = {"Bearer": self.SECRET_VALUE_WITH_SENSITIVE_KEY, "Good": self.SECRET_VALUE_WITH_NON_SENSITIVE_KEY}
self.r_cookies = weblog.get("/waf/", cookies=cookies)
@missing_feature(library="java")
@irrelevant(context.appsec_rules_version >= "1.2.7", reason="cookies were disabled for the time being")
def test_appsec_obfuscator_cookies(self):
"""
Specific obfuscation test for the cookies which often contain sensitive data and are
expected to be properly obfuscated on sensitive cookies only.
"""
# Validate that the AppSec events do not contain the following secret value.
# Note that this value must contain an attack pattern in order to be part of the security event data
# that is expected to be obfuscated.
def validate_appsec_span_tags(span, appsec_data):
if self.SECRET_VALUE_WITH_SENSITIVE_KEY in span["meta"]["_dd.appsec.json"]:
raise Exception("The security events contain the secret value that should be obfuscated")
if self.SECRET_VALUE_WITH_NON_SENSITIVE_KEY not in span["meta"]["_dd.appsec.json"]:
raise Exception("Could not find the non-sensitive cookie data")
return True
interfaces.library.assert_waf_attack(self.r_cookies, address="server.request.cookies")
interfaces.library.validate_appsec(self.r_cookies, validate_appsec_span_tags)
def setup_appsec_obfuscator_value(self):
sensitive_raw_payload = r"""{
"activeTab":"39612314-1890-45f7-8075-c793325c1d70",'
"allOpenTabs":["132ef2e5-afaa-4e20-bc64-db9b13230a","39612314-1890-45f7-8075-c793325c1d70"],
"lastPage":{
"accessToken":"BEARER lwqjedqwdoqwidmoqwndun32i",
"account":{
"name":"F123123",
"contactCustomFields":{
"ffa77959-1ff3-464b-a3af-e5410e436f1f":{
"questionServiceEntityType":"CustomField",
"question":{
"code":"Manager Name",
"questionTypeInfo":{
"questionType":"OpenEndedText",
"answerFormatType":"General"
,"scores":[]
},
"additionalInfo":{
"codeSnippetValue":"<script>alert(xss)</script>"
}
}
}
}
}
}"""
self.r_value = weblog.get(
"/waf/",
headers={"my-header": f"password={self.VALUE_WITH_SECRET} acunetix-product"},
params={"payload": sensitive_raw_payload},
)
@missing_feature(library="java")
def test_appsec_obfuscator_value(self):
"""Obfuscation test of a matching rule parameter value containing a sensitive keyword."""
# Validate that the AppSec event do not contain VALUE_WITH_SECRET value.
# The following payload will be sent as a raw encoded string via the request params
# and matches an XSS attack. It contains an access token secret we shouldn't have in the event.
def validate_appsec_span_tags(span, appsec_data):
if self.VALUE_WITH_SECRET in span["meta"]["_dd.appsec.json"]:
raise Exception("The security events contain the secret value that should be obfuscated")
return True
interfaces.library.assert_waf_attack(self.r_value, address="server.request.headers.no_cookies")
interfaces.library.assert_waf_attack(self.r_value, address="server.request.query")
interfaces.library.validate_appsec(self.r_value, validate_appsec_span_tags)
def setup_appsec_obfuscator_key_with_custom_rules(self):
self.r_custom = weblog.get(
"/waf/",
cookies={"Bearer": f"{self.SECRET_VALUE_WITH_SENSITIVE_KEY}aaaa"},
params={"pwd": f'{self.SECRET_VALUE_WITH_SENSITIVE_KEY} o:3:"d":3:{{}}'},
)
@scenarios.appsec_custom_rules
def test_appsec_obfuscator_key_with_custom_rules(self):
"""General obfuscation test of several attacks on several rule addresses."""
# Validate that the AppSec events do not contain the following secret value.
# Note that this value must contain an attack pattern in order to be part of the security event data
# that is expected to be obfuscated.
def validate_appsec_span_tags(span, appsec_data): # pylint: disable=unused-argument
if self.SECRET_VALUE_WITH_SENSITIVE_KEY in span["meta"]["_dd.appsec.json"]:
raise Exception("The security events contain the secret value that should be obfuscated")
return True
interfaces.library.assert_waf_attack(self.r_custom, address="server.request.cookies")
interfaces.library.assert_waf_attack(self.r_custom, address="server.request.query")
interfaces.library.validate_appsec(self.r_custom, validate_appsec_span_tags)
def setup_appsec_obfuscator_cookies_with_custom_rules(self):
cookies = {
"Bearer": self.SECRET_VALUE_WITH_SENSITIVE_KEY_CUSTOM,
"Good": self.SECRET_VALUE_WITH_NON_SENSITIVE_KEY_CUSTOM,
}
self.r_cookies_custom = weblog.get("/waf/", cookies=cookies)
@scenarios.appsec_custom_rules
def test_appsec_obfuscator_cookies_with_custom_rules(self):
"""
Specific obfuscation test for the cookies which often contain sensitive data and are
expected to be properly obfuscated on sensitive cookies only.
"""
# Validate that the AppSec events do not contain the following secret value.
# Note that this value must contain an attack pattern in order to be part of the security event data
# that is expected to be obfuscated.
def validate_appsec_span_tags(span, appsec_data): # pylint: disable=unused-argument
if self.SECRET_VALUE_WITH_SENSITIVE_KEY_CUSTOM in span["meta"]["_dd.appsec.json"]:
raise Exception("The security events contain the secret value that should be obfuscated")
if self.SECRET_VALUE_WITH_NON_SENSITIVE_KEY_CUSTOM not in span["meta"]["_dd.appsec.json"]:
raise Exception("Could not find the non-sensitive cookie data")
return True
interfaces.library.assert_waf_attack(self.r_cookies_custom, address="server.request.cookies")
interfaces.library.validate_appsec(self.r_cookies_custom, validate_appsec_span_tags)
@rfc("https://datadoghq.atlassian.net/wiki/spaces/APS/pages/2186870984/HTTP+header+collection")
@released(dotnet="2.5.1", php_appsec="0.2.2", python=PYTHON_RELEASE_PUBLIC_BETA, ruby="1.0.0.beta1")
@released(golang="1.37.0" if context.weblog_variant == "gin" else "1.36.2")
@released(nodejs="2.0.0", java="0.102.0")
@missing_feature(weblog_variant="akka-http", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-payara", reason="No AppSec support")
@missing_feature(weblog_variant="spring-boot-3-native", reason="GraalVM. Tracing support only")
@coverage.good
class Test_CollectRespondHeaders:
"""AppSec should collect some headers for http.response and store them in span tags."""
def setup_header_collection(self):
self.r = weblog.get("/headers", headers={"User-Agent": "Arachni/v1", "Content-Type": "text/plain"})
def test_header_collection(self):
def assertHeaderInSpanMeta(span, header):
if header not in span["meta"]:
raise Exception(f"Can't find {header} in span's meta")
def validate_response_headers(span):
for header in ["content-type", "content-length", "content-language"]:
assertHeaderInSpanMeta(span, f"http.response.headers.{header}")
return True
interfaces.library.validate_spans(self.r, validate_response_headers)
@coverage.not_implemented
class Test_DistributedTraceInfo:
"""Distributed traces info (Services, URL, trace id)"""