Compare commits

...
Author SHA1 Message Date
james.maesandClaude Fable 5.2 3ddcf7ec9d feat: a create date and a modify date on every table
build / maven (push) Successful in 2m9s
maven / build (push) Successful in 2m9s
Every table of the QBit has a create date and a modify date: DATE_TIME, not
editable, with core's CREATE_DATE and MODIFY_DATE behaviors, in the columns
create_date and modify_date.

Seven tables did not have them: reveal grant, break-glass session, access
log, wipe run, wipe marker, legal hold and audit key. Their fields are named
createDate and modifyDate. Classification, policy and retention rule already
had create_date and modify_date, set by the table customizer. They keep those
field names, because a rename would change what a host reads and what their
audits record, and the two fields are now not editable and have the
behaviors.

Writes. Every write of the QBit is a core insert or update action, so the
dates are in the statement that writes the row. The table customizer sets
them, as it did for the three tables: a new row gets both, equal, from the
QBit's clock, and a changed row a new modify date. The access-log writer
still runs one insert per row and no other statement, lock or transaction.
The access log and wipe runs are only ever inserted, so their dates stay
equal.

Core uses a DATE_TIME field with the MODIFY_DATE behavior as the record
version of its table. That now holds for all ten tables: on an update core
sets the modify date itself, after the customizer has run, and an update
that sends the version it read is refused when the row has changed since.
Updates that send no version, the QBit's own among them, behave as before.

Schema. docs/ddl/secured-data-postgres.sql has a new last block that adds
the two columns to the seven tables: nullable, defaulting to the current
time, with the rows that were already there given the row's own time. No
CREATE TABLE statement is edited. An existing database runs that block
alone, before this release is deployed. The block rewrites no table, can be
run while the release before this one is running (its inserts name neither
column and get both from the default) and can be run again. This release
does not run without the columns. README: "Upgrading an existing database".

Unchanged. The dates have no classification, policy or assistant exposure of
their own: they are CONFIDENTIAL with their table and get the tier of its
other fields. Nothing signed or verified covers them: a wrapped data key is
bound to its table, field and record id, and the fingerprints of a log row
are made from search values. A changed policy or classification writes the
same core audit, field by field, and the same POLICY_CHANGE or
CLASSIFICATION_CHANGE row.

Tests. SecuredDataStandardDatesTest: every table the producer declares has
the two dates (the tables are taken from the instance, so a table added
later without them fails); the dates resolve to the tier of the other fields
of their table for five kinds of session; every writer sets both and only a
change moves the modify date (access-log writer, policy, classification,
legal hold, reveal, break-glass start, end and expiry on the memory backend;
audit key, wipe run, wipe marker and retention rule in the shipped schema);
the access-log writer runs exactly one insert per row; a changed policy and
classification write the audit and log rows they wrote before; rows written
before the columns existed are unchanged by the upgrade block, their wrapped
keys unwrap to the same data keys and their audit token verifies the same
value and no other. SecuredDataDdlTest: the shipped DDL gives every declared
table the two columns, the upgrade block adds them where they were missing,
an insert that names neither succeeds, and the block can be run twice. Seven
of the eight new tests fail without the change; the eighth is the record of
what a changed policy wrote before and passes on both sides.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-20 09:01:39 -06:00
james.maes 7d0e54eeca Merge pull request 'fix: a reveal and the access-log writer no longer wait for each other' (#45) from fix/reveal-access-log-deadlock into develop
build / maven (push) Successful in 1m43s
maven / build (push) Successful in 1m43s
2026-11-14 14:25:54 +00:00
james.maesandClaude Fable 5.2 a366e8b96e fix: a reveal and the access-log writer no longer wait for each other
build / maven (push) Successful in 2m34s
maven / build (push) Successful in 2m34s
A reveal, and the start, end and expiry of a break-glass session, hold the
runtime's monitor from their first check to their last write. Asking for a
classification (SecuredDataRuntime.classificationRows, and
activeRetentionRules) took the same monitor, and every thread asks: core
asks for every field it decides on and for every filter criterion of every
query, including the queries made inside this QBit's own writes.

So a thread that asked while holding another lock of this QBit could not be
answered during a reveal, and if the reveal needed that lock next, both
waited for ever. The access-log writer is such a thread. It holds the
anomaly counters while it inserts a row; the insert counts earlier rows and
writes an audit, both queries with criteria. A reveal inserts its own
access-log row.

    reveal:  runtime's monitor, then the anomaly counters
    writer:  the anomaly counters, then the runtime's monitor

Seen in a host on PostgreSQL: a person read a record with a masked field and
revealed it at once; the writer's tick drained the read's log rows at the
same moment. The request and the writer deadlocked (thread dump: the request
in SystemWrites.insertOne under RevealService.reveal, the writer in
SecuredDataRuntime.classificationRows under AuditAction.fetchIdFromName
under its own insert), and every later request blocked in
classificationRows. The same order existed between a reveal and the
resolver's monitor, and the key source's.

- The rule rows have a lock of their own (ruleLock), held only while they
  are answered or read. A read is a query made as the system and takes none
  of the QBit's other locks, so nothing that holds ruleLock waits for one.
- The runtime's monitor is left to what it was for: one reveal or
  break-glass change at a time.

Tests (SecuredDataLockOrderTest, on H2 in PostgreSQL mode with the audit
tables): a thread is parked inside a reveal, and inside the start of a
break-glass session, holding the runtime's monitor; the access-log writer
must drain its queue and another thread must be told a classification and
the active retention rules meanwhile, and then the parked operation must
finish. Both tests fail without the fix (neither thread finishes).

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-14 03:39:54 -06:00
james.maes 7f1b5988af Merge pull request 'fix: a rule read that asks for its own rows no longer recurses' (#43) from fix/reentrant-rule-reload into develop
build / maven (push) Successful in 1m26s
maven / build (push) Successful in 1m26s
2026-11-14 08:23:02 +00:00
james.maesandClaude Fable 5.2 d99db4738f fix: a rule read that asks for its own rows no longer recurses
build / maven (push) Successful in 1m17s
maven / build (push) Successful in 1m17s
Reading the rule rows a node keeps (classifications, active retention rules,
policies) is a query on a secured-data table, and other code runs inside that
query: a virtual field value provider or a post-query customizer that another
QBit or the host put on the table. When that code runs a query with filter
criteria, core validates the operands of classified fields and asks this QBit
for the classification of the field, which needs the rows that are being
read. The version of the rows was recorded only after the read returned, so
the nested question started the read again, and that read asked again:
StackOverflowError, and the same on every later request, since nothing was
ever recorded. One classification row was enough (core runs no value provider
for an empty result).

- System reads of the QBit's own tables (SystemWrites.query, the audit key
  lookup) name the stored fields of the table. Core fills a virtual field only
  for a query that selects it, so no value provider runs inside a system read.
- RuleRows holds one kind of rule rows and is used for all three kinds, which
  had the same shape. A question asked from inside a read is answered from the
  rows held when the read began (none before the first read) and never starts
  another read. The owner's monitor makes that answer private to the reading
  thread: every other thread waits and gets the rows the read returns.
- A read that fails records nothing and clears the reading mark, so the next
  question reads again. The rows held before are not given to a request in
  place of rows that could not be read.
- RetentionRules.active: a question asked from inside a transaction's read of
  its own rule edits is answered from the rules every thread shares instead
  of reading the edits again.

Who can be given the nested answer: only code on the reading thread, inside
SystemWrites.call, where the session is the system session and the resolver
answers FULL without looking at a classification. No field access decision
for a person is made from it; the request that started the read, and every
request on another thread, gets the rows the read returns.

Tests (SecuredDataRuleReloadTest): 9 of the 11 end in StackOverflowError
without the fix. They cover a value provider and a post-query customizer on
the classification, retention rule and policy tables, the answer a nested
question gets in both directions of a change, the session it is asked in, a
second thread waiting for the read, and failed reads (an exception and an
Error) being read again.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-14 01:56:42 -06:00
james.maes 4cd0fd1f54 Merge pull request 'perf: keep the access fingerprint for the request and read rule rows once per change' (#41) from perf/request-scoped-resolver-and-cached-rules into develop
build / maven (push) Successful in 1m55s
maven / build (push) Successful in 1m56s
2026-11-10 21:37:13 +00:00
james.maesandClaude Fable 5.2 ab283c79b9 perf: keep the access fingerprint for the request and read rule rows once per change
build / maven (push) Successful in 1m32s
maven / build (push) Successful in 1m32s
Core asks the field access resolver for its fingerprint before every field
decision (FieldAccessHelper.getDecision), that is once per field of every
record of a result and of every table in the metaData document. Each call
recomputed it: a JSON key, a permission lookup for every table, another JSON
document and a digest. Core also asks for the retention rules of a field on
every audited field and every filter criterion, and each question was a
query.

- getAccessFingerprint keeps its value in the request context (QContext) and
  returns it while the session, its permission set, the channel, the policy
  and classification versions are unchanged and no active break-glass grant
  has expired. Nothing outlives the request.
- RetentionRules.active answers from the active rules the runtime read once
  (SecuredDataRuntime.activeRetentionRules). A rule write clears them after
  commit; a thread that edits rules inside a transaction reads its own edits.
- Policy, classification and retention changes are announced on QQQ's cluster
  bus (ClusterCaches, memo-invalidate), so every node reads again. Before,
  the versions were node-local and another node kept old rules until restart.
- No node uses rule rows older than 30 seconds without reading them again
  (the safety net for a lost event).
- A read that fails throws and replaces nothing: never an empty rule list.

Measured in one JVM with GG Forge's composed instance (222 tables, secured
data and collaboration wired, in-memory backend, platform administrator),
released 0.1.0-RC.4 against this change, same machine, back to back:
metaData request 866.6 ms to 125.3 ms (930 MB to 74 MB allocated, 96 to 34
queries); a 300-row list 1,566 ms to 24 ms; a 27-row list 174 to 230 ms down
to 13 to 17 ms; queries per list 23 to 8.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
2026-11-10 15:22:22 -06:00
james.maes eb98ec5fd0 Merge pull request 'build(deps): align with Gitea registry (parent 2.2.1, QQQ 4.1.0-RC.26)' (#39) from deps/align-gitea into develop
build / maven (push) Successful in 7m39s
maven / build (push) Successful in 4m16s
2026-11-07 18:16:02 +00:00
james.maesandClaude Opus 5.5 f09fe866ad build(deps): align with Gitea registry (parent 2.2.1, QQQ 4.1.0-RC.26)
build / maven (push) Successful in 3m34s
maven / build (push) Successful in 3m35s
pom.xml: parent -> 2.2.1
pom.xml: qqq.snapshot.version: 4.1.0-RC.15 -> 4.1.0-RC.26
pom.xml: qqq-frontend-next: 1.0.0-RC.14 -> 1.0.0-RC.38
pom.xml: added qqq.version=4.1.0-RC.26 (parent BOM import)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 18:08:54 +00:00
james.maes c4ebc6833c Merge pull request 'ci: pin shared workflow to v1' (#38) from ci/pin-v1-develop into develop
QRun-IO/ci-policy: native / fork-deny (push) Skipped
QRun-IO/ci-policy: native / dotnet-0 (push) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 1e25bb5a243dfdcd95d4b9a4f780200ff8c8778a] (push) Successful in 13s
QRun-IO/ci-policy: native / native-result (push) Successful in 15s
QRun-IO/ci-policy: ci / head-profile (push) Skipped
QRun-IO/ci-policy: ci / repository-policy (push) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (push) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (push) Skipped
QRun-IO/ci-policy: ci / node-8 (push) Skipped
QRun-IO/ci-policy: ci / node-10 (push) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (push) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (push) Skipped
QRun-IO/ci-policy: ci / source-config-13 (push) Skipped
QRun-IO/ci-policy: ci / source-config-14 (push) Skipped
QRun-IO/ci-policy: ci / original-voyage (push) Skipped
QRun-IO/ci-policy: ci / original-cli (push) Skipped
QRun-IO/ci-policy: ci / ci-result (push) Successful in 11s
build / maven (push) Successful in 5m40s
QRun-IO/ci-policy: ci / fork-guard (push) Skipped
QRun-IO/ci-policy: ci / application-template-0 (push) Skipped
QRun-IO/ci-policy: ci / gradle-1 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (push) Skipped
QRun-IO/ci-policy: ci / node-9 (push) Skipped
QRun-IO/ci-policy: ci / android-0 (push) Skipped
QRun-IO/ci-policy: ci / original-business (push) Skipped
QRun-IO/ci-policy: ci / original-mcp (push) Skipped
QRun-IO/ci-policy: ci / not-enrolled (push) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (push) Skipped
maven / build (push) Successful in 5m40s
2026-11-06 16:10:31 +00:00
james.maesandClaude Opus 5.5 2431b4723a ci: pin shared workflow to v1
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
build / maven (push) Successful in 3m34s
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 1e25bb5a243dfdcd95d4b9a4f780200ff8c8778a] (pull_request) Successful in 7s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 7s
maven / build (push) Successful in 3m34s
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 7s
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 14:13:29 +00:00
james.maes 9fb168b96d Merge pull request 'ci: use shared ci-workflows Maven workflow' (#37) from ci/ci-workflows into develop
QRun-IO/ci-policy: native / fork-deny (push) Skipped
QRun-IO/ci-policy: native / dotnet-0 (push) Skipped
QRun-IO/ci-policy: native / native-result (push) Successful in 4s
QRun-IO/ci-policy: ci / head-profile (push) Skipped
QRun-IO/ci-policy: ci / repository-policy (push) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (push) Skipped
QRun-IO/ci-policy: ci / node-8 (push) Skipped
QRun-IO/ci-policy: ci / node-10 (push) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (push) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (push) Skipped
QRun-IO/ci-policy: ci / source-config-13 (push) Skipped
QRun-IO/ci-policy: ci / source-config-14 (push) Skipped
QRun-IO/ci-policy: ci / original-voyage (push) Skipped
QRun-IO/ci-policy: ci / original-cli (push) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (push) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (push) Skipped
QRun-IO/ci-policy: ci / ci-result (push) Successful in 5s
build / maven (push) Successful in 2m46s
QRun-IO/ci-policy: ci / fork-guard (push) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow d20a578c7d818bc7ca32a2ac2c675da4e4f27385] (push) Successful in 6s
QRun-IO/ci-policy: ci / application-template-0 (push) Skipped
QRun-IO/ci-policy: ci / gradle-1 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (push) Skipped
QRun-IO/ci-policy: ci / node-9 (push) Skipped
QRun-IO/ci-policy: ci / android-0 (push) Skipped
QRun-IO/ci-policy: ci / original-business (push) Skipped
QRun-IO/ci-policy: ci / original-mcp (push) Skipped
QRun-IO/ci-policy: ci / not-enrolled (push) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (push) Skipped
maven / build (push) Successful in 2m46s
2026-11-05 23:17:59 +00:00
CI e0459a99ff ci: rerun shared workflow
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: ci / Scoped workflow [workflow 1b3648d9421543350067e95e54959dfb471b26d5] (pull_request) Failing after 2s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Failing after 1s
build / maven (push) Successful in 2m19s
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Failing after 1s
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
maven / build (push) Successful in 2m19s
2026-11-05 16:26:50 -06:00
james.maesandClaude Opus 5.5 84e2311d84 ci: use shared ci-workflows Maven workflow
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
build / maven (push) Failing after 2s
QRun-IO/ci-policy: ci / Scoped workflow [workflow 1b3648d9421543350067e95e54959dfb471b26d5] (pull_request) Failing after 2s
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: ci / original-voyage (pull_request) Skipped
QRun-IO/ci-policy: ci / original-cli (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Failing after 2s
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
maven / build (push) Failing after 2s
QRun-IO/ci-policy: native / native-result (pull_request) Failing after 1s
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / shared-pipeline (pull_request) Skipped
Replace the platform-ci release callers with one caller of
KofTwentyTwo/ci-workflows maven.yaml (qqq-orb port).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-05 22:08:11 +00:00
forge-recovery 5987cb53ac ci: enroll shared Gitea lifecycle
QRun-IO/ci-policy: ci / head-profile (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (push) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (push) Skipped
QRun-IO/ci-policy: ci / node-8 (push) Skipped
QRun-IO/ci-policy: ci / node-10 (push) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (push) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (push) Skipped
QRun-IO/ci-policy: ci / source-config-13 (push) Skipped
QRun-IO/ci-policy: ci / source-config-14 (push) Skipped
QRun-IO/ci-policy: native / fork-deny (push) Skipped
QRun-IO/ci-policy: native / dotnet-0 (push) Skipped
Shared Java Maven CI / secrets (push) Successful in 26s
QRun-IO/ci-policy: native / native-result (push) Successful in 7s
QRun-IO/ci-policy: ci / repository-policy (push) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (push) Skipped
Shared Java Maven CI / verify (push) Successful in 2m17s
QRun-IO/ci-policy: Shared Java Maven CI / verify (push) Successful in 1m55s
QRun-IO/ci-policy: ci / ci-result (push) Successful in 4s
qrun-release / postpublish (push) Successful in 2m4s
QRun-IO/ci-policy: ci / fork-guard (push) Skipped
QRun-IO/ci-policy: ci / application-template-0 (push) Skipped
QRun-IO/ci-policy: ci / gradle-1 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (push) Skipped
QRun-IO/ci-policy: ci / node-9 (push) Skipped
QRun-IO/ci-policy: ci / android-0 (push) Skipped
QRun-IO/ci-policy: ci / original-business (push) Skipped
QRun-IO/ci-policy: ci / original-mcp (push) Skipped
QRun-IO/ci-policy: ci / not-enrolled (push) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / secrets (push) Successful in 26s
QRun-IO/ci-policy: ci / java-docker-3-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (push) Skipped
Shared Java Maven CI / gate (push) Successful in 15s
qrun-release / release (push) Successful in 53m0s
QRun-IO/ci-policy: Shared Java Maven CI / gate (push) Successful in 12s
QRun-IO/ci-policy: ci / java-maven-6 (push) Successful in 52m55s
Shared QRun source version / version (push) Successful in 2m4s
2026-11-03 18:10:35 +00:00
forge-recovery a087988f11 ci: enroll shared Gitea lifecycle
QRun-IO/ci-policy: ci / repository-policy (push) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (push) Skipped
QRun-IO/ci-policy: ci / ci-result (push) Successful in 5s
QRun-IO/ci-policy: Shared Java Maven CI / verify (push) Successful in 2m5s
QRun-IO/ci-policy: ci / head-profile (push) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (push) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (push) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (push) Skipped
QRun-IO/ci-policy: ci / node-8 (push) Skipped
QRun-IO/ci-policy: ci / node-10 (push) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (push) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (push) Skipped
QRun-IO/ci-policy: ci / source-config-13 (push) Skipped
QRun-IO/ci-policy: ci / source-config-14 (push) Skipped
QRun-IO/ci-policy: native / fork-deny (push) Skipped
QRun-IO/ci-policy: native / dotnet-0 (push) Skipped
QRun-IO/ci-policy: native / native-result (push) Successful in 12s
QRun-IO/ci-policy: ci / java-docker-3-head (push) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (push) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / secrets (push) Successful in 29s
QRun-IO/ci-policy: Shared Java Maven CI / gate (push) Successful in 14s
QRun-IO/ci-policy: ci / java-maven-6 (push) Successful in 1h13m45s
QRun-IO/ci-policy: ci / fork-guard (push) Skipped
QRun-IO/ci-policy: ci / application-template-0 (push) Skipped
QRun-IO/ci-policy: ci / gradle-1 (push) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (push) Skipped
QRun-IO/ci-policy: ci / node-9 (push) Skipped
QRun-IO/ci-policy: ci / android-0 (push) Skipped
QRun-IO/ci-policy: ci / original-mcp (push) Skipped
QRun-IO/ci-policy: ci / not-enrolled (push) Skipped
2026-11-02 22:35:22 +00:00
forge-recoveryandCodex 894c3023b4 ci: enroll shared Gitea release-candidate lifecycle
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / secrets (pull_request) Successful in 25s
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / verify (pull_request) Successful in 2m28s
QRun-IO/ci-policy: Shared Java Maven CI / gate (pull_request) Successful in 20s
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Successful in 12m47s
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 5s
Release candidate / release-rc (pull_request) Skipped
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 8s
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
Co-Authored-By: Codex <noreply@openai.com>
2026-11-02 20:19:48 +00:00
15c2906fc1 ci: add the isolated postpublish job to the QRun release caller
Shared Java Maven CI / secrets (push) Failing after 16s
Shared Java Maven CI / verify (push) Canceled after 0s
qrun-release / postpublish (push) Canceled after 0s
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: ci / head-profile (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-business (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / secrets (pull_request) Successful in 20s
QRun-IO/ci-policy: ci / repository-policy (pull_request) Skipped
QRun-IO/ci-policy: ci / java-core-2-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-6-head (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-7-head (pull_request) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / verify (pull_request) Successful in 1m56s
QRun-IO/ci-policy: Shared Java Maven CI / gate (pull_request) Successful in 11s
QRun-IO/ci-policy: ci / java-maven-6 (pull_request) Successful in 23m20s
QRun-IO/ci-policy: ci / ci-result (pull_request) Successful in 4s
Release candidate / release-rc (pull_request) Skipped
Shared Java Maven CI / gate (push) Canceled after 0s
qrun-release / release (push) Canceled after 2h30m11s
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-4 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-9 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-10 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-11 (pull_request) Skipped
QRun-IO/ci-policy: ci / repository-policy-12 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-13 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-14 (pull_request) Skipped
QRun-IO/ci-policy: ci / android-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / original-mcp (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 7s
QRun-IO/ci-policy: ci / java-docker-3-head (pull_request) Skipped
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Codex <noreply@openai.com>
2026-11-02 15:52:40 +00:00
45015b6912 ci: move the QRun release caller to the thin v2 contract
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-2 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-9 (pull_request) Skipped
QRun-IO/ci-policy: native / fork-deny (pull_request) Skipped
QRun-IO/ci-policy: ci / ci-result (pull_request) Failing after 5s
QRun-IO/ci-policy: Shared Java Maven CI / verify (pull_request) Successful in 3m1s
Shared Java Maven CI / secrets (push) Failing after 20s
QRun-IO/ci-policy: Shared Java Maven CI / secrets (pull_request) Failing after 19s
QRun-IO/ci-policy: Shared Java Maven CI / gate (pull_request) Canceled after 0s
Shared Java Maven CI / verify (push) Canceled after 0s
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-7 (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: native / dotnet-0 (pull_request) Skipped
QRun-IO/ci-policy: native / native-result (pull_request) Successful in 5s
Shared Java Maven CI / gate (push) Canceled after 0s
qrun-release / release (push) Canceled after 27m5s
QRun-IO/ci-policy: ci / java-maven-4 (pull_request) Canceled after 26m44s
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Codex <noreply@openai.com>
2026-11-02 06:20:41 +00:00
forge-recoveryandCodex 0f94818084 ci: add the identical QRun release caller
QRun-IO/ci-policy: ci / ci-result (pull_request) Failing after 8s
QRun-IO/ci-policy: ci / fork-guard (pull_request) Skipped
QRun-IO/ci-policy: ci / application-template-0 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-docker-2 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-5 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-6 (pull_request) Skipped
QRun-IO/ci-policy: ci / node-playwright-7 (pull_request) Skipped
QRun-IO/ci-policy: Shared Java Maven CI / verify (pull_request) Failing after 1s
QRun-IO/ci-policy: Shared Java Maven CI / secrets (pull_request) Failing after 1s
QRun-IO/ci-policy: Shared Java Maven CI / gate (pull_request) Failing after 0s
QRun-IO/ci-policy: ci / gradle-1 (pull_request) Skipped
QRun-IO/ci-policy: ci / java-frontend-browser-3 (pull_request) Skipped
QRun-IO/ci-policy: ci / source-config-8 (pull_request) Skipped
QRun-IO/ci-policy: ci / not-enrolled (pull_request) Skipped
QRun-IO/ci-policy: ci / java-maven-4 (pull_request) Failing after 1m40s
Co-Authored-By: Codex <noreply@openai.com>
2026-11-02 04:14:35 +00:00
james.maesandCodex 7b302ed2b1 ci: adopt managed orb 0.8 patch track (#30)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 15:29:10 -05:00
james.maesandCodex b917b51656 ci: adopt shared orb 0.7.18 (#29)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 14:47:03 -05:00
james.maesandCodex dc4734eef1 ci: adopt shared orb 0.7.17 (#28)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 14:16:47 -05:00
james.maesandCodex eb912ebf07 ci: use the shared branch-aware CodeQL worker (#26)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 10:56:24 -05:00
james.maesandCodex 9091f26dd7 ci: adopt central orb 0.7.12 and stable gates (#24)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 08:53:36 -05:00
james.maesandCodex 4942b7e994 ci: centralize rc release completion in qqq orb (#23)
Co-authored-by: Codex <noreply@openai.com>
2026-10-21 02:25:10 -05:00
25 changed files with 2838 additions and 77 deletions

No files matched your search

+2 -2
View File
@@ -1,12 +1,12 @@
version: 2.1
setup: true
orbs:
qqq-orb: kingsrook/qqq-orb@0.7.11
qqq-orb: kingsrook/qqq-orb@0.8
workflows:
setup:
jobs:
- qqq-orb/generate_pipeline:
orb_version: 0.7.11
orb_version: '0.8'
filters:
branches:
ignore: automation/qbit-rc-pending
+7
View File
@@ -0,0 +1,7 @@
name: build
on:
push:
jobs:
maven:
uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
secrets: inherit
+23
View File
@@ -0,0 +1,23 @@
name: CodeQL
'on':
push:
branches:
- main
- develop
- release/**
- hotfix/**
pull_request: {}
schedule:
- cron: 41 16 * * 0
workflow_dispatch: {}
permissions:
contents: read
actions: read
security-events: write
packages: read
concurrency:
group: codeql-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
analyze:
uses: QRun-IO/qqq-orb/.github/workflows/qbit-codeql.yml@c288a8864fe9054f68410e1d78f5863aea4c4d22
+62 -14
View File
@@ -1,26 +1,74 @@
# Cut the next release candidate (QRun-IO/qqq docs/QRUN-QBIT-REPO-STANDARD.md, C6):
# run this workflow by hand, or merge a develop PR labelled `release:rc`. It merges develop into
# the release line and the release/* push runs CircleCI publish_release_candidate.
name: Release candidate
on:
'on':
workflow_dispatch:
inputs:
dry_run:
description: Print the plan without merging or creating branches
description: Plan a cut without changing release state
type: boolean
default: false
finalize:
description: Retry finalization of an existing cut; do not cut another RC
type: boolean
default: false
recover:
description: Recover the same published RC after a deployment timeout; never
reupload
type: boolean
default: false
circle_build:
description: Original Circle publisher build number (recovery only)
type: string
default: ''
merge_sha:
description: Existing cut merge_sha (finalize retry only)
type: string
default: ''
bump_sha:
description: Existing cut bump_sha (finalize retry only)
type: string
default: ''
branch:
description: Existing cut branch (finalize retry only)
type: string
default: ''
version:
description: Existing cut version (finalize retry only)
type: string
default: ''
pull_request:
types: [closed]
branches: [develop]
types:
- closed
branches:
- develop
repository_dispatch:
types:
- qbit-rc-published
permissions:
contents: write
actions: read
checks: read
jobs:
release-rc:
if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release:rc'))
uses: QRun-IO/.github/.github/workflows/qbit-release-rc.yml@main
secrets: inherit
if: github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch'
|| (github.event_name == 'pull_request' && github.event.pull_request.merged
== true && github.event.pull_request.base.ref == 'develop' && contains(github.event.pull_request.labels.*.name,
'release:rc'))
uses: QRun-IO/qqq-orb/.github/workflows/qbit-release-rc.yml@cc30f599e63c8e41629c99d23395bac1adb8bc44
with:
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run }}
dry_run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry_run || false
}}
finalize: ${{ github.event_name == 'repository_dispatch' || (github.event_name
== 'workflow_dispatch' && inputs.finalize) }}
recover: ${{ github.event_name == 'workflow_dispatch' && inputs.recover || false
}}
circle_build: ${{ github.event_name == 'workflow_dispatch' && inputs.circle_build
|| '' }}
merge_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.merge_sha
|| inputs.merge_sha || '' }}
bump_sha: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.bump_sha
|| inputs.bump_sha || '' }}
branch: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.branch
|| inputs.branch || '' }}
version: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.version
|| inputs.version || '' }}
secrets: inherit
+2 -2
View File
@@ -1,5 +1,5 @@
profile: qbit
orb_version: 0.7.11
orb_version: '0.8'
default_branch: develop
java_version: '21'
browsers: true
@@ -13,4 +13,4 @@ publish:
release_candidate: true
release: true
asciidoc: false
release_completion: false
release_completion: true
+17
View File
@@ -4,6 +4,23 @@ All notable changes are documented here, following [Keep a Changelog](https://ke
## [Unreleased]
### Added: a create date and a modify date on every table
- Every table has a create date and a modify date: `DATE_TIME`, not editable, with QQQ's `CREATE_DATE` and `MODIFY_DATE` behaviors, in the columns `create_date` and `modify_date`. Seven tables did not have them: reveal grant, break-glass session, access log, wipe run, wipe marker, legal hold and audit key. Their fields are named `createDate` and `modifyDate`. Classification, policy and retention rule already had `create_date` and `modify_date`; they keep those field names, and the two fields are now not editable and have the behaviors.
- A new row gets both dates, equal, in the insert that writes it. A changed row keeps its create date and gets a later modify date. The access log and wipe runs are only ever inserted, so their dates stay equal. The access-log writer still runs one insert per row, with no other statement, lock or transaction.
- **Upgrade: run the DDL first.** Before deploying this release on an existing database, run the last block of `docs/ddl/secured-data-postgres.sql` (from the line `-- Standard dates:` to the end). It adds the two nullable columns to the seven tables, defaults them to the current time and gives existing rows the row's own time. It rewrites no table and can be run while the release before this one is running, which goes on working with the columns present. This release does not run without them. See "Upgrading an existing database" in the README.
- The dates have no classification, policy or assistant exposure of their own, and nothing that is signed or verified covers them. Rows written before the columns existed are unchanged apart from the two columns: wrapped data keys unwrap as before and audit tokens verify as before.
- QQQ uses a field with the `MODIFY_DATE` behavior as the record version of its table. That now holds for every table of the QBit, classification, policy and retention rule included: on an update core sets the modify date itself, and an update that sends the version it read is refused if the row has changed since. Updates that send no version, the QBit's own among them, behave as before.
### Fixed: a reveal and the access-log writer waiting for each other
- A reveal, or the start, end or expiry of a break-glass session, no longer deadlocks with a thread that asks for a classification while it holds another lock of this QBit. The access-log writer is such a thread: it holds the anomaly counters while it inserts a row, and that insert asks for classifications (it counts earlier rows and writes an audit, both queries with criteria). A reveal holds the runtime's monitor and then inserts its own access-log row. When both happened at once, neither finished, and neither did any later request, because every request asks for a classification. A person who opens a record with a masked field and reveals it straight away does both at once.
- The rule rows a node keeps (classifications, active retention rules) have a lock of their own, held only while they are answered or read. Asking for a classification no longer takes the monitor that reveal and break-glass hold for their whole operation.
### Fixed: rule reads that ask for their own rows
- Reading the rule rows a node keeps (classifications, active retention rules, policies) no longer recurses when code that runs inside that read asks for the same rows. Another QBit's virtual field value provider, or a post-query customizer, on a secured-data table that ran a query with filter criteria did exactly that: with one classification row present, every request that needed a classification ended in a `StackOverflowError`.
- The QBit's system reads of its own tables (`SystemWrites.query`, the audit key lookup) name the stored fields of the table, so core runs no virtual field value provider inside them.
- A question asked from inside a rule read is answered from the rows held when that read began (none before the first read) and starts no other read. Only the reading thread, inside the QBit's system read, can be given that answer; every request gets the rows the read returns. The same holds for a transaction's read of its own retention rule edits.
- A rule read that fails is tried again by the next question instead of failing or recursing from then on.
### Fixed: access-log lifecycle
- The access-log worker and JVM shutdown hook hold the logger weakly, so an instance the host drops (tests, reloads) can be collected; its worker stops at the next tick.
- `withRegisterShutdownHook(false)` for hosts that call `SecuredDataRuntime.close()` themselves; `SecuredDataAccessLogger.isWorkerRunning()`.
+29 -1
View File
@@ -30,7 +30,29 @@ new SecuredDataQBitProducer()
Register the host backend and application tables before producing the QBit. Enable core permissions (`qInstance.withEnforcePermissionsInCoreActions(true)`) at application entry points. Only one secured-data runtime is supported per instance. A namespace labels the QBit identity; table names remain fixed.
The host supplies database connection metadata. Physical table names and field backend names are the same snake_case names as the QQQ metadata; an RDBMS host may set `RDBMSTableBackendDetails.withTableName(table.getName())` through `withTableMetaDataCustomizer(...)`. Apply [the PostgreSQL 15+ DDL](docs/ddl/secured-data-postgres.sql) before serving requests. The same SQL is tested with H2 in PostgreSQL mode.
The host supplies database connection metadata. Physical table names and field backend names are the same snake_case names as the QQQ metadata (the fields `createDate` and `modifyDate` are the columns `create_date` and `modify_date`); an RDBMS host may set `RDBMSTableBackendDetails.withTableName(table.getName())` through `withTableMetaDataCustomizer(...)`. Apply [the PostgreSQL 15+ DDL](docs/ddl/secured-data-postgres.sql) before serving requests. The same SQL is tested with H2 in PostgreSQL mode.
### Upgrading an existing database: create and modify dates
Every table has the columns `create_date` and `modify_date`, and the QBit reads and writes them on all ten tables. Seven tables were first created without them: `secured_data_reveal_grant`, `secured_data_break_glass`, `secured_data_access_log`, `secured_data_wipe_run`, `secured_data_wipe_marker`, `secured_data_legal_hold` and `secured_data_audit_key`.
Before deploying a release that has the two dates on every table, run the last block of [the DDL](docs/ddl/secured-data-postgres.sql) on the existing database: everything from the line `-- Standard dates:` to the end of the file. The order matters. The release before it runs unchanged once the columns are there. The release with the dates does not run without them: its reads of the seven tables fail, and with them every request that needs a field decision. The block does three things to each of the seven tables:
- It adds the two columns, nullable. That changes the catalog only; the table is not rewritten.
- It gives each column a default of the current time, so a release that does not know the columns goes on inserting while both releases run.
- It gives the rows that were already there the row's own time (below). The `UPDATE` touches only rows whose `create_date` is null, so the block can be run again and then changes nothing. It takes row locks only, and on a large access log it can be run in ranges of `id`.
| Table | `create_date` of an existing row | `modify_date` of an existing row |
|---|---|---|
| `secured_data_reveal_grant` | `granted_at` | `granted_at` |
| `secured_data_break_glass` | `started_at` | `ended_at`, else `started_at` |
| `secured_data_access_log` | `created_at` | `created_at` |
| `secured_data_wipe_run` | `finished_at`, else `started_at` | the same |
| `secured_data_wipe_marker` | `wiped_at` | `wiped_at` |
| `secured_data_legal_hold` | `placed_at`, else the time of the upgrade | `released_at`, else `placed_at`, else the time of the upgrade |
| `secured_data_audit_key` | `created_at` | `created_at` |
Nothing else changes in a row: wrapped data keys, search fingerprints and every other column are left as they are.
## Tables, screens and permissions
@@ -44,6 +66,12 @@ The host supplies database connection metadata. Physical table names and field b
Every table has audit rules, explicit record sections and CONFIDENTIAL code classification. The Secured Data app navigates to Classification, Policy, Access log and Break-glass session. Reveal grants are a read-only child list joined by `access_log_id`; no process or home widget appears in navigation. The classification target `(table_name, field_name)` is unique, including the null field used for a table-wide override.
Every table has a create date and a modify date: date-time fields that nobody edits, in the columns `create_date` and `modify_date`. The fields are named `createDate` and `modifyDate`. Classification, Policy and Retention rules had the two dates before the other tables did and keep the field names `create_date` and `modify_date`. A new row gets both, equal. A changed row keeps its create date and gets a later modify date. Every write of the QBit is a QQQ insert or update action, so the dates are in the one statement that writes the row, the access-log writer's insert included. The access log and wipe runs are only ever inserted, so their two dates stay equal.
The two dates have no classification of their own. They are CONFIDENTIAL with the rest of their table, are given the tier of its other fields, and are closed to the assistant with it. Nothing that is signed or verified covers them: a wrapped data key is bound to its table, field and record id, and the search fingerprints of a log row are made from the search values.
The modify date has QQQ's modify-date behavior, and QQQ uses such a field as the record version of its table. On an update core sets it to the current time (or one millisecond after the stored value, if that is later). When a caller sends the version it read, core refuses the update if the row has changed since. The QBit's own updates send no version.
`secured_data.admin` gates configuration editing and activity reads through a standard QQQ custom permission checker. It gives no implicit access to classified fields on application tables. `secured_data.hasAccess` is the catalog base permission; the custom checker requires admin. Activity writes are refused for ordinary users even when they hold admin. Customizers also protect system-only writes, and update/delete capabilities are disabled on the access log, including system calls.
Both table features are registered for **all tables**: `secured_data_full` (Secured data: full) and `secured_data_reveal` (Secured data: reveal). This deliberate catalog choice supports new admin classification rows without a restart. Core's permission-base, READ prerequisite and NOT_PROTECTED semantics are preserved: NOT_PROTECTED application tables grant their features without an explicit permission. Use protected table permission rules when field policies must restrict users. Feature grants have no standard WRITE/admin implication.
+49
View File
@@ -138,3 +138,52 @@ CREATE TABLE secured_data_audit_key (
CREATE INDEX secured_data_hold_lookup ON secured_data_legal_hold (table_name, status, record_id);
CREATE INDEX secured_data_retention_lookup ON secured_data_retention_rule (table_name, is_active);
CREATE INDEX secured_data_wipe_rule_lookup ON secured_data_wipe_marker (rule_id);
-- Standard dates: create_date and modify_date on the seven tables created above without them.
-- A new database runs the whole file. An existing database runs this block alone, BEFORE the release
-- that writes the two columns is deployed. The columns are nullable and default to the current time, so
-- a release that does not know them goes on inserting while both run. Adding a nullable column and
-- setting a default change the catalog only (no table rewrite). Each UPDATE gives the rows that were
-- already there the row's own time, once: it touches only rows whose create_date is still null, takes
-- row locks only, and on a large access log can be run in ranges of id.
ALTER TABLE secured_data_reveal_grant ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_reveal_grant ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_reveal_grant ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_reveal_grant ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_reveal_grant SET create_date = granted_at, modify_date = granted_at WHERE create_date IS NULL;
ALTER TABLE secured_data_break_glass ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_break_glass ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_break_glass ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_break_glass ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_break_glass SET create_date = started_at, modify_date = COALESCE(ended_at, started_at) WHERE create_date IS NULL;
ALTER TABLE secured_data_access_log ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_access_log ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_access_log ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_access_log ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_access_log SET create_date = created_at, modify_date = created_at WHERE create_date IS NULL;
ALTER TABLE secured_data_wipe_run ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_wipe_run ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_wipe_run ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_wipe_run ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_wipe_run SET create_date = COALESCE(finished_at, started_at), modify_date = COALESCE(finished_at, started_at) WHERE create_date IS NULL;
ALTER TABLE secured_data_wipe_marker ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_wipe_marker ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_wipe_marker ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_wipe_marker ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_wipe_marker SET create_date = wiped_at, modify_date = wiped_at WHERE create_date IS NULL;
ALTER TABLE secured_data_legal_hold ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_legal_hold ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_legal_hold ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_legal_hold ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_legal_hold SET create_date = COALESCE(placed_at, CURRENT_TIMESTAMP), modify_date = COALESCE(released_at, placed_at, CURRENT_TIMESTAMP) WHERE create_date IS NULL;
ALTER TABLE secured_data_audit_key ADD COLUMN IF NOT EXISTS create_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_audit_key ADD COLUMN IF NOT EXISTS modify_date TIMESTAMP WITH TIME ZONE;
ALTER TABLE secured_data_audit_key ALTER COLUMN create_date SET DEFAULT CURRENT_TIMESTAMP;
ALTER TABLE secured_data_audit_key ALTER COLUMN modify_date SET DEFAULT CURRENT_TIMESTAMP;
UPDATE secured_data_audit_key SET create_date = created_at, modify_date = created_at WHERE create_date IS NULL;
+4 -3
View File
@@ -22,8 +22,9 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<properties>
<qqq.version>4.1.0-RC.26</qqq.version> <!-- feeds qbit-build-parent's qqq-bom-pom import -->
<!-- QQQ 4.1.0-RC.15 ships UI API 1.6.0, field access and audit value protection -->
<qqq.snapshot.version>4.1.0-RC.15</qqq.snapshot.version>
<qqq.snapshot.version>4.1.0-RC.26</qqq.snapshot.version>
<revision>0.1.0-SNAPSHOT</revision>
<maven.compiler.source>21</maven.compiler.source>
<maven.compiler.target>21</maven.compiler.target>
@@ -34,7 +35,7 @@
<parent>
<groupId>com.kingsrook</groupId>
<artifactId>qbit-build-parent</artifactId>
<version>2.0.0</version>
<version>2.2.1</version>
</parent>
<groupId>com.kingsrook.qbits</groupId>
@@ -92,7 +93,7 @@
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-frontend-next</artifactId>
<version>1.0.0-RC.14</version>
<version>1.0.0-RC.38</version>
<scope>test</scope>
</dependency>
<dependency>
@@ -0,0 +1,103 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.secureddata;
import java.util.List;
import java.util.function.Supplier;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
/*******************************************************************************
** One kind of rule rows a node keeps in memory (classifications, policies or
** active retention rules): read once per version, never used unread past
** SecuredDataRuntime.MAX_RULE_AGE, and safe against a read that asks for the
** same rows again.
**
** Not synchronized: every call must be made holding the owner's lock (the
** runtime's rule lock for classifications and retention rules, the resolver's
** monitor for policies). That lock is what makes the re-entry answer below
** private to one thread: while a read is running, only the thread running it
** can get in here; every other thread waits for the lock and is given the rows
** that read returns.
**
** Re-entry: reading rule rows is itself a query, and anything that runs inside
** it (a table customizer, a record-security lookup, a value provider) may ask a
** question that needs the very rows being read. Such a nested question is
** answered with the rows this node held when the read began - the answer every
** request was given until now, and no rows before the first read - and never
** starts another read. The request that started the read gets the new rows.
**
** Failure: a read that throws leaves the previous rows and version in place
** and is not remembered, so the next question reads again. The previous rows
** are never handed to a request in place of rows that could not be read.
*******************************************************************************/
final class RuleRows
{
private List<QRecord> rows = List.of();
private long version;
private long loadedAt;
private boolean loaded;
private boolean reading;
/*******************************************************************************
** The rows of this version, reading them when the rows held are of another
** version, too old, or were never read.
**
** @param currentVersion the owner's invalidation clock, read by the caller
** before this call: a change during the read leaves a
** version that no longer matches, so the next question
** reads again
** @param read the query; whatever it throws is thrown to the caller
*******************************************************************************/
List<QRecord> get(long currentVersion, Supplier<List<QRecord>> read)
{
if(loaded && version == currentVersion && !SecuredDataRuntime.tooOld(loadedAt))
{
return (rows);
}
if(reading)
{
///////////////////////////////////////////////////////////////////////////
// the read that is running on this thread asked for its own rows: give //
// it the rows held when it began, and do not start another read //
///////////////////////////////////////////////////////////////////////////
return (rows);
}
reading = true;
try
{
long startedAt = System.nanoTime();
List<QRecord> fresh = List.copyOf(read.get());
rows = fresh;
version = currentVersion;
loadedAt = startedAt;
loaded = true;
}
finally
{
reading = false;
}
return (rows);
}
}
@@ -124,7 +124,7 @@ public final class SecuredDataKeySource implements ClassifiedValueKeySource, Aut
try
{
List<QRecord> rows = SystemWrites.call(() -> new QueryAction().execute(new QueryInput(SecuredDataTables.AUDIT_KEY)
.withFilter(recordField(table, field, pk)).withShouldOmitHiddenFields(false)
.withFilter(recordField(table, field, pk)).withShouldOmitHiddenFields(false).withFieldNamesToInclude(SystemWrites.storedFields(SecuredDataTables.AUDIT_KEY))
.withTransaction(QContext.getQBackendTransaction())).getRecords());
if(rows.isEmpty())
{
@@ -74,10 +74,14 @@ public class SecuredDataResolver implements FieldAccessResolverInterface
{
}
private long cachedVersion;
/** Used only inside methods synchronized on this resolver. */
private final RuleRows policyRows = new RuleRows();
private List<QRecord> policies = List.of();
private final Map<String, UserState> users = new HashMap<>();
/** Request-scoped (QContext) holder of the access fingerprint. */
private static final String FINGERPRINT_KEY = SecuredDataResolver.class.getName() + ".accessFingerprint";
/*******************************************************************************
@@ -288,16 +292,19 @@ public class SecuredDataResolver implements FieldAccessResolverInterface
/*******************************************************************************
** Refresh policy rows once per version and matched state per relevant permissions.
** A read that fails throws and is tried again by the next call. A question
** asked from inside the read itself (see RuleRows) is answered from the
** policies held when the read began; whatever it matched for its user is
** dropped with every other user's state when the read returns.
*******************************************************************************/
private synchronized UserState state()
{
long version = runtime.policyVersion();
if(cachedVersion != version)
policies = policyRows.get(runtime.policyVersion(), () ->
{
policies = List.copyOf(SystemWrites.query(SecuredDataTables.POLICY, new QQueryFilter()));
List<QRecord> rows = SystemWrites.query(SecuredDataTables.POLICY, new QQueryFilter());
users.clear();
cachedVersion = version;
}
return (rows);
});
QSession session = QContext.getQSession();
TreeSet<String> held = new TreeSet<>();
for(QRecord policy : policies)
@@ -308,7 +315,7 @@ public class SecuredDataResolver implements FieldAccessResolverInterface
held.add(permission);
}
}
String key = JsonUtils.toJson(List.of(userId(), held));
String key = userId() + '\u0000' + String.join("\u0000", held);
UserState state = users.get(key);
if(state == null)
{
@@ -356,11 +363,82 @@ public class SecuredDataResolver implements FieldAccessResolverInterface
** Stable across unrelated permissions/records; includes channel and exact expiry.
*******************************************************************************/
@Override
public synchronized String getAccessFingerprint()
public String getAccessFingerprint()
{
state();
TreeSet<String> relevant = new TreeSet<>();
/////////////////////////////////////////////////////////////////////////////
// core asks for the fingerprint before every field decision (once per //
// field of every record of a result), so the value is kept for the //
// request - and only while everything it is derived from is unchanged //
/////////////////////////////////////////////////////////////////////////////
QSession session = QContext.getQSession();
String channel = Objects.requireNonNullElse(SecuredDataMetadata.channel(session), "");
Instant now = runtime.config().getClock().instant();
RequestFingerprint kept = QContext.getObject(FINGERPRINT_KEY, RequestFingerprint.class).orElse(null);
if(kept != null && kept.matches(this, session, channel, runtime.policyVersion(), runtime.classificationVersion(), now))
{
return (kept.value());
}
RequestFingerprint computed = computeAccessFingerprint(session, channel, now);
QContext.setObject(FINGERPRINT_KEY, computed);
return (computed.value());
}
/*******************************************************************************
** The fingerprint and what it was derived from. It stops matching when the
** session, its permissions, the channel, a policy or classification version
** changes, or when the first active break-glass grant expires.
*******************************************************************************/
private record RequestFingerprint(int resolver, QSession session, int permissionsIdentity, int permissionCount, String channel, long policyVersion,
long classificationVersion, Instant validUntil, String value) implements Serializable
{
/*******************************************************************************
** Whether the kept value is still the one a fresh computation would give.
*******************************************************************************/
boolean matches(SecuredDataResolver owner, QSession current, String currentChannel, long currentPolicyVersion, long currentClassificationVersion, Instant now)
{
return (resolver == System.identityHashCode(owner) && session == current && permissionsIdentity == identityOfPermissions(current) && permissionCount == countOfPermissions(current)
&& channel.equals(currentChannel) && policyVersion == currentPolicyVersion && classificationVersion == currentClassificationVersion && now.isBefore(validUntil));
}
}
/*******************************************************************************
** The permission set object of a session (it is replaced, not edited, when a
** session is given new permissions).
*******************************************************************************/
private static int identityOfPermissions(QSession session)
{
return (session == null || session.getPermissions() == null ? 0 : System.identityHashCode(session.getPermissions()));
}
/*******************************************************************************
** How many permissions a session holds (an edit in place changes it).
*******************************************************************************/
private static int countOfPermissions(QSession session)
{
return (session == null || session.getPermissions() == null ? -1 : session.getPermissions().size());
}
/*******************************************************************************
** Stable across unrelated permissions/records; includes channel and exact expiry.
*******************************************************************************/
private synchronized RequestFingerprint computeAccessFingerprint(QSession session, String channel, Instant now)
{
/////////////////////////////////////////////////////////////////////////////
// versions are read before the rows they describe, so a change during the //
// computation leaves a kept value that no longer matches //
/////////////////////////////////////////////////////////////////////////////
long policyVersion = runtime.policyVersion();
long classificationVersion = runtime.classificationVersion();
TreeSet<String> relevant = new TreeSet<>();
List<QRecord> breakGlass = state().breakGlass();
for(QRecord row : policies)
{
String permission = row.getValueString("permission_name");
@@ -380,12 +458,15 @@ public class SecuredDataResolver implements FieldAccessResolverInterface
}
}
}
List<String> breaks = activeBreakGlass().stream().map(row -> row.getValueString("id")).sorted().toList();
String payload = JsonUtils.toJson(List.of(userId(), relevant, runtime.policyVersion(), runtime.classificationVersion(), breaks,
Objects.requireNonNullElse(SecuredDataMetadata.channel(session), "")));
List<QRecord> activeBreaks = breakGlass.stream().filter(row -> "ACTIVE".equals(row.getValueString("status")))
.filter(row -> row.getValueInstant("expires_at") != null && row.getValueInstant("expires_at").isAfter(now)).toList();
List<String> breaks = activeBreaks.stream().map(row -> row.getValueString("id")).sorted().toList();
Instant validUntil = activeBreaks.stream().map(row -> row.getValueInstant("expires_at")).min(Instant::compareTo).orElse(Instant.MAX);
String payload = JsonUtils.toJson(List.of(userId(), relevant, policyVersion, classificationVersion, breaks, channel));
try
{
return (Base64.getUrlEncoder().withoutPadding().encodeToString(MessageDigest.getInstance("SHA-256").digest(payload.getBytes(StandardCharsets.UTF_8))));
String value = Base64.getUrlEncoder().withoutPadding().encodeToString(MessageDigest.getInstance("SHA-256").digest(payload.getBytes(StandardCharsets.UTF_8)));
return (new RequestFingerprint(System.identityHashCode(this), session, identityOfPermissions(session), countOfPermissions(session), channel, policyVersion, classificationVersion, validUntil, value));
}
catch(java.security.NoSuchAlgorithmException e)
{
@@ -21,9 +21,21 @@
package com.kingsrook.qbits.secureddata;
import java.lang.ref.WeakReference;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.atomic.AtomicLong;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.cluster.ClusterBus;
import com.kingsrook.qqq.backend.core.cluster.ClusterCaches;
import com.kingsrook.qqq.backend.core.cluster.ClusterEvent;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.logging.QLogger;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData;
@@ -34,16 +46,58 @@ import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaDa
public class SecuredDataRuntime implements QSupplementalInstanceMetaData, AutoCloseable
{
public static final String NAME = "securedDataRuntime";
private static final QLogger LOG = QLogger.getLogger(SecuredDataRuntime.class);
/////////////////////////////////////////////////////////////////////////////////
// the three sets of rule rows a node keeps in memory. A change clears them on //
// this node at once and, through QQQ's cluster bus (ClusterCaches), on every //
// other node. MAX_RULE_AGE is the safety net for a lost event: no node uses //
// rule rows older than that without reading them again. //
/////////////////////////////////////////////////////////////////////////////////
public static final String POLICY_CACHE = "securedData.policies";
public static final String CLASSIFICATION_CACHE = "securedData.classifications";
public static final String RETENTION_CACHE = "securedData.retentionRules";
public static final Duration MAX_RULE_AGE = Duration.ofSeconds(30);
static
{
ClusterCaches.shared(POLICY_CACHE, POLICY_CACHE, () -> clearOnThisNode(POLICY_CACHE), null);
ClusterCaches.shared(CLASSIFICATION_CACHE, CLASSIFICATION_CACHE, () -> clearOnThisNode(CLASSIFICATION_CACHE), null);
ClusterCaches.shared(RETENTION_CACHE, RETENTION_CACHE, () -> clearOnThisNode(RETENTION_CACHE), null);
}
private static final AtomicLong STARTUP_VERSION = new AtomicLong(System.currentTimeMillis());
private final AtomicLong classificationVersion = new AtomicLong(STARTUP_VERSION.incrementAndGet());
private final AtomicLong policyVersion = new AtomicLong(STARTUP_VERSION.incrementAndGet());
private final AtomicLong retentionVersion = new AtomicLong(STARTUP_VERSION.incrementAndGet());
private final transient WeakReference<QInstance> owner;
private final transient SecuredDataQBitConfig config;
private final transient SecuredDataResolver resolver;
private final transient SecuredDataKeySource keys = new SecuredDataKeySource();
private final transient SecuredDataAccessLogger logger;
private final transient SecuredDataAnomalies anomalies;
private transient long cachedClassificationVersion;
private transient List<com.kingsrook.qqq.backend.core.model.data.QRecord> classificationRows = List.of();
/////////////////////////////////////////////////////////////////////////////////
// both are used only while holding ruleLock: one lock for the two, because //
// reading either may ask for the other. //
// //
// It is a lock of its own, never this runtime's monitor. A reveal and the //
// start, end and expiry of a break-glass session hold the runtime's monitor //
// for their whole operation, and every thread asks for a classification all //
// the time (core asks for every field it decides on and for every criterion //
// of every query), including threads that hold another lock of this QBit: the //
// access-log writer inside the anomaly counters, the resolver, the key //
// source. When the question needed the runtime's monitor, such a thread and //
// a reveal that needed its lock next waited for each other for ever. //
// //
// ruleLock is held only while rule rows are answered or read. A read is a //
// query made as the system: it takes none of the QBit's other locks, so no //
// thread holding ruleLock ever waits for one of them. //
/////////////////////////////////////////////////////////////////////////////////
private final transient Object ruleLock = new Object();
private final transient RuleRows classificationRows = new RuleRows();
private final transient RuleRows activeRetentionRules = new RuleRows();
@@ -53,6 +107,7 @@ public class SecuredDataRuntime implements QSupplementalInstanceMetaData, AutoCl
public SecuredDataRuntime(QInstance instance, SecuredDataQBitConfig config)
{
this.config = config;
this.owner = new WeakReference<>(instance);
this.resolver = new SecuredDataResolver(this);
this.anomalies = new SecuredDataAnomalies(config);
this.logger = new SecuredDataAccessLogger(instance, this);
@@ -137,6 +192,7 @@ public class SecuredDataRuntime implements QSupplementalInstanceMetaData, AutoCl
public void invalidateClassifications()
{
classificationVersion.incrementAndGet();
announce(CLASSIFICATION_CACHE);
}
@@ -147,23 +203,115 @@ public class SecuredDataRuntime implements QSupplementalInstanceMetaData, AutoCl
public void invalidatePolicies()
{
policyVersion.incrementAndGet();
announce(POLICY_CACHE);
}
/*******************************************************************************
** Read classification rows once per version, always as the system.
** A retention rule changed: forget the active rules here and on every node.
*******************************************************************************/
synchronized List<com.kingsrook.qqq.backend.core.model.data.QRecord> classificationRows()
public void invalidateRetentionRules()
{
long version = classificationVersion();
if(cachedClassificationVersion != version)
retentionVersion.incrementAndGet();
announce(RETENTION_CACHE);
}
/*******************************************************************************
** Version of the retention rules this node holds.
*******************************************************************************/
public long retentionVersion()
{
return (retentionVersion.get());
}
/*******************************************************************************
** Whether rows loaded at this System.nanoTime are too old to use unread.
*******************************************************************************/
static boolean tooOld(long loadedAtNanos)
{
return (System.nanoTime() - loadedAtNanos > MAX_RULE_AGE.toNanos());
}
/*******************************************************************************
** Every active retention rule, read once per version and at most MAX_RULE_AGE
** old. A read that fails throws and leaves nothing in place of the rules:
** callers never see "no rules" because the rules could not be read, and the
** next call reads again. A question asked from inside the read itself (see
** RuleRows) is answered with the rules held when the read began.
*******************************************************************************/
public List<QRecord> activeRetentionRules()
{
synchronized(ruleLock)
{
classificationRows = List.copyOf(com.kingsrook.qbits.secureddata.support.SystemWrites.query(
com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.CLASSIFICATION, new com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter()));
cachedClassificationVersion = version;
return (activeRetentionRules.get(retentionVersion(), () -> SystemWrites.query(SecuredDataTables.RETENTION_RULE, new QQueryFilter()
.withCriteria(new QFilterCriteria("is_active", QCriteriaOperator.EQUALS, true)))));
}
}
/*******************************************************************************
** Tell the other nodes (this node has already moved its version). A failure
** to send is logged: the other nodes then read again within MAX_RULE_AGE.
*******************************************************************************/
private void announce(String cache)
{
try
{
QInstance instance = owner.get();
if(instance != null)
{
ClusterBus.publish(instance, new ClusterEvent(ClusterEvent.TYPE_MEMO_INVALIDATE, cache, null));
}
}
catch(RuntimeException e)
{
LOG.warn("Could not announce a secured-data rule change; other nodes read again within " + MAX_RULE_AGE.toSeconds() + " seconds", e);
}
}
/*******************************************************************************
** A rule change announced on the cluster bus (also by this node): move the
** version of the runtime of the instance the event arrived on.
*******************************************************************************/
private static void clearOnThisNode(String cache)
{
SecuredDataRuntime runtime = current();
if(runtime == null)
{
return;
}
switch(cache)
{
case POLICY_CACHE -> runtime.policyVersion.incrementAndGet();
case CLASSIFICATION_CACHE -> runtime.classificationVersion.incrementAndGet();
default -> runtime.retentionVersion.incrementAndGet();
}
}
/*******************************************************************************
** Read classification rows once per version, always as the system. A read
** that fails throws and is tried again by the next call. A question asked from
** inside the read itself (see RuleRows) is answered with the rows held when
** the read began, and never starts another read.
*******************************************************************************/
List<QRecord> classificationRows()
{
synchronized(ruleLock)
{
return (classificationRows.get(classificationVersion(), () -> SystemWrites.query(SecuredDataTables.CLASSIFICATION, new QQueryFilter())));
}
return (classificationRows);
}
@@ -31,12 +31,16 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.SectionFactory;
import com.kingsrook.qqq.backend.core.model.metadata.tables.UniqueKey;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.AUDIT_KEY;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.CREATE_DATE;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.LEGAL_HOLD;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.MODIFY_DATE;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.RETENTION_RULE;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.WIPE_MARKER;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.WIPE_RUN;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.base;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.createDate;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.field;
import static com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.modifyDate;
/*******************************************************************************
** Retention policies, value-free history, legal holds and mutable audit keys.
@@ -74,8 +78,8 @@ public final class RetentionTables
.withField(field("is_active", QFieldType.BOOLEAN).withDefaultValue(true))
.withField(field("last_run_at", QFieldType.DATE_TIME).withIsEditable(false))
.withField(field("last_run_count", QFieldType.INTEGER).withIsEditable(false))
.withField(field("create_date", QFieldType.DATE_TIME))
.withField(field("modify_date", QFieldType.DATE_TIME))
.withField(createDate("create_date"))
.withField(modifyDate("modify_date"))
.withField(field("modified_by", QFieldType.STRING).withMaxLength(255));
rule.withSection(SectionFactory.defaultT1("id", "name", "table_name", "field_names"));
rule.withSection(SectionFactory.defaultT2("age_field_name", "age_days", "action", "overwrite_text", "audit_treatment", "archive_storage_name", "batch_size", "is_active"));
@@ -92,8 +96,11 @@ public final class RetentionTables
.withField(field("action", QFieldType.STRING).withMaxLength(40).withIsRequired(true))
.withField(field("wiped_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("run_id", QFieldType.INTEGER).withIsRequired(true))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE))
.withUniqueKey(new UniqueKey().withFieldNames(List.of("table_name", "record_id", "field_name")));
marker.withSection(SectionFactory.defaultT1("id", "table_name", "record_id", "field_name", "rule_id", "action", "wiped_at", "run_id"));
marker.withSection(SectionFactory.defaultT3(CREATE_DATE, MODIFY_DATE));
QTableMetaData hold = base(config, LEGAL_HOLD, "Legal hold")
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("tables"))
.withField(field("record_id", QFieldType.STRING).withMaxLength(255))
@@ -102,9 +109,11 @@ public final class RetentionTables
.withField(field("placed_at", QFieldType.DATE_TIME))
.withField(field("released_by", QFieldType.STRING).withMaxLength(255))
.withField(field("released_at", QFieldType.DATE_TIME))
.withField(field("status", QFieldType.STRING).withMaxLength(20).withDefaultValue("ACTIVE"));
.withField(field("status", QFieldType.STRING).withMaxLength(20).withDefaultValue("ACTIVE"))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE));
hold.withSection(SectionFactory.defaultT1("id", "table_name", "record_id", "reason", "status"));
hold.withSection(SectionFactory.defaultT3("placed_by", "placed_at", "released_by", "released_at"));
hold.withSection(SectionFactory.defaultT3("placed_by", "placed_at", "released_by", "released_at", CREATE_DATE, MODIFY_DATE));
QTableMetaData run = base(config, WIPE_RUN, "Wipe run")
.withField(field("rule_id", QFieldType.INTEGER).withIsRequired(true))
.withField(field("started_at", QFieldType.DATE_TIME).withIsRequired(true))
@@ -115,9 +124,11 @@ public final class RetentionTables
.withField(field("wiped_count", QFieldType.INTEGER))
.withField(field("error_count", QFieldType.INTEGER))
.withField(field("record_ids", QFieldType.STRING).withMaxLength(4000))
.withField(field("message", QFieldType.STRING).withMaxLength(500));
.withField(field("message", QFieldType.STRING).withMaxLength(500))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE));
run.withSection(SectionFactory.defaultT1("id", "rule_id", "status", "eligible_count", "held_count", "wiped_count", "error_count"));
run.withSection(SectionFactory.defaultT3("started_at", "finished_at", "record_ids", "message"));
run.withSection(SectionFactory.defaultT3("started_at", "finished_at", "record_ids", "message", CREATE_DATE, MODIFY_DATE));
QTableMetaData key = base(config, AUDIT_KEY, "Audit key")
.withAuditRules(new QAuditRules().withAuditLevel(AuditLevel.NONE))
.withoutCapabilities(Capability.TABLE_EXPORT)
@@ -127,8 +138,11 @@ public final class RetentionTables
.withField(field("wrapped_key", QFieldType.TEXT).withIsRequired(true).withIsSensitive(true).withIsHidden(true)
.withFieldSecurityLock(new FieldSecurityLock().withSecurityKeyType(KEY_LOCK).withDefaultBehavior(FieldSecurityLock.Behavior.DENY).withOverrideValues(List.of(KEY_LOCK_NEVER_GRANTED))))
.withField(field("created_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE))
.withUniqueKey(new UniqueKey().withFieldNames(List.of("table_name", "record_id", "field_name")));
key.withSection(SectionFactory.defaultT1("id", "table_name", "record_id", "field_name", "created_at"));
key.withSection(SectionFactory.defaultT3(CREATE_DATE, MODIFY_DATE));
return (List.of(rule, marker, hold, run, key));
}
}
@@ -68,6 +68,7 @@ public class SecuredDataTableCustomizers implements TableCustomizerInterface
record.getValues().forEach(effective::setValue);
validate(table, record, effective);
Instant now = SecuredDataRuntime.current().config().getClock().instant();
dates(table, record, old == null, now);
if(SecuredDataTables.LEGAL_HOLD.equals(table))
{
if(old == null)
@@ -82,19 +83,41 @@ public class SecuredDataTableCustomizers implements TableCustomizerInterface
}
continue;
}
if(old == null)
{
record.setValue("create_date", now);
}
record.setValue("modify_date", now);
record.setValue("modified_by", SecuredDataResolver.userId());
}
}
else
{
Instant now = SecuredDataRuntime.current().config().getClock().instant();
for(QRecord record : records)
{
dates(table, record, input instanceof InsertInput, now);
}
}
return (records);
}
/*******************************************************************************
** The two dates every table has, set in the write that is already being made:
** a new row gets both, equal, from the clock every other time of this QBit
** comes from, and a changed row a new modify date. Core has the last word on
** a change: the modify date is the record version of its table, and core
** moves it forward after this has run. A row of a table that is only ever
** inserted (the access log, a wipe run) so keeps equal dates.
*******************************************************************************/
private static void dates(String table, QRecord record, boolean inserted, Instant now)
{
if(inserted)
{
record.setValue(SecuredDataTables.createDateField(table), now);
}
record.setValue(SecuredDataTables.modifyDateField(table), now);
}
/*******************************************************************************
** Access logs are append-only even for the system.
*******************************************************************************/
@@ -238,7 +261,8 @@ public class SecuredDataTableCustomizers implements TableCustomizerInterface
}
SecuredDataRuntime runtime = SecuredDataRuntime.current();
Runnable invalidate = SecuredDataTables.CLASSIFICATION.equals(table) ? runtime::invalidateClassifications
: SecuredDataTables.POLICY.equals(table) || SecuredDataTables.BREAK_GLASS.equals(table) ? runtime::invalidatePolicies : null;
: SecuredDataTables.POLICY.equals(table) || SecuredDataTables.BREAK_GLASS.equals(table) ? runtime::invalidatePolicies
: SecuredDataTables.RETENTION_RULE.equals(table) ? runtime::invalidateRetentionRules : null;
if(invalidate != null)
{
QBackendTransaction active = transaction == null ? QContext.getQBackendTransaction() : transaction;
@@ -248,6 +272,10 @@ public class SecuredDataTableCustomizers implements TableCustomizerInterface
}
else
{
if(SecuredDataTables.RETENTION_RULE.equals(table))
{
com.kingsrook.qbits.secureddata.retention.RetentionRules.editedInTransaction();
}
active.addAfterCommitCallback(invalidate);
}
}
@@ -32,6 +32,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.audits.AuditLevel;
import com.kingsrook.qqq.backend.core.model.metadata.audits.QAuditRules;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.dashboard.QWidgetMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn;
@@ -66,6 +67,8 @@ public final class SecuredDataTables
public static final List<String> ALL = List.of(CLASSIFICATION, POLICY, REVEAL_GRANT, BREAK_GLASS, ACCESS_LOG, RETENTION_RULE, WIPE_MARKER, LEGAL_HOLD, WIPE_RUN, AUDIT_KEY);
public static final List<String> MAIN = List.of(CLASSIFICATION, POLICY, ACCESS_LOG, BREAK_GLASS, RETENTION_RULE);
public static final List<String> SYSTEM_WRITTEN = List.of(REVEAL_GRANT, BREAK_GLASS, ACCESS_LOG, WIPE_MARKER, WIPE_RUN, AUDIT_KEY);
public static final String CREATE_DATE = "createDate";
public static final String MODIFY_DATE = "modifyDate";
public static final String REVEALS_JOIN = "secured_data_access_log_reveals";
public static final String REVEALS_WIDGET = "securedDataReveals";
@@ -133,6 +136,51 @@ public final class SecuredDataTables
/*******************************************************************************
** When a row was written. Every table has this field and a modify date;
** neither is editable, and the columns are create_date and modify_date.
*******************************************************************************/
static QFieldMetaData createDate(String name)
{
return (field(name, QFieldType.DATE_TIME).withBackendName("create_date").withLabel("create date")
.withIsEditable(false).withBehavior(DynamicDefaultValueBehavior.CREATE_DATE));
}
/*******************************************************************************
** When a row last changed: its create date until something changes it.
*******************************************************************************/
static QFieldMetaData modifyDate(String name)
{
return (field(name, QFieldType.DATE_TIME).withBackendName("modify_date").withLabel("modify date")
.withIsEditable(false).withBehavior(DynamicDefaultValueBehavior.MODIFY_DATE));
}
/*******************************************************************************
** The name of a table's create date field. Classification, policy and
** retention rule had the two dates before the other tables did and keep the
** field names they have always had.
*******************************************************************************/
static String createDateField(String table)
{
return (List.of(CLASSIFICATION, POLICY, RETENTION_RULE).contains(table) ? "create_date" : CREATE_DATE);
}
/*******************************************************************************
** The name of a table's modify date field (see createDateField).
*******************************************************************************/
static String modifyDateField(String table)
{
return (List.of(CLASSIFICATION, POLICY, RETENTION_RULE).contains(table) ? "modify_date" : MODIFY_DATE);
}
/*******************************************************************************
** Define Classification.
*******************************************************************************/
@@ -145,8 +193,8 @@ public final class SecuredDataTables
.withField(field("mask_style", QFieldType.STRING).withMaxLength(255).withPossibleValueSourceName("secured_data_mask_style"))
.withField(field("low_cardinality", QFieldType.BOOLEAN))
.withField(field("notes", QFieldType.TEXT))
.withField(field("create_date", QFieldType.DATE_TIME))
.withField(field("modify_date", QFieldType.DATE_TIME))
.withField(createDate("create_date"))
.withField(modifyDate("modify_date"))
.withField(field("modified_by", QFieldType.STRING).withMaxLength(255));
table.withSection(SectionFactory.defaultT1("id", "table_name", "field_name", "classification"));
table.withSection(SectionFactory.defaultT2("mask_style", "low_cardinality", "notes"));
@@ -179,8 +227,8 @@ public final class SecuredDataTables
.withField(field("distinct_value_alert", QFieldType.INTEGER).withDefaultValue(15))
.withField(field("min_entropy_enabled", QFieldType.BOOLEAN).withDefaultValue(true))
.withField(field("is_active", QFieldType.BOOLEAN).withDefaultValue(true))
.withField(field("create_date", QFieldType.DATE_TIME))
.withField(field("modify_date", QFieldType.DATE_TIME))
.withField(createDate("create_date"))
.withField(modifyDate("modify_date"))
.withField(field("modified_by", QFieldType.STRING).withMaxLength(255));
table.withSection(SectionFactory.defaultT1("id", "name", "permission_name", "classification"));
table.withSection(SectionFactory.defaultT2("table_name", "tier", "reveal_minutes", "daily_reveal_cap", "reason_options", "allow_free_text_reason", "require_free_text", "client_channel", "exact_match_per_hour", "miss_alert_consecutive", "distinct_value_alert", "min_entropy_enabled", "is_active"));
@@ -205,10 +253,12 @@ public final class SecuredDataTables
.withField(field("reason_text", QFieldType.TEXT))
.withField(field("granted_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("expires_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("access_log_id", QFieldType.INTEGER).withIsRequired(true));
.withField(field("access_log_id", QFieldType.INTEGER).withIsRequired(true))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE));
table.withSection(SectionFactory.defaultT1("id", "user_id", "user_name", "table_name"));
table.withSection(SectionFactory.defaultT2("record_id", "field_name", "reason", "reason_text", "access_log_id"));
table.withSection(SectionFactory.defaultT3("granted_at", "expires_at"));
table.withSection(SectionFactory.defaultT3("granted_at", "expires_at", CREATE_DATE, MODIFY_DATE));
return (table);
}
@@ -230,10 +280,12 @@ public final class SecuredDataTables
.withField(field("expires_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("ended_at", QFieldType.DATE_TIME))
.withField(field("ended_by", QFieldType.STRING).withMaxLength(255))
.withField(field("status", QFieldType.STRING).withMaxLength(255).withDefaultValue("ACTIVE").withPossibleValueSourceName("secured_data_break_glass_status"));
.withField(field("status", QFieldType.STRING).withMaxLength(255).withDefaultValue("ACTIVE").withPossibleValueSourceName("secured_data_break_glass_status"))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE));
table.withSection(SectionFactory.defaultT1("id", "user_id", "user_name", "reason"));
table.withSection(SectionFactory.defaultT2("reason_text", "classification_ceiling", "table_name", "ended_by", "status"));
table.withSection(SectionFactory.defaultT3("started_at", "expires_at", "ended_at"));
table.withSection(SectionFactory.defaultT3("started_at", "expires_at", "ended_at", CREATE_DATE, MODIFY_DATE));
return (table);
}
@@ -261,10 +313,12 @@ public final class SecuredDataTables
.withField(field("break_glass_id", QFieldType.INTEGER))
.withField(field("created_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("search_value_fingerprints", QFieldType.TEXT))
.withField(field("rule_id", QFieldType.INTEGER));
.withField(field("rule_id", QFieldType.INTEGER))
.withField(createDate(CREATE_DATE))
.withField(modifyDate(MODIFY_DATE));
table.withSection(SectionFactory.defaultT1("id", "event_type", "user_id", "user_name"));
table.withSection(SectionFactory.defaultT2("table_name", "record_id", "field_name", "record_count", "action_name", "reason", "reason_text", "client_channel", "outcome", "anomaly_flag", "break_glass_id", "rule_id", "search_value_fingerprints"));
table.withSection(SectionFactory.defaultT3("created_at"));
table.withSection(SectionFactory.defaultT3("created_at", CREATE_DATE, MODIFY_DATE));
table.withSection(SectionFactory.customT2("reveals", new QIcon("visibility")).withLabel("Reveals").withWidgetName(REVEALS_WIDGET));
return (table);
}
@@ -58,15 +58,86 @@ public final class RetentionRules
return (names == null ? List.of() : Arrays.stream(names.split(",", -1)).map(String::trim).toList());
}
///////////////////////////////////////////////////////////////////////////////
// set on a thread that changed a rule inside a transaction: until that //
// transaction ends, the thread reads the rules through it (its own edits), //
// not the rules every other thread shares //
///////////////////////////////////////////////////////////////////////////////
private static final ThreadLocal<Boolean> EDITED_IN_TRANSACTION = ThreadLocal.withInitial(() -> false);
/** Set while this thread reads its own edits, so that a question from inside that read does not read them again. */
private static final ThreadLocal<Boolean> READING_OWN_EDITS = ThreadLocal.withInitial(() -> false);
/*******************************************************************************
** Fresh rules in the current transaction; edits take effect without a stale cache.
** The active rules of a table that name this field. Core asks this for every
** field of every audited write and every filter criterion of every query, so
** the active rules are read once (SecuredDataRuntime.activeRetentionRules: per
** change, and at most MAX_RULE_AGE old) instead of once per call. A committed
** change is seen at once on the node that made it and on every node the
** cluster event reaches; a transaction that edits rules reads its own edits.
** A failed read throws: it is never "no rules". A question asked from inside
** a read of the rules is answered from the rules held before that read (see
** RuleRows) and never starts another.
*******************************************************************************/
public static List<QRecord> active(String table, String field)
{
return (SystemWrites.query(SecuredDataTables.RETENTION_RULE, new QQueryFilter()
.withCriteria(new QFilterCriteria("is_active", QCriteriaOperator.EQUALS, true))
.withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, table)))
.stream().filter(rule -> fields(rule).contains(field)).toList());
SecuredDataRuntime runtime = SecuredDataRuntime.current();
List<QRecord> rules;
if(runtime != null && (!readsOwnEdits() || READING_OWN_EDITS.get()))
{
//////////////////////////////////////////////////////////////////////////
// also the answer to a question asked from inside this thread's read //
// of its own edits (code that runs inside that query): the rules //
// every other thread shares, and never another read of the edits //
//////////////////////////////////////////////////////////////////////////
rules = runtime.activeRetentionRules();
}
else
{
READING_OWN_EDITS.set(true);
try
{
rules = SystemWrites.query(SecuredDataTables.RETENTION_RULE, new QQueryFilter()
.withCriteria(new QFilterCriteria("is_active", QCriteriaOperator.EQUALS, true))
.withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, table)));
}
finally
{
READING_OWN_EDITS.remove();
}
}
return (rules.stream().filter(rule -> table != null && table.equals(rule.getValueString("table_name"))).filter(rule -> fields(rule).contains(field)).toList());
}
/*******************************************************************************
** A rule was written on this thread inside a transaction that is still open.
*******************************************************************************/
public static void editedInTransaction()
{
EDITED_IN_TRANSACTION.set(true);
}
/*******************************************************************************
** Whether this thread must read the rules through its open transaction.
*******************************************************************************/
private static boolean readsOwnEdits()
{
if(!EDITED_IN_TRANSACTION.get())
{
return (false);
}
if(QContext.getQBackendTransaction() == null)
{
EDITED_IN_TRANSACTION.remove();
return (false);
}
return (true);
}
/*******************************************************************************
@@ -21,7 +21,9 @@
package com.kingsrook.qbits.secureddata.support;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
import com.kingsrook.qqq.backend.core.actions.permissions.CorePermissionEnforcer;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
@@ -32,6 +34,7 @@ import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
@@ -100,13 +103,15 @@ public final class SystemWrites
/*******************************************************************************
** Query without user locks or field access recursion.
** Query without user locks or field access recursion, for the stored fields of
** the table only (see storedFields).
*******************************************************************************/
public static List<QRecord> query(String table, QQueryFilter filter)
{
try
{
return (call(() -> new QueryAction().execute(new QueryInput(table).withFilter(filter).withTransaction(QContext.getQBackendTransaction())).getRecords()));
return (call(() -> new QueryAction().execute(new QueryInput(table).withFilter(filter).withFieldNamesToInclude(storedFields(table))
.withTransaction(QContext.getQBackendTransaction())).getRecords()));
}
catch(QException e)
{
@@ -116,6 +121,22 @@ public final class SystemWrites
/*******************************************************************************
** The names of the stored fields of a table, as the projection of a system
** read. A query that names its fields is not given virtual fields, so core
** runs none of the value providers another QBit or the host may have added to
** a secured-data table: this QBit reads its own columns and nothing else, and
** a provider cannot be made to run inside a rule read. Null (every field, and
** the error core reports) for a table the instance does not have.
*******************************************************************************/
public static Set<String> storedFields(String tableName)
{
QTableMetaData table = QContext.getQInstance().getTable(tableName);
return (table == null ? null : new HashSet<>(table.getFields().keySet()));
}
/*******************************************************************************
** Insert and reject backend record errors.
*******************************************************************************/
@@ -120,4 +120,73 @@ class SecuredDataDdlTest
.isInstanceOf(java.sql.SQLException.class);
}
}
/*******************************************************************************
** Every table the producer declares has the columns create_date and
** modify_date in a database made from the DDL. The tables that were first
** created without them get them from the last block of the file, which is what
** an existing database runs: nullable columns that default to the current
** time, so an insert that names neither still succeeds, and a block that can
** be run again and then changes nothing.
*******************************************************************************/
@Test
void postgresDdlGivesEveryDeclaredTableTheTwoDateColumns() throws Exception
{
String url = "jdbc:h2:mem:secured_data_dates;MODE=PostgreSQL;DATABASE_TO_UPPER=FALSE;DB_CLOSE_DELAY=-1";
QInstance instance = SecuredDataTestSupport.setup();
try(Connection connection = DriverManager.getConnection(url, "sa", ""))
{
SecuredDataStandardDatesTest.run(connection, SecuredDataStandardDatesTest.ddl(false));
java.util.List<String> added = new java.util.ArrayList<>();
for(var table : SecuredDataStandardDatesTest.declared(instance))
{
if(!hasColumn(connection, table.getName(), "create_date"))
{
assertThat(hasColumn(connection, table.getName(), "modify_date")).as(table.getName()).isFalse();
added.add(table.getName());
}
}
assertThat(added).hasSize(7);
connection.createStatement().execute("INSERT INTO secured_data_legal_hold (table_name, reason) VALUES ('person', 'before the columns')");
SecuredDataStandardDatesTest.run(connection, SecuredDataStandardDatesTest.ddl(true));
for(var table : SecuredDataStandardDatesTest.declared(instance))
{
for(String column : java.util.List.of("create_date", "modify_date"))
{
try(java.sql.ResultSet columns = connection.getMetaData().getColumns(null, null, table.getName(), column))
{
assertThat(columns.next()).as(table.getName() + "." + column).isTrue();
assertThat(columns.getString("TYPE_NAME")).as(table.getName() + "." + column).isEqualTo("TIMESTAMP WITH TIME ZONE");
assertThat(columns.getString("IS_NULLABLE")).as(table.getName() + "." + column).isEqualTo("YES");
if(added.contains(table.getName()))
{
assertThat(columns.getString("COLUMN_DEF")).as(table.getName() + "." + column).isEqualTo("CURRENT_TIMESTAMP");
}
}
}
}
connection.createStatement().execute("INSERT INTO secured_data_legal_hold (table_name, reason) VALUES ('person', 'by a release that does not know the columns')");
var holds = SecuredDataStandardDatesTest.rows(connection, SecuredDataTables.LEGAL_HOLD, false);
assertThat(holds).hasSize(2).allSatisfy(hold -> assertThat(hold.get("create_date")).isNotNull().isEqualTo(hold.get("modify_date")));
SecuredDataStandardDatesTest.run(connection, SecuredDataStandardDatesTest.ddl(true));
assertThat(SecuredDataStandardDatesTest.rows(connection, SecuredDataTables.LEGAL_HOLD, false)).isEqualTo(holds);
}
}
/*******************************************************************************
** Whether a table has a column.
*******************************************************************************/
private static boolean hasColumn(Connection connection, String table, String column) throws java.sql.SQLException
{
try(java.sql.ResultSet columns = connection.getMetaData().getColumns(null, null, table, column))
{
return (columns.next());
}
}
}
@@ -0,0 +1,271 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.secureddata;
import java.io.Serializable;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.reveal.RevealResult;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEvent;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEventType;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessOutcome;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.CLOCK;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.insert;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.logs;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.policyRow;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;
/*******************************************************************************
** A reveal, and the start, end and expiry of a break-glass session, hold the
** runtime's monitor from their first check to their last write, so that two of
** them cannot both pass a check (the daily allowance, one active session).
** Every other thread asks this QBit for a classification all the time: core
** asks for every field it decides on and for every filter criterion of every
** query, including the queries made inside this QBit's own writes.
**
** When that question needed the same monitor, a thread that asked it while
** holding another of this QBit's locks could never be answered during a
** reveal that was about to need that lock: the access-log writer holds the
** anomaly counters' monitor while it inserts a row (the insert counts earlier
** rows and writes an audit, both queries with criteria), and a reveal inserts
** its own access-log row. Reveal: runtime, then counters. Writer: counters,
** then runtime. Both waited for ever, and so did every later request, since
** every request asks for a classification.
**
** The rule rows now have a lock of their own that is held only while they are
** read. These tests run on a relational database (H2 in PostgreSQL mode, with
** the audit tables), where an insert really writes its audit. Each parks one
** thread inside the operation, holding the runtime's monitor, and requires
** the access-log writer and a classification question on other threads to
** finish meanwhile; then the parked operation finishes too. Without the fix
** the writer does not finish and the test fails after WAIT_SECONDS.
*******************************************************************************/
@Timeout(180)
class SecuredDataLockOrderTest
{
private static final long WAIT_SECONDS = 20;
private final ExecutorService threads = Executors.newCachedThreadPool(work ->
{
Thread thread = new Thread(work, "lock-order-test");
thread.setDaemon(true);
return (thread);
});
private QInstance instance;
private SecuredDataRuntime runtime;
private QSession person;
private QTableMetaData reading;
private Serializable pk;
private final CountDownLatch parked = new CountDownLatch(1);
private final CountDownLatch resume = new CountDownLatch(1);
private final AtomicReference<Thread> working = new AtomicReference<>();
private final AtomicBoolean heldTheRuntimesMonitor = new AtomicBoolean();
/*******************************************************************************
** Let a parked thread go, then close; a runtime whose threads are stuck was
** already taken out of the list (see abandon).
*******************************************************************************/
@AfterEach
void cleanup()
{
resume.countDown();
threads.shutdownNow();
RetentionTestSupport.close();
}
/*******************************************************************************
** A reveal in progress holds up neither the access-log writer nor a question.
*******************************************************************************/
@Test
void theAccessLogWriterAndAClassificationQuestionFinishWhileARevealIsInProgress() throws Exception
{
setup();
Future<RevealResult> reveal = parkInside(() -> new RevealService().reveal("reading", pk, "notes", null, "Synthetic reveal; lock order test."));
othersFinishMeanwhile();
resume.countDown();
assertThat(reveal.get(WAIT_SECONDS, TimeUnit.SECONDS).value()).isEqualTo("test-notes");
assertThat(logs()).extracting(row -> row.getValueString("event_type")).contains("EXACT_MATCH_FILTER", "REVEAL");
assertThat(runtime.resolver().isRevealActive("reading", "notes", pk)).isTrue();
}
/*******************************************************************************
** The same for the start of a break-glass session, which holds the same monitor.
*******************************************************************************/
@Test
void theAccessLogWriterAndAClassificationQuestionFinishWhileBreakGlassStarts() throws Exception
{
setup();
person.getPermissions().add(BreakGlassService.START + ".hasAccess");
Future<QRecord> started = parkInside(() -> new BreakGlassService().start("Synthetic break-glass session; lock order test.", 5, "reading", DataClassification.PHI));
othersFinishMeanwhile();
resume.countDown();
assertThat(started.get(WAIT_SECONDS, TimeUnit.SECONDS).getValueString("status")).isEqualTo("ACTIVE");
assertThat(logs()).extracting(row -> row.getValueString("event_type")).contains("EXACT_MATCH_FILTER", "BREAK_GLASS_START");
}
/*******************************************************************************
** A relational instance with audit tables; a PII field one policy makes
** revealable to the person; one row; and one search of that field waiting in
** the access-log queue, as it waits after a person filters a list by it.
*******************************************************************************/
private void setup() throws Exception
{
instance = RetentionTestSupport.setup();
runtime = SecuredDataRuntime.current();
person = QContext.getQSession();
reading = instance.getTable("reading");
insert(SecuredDataTables.POLICY, policyRow("secured_data.admin", "PII", "REVEALABLE"));
pk = RetentionTestSupport.reading(120).getValue("id");
runtime.resolver().onAccess(new FieldAccessEvent().withType(FieldAccessEventType.EXACT_MATCH_FILTER).withOutcome(FieldAccessOutcome.MATCH)
.withTableName("reading").withFieldNames(List.of("notes")).withActionName("query").withRecordCount(1)
.withSearchValueFingerprints(List.of(runtime.resolver().fingerprintSearchValue("known"))));
assertThat(logs()).as("the search is queued, not yet written").extracting(row -> row.getValueString("event_type")).doesNotContain("EXACT_MATCH_FILTER");
}
/*******************************************************************************
** Run the operation as the person on another thread and return once it is
** parked at its first reading of the clock, which both operations make
** inside their synchronized block.
*******************************************************************************/
private <T> Future<T> parkInside(Callable<T> operation) throws Exception
{
CLOCK.beforeInstant = () ->
{
if(Thread.currentThread() == working.get() && parked.getCount() == 1)
{
heldTheRuntimesMonitor.set(Thread.holdsLock(runtime));
parked.countDown();
try
{
resume.await();
}
catch(InterruptedException e)
{
Thread.currentThread().interrupt();
}
}
};
Future<T> future = threads.submit(() ->
{
QContext.init(instance, person);
try
{
working.set(Thread.currentThread());
return (operation.call());
}
finally
{
QContext.clear();
}
});
assertThat(parked.await(WAIT_SECONDS, TimeUnit.SECONDS)).as("the operation read the clock").isTrue();
assertThat(heldTheRuntimesMonitor).as("the operation is parked holding the runtime's monitor").isTrue();
return (future);
}
/*******************************************************************************
** While the operation is parked: the access-log writer drains its queue (what
** its worker does on every tick), and a thread that holds no lock is told
** the classification of a field and the active retention rules.
*******************************************************************************/
private void othersFinishMeanwhile() throws Exception
{
Future<?> writer = threads.submit(() -> runtime.logger().flush());
Future<DataClassification> question = threads.submit(() ->
{
QContext.init(instance, person);
try
{
runtime.activeRetentionRules();
return (SecuredDataClassifications.effective(reading, "notes"));
}
finally
{
QContext.clear();
}
});
try
{
writer.get(WAIT_SECONDS, TimeUnit.SECONDS);
assertThat(question.get(WAIT_SECONDS, TimeUnit.SECONDS)).isEqualTo(DataClassification.PII);
}
catch(TimeoutException e)
{
abandon();
fail("A thread waited " + WAIT_SECONDS + " seconds for the monitor the parked operation holds (writer done: " + writer.isDone() + ", question done: " + question.isDone()
+ "): the operation needs the lock that thread holds next, so neither would ever finish");
}
}
/*******************************************************************************
** Threads of this runtime are stuck holding its locks: closing it would wait
** for them, so it is left to the daemon threads instead of being closed.
*******************************************************************************/
private void abandon()
{
SecuredDataTestSupport.RUNTIMES.remove(runtime);
}
}
@@ -95,7 +95,9 @@ class SecuredDataQBitProducerTest
assertThat(table.getAuditRules().getAuditLevel()).isEqualTo(name.equals(SecuredDataTables.AUDIT_KEY) ? AuditLevel.NONE : AuditLevel.FIELD);
assertThat(table.getSections()).isNotEmpty();
assertThat(SecuredDataMetadata.classification(table, null)).isEqualTo(DataClassification.CONFIDENTIAL);
table.getFields().values().forEach(field -> assertThat(field.getBackendName()).isEqualTo(field.getName()));
// A column has the name of its field. The two standard dates are always the columns create_date and modify_date.
table.getFields().values().forEach(field -> assertThat(field.getBackendName())
.isEqualTo("createDate".equals(field.getName()) ? "create_date" : "modifyDate".equals(field.getName()) ? "modify_date" : field.getName()));
}
assertThat(SecuredDataTables.esbTableNames()).containsExactlyElementsOf(SecuredDataTables.MAIN);
assertThat(SecuredDataEnums.sources()).hasSize(6);
@@ -0,0 +1,261 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.secureddata;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.permissions.SecuredDataPermissions;
import com.kingsrook.qbits.secureddata.retention.RetentionRules;
import com.kingsrook.qbits.secureddata.support.SecuredDataMetadata;
import com.kingsrook.qqq.backend.core.cluster.ClusterBus;
import com.kingsrook.qqq.backend.core.cluster.ClusterCaches;
import com.kingsrook.qqq.backend.core.cluster.ClusterEvent;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryRecordStore;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.close;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.delete;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.insert;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.setup;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.update;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** The rule rows a node keeps (retention rules, policies, classifications) and
** the access fingerprint of a request: read once, cleared by every change on
** every node, never older than the maximum age, and never an empty answer when
** the rules cannot be read.
*******************************************************************************/
class SecuredDataRuleCachesTest
{
private static final List<String> ANNOUNCED = new ArrayList<>();
static
{
ClusterBus.on(ClusterEvent.TYPE_MEMO_INVALIDATE, (instance, event) -> ANNOUNCED.add(event.getName()));
}
QInstance instance;
QTableMetaData person;
SecuredDataRuntime runtime;
/*******************************************************************************
** A person table with a date, so a retention rule on it is valid.
*******************************************************************************/
@BeforeEach
void init() throws Exception
{
instance = setup();
person = instance.getTable("person");
person.withField(new QFieldMetaData("createDate", QFieldType.DATE_TIME).withBackendName("createDate"));
runtime = SecuredDataRuntime.current();
MemoryRecordStore.setCollectStatistics(true);
MemoryRecordStore.resetStatistics();
ANNOUNCED.clear();
}
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
MemoryRecordStore.setCollectStatistics(false);
close();
}
/*******************************************************************************
** An active rule on one field of the person table.
*******************************************************************************/
private static QRecord rule(String field) throws Exception
{
return (insert(SecuredDataTables.RETENTION_RULE, new QRecord().withValue("name", "30 days: " + field).withValue("table_name", "person")
.withValue("field_names", field).withValue("age_field_name", "createDate").withValue("age_days", 30).withValue("action", "NULL_WITH_MARKER")));
}
/*******************************************************************************
** Queries the in-memory store has run since the last reset.
*******************************************************************************/
private static int queries()
{
return (MemoryRecordStore.getStatistics().getOrDefault(MemoryRecordStore.STAT_QUERIES_RAN, 0));
}
/*******************************************************************************
** Core asks for the rules of a field on every audited field and filter
** criterion: many questions are one read, and every committed change (insert,
** update, delete) is seen by the next question.
*******************************************************************************/
@Test
void activeRetentionRulesAreReadOncePerChange() throws Exception
{
QRecord notes = rule("notes");
assertThat(notes.getErrors()).isNullOrEmpty();
MemoryRecordStore.resetStatistics();
for(int i = 0; i < 50; i++)
{
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(RetentionRules.active("person", "email")).isEmpty();
assertThat(RetentionRules.active("anotherTable", "notes")).isEmpty();
assertThat(RetentionRules.changedOnly("person", "notes")).isFalse();
}
assertThat(queries()).isLessThanOrEqualTo(1);
QRecord ssn = rule("ssn");
assertThat(RetentionRules.active("person", "ssn")).hasSize(1);
update(SecuredDataTables.RETENTION_RULE, new QRecord().withValue("id", notes.getValue("id")).withValue("is_active", false));
assertThat(RetentionRules.active("person", "notes")).isEmpty();
delete(SecuredDataTables.RETENTION_RULE, ssn);
assertThat(RetentionRules.active("person", "ssn")).isEmpty();
assertThat(ANNOUNCED).contains(SecuredDataRuntime.RETENTION_CACHE);
}
/*******************************************************************************
** A rule change made on another node arrives as a cluster cache event: each
** of the three kinds of rules is read again here. A change made here is
** announced to the other nodes.
*******************************************************************************/
@Test
void aChangeOnAnyNodeClearsTheRulesOnEveryNode() throws Exception
{
rule("notes");
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
long retention = runtime.retentionVersion();
long policies = runtime.policyVersion();
long classifications = runtime.classificationVersion();
ClusterCaches.invalidate(SecuredDataRuntime.RETENTION_CACHE);
ClusterCaches.invalidate(SecuredDataRuntime.POLICY_CACHE);
ClusterCaches.invalidate(SecuredDataRuntime.CLASSIFICATION_CACHE);
assertThat(runtime.retentionVersion()).isGreaterThan(retention);
assertThat(runtime.policyVersion()).isGreaterThan(policies);
assertThat(runtime.classificationVersion()).isGreaterThan(classifications);
MemoryRecordStore.resetStatistics();
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(queries()).isGreaterThanOrEqualTo(1);
MemoryRecordStore.resetStatistics();
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(queries()).isZero();
ANNOUNCED.clear();
runtime.invalidatePolicies();
runtime.invalidateClassifications();
runtime.invalidateRetentionRules();
assertThat(ANNOUNCED).contains(SecuredDataRuntime.POLICY_CACHE, SecuredDataRuntime.CLASSIFICATION_CACHE, SecuredDataRuntime.RETENTION_CACHE);
}
/*******************************************************************************
** Fail closed: when the rules cannot be read, asking for them throws. The
** rules read before are not used, and the answer is never an empty list.
*******************************************************************************/
@Test
void rulesThatCannotBeReadAreNeverAnEmptyAnswer() throws Exception
{
rule("notes");
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
QTableMetaData ruleTable = instance.getTables().remove(SecuredDataTables.RETENTION_RULE);
try
{
runtime.invalidateRetentionRules();
assertThatThrownBy(() -> RetentionRules.active("person", "notes")).isInstanceOf(RuntimeException.class);
assertThatThrownBy(() -> RetentionRules.active("person", "notes")).isInstanceOf(RuntimeException.class);
}
finally
{
instance.getTables().put(SecuredDataTables.RETENTION_RULE, ruleTable);
}
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
}
/*******************************************************************************
** The safety net for a lost cluster event: rows are read again once they are
** older than the maximum age.
*******************************************************************************/
@Test
void ruleRowsAreNotUsedPastTheirMaximumAge()
{
assertThat(SecuredDataRuntime.tooOld(System.nanoTime())).isFalse();
assertThat(SecuredDataRuntime.tooOld(System.nanoTime() - SecuredDataRuntime.MAX_RULE_AGE.plusSeconds(1).toNanos())).isTrue();
assertThat(SecuredDataRuntime.MAX_RULE_AGE.toSeconds()).isLessThanOrEqualTo(60);
}
/*******************************************************************************
** Core asks for the access fingerprint before every field decision. Within a
** request the same value object is returned; a permission that matters, given
** to the same session object, changes it at once.
*******************************************************************************/
@Test
void theAccessFingerprintIsKeptForTheRequestAndTracksThePermissions()
{
SecuredDataResolver resolver = runtime.resolver();
QSession session = QContext.getQSession();
String first = resolver.getAccessFingerprint();
for(int i = 0; i < 20; i++)
{
assertThat(resolver.getAccessFingerprint()).isSameAs(first);
}
session.getPermissions().add("unrelated.permission");
assertThat(resolver.getAccessFingerprint()).isEqualTo(first);
session.getPermissions().add(SecuredDataMetadata.permissionBase(person) + "." + SecuredDataPermissions.FULL);
String granted = resolver.getAccessFingerprint();
assertThat(granted).isNotEqualTo(first);
session.setPermissions(new HashSet<>(List.of("person.read")));
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(granted);
}
}
@@ -0,0 +1,682 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.secureddata;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicInteger;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.retention.RetentionRules;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizerInterface;
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizers;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessDecision;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.actions.tables.query.VirtualFieldValueProviderInterface;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.QueryOrGetInputInterface;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QVirtualFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryRecordStore;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.close;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.policyRow;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.setup;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.user;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Reading rule rows (classifications, retention rules, policies) is a query on
** a secured-data table, and other code runs inside that query: a virtual field
** value provider or a post-query customizer that another QBit or the host put
** on the table. When that code runs a query with filter criteria, core asks
** this QBit for a classification - which needs the rows being read.
**
** These tests put such code on the rule tables and prove: the read asks for
** stored fields only, so no value provider runs inside it; a question asked
** inside a read is answered from the rows held before and starts no other
** read; only the reading thread, as the system, can be given that answer; and
** a read that fails is tried again by the next question.
*******************************************************************************/
class SecuredDataRuleReloadTest
{
QInstance instance;
QTableMetaData person;
SecuredDataRuntime runtime;
/*******************************************************************************
** Something to do inside a query on a rule table.
*******************************************************************************/
@FunctionalInterface
interface NestedWork
{
/*******************************************************************************
** Do it.
*******************************************************************************/
void run() throws Exception;
}
/*******************************************************************************
** Stands in for another QBit's virtual field on a secured-data table: filling
** it runs a query that has filter criteria.
*******************************************************************************/
public static class NestedQueryProvider implements VirtualFieldValueProviderInterface
{
static final AtomicInteger RUNS = new AtomicInteger();
/*******************************************************************************
** Fill the field from a query with criteria, as a real provider does.
*******************************************************************************/
@Override
public void fill(QTableMetaData table, String fieldName, List<QRecord> records, QueryInput input) throws QException
{
RUNS.incrementAndGet();
queryWithCriteria();
records.forEach(record -> record.setValue(fieldName, "filled"));
}
}
/*******************************************************************************
** A post-query customizer on a secured-data table. Core runs it for every
** query on the table, whatever fields the query names.
*******************************************************************************/
public static class NestedWorkCustomizer implements TableCustomizerInterface
{
static final AtomicInteger RUNS = new AtomicInteger();
static volatile NestedWork work;
/*******************************************************************************
** Run the work the test asked for, inside the query.
*******************************************************************************/
@Override
public List<QRecord> postQuery(QueryOrGetInputInterface queryInput, List<QRecord> records) throws QException
{
NestedWork toRun = work;
if(toRun != null)
{
RUNS.incrementAndGet();
try
{
toRun.run();
}
catch(QException | RuntimeException e)
{
throw (e);
}
catch(Exception e)
{
throw (new QException("Nested work failed", e));
}
}
return (records);
}
}
/*******************************************************************************
** A person table with a date, so a retention rule on it is valid.
*******************************************************************************/
@BeforeEach
void init() throws Exception
{
instance = setup();
person = instance.getTable("person");
person.withField(new QFieldMetaData("createDate", QFieldType.DATE_TIME).withBackendName("createDate"));
runtime = SecuredDataRuntime.current();
NestedQueryProvider.RUNS.set(0);
NestedWorkCustomizer.RUNS.set(0);
NestedWorkCustomizer.work = null;
}
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
NestedWorkCustomizer.work = null;
close();
}
/*******************************************************************************
** A query with filter criteria on a host table: core validates the operand
** of a classified field, so it asks for the field's classification - and
** this QBit then asks whether a retention rule names the field.
*******************************************************************************/
private static void queryWithCriteria() throws QException
{
new QueryAction().execute(new QueryInput("person").withFilter(new QQueryFilter(new QFilterCriteria("id", QCriteriaOperator.EQUALS, 1))));
}
/*******************************************************************************
** Another QBit's virtual field on a secured-data table.
*******************************************************************************/
private void addProvider(String table)
{
instance.getTable(table).addVirtualField(new QVirtualFieldMetaData("labels", QFieldType.STRING).withIsQuerySelectable(true)
.withValueProvider(new QCodeReference(NestedQueryProvider.class)));
}
/*******************************************************************************
** A post-query customizer on a secured-data table.
*******************************************************************************/
private void addCustomizer(String table)
{
instance.getTable(table).withCustomizer(TableCustomizers.POST_QUERY_RECORD, new QCodeReference(NestedWorkCustomizer.class));
}
/*******************************************************************************
** A row as another node writes it: straight into the store. None of this
** node's customizers run and nothing here reads the rule rows; this node
** learns of the change when its version moves (the cluster event).
*******************************************************************************/
private static QRecord writtenElsewhere(String table, QRecord row) throws QException
{
return (MemoryRecordStore.getInstance().insert(new InsertInput(table).withRecord(row), true).getFirst());
}
/*******************************************************************************
** A classification of a person field, written by another node.
*******************************************************************************/
private QRecord classifiedElsewhere(String field, String classification) throws QException
{
QRecord row = writtenElsewhere(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("table_name", "person")
.withValue("field_name", field).withValue("classification", classification));
runtime.invalidateClassifications();
return (row);
}
/*******************************************************************************
** A classification row changed by another node.
*******************************************************************************/
private void reclassifiedElsewhere(QRecord row, String classification) throws QException
{
MemoryRecordStore.getInstance().update(new UpdateInput(SecuredDataTables.CLASSIFICATION).withRecord(new QRecord()
.withValue("id", row.getValue("id")).withValue("classification", classification)), false);
runtime.invalidateClassifications();
}
/*******************************************************************************
** An active retention rule on one field of the person table, written by
** another node.
*******************************************************************************/
private void ruleWrittenElsewhere(String field) throws QException
{
writtenElsewhere(SecuredDataTables.RETENTION_RULE, new QRecord().withValue("name", "30 days: " + field).withValue("table_name", "person")
.withValue("field_names", field).withValue("age_field_name", "createDate").withValue("age_days", 30).withValue("action", "NULL_WITH_MARKER")
.withValue("audit_treatment", "SHREDDABLE").withValue("is_active", true));
runtime.invalidateRetentionRules();
}
/*******************************************************************************
** The classification of a person field.
*******************************************************************************/
private DataClassification classificationOf(String field)
{
return (SecuredDataClassifications.effective(person, field));
}
/*******************************************************************************
** The reported failure: a value provider on the classification table whose
** work is a query with criteria, and one classification row. Before the fix
** the next classification question recursed until the stack overflowed, and
** so did every question after it. Now the rule read names its stored fields,
** so the provider does not run inside it at all.
*******************************************************************************/
@Test
void aValueProviderOnTheClassificationTableDoesNotRunInsideTheRuleRead() throws Exception
{
addProvider(SecuredDataTables.CLASSIFICATION);
classification("notes", "PHI");
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PHI);
queryWithCriteria();
assertThat(NestedQueryProvider.RUNS).hasValue(0);
assertThat(SystemWrites.query(SecuredDataTables.CLASSIFICATION, new QQueryFilter())).singleElement()
.satisfies(row -> assertThat(row.getValues()).doesNotContainKey("labels").containsEntry("field_name", "notes"));
}
/*******************************************************************************
** The virtual field is still there for a query that asks for every field (a
** screen listing the classifications). Its provider's query with criteria
** asks for a classification while the rows are out of date: the rows are
** read once, inside the provider, and nothing recurses.
*******************************************************************************/
@Test
void anOrdinaryQueryOnTheClassificationTableStillFillsTheVirtualField() throws Exception
{
addProvider(SecuredDataTables.CLASSIFICATION);
classifiedElsewhere("notes", "PHI");
List<QRecord> rows = SystemWrites.call(() -> new QueryAction().execute(new QueryInput(SecuredDataTables.CLASSIFICATION)).getRecords());
assertThat(rows).singleElement().satisfies(row -> assertThat(row.getValueString("labels")).isEqualTo("filled"));
assertThat(NestedQueryProvider.RUNS).hasValue(1);
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PHI);
}
/*******************************************************************************
** A post-query customizer runs inside the rule read whatever fields the read
** names. Its query with criteria asks for a classification in the middle of
** the read of the classifications: before the fix that started the read again
** and recursed until the stack overflowed. Now the rows are read once.
*******************************************************************************/
@Test
void aQuestionAskedInsideTheClassificationReadDoesNotStartAnotherRead() throws Exception
{
addCustomizer(SecuredDataTables.CLASSIFICATION);
classifiedElsewhere("notes", "PHI");
NestedWorkCustomizer.work = SecuredDataRuleReloadTest::queryWithCriteria;
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PHI);
assertThat(NestedWorkCustomizer.RUNS).hasValue(1);
assertThat(classificationOf("email")).isEqualTo(DataClassification.PII);
assertThat(NestedWorkCustomizer.RUNS).hasValue(1);
}
/*******************************************************************************
** What a question asked inside the read is told, and who can ask it.
**
** The nested question gets the rows this node held when the read began (no
** rows, the first time; then the rows of the previous version), in both
** directions of a change. It can only be asked by the thread doing the read,
** which is inside the QBit's system read: the session is the system session
** and the resolver answers FULL there without looking at any classification,
** so no person's field access is decided from that answer. The question that
** started the read gets the new rows.
*******************************************************************************/
@Test
void aQuestionAskedInsideTheReadIsAnsweredFromTheRowsHeldBefore() throws Exception
{
addCustomizer(SecuredDataTables.CLASSIFICATION);
assertThat(classificationOf("notes")).isNull();
List<DataClassification> nestedAnswers = new ArrayList<>();
List<Boolean> nestedAsSystem = new ArrayList<>();
List<FieldAccessDecision> nestedDecisions = new ArrayList<>();
NestedWork ask = () ->
{
nestedAnswers.add(classificationOf("notes"));
nestedAsSystem.add(QContext.getQSession() instanceof QSystemUserSession && SystemWrites.active());
nestedDecisions.add(runtime.resolver().resolve(person, person.getField("notes")));
};
/////////////////////////////////////////////////////////////////////////
// a row raises the field: inside the read it is still unclassified, //
// and the question that started the read is answered PHI //
/////////////////////////////////////////////////////////////////////////
QRecord row = classifiedElsewhere("notes", "PHI");
NestedWorkCustomizer.work = ask;
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PHI);
NestedWorkCustomizer.work = null;
assertThat(nestedAnswers).containsExactly((DataClassification) null);
/////////////////////////////////////////////////////////////////////////
// the row is changed to lower the field: inside the read it is still //
// PHI, and the question that started the read is answered PUBLIC //
/////////////////////////////////////////////////////////////////////////
reclassifiedElsewhere(row, "PUBLIC");
NestedWorkCustomizer.work = ask;
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PUBLIC);
NestedWorkCustomizer.work = null;
assertThat(nestedAnswers).containsExactly(null, DataClassification.PHI);
assertThat(nestedAsSystem).containsExactly(true, true);
assertThat(nestedDecisions).containsExactly(FieldAccessDecision.FULL, FieldAccessDecision.FULL);
assertThat(NestedWorkCustomizer.RUNS).hasValue(2);
}
/*******************************************************************************
** A request on another thread is never given the rows held before: while the
** read is running it waits, and then it is answered from the rows the read
** returned.
*******************************************************************************/
@Test
void aRequestOnAnotherThreadWaitsForTheReadAndIsGivenItsRows() throws Exception
{
addCustomizer(SecuredDataTables.CLASSIFICATION);
QRecord row = classifiedElsewhere("notes", "PUBLIC");
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PUBLIC);
reclassifiedElsewhere(row, "PHI");
CountDownLatch readIsRunning = new CountDownLatch(1);
CountDownLatch letReadFinish = new CountDownLatch(1);
NestedWorkCustomizer.work = () ->
{
readIsRunning.countDown();
assertThat(letReadFinish.await(30, TimeUnit.SECONDS)).isTrue();
};
ExecutorService pool = Executors.newFixedThreadPool(2);
try
{
Future<DataClassification> reader = pool.submit(asUser("u2", () -> classificationOf("notes")));
assertThat(readIsRunning.await(30, TimeUnit.SECONDS)).isTrue();
Future<DataClassification> other = pool.submit(asUser("u3", () -> classificationOf("notes")));
assertThatThrownBy(() -> other.get(500, TimeUnit.MILLISECONDS)).isInstanceOf(TimeoutException.class);
letReadFinish.countDown();
assertThat(reader.get(30, TimeUnit.SECONDS)).isEqualTo(DataClassification.PHI);
assertThat(other.get(30, TimeUnit.SECONDS)).isEqualTo(DataClassification.PHI);
assertThat(NestedWorkCustomizer.RUNS).hasValue(1);
}
finally
{
letReadFinish.countDown();
pool.shutdownNow();
}
}
/*******************************************************************************
** A person's request on its own thread.
*******************************************************************************/
private <T> Callable<T> asUser(String id, Callable<T> work)
{
return (() ->
{
QContext.init(instance, user(id));
try
{
return (work.call());
}
finally
{
QContext.clear();
}
});
}
/*******************************************************************************
** A read that fails (here, in code running inside it, after that code asked a
** nested question) throws to the request that started it and leaves nothing
** behind: the next request reads again and gets the current rows - not the
** rows held before, and not another failure. An Error, such as the stack
** overflow this defect used to end in, is no different.
*******************************************************************************/
@Test
void aClassificationReadThatFailsIsTriedAgainByTheNextQuestion() throws Exception
{
addCustomizer(SecuredDataTables.CLASSIFICATION);
QRecord row = classifiedElsewhere("notes", "PUBLIC");
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PUBLIC);
reclassifiedElsewhere(row, "PHI");
NestedWorkCustomizer.work = () ->
{
classificationOf("notes");
throw (new QException("The store is unavailable"));
};
assertThatThrownBy(() -> classificationOf("notes")).isInstanceOf(IllegalStateException.class);
NestedWorkCustomizer.work = () ->
{
classificationOf("notes");
throw (new StackOverflowError());
};
assertThatThrownBy(() -> classificationOf("notes")).isInstanceOf(StackOverflowError.class);
NestedWorkCustomizer.work = null;
assertThat(classificationOf("notes")).isEqualTo(DataClassification.PHI);
}
/*******************************************************************************
** The active retention rules have the same shape: core's classification
** question for a host field also asks whether a retention rule names the
** field. A value provider on the retention rule table, with one active rule,
** recursed the same way before the fix; it does not run inside the rule read.
*******************************************************************************/
@Test
void aValueProviderOnTheRetentionRuleTableDoesNotRunInsideTheRuleRead() throws Exception
{
addProvider(SecuredDataTables.RETENTION_RULE);
ruleWrittenElsewhere("notes");
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
queryWithCriteria();
assertThat(NestedQueryProvider.RUNS).hasValue(0);
}
/*******************************************************************************
** A question asked inside the read of the retention rules starts no other
** read and is answered from the rules held before; the question that started
** the read gets the new rules. A read that fails is tried again.
*******************************************************************************/
@Test
void aQuestionAskedInsideTheRetentionRuleReadIsAnsweredFromTheRulesHeldBefore() throws Exception
{
addCustomizer(SecuredDataTables.RETENTION_RULE);
assertThat(RetentionRules.active("person", "notes")).isEmpty();
ruleWrittenElsewhere("notes");
List<Integer> nestedAnswers = new ArrayList<>();
NestedWorkCustomizer.work = () ->
{
queryWithCriteria();
nestedAnswers.add(RetentionRules.active("person", "notes").size());
if(nestedAnswers.size() == 1)
{
throw (new QException("The store is unavailable"));
}
};
assertThatThrownBy(() -> RetentionRules.active("person", "notes")).isInstanceOf(IllegalStateException.class);
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(nestedAnswers).containsExactly(0, 0);
assertThat(NestedWorkCustomizer.RUNS).hasValue(2);
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(NestedWorkCustomizer.RUNS).hasValue(2);
}
/*******************************************************************************
** A transaction that edited a rule reads the rules through itself, not from
** the rules the node keeps. A question asked inside that read is answered
** from the rules every thread shares: before the fix it read the edits again,
** and recursed until the stack overflowed.
*******************************************************************************/
@Test
void aQuestionAskedInsideAReadOfATransactionsOwnEditsDoesNotReadThemAgain() throws Exception
{
addCustomizer(SecuredDataTables.RETENTION_RULE);
ruleWrittenElsewhere("notes");
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
QContext.setTransaction(new QBackendTransaction());
RetentionRules.editedInTransaction();
try
{
NestedWorkCustomizer.work = SecuredDataRuleReloadTest::queryWithCriteria;
assertThat(RetentionRules.active("person", "notes")).hasSize(1);
assertThat(NestedWorkCustomizer.RUNS).hasValue(1);
}
finally
{
////////////////////////////////////////////////////////////////////////
// the next question outside a transaction ends this thread's edits //
////////////////////////////////////////////////////////////////////////
NestedWorkCustomizer.work = null;
QContext.setTransaction(null);
RetentionRules.active("person", "notes");
}
}
/*******************************************************************************
** The policies are read the same way (rows first, version afterwards), so
** they are guarded the same way: code inside the policy read that asks the
** resolver a policy question starts no other read, and a read that fails is
** tried again.
*******************************************************************************/
@Test
void aQuestionAskedInsideThePolicyReadDoesNotStartAnotherRead() throws Exception
{
addCustomizer(SecuredDataTables.POLICY);
addProvider(SecuredDataTables.POLICY);
assertThat(runtime.resolver().revealPolicies(person, "email")).isEmpty();
writtenElsewhere(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE"));
runtime.invalidatePolicies();
List<Integer> nestedAnswers = new ArrayList<>();
NestedWorkCustomizer.work = () ->
{
nestedAnswers.add(runtime.resolver().revealPolicies(person, "email").size());
if(nestedAnswers.size() == 1)
{
throw (new QException("The store is unavailable"));
}
};
assertThatThrownBy(() -> runtime.resolver().revealPolicies(person, "email")).isInstanceOf(IllegalStateException.class);
assertThat(runtime.resolver().revealPolicies(person, "email")).hasSize(1);
assertThat(nestedAnswers).containsExactly(0, 0);
assertThat(NestedQueryProvider.RUNS).hasValue(0);
NestedWorkCustomizer.RUNS.set(0);
assertThat(runtime.resolver().revealPolicies(person, "email")).hasSize(1);
assertThat(NestedWorkCustomizer.RUNS).hasValue(0);
}
/*******************************************************************************
** The rows themselves, without a table: nothing is held before the first
** read, a nested question never reads, a failed read is forgotten, and a new
** version is read once.
*******************************************************************************/
@Test
void ruleRowsAreReadOncePerVersionAndNeverFromInsideTheirOwnRead()
{
RuleRows rows = new RuleRows();
AtomicInteger reads = new AtomicInteger();
List<QRecord> first = List.of(new QRecord().withValue("id", 1));
List<QRecord> second = List.of(new QRecord().withValue("id", 2));
assertThatThrownBy(() -> rows.get(1, () ->
{
reads.incrementAndGet();
assertThat(rows.get(1, () -> fail("a nested question must not read"))).isEmpty();
throw (new IllegalStateException("The store is unavailable"));
})).isInstanceOf(IllegalStateException.class);
assertThat(rows.get(1, () ->
{
reads.incrementAndGet();
assertThat(rows.get(1, () -> fail("a nested question must not read"))).isEmpty();
return (first);
})).isEqualTo(first);
assertThat(rows.get(1, () -> fail("rows of this version are held"))).isEqualTo(first);
assertThat(rows.get(2, () ->
{
reads.incrementAndGet();
assertThat(rows.get(2, () -> fail("a nested question must not read"))).isEqualTo(first);
return (second);
})).isEqualTo(second);
assertThat(reads).hasValue(3);
}
/*******************************************************************************
** A read that must not happen.
*******************************************************************************/
private static List<QRecord> fail(String why)
{
throw (new AssertionError(why));
}
}
@@ -0,0 +1,774 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2025. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kingsrook.qbits.secureddata;
import java.io.IOException;
import java.io.Serializable;
import java.nio.file.Files;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.retention.WipeService;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.ai.AiExposure;
import com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData;
import com.kingsrook.qqq.backend.core.actions.ai.AiTableMetaData;
import com.kingsrook.qqq.backend.core.actions.ai.DataClassification;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.ClassifiedValueTokens;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEvent;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEventType;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessOutcome;
import com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessTier;
import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterCriteria;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QFilterOrderBy;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.fields.DynamicDefaultValueBehavior;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.CLOCK;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.NOW;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.RUNTIMES;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.base;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.insert;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.logs;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.person;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.policyRow;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.setup;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.update;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.user;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Every table has a create date and a modify date: what the metadata says of
** them, who may read them, every writer of this QBit setting them, what the
** access-log writer runs for a row, the records of a changed policy, and rows
** that were written before the two columns existed.
*******************************************************************************/
class SecuredDataStandardDatesTest
{
static final String DDL = "docs/ddl/secured-data-postgres.sql";
/** The first line of the block of the DDL that an existing database runs to get the two columns. */
static final String DDL_BLOCK = "-- Standard dates:";
/** The tables that had the two dates before the other tables did: they keep the field names they have always had. */
private static final Set<String> SNAKE_CASE_NAMES = Set.of("secured_data_classification", "secured_data_policy", "secured_data_retention_rule");
private static final Instant LATER = NOW.plusSeconds(90);
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
RetentionTestSupport.close();
}
/*******************************************************************************
** The tables the producer put in an instance, whichever class declares them,
** so that a table added later is covered without being named here.
*******************************************************************************/
static List<QTableMetaData> declared(QInstance instance)
{
String qBit = instance.getQBits().get("com.kingsrook.qbits:qbit-secured-data").getName();
List<QTableMetaData> tables = instance.getTables().values().stream().filter(table -> qBit.equals(table.getSourceQBitName())).toList();
assertThat(tables).extracting(QTableMetaData::getName).containsAll(SecuredDataTables.ALL);
return (tables);
}
/*******************************************************************************
** Create date field name.
*******************************************************************************/
private static String createDate(String table)
{
return (SNAKE_CASE_NAMES.contains(table) ? "create_date" : "createDate");
}
/*******************************************************************************
** Modify date field name.
*******************************************************************************/
private static String modifyDate(String table)
{
return (SNAKE_CASE_NAMES.contains(table) ? "modify_date" : "modifyDate");
}
/*******************************************************************************
** What the QBit declares, before core enriches anything: core gives a field
** named createDate or modifyDate its behavior by itself, unless a host turned
** that off, and gives the snake_case names nothing.
*******************************************************************************/
@Test
void everyDeclaredTableHasACreateDateAndAModifyDate() throws Exception
{
QInstance instance = base();
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
instance.addTable(person("memory"));
new SecuredDataQBitProducer().withQBitConfig(new SecuredDataQBitConfig().withClock(CLOCK).withAccessLogFlushIntervalMillis(60000)).produce(instance);
QContext.init(instance, user("u1"));
RUNTIMES.add(SecuredDataRuntime.current());
for(QTableMetaData table : declared(instance))
{
assertDate(table, createDate(table.getName()), "create_date", DynamicDefaultValueBehavior.CREATE_DATE);
assertDate(table, modifyDate(table.getName()), "modify_date", DynamicDefaultValueBehavior.MODIFY_DATE);
}
}
/*******************************************************************************
** One date field: a date-time nobody edits, kept by core, in a section.
*******************************************************************************/
private static void assertDate(QTableMetaData table, String name, String column, DynamicDefaultValueBehavior behavior)
{
String where = table.getName() + "." + name;
assertThat(table.getFields()).as(where).containsKey(name);
QFieldMetaData field = table.getField(name);
assertThat(field.getType()).as(where).isEqualTo(QFieldType.DATE_TIME);
assertThat(field.getIsEditable()).as(where).isFalse();
assertThat(field.getBehaviorOnlyIfSet(DynamicDefaultValueBehavior.class)).as(where).isEqualTo(behavior);
assertThat(field.getBackendName()).as(where).isEqualTo(column);
assertThat(table.getFields().values()).as(where).filteredOn(other -> other.getBehaviorOnlyIfSet(DynamicDefaultValueBehavior.class) == behavior).hasSize(1);
assertThat(table.getSections()).as(where).anySatisfy(section -> assertThat(section.getFieldNames()).contains(name));
}
/*******************************************************************************
** The two dates have no classification, policy or assistant exposure of their
** own. Whoever asks, they are given the tier of every other field of their
** table that has none of its own either, and the assistant is given nothing.
*******************************************************************************/
@Test
void theDatesAreReadableExactlyWhereTheOtherFieldsOfTheirTableAre() throws Exception
{
QInstance instance = setup(config -> config.withDefaultTier(DataClassification.CONFIDENTIAL, FieldAccessTier.MASKED));
insert(SecuredDataTables.POLICY, policyRow("hidden", "CONFIDENTIAL", "HIDDEN"));
insert(SecuredDataTables.POLICY, policyRow("full", "CONFIDENTIAL", "FULL"));
insert(SecuredDataTables.POLICY, policyRow("capped", "CONFIDENTIAL", "FULL"));
insert(SecuredDataTables.POLICY, policyRow("capped", "CONFIDENTIAL", "HIDDEN").withValue("client_channel", "web"));
Map<String, QSession> sessions = new LinkedHashMap<>();
sessions.put("the default tier", user("u1"));
sessions.put("a policy that hides", user("u2", "hidden"));
sessions.put("a policy that shows", user("u3", "full"));
sessions.put("a channel cap", SecuredDataTestSupport.channelUser("web", "capped"));
sessions.put("the administrator", user("u4", "secured_data.admin"));
Map<String, FieldAccessTier> expected = Map.of("the default tier", FieldAccessTier.MASKED, "a policy that hides", FieldAccessTier.HIDDEN,
"a policy that shows", FieldAccessTier.FULL, "a channel cap", FieldAccessTier.HIDDEN, "the administrator", FieldAccessTier.FULL);
for(Map.Entry<String, QSession> session : sessions.entrySet())
{
QContext.setQSession(session.getValue());
for(QTableMetaData table : declared(instance))
{
for(String name : List.of(createDate(table.getName()), modifyDate(table.getName())))
{
String where = session.getKey() + ": " + table.getName() + "." + name;
QFieldMetaData date = table.getField(name);
assertThat(AiFieldMetaData.of(date)).as(where).isNull();
assertThat(SecuredDataClassifications.effective(table, name)).as(where).isEqualTo(DataClassification.CONFIDENTIAL);
FieldAccessTier tier = SecuredDataRuntime.current().resolver().resolve(table, date).tier();
assertThat(tier).as(where).isEqualTo(expected.get(session.getKey()));
for(QFieldMetaData other : table.getFields().values())
{
if(!other.getName().equals(table.getPrimaryKeyField()))
{
assertThat(SecuredDataRuntime.current().resolver().resolve(table, other).tier()).as(where + " and " + other.getName()).isEqualTo(tier);
}
}
}
assertThat(AiTableMetaData.of(table).getExposure()).as(table.getName()).isEqualTo(AiExposure.NONE);
}
}
}
/*******************************************************************************
** Every writer of this QBit, on the memory backend: the access-log writer, a
** changed policy and classification with their own log rows, a legal hold, a
** reveal and a break-glass session from its start to its end and its expiry.
** A new row has both dates, equal, from the clock of the QBit. A changed row
** keeps its create date and has a later modify date, which core chooses (the
** modify date is the record version of its table).
*******************************************************************************/
@Test
void everyWriterSetsBothDatesAndOnlyAChangeMovesTheModifyDate() throws Exception
{
setup();
////////////////////////////////////////////////////////////////////////////
// the access-log writer: created_at is when the access happened, the two //
// dates are when the writer's one insert wrote the row //
////////////////////////////////////////////////////////////////////////////
SecuredDataRuntime.current().logger().onAccess(SecuredDataAccessLoggerTest.event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, "hmac"));
CLOCK.now = LATER;
SecuredDataRuntime.current().logger().flush();
QRecord logged = logs().getLast();
assertThat(logged.getValueString("event_type")).isEqualTo("EXACT_MATCH_FILTER");
assertThat(logged.getValueInstant("created_at")).isEqualTo(NOW);
assertDates(logged, SecuredDataTables.ACCESS_LOG, LATER, LATER);
assertThatThrownBy(() -> update(SecuredDataTables.ACCESS_LOG, new QRecord().withValue("id", logged.getValue("id")).withValue("outcome", "DENIED"))).isInstanceOf(Exception.class);
assertDates(row(SecuredDataTables.ACCESS_LOG, logged.getValue("id")), SecuredDataTables.ACCESS_LOG, LATER, LATER);
CLOCK.now = NOW;
///////////////////////////////////////////////////////////////////////
// the rows the rules are read from, and the log row of every change //
///////////////////////////////////////////////////////////////////////
QRecord policy = insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("reason_options", "Support").withValue("allow_free_text_reason", false));
QRecord classification = classification("notes", "PII");
QRecord hold = insert(SecuredDataTables.LEGAL_HOLD, new QRecord().withValue("table_name", "person").withValue("reason", "Preservation"));
Map<String, Serializable> written = new LinkedHashMap<>();
written.put(SecuredDataTables.POLICY, policy.getValue("id"));
written.put(SecuredDataTables.CLASSIFICATION, classification.getValue("id"));
written.put(SecuredDataTables.LEGAL_HOLD, hold.getValue("id"));
for(Map.Entry<String, Serializable> row : written.entrySet())
{
assertDates(row(row.getKey(), row.getValue()), row.getKey(), NOW, NOW);
}
assertDates(log("POLICY_CHANGE", "INSERT"), SecuredDataTables.ACCESS_LOG, NOW, NOW);
assertDates(log("CLASSIFICATION_CHANGE", "INSERT"), SecuredDataTables.ACCESS_LOG, NOW, NOW);
CLOCK.now = LATER;
update(SecuredDataTables.POLICY, new QRecord().withValue("id", policy.getValue("id")).withValue("name", "renamed"));
update(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("id", classification.getValue("id")).withValue("notes", "reviewed"));
update(SecuredDataTables.LEGAL_HOLD, new QRecord().withValue("id", hold.getValue("id")).withValue("status", "RELEASED"));
for(Map.Entry<String, Serializable> row : written.entrySet())
{
assertChanged(row(row.getKey(), row.getValue()), row.getKey(), NOW, NOW);
}
assertDates(log("POLICY_CHANGE", "UPDATE"), SecuredDataTables.ACCESS_LOG, LATER, LATER);
assertDates(log("CLASSIFICATION_CHANGE", "UPDATE"), SecuredDataTables.ACCESS_LOG, LATER, LATER);
CLOCK.now = NOW;
////////////////////////////////////////////
// a reveal: its grant and its log row //
////////////////////////////////////////////
Serializable person = insert("person", new QRecord().withValue("email", "someone@example.invalid")).getValue("id");
new RevealService().reveal("person", person, "email", "Support", null);
assertDates(SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter()).getFirst(), SecuredDataTables.REVEAL_GRANT, NOW, NOW);
assertDates(log("REVEAL", null), SecuredDataTables.ACCESS_LOG, NOW, NOW);
//////////////////////////////////////////////////////////////////////
// a break-glass session: started, then ended; started, then expired //
//////////////////////////////////////////////////////////////////////
BreakGlassService breaks = new BreakGlassService();
QContext.setQSession(user("u1", "cs_admin", BreakGlassService.START + ".hasAccess"));
Serializable ended = breaks.start("Investigating urgent incident", 60, null, null).getValue("id");
assertDates(breaks.find(ended), SecuredDataTables.BREAK_GLASS, NOW, NOW);
CLOCK.now = LATER;
breaks.end(ended);
Instant endedAt = assertChanged(breaks.find(ended), SecuredDataTables.BREAK_GLASS, NOW, NOW);
assertDates(log("BREAK_GLASS_END", null), SecuredDataTables.ACCESS_LOG, LATER, LATER);
Serializable expired = breaks.start("Investigating another incident", 1, null, null).getValue("id");
assertDates(breaks.find(expired), SecuredDataTables.BREAK_GLASS, LATER, LATER);
CLOCK.now = LATER.plusSeconds(60);
assertThat(breaks.expire()).isEqualTo(1);
assertChanged(breaks.find(expired), SecuredDataTables.BREAK_GLASS, LATER, LATER);
assertDates(breaks.find(ended), SecuredDataTables.BREAK_GLASS, NOW, endedAt);
/////////////////////////////////////////////////////////////////////////
// the access log is only ever inserted, so no row's modify date moved //
/////////////////////////////////////////////////////////////////////////
assertThat(logs()).hasSizeGreaterThan(8).allSatisfy(row ->
{
assertThat(row.getValueInstant("createDate")).isNotNull();
assertThat(row.getValueInstant("modifyDate")).isEqualTo(row.getValueInstant("createDate"));
});
}
/*******************************************************************************
** The writers of a wipe, in the shipped schema: the audit key, the run, the
** marker (written once, then changed by a later wipe of the same field), the
** log row, and the rule the run is recorded on. A time is compared with what
** the same database gives back for another time written from the same clock,
** not with the clock: the test database shifts a time by the zone of the
** machine it runs on.
*******************************************************************************/
@Test
void aWipeSetsBothDatesInTheShippedSchema() throws Exception
{
RetentionTestSupport.setup();
QRecord rule = RetentionTestSupport.rule("OVERWRITE_TEXT", "secret");
QRecord reading = RetentionTestSupport.reading(120);
assertThat(SecuredDataRuntime.current().keys().keyForRecordField("reading", "secret", reading.getValue("id"), true)).isPresent();
QRecord key = RetentionTestSupport.rows(SecuredDataTables.AUDIT_KEY).getFirst();
assertDates(key, SecuredDataTables.AUDIT_KEY, key.getValueInstant("created_at"), key.getValueInstant("created_at"));
Instant ruleWritten = row(SecuredDataTables.RETENTION_RULE, rule.getValue("id")).getValueInstant("create_date");
assertDates(row(SecuredDataTables.RETENTION_RULE, rule.getValue("id")), SecuredDataTables.RETENTION_RULE, ruleWritten, ruleWritten);
CLOCK.now = LATER;
QRecord run = new WipeService().batch(rule.getValue("id"), List.of(reading.getValue("id")));
assertThat(run.getValueInteger("wiped_count")).isEqualTo(1);
Instant wiped = ruleWritten.plusSeconds(90);
QRecord firstRun = row(SecuredDataTables.WIPE_RUN, run.getValue("id"));
assertThat(firstRun.getValueInstant("finished_at")).isEqualTo(wiped);
assertDates(firstRun, SecuredDataTables.WIPE_RUN, wiped, wiped);
QRecord marker = RetentionTestSupport.rows(SecuredDataTables.WIPE_MARKER).getFirst();
assertThat(marker.getValueInstant("wiped_at")).isEqualTo(wiped);
assertDates(marker, SecuredDataTables.WIPE_MARKER, wiped, wiped);
assertThat(log("WIPE", "OVERWRITE_TEXT").getValueInstant("created_at")).isEqualTo(wiped);
assertDates(log("WIPE", "OVERWRITE_TEXT"), SecuredDataTables.ACCESS_LOG, wiped, wiped);
Instant ruleRun = assertChanged(row(SecuredDataTables.RETENTION_RULE, rule.getValue("id")), SecuredDataTables.RETENTION_RULE, ruleWritten, ruleWritten);
///////////////////////////////////////////////////////////////////////////
// the field is given a value again and wiped again: the marker of that //
// record and field is changed, and no second marker is written //
///////////////////////////////////////////////////////////////////////////
CLOCK.now = LATER.plusSeconds(90);
Instant again = wiped.plusSeconds(90);
update("reading", new QRecord().withValue("id", reading.getValue("id")).withValue("secret", "another-test-secret"));
QRecord second = new WipeService().batch(rule.getValue("id"), List.of(reading.getValue("id")));
assertThat(second.getValueInteger("wiped_count")).isEqualTo(1);
assertThat(RetentionTestSupport.rows(SecuredDataTables.WIPE_MARKER)).hasSize(1);
QRecord changed = row(SecuredDataTables.WIPE_MARKER, marker.getValue("id"));
assertThat(changed.getValue("run_id")).isEqualTo(second.getValue("id"));
assertThat(changed.getValueInstant("wiped_at")).isEqualTo(again);
assertChanged(changed, SecuredDataTables.WIPE_MARKER, wiped, wiped);
assertDates(row(SecuredDataTables.WIPE_RUN, run.getValue("id")), SecuredDataTables.WIPE_RUN, wiped, wiped);
assertDates(row(SecuredDataTables.WIPE_RUN, second.getValue("id")), SecuredDataTables.WIPE_RUN, again, again);
assertChanged(row(SecuredDataTables.RETENTION_RULE, rule.getValue("id")), SecuredDataTables.RETENTION_RULE, ruleWritten, ruleRun);
}
/*******************************************************************************
** The access-log writer runs concurrently with reveals, so the dates must cost
** it nothing: for each row it still runs one insert, which now names the two
** columns, and no other statement that writes the log.
*******************************************************************************/
@Test
void theAccessLogWriterStillRunsOneInsertForARow() throws Exception
{
RetentionTestSupport.setup();
try(Connection connection = DriverManager.getConnection(url(), "sa", ""))
{
connection.createStatement().execute("SET QUERY_STATISTICS TRUE");
for(int i = 0; i < 3; i++)
{
SecuredDataRuntime.current().logger().onAccess(new FieldAccessEvent().withType(FieldAccessEventType.EXACT_MATCH_FILTER).withOutcome(FieldAccessOutcome.MATCH)
.withTableName("reading").withFieldNames(List.of("secret")).withActionName("query").withRecordCount(1).withSearchValueFingerprints(List.of("hmac" + i)));
}
SecuredDataRuntime.current().logger().flush();
assertThat(rows(connection, SecuredDataTables.ACCESS_LOG, false)).hasSize(3).allSatisfy(row -> assertThat(row.get("create_date")).isNotNull().isEqualTo(row.get("modify_date")));
Map<String, Integer> writes = new LinkedHashMap<>();
try(ResultSet statistics = connection.createStatement().executeQuery("SELECT SQL_STATEMENT, EXECUTION_COUNT FROM INFORMATION_SCHEMA.QUERY_STATISTICS"))
{
while(statistics.next())
{
String sql = statistics.getString(1).strip();
if(sql.contains(SecuredDataTables.ACCESS_LOG) && !sql.toUpperCase().startsWith("SELECT"))
{
writes.merge(sql, statistics.getInt(2), Integer::sum);
}
}
}
assertThat(writes).hasSize(1);
assertThat(writes.keySet().iterator().next()).startsWithIgnoringCase("INSERT INTO").contains("create_date", "modify_date");
assertThat(writes.values()).containsExactly(3);
}
}
/*******************************************************************************
** A changed policy or classification writes what it wrote before the tables
** had the standard dates: its core audit, field by field, and its
** POLICY_CHANGE or CLASSIFICATION_CHANGE row in the access log.
*******************************************************************************/
@Test
void aChangedPolicyOrClassificationWritesItsAuditAndItsLogRowAsBefore() throws Exception
{
QInstance instance = RetentionTestSupport.setup();
QRecord policy = new InsertAction().execute(new InsertInput(SecuredDataTables.POLICY).withRecord(policyRow("viewer", "PHI", "MASKED"))).getRecords().getFirst();
QRecord classification = new InsertAction().execute(new InsertInput(SecuredDataTables.CLASSIFICATION).withRecord(new QRecord().withValue("table_name", "reading")
.withValue("field_name", "notes").withValue("classification", "PHI"))).getRecords().getFirst();
assertThat(policy.getErrors()).isNullOrEmpty();
assertThat(classification.getErrors()).isNullOrEmpty();
CLOCK.now = LATER;
assertThat(new UpdateAction().execute(new UpdateInput(SecuredDataTables.POLICY).withRecord(new QRecord().withValue("id", policy.getValue("id")).withValue("tier", "HIDDEN")))
.getRecords().getFirst().getErrors()).isNullOrEmpty();
assertThat(new UpdateAction().execute(new UpdateInput(SecuredDataTables.CLASSIFICATION).withRecord(new QRecord().withValue("id", classification.getValue("id"))
.withValue("classification", "PII"))).getRecords().getFirst().getErrors()).isNullOrEmpty();
new DeleteAction().execute(new DeleteInput(SecuredDataTables.POLICY).withPrimaryKeys(List.of(policy.getValue("id"))));
new DeleteAction().execute(new DeleteInput(SecuredDataTables.CLASSIFICATION).withPrimaryKeys(List.of(classification.getValue("id"))));
///////////////////////////////////////////////////////////////////////////
// the log rows: one per change, with every value they have always had //
///////////////////////////////////////////////////////////////////////////
List<String> changes = new ArrayList<>();
List<QRecord> logged = RetentionTestSupport.rows(SecuredDataTables.ACCESS_LOG);
Instant inserted = logged.getFirst().getValueInstant("created_at");
for(QRecord row : logged)
{
changes.add(String.join(" ", row.getValueString("event_type"), row.getValueString("table_name"), row.getValueString("record_id"), row.getValueString("action_name"),
row.getValueString("outcome"), row.getValueString("user_id"), row.getValueString("user_name"),
"after " + Duration.between(inserted, row.getValueInstant("created_at")).toSeconds() + " s", String.valueOf(row.getValueBoolean("anomaly_flag"))));
for(String empty : List.of("field_name", "record_count", "reason", "reason_text", "client_channel", "break_glass_id", "search_value_fingerprints", "rule_id"))
{
assertThat(row.getValue(empty)).as(empty).isNull();
}
}
String policyId = policy.getValueString("id");
String classificationId = classification.getValueString("id");
assertThat(changes).containsExactly(
"POLICY_CHANGE secured_data_policy " + policyId + " INSERT ALLOWED admin admin after 0 s false",
"CLASSIFICATION_CHANGE secured_data_classification " + classificationId + " INSERT ALLOWED admin admin after 0 s false",
"POLICY_CHANGE secured_data_policy " + policyId + " UPDATE ALLOWED admin admin after 90 s false",
"CLASSIFICATION_CHANGE secured_data_classification " + classificationId + " UPDATE ALLOWED admin admin after 90 s false",
"POLICY_CHANGE secured_data_policy " + policyId + " DELETE ALLOWED admin admin after 90 s false",
"CLASSIFICATION_CHANGE secured_data_classification " + classificationId + " DELETE ALLOWED admin admin after 90 s false");
//////////////////////////////////////////////////////////////////////////////
// the core audits of the two rows: the same audits with the same details, //
// the two dates among them under the names they have always been audited by //
//////////////////////////////////////////////////////////////////////////////
assertThat(audits(instance, SecuredDataTables.POLICY, policy.getValue("id"))).containsExactly(
"Record was Inserted: allow_free_text_reason [Set allow free text reason to Yes], classification [Set classification to PHI], create_date,"
+ " distinct_value_alert [Set distinct value alert to 15], exact_match_per_hour [Set exact match per hour to 20], id [Set Id to " + policyId + "],"
+ " is_active [Set is active to Yes], min_entropy_enabled [Set min entropy enabled to Yes], miss_alert_consecutive [Set miss alert consecutive to 5],"
+ " modified_by [Set modified by to admin], modify_date, name [Set name to viewer PHI], permission_name [Set permission name to viewer],"
+ " require_free_text [Set require free text to No], reveal_minutes [Set reveal minutes to 5], tier [Set tier to MASKED]",
"Record was Edited: modify_date, tier [Changed tier from \"MASKED\" to \"HIDDEN\"]",
"Record was Deleted: ");
assertThat(audits(instance, SecuredDataTables.CLASSIFICATION, classification.getValue("id"))).containsExactly(
"Record was Inserted: classification [Set classification to PHI], create_date, field_name [Set field name to notes], id [Set Id to " + classificationId + "],"
+ " modified_by [Set modified by to admin], modify_date, table_name [Set table name to Reading]",
"Record was Edited: classification [Changed classification from \"PHI\" to \"PII\"], modify_date",
"Record was Deleted: ");
}
/*******************************************************************************
** The core audits of one record, oldest first: the message of each and, in
** the order of the field names, the fields it has a detail for and what the
** detail says. The two dates are named only: how a time reads depends on the
** zone of the machine.
*******************************************************************************/
private static List<String> audits(QInstance instance, String table, Serializable id)
{
Serializable auditTable = SystemWrites.query("auditTable", new QQueryFilter().withCriteria(new QFilterCriteria("name", QCriteriaOperator.EQUALS, table))).getFirst().getValue("id");
List<String> audits = new ArrayList<>();
for(QRecord audit : SystemWrites.query("audit", new QQueryFilter().withCriteria(new QFilterCriteria("auditTableId", QCriteriaOperator.EQUALS, auditTable))
.withCriteria(new QFilterCriteria("recordId", QCriteriaOperator.EQUALS, id)).withOrderBy(new QFilterOrderBy("id", true))))
{
List<String> fields = SystemWrites.query("auditDetail", new QQueryFilter().withCriteria(new QFilterCriteria("auditId", QCriteriaOperator.EQUALS, audit.getValue("id"))))
.stream().map(detail -> detail.getValueString("fieldName") + (detail.getValueString("fieldName").endsWith("_date") ? ""
: " [" + detail.getValueString("message") + "]")).sorted().toList();
audits.add(audit.getValueString("message") + ": " + String.join(", ", fields));
}
assertThat(instance.getTable(table)).isNotNull();
return (audits);
}
/*******************************************************************************
** Rows written before the two columns existed. A reading is audited (its
** audit token is made with a data key of its own, and that key is stored
** wrapped, bound to its record and field), the log has rows, a rule and a
** hold exist. The two columns are then taken away, which leaves the database
** as the release before this one left it, and a key and a log row are
** written the way that release wrote them. The block an existing database
** runs must change nothing but the two columns: the same rows, the same
** wrapped keys, which still unwrap to the same data keys, and the same
** token, which still verifies the value and no other.
*******************************************************************************/
@Test
void rowsWrittenBeforeTheDatesExistedVerifyUnchangedAfterTheyAreAdded() throws Exception
{
QInstance instance = RetentionTestSupport.setup();
QTableMetaData reading = instance.getTable("reading");
SecuredDataTestSupport.policy("secured_data.admin", "PHI", "FULL");
SecuredDataTestSupport.policy("secured_data.admin", "PII", "FULL");
QRecord rule = RetentionTestSupport.rule("NULL_WITH_MARKER", "systolic");
insert(SecuredDataTables.LEGAL_HOLD, new QRecord().withValue("table_name", "reading").withValue("record_id", "404").withValue("reason", "Preservation"));
Serializable id = new InsertAction().execute(new InsertInput("reading").withRecord(new QRecord().withValue("systolic", 120).withValue("secret", "s")
.withValue("reading_time", RetentionTestSupport.OLD))).getRecords().getFirst().getValue("id");
Serializable wiped = new InsertAction().execute(new InsertInput("reading").withRecord(new QRecord().withValue("systolic", 130).withValue("secret", "s")
.withValue("reading_time", RetentionTestSupport.OLD))).getRecords().getFirst().getValue("id");
new WipeService().batch(rule.getValue("id"), List.of(wiped));
SecuredDataKeySource keys = SecuredDataRuntime.current().keys();
byte[] dataKey = keys.keyForRecordField("reading", "systolic", id, false).orElseThrow().key();
List<String> tokens = SystemWrites.query("auditDetail", new QQueryFilter().withCriteria(new QFilterCriteria("fieldName", QCriteriaOperator.EQUALS, "systolic"))).stream()
.map(detail -> detail.getValueString("newValue")).filter(value -> value != null && value.startsWith("shred:v1:")).toList();
String token = tokens.stream().filter(candidate -> ClassifiedValueTokens.verifyRecordField(reading, reading.getField("systolic"), id, 120, candidate)).findFirst().orElseThrow();
assertThat(ClassifiedValueTokens.verifyRecordField(reading, reading.getField("systolic"), id, 121, token)).isFalse();
List<String> tables = declared(instance).stream().map(QTableMetaData::getName).filter(name -> !SNAKE_CASE_NAMES.contains(name)).toList();
byte[] earlierKey = new byte[32];
Arrays.fill(earlierKey, (byte) 7);
Instant earlier = NOW.minusSeconds(86400);
try(Connection connection = DriverManager.getConnection(url(), "sa", ""))
{
for(String table : tables)
{
assertThat(rows(connection, table, false)).as(table).allSatisfy(row -> assertThat(row.get("create_date")).isNotNull());
connection.createStatement().execute("ALTER TABLE " + table + " DROP COLUMN create_date");
connection.createStatement().execute("ALTER TABLE " + table + " DROP COLUMN modify_date");
}
try(PreparedStatement insert = connection.prepareStatement("INSERT INTO secured_data_audit_key (table_name, record_id, field_name, wrapped_key, created_at) VALUES ('reading', '9001', 'systolic', ?, ?)"))
{
insert.setString(1, Base64.getEncoder().encodeToString(SecuredDataKeySource.encrypt(earlierKey, "reading\u001fsystolic\u001f9001")));
insert.setTimestamp(2, Timestamp.from(earlier));
insert.executeUpdate();
}
try(PreparedStatement insert = connection.prepareStatement("INSERT INTO secured_data_access_log (event_type, user_id, table_name, field_name, outcome, anomaly_flag, created_at) VALUES ('VIEW', 'u1', 'reading', 'systolic', 'ALLOWED', false, ?)"))
{
insert.setTimestamp(1, Timestamp.from(earlier));
insert.executeUpdate();
}
Map<String, List<Map<String, String>>> before = new LinkedHashMap<>();
for(String table : tables)
{
before.put(table, rows(connection, table, false));
}
assertThat(before.get(SecuredDataTables.ACCESS_LOG)).hasSizeGreaterThan(3);
assertThat(before.get(SecuredDataTables.AUDIT_KEY)).hasSize(2);
for(String table : List.of(SecuredDataTables.WIPE_RUN, SecuredDataTables.WIPE_MARKER, SecuredDataTables.LEGAL_HOLD))
{
assertThat(before.get(table)).as(table).hasSize(1);
}
run(connection, ddl(true));
for(String table : tables)
{
assertThat(rows(connection, table, true)).as(table).isEqualTo(before.get(table));
assertThat(rows(connection, table, false)).as(table).allSatisfy(row ->
{
assertThat(row.get("create_date")).isNotNull();
assertThat(row.get("modify_date")).isNotNull();
});
}
assertThat(rows(connection, SecuredDataTables.ACCESS_LOG, false)).allSatisfy(row ->
{
assertThat(row.get("create_date")).isEqualTo(row.get("created_at"));
assertThat(row.get("modify_date")).isEqualTo(row.get("created_at"));
});
assertThat(rows(connection, SecuredDataTables.AUDIT_KEY, false)).allSatisfy(row ->
{
assertThat(row.get("create_date")).isEqualTo(row.get("created_at"));
assertThat(row.get("modify_date")).isEqualTo(row.get("created_at"));
});
/////////////////////////////////////////////////////////////////////////////
// the release before this one goes on writing while both run: its insert //
// names neither column, and the row has both, equal, all the same //
/////////////////////////////////////////////////////////////////////////////
connection.createStatement().execute("INSERT INTO secured_data_access_log (event_type, user_id, table_name, outcome, anomaly_flag, created_at) VALUES ('VIEW', 'u2', 'reading', 'ALLOWED', false, CURRENT_TIMESTAMP)");
Map<String, String> concurrent = rows(connection, SecuredDataTables.ACCESS_LOG, false).getLast();
assertThat(concurrent.get("user_id")).isEqualTo("u2");
assertThat(concurrent.get("create_date")).isNotNull().isEqualTo(concurrent.get("modify_date"));
}
///////////////////////////////////////////////////////////////////////////
// nothing kept in memory: every key is unwrapped again from its row //
///////////////////////////////////////////////////////////////////////////
keys.close();
assertThat(keys.keyForRecordField("reading", "systolic", id, false).orElseThrow().key()).isEqualTo(dataKey);
assertThat(keys.keyForRecordField("reading", "systolic", 9001, false).orElseThrow().key()).isEqualTo(earlierKey);
assertThat(keys.keyForRecordField("reading", "systolic", wiped, false)).isEmpty();
assertThat(ClassifiedValueTokens.verifyRecordField(reading, reading.getField("systolic"), id, 120, token)).isTrue();
assertThat(ClassifiedValueTokens.verifyRecordField(reading, reading.getField("systolic"), id, 121, token)).isFalse();
////////////////////////////////////////////////////////////////////////////
// and the rows that were there are read and written on as they were: the //
// earlier log row is counted, and the reading is wiped under its rule //
////////////////////////////////////////////////////////////////////////////
assertThat(RetentionTestSupport.rows(SecuredDataTables.ACCESS_LOG)).anySatisfy(row ->
{
assertThat(row.getValueString("user_id")).isEqualTo("u1");
assertThat(row.getValueInstant("createDate")).isNotNull().isEqualTo(row.getValueInstant("created_at"));
assertThat(row.getValueInstant("modifyDate")).isEqualTo(row.getValueInstant("created_at"));
});
CLOCK.now = LATER;
assertThat(new WipeService().batch(rule.getValue("id"), List.of(id)).getValueInteger("wiped_count")).isEqualTo(1);
assertThat(keys.keyForRecordField("reading", "systolic", id, false)).isEmpty();
assertThat(ClassifiedValueTokens.verifyRecordField(reading, reading.getField("systolic"), id, 120, token)).isFalse();
}
/*******************************************************************************
** The database RetentionTestSupport made from the shipped DDL.
*******************************************************************************/
private static String url()
{
return ("jdbc:h2:mem:" + RetentionTestSupport.BACKEND + ";MODE=PostgreSQL;DATABASE_TO_UPPER=FALSE;DB_CLOSE_DELAY=-1");
}
/*******************************************************************************
** The statements of the shipped DDL: those of the block an existing database
** runs to get the two columns, or those before it (the schema without them).
*******************************************************************************/
static List<String> ddl(boolean datesBlock) throws IOException
{
String ddl = Files.readString(Path.of(DDL));
int block = ddl.indexOf(DDL_BLOCK);
assertThat(block).as("the block of " + DDL + " that begins " + DDL_BLOCK).isPositive().isEqualTo(ddl.lastIndexOf(DDL_BLOCK));
return (Arrays.stream((datesBlock ? ddl.substring(block) : ddl.substring(0, block)).split(";")).filter(sql -> !sql.isBlank()).toList());
}
/*******************************************************************************
** Run statements.
*******************************************************************************/
static void run(Connection connection, List<String> statements) throws SQLException
{
for(String sql : statements)
{
connection.createStatement().execute(sql);
}
}
/*******************************************************************************
** Every row of a table as the database holds it, column by column, in id
** order, with or without the two date columns.
*******************************************************************************/
static List<Map<String, String>> rows(Connection connection, String table, boolean withoutDates) throws SQLException
{
List<Map<String, String>> rows = new ArrayList<>();
try(ResultSet results = connection.createStatement().executeQuery("SELECT * FROM " + table + " ORDER BY id"))
{
ResultSetMetaData columns = results.getMetaData();
while(results.next())
{
Map<String, String> row = new LinkedHashMap<>();
for(int i = 1; i <= columns.getColumnCount(); i++)
{
String column = columns.getColumnName(i);
if(!withoutDates || !Set.of("create_date", "modify_date").contains(column))
{
row.put(column, results.getString(i));
}
}
rows.add(row);
}
}
return (rows);
}
/*******************************************************************************
** One stored row.
*******************************************************************************/
private static QRecord row(String table, Serializable id)
{
return (SystemWrites.query(table, new QQueryFilter().withCriteria(new QFilterCriteria("id", QCriteriaOperator.EQUALS, id))).getFirst());
}
/*******************************************************************************
** The newest log row of an event, and of an action where one is given.
*******************************************************************************/
private static QRecord log(String event, String action)
{
return (logs().stream().filter(row -> event.equals(row.getValueString("event_type")) && (action == null || action.equals(row.getValueString("action_name"))))
.reduce((first, second) -> second).orElseThrow());
}
/*******************************************************************************
** Both dates of a stored row.
*******************************************************************************/
private static void assertDates(QRecord row, String table, Instant created, Instant modified)
{
assertThat(row.getValueInstant(createDate(table))).as(table + " create date").isEqualTo(created);
assertThat(row.getValueInstant(modifyDate(table))).as(table + " modify date").isEqualTo(modified);
}
/*******************************************************************************
** Both dates of a stored row that was changed: the create date it had, and a
** modify date later than the one it had, which is returned.
*******************************************************************************/
private static Instant assertChanged(QRecord row, String table, Instant created, Instant modifiedBefore)
{
assertThat(row.getValueInstant(createDate(table))).as(table + " create date").isEqualTo(created);
assertThat(row.getValueInstant(modifyDate(table))).as(table + " modify date").isAfter(modifiedBefore);
return (row.getValueInstant(modifyDate(table)));
}
}
@@ -234,6 +234,7 @@ final class SecuredDataTestSupport
*******************************************************************************/
static void close()
{
CLOCK.beforeInstant = null;
RUNTIMES.forEach(SecuredDataRuntime::close);
RUNTIMES.clear();
QContext.clear();
@@ -248,6 +249,9 @@ final class SecuredDataTestSupport
{
Instant now = NOW;
/** Run on the reading thread before every reading of the clock; a test parks a thread at a known point with it. */
volatile Runnable beforeInstant;
/*******************************************************************************
@@ -275,6 +279,11 @@ final class SecuredDataTestSupport
*******************************************************************************/
public Instant instant()
{
Runnable hook = beforeInstant;
if(hook != null)
{
hook.run();
}
return (now);
}
}