Skip to content

fix(kas): document rewrap proto fields used in bulk flow #2826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
elizabethhealy merged 11 commits into from
Nov 6, 2025
Merged

fix(kas): document rewrap proto fields used in bulk flow #2826

elizabethhealy merged 11 commits into from
Nov 6, 2025

Conversation

@jakedoublev
Copy link
Contributor

@jakedoublev jakedoublev commented Oct 20, 2025 •
edited by elizabethhealy
Loading

Proposed Changes

  • Adds descriptions to the rewrap request and response proto fields for clarity

Checklist

  • I have added or updated unit tests
  • I have added or updated integration tests (if appropriate)
  • I have added or updated documentation

Testing Instructions

@github-actions github-actions bot added comp:kas Key Access Server size/s labels Oct 20, 2025
jakedoublev
jakedoublev commented Oct 20, 2025
View reviewed changes
jakedoublev
jakedoublev commented Oct 20, 2025
View reviewed changes
@github-actions
Copy link
Contributor

github-actions bot commented Oct 20, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 185.952609ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 104.646382ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 378.648599ms
Throughput 264.10 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 39.201112328s
Average Latency 390.494975ms
Throughput 127.55 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.975831244s
Average Latency 278.988317ms
Throughput 178.73 requests/second

Copilot AI reviewed Oct 31, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive inline documentation to the KAS (Key Access Service) protobuf definitions, specifically focusing on fields used in the bulk rewrap flow for TDF (Trusted Data Format) encryption.

  • Documents all fields in key message types (PolicyBinding, KeyAccess, UnsignedRewrapRequest, RewrapRequest, RewrapResponse)
  • Clarifies required vs optional fields and differences between ZTDF and NanoTDF formats
  • Explains the cryptographic mechanisms including HMAC-SHA256 policy binding and ECDH key derivation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 172.77747ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 90.257521ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 357.323835ms
Throughput 279.86 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 38.272300685s
Average Latency 381.513354ms
Throughput 130.64 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.098427415s
Average Latency 270.0332ms
Throughput 184.51 requests/second

@elizabethhealy elizabethhealy marked this pull request as ready for review October 31, 2025 14:53
@elizabethhealy elizabethhealy requested review from a team as code owners October 31, 2025 14:53
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

X-Test Failure Report

opentdfplatformA0248N.dockerbuild
cukes-report
✅ js-v0.4.34
✅ java-v0.4.34
✅ go-v0.4.34

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 190.957608ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 105.527037ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 362.856028ms
Throughput 275.59 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 39.086788603s
Average Latency 389.677809ms
Throughput 127.92 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.460010602s
Average Latency 273.341562ms
Throughput 182.08 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

X-Test Failure Report

opentdfplatformTBQ2T5.dockerbuild
✅ js-v0.4.34
✅ java-v0.4.34
✅ go-v0.4.34

strantalis
strantalis reviewed Oct 31, 2025
View reviewed changes
strantalis
strantalis reviewed Oct 31, 2025
View reviewed changes
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 182.308203ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 94.509913ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 372.141512ms
Throughput 268.71 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 39.950257061s
Average Latency 398.160601ms
Throughput 125.16 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.559471922s
Average Latency 274.517278ms
Throughput 181.43 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 189.080487ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 104.76013ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 375.520367ms
Throughput 266.30 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 40.195127802s
Average Latency 400.355756ms
Throughput 124.39 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 28.367606371s
Average Latency 282.670666ms
Throughput 176.26 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

X-Test Results

opentdfplatformSCDJL4.dockerbuild
cukes-report
✅ js-v0.4.34
✅ java-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

X-Test Results

opentdfplatformMGRP8G.dockerbuild
cukes-report
✅ java-v0.4.34
✅ js-v0.4.34
bats-test-results
test-cases-mapping-report
✅ go-v0.4.34
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 162.632394ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 88.88537ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 376.827064ms
Throughput 265.37 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 40.372310229s
Average Latency 402.143116ms
Throughput 123.85 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 28.233048335s
Average Latency 281.290717ms
Throughput 177.10 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

X-Test Results

opentdfplatformY6C59G.dockerbuild
cukes-report
✅ java-v0.4.34
✅ js-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@alkalescent
Copy link
Contributor

alkalescent commented Nov 3, 2025

good job, looks like you just need to run make proto-generate here

dmihalcik-virtru
dmihalcik-virtru requested changes Nov 4, 2025
View reviewed changes
@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 185.221784ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 105.525037ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 364.600094ms
Throughput 274.27 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 38.735447927s
Average Latency 384.814993ms
Throughput 129.08 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.320793965s
Average Latency 272.488682ms
Throughput 183.01 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 165.333154ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 108.042988ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 375.030072ms
Throughput 266.65 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 39.74257392s
Average Latency 395.23013ms
Throughput 125.81 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.902243195s
Average Latency 277.701212ms
Throughput 179.20 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

X-Test Results

opentdfplatform8UVF8R.dockerbuild
cukes-report
✅ js-v0.4.34
✅ java-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@github-actions
Copy link
Contributor

github-actions bot commented Nov 5, 2025

X-Test Results

opentdfplatformLRETKN.dockerbuild
cukes-report
✅ java-v0.4.34
✅ js-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 186.124644ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 106.316965ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 364.890354ms
Throughput 274.05 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 40.108227357s
Average Latency 399.123251ms
Throughput 124.66 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 27.892232476s
Average Latency 277.961249ms
Throughput 179.26 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

X-Test Results

opentdfplatformZNAOG6.dockerbuild
✅ java-v0.4.34
cukes-report
✅ js-v0.4.34
✅ go-v0.4.34
bats-test-results
test-cases-mapping-report
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

Benchmark results, click to expand

Benchmark authorization.GetDecisions Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 177.201928ms

Benchmark authorization.v2.GetMultiResourceDecision Results:

Metric Value
Approved Decision Requests 1000
Denied Decision Requests 0
Total Time 100.880809ms

Standard Benchmark Metrics Skipped or Failed

Bulk Benchmark Results

Metric Value
Total Decrypts 100
Successful Decrypts 100
Failed Decrypts 0
Total Time 371.211514ms
Throughput 269.39 requests/second

TDF3 Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 40.308784236s
Average Latency 401.49626ms
Throughput 124.04 requests/second

NANOTDF Benchmark Results:

Metric Value
Total Requests 5000
Successful Requests 5000
Failed Requests 0
Concurrent Requests 50
Total Time 28.472767386s
Average Latency 283.611182ms
Throughput 175.61 requests/second

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

X-Test Results

opentdfplatformU2T2JY.dockerbuild
cukes-report
✅ js-v0.4.34
✅ java-v0.4.34
✅ go-v0.4.34
bats-test-results
✅ js-pull-2826
✅ java-pull-2826
✅ go-pull-2826

@elizabethhealy elizabethhealy added this pull request to the merge queue Nov 6, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 6, 2025
@elizabethhealy elizabethhealy added this pull request to the merge queue Nov 6, 2025
@elizabethhealy elizabethhealy removed this pull request from the merge queue due to a manual request Nov 6, 2025
@elizabethhealy elizabethhealy added this pull request to the merge queue Nov 6, 2025
Merged via the queue into main with commit 32a7e91 Nov 6, 2025
61 of 64 checks passed
@elizabethhealy elizabethhealy deleted the feat/DSPX-1781 branch November 6, 2025 20:09
This was referenced Nov 6, 2025
Merged
Open
github-merge-queue bot pushed a commit that referenced this pull request Dec 19, 2025
@opentdf-automation
chore(main): release protocol/go 0.14.0 (#2852)
1d0e525 
🤖 I have created a release *beep* *boop*
---


##
[0.14.0](protocol/go/v0.13.0...protocol/go/v0.14.0)
(2025-12-19)


### Features

* Update Go toolchain version to 1.24.11 across all modules
([#2943](#2943))
([a960eca](a960eca))


### Bug Fixes

* **deps:** bump toolchain to go1.24.9 for CVEs found by govulncheck
([#2849](#2849))
([23f76c0](23f76c0))
* **kas:** document rewrap proto fields used in bulk flow
([#2826](#2826))
([32a7e91](32a7e91))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
@opentdf-automation opentdf-automation bot mentioned this pull request Dec 19, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mkleene mkleene mkleene left review comments

@elizabethhealy elizabethhealy elizabethhealy left review comments

@pflynn-virtru pflynn-virtru pflynn-virtru left review comments

Copilot code review Copilot Copilot left review comments

@dmihalcik-virtru dmihalcik-virtru dmihalcik-virtru approved these changes

@strantalis strantalis Awaiting requested review from strantalis

Assignees

No one assigned

Labels

comp:kas Key Access Server size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@jakedoublev @alkalescent @mkleene @strantalis @elizabethhealy @dmihalcik-virtru @pflynn-virtru