[SERVER-76424] Change option names from redact to applyHmac Created: 21/Apr/23  Updated: 02/Feb/24  Resolved: 03/May/23

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 7.1.0-rc0

Type: Task Priority: Major - P3
Reporter: Colby Ing Assignee: Ted Tuckman
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by SERVER-76427 Rename $telemetry to $queryStats Closed
Backwards Compatibility: Fully Compatible
Sprint: QI 2023-05-01, QI 2023-05-15
Participants:

 Description   

Summary

This requires changing the option name for the following options:

(1) redactIdentifiers -> applyHmacToIdentifiers

(2) redactionKey -> hmacKey

 

Invoking a command would look like:

db.adminCommand({
  aggregate: 1,
  pipeline: [
    {$queryStats: {applyHmacToIdentifiers: <boolean>, hmacKey: <bindata>}},
    {$sort: {"metrics.execCount": -1}}
  ]
})

Motivation

The commonly accepted security definition of 'redaction' means to remove completely. Because we are hashing with HMAC, 'transformed' is a more accurate term to use. Even though this is a purely internal use, we care about the parameter names because calls to $queryStats are found in the audit log, which customers will have access to. We will look to the $queryStat entries in the audit log in order to prove to customers we are in fact safely transforming their data to ensure the highest standards of customer data security and privacy.



 Comments   
Comment by Githook User [ 02/Feb/24 ]

Author:

{'name': 'Erin Zhu', 'email': 'erin.zhu@mongodb.com', 'username': 'erinzhu001'}

Message: SERVER-86118 Query Stats Backport to 7.0 Batch #2

Includes community changes from
SERVER-73907 Ensure telemetry command succeeds after raising FCV
SERVER-75609 Graceful telemetry failures and error tracking
SERVER-75156 separate queryShape from telemetryKey for find requests
SERVER-76610 account for queryShape nesting in telemetry store key
SERVER-76367: Abstract request-specific shapifying logic into RequestShapifiers
SERVER-76424 Replace 'redact' with 'hmac' in $telemetry syntax
SERVER-76781: Decouple opdebug metric collection from telemetry
SERVER-76208 support query shape serialization in IDL for types with custom serializers
with querystats related serialization/redaction changes from
SERVER-72687 Support for $out to Time-series collections

and enterprise changes from
SERVER-76610 account for queryShape nesting in telemetry store key
SERVER-76424 Replace 'redact' with 'hmac' in $telemetry syntax

GitOrigin-RevId: f424d1b1848f85581a870c061b1231219748c00c
Branch: v7.0
https://github.com/mongodb/mongo/commit/5dc8bc61dfdc550f8d643a4db5d3564a21e24245

Comment by Githook User [ 03/May/23 ]

Author:

{'name': 'Ted Tuckman', 'email': 'ted.tuckman@mongodb.com', 'username': 'TedTuckman'}

Message: SERVER-76424 Replace 'redact' with 'hmac' in $telemetry syntax
Branch: master
https://github.com/mongodb/mongo/commit/8e79f414b58d1ca97027312cd721dfecb636ce69

Generated at Thu Feb 08 06:32:39 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.