Extract Jersey json body response schemas #9014
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jandro996
added
type: enhancement
inst: jax-ws
jandro996
force-pushed
the
alejandro.gonzalez/api-sec-jersey-response-schema
branch
from
3c78ad2 to
2aeb457
Compare
BenchmarksStartupParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 46 metrics, 7 unstable metrics. Startup time reports for petclinicgantt
title petclinic - global startup overhead: candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (996.872 ms) : 0, 996872
Total [baseline] (10.757 s) : 0, 10757453
Agent [candidate] (1.007 s) : 0, 1006639
Total [candidate] (10.805 s) : 0, 10804755
section appsec
Agent [baseline] (1.179 s) : 0, 1178967
Total [baseline] (10.733 s) : 0, 10733008
Agent [candidate] (1.184 s) : 0, 1183971
Total [candidate] (10.764 s) : 0, 10764402
section iast
Agent [baseline] (1.135 s) : 0, 1134796
Total [baseline] (10.866 s) : 0, 10866444
Agent [candidate] (1.142 s) : 0, 1141875
Total [candidate] (10.906 s) : 0, 10906488
section profiling
Agent [baseline] (1.244 s) : 0, 1244140
Total [baseline] (11.056 s) : 0, 11055753
Agent [candidate] (1.254 s) : 0, 1254436
Total [candidate] (10.983 s) : 0, 10982889
gantt
title petclinic - break down per module: candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (687.889 ms) : 0, 687889
BytebuddyAgent [candidate] (694.806 ms) : 0, 694806
GlobalTracer [baseline] (242.975 ms) : 0, 242975
GlobalTracer [candidate] (244.964 ms) : 0, 244964
AppSec [baseline] (30.302 ms) : 0, 30302
AppSec [candidate] (30.775 ms) : 0, 30775
Debugger [baseline] (6.004 ms) : 0, 6004
Debugger [candidate] (6.141 ms) : 0, 6141
Remote Config [baseline] (663.794 µs) : 0, 664
Remote Config [candidate] (682.619 µs) : 0, 683
Telemetry [baseline] (8.201 ms) : 0, 8201
Telemetry [candidate] (8.315 ms) : 0, 8315
section appsec
BytebuddyAgent [baseline] (713.278 ms) : 0, 713278
BytebuddyAgent [candidate] (717.338 ms) : 0, 717338
GlobalTracer [baseline] (236.905 ms) : 0, 236905
GlobalTracer [candidate] (238.018 ms) : 0, 238018
AppSec [baseline] (171.061 ms) : 0, 171061
AppSec [candidate] (170.656 ms) : 0, 170656
Debugger [baseline] (5.807 ms) : 0, 5807
Debugger [candidate] (5.832 ms) : 0, 5832
Remote Config [baseline] (620.763 µs) : 0, 621
Remote Config [candidate] (611.506 µs) : 0, 612
Telemetry [baseline] (8.192 ms) : 0, 8192
Telemetry [candidate] (8.182 ms) : 0, 8182
IAST [baseline] (22.188 ms) : 0, 22188
IAST [candidate] (22.293 ms) : 0, 22293
section iast
BytebuddyAgent [baseline] (809.858 ms) : 0, 809858
BytebuddyAgent [candidate] (815.141 ms) : 0, 815141
GlobalTracer [baseline] (233.83 ms) : 0, 233830
GlobalTracer [candidate] (234.988 ms) : 0, 234988
AppSec [baseline] (29.558 ms) : 0, 29558
AppSec [candidate] (28.147 ms) : 0, 28147
Debugger [baseline] (5.797 ms) : 0, 5797
Debugger [candidate] (5.866 ms) : 0, 5866
Remote Config [baseline] (577.521 µs) : 0, 578
Remote Config [candidate] (581.743 µs) : 0, 582
Telemetry [baseline] (7.993 ms) : 0, 7993
Telemetry [candidate] (7.942 ms) : 0, 7942
IAST [baseline] (26.331 ms) : 0, 26331
IAST [candidate] (28.201 ms) : 0, 28201
section profiling
BytebuddyAgent [baseline] (677.85 ms) : 0, 677850
BytebuddyAgent [candidate] (683.71 ms) : 0, 683710
GlobalTracer [baseline] (361.638 ms) : 0, 361638
GlobalTracer [candidate] (364.327 ms) : 0, 364327
AppSec [baseline] (32.21 ms) : 0, 32210
AppSec [candidate] (31.869 ms) : 0, 31869
Debugger [baseline] (11.222 ms) : 0, 11222
Debugger [candidate] (13.078 ms) : 0, 13078
Remote Config [baseline] (661.982 µs) : 0, 662
Remote Config [candidate] (665.929 µs) : 0, 666
Telemetry [baseline] (8.801 ms) : 0, 8801
Telemetry [candidate] (8.088 ms) : 0, 8088
ProfilingAgent [baseline] (103.073 ms) : 0, 103073
ProfilingAgent [candidate] (104.005 ms) : 0, 104005
Profiling [baseline] (103.099 ms) : 0, 103099
Profiling [candidate] (104.031 ms) : 0, 104031
Startup time reports for insecure-bankgantt
title insecure-bank - global startup overhead: candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section tracing
Agent [baseline] (996.588 ms) : 0, 996588
Total [baseline] (8.538 s) : 0, 8538294
Agent [candidate] (1.007 s) : 0, 1006871
Total [candidate] (8.59 s) : 0, 8589894
section iast
Agent [baseline] (1.14 s) : 0, 1140169
Total [baseline] (9.25 s) : 0, 9249679
Agent [candidate] (1.136 s) : 0, 1135763
Total [candidate] (9.291 s) : 0, 9291419
gantt
title insecure-bank - break down per module: candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section tracing
BytebuddyAgent [baseline] (688.094 ms) : 0, 688094
BytebuddyAgent [candidate] (695.373 ms) : 0, 695373
GlobalTracer [baseline] (242.357 ms) : 0, 242357
GlobalTracer [candidate] (244.826 ms) : 0, 244826
AppSec [baseline] (30.399 ms) : 0, 30399
AppSec [candidate] (30.671 ms) : 0, 30671
Debugger [baseline] (6.037 ms) : 0, 6037
Debugger [candidate] (6.092 ms) : 0, 6092
Remote Config [baseline] (666.993 µs) : 0, 667
Remote Config [candidate] (686.574 µs) : 0, 687
Telemetry [baseline] (8.185 ms) : 0, 8185
Telemetry [candidate] (8.274 ms) : 0, 8274
section iast
BytebuddyAgent [baseline] (814.263 ms) : 0, 814263
BytebuddyAgent [candidate] (810.935 ms) : 0, 810935
GlobalTracer [baseline] (234.6 ms) : 0, 234600
GlobalTracer [candidate] (233.891 ms) : 0, 233891
AppSec [baseline] (27.203 ms) : 0, 27203
AppSec [candidate] (27.795 ms) : 0, 27795
Debugger [baseline] (5.84 ms) : 0, 5840
Debugger [candidate] (5.83 ms) : 0, 5830
Remote Config [baseline] (593.453 µs) : 0, 593
Remote Config [candidate] (585.976 µs) : 0, 586
Telemetry [baseline] (8.025 ms) : 0, 8025
Telemetry [candidate] (7.99 ms) : 0, 7990
IAST [baseline] (28.787 ms) : 0, 28787
IAST [candidate] (27.9 ms) : 0, 27900
LoadParameters
See matching parameters
SummaryFound 2 performance improvements and 1 performance regressions! Performance is the same for 9 metrics, 12 unstable metrics.
Request duration reports for petclinicgantt
title petclinic - request duration [CI 0.99] : candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section baseline
no_agent (38.393 ms) : 38093, 38694
. : milestone, 38393,
appsec (49.231 ms) : 48778, 49685
. : milestone, 49231,
code_origins (45.456 ms) : 45083, 45829
. : milestone, 45456,
iast (44.954 ms) : 44560, 45348
. : milestone, 44954,
profiling (47.884 ms) : 47385, 48383
. : milestone, 47884,
tracing (45.143 ms) : 44772, 45514
. : milestone, 45143,
section candidate
no_agent (37.761 ms) : 37461, 38062
. : milestone, 37761,
appsec (46.309 ms) : 45898, 46719
. : milestone, 46309,
code_origins (44.417 ms) : 44047, 44788
. : milestone, 44417,
iast (43.454 ms) : 43063, 43845
. : milestone, 43454,
profiling (47.287 ms) : 46810, 47764
. : milestone, 47287,
tracing (44.301 ms) : 43936, 44666
. : milestone, 44301,
Request duration reports for insecure-bankgantt
title insecure-bank - request duration [CI 0.99] : candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section baseline
no_agent (4.434 ms) : 4381, 4488
. : milestone, 4434,
iast (9.345 ms) : 9192, 9498
. : milestone, 9345,
iast_FULL (13.351 ms) : 13082, 13619
. : milestone, 13351,
iast_GLOBAL (9.739 ms) : 9566, 9912
. : milestone, 9739,
profiling (8.466 ms) : 8333, 8599
. : milestone, 8466,
tracing (7.561 ms) : 7452, 7669
. : milestone, 7561,
section candidate
no_agent (4.306 ms) : 4258, 4355
. : milestone, 4306,
iast (9.154 ms) : 9007, 9300
. : milestone, 9154,
iast_FULL (13.84 ms) : 13560, 14120
. : milestone, 13840,
iast_GLOBAL (10.211 ms) : 10031, 10390
. : milestone, 10211,
profiling (8.773 ms) : 8630, 8916
. : milestone, 8773,
tracing (7.809 ms) : 7696, 7922
. : milestone, 7809,
DacapoParameters
See matching parameters
SummaryFound 0 performance improvements and 0 performance regressions! Performance is the same for 12 metrics, 0 unstable metrics. Execution time for biojavagantt
title biojava - execution time [CI 0.99] : candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section baseline
no_agent (15.457 s) : 15457000, 15457000
. : milestone, 15457000,
appsec (14.88 s) : 14880000, 14880000
. : milestone, 14880000,
iast (18.629 s) : 18629000, 18629000
. : milestone, 18629000,
iast_GLOBAL (18.056 s) : 18056000, 18056000
. : milestone, 18056000,
profiling (15.872 s) : 15872000, 15872000
. : milestone, 15872000,
tracing (14.848 s) : 14848000, 14848000
. : milestone, 14848000,
section candidate
no_agent (15.272 s) : 15272000, 15272000
. : milestone, 15272000,
appsec (14.962 s) : 14962000, 14962000
. : milestone, 14962000,
iast (18.344 s) : 18344000, 18344000
. : milestone, 18344000,
iast_GLOBAL (18.395 s) : 18395000, 18395000
. : milestone, 18395000,
profiling (15.411 s) : 15411000, 15411000
. : milestone, 15411000,
tracing (14.69 s) : 14690000, 14690000
. : milestone, 14690000,
Execution time for tomcatgantt
title tomcat - execution time [CI 0.99] : candidate=1.51.0-SNAPSHOT~db61f58eaf6, baseline=1.51.0-SNAPSHOT~d6d3d210b1
dateFormat X
axisFormat %s
section baseline
no_agent (1.475 ms) : 1464, 1486
. : milestone, 1475,
appsec (2.412 ms) : 2362, 2461
. : milestone, 2412,
iast (2.196 ms) : 2134, 2258
. : milestone, 2196,
iast_GLOBAL (2.226 ms) : 2165, 2288
. : milestone, 2226,
profiling (2.041 ms) : 1991, 2091
. : milestone, 2041,
tracing (2.003 ms) : 1955, 2051
. : milestone, 2003,
section candidate
no_agent (1.475 ms) : 1463, 1486
. : milestone, 1475,
appsec (2.402 ms) : 2353, 2452
. : milestone, 2402,
iast (2.192 ms) : 2130, 2253
. : milestone, 2192,
iast_GLOBAL (2.236 ms) : 2174, 2299
. : milestone, 2236,
profiling (2.058 ms) : 2007, 2109
. : milestone, 2058,
tracing (2.007 ms) : 1959, 2056
. : milestone, 2007,
|
jandro996
changed the title
manuel-alvarez-alvarez
force-pushed
the
malvarez/vertx-response-extraction
branch
9 times, most recently
from
ac7c355 to
bd96ea3
Compare
jandro996
force-pushed
the
alejandro.gonzalez/api-sec-jersey-response-schema
branch
from
8e2219c to
db61f58
Compare
| } | ||
|
|
||
|
|
||
| void 'test response schema extraction'() { |
There was a problem hiding this comment.
Can you update the test to do assertions on the response body schema:
void 'test response schema extraction'() {
given:
def url = "http://localhost:${httpPort}/api_security/response"
def client = OkHttpUtils.clientBuilder().build()
def body = [
"main" : [["key": "id001", "value": 1345.67], ["value": 1567.89, "key": "id002"]],
"nullable": null,
]
def request = new Request.Builder()
.url(url)
.post(RequestBody.create(MediaType.get('application/json'), JsonOutput.toJson(body)))
.build()
when:
final response = client.newCall(request).execute()
waitForTraceCount(1)
then:
response.code() == 200
def span = rootSpans.first()
span.meta.containsKey('_dd.appsec.s.res.headers')
span.meta.containsKey('_dd.appsec.s.res.body')
final schema = new JsonSlurper().parse(unzip(span.meta.get('_dd.appsec.s.res.body')))
assert schema == [["main": [[[["key": [8], "value": [16]]]], ["len": 2]], "nullable": [1]]]
}
private static byte[] unzip(final String text) {
final inflaterStream = new GZIPInputStream(new ByteArrayInputStream(text.decodeBase64()))
return inflaterStream.getBytes()
}| response.code() == 200 | ||
| def span = rootSpans.first() | ||
| span.meta.containsKey('_dd.appsec.s.res.headers') | ||
| span.meta.containsKey('_dd.appsec.s.res.body') |
There was a problem hiding this comment.
Same comment as with jersey-2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Does This Do
Adds response body extraction for Jersey JSON endpoints to enable automatic API schema discovery and protection by the Web Application Firewall (WAF).
Motivation
Additional Notes
Contributor Checklist
type:and (comp:orinst:) labels in addition to any usefull labelsclose,fixor any linking keywords when referencing an issue.Use
solvesinstead, and assign the PR milestone to the issueJira ticket: APPSEC-57909