Compare commits

...
Author SHA1 Message Date
james.maesandClaude Opus 5.5 6606bf3e90 test: demo server uses MOCK auth so the demo administrator's permissions apply
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:30:48 -05:00
james.maesandClaude Opus 5.5 3457481841 feat: app home and anomaly alerts (phase e)
One Secured Data home: KPIs, recent reveals, top revealers and reasons,
break-glass events, policy and classification changes and anomaly flags,
as full-width tables. Anomaly rules (3x daily median, distinct records per
hour, exact-match volume, break-glass) raise secured_data.anomaly and flag
the log row.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 21:20:16 -05:00
james.maesandClaude Opus 5.5 e26ba2b4ad feat: reveal, break-glass and the secured-data UI API extension (phase c)
Reveal service (options, reason validation, daily cap, grants, audit),
break-glass start/end/expiry with alerts and admin notification, status,
the secured-data 1.0.0 UI API extension (compiled under the uiapi profile
until RC.6) and a contingent field picker for classification rows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 20:47:31 -05:00
james.maes 76da1c74fc Merge pull request #7 from QRun-IO/feature/policy-and-access-log
feat: classification, policy, tier resolver and access log (phase b)
2026-10-13 20:14:57 -05:00
james.maesandClaude Opus 5.5 3290128de9 chore: point the stand-in markers at QRun-IO/qqq#1172
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 20:12:43 -05:00
james.maesandClaude Opus 5.5 0963b45467 feat: classification, policy, tier resolver and access log (phase b)
Tables secured_data_classification, _policy, _reveal_grant, _break_glass
and _access_log; SecuredDataClassifications; the tier resolver with
break-glass, table features, policy rows, channel caps and code defaults;
the asynchronous access log; enumeration guardrails (rate limit, miss and
distinct-value alerts, minimum entropy). Builds on QQQ RC.5 with marked
stand-ins for the unreleased fieldaccess API and a reflective bridge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 20:03:57 -05:00
james.maes 99c97932b6 Merge pull request #5 from QRun-IO/fix/pin-qqq-rc
build: pin QQQ to 4.1.0-RC.5
2026-10-13 19:33:56 -05:00
james.maesandClaude Opus 5.5 3d50612a45 build: pin QQQ to 4.1.0-RC.5
Closes #4.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 19:19:12 -05:00
james.maes 4e74994cc9 Merge pull request #1 from QRun-IO/feature/scaffold
chore: repo-standard scaffold
2026-10-13 18:34:49 -05:00
65 changed files with 9459 additions and 111 deletions

No files matched your search

+18 -1
View File
@@ -6,4 +6,21 @@ All notable changes are documented here, following [Keep a Changelog](https://ke
### Added
- Initial scaffold
- Phase (e) configurable reveal-median, distinct-record and exact-match anomaly detection, with system access-log counters, bounded daily median caching, per-user/day alerts, and flags retained without an alert sink.
- Break-glass start and capped-reveal anomaly flags alongside the existing alerts.
- One Secured Data app home with six live KPIs, six full-width responsive lists, filtered View all links, theme tokens, compact dates, clamped text/tooltips and explicit empty states.
- Transaction-aware, value-free policy/classification change audit rows from post-write customizers and two access-log indexes for anomaly/home queries.
- Boundary, alert, home data, rendering and navigation tests plus a synthetic Next demo harness for coordinator screenshot capture.
- Phase (c) HTTP-independent reveal options, reason validation, UTC daily limits, grants, audit links, cap alerts and assistant refusal.
- Five-second per-user grant cache with immediate invalidation and read-time expiration.
- Start/End break-glass table and record actions, streamed Review/Result summaries, owner/admin authorization, scheduled expiration, alerts and optional admin bell notification.
- Caller status and the versioned `secured-data` UI API extension behind the temporary `uiapi` Maven profile, with committed OpenAPI and contract/HTTP tests.
- Contingent classification field picker support for snake_case and camelCase table selections; unknown-table rejection.
- Memory and real-core coverage for reveal, break-glass, record locks and expiry. Reason columns support 500 characters; existing RDBMS installations must widen the three `reason` columns to VARCHAR(500).
- Phase (b) secured-data classification, policy, reveal-grant, break-glass and insert-only access-log tables, metadata, permissions, pickers and app navigation.
- Versioned classification and policy resolution with channel caps, table features, break-glass expiry and access fingerprints.
- Bounded asynchronous value-free logging, HMAC search fingerprints, rate limits, entropy rules and enumeration alerts.
- RC.5-compatible stand-ins and reflective core adapters; conditional core Query/Get integration coverage.
- PostgreSQL DDL, H2 persistence/constraint coverage, and configuration/deployment documentation.
+187 -31
View File
@@ -1,12 +1,18 @@
# QBit Secured Data
Field access for QQQ applications: FULL, REVEALABLE, MASKED and HIDDEN tiers by role × DataClassification, with masking enforced in QQQ core, explicit reveal grants, break-glass access and an access log. This repository currently contains only the compiling scaffold; enforcement and domain features are not implemented here yet. See the [secured-data spec](https://github.com/QRun-IO/qqq/blob/develop/docs/SECURED-DATA.md), especially §5–§8.
Phases (b), (c), and (e) of [SECURED-DATA](https://github.com/QRun-IO/qqq/blob/develop/docs/SECURED-DATA.md): classification overrides, policy resolution, enumeration guardrails, and value-free access logging. QQQ core owns masking and query enforcement. Reveal, break-glass, the app home and anomaly alerts are implemented. Retention and audit-value protection remain later phases.
## Requirements
## Compatibility
Java 21 and QQQ 4.1.0-SNAPSHOT with the fieldaccess hooks. The Maven wrapper pins Maven 3.9.11.
Java 21, Maven wrapper 3.9.11, **QQQ 4.1.0-RC.5**. The released dependency pin is unchanged.
## Install
RC.5 contains AI exposure metadata, the alerts producer SPI and the tables picker. It does **not** contain field-access enforcement, `DataClassification`, classification properties on AI metadata, client channels, or table-feature permissions. Jar contents and embedded sources were inspected locally (`jar tf`; Git's `unzip` could not run in the Windows sandbox).
Missing APIs live under `com.kingsrook.qbits.secureddata.standin`, with `STAND-IN` removal markers. `CoreFieldAccessBridge` registers a dynamic proxy only when core's `FieldAccessResolverMetaData` exists. It converts decision record components and event enums by name. On RC.5 it logs one INFO that enforcement requires RC.6+; installing this QBit on RC.5 **does not enforce field tiers**.
`CoreMetadataBridge` promotes temporary classifications into core AI metadata when supported, registers the channel wall and table features reflectively, and uses core feature-permission checks when present. A missing API is supported; a present but incompatible API fails startup. The public classification API temporarily returns the stand-in `DataClassification` because the core enum is absent from RC.5. At RC.6, move these imports to core and delete the adapters/stand-ins.
## Install and register
```xml
<dependency>
@@ -16,42 +22,192 @@ Java 21 and QQQ 4.1.0-SNAPSHOT with the fieldaccess hooks. The Maven wrapper pin
</dependency>
```
## Tables and permissions
Planned tables (none are produced yet):
- `secured_data_classification`
- `secured_data_policy`
- `secured_data_reveal_grant`
- `secured_data_break_glass`
- `secured_data_access_log`
Backend names match table names. Permissions use the `secured_data` prefix; role × DataClassification policies determine field tiers. Reveal and break-glass semantics follow the spec.
## Configuration
`SecuredDataQBitConfig` exposes an optional `tableMetaDataCustomizer` and an initially empty `Map<String, String> defaultTierByClassification`. These settings reserve the configuration surface; the scaffold does not apply policies or customize tables yet.
## Adopting in another app
```java
new SecuredDataQBitProducer()
.withQBitConfig(new SecuredDataQBitConfig())
.withQBitConfig(new SecuredDataQBitConfig()
.withBackendName("rdbms")
.withDefaultTier(DataClassification.PII, FieldAccessTier.MASKED))
.produce(qInstance);
```
Import both classes from `com.kingsrook.qbits.secureddata`. Production registers the QBit identity and config in the QInstance; no tables are added yet.
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.
## Build
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.
```bash
./mvnw compile
./mvnw test
./mvnw verify
./mvnw -q -o verify # when dependencies are cached locally
## Tables, screens and permissions
| Table | Label | User access |
|---|---|---|
| `secured_data_classification` | Classification | Admin management |
| `secured_data_policy` | Policy | Admin management |
| `secured_data_reveal_grant` | Reveal | Admin read; system writes |
| `secured_data_break_glass` | Break-glass session | Admin read; system writes |
| `secured_data_access_log` | Access log | Admin read; system insert only |
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.
`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.
The assistant is denied `secured_data_*` through core client-channel metadata. The local custom checker enforces the same wall on RC.5 when the trusted host uses `standin.ClientChannelSession`. On newer core use `QSession.withClientChannel("assistant/t1")`. The normalized channel `assistant` is stored in logs and used for policy caps. A host must set the channel from trusted request context.
ESB integration follows webhooks' host-wiring pattern: `SecuredDataTables.esbTableNames()` lists Classification, Policy, Access log and Break-glass. Connect those names to the host ESB table-event producer. No ESB or qbit-alerts dependency is added.
## Classifying fields
Code metadata establishes defaults. While pinned to RC.5:
```java
import com.kingsrook.qbits.secureddata.standin.AiFieldMetaData;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
email.withSupplementalMetaData(
new AiFieldMetaData().withClassification(DataClassification.PII));
```
Verification includes Checkstyle and JaCoCo gates of 70% instructions and 90% classes. On Windows, use `./mvnw.cmd`.
The matching stand-in `AiTableMetaData` sets a table default. These supplemental objects coexist with RC.5's core AI exposure metadata. The producer promotes them into core AI metadata when the newer API is available. After moving to RC.6, use `com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData` and core `DataClassification` with the same classification pattern.
Admin rows in Classification can raise **or lower** the default. Effective order:
1. Field-specific classification row.
2. Table-wide row (`field_name` null).
3. Code field classification.
4. Code table classification.
5. Unclassified.
Rows can also set `mask_style` and `low_cardinality`: true/false override entropy detection in either direction; null selects automatic rules. The tables picker reuses core's PVS, and the fields picker uses the selected `table_name`.
Other QBits use `SecuredDataClassifications.effective(table, fieldName)`, `effective(table)`, `highest(table)`, or `highest(table, fieldNames)` under their QContext. An empty field subset returns null. Rows are cached by classification version; startup and successful post-commit insert/update/delete change the version.
## Policy resolution and guardrails
Unclassified/PUBLIC fields and primary keys are FULL. Active, unexpired break-glass grants cover a table or all tables up to their classification ceiling. Full/reveal table features combine with the least restrictive matching non-channel policy tier. A policy matches an active row, the session's `permission_name`, classification and optional table. If no grant row matches, code defaults are CONFIDENTIAL FULL, PII MASKED and PHI MASKED.
A `client_channel` policy row **only caps** the result. Caps also restrict break-glass and feature grants; a channel-only FULL row cannot elevate a default MASKED tier. This makes the channel a ceiling regardless of how access was granted. The admin shortcut applies only to this QBit's own tables.
The four policy guardrail settings combine most restrictively across applicable rows. Positive numeric limits combine by minimum; zero disables a control only when no matching row enables it. `min_entropy_enabled` is enabled if any matching row enables it. When no policy matches, configuration defaults apply.
- `exact_match_per_hour`: 20 searches per user/table/field, including MATCH, NO_MATCH and REFUSED rows. The next request is refused with `Exact-match search limit reached for [field]. Try again later or ask an administrator.`
- `miss_alert_consecutive`: 5 consecutive NO_MATCH outcomes, including across hour boundaries; other outcomes reset the streak.
- `distinct_value_alert`: more than 15 HMAC fingerprints per hour flags the row.
- `min_entropy_enabled`: disables exact match for boolean, PVS/enum, DATE/DATE_TIME, integer year names/labels, state/region/province/zip3 names/labels, and strings with maxLength under 6. Explicit classification-row true/false takes precedence over detection; disabling the control bypasses both.
Database history plus unflushed rows and local in-flight reservations prevent local concurrent overspending. Failed queries/dropped audit rows retain conservative reservations for an hour. Database history is shared, but another node's pending queue/reservations are not: this is not an atomic distributed quota. Hosts requiring that must serialize exact-search preflight across nodes.
Policy/break-glass caches are bounded per instance and keyed by relevant user permissions and policy version; expiry is rechecked at use time. Fingerprints hash user, held permissions mentioned in any policy or either table feature, policy/classification versions, active break-glass ids, and channel. Unrelated records/permissions and reveal grants do not change them. Multi-node hosts must propagate configuration/break-glass changes to `SecuredDataRuntime.invalidatePolicies()` / `invalidateClassifications()` on other nodes; local customizers only invalidate their own instance.
## Logging and lifecycle
`SecuredDataAccessLogger` captures identifiers, counts, normalized channel and outcomes, never field/search values. VIEW includes only configured classifications (PII/PHI by default), at most 50 primary keys encoded as JSON, and one row per table/action. Exact searches produce one row per affected field with MATCH/NO_MATCH/REFUSED; DENIED events become FILTER_DENIED. Break-glass id and refusal reason are recorded when available.
The extra `search_value_fingerprints` TEXT column persists JSON arrays of HMAC-SHA256 fingerprints for distinct-value detection after restarts and across nodes. Use a shared secret key supplier on multi-node deployments; the default is a random per-JVM key, so historical fingerprints from another JVM/key cannot be compared reliably.
One daemon worker drains a bounded queue as a system session. Enqueueing does not wait for persistence. Full queues and failed writes warn without values and increment `getDroppedCount()`. The app can expose this counter later. Explicitly call the instance's `SecuredDataRuntime.close()` at host shutdown; a JVM shutdown hook also drains accepted rows. An abrupt process crash can lose queued rows.
Flagged rows raise the optional alerts producer signal `secured_data.enumeration`, deduplicated by `secured_data.enumeration:<user>:<table>.<field>:<UTC date>`. RC.5 already provides `QAlerts`; without an installed sink it logs the signal. Its catalog validator rejects underscores in type names, so this mandated type is sent through the producer without catalog registration until that core restriction is reconciled. No values or fingerprints are sent to the alert sink.
## Reveal and break-glass
`new RevealService().options(tableName, fieldName)` describes the reason choices, free-text rules, duration and remaining allowance. `reveal(tableName, primaryKey, fieldName, reason, reasonText)` performs an explicitly permission-enforced Get as the caller before a system read. It returns `value`, core-formatted `displayValue`, `expiresAt`, and `revealId`. Grants and their linked audit rows are system-written; no raw value is copied into the access log.
The effective tier must be REVEALABLE. The chosen granting policy is the row with the highest daily cap (null means unlimited), then the longest duration, then lowest lexical id. Channel-only cap rows never grant reveal settings. A feature/default-based REVEALABLE tier with no granting row uses five minutes and an allowed free-text reason. Limits count grants across all tables for the user in the UTC day. Reason and reason text each have a 500-character limit. A required explanation is accepted alongside a listed reason even if arbitrary free-text reasons are disabled. Capped requests record `REVEAL_DENIED/CAPPED` and raise `secured_data.reveal_capped`; assistant-channel requests record `REVEAL_DENIED/DENIED` and return 403.
Grant lookups cache identifiers and expiration times for at most five seconds per user, check expiration on each use, and invalidate immediately after a new grant. The service serializes cap-check/write and duplicate-session checks within one runtime. Multi-replica deployments must coordinate these operations externally for a globally atomic cap and single active session; the in-process lock is not a distributed lock.
`secured_data_break_glass_start` is a table action, labeled **Start break-glass**, requiring `secured_data_break_glass_start.hasAccess`. Its reason must contain 20-500 characters; duration defaults to 60 minutes and accepts 1-480. Table scope is optional and classification ceiling defaults to PHI. `secured_data_break_glass_end` is a record action with the standard streamed ETL Review/Result screens; ownership/admin authorization is checked at review and again at execution. Neither action is a navigation entry. The current admin-only activity table permissions remain in place; an owner can invoke End using the session id returned by status without obtaining admin access to activity tables.
Start raises `secured_data.break_glass` at core's `HIGH` mapping (`AlertSeverity.ERROR`). End and expiry resolve the same per-session alert. Bell delivery targets holders of `secured_data.admin` through core's optional notification SPI #1125. RC.5 and the installed secure-data snapshot lack that SPI: a clear warning is logged. TODO: switch to a direct notification call when #1125 ships and verify against a notification-capable core.
Configure `.withSchedulerName("yourScheduler")` to register the hidden `secured_data_break_glass_expire` process every minute. Without a scheduler, the host must invoke that process itself. Tier resolution checks expiration independently, so delayed maintenance cannot prolong access. `new StatusService().status()` returns the caller's active session or null, grants used today, and the allowance for each readable REVEALABLE field.
## UI API extension
The `secured-data` extension is version **1.0.0**:
- `POST /qqq/v1/qbit/secured-data/reveal`
- `GET /qqq/v1/qbit/secured-data/reveal/options?tableName=&fieldName=`
- `GET /qqq/v1/qbit/secured-data/status`
Build with `-Duiapi=true` and a compatible core to compile `src/main/java-uiapi` and `src/test/java-uiapi`. The producer registers the extension only when both its classes and core's extension metadata exist. The committed contract is [secured-data.yaml](src/main/resources/openapi/qqq-v1/secured-data.yaml); regenerate intentionally with `-Dqqq.uiApi.regenerate=true`. The supplied core exposes `UiApiContract.check`, so a local test-only `UiApiContractAssertions` adapter supplies the documented assertion facade. All UI API roots and adapters are `STAND-IN(core=QRun-IO/qqq#1128, removeBy=RC.6)` and fold into the normal roots at RC.6. The core OpenAPI model cannot mark object properties required; the request schema documents required properties and the handler validates them.
The classification field picker uses CUSTOM possible values, reading `table_name` or `tableName` from the form's other values. It returns only the selected readable table's labeled fields, returns none without a selection, and rejects an unknown table. TODO: add `dependsOn("table_name")` when the core metadata API supports it.
## Configuration
| Fluent option | Default / purpose |
|---|---|
| `withBackendName(String)` | `memory`; host backend name |
| `withTableMetaDataCustomizer(...)` | Optional host storage/security customization |
| `withDefaultTier(DataClassification, FieldAccessTier)` | CONFIDENTIAL FULL; PII/PHI MASKED |
| `withDefaultTierByClassification(Map<String,String>)` | Compatibility bulk setter; omitted restricted types fail closed |
| `withNameHeuristics(boolean)` | false; opt-in PII for ssn/dob/date_of_birth/email/phone, PHI for diagnosis* |
| `withViewLogClassifications(Set<DataClassification>)` | PII, PHI |
| `withFingerprintKeySupplier(Supplier<byte[]>)` | Random 32-byte JVM key; supplied key must be at least 16 bytes |
| `withAccessLogQueueCapacity(int)` | 4096 rows |
| `withAccessLogFlushIntervalMillis(long)` | 250 ms |
| `withExactMatchPerHour(int)` | 20; zero disables |
| `withMissAlertConsecutive(int)` | 5; zero disables |
| `withDistinctValueAlert(int)` | 15; zero disables |
| `withMinEntropyEnabled(boolean)` | true |
| `withSchedulerName(String)` | Host scheduler for the 60-second break-glass expiry job; null means host-managed invocation |
| `withClock(Clock)` | UTC system clock; injectable for deterministic expiry tests |
Configure before producing the QBit; runtime infrastructure and HMAC keys are captured at startup. Classification/policy/break-glass lookups always run as system, with a thread-local recursion guard. No reveal values are cached.
## Build and tests
```powershell
./mvnw.cmd -q -o clean verify
./mvnw.cmd -q -o clean verify -Dqqq.snapshot.version=4.1.0-SECUREDATA-SNAPSHOT -Duiapi=true
```
The direct suite uses memory and H2. `CoreFieldAccessBridgeIT` is included by Surefire and uses JUnit assumptions to skip unless the actual core resolver metadata is present. With the installed core snapshot it exercises Query/Get, policy tiers, masking, exact matches and outcomes, sorting denial, rate/entropy refusal and the assistant wall. Checkstyle and JaCoCo remain 70% instructions / 90% classes; stand-ins are not excluded.
## Anomaly monitoring (phase e)
Application REVEAL and queued EXACT_MATCH_FILTER audit writes evaluate persisted access-log counters as system, counting the current row once. Successful reveals flag above three times the user's median across the previous 30 complete UTC days (including zero days), with at least ten reveals today. More than 20 distinct `(table, record)` pairs within the last hour also flag. More than 50 exact-match attempts on one restricted field within the last hour flag independently of enumeration controls. The default rate limit of 20 usually refuses searches first; refused attempts still count.
Break-glass starts and capped reveal refusals also flag. Each raises `secured_data.anomaly` with dedup key `secured_data.anomaly:<user>:<UTC day>` through the optional alerts SPI. Existing enumeration, break-glass and cap alerts remain intact. No qbit-alerts dependency is required; flags remain visible without a sink. The sink owns deduplication. End and expiry events remain in the break-glass activity list rather than representing new session anomalies.
Thresholds are positive integers:
| Config method | Default |
| --- | ---: |
| `withAnomalyDailyMedianMultiplier` | 3 |
| `withAnomalyMinimumDailyReveals` | 10 |
| `withAnomalyDistinctRecordsPerHour` | 20 |
| `withAnomalyExactMatchesPerHour` | 50 |
Medians use 30 scalar indexed counts on first qualifying use per user/day, cached for at most 2,048 users per instance and cleared at UTC day rollover. Today's and hourly counts read persisted history; distinct-record queries return at most the threshold plus one grouped rows. Counter evaluation and insertion serialize within an instance; other nodes become visible through persisted rows. This monitors activity rather than providing a distributed enforcement lock. Historical backfills after caching take effect next UTC day or after runtime restart. Existing deployments should apply the two new access-log indexes in `docs/ddl/secured-data-postgres.sql`.
## Secured Data home
The single Secured Data app owns one full-width HTML home widget, following qbit-webhooks' data/view/renderer pattern. It reads as the viewer with normal permissions and record security:
- Six KPIs: reveals today, unexpired grants, active and unexpired break-glass sessions, anomaly flags and denied filters over seven days, and this runtime's access-log queue drops since startup. Denied filters include refused exact-match attempts.
- Six full-width lists: recent reveals (10), top revealers and reasons (30-day backend aggregates, top 10), recent break-glass starts/ends/expiries (10), policy/classification changes (10), and seven-day anomaly flags (10).
- Each list has a filtered access-log `View all` link without the widget's ten-row limit. Configure the host table route with `withTablePathPrefix("/app")`.
Lists order newest first with id tie-breaking; rankings order by count descending then group alphabetically. Narrow screens use wrapping labelled card rows. Dates stay compact on one line, text is ellipsized with full tooltips, and colors inherit the host with `--qqq-grid-border` for borders. There are no inner scrollers. Empty lists explicitly say there is no activity.
Navigation contains Classification, Policy, Access log and Break-glass sessions. Reveal grants remain a child list; retention is not implemented. Successful policy/classification inserts, updates and deletes produce value-free change rows with actor, record id and action in the source transaction. No configuration values are copied into these rows.
### Local screenshot harness
`SecuredDataDemoServer` is a test-only memory-backed Next demo adapted from qbit-webhooks. It seeds synthetic activity for all six lists, including long reasons, sessions and anomaly flags. It uses a demo administrator and must only be run locally. After a test run, launch in PowerShell:
```powershell
[xml]$report = Get-Content target/surefire-reports/TEST-com.kingsrook.qbits.secureddata.SecuredDataHomeTest.xml
$demoClasspath = ($report.testsuite.properties.property | Where-Object name -eq 'java.class.path').value
java -cp $demoClasspath com.kingsrook.qbits.secureddata.SecuredDataDemoServer
```
Open `http://localhost:8098/app/secured_data`. Stop the demo before `clean` on Windows. Capture light and dark at 390, 768, 1024, 1440, 1920 and 3200 px under `target/screenshots/`. This session started the server, but screenshot capture was blocked by Chromium `spawn EPERM` in the sandbox and two connected-browser timeouts. The coordinator still needs to capture and inspect the twelve images through Next.
## Remaining phases
RC.6 migration removes temporary types and reflection. Retention, wipe and audit-value protection remain phases (f)/(g).
## License
+99
View File
@@ -0,0 +1,99 @@
-- PostgreSQL 15+ (NULLS NOT DISTINCT makes the table-wide classification unique).
-- Extra value-free fingerprint column supports enumeration detection across restarts/nodes.
CREATE TABLE secured_data_classification (
id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
table_name VARCHAR(255) NOT NULL,
field_name VARCHAR(255),
classification VARCHAR(255) NOT NULL,
mask_style VARCHAR(255),
low_cardinality BOOLEAN,
notes TEXT,
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
modified_by VARCHAR(255),
CONSTRAINT secured_data_classification_target UNIQUE NULLS NOT DISTINCT (table_name, field_name)
);
CREATE TABLE secured_data_policy (
id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
name VARCHAR(255) NOT NULL,
permission_name VARCHAR(255) NOT NULL,
classification VARCHAR(255) NOT NULL,
table_name VARCHAR(255),
tier VARCHAR(255) NOT NULL,
reveal_minutes INTEGER DEFAULT 5,
daily_reveal_cap INTEGER,
reason_options TEXT,
allow_free_text_reason BOOLEAN DEFAULT true,
require_free_text BOOLEAN DEFAULT false,
client_channel VARCHAR(255),
exact_match_per_hour INTEGER DEFAULT 20,
miss_alert_consecutive INTEGER DEFAULT 5,
distinct_value_alert INTEGER DEFAULT 15,
min_entropy_enabled BOOLEAN DEFAULT true,
is_active BOOLEAN DEFAULT true,
create_date TIMESTAMP WITH TIME ZONE,
modify_date TIMESTAMP WITH TIME ZONE,
modified_by VARCHAR(255),
CHECK (reveal_minutes BETWEEN 1 AND 60),
CHECK (exact_match_per_hour >= 0 AND miss_alert_consecutive >= 0 AND distinct_value_alert >= 0)
);
CREATE TABLE secured_data_reveal_grant (
id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
user_id VARCHAR(255) NOT NULL,
user_name VARCHAR(255),
table_name VARCHAR(255) NOT NULL,
record_id VARCHAR(255) NOT NULL,
field_name VARCHAR(255) NOT NULL,
reason VARCHAR(500),
reason_text TEXT,
granted_at TIMESTAMP WITH TIME ZONE NOT NULL,
expires_at TIMESTAMP WITH TIME ZONE NOT NULL,
access_log_id INTEGER NOT NULL
);
CREATE TABLE secured_data_break_glass (
id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
user_id VARCHAR(255) NOT NULL,
user_name VARCHAR(255),
reason VARCHAR(500),
reason_text TEXT,
classification_ceiling VARCHAR(255) DEFAULT 'PHI',
table_name VARCHAR(255),
started_at TIMESTAMP WITH TIME ZONE NOT NULL,
expires_at TIMESTAMP WITH TIME ZONE NOT NULL,
ended_at TIMESTAMP WITH TIME ZONE,
ended_by VARCHAR(255),
status VARCHAR(255) DEFAULT 'ACTIVE'
);
CREATE TABLE secured_data_access_log (
id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
event_type VARCHAR(255) NOT NULL,
user_id VARCHAR(255),
user_name VARCHAR(255),
table_name VARCHAR(255) NOT NULL,
record_id TEXT,
field_name TEXT,
record_count INTEGER,
action_name VARCHAR(255),
reason VARCHAR(500),
reason_text TEXT,
client_channel VARCHAR(255),
outcome VARCHAR(255),
anomaly_flag BOOLEAN DEFAULT false,
break_glass_id INTEGER,
created_at TIMESTAMP WITH TIME ZONE NOT NULL,
search_value_fingerprints TEXT
);
CREATE INDEX secured_data_policy_lookup ON secured_data_policy (is_active, permission_name, classification, table_name);
CREATE INDEX secured_data_break_glass_lookup ON secured_data_break_glass (user_id, status, expires_at);
CREATE INDEX secured_data_reveal_lookup ON secured_data_reveal_grant (user_id, table_name, field_name, record_id, expires_at);
CREATE INDEX secured_data_access_lookup ON secured_data_access_log (user_id, table_name, field_name, event_type, created_at);
-- Phase (e): bounded user counters and home time windows.
CREATE INDEX secured_data_anomaly_lookup ON secured_data_access_log (user_id, event_type, created_at);
CREATE INDEX secured_data_home_lookup ON secured_data_access_log (event_type, created_at);
+47 -20
View File
@@ -22,6 +22,7 @@
<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.snapshot.version>4.1.0-RC.5</qqq.snapshot.version>
<revision>1.0.0-SNAPSHOT</revision>
<maven.compiler.source>21</maven.compiler.source>
<maven.compiler.target>21</maven.compiler.target>
@@ -114,6 +115,16 @@
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<includes>
<include>**/*Test.java</include>
<include>**/*IT.java</include>
</includes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
@@ -193,28 +204,44 @@
</plugins>
</build>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-bom-pom</artifactId>
<version>${qqq.snapshot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<profiles>
<!-- QQQ 4.1 APIs until qbit-build-parent imports the 4.1 BOM (as in qbit-quick-search and qbit-cdn, ADR-0007). -->
<!-- STAND-IN(core=QRun-IO/qqq#1128, removeBy=RC.6): fold these roots into main/test at RC.6. -->
<profile>
<id>qqq-snapshot</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<!-- TODO(secured-data): pin to the QQQ RC that ships the fieldaccess hooks (qqq feature/secured-data-core) -->
<qqq.snapshot.version>4.1.0-SNAPSHOT</qqq.snapshot.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.kingsrook.qqq</groupId>
<artifactId>qqq-bom-pom</artifactId>
<version>${qqq.snapshot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<id>uiapi</id>
<activation><property><name>uiapi</name><value>true</value></property></activation>
<build><plugins><plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<sourceDirectories>
<sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
<sourceDirectory>${project.basedir}/src/main/java-uiapi</sourceDirectory>
</sourceDirectories>
</configuration>
</plugin><plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.6.1</version>
<executions>
<execution><id>uiapi-source</id><phase>generate-sources</phase><goals><goal>add-source</goal></goals>
<configuration><sources><source>src/main/java-uiapi</source></sources></configuration>
</execution>
<execution><id>uiapi-tests</id><phase>generate-test-sources</phase><goals><goal>add-test-source</goal></goals>
<configuration><sources><source>src/test/java-uiapi</source></sources></configuration>
</execution>
</executions>
</plugin></plugins></build>
</profile>
</profiles>
</project>
@@ -0,0 +1,56 @@
/*
* 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.uiapi;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtension;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtensionsMetaData;
/*******************************************************************************
** STAND-IN(core=QRun-IO/qqq#1128, removeBy=RC.6): move to main source root.
*******************************************************************************/
public final class SecuredDataExtension
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataExtension()
{
}
/*******************************************************************************
** The secured-data UI API, version 1.0.0.
*******************************************************************************/
public static MiddlewareSpecExtension defineExtension()
{
return (new MiddlewareSpecExtension().withName("secured-data").withSemanticVersion("1.0.0")
.withDescription("Reveal grants and break-glass status")
.withSpec(SecuredDataRevealSpecV1.class).withSpec(SecuredDataRevealOptionsSpecV1.class).withSpec(SecuredDataStatusSpecV1.class));
}
/*******************************************************************************
** Called reflectively by the producer.
*******************************************************************************/
public static void register(QInstance instance)
{
MiddlewareSpecExtensionsMetaData.ofOrWithNew(instance).withExtension(defineExtension());
}
}
@@ -0,0 +1,84 @@
/*
* 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.uiapi;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qqq.middleware.javalin.specs.BasicOperation;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec;
import com.kingsrook.qqq.openapi.model.HttpMethod;
import com.kingsrook.qqq.openapi.model.Parameter;
import com.kingsrook.qqq.openapi.model.Schema;
/*******************************************************************************
** GET secured-data/reveal/options.
*******************************************************************************/
public class SecuredDataRevealOptionsSpecV1 extends AbstractJsonEndpointSpec
{
/*******************************************************************************
** Operation metadata.
*******************************************************************************/
@Override
public BasicOperation defineBasicOperation()
{
return (new BasicOperation().withPath("/qbit/secured-data/reveal/options").withHttpMethod(HttpMethod.GET)
.withTag(() -> "Secured data").withShortSummary("RevealOptions"));
}
/*******************************************************************************
** Request query parameters.
*******************************************************************************/
@Override
public List<Parameter> defineRequestParameters()
{
return (List.of(new Parameter().withName("tableName").withIn(com.kingsrook.qqq.openapi.model.In.QUERY).withRequired(true).withSchema(new Schema().withType(com.kingsrook.qqq.openapi.model.Type.STRING)),
new Parameter().withName("fieldName").withIn(com.kingsrook.qqq.openapi.model.In.QUERY).withRequired(true).withSchema(new Schema().withType(com.kingsrook.qqq.openapi.model.Type.STRING))));
}
/*******************************************************************************
** Published component schemas.
*******************************************************************************/
@Override
public Map<String, Schema> defineComponentSchemas()
{
Map<String, Schema> schemas = SecuredDataSchemas.all();
return (Map.of("SecuredDataRevealOptionsResponseV1", schemas.get("SecuredDataRevealOptionsResponseV1")));
}
/*******************************************************************************
** Response component.
*******************************************************************************/
@Override
protected String getResponseSchemaName()
{
return ("SecuredDataRevealOptionsResponseV1");
}
/*******************************************************************************
** Execute with the caller session supplied by the core middleware.
*******************************************************************************/
@Override
protected Object handle(JsonInput input) throws Exception
{
return (new RevealService().options(input.getQueryParam("tableName"), input.getQueryParam("fieldName")));
}
}
@@ -0,0 +1,143 @@
/*
* 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.uiapi;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.reveal.RevealCappedException;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException;
import com.kingsrook.qqq.middleware.javalin.specs.BasicOperation;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec;
import com.kingsrook.qqq.openapi.model.HttpMethod;
import com.kingsrook.qqq.openapi.model.Parameter;
import com.kingsrook.qqq.openapi.model.Schema;
/*******************************************************************************
** POST secured-data/reveal.
*******************************************************************************/
public class SecuredDataRevealSpecV1 extends AbstractJsonEndpointSpec
{
/*******************************************************************************
** Operation metadata.
*******************************************************************************/
@Override
public BasicOperation defineBasicOperation()
{
return (new BasicOperation().withPath("/qbit/secured-data/reveal").withHttpMethod(HttpMethod.POST)
.withTag(() -> "Secured data").withShortSummary("Reveal"));
}
/*******************************************************************************
** Request query parameters.
*******************************************************************************/
@Override
public List<Parameter> defineRequestParameters()
{
return (List.of());
}
/*******************************************************************************
** Published component schemas.
*******************************************************************************/
@Override
public Map<String, Schema> defineComponentSchemas()
{
Map<String, Schema> schemas = SecuredDataSchemas.all();
return (Map.of("SecuredDataRevealRequestV1", schemas.get("SecuredDataRevealRequestV1"), "SecuredDataRevealResponseV1", schemas.get("SecuredDataRevealResponseV1"), "SecuredDataErrorV1", schemas.get("SecuredDataErrorV1")));
}
/*******************************************************************************
** Response component.
*******************************************************************************/
@Override
protected String getResponseSchemaName()
{
return ("SecuredDataRevealResponseV1");
}
/*******************************************************************************
** Standard error responses, including the daily-limit refusal.
*******************************************************************************/
@Override
public List<com.kingsrook.qqq.middleware.javalin.specs.BasicResponse> defineAdditionalBasicResponses()
{
return (List.of(new com.kingsrook.qqq.middleware.javalin.specs.BasicResponse(io.javalin.http.HttpStatus.BAD_REQUEST, "Invalid reveal request", "SecuredDataErrorV1"),
new com.kingsrook.qqq.middleware.javalin.specs.BasicResponse(io.javalin.http.HttpStatus.FORBIDDEN, "Reveal denied", "SecuredDataErrorV1"),
new com.kingsrook.qqq.middleware.javalin.specs.BasicResponse(io.javalin.http.HttpStatus.NOT_FOUND, "Record not found or locked", "SecuredDataErrorV1"),
new com.kingsrook.qqq.middleware.javalin.specs.BasicResponse(io.javalin.http.HttpStatus.TOO_MANY_REQUESTS, "Daily reveal cap reached", "SecuredDataErrorV1")));
}
/*******************************************************************************
** Required JSON request.
*******************************************************************************/
@Override
protected Schema defineRequestBodySchema()
{
return (new Schema().withRefToSchema("SecuredDataRevealRequestV1"));
}
/*******************************************************************************
** Reject wrong JSON types with the standard 400 response.
*******************************************************************************/
private String string(Map<String, Object> body, String key) throws QBadRequestException
{
Object value = body.get(key);
if(value != null && !(value instanceof String))
{
throw (new QBadRequestException(key + " must be a string."));
}
return ((String) value);
}
/*******************************************************************************
** Execute with the caller session supplied by the core middleware.
*******************************************************************************/
@Override
protected Object handle(JsonInput input) throws Exception
{
Map<String, Object> body = input.getBody();
Object pk = body.get("primaryKey");
if(!(pk instanceof String || pk instanceof Number))
{
throw (new QBadRequestException("primaryKey must be a string or number."));
}
return (new RevealService().reveal(string(body, "tableName"), (Serializable) pk, string(body, "fieldName"),
string(body, "reason"), string(body, "reasonText")));
}
/*******************************************************************************
** Preserve core error bodies and use 429 for exhausted daily allowances.
*******************************************************************************/
@Override
protected void handleException(io.javalin.http.Context context, Exception e)
{
if(e instanceof RevealCappedException)
{
com.kingsrook.qqq.middleware.javalin.QJavalinUtils.respondWithError(context, org.eclipse.jetty.http.HttpStatus.Code.TOO_MANY_REQUESTS, e.getMessage());
}
else
{
super.handleException(context, e);
}
}
}
@@ -0,0 +1,85 @@
/*
* 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.uiapi;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qqq.openapi.model.Schema;
import com.kingsrook.qqq.openapi.model.Type;
/*******************************************************************************
** Published shapes of service responses; nullable allowances mean unlimited.
*******************************************************************************/
public final class SecuredDataSchemas
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataSchemas()
{
}
/*******************************************************************************
** Every request and response component carries the extension prefix and version.
*******************************************************************************/
public static Map<String, Schema> all()
{
Map<String, Schema> schemas = new LinkedHashMap<>();
schemas.put("SecuredDataRevealRequestV1", object("tableName", type(Type.STRING), "fieldName", type(Type.STRING),
"primaryKey", new Schema().withAnyOf(List.of(type(Type.STRING), type(Type.NUMBER))).withDescription("Record primary key (string or number)."),
"reason", type(Type.STRING).withNullable(true).withMaxLength(500), "reasonText", type(Type.STRING).withNullable(true).withMaxLength(500))
.withDescription("tableName, primaryKey and fieldName are required. Supply a policy reason or allowed free text; maximum 500 characters."));
schemas.put("SecuredDataRevealResponseV1", object("value", new Schema().withNullable(true).withDescription("Authorized raw field value."),
"displayValue", type(Type.STRING).withNullable(true), "expiresAt", type(Type.STRING).withFormat("date-time"), "revealId", type(Type.INTEGER)));
schemas.put("SecuredDataRevealOptionsResponseV1", object("reasonOptions", type(Type.ARRAY).withItems(type(Type.STRING)),
"allowFreeTextReason", type(Type.BOOLEAN), "requireFreeText", type(Type.BOOLEAN), "revealMinutes", type(Type.INTEGER),
"remainingDailyAllowance", type(Type.INTEGER).withNullable(true)));
schemas.put("SecuredDataBreakGlassV1", object("id", type(Type.INTEGER), "reason", type(Type.STRING), "expiresAt", type(Type.STRING).withFormat("date-time"),
"scope", type(Type.STRING).withNullable(true), "ceiling", type(Type.STRING)));
schemas.put("SecuredDataRevealAllowanceV1", object("tableName", type(Type.STRING), "fieldName", type(Type.STRING), "remainingDailyAllowance", type(Type.INTEGER).withNullable(true)));
schemas.put("SecuredDataStatusResponseV1", object("breakGlass", new Schema().withRefToSchema("SecuredDataBreakGlassV1").withNullable(true),
"revealsUsedToday", type(Type.INTEGER), "revealAllowances", type(Type.ARRAY).withItems(new Schema().withRefToSchema("SecuredDataRevealAllowanceV1"))));
schemas.put("SecuredDataErrorV1", object("error", type(Type.STRING)));
return (schemas);
}
/*******************************************************************************
** Object properties in stable order.
*******************************************************************************/
private static Schema object(Object... pairs)
{
Map<String, Schema> properties = new LinkedHashMap<>();
for(int i = 0; i < pairs.length; i += 2)
{
properties.put((String) pairs[i], (Schema) pairs[i + 1]);
}
return (type(Type.OBJECT).withProperties(properties));
}
/*******************************************************************************
** Typed schema.
*******************************************************************************/
private static Schema type(Type type)
{
return (new Schema().withType(type));
}
}
@@ -0,0 +1,83 @@
/*
* 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.uiapi;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.StatusService;
import com.kingsrook.qqq.middleware.javalin.specs.BasicOperation;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec;
import com.kingsrook.qqq.openapi.model.HttpMethod;
import com.kingsrook.qqq.openapi.model.Parameter;
import com.kingsrook.qqq.openapi.model.Schema;
/*******************************************************************************
** GET secured-data/status.
*******************************************************************************/
public class SecuredDataStatusSpecV1 extends AbstractJsonEndpointSpec
{
/*******************************************************************************
** Operation metadata.
*******************************************************************************/
@Override
public BasicOperation defineBasicOperation()
{
return (new BasicOperation().withPath("/qbit/secured-data/status").withHttpMethod(HttpMethod.GET)
.withTag(() -> "Secured data").withShortSummary("Status"));
}
/*******************************************************************************
** Request query parameters.
*******************************************************************************/
@Override
public List<Parameter> defineRequestParameters()
{
return (List.of());
}
/*******************************************************************************
** Published component schemas.
*******************************************************************************/
@Override
public Map<String, Schema> defineComponentSchemas()
{
Map<String, Schema> schemas = SecuredDataSchemas.all();
return (Map.of("SecuredDataStatusResponseV1", schemas.get("SecuredDataStatusResponseV1"), "SecuredDataBreakGlassV1", schemas.get("SecuredDataBreakGlassV1"), "SecuredDataRevealAllowanceV1", schemas.get("SecuredDataRevealAllowanceV1")));
}
/*******************************************************************************
** Response component.
*******************************************************************************/
@Override
protected String getResponseSchemaName()
{
return ("SecuredDataStatusResponseV1");
}
/*******************************************************************************
** Execute with the caller session supplied by the core middleware.
*******************************************************************************/
@Override
protected Object handle(JsonInput input) throws Exception
{
return (new StatusService().status());
}
}
@@ -0,0 +1,166 @@
/*
* 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.lang.reflect.InvocationTargetException;
import java.lang.reflect.Proxy;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import com.kingsrook.qbits.secureddata.standin.FieldAccessDecision;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEvent;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEventType;
import com.kingsrook.qbits.secureddata.standin.FieldAccessOutcome;
import com.kingsrook.qbits.secureddata.standin.FieldAccessResolverInterface;
import com.kingsrook.qqq.backend.core.logging.QLogger;
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.tables.QTableMetaData;
/*******************************************************************************
** The only boundary between the temporary field-access API and unreleased core.
*******************************************************************************/
public final class CoreFieldAccessBridge
{
private static final String PACKAGE = "com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.";
private static final QLogger LOG = QLogger.getLogger(CoreFieldAccessBridge.class);
private static final AtomicBoolean WARNED = new AtomicBoolean();
/*******************************************************************************
** Utility class.
*******************************************************************************/
private CoreFieldAccessBridge()
{
}
/*******************************************************************************
** Register only when core can actually enforce field access.
*******************************************************************************/
public static boolean register(QInstance instance, FieldAccessResolverInterface resolver)
{
try
{
Class<?> metadata = Class.forName(PACKAGE + "FieldAccessResolverMetaData");
Class<?> contract = Class.forName(PACKAGE + "FieldAccessResolverInterface");
Object proxy = Proxy.newProxyInstance(contract.getClassLoader(), new Class<?>[] {contract}, (self, method, args) ->
{
return (switch(method.getName())
{
case "resolve" -> decision(resolver.resolve((QTableMetaData) args[0], (QFieldMetaData) args[1]));
case "getAccessFingerprint" -> resolver.getAccessFingerprint();
case "isRevealActive" -> resolver.isRevealActive((String) args[0], (String) args[1], (Serializable) args[2]);
case "fingerprintSearchValue" -> resolver.fingerprintSearchValue((Serializable) args[0]);
case "checkExactMatch" ->
{
resolver.checkExactMatch(event(args[0]));
yield null;
}
case "onAccess" ->
{
resolver.onAccess(event(args[0]));
yield null;
}
case "toString" -> "SecuredData core bridge";
case "hashCode" -> System.identityHashCode(self);
case "equals" -> self == args[0];
default -> throw new UnsupportedOperationException(method.getName());
});
});
Object registry = metadata.getMethod("ofOrWithNew", QInstance.class).invoke(null, instance);
metadata.getMethod("withResolverInstance", contract).invoke(registry, proxy);
return (true);
}
catch(ClassNotFoundException e)
{
if(WARNED.compareAndSet(false, true))
{
LOG.info("Secured-data field enforcement needs QQQ RC.6+; policy and access-log services are available.");
}
return (false);
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Core field-access API is incompatible", unwrap(e)));
}
}
/*******************************************************************************
** Construct the core record by its declared component types and enum names.
*******************************************************************************/
private static Object decision(FieldAccessDecision decision) throws ReflectiveOperationException
{
Class<?> type = Class.forName(PACKAGE + "FieldAccessDecision");
Class<?> tier = type.getRecordComponents()[0].getType();
Class<?> mask = type.getRecordComponents()[1].getType();
return (type.getConstructor(tier, mask, String.class, boolean.class).newInstance(
enumValue(tier, decision.tier().name()), decision.maskStyle() == null ? null : enumValue(mask, decision.maskStyle().name()),
decision.reason(), decision.exactMatchAllowed()));
}
/*******************************************************************************
** Convert enum types without sharing class identity across the bridge.
*******************************************************************************/
private static Object enumValue(Class<?> type, String name) throws ReflectiveOperationException
{
return (type.getMethod("valueOf", String.class).invoke(null, name));
}
/*******************************************************************************
** Events carry identifiers and keyed fingerprints, never search literals.
*******************************************************************************/
@SuppressWarnings("unchecked")
private static FieldAccessEvent event(Object source) throws ReflectiveOperationException
{
Class<?> type = source.getClass();
Object outcome = type.getMethod("getOutcome").invoke(source);
return (new FieldAccessEvent()
.withType(FieldAccessEventType.valueOf(type.getMethod("getType").invoke(source).toString()))
.withTableName((String) type.getMethod("getTableName").invoke(source))
.withFieldNames((List<String>) type.getMethod("getFieldNames").invoke(source))
.withPrimaryKeys((List<Serializable>) type.getMethod("getPrimaryKeys").invoke(source))
.withRecordCount((Integer) type.getMethod("getRecordCount").invoke(source))
.withActionName((String) type.getMethod("getActionName").invoke(source))
.withOutcome(outcome == null ? null : FieldAccessOutcome.valueOf(outcome.toString()))
.withSearchValueFingerprints((List<String>) type.getMethod("getSearchValueFingerprints").invoke(source)));
}
/*******************************************************************************
** Preserve the startup failure, including duplicate resolver registration.
*******************************************************************************/
private static Throwable unwrap(ReflectiveOperationException exception)
{
return (exception instanceof InvocationTargetException invocation ? invocation.getCause() : exception);
}
}
@@ -0,0 +1,479 @@
/*
* 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.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicLong;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEvent;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEventType;
import com.kingsrook.qbits.secureddata.standin.FieldAccessOutcome;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
import com.kingsrook.qqq.backend.core.context.CapturedContext;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
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.QFilterOrderBy;
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.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
/*******************************************************************************
** Bounded asynchronous value-free audit, with persisted and local enumeration accounting.
*******************************************************************************/
public class SecuredDataAccessLogger implements AutoCloseable
{
private static final QLogger LOG = QLogger.getLogger(SecuredDataAccessLogger.class);
private final QInstance instance;
private final SecuredDataRuntime runtime;
private final ArrayBlockingQueue<PendingLog> queue;
private final ScheduledExecutorService worker;
private final Thread shutdownHook;
private final AtomicLong dropped = new AtomicLong();
private final Object flushLock = new Object();
private final Object lifecycleLock = new Object();
private final ThreadLocal<String> refusalReason = new ThreadLocal<>();
private final Map<String, ArrayDeque<Instant>> reservations = new HashMap<>();
private volatile boolean closed;
/*******************************************************************************
** Settings are captured for the acting user, before the worker becomes system.
*******************************************************************************/
private record PendingLog(QRecord row, SecuredDataResolver.Guardrails guardrails)
{
}
/*******************************************************************************
** One daemon drains this instance's queue; the JVM hook flushes on shutdown.
*******************************************************************************/
public SecuredDataAccessLogger(QInstance instance, SecuredDataRuntime runtime)
{
this.instance = instance;
this.runtime = runtime;
this.queue = new ArrayBlockingQueue<>(runtime.config().getAccessLogQueueCapacity());
this.worker = Executors.newSingleThreadScheduledExecutor(task ->
{
Thread thread = new Thread(task, "secured-data-access-log");
thread.setDaemon(true);
return (thread);
});
long interval = runtime.config().getAccessLogFlushIntervalMillis();
worker.scheduleWithFixedDelay(this::flush, interval, interval, TimeUnit.MILLISECONDS);
shutdownHook = new Thread(this::close, "secured-data-access-log-shutdown");
Runtime.getRuntime().addShutdownHook(shutdownHook);
}
/*******************************************************************************
** Drop count for operational monitoring and the future app home.
*******************************************************************************/
public long getDroppedCount()
{
return (dropped.get());
}
/*******************************************************************************
** Snapshot identifiers only. A failed/full logger must never fail the read.
*******************************************************************************/
public void onAccess(FieldAccessEvent event)
{
if(SystemWrites.active())
{
return;
}
try
{
QTableMetaData table = instance.getTable(event.getTableName());
if(table == null || SecuredDataTables.ALL.contains(table.getName()))
{
return;
}
List<String> fields = event.getFieldNames() == null ? List.of() : event.getFieldNames();
if(event.getType() == FieldAccessEventType.VIEW)
{
fields = fields.stream().filter(field -> runtime.config().getViewLogClassifications().contains(SecuredDataClassifications.effective(table, field))).toList();
if(fields.isEmpty())
{
return;
}
}
if(event.getType() == FieldAccessEventType.EXACT_MATCH_FILTER)
{
for(String field : fields.stream().distinct().toList())
{
offer(row(event, List.of(field)), runtime.resolver().guardrails(table, field));
}
}
else
{
offer(row(event, fields), null);
}
}
catch(Exception e)
{
drop("Unable to queue secured-data access log");
}
}
/*******************************************************************************
** Build a row without copying record values, arbitrary reasons or filter objects.
*******************************************************************************/
private QRecord row(FieldAccessEvent event, List<String> fields)
{
QSession session = QContext.getQSession();
String type = event.getType() == FieldAccessEventType.DENIED ? "FILTER_DENIED" : event.getType().name();
String outcome = event.getOutcome() == null ? (event.getType() == FieldAccessEventType.DENIED ? "DENIED" : "ALLOWED") : event.getOutcome().name();
QRecord row = new QRecord().withValue("event_type", type).withValue("user_id", SecuredDataResolver.userId())
.withValue("user_name", session == null || session.getUser() == null ? null : session.getUser().getFullName())
.withValue("table_name", event.getTableName()).withValue("field_name", String.join(",", fields))
.withValue("record_count", event.getRecordCount()).withValue("action_name", event.getActionName())
.withValue("client_channel", CoreMetadataBridge.channel(session)).withValue("outcome", outcome)
.withValue("anomaly_flag", false).withValue("created_at", runtime.config().getClock().instant());
if(event.getPrimaryKeys() != null)
{
row.setValue("record_id", JsonUtils.toJson(event.getPrimaryKeys().stream().limit(50).toList()));
}
if(event.getSearchValueFingerprints() != null)
{
row.setValue("search_value_fingerprints", JsonUtils.toJson(event.getSearchValueFingerprints()));
}
if(event.getOutcome() == FieldAccessOutcome.REFUSED)
{
row.setValue("reason", Objects.requireNonNullElse(refusalReason.get(), "Exact-match search refused by access policy or enumeration guardrail."));
refusalReason.remove();
}
QTableMetaData table = instance.getTable(event.getTableName());
QRecord breakGlass = runtime.resolver().activeBreakGlass(table.getName(), SecuredDataClassifications.highest(table, fields));
if(breakGlass != null)
{
row.setValue("break_glass_id", breakGlass.getValue("id"));
}
return (row);
}
/*******************************************************************************
** A full queue drops without waiting, warning only with value-free text.
*******************************************************************************/
private void offer(QRecord row, SecuredDataResolver.Guardrails guardrails)
{
synchronized(lifecycleLock)
{
if(closed || !queue.offer(new PendingLog(row, guardrails)))
{
drop("Secured-data access-log queue is full or closed; dropped one row");
}
}
}
/*******************************************************************************
** Keep failed persistence observable without dumping sensitive record objects.
*******************************************************************************/
private void drop(String message)
{
dropped.incrementAndGet();
LOG.warn(message);
}
/*******************************************************************************
** Authoritative persisted count plus queued rows and uncompleted local searches.
** Serializes preflight and drain accounting, never ordinary VIEW enqueues.
*******************************************************************************/
public void checkExactMatch(FieldAccessEvent event) throws QPermissionDeniedException
{
synchronized(flushLock)
{
refusalReason.remove();
String user = SecuredDataResolver.userId();
QTableMetaData table = instance.getTable(event.getTableName());
Instant now = runtime.config().getClock().instant();
Instant since = now.minus(1, ChronoUnit.HOURS);
expireReservations(since);
List<String> fields = event.getFieldNames().stream().distinct().toList();
for(String field : fields)
{
if(!runtime.resolver().resolve(table, table.getField(field)).exactMatchAllowed())
{
refusalReason.set("Exact-match search is disabled for this low-cardinality field.");
throw (new QPermissionDeniedException("Permission denied."));
}
int limit = runtime.resolver().guardrails(table, field).exactMatchPerHour();
if(limit == 0)
{
continue;
}
List<QRecord> persisted = history(user, table.getName(), field, since);
long pending = queue.stream().filter(item -> matches(item.row(), user, table.getName(), field, since)).count();
long reserved = reservations.getOrDefault(key(user, table.getName(), field), new ArrayDeque<>()).size();
// Accepted outcomes in the queue still have their reservation until flush.
long completedReserved = queue.stream().filter(item -> matches(item.row(), user, table.getName(), field, since))
.filter(item -> !"REFUSED".equals(item.row().getValueString("outcome"))).count();
if(persisted.size() + pending + Math.max(0, reserved - completedReserved) >= limit)
{
String reason = "Exact-match search limit reached for [" + field + "]. Try again later or ask an administrator.";
refusalReason.set(reason);
throw (new QPermissionDeniedException(reason));
}
}
for(String field : fields)
{
if(runtime.resolver().guardrails(table, field).exactMatchPerHour() > 0)
{
reservations.computeIfAbsent(key(user, table.getName(), field), ignored -> new ArrayDeque<>()).addLast(now);
}
}
}
}
/*******************************************************************************
** Retire conservative reservations left behind by failed queries or dropped logs.
*******************************************************************************/
private void expireReservations(Instant since)
{
reservations.values().forEach(times -> times.removeIf(time -> !time.isAfter(since)));
reservations.values().removeIf(ArrayDeque::isEmpty);
}
/*******************************************************************************
** Identifier-safe composite key.
*******************************************************************************/
private static String key(String user, String table, String field)
{
return (JsonUtils.toJson(List.of(user, table, field)));
}
/*******************************************************************************
** The queue contains one exact-match row per field, matching the indexed query.
*******************************************************************************/
private static boolean matches(QRecord row, String user, String table, String field, Instant since)
{
return ("EXACT_MATCH_FILTER".equals(row.getValueString("event_type")) && Objects.equals(user, row.getValueString("user_id"))
&& Objects.equals(table, row.getValueString("table_name")) && Objects.equals(field, row.getValueString("field_name"))
&& row.getValueInstant("created_at").isAfter(since));
}
/*******************************************************************************
** Indexed history lookup, always under a system session.
*******************************************************************************/
private List<QRecord> history(String user, String table, String field, Instant since)
{
return (SystemWrites.query(SecuredDataTables.ACCESS_LOG, new QQueryFilter()
.withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, user))
.withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, table))
.withCriteria(new QFilterCriteria("field_name", QCriteriaOperator.EQUALS, field))
.withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.EQUALS, "EXACT_MATCH_FILTER"))
.withCriteria(new QFilterCriteria("created_at", QCriteriaOperator.GREATER_THAN, since))
.withOrderBy(new QFilterOrderBy("created_at", false)).withOrderBy(new QFilterOrderBy("id", false))));
}
/*******************************************************************************
** Drain safely both from the worker and explicit test/host shutdown calls.
*******************************************************************************/
public void flush()
{
synchronized(flushLock)
{
QContext.withTemporaryContext(new CapturedContext(instance, new QSystemUserSession(instance)), () ->
{
PendingLog pending;
while((pending = queue.peek()) != null)
{
QRecord row = pending.row();
try
{
boolean anomaly = isAnomaly(pending);
row.setValue("anomaly_flag", anomaly);
SystemWrites.insertOne(SecuredDataTables.ACCESS_LOG, row);
if(anomaly)
{
raiseAlert(row);
}
completeReservation(row);
}
catch(Exception e)
{
drop("Unable to persist secured-data access log; dropped one row");
}
finally
{
queue.poll();
}
}
});
}
}
/*******************************************************************************
** Only persisted successful searches release their in-flight reservation.
*******************************************************************************/
private void completeReservation(QRecord row)
{
if(!"EXACT_MATCH_FILTER".equals(row.getValueString("event_type")) || "REFUSED".equals(row.getValueString("outcome")))
{
return;
}
ArrayDeque<Instant> times = reservations.get(key(row.getValueString("user_id"), row.getValueString("table_name"), row.getValueString("field_name")));
if(times != null)
{
times.pollFirst();
}
}
/*******************************************************************************
** Evaluate each row in drain order against already persisted predecessors.
*******************************************************************************/
private boolean isAnomaly(PendingLog pending) throws java.io.IOException
{
SecuredDataResolver.Guardrails settings = pending.guardrails();
if(settings == null)
{
return (false);
}
QRecord row = pending.row();
List<QRecord> history = history(row.getValueString("user_id"), row.getValueString("table_name"), row.getValueString("field_name"),
row.getValueInstant("created_at").minus(1, ChronoUnit.HOURS));
int misses = "NO_MATCH".equals(row.getValueString("outcome")) ? 1 : 0;
if(misses > 0 && settings.missAlertConsecutive() > 0)
{
List<QRecord> recent = SystemWrites.query(SecuredDataTables.ACCESS_LOG, new QQueryFilter()
.withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, row.getValueString("user_id")))
.withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, row.getValueString("table_name")))
.withCriteria(new QFilterCriteria("field_name", QCriteriaOperator.EQUALS, row.getValueString("field_name")))
.withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.EQUALS, "EXACT_MATCH_FILTER"))
.withOrderBy(new QFilterOrderBy("created_at", false)).withOrderBy(new QFilterOrderBy("id", false))
.withLimit(Math.max(1, settings.missAlertConsecutive())));
for(QRecord previous : recent)
{
if(!"NO_MATCH".equals(previous.getValueString("outcome")))
{
break;
}
misses++;
}
}
Set<String> distinct = new HashSet<>();
List<QRecord> combined = new ArrayList<>(history);
combined.add(row);
for(QRecord item : combined)
{
String fingerprints = item.getValueString("search_value_fingerprints");
if(fingerprints != null)
{
distinct.addAll(Arrays.asList(JsonUtils.toObject(fingerprints, String[].class)));
}
}
return ((settings.missAlertConsecutive() > 0 && misses >= settings.missAlertConsecutive())
|| (settings.distinctValueAlert() > 0 && distinct.size() > settings.distinctValueAlert()));
}
/*******************************************************************************
** Core #1090 is released in RC.5; its optional sink is supplied by qbit-alerts.
*******************************************************************************/
private static void raiseAlert(QRecord row)
{
String dedup = "secured_data.enumeration:" + row.getValueString("user_id") + ":" + row.getValueString("table_name") + "."
+ row.getValueString("field_name") + ":" + row.getValueInstant("created_at").atOffset(java.time.ZoneOffset.UTC).toLocalDate();
QAlerts.raise(new AlertSignal("secured_data.enumeration").withDedupKey(dedup)
.withTitle("Repeated exact-match searches on secured data").withSummary("Review the secured-data access log for enumeration activity."));
}
/*******************************************************************************
** Idempotent shutdown; stops scheduling and drains accepted rows.
*******************************************************************************/
@Override
public void close()
{
synchronized(lifecycleLock)
{
closed = true;
}
worker.shutdown();
flush();
if(Thread.currentThread() != shutdownHook)
{
try
{
Runtime.getRuntime().removeShutdownHook(shutdownHook);
}
catch(IllegalStateException expected)
{
// JVM shutdown has already begun.
}
}
}
}
@@ -0,0 +1,163 @@
/*
* 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.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.tables.AggregateAction;
import com.kingsrook.qqq.backend.core.actions.tables.CountAction;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.Aggregate;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.GroupBy;
import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput;
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.fields.QFieldType;
/*******************************************************************************
** System-only access-log counters. No protected values or unbounded row reads.
*******************************************************************************/
public class SecuredDataAnomalies
{
private final SecuredDataQBitConfig config;
private final Map<String, Double> medians = new LinkedHashMap<>();
private Instant medianDay;
/*******************************************************************************
** Instance-scoped bounded daily cache.
*******************************************************************************/
public SecuredDataAnomalies(SecuredDataQBitConfig config)
{
this.config = config;
}
/*******************************************************************************
** Evaluate before insertion, including this row exactly once.
*******************************************************************************/
public synchronized boolean evaluate(QRecord row) throws QException
{
String event = row.getValueString("event_type");
if("BREAK_GLASS_START".equals(event) || ("REVEAL_DENIED".equals(event) && "CAPPED".equals(row.getValueString("outcome"))))
{
return (true);
}
Instant now = row.getValueInstant("created_at");
if(!List.of("REVEAL", "EXACT_MATCH_FILTER").contains(event) || now == null)
{
return (false);
}
String user = row.getValueString("user_id");
QQueryFilter hour = filter(user, event, now.minus(1, ChronoUnit.HOURS), now, QCriteriaOperator.LESS_THAN_OR_EQUALS);
hour.getCriteria().stream().filter(criteria -> "created_at".equals(criteria.getFieldName())
&& criteria.getOperator() == QCriteriaOperator.GREATER_THAN_OR_EQUALS).forEach(criteria -> criteria.setOperator(QCriteriaOperator.GREATER_THAN));
if("EXACT_MATCH_FILTER".equals(event))
{
hour.withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, row.getValueString("table_name")))
.withCriteria(new QFilterCriteria("field_name", QCriteriaOperator.EQUALS, row.getValueString("field_name")));
return (count(hour) >= config.getAnomalyExactMatchesPerHour());
}
Instant day = now.truncatedTo(ChronoUnit.DAYS);
int today = count(filter(user, event, day, now, QCriteriaOperator.LESS_THAN_OR_EQUALS)) + 1;
if(today >= config.getAnomalyMinimumDailyReveals() && today > config.getAnomalyDailyMedianMultiplier() * median(user, day))
{
return (true);
}
GroupBy table = new GroupBy(QFieldType.STRING, "table_name");
GroupBy record = new GroupBy(QFieldType.STRING, "record_id");
var groups = SystemWrites.call(() -> new AggregateAction().execute(new AggregateInput(SecuredDataTables.ACCESS_LOG)
.withFilter(hour).withGroupBy(table).withGroupBy(record).withAggregate(new Aggregate("id", AggregateOperator.COUNT))
.withLimit(config.getAnomalyDistinctRecordsPerHour() + 1)).getResults());
long distinct = groups.size();
boolean alreadySeen = groups.stream().anyMatch(group -> java.util.Objects.equals(group.getGroupByValue(table), row.getValue("table_name"))
&& java.util.Objects.equals(group.getGroupByValue(record), row.getValue("record_id")));
return (distinct + (alreadySeen ? 0 : 1) > config.getAnomalyDistinctRecordsPerHour());
}
/*******************************************************************************
** Previous thirty complete UTC days, including zeros; even median averages middle days.
** Thirty scalar counts once per user/day; at most 2048 cached users.
*******************************************************************************/
private double median(String user, Instant day) throws QException
{
if(!day.equals(medianDay))
{
medians.clear();
medianDay = day;
}
if(!medians.containsKey(user))
{
int[] counts = new int[30];
for(int i = 0; i < counts.length; i++)
{
counts[i] = count(filter(user, "REVEAL", day.minus(i + 1, ChronoUnit.DAYS), day.minus(i, ChronoUnit.DAYS), QCriteriaOperator.LESS_THAN));
}
Arrays.sort(counts);
if(medians.size() >= 2048)
{
medians.remove(medians.keySet().iterator().next());
}
medians.put(user, (counts[14] + (double) counts[15]) / 2);
}
return (medians.get(user));
}
/*******************************************************************************
** Scalar database count, always as system.
*******************************************************************************/
private static int count(QQueryFilter filter) throws QException
{
return (SystemWrites.call(() -> new CountAction().execute(new CountInput(SecuredDataTables.ACCESS_LOG).withFilter(filter)).getCount()));
}
/*******************************************************************************
** Bounded time window and user, compatible with indexed access-log lookups.
*******************************************************************************/
private static QQueryFilter filter(String user, String event, Instant from, Instant until, QCriteriaOperator endOperator)
{
return (new QQueryFilter().withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, user))
.withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.EQUALS, event))
.withCriteria(new QFilterCriteria("created_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, from))
.withCriteria(new QFilterCriteria("created_at", endOperator, until)));
}
/*******************************************************************************
** Optional SPI: flags remain useful without a sink. Deduplication belongs to the sink.
*******************************************************************************/
public static void raise(QRecord row)
{
QAlerts.raise(new AlertSignal("secured_data.anomaly")
.withDedupKey("secured_data.anomaly:" + row.getValueString("user_id") + ":" + row.getValueInstant("created_at").toString().substring(0, 10))
.withOccurredAt(row.getValueInstant("created_at")).withTitle("Unusual secured-data access")
.withSummary("Review the flagged secured-data access-log row."));
}
}
@@ -0,0 +1,129 @@
/*
* 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.Collection;
import java.util.Objects;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Public classification API shared by QBits, with runtime rows overriding code metadata.
*******************************************************************************/
public final class SecuredDataClassifications
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataClassifications()
{
}
/*******************************************************************************
** Field row, table row, code field, code table, then unclassified.
*******************************************************************************/
public static DataClassification effective(QTableMetaData table, String fieldName)
{
QRecord row = row(table, fieldName);
if(row != null)
{
return (DataClassification.valueOf(row.getValueString("classification")));
}
QFieldMetaData field = table.getField(fieldName);
DataClassification classification = field == null ? null : CoreMetadataBridge.classification(table, field);
return (classification == null ? CoreMetadataBridge.classification(table, null) : classification);
}
/*******************************************************************************
** Table-level override or code-level table classification.
*******************************************************************************/
public static DataClassification effective(QTableMetaData table)
{
QRecord row = row(table, null);
return (row == null ? CoreMetadataBridge.classification(table, null) : DataClassification.valueOf(row.getValueString("classification")));
}
/*******************************************************************************
** Most sensitive effective field, including an empty table's classification.
*******************************************************************************/
public static DataClassification highest(QTableMetaData table)
{
return (table.getFields().isEmpty() ? effective(table) : highest(table, table.getFields().keySet()));
}
/*******************************************************************************
** Most sensitive among the requested fields only; an empty subset is null.
*******************************************************************************/
public static DataClassification highest(QTableMetaData table, Collection<String> fieldNames)
{
DataClassification highest = null;
for(String fieldName : fieldNames)
{
highest = DataClassification.max(highest, effective(table, fieldName));
}
return (highest);
}
/*******************************************************************************
** Effective classification row also owns mask and low-cardinality overrides.
*******************************************************************************/
static QRecord row(QTableMetaData table, String fieldName)
{
SecuredDataRuntime runtime = SecuredDataRuntime.current();
if(runtime == null)
{
return (null);
}
QRecord tableRow = null;
for(QRecord row : runtime.classificationRows())
{
if(!Objects.equals(table.getName(), row.getValueString("table_name")))
{
continue;
}
String field = row.getValueString("field_name");
if(Objects.equals(fieldName, field))
{
return (row);
}
if(field == null || field.isBlank())
{
tableRow = row;
}
}
return (tableRow);
}
}
@@ -21,25 +21,299 @@
package com.kingsrook.qbits.secureddata;
import java.security.SecureRandom;
import java.time.Clock;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Supplier;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qqq.backend.core.model.metadata.producers.MetaDataCustomizerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitConfig;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Configuration for the secured-data qbit.
** Configuration for policy resolution and bounded asynchronous access logging.
*******************************************************************************/
public class SecuredDataQBitConfig implements QBitConfig
{
private MetaDataCustomizerInterface<QTableMetaData> tableMetaDataCustomizer;
private Map<String, String> defaultTierByClassification = new HashMap<>();
private static final byte[] JVM_KEY = new SecureRandom().generateSeed(32);
private Map<String, String> defaultTierByClassification = new HashMap<>(Map.of("CONFIDENTIAL", "FULL", "PII", "MASKED", "PHI", "MASKED"));
private int anomalyDailyMedianMultiplier = 3;
private int anomalyMinimumDailyReveals = 10;
private int anomalyDistinctRecordsPerHour = 20;
private int anomalyExactMatchesPerHour = 50;
private String tablePathPrefix = "/app";
private String schedulerName;
private String backendName = "memory";
private Clock clock = Clock.systemUTC();
private int accessLogQueueCapacity = 4096;
private long accessLogFlushIntervalMillis = 250;
private int exactMatchPerHour = 20;
private int missAlertConsecutive = 5;
private int distinctValueAlert = 15;
private boolean minEntropyEnabled = true;
private boolean nameHeuristics = false;
private Set<DataClassification> viewLogClassifications = EnumSet.of(DataClassification.PII, DataClassification.PHI);
private Supplier<byte[]> fingerprintKeySupplier = () -> JVM_KEY.clone();
private MetaDataCustomizerInterface<QTableMetaData> tableMetaDataCustomizer = null;
/*******************************************************************************
** Getter for the optional table customizer.
** Scheduler to run the once-per-minute break-glass expiry job.
*******************************************************************************/
public String getSchedulerName()
{
return (schedulerName);
}
/*******************************************************************************
** Configure the host scheduler; null leaves manual scheduling to the host.
*******************************************************************************/
public SecuredDataQBitConfig withSchedulerName(String schedulerName)
{
this.schedulerName = schedulerName;
return (this);
}
/*******************************************************************************
** Get backendName.
*******************************************************************************/
public String getBackendName()
{
return (backendName);
}
/*******************************************************************************
** Configure backendName.
*******************************************************************************/
public SecuredDataQBitConfig withBackendName(String backendName)
{
this.backendName = backendName;
return (this);
}
/*******************************************************************************
** Get clock.
*******************************************************************************/
public Clock getClock()
{
return (clock);
}
/*******************************************************************************
** Configure clock.
*******************************************************************************/
public SecuredDataQBitConfig withClock(Clock clock)
{
this.clock = clock;
return (this);
}
/*******************************************************************************
** Get accessLogQueueCapacity.
*******************************************************************************/
public int getAccessLogQueueCapacity()
{
return (accessLogQueueCapacity);
}
/*******************************************************************************
** Configure accessLogQueueCapacity.
*******************************************************************************/
public SecuredDataQBitConfig withAccessLogQueueCapacity(int accessLogQueueCapacity)
{
this.accessLogQueueCapacity = accessLogQueueCapacity;
return (this);
}
/*******************************************************************************
** Get accessLogFlushIntervalMillis.
*******************************************************************************/
public long getAccessLogFlushIntervalMillis()
{
return (accessLogFlushIntervalMillis);
}
/*******************************************************************************
** Configure accessLogFlushIntervalMillis.
*******************************************************************************/
public SecuredDataQBitConfig withAccessLogFlushIntervalMillis(long accessLogFlushIntervalMillis)
{
this.accessLogFlushIntervalMillis = accessLogFlushIntervalMillis;
return (this);
}
/*******************************************************************************
** Get exactMatchPerHour.
*******************************************************************************/
public int getExactMatchPerHour()
{
return (exactMatchPerHour);
}
/*******************************************************************************
** Configure exactMatchPerHour.
*******************************************************************************/
public SecuredDataQBitConfig withExactMatchPerHour(int exactMatchPerHour)
{
this.exactMatchPerHour = exactMatchPerHour;
return (this);
}
/*******************************************************************************
** Get missAlertConsecutive.
*******************************************************************************/
public int getMissAlertConsecutive()
{
return (missAlertConsecutive);
}
/*******************************************************************************
** Configure missAlertConsecutive.
*******************************************************************************/
public SecuredDataQBitConfig withMissAlertConsecutive(int missAlertConsecutive)
{
this.missAlertConsecutive = missAlertConsecutive;
return (this);
}
/*******************************************************************************
** Get distinctValueAlert.
*******************************************************************************/
public int getDistinctValueAlert()
{
return (distinctValueAlert);
}
/*******************************************************************************
** Configure distinctValueAlert.
*******************************************************************************/
public SecuredDataQBitConfig withDistinctValueAlert(int distinctValueAlert)
{
this.distinctValueAlert = distinctValueAlert;
return (this);
}
/*******************************************************************************
** Get minEntropyEnabled.
*******************************************************************************/
public boolean getMinEntropyEnabled()
{
return (minEntropyEnabled);
}
/*******************************************************************************
** Configure minEntropyEnabled.
*******************************************************************************/
public SecuredDataQBitConfig withMinEntropyEnabled(boolean minEntropyEnabled)
{
this.minEntropyEnabled = minEntropyEnabled;
return (this);
}
/*******************************************************************************
** Get nameHeuristics.
*******************************************************************************/
public boolean getNameHeuristics()
{
return (nameHeuristics);
}
/*******************************************************************************
** Configure nameHeuristics.
*******************************************************************************/
public SecuredDataQBitConfig withNameHeuristics(boolean nameHeuristics)
{
this.nameHeuristics = nameHeuristics;
return (this);
}
/*******************************************************************************
** Get viewLogClassifications.
*******************************************************************************/
public Set<DataClassification> getViewLogClassifications()
{
return (viewLogClassifications);
}
/*******************************************************************************
** Configure viewLogClassifications.
*******************************************************************************/
public SecuredDataQBitConfig withViewLogClassifications(Set<DataClassification> viewLogClassifications)
{
this.viewLogClassifications = viewLogClassifications;
return (this);
}
/*******************************************************************************
** Get fingerprintKeySupplier.
*******************************************************************************/
public Supplier<byte[]> getFingerprintKeySupplier()
{
return (fingerprintKeySupplier);
}
/*******************************************************************************
** Configure fingerprintKeySupplier.
*******************************************************************************/
public SecuredDataQBitConfig withFingerprintKeySupplier(Supplier<byte[]> fingerprintKeySupplier)
{
this.fingerprintKeySupplier = fingerprintKeySupplier;
return (this);
}
/*******************************************************************************
** Get tableMetaDataCustomizer.
*******************************************************************************/
@Override
public MetaDataCustomizerInterface<QTableMetaData> getTableMetaDataCustomizer()
@@ -50,7 +324,7 @@ public class SecuredDataQBitConfig implements QBitConfig
/*******************************************************************************
** Fluent setter for the optional table customizer.
** Configure tableMetaDataCustomizer.
*******************************************************************************/
public SecuredDataQBitConfig withTableMetaDataCustomizer(MetaDataCustomizerInterface<QTableMetaData> tableMetaDataCustomizer)
{
@@ -61,21 +335,151 @@ public class SecuredDataQBitConfig implements QBitConfig
/*******************************************************************************
** Getter for the default tiers by classification (initially empty).
** Default tier for a classification.
*******************************************************************************/
public Map<String, String> getDefaultTierByClassification()
public SecuredDataQBitConfig withDefaultTier(DataClassification classification, FieldAccessTier tier)
{
return (defaultTierByClassification);
defaultTierByClassification.put(classification.name(), tier.name());
return (this);
}
/*******************************************************************************
** Fluent setter for the default tiers by classification.
** Compatibility getter for scaffold configuration.
*******************************************************************************/
public SecuredDataQBitConfig withDefaultTierByClassification(Map<String, String> defaultTierByClassification)
public Map<String, String> getDefaultTierByClassification()
{
this.defaultTierByClassification = defaultTierByClassification;
return (Map.copyOf(defaultTierByClassification));
}
/*******************************************************************************
** Replace configured defaults; missing restricted classifications fail closed.
*******************************************************************************/
public SecuredDataQBitConfig withDefaultTierByClassification(Map<String, String> tiers)
{
tiers.forEach((classification, tier) ->
{
DataClassification.valueOf(classification);
FieldAccessTier.valueOf(tier);
});
defaultTierByClassification = new HashMap<>(tiers);
return (this);
}
/*******************************************************************************
** Resolve the configured default.
*******************************************************************************/
public FieldAccessTier defaultTier(DataClassification classification)
{
return (FieldAccessTier.valueOf(defaultTierByClassification.getOrDefault(classification.name(), "MASKED")));
}
/*******************************************************************************
** Reject invalid infrastructure and guardrail settings at startup.
*******************************************************************************/
public void validate()
{
if(backendName == null || backendName.isBlank() || accessLogQueueCapacity < 1 || accessLogFlushIntervalMillis < 1
|| anomalyDailyMedianMultiplier < 1 || anomalyMinimumDailyReveals < 1 || anomalyDistinctRecordsPerHour < 1
|| anomalyExactMatchesPerHour < 1 || tablePathPrefix == null || !tablePathPrefix.startsWith("/") || tablePathPrefix.startsWith("//")
|| exactMatchPerHour < 0 || missAlertConsecutive < 0 || distinctValueAlert < 0)
{
throw (new IllegalArgumentException("Invalid secured-data configuration"));
}
Objects.requireNonNull(clock);
Objects.requireNonNull(viewLogClassifications);
Objects.requireNonNull(fingerprintKeySupplier);
}
/*******************************************************************************
** Get anomalyDailyMedianMultiplier.
*******************************************************************************/
public int getAnomalyDailyMedianMultiplier()
{
return (anomalyDailyMedianMultiplier);
}
/*******************************************************************************
** Configure anomalyDailyMedianMultiplier.
*******************************************************************************/
public SecuredDataQBitConfig withAnomalyDailyMedianMultiplier(int value)
{
this.anomalyDailyMedianMultiplier = value;
return (this);
}
/*******************************************************************************
** Get anomalyMinimumDailyReveals.
*******************************************************************************/
public int getAnomalyMinimumDailyReveals()
{
return (anomalyMinimumDailyReveals);
}
/*******************************************************************************
** Configure anomalyMinimumDailyReveals.
*******************************************************************************/
public SecuredDataQBitConfig withAnomalyMinimumDailyReveals(int value)
{
this.anomalyMinimumDailyReveals = value;
return (this);
}
/*******************************************************************************
** Get anomalyDistinctRecordsPerHour.
*******************************************************************************/
public int getAnomalyDistinctRecordsPerHour()
{
return (anomalyDistinctRecordsPerHour);
}
/*******************************************************************************
** Configure anomalyDistinctRecordsPerHour.
*******************************************************************************/
public SecuredDataQBitConfig withAnomalyDistinctRecordsPerHour(int value)
{
this.anomalyDistinctRecordsPerHour = value;
return (this);
}
/*******************************************************************************
** Get anomalyExactMatchesPerHour.
*******************************************************************************/
public int getAnomalyExactMatchesPerHour()
{
return (anomalyExactMatchesPerHour);
}
/*******************************************************************************
** Configure anomalyExactMatchesPerHour.
*******************************************************************************/
public SecuredDataQBitConfig withAnomalyExactMatchesPerHour(int value)
{
this.anomalyExactMatchesPerHour = value;
return (this);
}
/*******************************************************************************
** Get tablePathPrefix.
*******************************************************************************/
public String getTablePathPrefix()
{
return (tablePathPrefix);
}
/*******************************************************************************
** Configure tablePathPrefix.
*******************************************************************************/
public SecuredDataQBitConfig withTablePathPrefix(String value)
{
this.tablePathPrefix = value;
return (this);
}
}
@@ -21,14 +21,27 @@
package com.kingsrook.qbits.secureddata;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTableCustomizers;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizers;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
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.qbits.QBitMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaDataProducer;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Entry point for the secured-data qbit; no tables are produced yet.
** Entry point for secured-data policy, classification and access logging.
*******************************************************************************/
public class SecuredDataQBitProducer implements QBitMetaDataProducer<SecuredDataQBitConfig>
{
@@ -108,13 +121,91 @@ public class SecuredDataQBitProducer implements QBitMetaDataProducer<SecuredData
/*******************************************************************************
** Register this qbit and return its metadata, without producing tables.
** Register tables, permissions, runtime and the optional core enforcement bridge.
*******************************************************************************/
@Override
public MetaDataProducerMultiOutput produce(QInstance qInstance)
public MetaDataProducerMultiOutput produce(QInstance qInstance) throws QException
{
qBitConfig.validate();
if(qInstance.getSupplementalMetaData(SecuredDataRuntime.NAME) != null)
{
throw (new IllegalStateException("Only one secured-data QBit may be registered per instance"));
}
QBitMetaData qBit = getQBitMetaData();
qInstance.addQBit(qBit);
return (new MetaDataProducerMultiOutput().with(qBit));
MetaDataProducerMultiOutput output = new MetaDataProducerMultiOutput();
SecuredDataTables.possibleValueSources(qInstance).forEach(output::add);
Map<String, QTableMetaData> tables = new LinkedHashMap<>();
for(QTableMetaData definition : SecuredDataTables.tables(qBitConfig))
{
QTableMetaData table = qBitConfig.getTableMetaDataCustomizer() == null ? definition
: qBitConfig.getTableMetaDataCustomizer().customizeMetaData(qInstance, definition);
for(TableCustomizers role : List.of(TableCustomizers.PRE_INSERT_RECORD, TableCustomizers.PRE_UPDATE_RECORD, TableCustomizers.PRE_DELETE_RECORD,
TableCustomizers.POST_INSERT_RECORD, TableCustomizers.POST_UPDATE_RECORD, TableCustomizers.POST_DELETE_RECORD))
{
table.withCustomizer(role, new QCodeReference(SecuredDataTableCustomizers.class));
}
table.setSourceQBitName(qBit.getName());
tables.put(table.getName(), table);
output.add(table);
}
output.add(com.kingsrook.qbits.secureddata.app.SecuredDataApp.app(tables));
output.add(com.kingsrook.qbits.secureddata.app.SecuredDataApp.widget());
com.kingsrook.qbits.secureddata.processes.BreakGlassProcesses.processes(qBitConfig).forEach(output::add);
output.add(SecuredDataTables.revealsJoin());
output.add(SecuredDataTables.revealsWidget());
output.addSelfToInstance(qInstance);
CoreMetadataBridge.register(qInstance);
com.kingsrook.qbits.secureddata.support.UiApiBridge.register(qInstance);
if(qBitConfig.getNameHeuristics())
{
seedHeuristics(qInstance);
}
CoreMetadataBridge.promoteClassifications(qInstance);
SecuredDataRuntime runtime = new SecuredDataRuntime(qInstance, qBitConfig);
runtime.addSelfToInstance(qInstance);
try
{
CoreFieldAccessBridge.register(qInstance, runtime.resolver());
}
catch(RuntimeException e)
{
runtime.close();
throw e;
}
return (new MetaDataProducerMultiOutput());
}
/*******************************************************************************
** Opt-in common-name defaults, preserving existing field/table classifications.
*******************************************************************************/
private static void seedHeuristics(QInstance instance)
{
for(QTableMetaData table : instance.getTables().values())
{
if(SecuredDataTables.ALL.contains(table.getName()))
{
continue;
}
for(QFieldMetaData field : table.getFields().values())
{
if(CoreMetadataBridge.classification(table, field) != null || CoreMetadataBridge.classification(table, null) != null)
{
continue;
}
String name = field.getName().toLowerCase(Locale.ROOT);
if(name.startsWith("diagnosis"))
{
CoreMetadataBridge.classifyField(field, DataClassification.PHI);
}
else if(List.of("ssn", "dob", "date_of_birth", "email", "phone").contains(name))
{
CoreMetadataBridge.classifyField(field, DataClassification.PII);
}
}
}
}
}
@@ -0,0 +1,509 @@
/*
* 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 javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.Serializable;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.time.Instant;
import java.util.Base64;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.TreeSet;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.permissions.SecuredDataPermissions;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessDecision;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEvent;
import com.kingsrook.qbits.secureddata.standin.FieldAccessResolverInterface;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.standin.FieldMaskStyle;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
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.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.model.session.QSystemUserSession;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
/*******************************************************************************
** Seven-step policy resolution with instance-versioned, bounded per-user state.
*******************************************************************************/
public class SecuredDataResolver implements FieldAccessResolverInterface
{
private final SecuredDataRuntime runtime;
private final byte[] fingerprintKey;
private final ThreadLocal<Boolean> resolving = ThreadLocal.withInitial(() -> false);
private final Map<String, RevealCache> reveals = new HashMap<>();
/*******************************************************************************
** Bounded per-user grant cache, with exact read-time expiry.
*******************************************************************************/
private record RevealCache(Instant until, List<QRecord> rows)
{
}
private long cachedVersion;
private List<QRecord> policies = List.of();
private final Map<String, UserState> users = new HashMap<>();
/*******************************************************************************
** Cached policy matches and break-glass rows. Expiration is checked on every use.
*******************************************************************************/
private record UserState(List<QRecord> policies, List<QRecord> breakGlass)
{
}
/*******************************************************************************
** Zero thresholds disable that guardrail; positive thresholds combine by minimum.
*******************************************************************************/
public record Guardrails(int exactMatchPerHour, int missAlertConsecutive, int distinctValueAlert, boolean minEntropyEnabled)
{
}
/*******************************************************************************
** Capture the supplied key once; default keys are shared within this JVM.
*******************************************************************************/
public SecuredDataResolver(SecuredDataRuntime runtime)
{
this.runtime = runtime;
this.fingerprintKey = Objects.requireNonNull(runtime.config().getFingerprintKeySupplier().get()).clone();
if(fingerprintKey.length < 16)
{
throw (new IllegalArgumentException("Fingerprint keys must contain at least 16 bytes"));
}
}
/*******************************************************************************
** Resolve classification, grants, policies, channel caps and entropy.
*******************************************************************************/
@Override
public FieldAccessDecision resolve(QTableMetaData table, QFieldMetaData field)
{
if(SystemWrites.active() || QContext.getQSession() instanceof QSystemUserSession
|| Objects.equals(table.getPrimaryKeyField(), field.getName()))
{
return (FieldAccessDecision.FULL);
}
if(resolving.get())
{
throw (new IllegalStateException("Recursive secured-data resolution outside a system lookup"));
}
resolving.set(true);
try
{
DataClassification classification = SecuredDataClassifications.effective(table, field.getName());
if(classification == null || classification == DataClassification.PUBLIC)
{
return (FieldAccessDecision.FULL);
}
QSession session = QContext.getQSession();
if(SecuredDataTables.ALL.contains(table.getName()) && session != null && session.hasPermission(SecuredDataPermissions.ADMIN))
{
return (FieldAccessDecision.FULL);
}
List<QRecord> matches = matching(table, classification);
FieldAccessTier tier = null;
for(QRecord row : matches)
{
if(blank(row.getValueString("client_channel")))
{
FieldAccessTier candidate = FieldAccessTier.valueOf(row.getValueString("tier"));
tier = tier == null ? candidate : tier.leastRestrictive(candidate);
}
}
if(tier == null)
{
tier = runtime.config().defaultTier(classification);
}
if(session != null && CoreMetadataBridge.hasFeature(table, SecuredDataPermissions.REVEAL))
{
tier = tier.leastRestrictive(FieldAccessTier.REVEALABLE);
}
if(activeBreakGlass(table.getName(), classification) != null
|| (session != null && CoreMetadataBridge.hasFeature(table, SecuredDataPermissions.FULL)))
{
tier = FieldAccessTier.FULL;
}
for(QRecord row : matches)
{
if(!blank(row.getValueString("client_channel")))
{
tier = tier.mostRestrictive(FieldAccessTier.valueOf(row.getValueString("tier")));
}
}
QRecord override = SecuredDataClassifications.row(table, field.getName());
String style = override == null ? null : override.getValueString("mask_style");
boolean exactAllowed = !guardrails(matches).minEntropyEnabled() || !lowCardinality(field, override);
return (new FieldAccessDecision(tier, blank(style) ? null : FieldMaskStyle.valueOf(style), "Secured-data policy", exactAllowed));
}
finally
{
resolving.remove();
}
}
/*******************************************************************************
** The field's matching policies also drive enumeration controls.
*******************************************************************************/
public Guardrails guardrails(QTableMetaData table, String fieldName)
{
return (guardrails(matching(table, SecuredDataClassifications.effective(table, fieldName))));
}
/*******************************************************************************
** Most restrictive enabled setting across matching rows; config when none match.
*******************************************************************************/
private Guardrails guardrails(List<QRecord> matches)
{
SecuredDataQBitConfig config = runtime.config();
if(matches.isEmpty())
{
return (new Guardrails(config.getExactMatchPerHour(), config.getMissAlertConsecutive(), config.getDistinctValueAlert(), config.getMinEntropyEnabled()));
}
int rate = 0;
int misses = 0;
int distinct = 0;
boolean entropy = false;
for(QRecord row : matches)
{
rate = minimumEnabled(rate, setting(row, "exact_match_per_hour", config.getExactMatchPerHour()));
misses = minimumEnabled(misses, setting(row, "miss_alert_consecutive", config.getMissAlertConsecutive()));
distinct = minimumEnabled(distinct, setting(row, "distinct_value_alert", config.getDistinctValueAlert()));
entropy |= row.getValueBoolean("min_entropy_enabled") == null ? config.getMinEntropyEnabled() : row.getValueBoolean("min_entropy_enabled");
}
return (new Guardrails(rate, misses, distinct, entropy));
}
/*******************************************************************************
** Read an optional numeric setting.
*******************************************************************************/
private static int setting(QRecord row, String name, int fallback)
{
Integer value = row.getValueInteger(name);
return (value == null ? fallback : value);
}
/*******************************************************************************
** Zero means off, so an enabled row always wins over a disabled row.
*******************************************************************************/
private static int minimumEnabled(int left, int right)
{
return (left == 0 ? right : right == 0 ? left : Math.min(left, right));
}
/*******************************************************************************
** Explicit true/false wins over the field type/name heuristic.
*******************************************************************************/
static boolean lowCardinality(QFieldMetaData field, QRecord override)
{
Boolean explicit = override == null ? null : override.getValueBoolean("low_cardinality");
if(explicit != null)
{
return (explicit);
}
QFieldType type = field.getType();
String name = (field.getName() + " " + field.getLabel()).replaceAll("([a-z])([A-Z])", "$1 $2").toLowerCase(Locale.ROOT);
return (type == QFieldType.BOOLEAN || type == QFieldType.DATE || type == QFieldType.DATE_TIME
|| field.getPossibleValueSourceName() != null || field.getInlinePossibleValueSource() != null
|| (type == QFieldType.INTEGER && name.contains("year"))
|| name.matches(".*(?:^|[^a-z])(state|region|province|zip3)(?:[^a-z]|$).*")
|| (type == QFieldType.STRING && field.getMaxLength() != null && field.getMaxLength() < 6));
}
/*******************************************************************************
** Policies for this user, classification, table and current normalized channel.
*******************************************************************************/
private List<QRecord> matching(QTableMetaData table, DataClassification classification)
{
String channel = CoreMetadataBridge.channel(QContext.getQSession());
return (state().policies().stream().filter(row -> classification != null && classification.name().equals(row.getValueString("classification")))
.filter(row -> blank(row.getValueString("table_name")) || table.getName().equals(row.getValueString("table_name")))
.filter(row -> blank(row.getValueString("client_channel")) || Objects.equals(channel, row.getValueString("client_channel"))).toList());
}
/*******************************************************************************
** Granting rows only: channel rows cap tiers and never grant reveal settings.
*******************************************************************************/
public List<QRecord> revealPolicies(QTableMetaData table, String fieldName)
{
return (matching(table, SecuredDataClassifications.effective(table, fieldName)).stream()
.filter(row -> blank(row.getValueString("client_channel")) && "REVEALABLE".equals(row.getValueString("tier"))).toList());
}
/*******************************************************************************
** Refresh policy rows once per version and matched state per relevant permissions.
*******************************************************************************/
private synchronized UserState state()
{
long version = runtime.policyVersion();
if(cachedVersion != version)
{
policies = List.copyOf(SystemWrites.query(SecuredDataTables.POLICY, new QQueryFilter()));
users.clear();
cachedVersion = version;
}
QSession session = QContext.getQSession();
TreeSet<String> held = new TreeSet<>();
for(QRecord policy : policies)
{
String permission = policy.getValueString("permission_name");
if(session != null && session.hasPermission(permission))
{
held.add(permission);
}
}
String key = JsonUtils.toJson(List.of(userId(), held));
UserState state = users.get(key);
if(state == null)
{
if(users.size() >= 1024)
{
users.clear();
}
List<QRecord> matching = policies.stream().filter(row -> Boolean.TRUE.equals(row.getValueBoolean("is_active")))
.filter(row -> held.contains(row.getValueString("permission_name"))).toList();
List<QRecord> breaks = SystemWrites.query(SecuredDataTables.BREAK_GLASS, new QQueryFilter()
.withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, userId())));
state = new UserState(matching, List.copyOf(breaks));
users.put(key, state);
}
return (state);
}
/*******************************************************************************
** Exact expiry is checked at use time, independent of the future expiry job.
*******************************************************************************/
public List<QRecord> activeBreakGlass()
{
Instant now = runtime.config().getClock().instant();
return (state().breakGlass().stream().filter(row -> "ACTIVE".equals(row.getValueString("status")))
.filter(row -> row.getValueInstant("expires_at") != null && row.getValueInstant("expires_at").isAfter(now)).toList());
}
/*******************************************************************************
** A break-glass grant must cover both the table and classification.
*******************************************************************************/
QRecord activeBreakGlass(String table, DataClassification classification)
{
return (activeBreakGlass().stream().filter(row -> blank(row.getValueString("table_name")) || table.equals(row.getValueString("table_name")))
.filter(row -> DataClassification.valueOf(Objects.requireNonNullElse(row.getValueString("classification_ceiling"), "PHI")).isAtLeast(classification))
.findFirst().orElse(null));
}
/*******************************************************************************
** Stable across unrelated permissions/records; includes channel and exact expiry.
*******************************************************************************/
@Override
public synchronized String getAccessFingerprint()
{
state();
TreeSet<String> relevant = new TreeSet<>();
QSession session = QContext.getQSession();
for(QRecord row : policies)
{
String permission = row.getValueString("permission_name");
if(session != null && session.hasPermission(permission))
{
relevant.add(permission);
}
}
for(QTableMetaData table : QContext.getQInstance().getTables().values())
{
String base = CoreMetadataBridge.permissionBase(table);
for(String suffix : List.of(SecuredDataPermissions.FULL, SecuredDataPermissions.REVEAL))
{
if(session != null && session.hasPermission(base + "." + suffix))
{
relevant.add(base + "." + suffix);
}
}
}
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(CoreMetadataBridge.channel(session), "")));
try
{
return (Base64.getUrlEncoder().withoutPadding().encodeToString(MessageDigest.getInstance("SHA-256").digest(payload.getBytes(StandardCharsets.UTF_8))));
}
catch(java.security.NoSuchAlgorithmException e)
{
throw (new IllegalStateException(e));
}
}
/*******************************************************************************
** Existing grants are read as system; phase (c) owns their creation.
*******************************************************************************/
@Override
public boolean isRevealActive(String tableName, String fieldName, Serializable primaryKey)
{
synchronized(reveals)
{
String user = userId();
Instant now = runtime.config().getClock().instant();
RevealCache cached = reveals.get(user);
if(cached == null || !cached.until().isAfter(now))
{
if(reveals.size() >= 1024)
{
reveals.clear();
}
cached = new RevealCache(now.plusSeconds(5), SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter()
.withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, user))
.withCriteria(new QFilterCriteria("expires_at", QCriteriaOperator.GREATER_THAN, now))));
reveals.put(user, cached);
}
return (cached.rows().stream().anyMatch(row -> tableName.equals(row.getValueString("table_name"))
&& fieldName.equals(row.getValueString("field_name")) && String.valueOf(primaryKey).equals(row.getValueString("record_id"))
&& row.getValueInstant("expires_at").isAfter(now)));
}
}
/*******************************************************************************
** Publish a newly created grant to all sessions on this instance immediately.
*******************************************************************************/
public void invalidateReveals()
{
synchronized(reveals)
{
reveals.clear();
}
}
/*******************************************************************************
** Logging never throws into a core read.
*******************************************************************************/
@Override
public void onAccess(FieldAccessEvent event)
{
runtime.logger().onAccess(event);
}
/*******************************************************************************
** Preflight enumeration limits; core reports the REFUSED outcome exactly once.
*******************************************************************************/
@Override
public void checkExactMatch(FieldAccessEvent event) throws QPermissionDeniedException
{
runtime.logger().checkExactMatch(event);
}
/*******************************************************************************
** A keyed, non-reversible search identifier. No raw value leaves this method.
*******************************************************************************/
@Override
public String fingerprintSearchValue(Serializable value)
{
try
{
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(fingerprintKey, "HmacSHA256"));
///////////////////////////////////////////////////////////////////////////////
// keep only 16 bits: enough to count distinct searched values in an hour, //
// far too few to confirm a guessed value (each fingerprint matches ~1 in //
// 65536 of the value space), so a persisted fingerprint is not a derivative //
// of the searched value that could be brute-forced with the key. //
///////////////////////////////////////////////////////////////////////////////
byte[] digest = mac.doFinal(JsonUtils.toJson(value).getBytes(StandardCharsets.UTF_8));
return (String.format("%02x%02x", digest[0], digest[1]));
}
catch(java.security.GeneralSecurityException e)
{
throw (new IllegalStateException("Unable to fingerprint search", e));
}
}
/*******************************************************************************
** Stable user identity for all of that user's sessions.
*******************************************************************************/
public static String userId()
{
QSession session = QContext.getQSession();
return (session == null || session.getUser() == null ? "anonymous" : Objects.requireNonNullElse(session.getUser().getIdReference(), "anonymous"));
}
/*******************************************************************************
** Treat empty optional selectors like null.
*******************************************************************************/
private static boolean blank(String value)
{
return (value == null || value.isBlank());
}
}
@@ -0,0 +1,186 @@
/*
* 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.concurrent.atomic.AtomicLong;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData;
/*******************************************************************************
** Instance-scoped services and invalidation clocks, never shared across applications.
*******************************************************************************/
public class SecuredDataRuntime implements QSupplementalInstanceMetaData, AutoCloseable
{
public static final String NAME = "securedDataRuntime";
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 transient SecuredDataQBitConfig config;
private final transient SecuredDataResolver resolver;
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();
/*******************************************************************************
** Construct services only after tables have been registered.
*******************************************************************************/
public SecuredDataRuntime(QInstance instance, SecuredDataQBitConfig config)
{
this.config = config;
this.resolver = new SecuredDataResolver(this);
this.anomalies = new SecuredDataAnomalies(config);
this.logger = new SecuredDataAccessLogger(instance, this);
}
/*******************************************************************************
** Supplemental metadata identity.
*******************************************************************************/
@Override
public String getName()
{
return (NAME);
}
/*******************************************************************************
** Services for the current QContext.
*******************************************************************************/
public static SecuredDataRuntime current()
{
return (QContext.getQInstance() == null ? null : QSupplementalInstanceMetaData.of(QContext.getQInstance(), NAME));
}
/*******************************************************************************
** Code configuration.
*******************************************************************************/
public SecuredDataQBitConfig config()
{
return (config);
}
/*******************************************************************************
** Resolver service.
*******************************************************************************/
public SecuredDataResolver resolver()
{
return (resolver);
}
/*******************************************************************************
** Logger service and drop counter.
*******************************************************************************/
public SecuredDataAccessLogger logger()
{
return (logger);
}
/*******************************************************************************
** Classification invalidation clock.
*******************************************************************************/
public long classificationVersion()
{
return (classificationVersion.get());
}
/*******************************************************************************
** Policy/break-glass invalidation clock.
*******************************************************************************/
public long policyVersion()
{
return (policyVersion.get());
}
/*******************************************************************************
** Post-commit customizers and host distributed invalidation call this.
*******************************************************************************/
public void invalidateClassifications()
{
classificationVersion.incrementAndGet();
}
/*******************************************************************************
** Post-commit customizers and host distributed invalidation call this.
*******************************************************************************/
public void invalidatePolicies()
{
policyVersion.incrementAndGet();
}
/*******************************************************************************
** Read classification rows once per version, always as the system.
*******************************************************************************/
synchronized List<com.kingsrook.qqq.backend.core.model.data.QRecord> classificationRows()
{
long version = classificationVersion();
if(cachedClassificationVersion != version)
{
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 (classificationRows);
}
/*******************************************************************************
** Drain the audit queue during normal host shutdown.
*******************************************************************************/
@Override
public void close()
{
logger.close();
}
/*******************************************************************************
** Anomaly counters shared by synchronous reveals and queued searches.
*******************************************************************************/
public SecuredDataAnomalies anomalies()
{
return (anomalies);
}
}
@@ -0,0 +1,90 @@
/*
* 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.time.Instant;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.secureddata.reveal.RevealOptions;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Caller-only banner and per-field reveal allowance summary.
*******************************************************************************/
public class StatusService
{
/*******************************************************************************
** Active session projection.
*******************************************************************************/
public record BreakGlassStatus(Serializable id, String reason, Instant expiresAt, String scope, String ceiling)
{
}
/*******************************************************************************
** Allowances differ by granting policy; null remaining means unlimited.
*******************************************************************************/
public record Allowance(String tableName, String fieldName, Integer remainingDailyAllowance)
{
}
/*******************************************************************************
** Status response.
*******************************************************************************/
public record Status(BreakGlassStatus breakGlass, int revealsUsedToday, List<Allowance> revealAllowances)
{
}
/*******************************************************************************
** Only readable revealable fields are included, without any record values.
*******************************************************************************/
public Status status() throws QException
{
List<QRecord> active = SecuredDataRuntime.current().resolver().activeBreakGlass();
QRecord row = active.isEmpty() ? null : active.getFirst();
BreakGlassStatus session = row == null ? null : new BreakGlassStatus(row.getValue("id"), row.getValueString("reason"), row.getValueInstant("expires_at"),
row.getValueString("table_name"), row.getValueString("classification_ceiling"));
RevealService service = new RevealService();
List<Allowance> allowances = new ArrayList<>();
for(QTableMetaData table : QContext.getQInstance().getTables().values())
{
for(QFieldMetaData field : table.getFields().values())
{
try
{
RevealOptions options = service.options(table.getName(), field.getName());
allowances.add(new Allowance(table.getName(), field.getName(), options.remainingDailyAllowance()));
}
catch(QPermissionDeniedException expected)
{
// This field offers no reveal operation to the caller.
}
}
}
return (new Status(session, service.usedToday(), List.copyOf(allowances)));
}
}
@@ -0,0 +1,88 @@
/*
* 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.app;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.permissions.SecuredDataPermissions;
import com.kingsrook.qqq.backend.core.actions.dashboard.widgets.AbstractWidgetRenderer;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.widgets.RenderWidgetInput;
import com.kingsrook.qqq.backend.core.model.actions.widgets.RenderWidgetOutput;
import com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML;
import com.kingsrook.qqq.backend.core.model.dashboard.widgets.WidgetType;
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.layout.QAppMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** One app and one home. Grants remain a child list; processes stay off the nav.
*******************************************************************************/
public final class SecuredDataApp
{
public static final String HOME_WIDGET = "securedDataHome";
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataApp()
{
}
/*******************************************************************************
** Admin-only home spanning the host's full grid.
*******************************************************************************/
public static QWidgetMetaData widget()
{
return (new QWidgetMetaData().withName(HOME_WIDGET).withLabel("Overview").withType(WidgetType.HTML.getType())
.withCodeReference(new QCodeReference(HomeRenderer.class)).withGridColumns(12).withIsCard(false)
.withPermissionRules(SecuredDataPermissions.rules()));
}
/*******************************************************************************
** Exactly four navigation tables.
*******************************************************************************/
public static QAppMetaData app(Map<String, QTableMetaData> tables)
{
QAppMetaData app = new QAppMetaData().withName("secured_data").withLabel("Secured Data")
.withIcon(new QIcon("shield")).withPermissionRules(SecuredDataPermissions.rules()).withWidgets(List.of(HOME_WIDGET));
SecuredDataTables.MAIN.forEach(name -> app.withChild(tables.get(name)));
return (app);
}
/*******************************************************************************
** Standard HTML widget, following the webhooks home pattern.
*******************************************************************************/
public static class HomeRenderer extends AbstractWidgetRenderer
{
/*******************************************************************************
** Render real viewer-scoped data.
*******************************************************************************/
@Override
public RenderWidgetOutput render(RenderWidgetInput input) throws QException
{
return (new RenderWidgetOutput(new RawHTML(null, SecuredDataHomeView.render(SecuredDataHomeData.load()))));
}
}
}
@@ -0,0 +1,185 @@
/*
* 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.app;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.SecuredDataRuntime;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qqq.backend.core.actions.tables.AggregateAction;
import com.kingsrook.qqq.backend.core.actions.tables.CountAction;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.Aggregate;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateOperator;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.GroupBy;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.QFilterOrderByAggregate;
import com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.QFilterOrderByGroupBy;
import com.kingsrook.qqq.backend.core.model.actions.tables.count.CountInput;
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.query.QueryInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
/*******************************************************************************
** Real home data, read as the viewer. Counts and rankings aggregate in the backend.
*******************************************************************************/
public class SecuredDataHomeData
{
private final Map<String, Long> kpis = new LinkedHashMap<>();
private final List<Section> sections = new ArrayList<>();
/*******************************************************************************
** A full-width table and the exact filter behind its View all link.
*******************************************************************************/
public record Section(String title, String empty, List<String> fields, List<String> labels, List<QRecord> rows, String href)
{
}
/*******************************************************************************
** Six KPIs and six lists; no samples or hidden truncation of aggregate counts.
*******************************************************************************/
public static SecuredDataHomeData load() throws QException
{
SecuredDataHomeData data = new SecuredDataHomeData();
Instant now = SecuredDataRuntime.current().config().getClock().instant();
Instant week = now.minus(7, ChronoUnit.DAYS);
Instant month = now.minus(30, ChronoUnit.DAYS);
data.kpis.put("Reveals today", count(SecuredDataTables.ACCESS_LOG, events(now.truncatedTo(ChronoUnit.DAYS), now, "REVEAL")));
data.kpis.put("Active reveal grants", count(SecuredDataTables.REVEAL_GRANT, new QQueryFilter()
.withCriteria(new QFilterCriteria("expires_at", QCriteriaOperator.GREATER_THAN, now))));
data.kpis.put("Active break-glass sessions", count(SecuredDataTables.BREAK_GLASS, new QQueryFilter()
.withCriteria(new QFilterCriteria("status", QCriteriaOperator.EQUALS, "ACTIVE"))
.withCriteria(new QFilterCriteria("expires_at", QCriteriaOperator.GREATER_THAN, now))));
QQueryFilter anomalies = window(week, now).withCriteria(new QFilterCriteria("anomaly_flag", QCriteriaOperator.EQUALS, true));
data.kpis.put("Anomaly flags (7 days)", count(SecuredDataTables.ACCESS_LOG, anomalies));
QQueryFilter denied = window(week, now).withSubFilter(new QQueryFilter().withBooleanOperator(QQueryFilter.BooleanOperator.OR)
.withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.EQUALS, "FILTER_DENIED"))
.withSubFilter(new QQueryFilter().withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.EQUALS, "EXACT_MATCH_FILTER"))
.withCriteria(new QFilterCriteria("outcome", QCriteriaOperator.EQUALS, "REFUSED"))));
data.kpis.put("Denied filters (7 days)", count(SecuredDataTables.ACCESS_LOG, denied));
data.kpis.put("Access-log queue drops", SecuredDataRuntime.current().logger().getDroppedCount());
data.recent("Recent reveals", "No reveals yet", events(null, now, "REVEAL"),
List.of("user_name", "table_name", "record_id", "field_name", "reason", "created_at", "client_channel"),
List.of("User", "Table", "Record", "Field", "Reason", "When", "Channel"));
data.top("Top revealers (30 days)", "No reveals in the last 30 days", "user_id", "User", events(month, now, "REVEAL"));
data.top("Top reasons (30 days)", "No reveal reasons in the last 30 days", "reason", "Reason", events(month, now, "REVEAL"));
data.recent("Break-glass events", "No break-glass events yet", events(null, now, "BREAK_GLASS_START", "BREAK_GLASS_END", "BREAK_GLASS_EXPIRED"),
List.of("user_name", "event_type", "reason", "created_at"), List.of("User", "Event", "Reason", "When"));
data.recent("Policy and classification changes", "No policy or classification changes yet", events(null, now, "POLICY_CHANGE", "CLASSIFICATION_CHANGE"),
List.of("user_name", "table_name", "record_id", "action_name", "created_at"), List.of("User", "Table", "Record", "Action", "When"));
data.recent("Anomaly flags", "No anomaly flags in the last 7 days", anomalies,
List.of("user_name", "event_type", "table_name", "field_name", "created_at"), List.of("User", "Event", "Table", "Field", "When"));
return (data);
}
/*******************************************************************************
** Scalar counts preserve viewer permissions.
*******************************************************************************/
private static long count(String table, QQueryFilter filter) throws QException
{
return (new CountAction().execute(new CountInput(table).withFilter(filter)).getCount());
}
/*******************************************************************************
** Newest ten, with deterministic id ordering for equal timestamps.
*******************************************************************************/
private void recent(String title, String empty, QQueryFilter filter, List<String> fields, List<String> labels) throws QException
{
filter.withOrderBy(new QFilterOrderBy("created_at", false)).withOrderBy(new QFilterOrderBy("id", false));
String href = link(filter);
List<QRecord> rows = new QueryAction().execute(new QueryInput(SecuredDataTables.ACCESS_LOG).withFilter(filter.withLimit(10))).getRecords();
sections.add(new Section(title, empty, fields, labels, rows, href));
}
/*******************************************************************************
** Top ten complete counts, with stable alphabetical tie ordering.
*******************************************************************************/
private void top(String title, String empty, String field, String label, QQueryFilter filter) throws QException
{
String href = link(filter);
GroupBy group = new GroupBy(QFieldType.STRING, field);
Aggregate count = new Aggregate("id", AggregateOperator.COUNT);
filter.withOrderBy(new QFilterOrderByAggregate(count, false)).withOrderBy(new QFilterOrderByGroupBy(group));
var results = new AggregateAction().execute(new AggregateInput(SecuredDataTables.ACCESS_LOG).withFilter(filter)
.withGroupBy(group).withAggregate(count).withLimit(10)).getResults();
List<QRecord> rows = results.stream().map(result -> new QRecord().withValue(field, result.getGroupByValue(group))
.withValue("count", result.getAggregateValue(count))).toList();
sections.add(new Section(title, empty, List.of(field, "count"), List.of(label, "Reveals"), rows, href));
}
/*******************************************************************************
** Next's table filter wire format, URL encoded; no widget row limit in the link.
*******************************************************************************/
private static String link(QQueryFilter filter)
{
return (SecuredDataRuntime.current().config().getTablePathPrefix() + "/" + SecuredDataTables.ACCESS_LOG
+ "?filter=" + URLEncoder.encode(JsonUtils.toJson(filter), StandardCharsets.UTF_8));
}
/*******************************************************************************
** Event filter scoped to a time window.
*******************************************************************************/
private static QQueryFilter events(Instant from, Instant now, String... events)
{
return (window(from, now).withCriteria(new QFilterCriteria("event_type", QCriteriaOperator.IN, java.util.Arrays.asList(events))));
}
/*******************************************************************************
** Exclude future timestamps from all home activity windows.
*******************************************************************************/
private static QQueryFilter window(Instant from, Instant now)
{
QQueryFilter filter = new QQueryFilter().withCriteria(new QFilterCriteria("created_at", QCriteriaOperator.LESS_THAN_OR_EQUALS, now));
if(from != null)
{
filter.withCriteria(new QFilterCriteria("created_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, from));
}
return (filter);
}
/*******************************************************************************
** KPI row.
*******************************************************************************/
public Map<String, Long> getKpis()
{
return (kpis);
}
/*******************************************************************************
** Full-width lists in display order.
*******************************************************************************/
public List<Section> getSections()
{
return (sections);
}
}
@@ -0,0 +1,101 @@
/*
* 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.app;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.util.Locale;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
/*******************************************************************************
** Inline styles survive Next's sanitizer. Full-width labelled card rows wrap at
** narrow widths; no inner scrollers. Inherited host text and theme border tokens.
*******************************************************************************/
public final class SecuredDataHomeView
{
private static final DateTimeFormatter WHEN = DateTimeFormatter.ofPattern("MMM d, HH:mm 'UTC'", Locale.ENGLISH).withZone(ZoneOffset.UTC);
private static final String GRID = "display:grid;grid-template-columns:repeat(auto-fit,minmax(min(100%,10rem),1fr));gap:.75rem;min-width:0;";
private static final String CARD = "border:1px solid var(--qqq-grid-border,currentColor);border-radius:.5rem;padding:1rem;min-width:0;";
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataHomeView()
{
}
/*******************************************************************************
** KPI row followed by six full-width tables, never side by side.
*******************************************************************************/
public static String render(SecuredDataHomeData data)
{
StringBuilder html = new StringBuilder("<div style=\"display:flex;flex-direction:column;gap:1rem;min-width:0;color:inherit\">");
html.append("<div aria-label=\"Secured data metrics\" style=\"").append(GRID).append("\">");
data.getKpis().forEach((label, value) -> html.append("<div style=\"").append(CARD)
.append("\"><div style=\"font-size:1.6rem;font-weight:600\">").append(value)
.append("</div><div>").append(esc(label)).append("</div></div>"));
html.append("</div>");
for(SecuredDataHomeData.Section section : data.getSections())
{
html.append("<section style=\"").append(CARD).append("\"><h3 style=\"margin:0;font-size:1rem\">")
.append(esc(section.title())).append("</h3><p><a style=\"color:inherit\" aria-label=\"View all ")
.append(esc(section.title())).append("\" href=\"")
.append(esc(section.href())).append("\">View all</a></p>");
if(section.rows().isEmpty())
{
html.append("<p>").append(esc(section.empty())).append("</p>");
}
for(QRecord row : section.rows())
{
html.append("<div style=\"").append(GRID).append("border-top:1px solid var(--qqq-grid-border,currentColor);padding:.75rem 0\">");
for(int i = 0; i < section.fields().size(); i++)
{
String field = section.fields().get(i);
String value = row.getValueString(field);
boolean date = "created_at".equals(field);
if(date && row.getValueInstant(field) != null)
{
value = WHEN.format(row.getValueInstant(field));
}
if(value == null || value.isBlank())
{
value = "—";
}
html.append("<div style=\"min-width:0\"><span style=\"display:block;font-size:.75rem;opacity:.7\">")
.append(esc(section.labels().get(i))).append("</span><span title=\"").append(esc(value))
.append("\" style=\"display:block;overflow:hidden;text-overflow:ellipsis;white-space:nowrap\">")
.append(esc(value)).append("</span></div>");
}
html.append("</div>");
}
html.append("</section>");
}
return (html.append("</div>").toString());
}
/*******************************************************************************
** Escape every text, tooltip and URL attribute.
*******************************************************************************/
private static String esc(String value)
{
return (value.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;").replace("\"", "&quot;").replace("'", "&#39;"));
}
}
@@ -0,0 +1,243 @@
/*
* 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.breakglass;
import java.io.Serializable;
import java.time.Instant;
import java.util.List;
import java.util.Objects;
import com.kingsrook.qbits.secureddata.SecuredDataResolver;
import com.kingsrook.qbits.secureddata.SecuredDataRuntime;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.permissions.SecuredDataPermissions;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.support.ActivityLog;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
import com.kingsrook.qqq.backend.core.alerts.AlertSeverity;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QNotFoundException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
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.actions.tables.update.UpdateInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
/*******************************************************************************
** Explicit, audited emergency access. No implicit admin access to user data.
*******************************************************************************/
public class BreakGlassService
{
public static final String START = "secured_data_break_glass_start";
public static final String END = "secured_data_break_glass_end";
public static final String EXPIRE = "secured_data_break_glass_expire";
private static final QLogger LOG = QLogger.getLogger(BreakGlassService.class);
/*******************************************************************************
** Validate first, then create a system-owned session and publish its policy version.
*******************************************************************************/
public QRecord start(String reason, Integer minutes, String table, DataClassification ceiling) throws QException
{
checkChannel();
if(!QContext.getQSession().hasPermission(START + ".hasAccess"))
{
throw (new QPermissionDeniedException("Permission denied."));
}
int duration = minutes == null ? 60 : minutes;
if(reason == null || reason.trim().length() < 20 || reason.length() > 500 || duration < 1 || duration > 480)
{
throw (new QBadRequestException("Reason must contain 20-500 characters; duration must be 1-480 minutes."));
}
if(table != null && table.isBlank())
{
table = null;
}
if(table != null && QContext.getQInstance().getTable(table) == null)
{
throw (new QBadRequestException("Unknown table scope."));
}
SecuredDataRuntime runtime = SecuredDataRuntime.current();
synchronized(runtime)
{
if(!runtime.resolver().activeBreakGlass().isEmpty())
{
throw (new QBadRequestException("An active break-glass session already exists."));
}
Instant now = runtime.config().getClock().instant();
QRecord row = SystemWrites.insertOne(SecuredDataTables.BREAK_GLASS, new QRecord()
.withValue("user_id", SecuredDataResolver.userId()).withValue("user_name", QContext.getQSession().getUser().getFullName())
.withValue("reason", reason).withValue("table_name", table).withValue("classification_ceiling", Objects.requireNonNullElse(ceiling, DataClassification.PHI).name())
.withValue("started_at", now).withValue("expires_at", now.plusSeconds(duration * 60L)).withValue("status", "ACTIVE"));
runtime.invalidatePolicies();
log(row, "BREAK_GLASS_START");
QAlerts.raise(new AlertSignal("secured_data.break_glass").withSeverity(AlertSeverity.fromLabel("HIGH", AlertSeverity.ERROR)).withDedupKey(dedup(row))
.withTitle("Break-glass access started").withSummary("Review the secured-data break-glass session.").withOccurredAt(now));
notifyAdmins(row);
return (row);
}
}
/*******************************************************************************
** Owner or admin may end an active session, never an assistant channel.
*******************************************************************************/
public QRecord end(Serializable id) throws QException
{
checkChannel();
synchronized(SecuredDataRuntime.current())
{
QRecord row = find(id);
checkOwner(row);
if(!"ACTIVE".equals(row.getValueString("status")))
{
throw (new QBadRequestException("Session is already finished."));
}
return (finish(row, "ENDED", "BREAK_GLASS_END"));
}
}
/*******************************************************************************
** Review uses the same ownership check; load rechecks against persisted state.
*******************************************************************************/
public void checkOwner(QRecord row) throws QPermissionDeniedException
{
checkChannel();
if(!Objects.equals(SecuredDataResolver.userId(), row.getValueString("user_id"))
&& !QContext.getQSession().hasPermission(SecuredDataPermissions.ADMIN))
{
throw (new QPermissionDeniedException("Only the owner or a secured-data administrator can end this session."));
}
}
/*******************************************************************************
** All rows are looked up as system; authorization remains the caller responsibility.
*******************************************************************************/
public QRecord find(Serializable id) throws QNotFoundException
{
List<QRecord> rows = SystemWrites.query(SecuredDataTables.BREAK_GLASS, new QQueryFilter(new QFilterCriteria("id", QCriteriaOperator.EQUALS, id)));
if(rows.isEmpty())
{
throw (new QNotFoundException("No record was found"));
}
return (rows.getFirst());
}
/*******************************************************************************
** Scheduled maintenance always performs its lookups and changes as system.
*******************************************************************************/
public int expire() throws QException
{
synchronized(SecuredDataRuntime.current())
{
return (SystemWrites.call(() ->
{
List<QRecord> rows = SystemWrites.query(SecuredDataTables.BREAK_GLASS, new QQueryFilter()
.withCriteria(new QFilterCriteria("status", QCriteriaOperator.EQUALS, "ACTIVE"))
.withCriteria(new QFilterCriteria("expires_at", QCriteriaOperator.LESS_THAN_OR_EQUALS, SecuredDataRuntime.current().config().getClock().instant())));
for(QRecord row : rows)
{
finish(row, "EXPIRED", "BREAK_GLASS_EXPIRED");
}
return (rows.size());
}));
}
}
/*******************************************************************************
** Update, audit and resolve using one stable per-session alert key.
*******************************************************************************/
private QRecord finish(QRecord row, String status, String event) throws QException
{
QRecord update = new QRecord().withValue("id", row.getValue("id")).withValue("status", status)
.withValue("ended_at", SecuredDataRuntime.current().config().getClock().instant()).withValue("ended_by", SecuredDataResolver.userId());
QRecord result = SystemWrites.call(() -> new UpdateAction().execute(new UpdateInput(SecuredDataTables.BREAK_GLASS).withRecord(update)).getRecords().getFirst());
if(result.getErrors() != null && !result.getErrors().isEmpty())
{
throw (new QException("Unable to finish break-glass session."));
}
SecuredDataRuntime.current().invalidatePolicies();
log(row, event);
QAlerts.resolve("secured_data.break_glass", dedup(row), status);
return (result);
}
/*******************************************************************************
** Audit the actor and affected session without copying protected field values.
*******************************************************************************/
private void log(QRecord row, String event) throws QException
{
SystemWrites.insertOne(SecuredDataTables.ACCESS_LOG, ActivityLog.row(event, SecuredDataTables.BREAK_GLASS, "ALLOWED")
.withValue("break_glass_id", row.getValue("id")).withValue("record_id", row.getValueString("id")).withValue("reason", row.getValue("reason")));
}
/*******************************************************************************
** Stable alert identity.
*******************************************************************************/
private String dedup(QRecord row)
{
return ("secured_data.break_glass:" + row.getValueString("id"));
}
/*******************************************************************************
** RC.5 lacks #1125; use the notify SPI when installed without a qbit-alerts dependency.
*******************************************************************************/
private void notifyAdmins(QRecord row)
{
try
{
Class<?> signalClass = Class.forName("com.kingsrook.qqq.backend.core.alerts.NotificationSignal");
Class<?> audienceClass = Class.forName("com.kingsrook.qqq.backend.core.alerts.NotificationAudience");
Object signal = signalClass.getConstructor(String.class).newInstance("Break-glass access started");
signalClass.getMethod("withAudience", audienceClass).invoke(signal, audienceClass.getMethod("permission", String.class).invoke(null, SecuredDataPermissions.ADMIN));
signalClass.getMethod("withSourceName", String.class).invoke(signal, "secured_data");
signalClass.getMethod("withSourceKey", String.class).invoke(signal, dedup(row));
QAlerts.class.getMethod("notify", signalClass).invoke(null, signal);
}
catch(ClassNotFoundException | NoSuchMethodException expected)
{
// TODO(core #1125): remove reflection at RC.6 and use the notification SPI directly.
LOG.warn("Break-glass admin bell notification unavailable: core notification SPI #1125 is not installed.");
}
catch(ReflectiveOperationException e)
{
LOG.warn("Unable to deliver break-glass admin bell notification.");
}
}
/*******************************************************************************
** Deny unauthenticated and assistant invocations in direct service calls too.
*******************************************************************************/
private void checkChannel() throws QPermissionDeniedException
{
if(QContext.getQSession() == null || QContext.getQSession().getUser() == null
|| "anonymous".equals(SecuredDataResolver.userId()) || SecuredDataResolver.userId().isBlank()
|| "assistant".equals(CoreMetadataBridge.channel(QContext.getQSession())))
{
throw (new QPermissionDeniedException("Permission denied."));
}
}
}
@@ -0,0 +1,81 @@
/*
* 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.metadata;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionsHelper;
import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType;
import com.kingsrook.qqq.backend.core.actions.values.QCustomPossibleValueProvider;
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.get.GetInput;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Fields of the selected table; table_name is supplied through the dependent picker.
*******************************************************************************/
public class FieldsOfTablePossibleValueSource implements QCustomPossibleValueProvider<String>
{
/*******************************************************************************
** Stored ids are unqualified field names; labels are provided by search.
*******************************************************************************/
@Override
public QPossibleValue<String> getPossibleValue(Serializable id)
{
return (id == null ? null : new QPossibleValue<>(id.toString(), id.toString()));
}
/*******************************************************************************
** Never offer fields from a table the administrator cannot read.
*******************************************************************************/
@Override
public List<QPossibleValue<String>> search(SearchPossibleValueSourceInput input) throws QException
{
Object tableName = input.getOtherValues() == null ? null : input.getOtherValues().get("table_name");
if(tableName == null && input.getOtherValues() != null)
{
tableName = input.getOtherValues().get("tableName");
}
List<QPossibleValue<String>> values = new ArrayList<>();
if(tableName == null || tableName.toString().isBlank())
{
return (values);
}
QTableMetaData table = QContext.getQInstance().getTable(tableName.toString());
if(table == null)
{
throw (new QException("Unknown table."));
}
if(PermissionsHelper.hasTablePermission(new GetInput(table.getName()), table.getName(), TablePermissionSubType.READ))
{
table.getFields().values().forEach(field -> values.add(new QPossibleValue<>(field.getName(), field.getLabel())));
}
return (completeCustomPVSSearch(input, values));
}
}
@@ -0,0 +1,105 @@
/*
* 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.metadata;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.standin.FieldMaskStyle;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValue;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSourceType;
/*******************************************************************************
** String-valued possible-value sources shared by UI metadata and the DDL.
*******************************************************************************/
public final class SecuredDataEnums
{
/*******************************************************************************
** Activity event names include the future Reveal and break-glass actions.
*******************************************************************************/
public enum EventType
{
VIEW, REVEAL, REVEAL_DENIED, EXACT_MATCH_FILTER, FILTER_DENIED, BREAK_GLASS_START, BREAK_GLASS_END,
BREAK_GLASS_EXPIRED, POLICY_CHANGE, CLASSIFICATION_CHANGE
}
/*******************************************************************************
** Access outcomes.
*******************************************************************************/
public enum Outcome
{
ALLOWED, DENIED, CAPPED, MATCH, NO_MATCH, REFUSED
}
/*******************************************************************************
** Break-glass lifecycle.
*******************************************************************************/
public enum BreakGlassStatus
{
ACTIVE, ENDED, EXPIRED
}
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataEnums()
{
}
/*******************************************************************************
** All enum sources, keeping the stand-in core types exact copies.
*******************************************************************************/
public static List<QPossibleValueSource> sources()
{
return (List.of(source("classification", DataClassification.values()), source("tier", FieldAccessTier.values()),
source("mask_style", FieldMaskStyle.values()), source("event_type", EventType.values()), source("outcome", Outcome.values()),
source("break_glass_status", BreakGlassStatus.values())));
}
/*******************************************************************************
** Convert enum names to stored string ids.
*******************************************************************************/
private static QPossibleValueSource source(String name, Enum<?>[] values)
{
List<QPossibleValue<?>> options = new ArrayList<>();
for(Enum<?> value : values)
{
options.add(new QPossibleValue<>(value.name(), value.name().replace('_', ' ')));
}
return (new QPossibleValueSource().withName("secured_data_" + name).withType(QPossibleValueSourceType.ENUM)
.withIdType(QFieldType.STRING).withEnumValues(options));
}
}
@@ -0,0 +1,244 @@
/*
* 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.metadata;
import java.time.Instant;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import com.kingsrook.qbits.secureddata.SecuredDataResolver;
import com.kingsrook.qbits.secureddata.SecuredDataRuntime;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.QBackendTransaction;
import com.kingsrook.qqq.backend.core.actions.customizers.TableCustomizerInterface;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
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.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.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
import com.kingsrook.qqq.backend.core.model.statusmessages.BadInputStatusMessage;
/*******************************************************************************
** Validation, activity-table write protection and post-commit cache invalidation.
*******************************************************************************/
public class SecuredDataTableCustomizers implements TableCustomizerInterface
{
/*******************************************************************************
** Defend system-only activity writes even when a caller skips permission checks.
*******************************************************************************/
@Override
public List<QRecord> preInsertOrUpdate(AbstractActionInput input, List<QRecord> records, boolean preview, Optional<List<QRecord>> oldRecords) throws QException
{
String table = input instanceof InsertInput insert ? insert.getTableName() : ((UpdateInput) input).getTableName();
assertWrite(table, input instanceof UpdateInput);
if(!SecuredDataTables.SYSTEM_WRITTEN.contains(table))
{
for(QRecord record : records)
{
QRecord old = oldRecords.orElse(List.of()).stream().filter(row -> Objects.equals(row.getValue("id"), record.getValue("id"))).findFirst().orElse(null);
QRecord effective = old == null ? new QRecord() : new QRecord(old);
record.getValues().forEach(effective::setValue);
validate(table, record, effective);
Instant now = SecuredDataRuntime.current().config().getClock().instant();
if(old == null)
{
record.setValue("create_date", now);
}
record.setValue("modify_date", now);
record.setValue("modified_by", SecuredDataResolver.userId());
}
}
return (records);
}
/*******************************************************************************
** Access logs are append-only even for the system.
*******************************************************************************/
private static void assertWrite(String table, boolean mutation) throws QPermissionDeniedException
{
if((mutation && SecuredDataTables.ACCESS_LOG.equals(table))
|| (SecuredDataTables.SYSTEM_WRITTEN.contains(table) && !SystemWrites.active() && !(QContext.getQSession() instanceof QSystemUserSession)))
{
throw (new QPermissionDeniedException("Secured-data activity is system-written; access logs are insert-only."));
}
}
/*******************************************************************************
** Validate target names, unique table-wide classifications and guardrail ranges.
*******************************************************************************/
private static void validate(String table, QRecord record, QRecord effective)
{
String target = effective.getValueString("table_name");
QTableMetaData metadata = target == null ? null : QContext.getQInstance().getTable(target);
if(target != null && metadata == null)
{
record.addError(new BadInputStatusMessage("Select an existing table."));
}
if(SecuredDataTables.CLASSIFICATION.equals(table))
{
String field = effective.getValueString("field_name");
if(field != null && field.isBlank())
{
field = null;
record.setValue("field_name", null);
}
if(field != null && (metadata == null || !metadata.getFields().containsKey(field)))
{
record.addError(new BadInputStatusMessage("Select a field of the selected table."));
}
if(target != null)
{
for(QRecord row : SystemWrites.query(table, new QQueryFilter().withCriteria(new QFilterCriteria("table_name", QCriteriaOperator.EQUALS, target))))
{
if(Objects.equals(field, row.getValueString("field_name")) && !Objects.equals(row.getValue("id"), effective.getValue("id")))
{
record.addError(new BadInputStatusMessage("A classification for this table and field already exists."));
}
}
}
}
else
{
Integer minutes = effective.getValueInteger("reveal_minutes");
if(minutes != null && (minutes < 1 || minutes > 60))
{
record.addError(new BadInputStatusMessage("Reveal duration must be 1 to 60 minutes."));
}
for(String name : List.of("exact_match_per_hour", "miss_alert_consecutive", "distinct_value_alert", "daily_reveal_cap"))
{
Integer value = effective.getValueInteger(name);
if(value != null && value < 0)
{
record.addError(new BadInputStatusMessage("Guardrail limits cannot be negative."));
}
}
}
}
/*******************************************************************************
** User deletes of activity are forbidden; the log is immutable for everyone.
*******************************************************************************/
@Override
public List<QRecord> preDelete(DeleteInput input, List<QRecord> records, boolean preview) throws QException
{
assertWrite(input.getTableName(), true);
return (records);
}
/*******************************************************************************
** Only successful mutations invalidate; transactions invalidate after commit.
*******************************************************************************/
@Override
public List<QRecord> postInsertOrUpdate(AbstractActionInput input, List<QRecord> records, Optional<List<QRecord>> oldRecords) throws QException
{
if(input instanceof InsertInput insert)
{
changed(insert.getTableName(), records, insert.getTransaction());
audit(insert.getTableName(), records, "INSERT", insert.getTransaction());
}
else if(input instanceof UpdateInput update)
{
changed(update.getTableName(), records, update.getTransaction());
audit(update.getTableName(), records, "UPDATE", update.getTransaction());
}
return (records);
}
/*******************************************************************************
** Deletions change the same versions as inserts and updates.
*******************************************************************************/
@Override
public List<QRecord> postDelete(DeleteInput input, List<QRecord> records) throws QException
{
changed(input.getTableName(), records, input.getTransaction());
audit(input.getTableName(), records, "DELETE", input.getTransaction());
return (records);
}
/*******************************************************************************
** Capture the instance service; callbacks need no current user context.
*******************************************************************************/
private static void changed(String table, List<QRecord> records, QBackendTransaction transaction)
{
if(records.stream().noneMatch(row -> row.getErrors() == null || row.getErrors().isEmpty()))
{
return;
}
SecuredDataRuntime runtime = SecuredDataRuntime.current();
Runnable invalidate = SecuredDataTables.CLASSIFICATION.equals(table) ? runtime::invalidateClassifications
: SecuredDataTables.POLICY.equals(table) || SecuredDataTables.BREAK_GLASS.equals(table) ? runtime::invalidatePolicies : null;
if(invalidate != null)
{
QBackendTransaction active = transaction == null ? QContext.getQBackendTransaction() : transaction;
if(active == null)
{
invalidate.run();
}
else
{
active.addAfterCommitCallback(invalidate);
}
}
}
/*******************************************************************************
** Value-free mutation audit in the same transaction as the changed metadata.
*******************************************************************************/
private static void audit(String table, List<QRecord> records, String action, QBackendTransaction transaction) throws QException
{
if(!List.of(SecuredDataTables.POLICY, SecuredDataTables.CLASSIFICATION).contains(table))
{
return;
}
for(QRecord record : records)
{
if(record.getErrors() == null || record.getErrors().isEmpty())
{
SystemWrites.insertOne(SecuredDataTables.ACCESS_LOG, com.kingsrook.qbits.secureddata.support.ActivityLog.row(
SecuredDataTables.POLICY.equals(table) ? "POLICY_CHANGE" : "CLASSIFICATION_CHANGE", table, "ALLOWED")
.withValue("record_id", record.getValueString("id")).withValue("action_name", action),
transaction == null ? QContext.getQBackendTransaction() : transaction);
}
}
}
}
@@ -0,0 +1,304 @@
/*
* 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.metadata;
import java.util.ArrayList;
import java.util.List;
import com.kingsrook.qbits.secureddata.SecuredDataQBitConfig;
import com.kingsrook.qbits.secureddata.permissions.SecuredDataPermissions;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qqq.backend.core.actions.dashboard.widgets.ChildRecordListRenderer;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
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.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinOn;
import com.kingsrook.qqq.backend.core.model.metadata.joins.JoinType;
import com.kingsrook.qqq.backend.core.model.metadata.joins.QJoinMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.layout.QIcon;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.PVSValueFormatAndFields;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSource;
import com.kingsrook.qqq.backend.core.model.metadata.possiblevalues.QPossibleValueSourceType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.Capability;
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.TablesPossibleValueSourceMetaDataProvider;
import com.kingsrook.qqq.backend.core.model.metadata.tables.UniqueKey;
/*******************************************************************************
** The five audited tables, record sections, possible values and reveal child list.
*******************************************************************************/
public final class SecuredDataTables
{
public static final String CLASSIFICATION = "secured_data_classification";
public static final String POLICY = "secured_data_policy";
public static final String REVEAL_GRANT = "secured_data_reveal_grant";
public static final String BREAK_GLASS = "secured_data_break_glass";
public static final String ACCESS_LOG = "secured_data_access_log";
public static final List<String> ALL = List.of(CLASSIFICATION, POLICY, REVEAL_GRANT, BREAK_GLASS, ACCESS_LOG);
public static final List<String> MAIN = List.of(CLASSIFICATION, POLICY, ACCESS_LOG, BREAK_GLASS);
public static final List<String> SYSTEM_WRITTEN = List.of(REVEAL_GRANT, BREAK_GLASS, ACCESS_LOG);
public static final String REVEALS_JOIN = "secured_data_access_log_reveals";
public static final String REVEALS_WIDGET = "securedDataReveals";
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataTables()
{
}
/*******************************************************************************
** Main table events for the host ESB wiring, following WebhooksIntegrations.
*******************************************************************************/
public static List<String> esbTableNames()
{
return (MAIN);
}
/*******************************************************************************
** Complete table metadata.
*******************************************************************************/
public static List<QTableMetaData> tables(SecuredDataQBitConfig config)
{
return (List.of(classification(config), policy(config), revealGrant(config), breakGlass(config), accessLog(config)));
}
/*******************************************************************************
** Common identity, audit and administration rules.
*******************************************************************************/
private static QTableMetaData base(SecuredDataQBitConfig config, String name, String label)
{
QTableMetaData table = new QTableMetaData().withName(name).withLabel(label).withBackendName(config.getBackendName())
.withPrimaryKeyField("id").withField(new QFieldMetaData("id", QFieldType.INTEGER).withBackendName("id").withIsEditable(false))
.withPermissionRules(SecuredDataPermissions.rules()).withIcon(new QIcon("shield"))
.withAuditRules(new QAuditRules().withAuditLevel(AuditLevel.FIELD));
CoreMetadataBridge.classifyTable(table);
if(ACCESS_LOG.equals(name))
{
table.withoutCapabilities(Capability.TABLE_UPDATE, Capability.TABLE_DELETE);
}
return (table);
}
/*******************************************************************************
** Every database column has an explicit snake_case name.
*******************************************************************************/
private static QFieldMetaData field(String name, QFieldType type)
{
QFieldMetaData field = new QFieldMetaData(name, type).withBackendName(name).withLabel(name.replace('_', ' '));
// TODO(contingent): dependsOn("table_name") once the core RC has it
return (field);
}
/*******************************************************************************
** Define Classification.
*******************************************************************************/
private static QTableMetaData classification(SecuredDataQBitConfig config)
{
QTableMetaData table = base(config, CLASSIFICATION, "Classification")
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("tables"))
.withField(field("field_name", QFieldType.STRING).withMaxLength(255).withPossibleValueSourceName("secured_data_fields"))
.withField(field("classification", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("secured_data_classification"))
.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(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"));
table.withSection(SectionFactory.defaultT3("create_date", "modify_date", "modified_by"));
table.withUniqueKey(new UniqueKey().withFieldNames(List.of("table_name", "field_name")));
return (table);
}
/*******************************************************************************
** Define Policy.
*******************************************************************************/
private static QTableMetaData policy(SecuredDataQBitConfig config)
{
QTableMetaData table = base(config, POLICY, "Policy")
.withField(field("name", QFieldType.STRING).withMaxLength(255).withIsRequired(true))
.withField(field("permission_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true))
.withField(field("classification", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("secured_data_classification"))
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withPossibleValueSourceName("tables"))
.withField(field("tier", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("secured_data_tier"))
.withField(field("reveal_minutes", QFieldType.INTEGER).withDefaultValue(5))
.withField(field("daily_reveal_cap", QFieldType.INTEGER))
.withField(field("reason_options", QFieldType.TEXT))
.withField(field("allow_free_text_reason", QFieldType.BOOLEAN).withDefaultValue(true))
.withField(field("require_free_text", QFieldType.BOOLEAN).withDefaultValue(false))
.withField(field("client_channel", QFieldType.STRING).withMaxLength(255))
.withField(field("exact_match_per_hour", QFieldType.INTEGER).withDefaultValue(20))
.withField(field("miss_alert_consecutive", QFieldType.INTEGER).withDefaultValue(5))
.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(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"));
table.withSection(SectionFactory.defaultT3("create_date", "modify_date", "modified_by"));
return (table);
}
/*******************************************************************************
** Define Reveal.
*******************************************************************************/
private static QTableMetaData revealGrant(SecuredDataQBitConfig config)
{
QTableMetaData table = base(config, REVEAL_GRANT, "Reveal")
.withField(field("user_id", QFieldType.STRING).withMaxLength(255).withIsRequired(true))
.withField(field("user_name", QFieldType.STRING).withMaxLength(255))
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("tables"))
.withField(field("record_id", QFieldType.STRING).withMaxLength(255).withIsRequired(true))
.withField(field("field_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("secured_data_fields"))
.withField(field("reason", QFieldType.STRING).withMaxLength(500))
.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));
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"));
return (table);
}
/*******************************************************************************
** Define Break-glass session.
*******************************************************************************/
private static QTableMetaData breakGlass(SecuredDataQBitConfig config)
{
QTableMetaData table = base(config, BREAK_GLASS, "Break-glass session")
.withField(field("user_id", QFieldType.STRING).withMaxLength(255).withIsRequired(true))
.withField(field("user_name", QFieldType.STRING).withMaxLength(255))
.withField(field("reason", QFieldType.STRING).withMaxLength(500))
.withField(field("reason_text", QFieldType.TEXT))
.withField(field("classification_ceiling", QFieldType.STRING).withMaxLength(255).withDefaultValue("PHI").withPossibleValueSourceName("secured_data_classification"))
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withPossibleValueSourceName("tables"))
.withField(field("started_at", QFieldType.DATE_TIME).withIsRequired(true))
.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"));
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"));
return (table);
}
/*******************************************************************************
** Define Access log.
*******************************************************************************/
private static QTableMetaData accessLog(SecuredDataQBitConfig config)
{
QTableMetaData table = base(config, ACCESS_LOG, "Access log")
.withField(field("event_type", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("secured_data_event_type"))
.withField(field("user_id", QFieldType.STRING).withMaxLength(255))
.withField(field("user_name", QFieldType.STRING).withMaxLength(255))
.withField(field("table_name", QFieldType.STRING).withMaxLength(255).withIsRequired(true).withPossibleValueSourceName("tables"))
.withField(field("record_id", QFieldType.TEXT))
.withField(field("field_name", QFieldType.TEXT))
.withField(field("record_count", QFieldType.INTEGER))
.withField(field("action_name", QFieldType.STRING).withMaxLength(255))
.withField(field("reason", QFieldType.STRING).withMaxLength(500))
.withField(field("reason_text", QFieldType.TEXT))
.withField(field("client_channel", QFieldType.STRING).withMaxLength(255))
.withField(field("outcome", QFieldType.STRING).withMaxLength(255).withPossibleValueSourceName("secured_data_outcome"))
.withField(field("anomaly_flag", QFieldType.BOOLEAN).withDefaultValue(false))
.withField(field("break_glass_id", QFieldType.INTEGER))
.withField(field("created_at", QFieldType.DATE_TIME).withIsRequired(true))
.withField(field("search_value_fingerprints", QFieldType.TEXT));
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", "search_value_fingerprints"));
table.withSection(SectionFactory.defaultT3("created_at"));
table.withSection(SectionFactory.customT2("reveals", new QIcon("visibility")).withLabel("Reveals").withWidgetName(REVEALS_WIDGET));
return (table);
}
/*******************************************************************************
** Core table picker plus a dependent field picker.
*******************************************************************************/
public static List<QPossibleValueSource> possibleValueSources(QInstance instance)
{
List<QPossibleValueSource> sources = new ArrayList<>(SecuredDataEnums.sources());
if(instance.getPossibleValueSource("tables") == null)
{
sources.add(TablesPossibleValueSourceMetaDataProvider.defineTablesPossibleValueSource(instance));
}
sources.add(new QPossibleValueSource().withName("secured_data_fields").withType(QPossibleValueSourceType.CUSTOM)
.withIdType(QFieldType.STRING).withValueFormatAndFields(PVSValueFormatAndFields.LABEL_ONLY)
.withCustomCodeReference(new QCodeReference(FieldsOfTablePossibleValueSource.class)));
return (sources);
}
/*******************************************************************************
** Reveals belong to the access-log record that authorized them.
*******************************************************************************/
public static QJoinMetaData revealsJoin()
{
return (new QJoinMetaData().withName(REVEALS_JOIN).withType(JoinType.ONE_TO_MANY)
.withLeftTable(ACCESS_LOG).withRightTable(REVEAL_GRANT).withJoinOn(new JoinOn("id", "access_log_id")));
}
/*******************************************************************************
** Read-only child list, never a navigation entry.
*******************************************************************************/
public static QWidgetMetaData revealsWidget()
{
return (ChildRecordListRenderer.widgetMetaDataBuilder(revealsJoin()).withName(REVEALS_WIDGET).withLabel("Reveals")
.withCanAddChildRecord(false).withMaxRows(50).getWidgetMetaData().withGridColumns(12)
.withPermissionRules(SecuredDataPermissions.rules()));
}
}
@@ -0,0 +1,55 @@
/*
* 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.permissions;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qqq.backend.core.actions.permissions.CustomPermissionChecker;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput;
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.update.UpdateInput;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.MetaDataWithPermissionRules;
/*******************************************************************************
** Admin-only management and read access; activity writes belong to system operations.
*******************************************************************************/
public class SecuredDataPermissionChecker implements CustomPermissionChecker
{
/*******************************************************************************
** Enforce the assistant wall on RC.5 too, when a trusted channel is supplied.
*******************************************************************************/
@Override
public void checkPermissionsThrowing(AbstractActionInput input, MetaDataWithPermissionRules metadata) throws QPermissionDeniedException
{
boolean write = input instanceof InsertInput || input instanceof UpdateInput || input instanceof DeleteInput;
if(QContext.getQSession() == null || "assistant".equals(CoreMetadataBridge.channel(QContext.getQSession()))
|| !QContext.getQSession().hasPermission(SecuredDataPermissions.ADMIN)
|| (write && SecuredDataTables.SYSTEM_WRITTEN.contains(metadata.getName())))
{
throw (new QPermissionDeniedException("Permission denied."));
}
}
}
@@ -0,0 +1,59 @@
/*
* 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.permissions;
import java.util.List;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
/*******************************************************************************
** Administrative access is independent of access to classified application data.
*******************************************************************************/
public final class SecuredDataPermissions
{
public static final String ADMIN = "secured_data.admin";
public static final String FULL = "secured_data_full";
public static final String REVEAL = "secured_data_reveal";
public static final List<String> ALL = List.of(ADMIN, "secured_data.hasAccess");
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SecuredDataPermissions()
{
}
/*******************************************************************************
** Standard QQQ custom checker, shared by tables, app and child widget.
*******************************************************************************/
public static QPermissionRules rules()
{
return (new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION).withPermissionBaseName("secured_data")
.withCustomPermissionChecker(new QCodeReference(SecuredDataPermissionChecker.class)));
}
}
@@ -0,0 +1,233 @@
/*
* 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.processes;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.SecuredDataQBitConfig;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.processes.BackendStep;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLineInterface;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.model.actions.processes.Status;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
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.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QBackendStepMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QComponentType;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendComponentMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFrontendStepMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.scheduleing.QScheduleMetaData;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractTransformStep;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ExtractViaQueryStep;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ProcessSummaryProviderInterface;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess;
/*******************************************************************************
** Table/record actions and the expiry schedule. Never added to navigation.
*******************************************************************************/
public final class BreakGlassProcesses
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private BreakGlassProcesses()
{
}
/*******************************************************************************
** A start form, a streamed Review/Result end action, and a hidden scheduled job.
*******************************************************************************/
public static List<QProcessMetaData> processes(SecuredDataQBitConfig config)
{
QProcessMetaData start = new QProcessMetaData().withName(BreakGlassService.START).withLabel("Start break-glass")
.withTableName(SecuredDataTables.BREAK_GLASS).withMinInputRecords(0).withMaxInputRecords(0)
.withPermissionRules(new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION))
.withStep(new QFrontendStepMetaData().withName("input").withLabel("Start break-glass")
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.EDIT_FORM))
.withFormField(new QFieldMetaData("reason", QFieldType.STRING).withLabel("Reason").withIsRequired(true).withMaxLength(500))
.withFormField(new QFieldMetaData("duration_minutes", QFieldType.INTEGER).withLabel("Duration minutes").withDefaultValue(60))
.withFormField(new QFieldMetaData("table_name", QFieldType.STRING).withLabel("Table scope").withPossibleValueSourceName("tables"))
.withFormField(new QFieldMetaData("classification_ceiling", QFieldType.STRING).withLabel("Classification ceiling")
.withDefaultValue("PHI").withPossibleValueSourceName("secured_data_classification")))
.withStep(new QBackendStepMetaData().withName("start").withCode(new QCodeReference(Start.class)))
.withStep(new QFrontendStepMetaData().withName("result").withLabel("Result")
.withComponent(new QFrontendComponentMetaData().withType(QComponentType.VIEW_FORM))
.withViewField(new QFieldMetaData("message", QFieldType.STRING)));
Map<String, Serializable> values = new HashMap<>();
values.put(StreamedETLWithFrontendProcess.FIELD_SOURCE_TABLE, SecuredDataTables.BREAK_GLASS);
values.put(StreamedETLWithFrontendProcess.FIELD_DESTINATION_TABLE, SecuredDataTables.BREAK_GLASS);
values.put(StreamedETLWithFrontendProcess.FIELD_SUPPORTS_FULL_VALIDATION, true);
values.put(StreamedETLWithFrontendProcess.FIELD_DO_FULL_VALIDATION, true);
values.put(StreamedETLWithFrontendProcess.FIELD_PREVIEW_MESSAGE, "The selected break-glass sessions will be ended.");
QProcessMetaData end = StreamedETLWithFrontendProcess.defineProcessMetaData(EndExtract.class, EndReview.class, EndLoad.class, values)
.withName(BreakGlassService.END).withLabel("End break-glass").withTableName(SecuredDataTables.BREAK_GLASS).withMinInputRecords(1)
.withPermissionRules(new QPermissionRules().withLevel(PermissionLevel.NOT_PROTECTED));
QProcessMetaData expire = new QProcessMetaData().withName(BreakGlassService.EXPIRE).withLabel("Expire break-glass sessions").withIsHidden(true)
.withPermissionRules(new QPermissionRules().withLevel(PermissionLevel.HAS_ACCESS_PERMISSION))
.withStep(new QBackendStepMetaData().withName("expire").withCode(new QCodeReference(Expire.class)));
if(config.getSchedulerName() != null)
{
expire.withSchedule(new QScheduleMetaData().withSchedulerName(config.getSchedulerName()).withRepeatSeconds(60).withInitialDelaySeconds(30));
}
return (List.of(start, end, expire));
}
/*******************************************************************************
** Start after the form is submitted.
*******************************************************************************/
public static class Start implements BackendStep
{
@Override
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
String ceiling = input.getValueString("classification_ceiling");
DataClassification classification;
try
{
classification = ceiling == null ? null : DataClassification.valueOf(ceiling);
}
catch(IllegalArgumentException e)
{
throw (new com.kingsrook.qqq.backend.core.exceptions.QBadRequestException("Unknown classification ceiling."));
}
new BreakGlassService().start(input.getValueString("reason"), input.getValueInteger("duration_minutes"), input.getValueString("table_name"), classification);
output.addValue("message", "Break-glass access is active.");
}
}
/*******************************************************************************
** Extract with system visibility; ownership is checked before any row enters the pipe.
*******************************************************************************/
public static class EndExtract extends ExtractViaQueryStep
{
@Override
public Integer doCount(RunBackendStepInput input)
{
return (null);
}
@Override
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
for(QRecord row : SystemWrites.query(SecuredDataTables.BREAK_GLASS, getQueryFilter(input)))
{
new BreakGlassService().checkOwner(row);
getRecordPipe().addRecord(row);
}
}
}
/*******************************************************************************
** Review validates ownership and reports the change in future and past tense.
*******************************************************************************/
public static class EndReview extends AbstractTransformStep implements ProcessSummaryProviderInterface
{
private final ProcessSummaryLine line = summary();
@Override
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
for(QRecord row : input.getRecords())
{
new BreakGlassService().checkOwner(row);
if("ACTIVE".equals(row.getValueString("status")))
{
line.incrementCountAndAddPrimaryKey(row.getValue("id"));
output.getRecords().add(row);
}
}
}
@Override
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
{
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
line.addSelfToListIfAnyCount(lines);
return (lines);
}
}
/*******************************************************************************
** Apply the reviewed operation, rechecking persisted ownership at execution time.
*******************************************************************************/
public static class EndLoad extends AbstractLoadStep implements ProcessSummaryProviderInterface
{
private final ProcessSummaryLine line = summary();
@Override
public void runOnePage(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
for(QRecord row : input.getRecords())
{
output.getRecords().add(new BreakGlassService().end(row.getValue("id")));
line.incrementCountAndAddPrimaryKey(row.getValue("id"));
}
}
@Override
public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput output, boolean isForResultScreen)
{
ArrayList<ProcessSummaryLineInterface> lines = new ArrayList<>();
line.addSelfToListIfAnyCount(lines);
return (lines);
}
}
/*******************************************************************************
** Standard ETL summary wording.
*******************************************************************************/
private static ProcessSummaryLine summary()
{
ProcessSummaryLine line = new ProcessSummaryLine(Status.OK, 0, null);
line.setSingularFutureMessage("session will be ended");
line.setPluralFutureMessage("sessions will be ended");
line.setSingularPastMessage("session was ended");
line.setPluralPastMessage("sessions were ended");
return (line);
}
/*******************************************************************************
** Expiry job; system context and writes are established by the service.
*******************************************************************************/
public static class Expire implements BackendStep
{
@Override
public void run(RunBackendStepInput input, RunBackendStepOutput output) throws QException
{
output.addValue("expired", new BreakGlassService().expire());
}
}
}
@@ -0,0 +1,37 @@
/*
* 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.reveal;
import com.kingsrook.qqq.backend.core.exceptions.QException;
/*******************************************************************************
** Transport-independent refusal, mapped to 429 by the UI API.
*******************************************************************************/
public class RevealCappedException extends QException
{
/*******************************************************************************
** Daily allowance exhausted.
*******************************************************************************/
public RevealCappedException()
{
super("Daily reveal allowance exhausted.");
}
}
@@ -0,0 +1,31 @@
/*
* 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.reveal;
import java.util.List;
/*******************************************************************************
** Policy-driven reveal dialog. Null remainingDailyAllowance means unlimited.
*******************************************************************************/
public record RevealOptions(List<String> reasonOptions, boolean allowFreeTextReason, boolean requireFreeText,
int revealMinutes, Integer remainingDailyAllowance)
{
}
@@ -0,0 +1,31 @@
/*
* 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.reveal;
import java.io.Serializable;
import java.time.Instant;
/*******************************************************************************
** The authorized value and its grant; never persist this response in an audit row.
*******************************************************************************/
public record RevealResult(Serializable value, String displayValue, Instant expiresAt, Serializable revealId)
{
}
@@ -0,0 +1,215 @@
/*
* 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.reveal;
import java.io.Serializable;
import java.time.Instant;
import java.time.ZoneOffset;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import com.kingsrook.qbits.secureddata.SecuredDataResolver;
import com.kingsrook.qbits.secureddata.SecuredDataRuntime;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.support.ActivityLog;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.permissions.CorePermissionEnforcer;
import com.kingsrook.qqq.backend.core.actions.permissions.PermissionEnforcement;
import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType;
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.QAlerts;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.exceptions.QNotFoundException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
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.tables.QTableMetaData;
/*******************************************************************************
** Reveal authorization and grant creation independent of any HTTP transport.
*******************************************************************************/
public class RevealService
{
/*******************************************************************************
** Use the current instance runtime, including its injectable clock.
*******************************************************************************/
public RevealOptions options(String tableName, String fieldName) throws QException
{
requireActor();
QRecord policy = policy(tableName, fieldName);
String reasons = policy.getValueString("reason_options");
Integer cap = policy.getValueInteger("daily_reveal_cap");
return (new RevealOptions(reasons == null ? List.of() : Arrays.stream(reasons.split("\\R")).map(String::trim).filter(s -> !s.isEmpty()).toList(),
!Boolean.FALSE.equals(policy.getValueBoolean("allow_free_text_reason")), Boolean.TRUE.equals(policy.getValueBoolean("require_free_text")),
Objects.requireNonNullElse(policy.getValueInteger("reveal_minutes"), 5), cap == null ? null : Math.max(0, cap - usedToday())));
}
/*******************************************************************************
** A single coherent policy: unlimited/highest cap, then longest duration, then id.
*******************************************************************************/
private QRecord policy(String tableName, String fieldName) throws QException
{
requireTarget(tableName, fieldName);
if("assistant".equals(CoreMetadataBridge.channel(QContext.getQSession())))
{
throw (new QPermissionDeniedException("Reveal is unavailable on the assistant channel."));
}
QTableMetaData table = QContext.getQInstance().getTable(tableName);
if(table == null || !table.getFields().containsKey(fieldName))
{
throw (new QNotFoundException("Table or field not found."));
}
GetInput input = new GetInput(tableName);
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
CorePermissionEnforcer.checkTablePermissions(input, TablePermissionSubType.READ);
if(SecuredDataRuntime.current().resolver().resolve(table, table.getField(fieldName)).tier() != FieldAccessTier.REVEALABLE)
{
throw (new QPermissionDeniedException("Field is not revealable."));
}
return (SecuredDataRuntime.current().resolver().revealPolicies(table, fieldName).stream()
.max(Comparator.comparingInt((QRecord row) -> Objects.requireNonNullElse(row.getValueInteger("daily_reveal_cap"), Integer.MAX_VALUE))
.thenComparingInt(row -> Objects.requireNonNullElse(row.getValueInteger("reveal_minutes"), 5))
.thenComparing(row -> row.getValueString("id"), Comparator.reverseOrder()))
.orElse(new QRecord().withValue("reveal_minutes", 5).withValue("allow_free_text_reason", true)));
}
/*******************************************************************************
** UTC daily count across all tables, including expired grants.
*******************************************************************************/
public int usedToday()
{
Instant start = SecuredDataRuntime.current().config().getClock().instant().atOffset(ZoneOffset.UTC).toLocalDate().atStartOfDay().toInstant(ZoneOffset.UTC);
return (SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter()
.withCriteria(new QFilterCriteria("user_id", QCriteriaOperator.EQUALS, SecuredDataResolver.userId()))
.withCriteria(new QFilterCriteria("granted_at", QCriteriaOperator.GREATER_THAN_OR_EQUALS, start))).size());
}
/*******************************************************************************
** Serialize the cap check and write within this runtime; first fetch always as caller.
*******************************************************************************/
public RevealResult reveal(String tableName, Serializable primaryKey, String fieldName, String reason, String reasonText) throws QException
{
requireActor();
SecuredDataRuntime runtime = SecuredDataRuntime.current();
synchronized(runtime)
{
if("assistant".equals(CoreMetadataBridge.channel(QContext.getQSession())))
{
denied(tableName, primaryKey, fieldName, "DENIED");
throw (new QPermissionDeniedException("Reveal is unavailable on the assistant channel."));
}
if(primaryKey == null)
{
throw (new QBadRequestException("primaryKey is required."));
}
requireTarget(tableName, fieldName);
GetInput input = new GetInput(tableName).withPrimaryKey(primaryKey).withShouldFetchHeavyFields(true);
input.setPermissionEnforcement(PermissionEnforcement.ENFORCE);
if(new GetAction().execute(input).getRecord() == null)
{
throw (new QNotFoundException("No record was found"));
}
RevealOptions options = options(tableName, fieldName);
validateReason(options, reason, reasonText);
if(options.remainingDailyAllowance() != null && options.remainingDailyAllowance() == 0)
{
denied(tableName, primaryKey, fieldName, "CAPPED");
QAlerts.raise(new AlertSignal("secured_data.reveal_capped").withDedupKey("secured_data.reveal_capped:" + SecuredDataResolver.userId())
.withTitle("Daily reveal allowance exhausted").withSummary("Review the secured-data access log."));
throw (new RevealCappedException());
}
QRecord raw = SystemWrites.call(() -> new GetAction().execute(new GetInput(tableName).withPrimaryKey(primaryKey)
.withShouldFetchHeavyFields(true).withShouldTranslatePossibleValues(true)).getRecord());
if(raw == null)
{
throw (new QNotFoundException("No record was found"));
}
com.kingsrook.qqq.backend.core.actions.values.QValueFormatter.setDisplayValuesInRecords(QContext.getQInstance().getTable(tableName), List.of(raw));
Instant now = runtime.config().getClock().instant();
Instant expiry = now.plusSeconds(options.revealMinutes() * 60L);
QRecord audit = SystemWrites.insertOne(SecuredDataTables.ACCESS_LOG, ActivityLog.row("REVEAL", tableName, "ALLOWED")
.withValue("record_id", String.valueOf(primaryKey)).withValue("field_name", fieldName).withValue("reason", reason).withValue("reason_text", reasonText));
QRecord grant = SystemWrites.insertOne(SecuredDataTables.REVEAL_GRANT, new QRecord()
.withValue("user_id", SecuredDataResolver.userId()).withValue("user_name", QContext.getQSession().getUser().getFullName())
.withValue("table_name", tableName).withValue("field_name", fieldName).withValue("record_id", String.valueOf(primaryKey))
.withValue("reason", reason).withValue("reason_text", reasonText).withValue("granted_at", now).withValue("expires_at", expiry)
.withValue("access_log_id", audit.getValue("id")));
runtime.resolver().invalidateReveals();
return (new RevealResult(raw.getValue(fieldName), raw.getDisplayValue(fieldName), expiry, grant.getValue("id")));
}
}
/*******************************************************************************
** Grants require a stable authenticated user identity across sessions.
*******************************************************************************/
private void requireActor() throws QPermissionDeniedException
{
if("anonymous".equals(SecuredDataResolver.userId()) || SecuredDataResolver.userId().isBlank())
{
throw (new QPermissionDeniedException("Reveal requires an authenticated user."));
}
}
/*******************************************************************************
** Missing target identifiers are malformed input, not an internal lookup error.
*******************************************************************************/
private void requireTarget(String table, String field) throws QBadRequestException
{
if(table == null || table.isBlank() || field == null || field.isBlank())
{
throw (new QBadRequestException("tableName and fieldName are required."));
}
}
/*******************************************************************************
** Persist refusals without user supplied text or protected values.
*******************************************************************************/
private void denied(String table, Serializable pk, String field, String outcome) throws QException
{
SystemWrites.insertOne(SecuredDataTables.ACCESS_LOG, ActivityLog.row("REVEAL_DENIED", table, outcome)
.withValue("record_id", String.valueOf(pk)).withValue("field_name", field));
}
/*******************************************************************************
** Reasons are a listed option or allowed free text; both inputs are bounded.
*******************************************************************************/
private void validateReason(RevealOptions options, String reason, String text) throws QBadRequestException
{
boolean hasText = text != null && !text.isBlank();
boolean listed = reason != null && options.reasonOptions().contains(reason);
if((reason != null && reason.length() > 500) || (text != null && text.length() > 500)
|| (options.requireFreeText() && !hasText)
|| (!options.allowFreeTextReason() && hasText && !options.requireFreeText())
|| (!listed && !(options.allowFreeTextReason() && (hasText || (reason != null && !reason.isBlank())))))
{
throw (new QBadRequestException("Supply an allowed reason and required explanation, each at most 500 characters."));
}
}
}
@@ -0,0 +1,67 @@
/*
* 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.standin;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData;
/*******************************************************************************
** Temporary classification metadata alongside the released AI exposure metadata.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1142, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData classification properties; delete when the pin moves to RC.6.
public class AiFieldMetaData extends QSupplementalFieldMetaData
{
public static final String TYPE = "securedDataAi";
private DataClassification classification;
/*******************************************************************************
** Metadata key, separate from RC.5's exposure-only AI metadata.
*******************************************************************************/
@Override
public String getType()
{
return (TYPE);
}
/*******************************************************************************
** Classification.
*******************************************************************************/
public DataClassification getClassification()
{
return (classification);
}
/*******************************************************************************
** Code classification until the released core supports it.
*******************************************************************************/
public AiFieldMetaData withClassification(DataClassification classification)
{
this.classification = classification;
return (this);
}
}
@@ -0,0 +1,67 @@
/*
* 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.standin;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData;
/*******************************************************************************
** Temporary classification metadata alongside the released AI exposure metadata.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1142, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.ai.AiTableMetaData classification properties; delete when the pin moves to RC.6.
public class AiTableMetaData extends QSupplementalTableMetaData
{
public static final String TYPE = "securedDataAi";
private DataClassification classification;
/*******************************************************************************
** Metadata key, separate from RC.5's exposure-only AI metadata.
*******************************************************************************/
@Override
public String getType()
{
return (TYPE);
}
/*******************************************************************************
** Classification.
*******************************************************************************/
public DataClassification getClassification()
{
return (classification);
}
/*******************************************************************************
** Code classification until the released core supports it.
*******************************************************************************/
public AiTableMetaData withClassification(DataClassification classification)
{
this.classification = classification;
return (this);
}
}
@@ -0,0 +1,66 @@
/*
* 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.standin;
import java.util.Locale;
import com.kingsrook.qqq.backend.core.model.session.QSession;
/*******************************************************************************
** RC.5 host adapter for a trusted, server-supplied client channel.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1141, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.model.session.QSession client channel properties; delete when the pin moves to RC.6.
public class ClientChannelSession extends QSession
{
private String clientChannel;
/*******************************************************************************
** Trusted host channel value; never take this from an unvalidated request.
*******************************************************************************/
public ClientChannelSession withClientChannel(String clientChannel)
{
this.clientChannel = clientChannel;
return (this);
}
/*******************************************************************************
** Full channel including optional request detail.
*******************************************************************************/
public String getClientChannel()
{
return (clientChannel);
}
/*******************************************************************************
** Normalized channel for policy matching.
*******************************************************************************/
public String getClientChannelName()
{
return (clientChannel == null || clientChannel.isBlank() ? null : clientChannel.strip().split("/", 2)[0].toLowerCase(Locale.ROOT));
}
}
@@ -0,0 +1,79 @@
/*
* 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.standin;
import java.util.LinkedHashMap;
import java.util.Map;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData;
/*******************************************************************************
** Temporary registry for the subset needed by this QBit.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1141, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.model.metadata.permissions.ClientChannelsMetaData registration subset; delete when the pin moves to RC.6.
public class ClientChannelsMetaData implements QSupplementalInstanceMetaData
{
private final Map<String, String> entries = new LinkedHashMap<>();
/*******************************************************************************
** Registry name, distinct from the future core registry.
*******************************************************************************/
@Override
public String getName()
{
return ("securedDataClientChannels");
}
/*******************************************************************************
** Instance registry.
*******************************************************************************/
public static ClientChannelsMetaData ofOrWithNew(QInstance instance)
{
return (QSupplementalInstanceMetaData.ofOrWithNew(instance, "securedDataClientChannels", ClientChannelsMetaData::new));
}
/*******************************************************************************
** Register the QBit's entry.
*******************************************************************************/
public ClientChannelsMetaData withDeniedPattern(String key, String value)
{
entries.put(key, value);
return (this);
}
/*******************************************************************************
** Read-only registration view.
*******************************************************************************/
public Map<String, String> getEntries()
{
return (Map.copyOf(entries));
}
}
@@ -0,0 +1,72 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
/*******************************************************************************
** Data sensitivity, ordered from least to most sensitive.
** Null means not classified and is less sensitive than every declared value.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1142, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.ai.DataClassification; delete when the pin moves to RC.6.
public enum DataClassification
{
/*******************************************************************************
** May be shown to anyone.
*******************************************************************************/
PUBLIC,
/*******************************************************************************
** Business-confidential information.
*******************************************************************************/
CONFIDENTIAL,
/*******************************************************************************
** Personally identifiable information.
*******************************************************************************/
PII,
/*******************************************************************************
** Protected health information under HIPAA.
*******************************************************************************/
PHI;
/*******************************************************************************
** Whether this classification is at least as sensitive as other.
** Every classification is at least as sensitive as null.
*******************************************************************************/
public boolean isAtLeast(DataClassification other)
{
return (other == null || ordinal() >= other.ordinal());
}
/*******************************************************************************
** The more sensitive classification; null loses to any declared value.
** Returns null when both values are null.
*******************************************************************************/
public static DataClassification max(DataClassification a, DataClassification b)
{
return (a == null ? b : a.isAtLeast(b) ? a : b);
}
}
@@ -0,0 +1,43 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
/*******************************************************************************
** A resolver decision; the reason must never contain a field value.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessDecision; delete when the pin moves to RC.6.
public record FieldAccessDecision(FieldAccessTier tier, FieldMaskStyle maskStyle, String reason, boolean exactMatchAllowed)
{
public static final FieldAccessDecision FULL = new FieldAccessDecision(FieldAccessTier.FULL, null, null);
/*******************************************************************************
** Compatibility constructor: exact-match searches are allowed by default.
*******************************************************************************/
public FieldAccessDecision(FieldAccessTier tier, FieldMaskStyle maskStyle, String reason)
{
this(tier, maskStyle, reason, true);
}
}
@@ -0,0 +1,272 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/*******************************************************************************
** Value-free audit notification. Primary key samples contain at most 50 keys.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEvent; delete when the pin moves to RC.6.
public class FieldAccessEvent
{
private FieldAccessEventType type;
private String tableName;
private List<String> fieldNames;
private List<Serializable> primaryKeys;
private Integer recordCount;
private String actionName;
private FieldAccessOutcome outcome;
private List<String> searchValueFingerprints;
/*******************************************************************************
** Getter for type
*******************************************************************************/
public FieldAccessEventType getType()
{
return (this.type);
}
/*******************************************************************************
** Setter for type
*******************************************************************************/
public void setType(FieldAccessEventType type)
{
this.type = type;
}
/*******************************************************************************
** Fluent setter for type
*******************************************************************************/
public FieldAccessEvent withType(FieldAccessEventType type)
{
setType(type);
return (this);
}
/*******************************************************************************
** Getter for tableName
*******************************************************************************/
public String getTableName()
{
return (this.tableName);
}
/*******************************************************************************
** Setter for tableName
*******************************************************************************/
public void setTableName(String tableName)
{
this.tableName = tableName;
}
/*******************************************************************************
** Fluent setter for tableName
*******************************************************************************/
public FieldAccessEvent withTableName(String tableName)
{
setTableName(tableName);
return (this);
}
/*******************************************************************************
** Getter for fieldNames
*******************************************************************************/
public List<String> getFieldNames()
{
return (this.fieldNames);
}
/*******************************************************************************
** Setter for fieldNames
*******************************************************************************/
public void setFieldNames(List<String> fieldNames)
{
this.fieldNames = fieldNames == null ? null : new ArrayList<>(fieldNames);
}
/*******************************************************************************
** Fluent setter for fieldNames
*******************************************************************************/
public FieldAccessEvent withFieldNames(List<String> fieldNames)
{
setFieldNames(fieldNames);
return (this);
}
/*******************************************************************************
** Getter for primaryKeys
*******************************************************************************/
public List<Serializable> getPrimaryKeys()
{
return (this.primaryKeys == null ? null : Collections.unmodifiableList(this.primaryKeys));
}
/*******************************************************************************
** Setter for primaryKeys
*******************************************************************************/
public void setPrimaryKeys(List<Serializable> primaryKeys)
{
this.primaryKeys = primaryKeys == null ? null : new ArrayList<>(primaryKeys.subList(0, Math.min(50, primaryKeys.size())));
}
/*******************************************************************************
** Fluent setter for primaryKeys
*******************************************************************************/
public FieldAccessEvent withPrimaryKeys(List<Serializable> primaryKeys)
{
setPrimaryKeys(primaryKeys);
return (this);
}
/*******************************************************************************
** Getter for recordCount
*******************************************************************************/
public Integer getRecordCount()
{
return (this.recordCount);
}
/*******************************************************************************
** Setter for recordCount
*******************************************************************************/
public void setRecordCount(Integer recordCount)
{
this.recordCount = recordCount;
}
/*******************************************************************************
** Fluent setter for recordCount
*******************************************************************************/
public FieldAccessEvent withRecordCount(Integer recordCount)
{
setRecordCount(recordCount);
return (this);
}
/*******************************************************************************
** Getter for actionName
*******************************************************************************/
public String getActionName()
{
return (this.actionName);
}
/*******************************************************************************
** Setter for actionName
*******************************************************************************/
public void setActionName(String actionName)
{
this.actionName = actionName;
}
/*******************************************************************************
** Fluent setter for actionName
*******************************************************************************/
public FieldAccessEvent withActionName(String actionName)
{
setActionName(actionName);
return (this);
}
/*******************************************************************************
** Getter for outcome
*******************************************************************************/
public FieldAccessOutcome getOutcome()
{
return (outcome);
}
/*******************************************************************************
** Fluent setter for outcome
*******************************************************************************/
public FieldAccessEvent withOutcome(FieldAccessOutcome outcome)
{
this.outcome = outcome;
return (this);
}
/*******************************************************************************
** Getter for searchValueFingerprints
*******************************************************************************/
public List<String> getSearchValueFingerprints()
{
return (searchValueFingerprints);
}
/*******************************************************************************
** Fluent setter for searchValueFingerprints
*******************************************************************************/
public FieldAccessEvent withSearchValueFingerprints(List<String> searchValueFingerprints)
{
this.searchValueFingerprints = searchValueFingerprints == null ? null : List.copyOf(searchValueFingerprints);
return (this);
}
}
@@ -0,0 +1,33 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
/*******************************************************************************
** Kinds of field access reported to the resolver.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessEventType; delete when the pin moves to RC.6.
public enum FieldAccessEventType
{
VIEW, EXACT_MATCH_FILTER, DENIED
}
@@ -0,0 +1,33 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
/*******************************************************************************
** Outcome of an exact-match search.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessOutcome; delete when the pin moves to RC.6.
public enum FieldAccessOutcome
{
MATCH, NO_MATCH, REFUSED
}
@@ -0,0 +1,90 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
import java.io.Serializable;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
/*******************************************************************************
** Session-aware policy, reveal grants and value-free access notifications.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessResolverInterface; delete when the pin moves to RC.6.
public interface FieldAccessResolverInterface
{
/*******************************************************************************
** Resolve using the current QContext session.
*******************************************************************************/
FieldAccessDecision resolve(QTableMetaData table, QFieldMetaData field);
/*******************************************************************************
** Whether this record and field have an active reveal grant.
*******************************************************************************/
default boolean isRevealActive(String tableName, String fieldName, Serializable primaryKey)
{
return (false);
}
/*******************************************************************************
** Stable identity of effective access, excluding reveal grants.
*******************************************************************************/
default String getAccessFingerprint()
{
return ("");
}
/*******************************************************************************
** Receive an audit notification; failures never prevent enforcement.
*******************************************************************************/
default void onAccess(FieldAccessEvent event)
{
}
/*******************************************************************************
** Refuse an exact-match search before execution; the exception message is user-facing.
*******************************************************************************/
default void checkExactMatch(FieldAccessEvent event) throws QPermissionDeniedException
{
}
/*******************************************************************************
** One-way fingerprint of a search literal. Raw values never enter access events.
*******************************************************************************/
default String fingerprintSearchValue(Serializable value)
{
return (null);
}
}
@@ -0,0 +1,126 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QCriteriaOperator;
/*******************************************************************************
** Effective field access, ordered from least to most restrictive.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessTier; delete when the pin moves to RC.6.
public enum FieldAccessTier
{
FULL, REVEALABLE, MASKED, HIDDEN;
/*******************************************************************************
** canReadValue
*******************************************************************************/
public boolean canReadValue()
{
return (this == FULL);
}
/*******************************************************************************
** canSort
*******************************************************************************/
public boolean canSort()
{
return (this == FULL);
}
/*******************************************************************************
** canGroupOrAggregate
*******************************************************************************/
public boolean canGroupOrAggregate()
{
return (this == FULL);
}
/*******************************************************************************
** canQuickSearch
*******************************************************************************/
public boolean canQuickSearch()
{
return (this == FULL);
}
/*******************************************************************************
** canWrite
*******************************************************************************/
public boolean canWrite()
{
return (this == FULL);
}
/*******************************************************************************
** Whether the operator is available for this tier.
*******************************************************************************/
public boolean canFilter(QCriteriaOperator operator)
{
return (this == FULL || (this == REVEALABLE && (operator == QCriteriaOperator.EQUALS || operator == QCriteriaOperator.IN)));
}
/*******************************************************************************
** Whether the field may be described to the caller.
*******************************************************************************/
public boolean isInMetaData()
{
return (this != HIDDEN);
}
/*******************************************************************************
** Combine tiers; null means FULL.
*******************************************************************************/
public FieldAccessTier mostRestrictive(FieldAccessTier other)
{
FieldAccessTier candidate = other == null ? FULL : other;
return (ordinal() > candidate.ordinal() ? this : candidate);
}
/*******************************************************************************
** Combine tiers; null means FULL.
*******************************************************************************/
public FieldAccessTier leastRestrictive(FieldAccessTier other)
{
FieldAccessTier candidate = other == null ? FULL : other;
return (ordinal() < candidate.ordinal() ? this : candidate);
}
}
@@ -0,0 +1,33 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2026. 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.standin;
/*******************************************************************************
** Presentation rules for a restricted value.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1172, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldMaskStyle; delete when the pin moves to RC.6.
public enum FieldMaskStyle
{
AUTO, EMAIL, LAST_4, FIRST_LAST, FULL
}
@@ -0,0 +1,79 @@
/*
* 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.standin;
import java.util.LinkedHashMap;
import java.util.Map;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData;
/*******************************************************************************
** Temporary registry for the subset needed by this QBit.
*******************************************************************************/
// STAND-IN(core=QRun-IO/qqq#1142, removeBy=RC.6): copy of com.kingsrook.qqq.backend.core.model.metadata.permissions.TableFeaturePermissionsMetaData registration subset; delete when the pin moves to RC.6.
public class TableFeaturePermissionsMetaData implements QSupplementalInstanceMetaData
{
private final Map<String, String> entries = new LinkedHashMap<>();
/*******************************************************************************
** Registry name, distinct from the future core registry.
*******************************************************************************/
@Override
public String getName()
{
return ("securedDataTableFeatures");
}
/*******************************************************************************
** Instance registry.
*******************************************************************************/
public static TableFeaturePermissionsMetaData ofOrWithNew(QInstance instance)
{
return (QSupplementalInstanceMetaData.ofOrWithNew(instance, "securedDataTableFeatures", TableFeaturePermissionsMetaData::new));
}
/*******************************************************************************
** Register the QBit's entry.
*******************************************************************************/
public TableFeaturePermissionsMetaData withPermission(String key, String value)
{
entries.put(key, value);
return (this);
}
/*******************************************************************************
** Read-only registration view.
*******************************************************************************/
public Map<String, String> getEntries()
{
return (Map.copyOf(entries));
}
}
@@ -0,0 +1,52 @@
/*
* 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.support;
import com.kingsrook.qbits.secureddata.SecuredDataResolver;
import com.kingsrook.qbits.secureddata.SecuredDataRuntime;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
/*******************************************************************************
** Synchronous activity audit rows for state-changing operations.
*******************************************************************************/
public final class ActivityLog
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private ActivityLog()
{
}
/*******************************************************************************
** Capture the actor before entering the system session. No field values.
*******************************************************************************/
public static QRecord row(String event, String table, String outcome)
{
return (new QRecord().withValue("event_type", event).withValue("table_name", table)
.withValue("user_id", SecuredDataResolver.userId())
.withValue("user_name", QContext.getQSession().getUser() == null ? "system" : QContext.getQSession().getUser().getFullName())
.withValue("client_channel", CoreMetadataBridge.channel(QContext.getQSession()))
.withValue("created_at", SecuredDataRuntime.current().config().getClock().instant())
.withValue("outcome", outcome).withValue("anomaly_flag", false));
}
}
@@ -0,0 +1,286 @@
/*
* 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.support;
import java.lang.reflect.InvocationTargetException;
import com.kingsrook.qbits.secureddata.standin.ClientChannelsMetaData;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.TableFeaturePermissionsMetaData;
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.permissions.PermissionsHelper;
import com.kingsrook.qqq.backend.core.actions.permissions.TablePermissionSubType;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
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.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.session.QSession;
/*******************************************************************************
** Adapters for #1141/#1142 APIs missing from the pinned released core.
*******************************************************************************/
public final class CoreMetadataBridge
{
private static final String PERMISSIONS = "com.kingsrook.qqq.backend.core.model.metadata.permissions.";
/*******************************************************************************
** Utility class.
*******************************************************************************/
private CoreMetadataBridge()
{
}
/*******************************************************************************
** Normalized client channel, with RC.5 session-adapter support.
*******************************************************************************/
public static String channel(QSession session)
{
return (session == null ? null : (String) optional(session, "getClientChannelName"));
}
/*******************************************************************************
** Read a code classification from released/future core or temporary metadata.
*******************************************************************************/
public static DataClassification classification(QTableMetaData table, QFieldMetaData field)
{
Object ai = field == null ? AiTableMetaData.of(table) : AiFieldMetaData.of(field);
Object result = ai == null ? null : optional(ai, "getClassification");
if(result != null)
{
return (DataClassification.valueOf(result.toString()));
}
Object fallback = field == null ? table.getSupplementalMetaData("securedDataAi") : field.getSupplementalMetaData("securedDataAi");
return (fallback == null ? null : (DataClassification) optional(fallback, "getClassification"));
}
/*******************************************************************************
** Protect the QBit's own AI routing metadata on either core version.
*******************************************************************************/
public static void classifyTable(QTableMetaData table)
{
AiTableMetaData ai = AiTableMetaData.ofOrWithNew(table);
ai.withExposure(AiExposure.NONE);
setClassification(ai, DataClassification.CONFIDENTIAL);
table.withSupplementalMetaData(new com.kingsrook.qbits.secureddata.standin.AiTableMetaData().withClassification(DataClassification.CONFIDENTIAL));
}
/*******************************************************************************
** Seed opt-in name heuristics without overriding explicit code metadata.
*******************************************************************************/
public static void classifyField(QFieldMetaData field, DataClassification classification)
{
AiFieldMetaData ai = AiFieldMetaData.of(field);
if(ai == null)
{
ai = new AiFieldMetaData();
field.withSupplementalMetaData(ai);
}
setClassification(ai, classification);
field.withSupplementalMetaData(new com.kingsrook.qbits.secureddata.standin.AiFieldMetaData().withClassification(classification));
}
/*******************************************************************************
** Copy the classification into core when that property exists.
*******************************************************************************/
private static void setClassification(Object ai, DataClassification classification)
{
try
{
Class<?> type = Class.forName("com.kingsrook.qqq.backend.core.actions.ai.DataClassification");
Object value = type.getMethod("valueOf", String.class).invoke(null, classification.name());
ai.getClass().getMethod("withClassification", type).invoke(ai, value);
}
catch(ClassNotFoundException | NoSuchMethodException expected)
{
// RC.5 has exposure-only metadata; the stand-in carries classification.
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Unable to set core classification", e));
}
}
/*******************************************************************************
** Register the assistant wall and both features. Catalog applies to all tables.
*******************************************************************************/
public static void register(QInstance instance)
{
ClientChannelsMetaData.ofOrWithNew(instance).withDeniedPattern("assistant", "secured_data_*");
registerChannel(instance);
for(String suffix : new String[] {"secured_data_full", "secured_data_reveal"})
{
String label = "Secured data: " + suffix.substring("secured_data_".length());
TableFeaturePermissionsMetaData.ofOrWithNew(instance).withPermission(suffix, label);
try
{
Class<?> registry = Class.forName(PERMISSIONS + "TableFeaturePermissionsMetaData");
Class<?> entry = Class.forName(PERMISSIONS + "TableFeaturePermission");
Object feature = entry.getConstructor().newInstance();
entry.getMethod("withSuffix", String.class).invoke(feature, suffix);
entry.getMethod("withLabel", String.class).invoke(feature, label);
Object metadata = registry.getMethod("ofOrWithNew", QInstance.class).invoke(null, instance);
registry.getMethod("withPermission", entry).invoke(metadata, feature);
}
catch(ClassNotFoundException expected)
{
// RC.5 uses the stand-in catalog until core exposes the registry.
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Unable to register table features", e));
}
}
}
/*******************************************************************************
** Core channel enforcement when the #1141 API is installed.
*******************************************************************************/
private static void registerChannel(QInstance instance)
{
try
{
Class<?> type = Class.forName(PERMISSIONS + "ClientChannelsMetaData");
Object metadata = type.getMethod("ofOrWithNew", QInstance.class).invoke(null, instance);
type.getMethod("withDeniedPattern", String.class, String.class).invoke(metadata, "assistant", "secured_data_*");
}
catch(ClassNotFoundException expected)
{
// The RC.5 custom permission checker also enforces the local wall.
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Unable to register client channel wall", e));
}
}
/*******************************************************************************
** Use core's feature semantics, including table READ and permission base names.
*******************************************************************************/
public static boolean hasFeature(QTableMetaData table, String suffix)
{
try
{
return ((Boolean) PermissionsHelper.class.getMethod("hasTableFeaturePermission", QTableMetaData.class, String.class).invoke(null, table, suffix));
}
catch(NoSuchMethodException expected)
{
if(table.getIsHidden() || !PermissionsHelper.hasTablePermission(new GetInput(table.getName()), table.getName(), TablePermissionSubType.READ))
{
return (false);
}
QPermissionRules rules = PermissionsHelper.getEffectivePermissionRules(table, QContext.getQInstance());
String base = permissionBase(table);
return (rules.getLevel() == PermissionLevel.NOT_PROTECTED || QContext.getQSession().hasPermission(base + "." + suffix));
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Core feature permission check failed", e));
}
}
/*******************************************************************************
** Missing properties are expected only on RC.5; invocation errors fail closed.
*******************************************************************************/
private static Object optional(Object target, String name)
{
try
{
return (target.getClass().getMethod(name).invoke(target));
}
catch(NoSuchMethodException expected)
{
return (null);
}
catch(IllegalAccessException | InvocationTargetException e)
{
throw (new IllegalStateException("Core metadata adapter failed", e));
}
}
/*******************************************************************************
** RC.5 keeps core's equivalent helper package-private.
*******************************************************************************/
public static String permissionBase(QTableMetaData table)
{
QPermissionRules rules = PermissionsHelper.getEffectivePermissionRules(table, QContext.getQInstance());
String base = rules.getPermissionBaseName();
return (base == null || base.isBlank() ? table.getName() : base);
}
/*******************************************************************************
** Promote temporary host code classifications so future core AI routing sees them.
*******************************************************************************/
public static void promoteClassifications(QInstance instance)
{
for(QTableMetaData table : instance.getTables().values())
{
DataClassification tableClassification = classification(table, null);
if(tableClassification != null)
{
setClassification(AiTableMetaData.ofOrWithNew(table), tableClassification);
}
for(QFieldMetaData field : table.getFields().values())
{
DataClassification fieldClassification = classification(table, field);
if(fieldClassification != null)
{
AiFieldMetaData ai = AiFieldMetaData.of(field);
if(ai == null)
{
ai = new AiFieldMetaData();
field.withSupplementalMetaData(ai);
}
setClassification(ai, fieldClassification);
}
}
}
}
}
@@ -0,0 +1,173 @@
/*
* 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.support;
import java.util.List;
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;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
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.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.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QSystemUserSession;
/*******************************************************************************
** System-session lookups and writes; restoring the caller even after a failure.
*******************************************************************************/
public final class SystemWrites
{
private static final ThreadLocal<Integer> DEPTH = ThreadLocal.withInitial(() -> 0);
/*******************************************************************************
** Work inside a system session.
*******************************************************************************/
@FunctionalInterface
public interface Work<T>
{
/*******************************************************************************
** Execute.
*******************************************************************************/
T run() throws QException;
}
/*******************************************************************************
** Utility class.
*******************************************************************************/
private SystemWrites()
{
}
/*******************************************************************************
** Preserve the transaction and instance, replacing only the session.
*******************************************************************************/
public static <T> T call(Work<T> work) throws QException
{
QSession previous = QContext.getQSession();
DEPTH.set(DEPTH.get() + 1);
QContext.setQSession(new QSystemUserSession(QContext.getQInstance()));
try(CorePermissionEnforcer.AuthorizedScope ignored = CorePermissionEnforcer.openAuthorizedScope())
{
return (work.run());
}
finally
{
QContext.setQSession(previous);
DEPTH.set(DEPTH.get() - 1);
}
}
/*******************************************************************************
** Reentrancy guard used by the resolver.
*******************************************************************************/
public static boolean active()
{
return (DEPTH.get() > 0);
}
/*******************************************************************************
** Query without user locks or field access recursion.
*******************************************************************************/
public static List<QRecord> query(String table, QQueryFilter filter)
{
try
{
return (call(() -> new QueryAction().execute(new QueryInput(table).withFilter(filter)).getRecords()));
}
catch(QException e)
{
throw (new IllegalStateException("Unable to read secured-data state", e));
}
}
/*******************************************************************************
** Insert and reject backend record errors.
*******************************************************************************/
public static QRecord insertOne(String table, QRecord record) throws QException
{
return (insertOne(table, record, QContext.getQBackendTransaction()));
}
/*******************************************************************************
** Explicit transaction for post-write customizers; audit rolls back with its source.
*******************************************************************************/
public static QRecord insertOne(String table, QRecord record, QBackendTransaction transaction) throws QException
{
if(com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.ACCESS_LOG.equals(table))
{
synchronized(com.kingsrook.qbits.secureddata.SecuredDataRuntime.current().anomalies())
{
return (insertAndAlert(table, record, transaction));
}
}
return (insertAndAlert(table, record, transaction));
}
/*******************************************************************************
** Serialize same-node counter evaluation and insertion. Preserve enumeration flags.
*******************************************************************************/
private static QRecord insertAndAlert(String table, QRecord record, QBackendTransaction transaction) throws QException
{
boolean anomaly = com.kingsrook.qbits.secureddata.metadata.SecuredDataTables.ACCESS_LOG.equals(table)
&& com.kingsrook.qbits.secureddata.SecuredDataRuntime.current().anomalies().evaluate(record);
if(anomaly)
{
record.setValue("anomaly_flag", true);
}
QRecord inserted = call(() -> new InsertAction().execute(new InsertInput(table).withRecord(record).withTransaction(transaction)).getRecords().getFirst());
if(inserted.getErrors() != null && !inserted.getErrors().isEmpty())
{
throw (new QException("Secured-data system insert failed"));
}
if(anomaly)
{
if(transaction == null)
{
com.kingsrook.qbits.secureddata.SecuredDataAnomalies.raise(inserted);
}
else
{
var context = new com.kingsrook.qqq.backend.core.context.CapturedContext(QContext.getQInstance(), QContext.getQSession());
transaction.addAfterCommitCallback(() -> QContext.withTemporaryContext(context,
() -> com.kingsrook.qbits.secureddata.SecuredDataAnomalies.raise(inserted)));
}
}
return (inserted);
}
}
@@ -0,0 +1,56 @@
/*
* 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.support;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
/*******************************************************************************
** Optional UI API registration, with no linkage to unreleased middleware on RC.5.
*******************************************************************************/
public final class UiApiBridge
{
/*******************************************************************************
** Utility class.
*******************************************************************************/
private UiApiBridge()
{
}
/*******************************************************************************
** STAND-IN(core=QRun-IO/qqq#1128, removeBy=RC.6): register directly at RC.6.
*******************************************************************************/
public static void register(QInstance instance)
{
try
{
Class.forName("com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtensionsMetaData");
Class.forName("com.kingsrook.qbits.secureddata.uiapi.SecuredDataExtension").getMethod("register", QInstance.class).invoke(null, instance);
}
catch(ClassNotFoundException expected)
{
// RC.5 or a build without the uiapi source profile.
}
catch(ReflectiveOperationException e)
{
throw (new IllegalStateException("Unable to register secured-data UI API extension", e));
}
}
}
@@ -0,0 +1,195 @@
components:
schemas:
SecuredDataBreakGlassV1:
properties:
id:
type: "integer"
reason:
type: "string"
expiresAt:
format: "date-time"
type: "string"
scope:
nullable: true
type: "string"
ceiling:
type: "string"
type: "object"
SecuredDataErrorV1:
properties:
error:
type: "string"
type: "object"
SecuredDataRevealAllowanceV1:
properties:
tableName:
type: "string"
fieldName:
type: "string"
remainingDailyAllowance:
nullable: true
type: "integer"
type: "object"
SecuredDataRevealOptionsResponseV1:
properties:
reasonOptions:
items:
type: "string"
type: "array"
allowFreeTextReason:
type: "boolean"
requireFreeText:
type: "boolean"
revealMinutes:
type: "integer"
remainingDailyAllowance:
nullable: true
type: "integer"
type: "object"
SecuredDataRevealRequestV1:
description: "tableName, primaryKey and fieldName are required. Supply a policy\
\ reason or allowed free text; maximum 500 characters."
properties:
tableName:
type: "string"
fieldName:
type: "string"
primaryKey:
anyOf:
- type: "string"
- type: "number"
description: "Record primary key (string or number)."
reason:
maxLength: 500
nullable: true
type: "string"
reasonText:
maxLength: 500
nullable: true
type: "string"
type: "object"
SecuredDataRevealResponseV1:
properties:
value:
description: "Authorized raw field value."
nullable: true
displayValue:
nullable: true
type: "string"
expiresAt:
format: "date-time"
type: "string"
revealId:
type: "integer"
type: "object"
SecuredDataStatusResponseV1:
properties:
breakGlass:
$ref: "#/components/schemas/SecuredDataBreakGlassV1"
nullable: true
revealsUsedToday:
type: "integer"
revealAllowances:
items:
$ref: "#/components/schemas/SecuredDataRevealAllowanceV1"
type: "array"
type: "object"
securitySchemes:
sessionUuidCookie:
in: "cookie"
name: "sessionUUID"
type: "apiKey"
info:
contact:
email: "contact@kingsrook.com"
description: "Reveal grants and break-glass status"
title: "QQQ Middleware API extension: secured-data"
version: "1.0.0"
openapi: "3.0.3"
paths:
/qqq/v1/qbit/secured-data/reveal:
post:
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataRevealRequestV1"
required: true
responses:
400:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataErrorV1"
description: "Invalid reveal request"
403:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataErrorV1"
description: "Reveal denied"
404:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataErrorV1"
description: "Record not found or locked"
200:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataRevealResponseV1"
description: "Successful Response"
429:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataErrorV1"
description: "Daily reveal cap reached"
security:
- sessionUuidCookie:
- "N/A"
summary: "Reveal"
tags:
- "Secured data"
/qqq/v1/qbit/secured-data/reveal/options:
get:
parameters:
- in: "query"
name: "tableName"
required: true
schema:
type: "string"
- in: "query"
name: "fieldName"
required: true
schema:
type: "string"
responses:
200:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataRevealOptionsResponseV1"
description: "Successful Response"
security:
- sessionUuidCookie:
- "N/A"
summary: "RevealOptions"
tags:
- "Secured data"
/qqq/v1/qbit/secured-data/status:
get:
responses:
200:
content:
application/json:
schema:
$ref: "#/components/schemas/SecuredDataStatusResponseV1"
description: "Successful Response"
security:
- sessionUuidCookie:
- "N/A"
summary: "Status"
tags:
- "Secured data"
@@ -0,0 +1,147 @@
/*
* 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.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qqq.backend.core.alerts.AlertResolution;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.AlertSinkInterface;
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.instances.AbstractQQQApplication;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
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.session.QSession;
import com.kingsrook.qqq.backend.core.modules.authentication.QAuthenticationModuleCustomizerInterface;
import com.kingsrook.qqq.middleware.javalin.QApplicationJavalinServer;
import com.kingsrook.qqq.middleware.javalin.QJavalinImplementation;
import org.json.JSONObject;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.*;
import static org.assertj.core.api.Assertions.*;
class SecuredDataHttpTest
{
QApplicationJavalinServer server;
int port;
@AfterEach
void cleanup()
{
if(server != null) server.stop();
QJavalinImplementation.setSessionCookieHttpOnly(false);
close();
}
public static class Sessions implements QAuthenticationModuleCustomizerInterface
{
public void customizeSession(QInstance instance, QSession session, Map<String, Object> context)
{
session.setPermissions(java.util.Set.of("person.read", "cs_admin"));
}
}
void start() throws Exception
{
QInstance instance = setup();
instance.getAuthentication().setType(QAuthenticationType.MOCK);
instance.getAuthentication().setCustomizer(new QCodeReference(Sessions.class));
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("daily_reveal_cap", 1));
insert("person", new QRecord().withValue("id", 1).withValue("email", "HTTP-CANARY@example.invalid"));
server = new QApplicationJavalinServer(new AbstractQQQApplication()
{
public QInstance defineQInstance() { return instance; }
}).withPort(0).withServeFrontendNext(false).withServeFrontendMaterialDashboard(false).withServeLegacyUnversionedMiddlewareAPI(false).withStrictUiApiRoutes(true);
server.start();
var serviceField = QApplicationJavalinServer.class.getDeclaredField("service");
serviceField.setAccessible(true);
port = ((io.javalin.Javalin) serviceField.get(server)).port();
}
HttpResponse<String> request(String path, String body, boolean assistant) throws Exception
{
var builder = HttpRequest.newBuilder(URI.create("http://127.0.0.1:" + port + "/qqq/v1" + path)).header("Cookie", "sessionUUID=phase-c-user");
if(assistant) builder.header("X-QQQ-Client", "assistant");
if(body != null) builder.header("Content-Type", "application/json").POST(HttpRequest.BodyPublishers.ofString(body));
return HttpClient.newHttpClient().send(builder.build(), HttpResponse.BodyHandlers.ofString());
}
@Test
void optionsRevealStatusAndCapThroughRealMiddleware() throws Exception
{
start();
var options = request("/qbit/secured-data/reveal/options?tableName=person&fieldName=email", null, false);
assertThat(options.statusCode()).as(options.body()).isEqualTo(200);
assertThat(new JSONObject(options.body()).getInt("remainingDailyAllowance")).isEqualTo(1);
String body = "{\"tableName\":\"person\",\"primaryKey\":1,\"fieldName\":\"email\",\"reason\":\"Investigation\"}";
var reveal = request("/qbit/secured-data/reveal", body, false);
assertThat(reveal.statusCode()).as(reveal.body()).isEqualTo(200);
assertThat(new JSONObject(reveal.body()).getString("value")).isEqualTo("HTTP-CANARY@example.invalid");
var status = request("/qbit/secured-data/status", null, false);
assertThat(status.statusCode()).as(status.body()).isEqualTo(200);
assertThat(new JSONObject(status.body()).getInt("revealsUsedToday")).isEqualTo(1);
assertThat(request("/qbit/secured-data/reveal", body, false).statusCode()).isEqualTo(429);
assertThat(request("/qbit/secured-data/reveal", body, true).statusCode()).isEqualTo(403);
assertThat(request("/qbit/secured-data/reveal", "{}", false).statusCode()).isEqualTo(400);
assertThat(request("/qbit/secured-data/reveal", "{\"primaryKey\":1}", false).statusCode()).isEqualTo(400);
assertThat(request("/qbit/secured-data/reveal/options?tableName=person&fieldName=missing", null, false).statusCode()).isEqualTo(404);
}
@Test
void notificationTargetsOnlySecuredDataAdmins() throws Exception
{
Class<?> signalType;
try { signalType = Class.forName("com.kingsrook.qqq.backend.core.alerts.NotificationSignal"); }
catch(ClassNotFoundException expected) { org.junit.jupiter.api.Assumptions.assumeTrue(false, "Installed core lacks notification SPI #1125"); return; }
var instance = setup();
Bell.signal = null;
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(Bell.class));
var metadata = AlertsInstanceMetaData.ofOrWithNew(instance);
var setter = metadata.getClass().getDeclaredMethod("setLoadedSink", AlertSinkInterface.class);
setter.setAccessible(true);
setter.invoke(metadata, java.lang.reflect.Proxy.newProxyInstance(AlertSinkInterface.class.getClassLoader(), new Class<?>[] {AlertSinkInterface.class},
(proxy, method, args) -> { if(method.getName().equals("notify")) Bell.signal = args[0]; return null; }));
QContext.setQSession(user("u1", BreakGlassService.START + ".hasAccess"));
new BreakGlassService().start("Urgent incident investigation", 60, null, null);
assertThat(Bell.signal).isNotNull();
Object audience = signalType.getMethod("getAudience").invoke(Bell.signal);
assertThat((List<?>) audience.getClass().getMethod("getValues").invoke(audience)).isEqualTo(List.of("secured_data.admin"));
}
public static class Bell implements AlertSinkInterface
{
static Object signal;
public void raise(AlertSignal ignored) { }
public void resolve(AlertResolution ignored) { }
public void heartbeat(String key, Instant at) { }
}
}
@@ -0,0 +1,34 @@
/*
* 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.nio.file.Path;
import com.kingsrook.qbits.secureddata.uiapi.SecuredDataExtension;
import org.junit.jupiter.api.Test;
class SecuredDataUiApiContractTest
{
@Test
void committedContractMatches() throws Exception
{
UiApiContractAssertions.assertExtensionMatchesCommitted(SecuredDataExtension.defineExtension(), Path.of("src/main/resources/openapi/qqq-v1/secured-data.yaml"));
}
}
@@ -0,0 +1,43 @@
/*
* 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.nio.file.Files;
import java.nio.file.Path;
import com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtension;
import com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1;
import com.kingsrook.qqq.middleware.javalin.tools.UiApiContract;
import static org.assertj.core.api.Assertions.assertThat;
/** STAND-IN(core=QRun-IO/qqq#1128, removeBy=RC.6): supplied worktree exposes UiApiContract, not the documented assertion facade. */
final class UiApiContractAssertions
{
static void assertExtensionMatchesCommitted(MiddlewareSpecExtension extension, Path path) throws Exception
{
String generated = UiApiContract.generateExtensionYaml(new MiddlewareVersionV1(), extension);
if(Boolean.getBoolean("qqq.uiApi.regenerate"))
{
Files.createDirectories(path.getParent());
Files.writeString(path, generated);
}
assertThat(UiApiContract.check(generated, Files.readString(path), null, 1, "Regenerate secured-data.yaml with -Dqqq.uiApi.regenerate=true")).isEmpty();
}
}
@@ -0,0 +1,209 @@
/*
* 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 com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
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.query.QueryInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.channelUser;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.close;
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.policy;
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;
/*******************************************************************************
** Core field access bridge it.
*******************************************************************************/
class CoreFieldAccessBridgeIT
{
static final String EMAIL = "CANARY-EMAIL-918273@example.invalid";
static final String SSN = "CANARY-PHI-192837465";
/*******************************************************************************
** Require core.
*******************************************************************************/
@BeforeEach
void requireCore()
{
boolean available;
try
{
Class.forName("com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess.FieldAccessResolverMetaData");
available = true;
}
catch(ClassNotFoundException expected)
{
available = false;
}
Assumptions.assumeTrue(available, "QQQ RC.6 field-access core is not on this classpath");
}
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
close();
}
/*******************************************************************************
** End to end query get exact match and denial matrix.
*******************************************************************************/
@Test
void endToEndQueryGetExactMatchAndDenialMatrix() throws Exception
{
QInstance instance = setup();
for(String classification : List.of("PII", "PHI"))
{
policy("cs_rep", classification, "MASKED");
policy("cs_admin", classification, "REVEALABLE");
policy("admin", classification, "FULL");
}
QRecord person = insert("person", new QRecord().withValue("email", EMAIL).withValue("ssn", SSN).withValue("notes", "ordinary"));
for(String role : List.of("cs_rep", "cs_admin", "admin"))
{
QContext.setQSession(user(role, role));
QRecord query = new QueryAction().execute(new QueryInput("person")).getRecords().getFirst();
QRecord get = new GetAction().execute(new GetInput("person").withPrimaryKey(person.getValue("id"))).getRecord();
for(QRecord row : List.of(query, get))
{
assertThat(row.getValueString("notes")).isEqualTo("ordinary");
if(role.equals("admin"))
{
assertThat(row.getValueString("email")).isEqualTo(EMAIL);
assertThat(row.getValueString("ssn")).isEqualTo(SSN);
}
else
{
assertThat(row.getValueString("email")).isNotNull().isNotEqualTo(EMAIL);
assertThat(row.getValueString("ssn")).isNotNull().isNotEqualTo(SSN);
}
}
}
QContext.setQSession(user("cs_admin", "cs_admin"));
assertThat(search(EMAIL)).hasSize(1).allMatch(row -> !EMAIL.equals(row.getValueString("email")));
assertThat(search("NOT-IN-TABLE")).isEmpty();
assertThatThrownBy(() -> new QueryAction().execute(new QueryInput("person").withFilter(new QQueryFilter().withOrderBy(new QFilterOrderBy("email"))))).hasMessageContaining("Permission denied");
QContext.setQSession(user("cs_rep", "cs_rep"));
assertThatThrownBy(() -> search(EMAIL)).hasMessageContaining("Permission denied");
QContext.setQSession(user("admin", "admin"));
assertThat(search(EMAIL)).hasSize(1).allMatch(row -> EMAIL.equals(row.getValueString("email")));
SecuredDataRuntime.current().logger().flush();
assertThat(logs().stream().filter(row -> "EXACT_MATCH_FILTER".equals(row.getValueString("event_type"))).map(row -> row.getValueString("outcome"))).contains("MATCH", "NO_MATCH");
assertThat(logs().stream().filter(row -> "FILTER_DENIED".equals(row.getValueString("event_type")))).isNotEmpty();
assertThat(com.kingsrook.qqq.backend.core.utils.JsonUtils.toJson(logs())).doesNotContain(EMAIL, SSN, "NOT-IN-TABLE");
QContext.setQSession(channelUser("assistant/t1", "secured_data.admin"));
assertThatThrownBy(() -> new QueryAction().execute(new QueryInput(SecuredDataTables.ACCESS_LOG))).hasMessageContaining("Permission denied");
}
/*******************************************************************************
** Core preflight reports exactly one refused log and honors entropy.
*******************************************************************************/
@Test
void corePreflightReportsExactlyOneRefusedLogAndHonorsEntropy() throws Exception
{
setup();
policy("cs_admin", "PII", "REVEALABLE");
for(int i = 0; i < 20; i++)
{
assertThat(search("known" + i)).isEmpty();
}
assertThatThrownBy(() -> search("known21")).hasMessageContaining("Exact-match search limit reached for [email]");
SecuredDataRuntime.current().logger().flush();
assertThat(logs().stream().filter(row -> "EXACT_MATCH_FILTER".equals(row.getValueString("event_type")))) .hasSize(21);
assertThat(logs().stream().filter(row -> "REFUSED".equals(row.getValueString("outcome")))) .hasSize(1);
classification("email", "PII");
QRecord row = com.kingsrook.qbits.secureddata.support.SystemWrites.query(SecuredDataTables.CLASSIFICATION, new QQueryFilter()).getFirst();
update(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("id", row.getValue("id")).withValue("low_cardinality", true));
assertThatThrownBy(() -> search("known")).hasMessageContaining("Permission denied");
}
@Test
void revealUnmasksOnlyGrantedRecordAndExpiresInCoreGet() throws Exception
{
setup();
policy("cs_admin", "PII", "REVEALABLE");
QRecord row = insert("person", new QRecord().withValue("email", EMAIL));
QRecord other = insert("person", new QRecord().withValue("email", "OTHER-CANARY"));
GetInput get = new GetInput("person").withPrimaryKey(row.getValue("id"));
assertThat(new GetAction().execute(get).getRecord().getValueString("email")).isNotEqualTo(EMAIL);
var reveal = new com.kingsrook.qbits.secureddata.reveal.RevealService().reveal("person", row.getValue("id"), "email", "Investigating", null);
assertThat(reveal.value()).isEqualTo(EMAIL);
assertThat(new GetAction().execute(get).getRecord().getValueString("email")).isEqualTo(EMAIL);
assertThat(new GetAction().execute(new GetInput("person").withPrimaryKey(other.getValue("id"))).getRecord().getValueString("email")).isNotEqualTo("OTHER-CANARY");
SecuredDataTestSupport.CLOCK.now = SecuredDataTestSupport.NOW.plusSeconds(300);
assertThat(new GetAction().execute(get).getRecord().getValueString("email")).isNotEqualTo(EMAIL);
}
@Test
void revealPreservesCoreRecordLockDenial() throws Exception
{
QInstance instance = setup();
policy("cs_admin", "PII", "REVEALABLE");
QRecord row = insert("person", new QRecord().withValue("email", EMAIL).withValue("notes", "tenant-a"));
instance.addSecurityKeyType(new com.kingsrook.qqq.backend.core.model.metadata.security.QSecurityKeyType().withName("tenant"));
instance.getTable("person").withRecordSecurityLock(new com.kingsrook.qqq.backend.core.model.metadata.security.RecordSecurityLock().withSecurityKeyType("tenant").withFieldName("notes"));
QContext.getQSession().withSecurityKeyValue("tenant", "tenant-b");
assertThat(new GetAction().execute(new GetInput("person").withPrimaryKey(row.getValue("id"))).getRecord()).isNull();
assertThatThrownBy(() -> new com.kingsrook.qbits.secureddata.reveal.RevealService().reveal("person", row.getValue("id"), "email", "Investigating", null))
.isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QNotFoundException.class);
assertThat(com.kingsrook.qbits.secureddata.support.SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter())).isEmpty();
}
/*******************************************************************************
** Search.
*******************************************************************************/
private List<QRecord> search(String email) throws Exception
{
return (new QueryAction().execute(new QueryInput("person").withFilter(new QQueryFilter()
.withCriteria(new QFilterCriteria("email", QCriteriaOperator.EQUALS, email)))).getRecords());
}
}
@@ -0,0 +1,109 @@
/*
* 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.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import com.kingsrook.qqq.backend.core.actions.processes.RunProcessAction;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLine;
import com.kingsrook.qqq.backend.core.model.actions.processes.ProcessSummaryLineInterface;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunProcessOutput;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess;
/*******************************************************************************
** Runs a streamed-ETL table or record action the way the UI does: the
** review screen, then the result.
*******************************************************************************/
public final class ProcessRunner
{
/*******************************************************************************
** Review and result lines, as shown.
*******************************************************************************/
public record Lines(List<String> review, List<String> result)
{
}
/*******************************************************************************
** Utility class.
*******************************************************************************/
private ProcessRunner()
{
}
/*******************************************************************************
** Run on some record ids.
*******************************************************************************/
@SuppressWarnings("unchecked")
public static Lines run(String process, Serializable... ids) throws Exception
{
RunProcessInput input = new RunProcessInput();
input.setProcessName(process);
input.addValue("recordsParam", "recordIds");
input.addValue("recordIds", Arrays.stream(ids).map(String::valueOf).collect(Collectors.joining(",")));
input.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.BREAK);
RunProcessOutput review = new RunProcessAction().execute(input);
if(review.getException().isPresent())
{
throw (review.getException().get());
}
List<ProcessSummaryLineInterface> reviewLines = (List<ProcessSummaryLineInterface>) review.getValues().get(StreamedETLWithFrontendProcess.FIELD_VALIDATION_SUMMARY);
RunProcessInput go = new RunProcessInput();
go.setProcessName(process);
go.setProcessUUID(review.getProcessUUID());
go.setStartAfterStep(StreamedETLWithFrontendProcess.STEP_NAME_REVIEW);
go.setFrontendStepBehavior(RunProcessInput.FrontendStepBehavior.SKIP);
RunProcessOutput result = new RunProcessAction().execute(go);
if(result.getException().isPresent())
{
throw (result.getException().get());
}
List<ProcessSummaryLineInterface> resultLines = (List<ProcessSummaryLineInterface>) result.getValues().get(StreamedETLWithFrontendProcess.FIELD_PROCESS_SUMMARY);
return (new Lines(text(reviewLines, false), text(resultLines, true)));
}
/*******************************************************************************
** Lines as text.
*******************************************************************************/
private static List<String> text(List<ProcessSummaryLineInterface> lines, boolean past)
{
return (lines == null ? List.of() : lines.stream().map(line ->
{
if(line instanceof ProcessSummaryLine summary)
{
summary.pickMessage(past);
return ((summary.getCount() == null ? "" : summary.getCount() + " ") + summary.getMessage());
}
return (String.valueOf(line));
}).toList());
}
}
@@ -0,0 +1,319 @@
/*
* 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.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.FieldsOfTablePossibleValueSource;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.processes.BreakGlassProcesses;
import com.kingsrook.qbits.secureddata.reveal.RevealCappedException;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.tables.GetAction;
import com.kingsrook.qqq.backend.core.alerts.AlertResolution;
import com.kingsrook.qqq.backend.core.alerts.AlertSeverity;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.AlertSinkInterface;
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QBadRequestException;
import com.kingsrook.qqq.backend.core.exceptions.QNotFoundException;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInput;
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.model.actions.tables.get.GetInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QQueryFilter;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.session.QSession;
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.*;
import static org.assertj.core.api.Assertions.*;
class RevealAndBreakGlassTest
{
RevealService reveals = new RevealService();
BreakGlassService breaks = new BreakGlassService();
Serializable pk;
QRecord policy;
@BeforeEach
void init() throws Exception
{
var instance = setup();
policy = insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE")
.withValue("reason_options", "Support\nInvestigation").withValue("daily_reveal_cap", 2).withValue("allow_free_text_reason", false));
pk = insert("person", new QRecord().withValue("email", "secret@example.invalid").withValue("ssn", "123456789")).getValue("id");
Sink.signals.clear(); Sink.resolutions.clear();
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(Sink.class));
}
@AfterEach
void cleanup() { close(); }
@Test
void revealValueAuditLinkCacheAndExactExpiry() throws Exception
{
var resolver = SecuredDataRuntime.current().resolver();
assertThat(resolver.isRevealActive("person", "email", pk)).isFalse();
var result = reveals.reveal("person", pk, "email", "Support", null);
assertThat(result.value()).isEqualTo("secret@example.invalid");
assertThat(result.displayValue()).isEqualTo("secret@example.invalid");
assertThat(result.expiresAt()).isEqualTo(NOW.plusSeconds(300));
assertThat(resolver.isRevealActive("person", "email", pk)).isTrue();
assertThat(resolver.isRevealActive("person", "ssn", pk)).isFalse();
assertThat(resolver.isRevealActive("person", "email", 999)).isFalse();
QRecord grant = SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter()).getFirst();
QRecord log = logs().stream().filter(r -> "REVEAL".equals(r.getValueString("event_type"))).findFirst().orElseThrow();
assertThat(grant.getValue("access_log_id")).isEqualTo(log.getValue("id"));
assertThat(log.getValueString("reason")).isEqualTo("Support");
QContext.setQSession(user("u2", "cs_admin"));
assertThat(resolver.isRevealActive("person", "email", pk)).isFalse();
QContext.setQSession(user("u1", "cs_admin"));
assertThat(resolver.isRevealActive("person", "email", pk)).isTrue();
CLOCK.now = NOW.plusSeconds(300);
assertThat(resolver.isRevealActive("person", "email", pk)).isFalse();
}
@Test
void optionsSelectOneMostPermissiveGrantingPolicy() throws Exception
{
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("daily_reveal_cap", 10)
.withValue("reveal_minutes", 15).withValue("reason_options", "Other policy").withValue("require_free_text", true));
var options = reveals.options("person", "email");
assertThat(options.remainingDailyAllowance()).isEqualTo(10);
assertThat(options.revealMinutes()).isEqualTo(15);
assertThat(options.reasonOptions()).containsExactly("Other policy");
assertThat(options.requireFreeText()).isTrue();
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("client_channel", "web").withValue("reveal_minutes", 60));
QContext.setQSession(channelUser("web", "cs_admin"));
assertThat(reveals.options("person", "email").revealMinutes()).isEqualTo(15);
}
@Test
void wrongTierAndReadPermissionAreRefused() throws Exception
{
assertThatThrownBy(() -> reveals.reveal("person", pk, "ssn", "Support", null)).isInstanceOf(QPermissionDeniedException.class);
QContext.setQSession(new QSession().withUser(user("u1").getUser()).withPermissions(List.of("cs_admin")));
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Support", null)).isInstanceOf(QPermissionDeniedException.class);
assertThat(SystemWrites.query(SecuredDataTables.REVEAL_GRANT, new QQueryFilter())).isEmpty();
}
@Test
void missingRecordAndFieldAreNotFound() throws Exception
{
assertThatThrownBy(() -> reveals.reveal("person", 999, "email", "Support", null)).isInstanceOf(QNotFoundException.class);
assertThatThrownBy(() -> reveals.options("person", "bogus")).isInstanceOf(QNotFoundException.class);
assertThatThrownBy(() -> reveals.reveal("person", null, "email", "Support", null)).isInstanceOf(QBadRequestException.class);
}
@Test
void invalidReasonsAndLengthAreRejected() throws Exception
{
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Bogus", null)).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Support", "x".repeat(501))).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "x".repeat(501), null)).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", null, null)).isInstanceOf(QBadRequestException.class);
}
@Test
void freeTextRequiredAndFiveHundredCharactersAccepted() throws Exception
{
update(SecuredDataTables.POLICY, new QRecord().withValue("id", policy.getValue("id")).withValue("allow_free_text_reason", true).withValue("require_free_text", true));
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Support", null)).isInstanceOf(QBadRequestException.class);
assertThat(reveals.reveal("person", pk, "email", null, "x".repeat(500)).value()).isEqualTo("secret@example.invalid");
}
@Test
void dailyCapAcrossTablesAlertsAndResetsAtUtcMidnight() throws Exception
{
reveals.reveal("person", pk, "email", "Support", null);
QContext.getQInstance().addTable(person("memory").withName("customer"));
QContext.setQSession(user("u1", "cs_admin", "customer.read"));
Serializable other = insert("customer", new QRecord().withValue("email", "second@example.invalid")).getValue("id");
reveals.reveal("customer", other, "email", "Support", null);
assertThat(reveals.options("person", "email").remainingDailyAllowance()).isZero();
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Support", null)).isInstanceOf(RevealCappedException.class);
assertThat(logs()).anyMatch(r -> "CAPPED".equals(r.getValueString("outcome")) && "REVEAL_DENIED".equals(r.getValueString("event_type")));
assertThat(Sink.signals).anyMatch(s -> "secured_data.reveal_capped".equals(s.getAlertTypeName()));
CLOCK.now = NOW.plusSeconds(86400);
assertThat(reveals.options("person", "email").remainingDailyAllowance()).isEqualTo(2);
}
@Test
void assistantRefusedAndLogged() throws Exception
{
QContext.setQSession(channelUser("assistant/thread", "cs_admin"));
assertThatThrownBy(() -> reveals.reveal("person", pk, "email", "Support", null)).isInstanceOf(QPermissionDeniedException.class);
assertThat(logs()).anyMatch(r -> "REVEAL_DENIED".equals(r.getValueString("event_type")) && "assistant".equals(r.getValueString("client_channel")));
}
void enableStart() { QContext.setQSession(user("u1", "cs_admin", BreakGlassService.START + ".hasAccess")); }
@Test
void breakGlassStartsImmediatelyAlertsAndReportsStatus() throws Exception
{
enableStart();
String fingerprint = SecuredDataRuntime.current().resolver().getAccessFingerprint();
QRecord row = breaks.start("Investigating urgent incident", null, null, null);
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.FULL);
assertThat(SecuredDataRuntime.current().resolver().getAccessFingerprint()).isNotEqualTo(fingerprint);
assertThat(Sink.signals).filteredOn(s -> "secured_data.break_glass".equals(s.getAlertTypeName())).singleElement().satisfies(s -> { assertThat(s.getSeverity()).isEqualTo(AlertSeverity.ERROR); assertThat(s.getAlertTypeName()).isEqualTo("secured_data.break_glass"); });
var status = new StatusService().status();
assertThat(status.breakGlass().id()).isEqualTo(row.getValue("id"));
assertThat(status.breakGlass().expiresAt()).isEqualTo(NOW.plusSeconds(3600));
assertThat(status.breakGlass().ceiling()).isEqualTo("PHI");
assertThatThrownBy(() -> breaks.start("Another urgent investigation", 60, null, null)).isInstanceOf(QBadRequestException.class);
}
FieldAccessTier tier(String field) { var table = QContext.getQInstance().getTable("person"); return SecuredDataRuntime.current().resolver().resolve(table, table.getField(field)).tier(); }
@Test
void ceilingScopeAndReadTimeExpiry() throws Exception
{
enableStart();
breaks.start("Investigating urgent incident", 1, "person", DataClassification.PII);
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.MASKED);
CLOCK.now = NOW.plusSeconds(60);
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
assertThat(new StatusService().status().breakGlass()).isNull();
breaks.start("Investigating another incident", 1, SecuredDataTables.POLICY, null);
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
}
@Test
void ownerAndAdminEndButOthersCannot() throws Exception
{
enableStart(); QRecord row = breaks.start("Investigating urgent incident", 60, null, null);
Serializable firstId = row.getValue("id");
QContext.setQSession(user("u2"));
assertThatThrownBy(() -> breaks.end(firstId)).isInstanceOf(QPermissionDeniedException.class);
QContext.setQSession(user("u2", "secured_data.admin"));
breaks.end(row.getValue("id"));
assertThat(breaks.find(row.getValue("id")).getValueString("ended_by")).isEqualTo("u2");
assertThat(Sink.resolutions).hasSize(1);
enableStart(); row = breaks.start("Investigating urgent incident", 60, null, null);
breaks.end(row.getValue("id"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
assertThat(logs()).anyMatch(r -> "BREAK_GLASS_END".equals(r.getValueString("event_type")));
}
@Test
void expiryJobIsIdempotentAndResolvesAlert() throws Exception
{
enableStart(); QRecord row = breaks.start("Investigating urgent incident", 1, null, null);
CLOCK.now = NOW.plusSeconds(60);
var output = new RunBackendStepOutput();
new BreakGlassProcesses.Expire().run(new RunBackendStepInput(), output);
assertThat(breaks.find(row.getValue("id")).getValueString("status")).isEqualTo("EXPIRED");
assertThat(breaks.expire()).isZero();
assertThat(Sink.resolutions).hasSize(1);
assertThat(logs()).anyMatch(r -> "BREAK_GLASS_EXPIRED".equals(r.getValueString("event_type")));
}
@Test
void breakGlassValidationAndPermission() throws Exception
{
assertThatThrownBy(() -> breaks.start("Investigating urgent incident", 60, null, null)).isInstanceOf(QPermissionDeniedException.class);
enableStart();
assertThatThrownBy(() -> breaks.start("short", 60, null, null)).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> breaks.start("Investigating urgent incident", 481, null, null)).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> breaks.start("Investigating urgent incident", 0, null, null)).isInstanceOf(QBadRequestException.class);
assertThatThrownBy(() -> breaks.start("Investigating urgent incident", 60, "missing", null)).isInstanceOf(QBadRequestException.class);
QContext.setQSession(channelUser("assistant", BreakGlassService.START + ".hasAccess"));
assertThatThrownBy(() -> breaks.start("Investigating urgent incident", 60, null, null)).isInstanceOf(QPermissionDeniedException.class);
}
@Test
void statusAllowanceAndPicker() throws Exception
{
var status = new StatusService().status();
assertThat(status.breakGlass()).isNull();
assertThat(status.revealAllowances()).singleElement().satisfies(a -> { assertThat(a.tableName()).isEqualTo("person"); assertThat(a.fieldName()).isEqualTo("email"); assertThat(a.remainingDailyAllowance()).isEqualTo(2); });
var provider = new FieldsOfTablePossibleValueSource();
assertThat(provider.search(new SearchPossibleValueSourceInput())).isEmpty();
assertThat(provider.search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("table_name", "")))).isEmpty();
var fields = provider.search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("table_name", "person")));
assertThat(fields).extracting(v -> v.getId()).containsExactlyInAnyOrder("id", "email", "ssn", "notes");
assertThat(fields).allMatch(v -> v.getLabel() != null);
assertThat(provider.search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("tableName", "person")))).hasSize(4);
assertThatThrownBy(() -> provider.search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("tableName", "unknown")))).hasMessageContaining("Unknown table");
}
@Test
void endReviewAndResultRecheckOwnership() throws Exception
{
enableStart(); QRecord row = breaks.start("Investigating urgent incident", 60, null, null);
var input = new RunBackendStepInput(); input.setRecords(List.of(row));
var output = new RunBackendStepOutput();
var review = new BreakGlassProcesses.EndReview(); review.runOnePage(input, output);
assertThat(review.getProcessSummary(output, false)).hasSize(1);
var load = new BreakGlassProcesses.EndLoad(); load.runOnePage(input, new RunBackendStepOutput());
assertThat(load.getProcessSummary(output, true)).hasSize(1);
assertThat(breaks.find(row.getValue("id")).getValueString("status")).isEqualTo("ENDED");
}
@Test
void startAndEndThroughProcessEngine() throws Exception
{
enableStart();
var input = new RunBackendStepInput();
input.addValue("reason", "Investigating urgent incident");
input.addValue("duration_minutes", 60);
new BreakGlassProcesses.Start().run(input, new RunBackendStepOutput());
QRecord row = SecuredDataRuntime.current().resolver().activeBreakGlass().getFirst();
var lines = ProcessRunner.run(BreakGlassService.END, row.getValue("id"));
assertThat(lines.review()).anyMatch(line -> line.contains("will be ended"));
assertThat(lines.result()).anyMatch(line -> line.contains("was ended"));
assertThat(breaks.find(row.getValue("id")).getValueString("status")).isEqualTo("ENDED");
}
@Test
void expiryScheduleUsesHostSchedulerAndSixtySeconds()
{
var config = new SecuredDataQBitConfig().withSchedulerName("host");
var process = BreakGlassProcesses.processes(config).getLast();
assertThat(process.getSchedule().getRepeatSeconds()).isEqualTo(60);
assertThat(process.getSchedule().getSchedulerName()).isEqualTo("host");
assertThat(process.getIsHidden()).isTrue();
}
public static class Sink implements AlertSinkInterface
{
static final List<AlertSignal> signals = new ArrayList<>();
static final List<AlertResolution> resolutions = new ArrayList<>();
public void raise(AlertSignal signal) { signals.add(signal); }
public void resolve(AlertResolution resolution) { resolutions.add(resolution); }
public void heartbeat(String key, Instant at) { }
}
}
@@ -0,0 +1,363 @@
/*
* 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.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.IntStream;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEvent;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEventType;
import com.kingsrook.qbits.secureddata.standin.FieldAccessOutcome;
import com.kingsrook.qqq.backend.core.alerts.AlertResolution;
import com.kingsrook.qqq.backend.core.alerts.AlertSignal;
import com.kingsrook.qqq.backend.core.alerts.AlertSinkInterface;
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
import com.kingsrook.qqq.backend.core.context.CapturedContext;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException;
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.utils.JsonUtils;
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.channelUser;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.close;
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.policy;
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;
/*******************************************************************************
** Secured data access logger test.
*******************************************************************************/
class SecuredDataAccessLoggerTest
{
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
close();
}
static FieldAccessEvent event(FieldAccessEventType type, FieldAccessOutcome outcome, String fingerprint)
{
return (new FieldAccessEvent().withType(type).withOutcome(outcome).withTableName("person").withFieldNames(List.of("email"))
.withActionName("query").withRecordCount(outcome == FieldAccessOutcome.MATCH ? 1 : 0)
.withSearchValueFingerprints(fingerprint == null ? null : List.of(fingerprint)));
}
/*******************************************************************************
** Twenty first search refused including unflushed rows and persisted history.
*******************************************************************************/
@Test
void twentyFirstSearchRefusedIncludingUnflushedRowsAndPersistedHistory() throws Exception
{
setup();
policy("cs_admin", "PII", "REVEALABLE");
var resolver = SecuredDataRuntime.current().resolver();
var logger = SecuredDataRuntime.current().logger();
for(int i = 0; i < 20; i++)
{
var event = event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, resolver.fingerprintSearchValue("known"));
resolver.checkExactMatch(event);
resolver.onAccess(event);
if(i == 9)
{
logger.flush();
}
}
var refused = event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.REFUSED, resolver.fingerprintSearchValue("sentinel"));
assertThatThrownBy(() -> resolver.checkExactMatch(refused)).isInstanceOf(QPermissionDeniedException.class)
.hasMessage("Exact-match search limit reached for [email]. Try again later or ask an administrator.");
resolver.onAccess(refused);
logger.flush();
assertThat(logs()).filteredOn(row -> "EXACT_MATCH_FILTER".equals(row.getValueString("event_type"))).hasSize(21);
assertThat(logs().stream().filter(row -> "REFUSED".equals(row.getValueString("outcome")))).hasSize(1);
assertThat(JsonUtils.toJson(logs())).doesNotContain("sentinel").doesNotContain("known");
CLOCK.now = NOW.plusSeconds(3601);
resolver.checkExactMatch(event(FieldAccessEventType.EXACT_MATCH_FILTER, null, null));
}
/*******************************************************************************
** Misses and distinct values flag and raise through real alerts spi.
*******************************************************************************/
@Test
void missesAndDistinctValuesFlagAndRaiseThroughRealAlertsSpi() throws Exception
{
QInstance instance = setup();
AlertsSink.signals.clear();
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(AlertsSink.class));
var resolver = SecuredDataRuntime.current().resolver();
for(int i = 0; i < 5; i++)
{
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, resolver.fingerprintSearchValue("same")));
}
SecuredDataRuntime.current().logger().flush();
assertThat(logs().stream().filter(row -> Boolean.TRUE.equals(row.getValueBoolean("anomaly_flag")))) .hasSize(1);
assertThat(AlertsSink.signals).hasSize(1);
assertThat(AlertsSink.signals.getFirst().getDedupKey()).isEqualTo("secured_data.enumeration:u1:person.email:2026-10-13");
assertThat(AlertsSink.signals.getFirst().getAlertTypeName()).isEqualTo("secured_data.enumeration");
QContext.setQSession(user("different", "cs_admin"));
for(int i = 0; i < 16; i++)
{
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, resolver.fingerprintSearchValue("value-" + i)));
}
SecuredDataRuntime.current().logger().flush();
assertThat(logs().stream().filter(row -> Boolean.TRUE.equals(row.getValueBoolean("anomaly_flag")))).hasSize(2);
assertThat(AlertsSink.signals).hasSize(2);
}
/*******************************************************************************
** Match resets miss streak and policy can disable all controls.
*******************************************************************************/
@Test
void matchResetsMissStreakAndPolicyCanDisableAllControls() throws Exception
{
setup();
var resolver = SecuredDataRuntime.current().resolver();
for(int i = 0; i < 4; i++)
{
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, "hash"));
}
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, "hash"));
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, "hash"));
SecuredDataRuntime.current().logger().flush();
assertThat(logs()).allMatch(row -> !row.getValueBoolean("anomaly_flag"));
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("exact_match_per_hour", 0)
.withValue("miss_alert_consecutive", 0).withValue("distinct_value_alert", 0).withValue("min_entropy_enabled", false));
for(int i = 0; i < 25; i++)
{
var event = event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, resolver.fingerprintSearchValue(i));
resolver.checkExactMatch(event);
resolver.onAccess(event);
}
SecuredDataRuntime.current().logger().flush();
assertThat(logs()).allMatch(row -> !row.getValueBoolean("anomaly_flag"));
}
/*******************************************************************************
** Views only log configured classifications with fifty ids and channel.
*******************************************************************************/
@Test
void viewsOnlyLogConfiguredClassificationsWithFiftyIdsAndChannel() throws Exception
{
setup();
QContext.setQSession(channelUser("assistant/t1", "cs_admin"));
var logger = SecuredDataRuntime.current().logger();
logger.onAccess(event(FieldAccessEventType.VIEW, null, null).withFieldNames(List.of("notes")));
List<Serializable> ids = IntStream.rangeClosed(1, 80).mapToObj(i -> (Serializable) i).toList();
logger.onAccess(event(FieldAccessEventType.VIEW, null, null).withFieldNames(List.of("notes", "email", "ssn")).withPrimaryKeys(ids).withRecordCount(80));
logger.onAccess(event(FieldAccessEventType.DENIED, null, null));
logger.flush();
assertThat(logs()).hasSize(2);
QRecord view = logs().stream().filter(row -> "VIEW".equals(row.getValueString("event_type"))).findFirst().orElseThrow();
assertThat(view.getValueString("field_name")).isEqualTo("email,ssn");
assertThat(view.getValueString("client_channel")).isEqualTo("assistant");
assertThat(JsonUtils.toObject(view.getValueString("record_id"), Integer[].class)).hasSize(50);
assertThat(logs().stream().anyMatch(row -> "FILTER_DENIED".equals(row.getValueString("event_type")))) .isTrue();
SecuredDataRuntime.current().config().withViewLogClassifications(Set.of(DataClassification.CONFIDENTIAL));
classification("notes", "CONFIDENTIAL");
logger.onAccess(event(FieldAccessEventType.VIEW, null, null).withFieldNames(List.of("notes", "email")));
logger.flush();
assertThat(logs()).filteredOn(row -> !"CLASSIFICATION_CHANGE".equals(row.getValueString("event_type"))).hasSize(3);
}
/*******************************************************************************
** Queue overflow and shutdown are observable without failing access.
*******************************************************************************/
@Test
void queueOverflowAndShutdownAreObservableWithoutFailingAccess() throws Exception
{
setup(config -> config.withAccessLogQueueCapacity(1));
var logger = SecuredDataRuntime.current().logger();
logger.onAccess(event(FieldAccessEventType.VIEW, null, null));
logger.onAccess(event(FieldAccessEventType.VIEW, null, null));
assertThat(logger.getDroppedCount()).isEqualTo(1);
logger.close();
assertThat(logs()).hasSize(1);
logger.onAccess(event(FieldAccessEventType.VIEW, null, null));
assertThat(logger.getDroppedCount()).isEqualTo(2);
}
/*******************************************************************************
** Asynchronous worker drains in system context.
*******************************************************************************/
@Test
void asynchronousWorkerDrainsInSystemContext() throws Exception
{
setup(config -> config.withAccessLogFlushIntervalMillis(10));
SecuredDataRuntime.current().logger().onAccess(event(FieldAccessEventType.VIEW, null, null));
long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5);
while(logs().isEmpty() && System.nanoTime() < deadline)
{
Thread.sleep(10);
}
assertThat(logs()).hasSize(1);
assertThat(QContext.getQSession().getUser().getIdReference()).isEqualTo("u1");
}
/*******************************************************************************
** Concurrent preflight cannot spend the same last slot.
*******************************************************************************/
@Test
void concurrentPreflightCannotSpendTheSameLastSlot() throws Exception
{
QInstance instance = setup();
var resolver = SecuredDataRuntime.current().resolver();
for(int i = 0; i < 19; i++)
{
resolver.checkExactMatch(event(FieldAccessEventType.EXACT_MATCH_FILTER, null, null));
}
AtomicInteger accepted = new AtomicInteger();
CountDownLatch start = new CountDownLatch(1);
try(var pool = Executors.newFixedThreadPool(8))
{
List<java.util.concurrent.Future<?>> futures = new ArrayList<>();
for(int i = 0; i < 8; i++)
{
futures.add(pool.submit(() ->
{
QContext.withTemporaryContext(new CapturedContext(instance, user("u1", "cs_admin")), () ->
{
start.await();
try
{
resolver.checkExactMatch(event(FieldAccessEventType.EXACT_MATCH_FILTER, null, null));
accepted.incrementAndGet();
}
catch(QPermissionDeniedException expected)
{
}
});
return (null);
}));
}
start.countDown();
for(var future : futures)
{
future.get(5, TimeUnit.SECONDS);
}
}
assertThat(accepted).hasValue(1);
}
/*******************************************************************************
** Consecutive misses span an hour but distinct values do not.
*******************************************************************************/
@Test
void consecutiveMissesSpanAnHourButDistinctValuesDoNot() throws Exception
{
QInstance instance = setup();
AlertsSink.signals.clear();
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(AlertsSink.class));
var resolver = SecuredDataRuntime.current().resolver();
for(int i = 0; i < 4; i++)
{
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, resolver.fingerprintSearchValue("same")));
}
SecuredDataRuntime.current().logger().flush();
CLOCK.now = NOW.plusSeconds(3601);
resolver.onAccess(event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.NO_MATCH, resolver.fingerprintSearchValue("same")));
SecuredDataRuntime.current().logger().flush();
assertThat(AlertsSink.signals).hasSize(1);
assertThat(logs().stream().filter(row -> Boolean.TRUE.equals(row.getValueBoolean("anomaly_flag")))) .hasSize(1);
}
/*******************************************************************************
** Break glass identity is captured before worker switches to system.
*******************************************************************************/
@Test
void breakGlassIdentityIsCapturedBeforeWorkerSwitchesToSystem() throws Exception
{
setup();
QRecord grant = insert(SecuredDataTables.BREAK_GLASS, new QRecord().withValue("user_id", "u1").withValue("status", "ACTIVE")
.withValue("classification_ceiling", "PHI").withValue("started_at", NOW).withValue("expires_at", NOW.plusSeconds(60)));
SecuredDataRuntime.current().logger().onAccess(event(FieldAccessEventType.VIEW, null, null));
SecuredDataRuntime.current().logger().flush();
assertThat(logs().getFirst().getValue("break_glass_id")).isEqualTo(grant.getValue("id"));
}
/*******************************************************************************
** Alerts sink.
*******************************************************************************/
public static class AlertsSink implements AlertSinkInterface
{
static final List<AlertSignal> signals = new ArrayList<>();
/*******************************************************************************
** Raise.
*******************************************************************************/
public void raise(AlertSignal signal)
{
signals.add(signal);
}
/*******************************************************************************
** Resolve.
*******************************************************************************/
public void resolve(AlertResolution resolution)
{
}
/*******************************************************************************
** Heartbeat.
*******************************************************************************/
public void heartbeat(String key, Instant at)
{
}
}
}
@@ -0,0 +1,186 @@
/*
* 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.time.temporal.ChronoUnit;
import java.util.List;
import com.kingsrook.qbits.secureddata.breakglass.BreakGlassService;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.reveal.RevealService;
import com.kingsrook.qbits.secureddata.standin.FieldAccessEventType;
import com.kingsrook.qbits.secureddata.standin.FieldAccessOutcome;
import com.kingsrook.qbits.secureddata.support.ActivityLog;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.*;
import static org.assertj.core.api.Assertions.*;
class SecuredDataAnomaliesTest
{
@AfterEach void cleanup() { close(); }
void init(java.util.function.Consumer<SecuredDataQBitConfig> config) throws Exception
{
var instance = setup(config);
SecuredDataAccessLoggerTest.AlertsSink.signals.clear();
AlertsInstanceMetaData.ofOrWithNew(instance).withSink(new QCodeReference(SecuredDataAccessLoggerTest.AlertsSink.class));
}
QRecord reveal(int record) throws Exception
{
return insert(SecuredDataTables.ACCESS_LOG, ActivityLog.row("REVEAL", "person", "ALLOWED")
.withValue("record_id", String.valueOf(record)).withValue("field_name", "email"));
}
static void seed(QRecord row) throws Exception
{
SystemWrites.call(() -> new InsertAction().execute(new InsertInput(SecuredDataTables.ACCESS_LOG).withRecord(row)));
}
void alertCount(int count)
{
assertThat(SecuredDataAccessLoggerTest.AlertsSink.signals).filteredOn(s -> "secured_data.anomaly".equals(s.getAlertTypeName())).hasSize(count)
.allSatisfy(s -> assertThat(s.getDedupKey()).isEqualTo("secured_data.anomaly:u1:2026-10-13"));
}
@Test void minimumTenAndZeroDaysMedian() throws Exception
{
init(c -> {});
for(int i = 0; i < 9; i++) assertThat(reveal(1).getValueBoolean("anomaly_flag")).isFalse();
alertCount(0);
assertThat(reveal(1).getValueBoolean("anomaly_flag")).isTrue();
alertCount(1);
}
@Test void strictlyAboveThreeTimesMedianAndDailyCacheRollover() throws Exception
{
init(c -> {});
for(int day = 1; day <= 30; day++)
for(int i = 0; i < 4; i++) seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("record_id", "1")
.withValue("created_at", NOW.truncatedTo(ChronoUnit.DAYS).minus(day, ChronoUnit.DAYS).plusSeconds(i)));
for(int i = 0; i < 12; i++) assertThat(reveal(1).getValueBoolean("anomaly_flag")).isFalse();
alertCount(0);
assertThat(reveal(1).getValueBoolean("anomaly_flag")).isTrue();
alertCount(1);
CLOCK.now = NOW.plus(1, ChronoUnit.DAYS);
assertThat(reveal(1).getValueBoolean("anomaly_flag")).isFalse();
}
@Test void distinctRecordBoundaryDuplicatesOtherUsersAndExpiredRows() throws Exception
{
init(c -> c.withAnomalyMinimumDailyReveals(1000));
for(int i = 0; i < 20; i++) assertThat(reveal(i).getValueBoolean("anomaly_flag")).isFalse();
assertThat(reveal(0).getValueBoolean("anomaly_flag")).isFalse();
seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("user_id", "other").withValue("record_id", "999"));
seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("record_id", "998").withValue("created_at", NOW.minusSeconds(3600)));
alertCount(0);
assertThat(reveal(20).getValueBoolean("anomaly_flag")).isTrue();
alertCount(1);
CLOCK.now = NOW.plusSeconds(3601);
assertThat(reveal(21).getValueBoolean("anomaly_flag")).isFalse();
}
@Test void exactMatchFiftyFirstQueuedSearchFlagsWithoutEnumerationAlert() throws Exception
{
init(c -> c.withExactMatchPerHour(0).withMissAlertConsecutive(0).withDistinctValueAlert(0));
var logger = SecuredDataRuntime.current().logger();
for(int i = 0; i < 50; i++) logger.onAccess(SecuredDataAccessLoggerTest.event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, "hash"));
logger.flush();
assertThat(logs()).allSatisfy(row -> assertThat(row.getValueBoolean("anomaly_flag")).isFalse());
alertCount(0);
logger.onAccess(SecuredDataAccessLoggerTest.event(FieldAccessEventType.EXACT_MATCH_FILTER, FieldAccessOutcome.MATCH, "hash"));
logger.flush();
assertThat(logs().getLast().getValueBoolean("anomaly_flag")).isTrue();
alertCount(1);
}
@Test void configurableThresholdsAndMissingAlertSink() throws Exception
{
setup(c -> c.withAnomalyDailyMedianMultiplier(2).withAnomalyMinimumDailyReveals(3).withAnomalyDistinctRecordsPerHour(2).withAnomalyExactMatchesPerHour(2));
assertThat(reveal(1).getValueBoolean("anomaly_flag")).isFalse();
assertThat(reveal(2).getValueBoolean("anomaly_flag")).isFalse();
assertThat(reveal(3).getValueBoolean("anomaly_flag")).isTrue();
QContext.setQSession(user("u2"));
for(int i = 0; i < 3; i++)
{
var row = insert(SecuredDataTables.ACCESS_LOG, ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH").withValue("field_name", "email"));
assertThat(row.getValueBoolean("anomaly_flag")).isEqualTo(i == 2);
}
}
@Test void actualRevealServiceBreakGlassAndCapFlagAndAlert() throws Exception
{
init(c -> c.withAnomalyMinimumDailyReveals(1));
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("daily_reveal_cap", 1));
var pk = insert("person", new QRecord().withValue("email", "private@example.invalid")).getValue("id");
new RevealService().reveal("person", pk, "email", "Support", null);
assertThat(logs()).filteredOn(r -> "REVEAL".equals(r.getValueString("event_type"))).singleElement()
.satisfies(r -> assertThat(r.getValueBoolean("anomaly_flag")).isTrue());
alertCount(1);
assertThatThrownBy(() -> new RevealService().reveal("person", pk, "email", "Support", null)).isInstanceOf(com.kingsrook.qbits.secureddata.reveal.RevealCappedException.class);
alertCount(2);
QContext.setQSession(user("u1", BreakGlassService.START + ".hasAccess"));
new BreakGlassService().start("Investigating urgent customer incident", 5, null, null);
alertCount(3);
assertThat(logs()).filteredOn(r -> "BREAK_GLASS_START".equals(r.getValueString("event_type"))).singleElement()
.satisfies(r -> assertThat(r.getValueBoolean("anomaly_flag")).isTrue());
}
@Test void invalidThresholdsRejected() throws Exception
{
for(var config : List.of(new SecuredDataQBitConfig().withAnomalyDailyMedianMultiplier(0), new SecuredDataQBitConfig().withAnomalyMinimumDailyReveals(0),
new SecuredDataQBitConfig().withAnomalyDistinctRecordsPerHour(0), new SecuredDataQBitConfig().withAnomalyExactMatchesPerHour(0)))
assertThatThrownBy(config::validate).isInstanceOf(IllegalArgumentException.class);
}
@Test void exactMatchCounterIsScopedToFieldTableUserAndHour() throws Exception
{
init(c -> c.withAnomalyExactMatchesPerHour(2));
seed(ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH").withValue("field_name", "email").withValue("created_at", NOW.minusSeconds(3600)));
seed(ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH").withValue("field_name", "ssn"));
seed(ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH").withValue("field_name", "email").withValue("user_id", "u2"));
for(int i = 0; i < 3; i++)
{
QRecord row = insert(SecuredDataTables.ACCESS_LOG, ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH").withValue("field_name", "email"));
assertThat(row.getValueBoolean("anomaly_flag")).isEqualTo(i == 2);
}
alertCount(1);
}
@Test void configurableMedianMultiplierUsesHistoricalCounts() throws Exception
{
init(c -> c.withAnomalyDailyMedianMultiplier(2).withAnomalyMinimumDailyReveals(3));
for(int day = 1; day <= 30; day++)
for(int i = 0; i < 2; i++) seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("record_id", "1")
.withValue("created_at", NOW.minus(day, ChronoUnit.DAYS)));
for(int i = 0; i < 4; i++) assertThat(reveal(1).getValueBoolean("anomaly_flag")).isFalse();
alertCount(0);
assertThat(reveal(1).getValueBoolean("anomaly_flag")).isTrue();
alertCount(1);
}
}
@@ -0,0 +1,124 @@
/*
* 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.nio.file.Files;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.DriverManager;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
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.module.rdbms.model.metadata.RDBMSBackendMetaData;
import com.kingsrook.qqq.backend.module.rdbms.model.metadata.RDBMSTableBackendDetails;
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.RUNTIMES;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.base;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.close;
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.policy;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.user;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/*******************************************************************************
** Secured data ddl test.
*******************************************************************************/
class SecuredDataDdlTest
{
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
close();
}
/*******************************************************************************
** Postgres ddl runs in h2and supports actual qqq writes.
*******************************************************************************/
@Test
void postgresDdlRunsInH2AndSupportsActualQqqWrites() throws Exception
{
String url = "jdbc:h2:mem:secured_data;MODE=PostgreSQL;DATABASE_TO_UPPER=FALSE;DB_CLOSE_DELAY=-1";
try(Connection connection = DriverManager.getConnection(url, "sa", ""))
{
String ddl = Files.readString(Path.of("docs/ddl/secured-data-postgres.sql"));
for(String sql : ddl.split(";"))
{
if(!sql.isBlank())
{
connection.createStatement().execute(sql);
}
}
RDBMSBackendMetaData backend = new RDBMSBackendMetaData().withName("rdbms").withVendor("h2").withHostName("mem")
.withDatabaseName("secured_data").withUsername("sa");
backend.setJdbcUrl(url);
QInstance instance = base();
instance.addBackend(backend);
instance.addTable(person("rdbms").withBackendDetails(new RDBMSTableBackendDetails().withTableName("person")));
connection.createStatement().execute("CREATE TABLE person (id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, email VARCHAR(255), ssn VARCHAR(255), notes TEXT)");
new SecuredDataQBitProducer().withQBitConfig(new SecuredDataQBitConfig().withBackendName("rdbms").withClock(CLOCK)
.withAccessLogFlushIntervalMillis(60000).withTableMetaDataCustomizer((i, t) -> t.withBackendDetails(new RDBMSTableBackendDetails().withTableName(t.getName())))).produce(instance);
QContext.init(instance, user("u1", "cs_admin"));
RUNTIMES.add(SecuredDataRuntime.current());
classification(null, "PII");
policy("cs_admin", "PII", "REVEALABLE");
assertThat(SecuredDataRuntime.current().resolver().resolve(instance.getTable("person"), instance.getTable("person").getField("email")).tier().name()).isEqualTo("REVEALABLE");
SecuredDataRuntime.current().logger().onAccess(SecuredDataAccessLoggerTest.event(com.kingsrook.qbits.secureddata.standin.FieldAccessEventType.EXACT_MATCH_FILTER,
com.kingsrook.qbits.secureddata.standin.FieldAccessOutcome.MATCH, "hmac"));
SecuredDataRuntime.current().logger().flush();
assertThat(logs()).extracting(row -> row.getValueString("event_type")).containsExactly("CLASSIFICATION_CHANGE", "POLICY_CHANGE", "EXACT_MATCH_FILTER");
// Equal timestamps must be counted by SQL as well as the memory backend.
SecuredDataRuntime.current().config().withAnomalyMinimumDailyReveals(1000).withAnomalyDistinctRecordsPerHour(2).withAnomalyExactMatchesPerHour(2);
for(int i = 0; i < 3; i++)
{
QRecord audit = insert(SecuredDataTables.ACCESS_LOG, com.kingsrook.qbits.secureddata.support.ActivityLog.row("REVEAL", "person", "ALLOWED")
.withValue("record_id", String.valueOf(i)).withValue("field_name", "email"));
assertThat(audit.getValueBoolean("anomaly_flag")).isEqualTo(i == 2);
}
for(int i = 0; i < 2; i++)
{
QRecord audit = insert(SecuredDataTables.ACCESS_LOG, com.kingsrook.qbits.secureddata.support.ActivityLog.row("EXACT_MATCH_FILTER", "person", "MATCH")
.withValue("field_name", "email"));
assertThat(audit.getValueBoolean("anomaly_flag")).isEqualTo(i == 1);
}
assertThatThrownBy(() -> connection.createStatement().execute("INSERT INTO secured_data_classification (table_name, classification) VALUES ('person', 'PHI')"))
.isInstanceOf(java.sql.SQLException.class);
assertThatThrownBy(() -> connection.createStatement().execute("INSERT INTO secured_data_policy (name, permission_name, classification, tier, reveal_minutes) VALUES ('x','x','PII','FULL',61)"))
.isInstanceOf(java.sql.SQLException.class);
}
}
}
@@ -0,0 +1,117 @@
/*
* 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.Map;
import java.util.Set;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.support.ActivityLog;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.instances.AbstractQQQApplication;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.code.QCodeReference;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.qqq.backend.core.model.session.QUser;
import com.kingsrook.qqq.backend.core.modules.authentication.QAuthenticationModuleCustomizerInterface;
import com.kingsrook.qqq.middleware.javalin.QApplicationJavalinServer;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.*;
/*******************************************************************************
** Test-only local Next demo, following WebhooksDemoServer. Synthetic identifiers
** and reasons only; never shipped. Run on port 8098 after test compilation.
*******************************************************************************/
public class SecuredDataDemoServer
{
/*******************************************************************************
** Local demo administrator; not an application authentication implementation.
*******************************************************************************/
public static class Sessions implements QAuthenticationModuleCustomizerInterface
{
/*******************************************************************************
** Give the local demo access to its home and tables.
*******************************************************************************/
public void customizeSession(QInstance instance, QSession session, Map<String, Object> context)
{
session.setUser(new QUser().withIdReference("demo-admin").withFullName("Demo Administrator"));
session.setPermissions(Set.of("secured_data.admin", "secured_data.hasAccess", "person.read"));
}
}
/*******************************************************************************
** Seed every home section with realistic synthetic rows.
*******************************************************************************/
public static void seedDemo() throws Exception
{
String[] names = {"Avery Morgan", "Jordan Patel", "Sam Rivera", "Taylor Chen"};
String[] reasons = {"Customer identity verification", "Support case follow-up", "Account recovery investigation", "Review of an escalated access request with the customer support team"};
for(int i = 0; i < 48; i++)
{
SecuredDataAnomaliesTest.seed(ActivityLog.row("REVEAL", "person", "ALLOWED")
.withValue("user_id", "operator-" + i % 4).withValue("user_name", names[i % 4])
.withValue("record_id", String.valueOf(4200 + i)).withValue("field_name", i % 2 == 0 ? "email" : "ssn")
.withValue("reason", reasons[i % 4]).withValue("client_channel", i % 3 == 0 ? "api" : "web")
.withValue("created_at", NOW.minusSeconds(i < 15 ? i * 180L : i * 36000L)).withValue("anomaly_flag", i < 2));
}
for(int i = 0; i < 3; i++)
{
String event = new String[] {"BREAK_GLASS_START", "BREAK_GLASS_END", "BREAK_GLASS_EXPIRED"}[i];
SecuredDataAnomaliesTest.seed(ActivityLog.row(event, SecuredDataTables.BREAK_GLASS, "ALLOWED")
.withValue("user_name", names[i]).withValue("reason", "Urgent investigation of customer support incident SD-2026-1042")
.withValue("created_at", NOW.minusSeconds(i * 1200L)).withValue("anomaly_flag", i == 0));
}
for(int i = 0; i < 4; i++)
{
insert(SecuredDataTables.REVEAL_GRANT, new QRecord().withValue("user_id", "operator-" + i).withValue("user_name", names[i])
.withValue("table_name", "person").withValue("record_id", "4200").withValue("field_name", "email")
.withValue("granted_at", NOW.minusSeconds(60)).withValue("expires_at", NOW.plusSeconds(240)).withValue("access_log_id", i + 1));
}
insert(SecuredDataTables.BREAK_GLASS, new QRecord().withValue("user_id", "operator-0").withValue("user_name", names[0])
.withValue("started_at", NOW.minusSeconds(300)).withValue("expires_at", NOW.plusSeconds(3300)).withValue("status", "ACTIVE"));
for(int i = 0; i < 6; i++)
SecuredDataAnomaliesTest.seed(ActivityLog.row("FILTER_DENIED", "person", "DENIED").withValue("user_name", names[i % 4]));
policy("support_specialist", "PII", "REVEALABLE");
classification("email", "PII");
}
/*******************************************************************************
** Run the real bundled Next frontend and middleware against memory data.
*******************************************************************************/
public static void main(String[] args) throws Exception
{
QInstance instance = setup();
instance.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("mock").withType(QAuthenticationType.MOCK));
instance.getAuthentication().setCustomizer(new QCodeReference(Sessions.class));
instance.setHomeAppName("secured_data");
QContext.setQSession(user("demo-admin", "secured_data.admin"));
seedDemo();
new QApplicationJavalinServer(new AbstractQQQApplication()
{
public QInstance defineQInstance()
{
return (instance);
}
}).withPort(args.length == 0 ? 8098 : Integer.parseInt(args[0])).withServeFrontendNext(true).start();
System.out.println("Secured Data demo: http://localhost:8098/app/secured_data");
}
}
@@ -0,0 +1,143 @@
/*
* 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.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.util.List;
import com.kingsrook.qbits.secureddata.app.SecuredDataApp;
import com.kingsrook.qbits.secureddata.app.SecuredDataHomeData;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.support.ActivityLog;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.widgets.RenderWidgetInput;
import com.kingsrook.qqq.backend.core.model.dashboard.widgets.RawHTML;
import com.kingsrook.qqq.backend.core.model.data.QRecord;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.*;
import static org.assertj.core.api.Assertions.*;
class SecuredDataHomeTest
{
@AfterEach void cleanup() { close(); }
String home() throws Exception
{
return ((RawHTML) new SecuredDataApp.HomeRenderer().render(new RenderWidgetInput()).getWidgetData()).getHtml();
}
@Test void emptyStateAndNav() throws Exception
{
var instance = setup();
QContext.setQSession(user("admin", "secured_data.admin"));
var data = SecuredDataHomeData.load();
assertThat(data.getKpis().values()).containsOnly(0L);
assertThat(data.getSections()).hasSize(6).allSatisfy(s -> assertThat(s.rows()).isEmpty());
assertThat(home()).contains("No reveals yet", "No reveals in the last 30 days", "No reveal reasons in the last 30 days",
"No break-glass events yet", "No policy or classification changes yet", "No anomaly flags in the last 7 days");
var app = instance.getApp("secured_data");
assertThat(app.getWidgets()).containsExactly(SecuredDataApp.HOME_WIDGET);
assertThat(app.getChildren()).extracting(c -> c.getName()).containsExactly(SecuredDataTables.CLASSIFICATION, SecuredDataTables.POLICY,
SecuredDataTables.ACCESS_LOG, SecuredDataTables.BREAK_GLASS);
assertThat(instance.getTable(SecuredDataTables.ACCESS_LOG).getSections()).anyMatch(s -> SecuredDataTables.REVEALS_WIDGET.equals(s.getWidgetName()));
}
@Test void seededKpisOrderingLimitsLinksAndEveryWidget() throws Exception
{
setup(c -> c.withTablePathPrefix("/admin/data").withAccessLogQueueCapacity(1));
QContext.setQSession(user("admin", "secured_data.admin"));
for(int i = 0; i < 15; i++)
SecuredDataAnomaliesTest.seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("user_id", i < 12 ? "alice" : "bob")
.withValue("user_name", i < 12 ? "Alice <b>" : "Bob").withValue("reason", i < 11 ? "Customer support" : "Case review")
.withValue("record_id", String.valueOf(i)).withValue("field_name", "email").withValue("client_channel", "web")
.withValue("created_at", NOW.minusSeconds(i)).withValue("anomaly_flag", i == 0));
SecuredDataAnomaliesTest.seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("created_at", NOW.minusSeconds(31 * 86400L)));
SecuredDataAnomaliesTest.seed(ActivityLog.row("REVEAL", "person", "ALLOWED").withValue("created_at", NOW.plusSeconds(60)));
for(String type : List.of("BREAK_GLASS_START", "BREAK_GLASS_END", "BREAK_GLASS_EXPIRED", "FILTER_DENIED"))
SecuredDataAnomaliesTest.seed(ActivityLog.row(type, "person", "ALLOWED"));
SecuredDataAnomaliesTest.seed(ActivityLog.row("EXACT_MATCH_FILTER", "person", "REFUSED"));
SecuredDataAnomaliesTest.seed(ActivityLog.row("FILTER_DENIED", "person", "DENIED").withValue("created_at", NOW.minusSeconds(8 * 86400L)));
for(int i = 0; i < 2; i++)
insert(SecuredDataTables.REVEAL_GRANT, new QRecord().withValue("user_id", "alice").withValue("table_name", "person")
.withValue("record_id", "1").withValue("field_name", "email").withValue("granted_at", NOW.minusSeconds(60))
.withValue("expires_at", NOW.plusSeconds(i == 0 ? 60 : 0)).withValue("access_log_id", 1));
for(int i = 0; i < 3; i++)
insert(SecuredDataTables.BREAK_GLASS, new QRecord().withValue("user_id", "alice").withValue("started_at", NOW.minusSeconds(60))
.withValue("expires_at", NOW.plusSeconds(i == 0 ? 60 : 0)).withValue("status", i == 2 ? "ENDED" : "ACTIVE"));
var policy = policy("role", "PII", "MASKED");
update(SecuredDataTables.POLICY, new QRecord().withValue("id", policy.getValue("id")).withValue("name", "Changed"));
delete(SecuredDataTables.POLICY, policy);
classification("email", "PII");
var logger = SecuredDataRuntime.current().logger();
logger.onAccess(SecuredDataAccessLoggerTest.event(com.kingsrook.qbits.secureddata.standin.FieldAccessEventType.VIEW, null, null));
logger.onAccess(SecuredDataAccessLoggerTest.event(com.kingsrook.qbits.secureddata.standin.FieldAccessEventType.VIEW, null, null));
var data = SecuredDataHomeData.load();
assertThat(data.getKpis()).containsEntry("Reveals today", 15L).containsEntry("Active reveal grants", 1L)
.containsEntry("Active break-glass sessions", 1L).containsEntry("Anomaly flags (7 days)", 1L)
.containsEntry("Denied filters (7 days)", 2L).containsEntry("Access-log queue drops", 1L);
assertThat(data.getSections().get(0).rows()).hasSize(10).extracting(r -> r.getValueString("record_id"))
.containsExactly("0", "1", "2", "3", "4", "5", "6", "7", "8", "9");
assertThat(data.getSections().get(1).rows()).extracting(r -> r.getValueString("user_id")).containsExactly("alice", "bob");
assertThat(data.getSections().get(1).rows().getFirst().getValueInteger("count")).isEqualTo(12);
assertThat(data.getSections().get(2).rows().getFirst().getValueString("reason")).isEqualTo("Customer support");
assertThat(data.getSections().get(3).rows()).hasSize(3);
assertThat(data.getSections().get(4).rows()).hasSize(4).extracting(r -> r.getValueString("action_name")).containsExactly("INSERT", "DELETE", "UPDATE", "INSERT");
assertThat(data.getSections().get(5).rows()).hasSize(1);
for(var section : data.getSections())
{
assertThat(section.href()).startsWith("/admin/data/secured_data_access_log?filter=");
String filter = URLDecoder.decode(section.href().split("filter=")[1], StandardCharsets.UTF_8);
assertThat(filter).contains("created_at").doesNotContain("\"limit\":10");
}
String html = home();
assertThat(html).contains("Recent reveals", "Top revealers (30 days)", "Top reasons (30 days)", "Break-glass events", "Policy and classification changes", "Anomaly flags")
.contains("Alice &lt;b&gt;", "Customer support", "BREAK_GLASS_EXPIRED", "CLASSIFICATION_CHANGE", "View all", "UTC", "title=", "text-overflow:ellipsis", "white-space:nowrap", "minmax(min(100%", "var(--qqq-grid-border")
.doesNotContain("Alice <b>", "overflow:auto", "overflow-x", "<style", "#ffffff", "rgba(");
assertThat(html.split("<section ", -1)).hasSize(7);
}
@Test void viewerWithoutAdminCannotReadHome() throws Exception
{
setup();
assertThatThrownBy(SecuredDataHomeData::load).isInstanceOf(com.kingsrook.qqq.backend.core.exceptions.QPermissionDeniedException.class);
}
@Test void classificationMutationsAreValueFreeAndAttributed() throws Exception
{
setup();
QContext.setQSession(user("admin", "secured_data.admin"));
var input = new com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput(SecuredDataTables.CLASSIFICATION)
.withRecord(new QRecord().withValue("table_name", "person").withValue("field_name", "email").withValue("classification", "PII"));
var row = new com.kingsrook.qqq.backend.core.actions.tables.InsertAction().execute(input).getRecords().getFirst();
new com.kingsrook.qqq.backend.core.actions.tables.UpdateAction().execute(new com.kingsrook.qqq.backend.core.model.actions.tables.update.UpdateInput(SecuredDataTables.CLASSIFICATION)
.withRecord(new QRecord().withValue("id", row.getValue("id")).withValue("classification", "PHI")));
new com.kingsrook.qqq.backend.core.actions.tables.DeleteAction().execute(new com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput(SecuredDataTables.CLASSIFICATION)
.withPrimaryKeys(List.of(row.getValue("id"))));
assertThat(logs()).hasSize(3).allSatisfy(r -> {
assertThat(r.getValueString("user_id")).isEqualTo("admin");
assertThat(r.getValueString("record_id")).isEqualTo(row.getValueString("id"));
assertThat(r.getValueString("event_type")).isEqualTo("CLASSIFICATION_CHANGE");
assertThat(r.getValue("reason")).isNull();
});
assertThat(logs()).extracting(r -> r.getValueString("action_name")).containsExactly("INSERT", "UPDATE", "DELETE");
}
}
@@ -21,73 +21,205 @@
package com.kingsrook.qbits.secureddata;
import java.util.List;
import java.util.Map;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerMultiOutput;
import com.kingsrook.qbits.secureddata.metadata.FieldsOfTablePossibleValueSource;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataEnums;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.ClientChannelsMetaData;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.standin.TableFeaturePermissionsMetaData;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qqq.backend.core.actions.tables.InsertAction;
import com.kingsrook.qqq.backend.core.actions.tables.QueryAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.model.actions.tables.insert.InsertInput;
import com.kingsrook.qqq.backend.core.model.actions.tables.query.QueryInput;
import com.kingsrook.qqq.backend.core.model.actions.values.SearchPossibleValueSourceInput;
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.producers.MetaDataCustomizerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.audits.AuditLevel;
import com.kingsrook.qqq.backend.core.model.metadata.tables.Capability;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
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.channelUser;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
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.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;
/*******************************************************************************
** Verify the scaffold's registration and configuration contract.
** Secured data qbit producer test.
*******************************************************************************/
class SecuredDataQBitProducerTest
{
/*******************************************************************************
** Produce the identity and exact config into an otherwise empty instance.
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
close();
}
/*******************************************************************************
** Produces complete metadata.
*******************************************************************************/
@Test
void producesQBitWithoutTables()
void producesCompleteMetadata() throws Exception
{
QInstance instance = new QInstance();
SecuredDataQBitConfig config = new SecuredDataQBitConfig();
SecuredDataQBitProducer producer = new SecuredDataQBitProducer().withQBitConfig(config);
MetaDataProducerMultiOutput output = producer.produce(instance);
QBitMetaData qBit = instance.getQBits().get("com.kingsrook.qbits:qbit-secured-data");
QInstance instance = setup();
assertThat(instance.getTables().keySet()).containsAll(SecuredDataTables.ALL);
assertThat(instance.getQBits().get("com.kingsrook.qbits:qbit-secured-data").getVersion()).isEqualTo("1.0.0");
for(String name : SecuredDataTables.ALL)
{
QTableMetaData table = instance.getTable(name);
assertThat(table.getAuditRules().getAuditLevel()).isEqualTo(AuditLevel.FIELD);
assertThat(table.getSections()).isNotEmpty();
assertThat(CoreMetadataBridge.classification(table, null)).isEqualTo(DataClassification.CONFIDENTIAL);
table.getFields().values().forEach(field -> assertThat(field.getBackendName()).isEqualTo(field.getName()));
}
assertThat(SecuredDataTables.esbTableNames()).containsExactlyElementsOf(SecuredDataTables.MAIN);
assertThat(SecuredDataEnums.sources()).hasSize(6);
assertThat(ClientChannelsMetaData.ofOrWithNew(instance).getEntries()).containsEntry("assistant", "secured_data_*");
assertThat(TableFeaturePermissionsMetaData.ofOrWithNew(instance).getEntries()).containsKeys("secured_data_full", "secured_data_reveal");
assertThat(instance.getTable(SecuredDataTables.ACCESS_LOG).getDisabledCapabilities()).contains(Capability.TABLE_UPDATE, Capability.TABLE_DELETE);
assertThat(instance.getJoin(SecuredDataTables.REVEALS_JOIN)).isNotNull();
assertThat(instance.getWidget(SecuredDataTables.REVEALS_WIDGET)).isNotNull();
assertThat(instance.getApp("secured_data").getChildren()).hasSize(4);
}
assertThat(qBit).isNotNull();
assertThat(qBit.getGroupId()).isEqualTo("com.kingsrook.qbits");
assertThat(qBit.getArtifactId()).isEqualTo("qbit-secured-data");
assertThat(qBit.getVersion()).isEqualTo("1.0.0");
assertThat(qBit.getConfig()).isSameAs(config);
/*******************************************************************************
** Config and producer contract.
*******************************************************************************/
@Test
void configAndProducerContract() throws Exception
{
SecuredDataQBitConfig config = new SecuredDataQBitConfig().withBackendName("memory")
.withDefaultTier(DataClassification.PHI, FieldAccessTier.HIDDEN).withDefaultTierByClassification(Map.of("PHI", "FULL"))
.withNameHeuristics(true).withTableMetaDataCustomizer((instance, table) -> table);
assertThat(config.defaultTier(DataClassification.PHI)).isEqualTo(FieldAccessTier.FULL);
assertThat(config.defaultTier(DataClassification.PII)).isEqualTo(FieldAccessTier.MASKED);
SecuredDataQBitProducer producer = new SecuredDataQBitProducer().withQBitConfig(config).withNamespace("test");
assertThat(producer.getNamespace()).isEqualTo("test");
assertThat(producer.getQBitConfig()).isSameAs(config);
assertThat(producer.isEnabled()).isTrue();
assertThat(producer.getNamespace()).isNull();
assertThat(output.getEach(QBitMetaData.class)).containsExactly(qBit);
assertThat(output.getEach(QTableMetaData.class)).isEmpty();
assertThat(instance.getTables()).isEmpty();
assertThat(config.getDefaultTierByClassification()).isEmpty();
assertThat(config.getTableMetaDataCustomizer()).isNull();
assertThat(new SecuredDataQBitProducer().isEnabled()).isFalse();
assertThatThrownBy(() -> new SecuredDataQBitConfig().withAccessLogQueueCapacity(0).validate()).isInstanceOf(IllegalArgumentException.class);
setup();
assertThatThrownBy(() -> new SecuredDataQBitProducer().withQBitConfig(config).produce(QContext.getQInstance())).isInstanceOf(IllegalStateException.class);
}
/*******************************************************************************
** Configured instances may be namespaced; unconfigured scanning is disabled.
** Admin can read but cannot forge activity and assistant cannot read.
*******************************************************************************/
@Test
void supportsNamespacedConfiguration()
void adminCanReadButCannotForgeActivityAndAssistantCannotRead() throws Exception
{
assertThat(new SecuredDataQBitProducer().isEnabled()).isFalse();
MetaDataCustomizerInterface<QTableMetaData> customizer = (instance, table) -> table;
Map<String, String> tiers = Map.of("CONFIDENTIAL", "MASKED");
SecuredDataQBitConfig config = new SecuredDataQBitConfig()
.withTableMetaDataCustomizer(customizer)
.withDefaultTierByClassification(tiers);
SecuredDataQBitProducer producer = new SecuredDataQBitProducer()
.withQBitConfig(config)
.withNamespace("test");
QInstance instance = new QInstance();
producer.produce(instance);
assertThat(producer.getNamespace()).isEqualTo("test");
assertThat(instance.getQBits().get("com.kingsrook.qbits:qbit-secured-data:test").getConfig()).isSameAs(config);
assertThat(config.getTableMetaDataCustomizer()).isSameAs(customizer);
assertThat(config.getDefaultTierByClassification()).containsExactlyEntriesOf(tiers);
assertThat(new SecuredDataQBitConfig().getDefaultTierByClassification()).isEmpty();
assertThat(instance.getTables()).isEmpty();
QInstance instance = setup();
QContext.setQSession(user("admin", "secured_data.admin"));
assertThat(new QueryAction().execute(new QueryInput(SecuredDataTables.POLICY)).getRecords()).isEmpty();
for(String table : SecuredDataTables.SYSTEM_WRITTEN)
{
assertThatThrownBy(() -> new InsertAction().execute(new InsertInput(table).withRecord(new QRecord()))).hasMessageContaining("Permission denied");
}
QContext.setQSession(channelUser("assistant/t1", "secured_data.admin"));
for(String table : SecuredDataTables.ALL)
{
assertThatThrownBy(() -> new QueryAction().execute(new QueryInput(table))).hasMessageContaining("Permission denied");
}
QContext.setQSession(user("ordinary"));
assertThatThrownBy(() -> new QueryAction().execute(new QueryInput(SecuredDataTables.CLASSIFICATION))).hasMessageContaining("Permission denied");
}
/*******************************************************************************
** Fields picker and classification uniqueness.
*******************************************************************************/
@Test
void fieldsPickerAndClassificationUniqueness() throws Exception
{
setup();
FieldsOfTablePossibleValueSource picker = new FieldsOfTablePossibleValueSource();
assertThat(picker.search(new SearchPossibleValueSourceInput().withOtherValues(Map.of("table_name", "person")))).hasSize(4);
assertThat(picker.search(new SearchPossibleValueSourceInput())).isEmpty();
assertThat(picker.getPossibleValue("email").getId()).isEqualTo("email");
assertThat(picker.getPossibleValue(null)).isNull();
classification(null, "CONFIDENTIAL");
assertThatThrownBy(() -> classification(null, "PHI")).hasMessageContaining("system insert failed");
assertThatThrownBy(() -> classification("no_such_field", "PHI")).hasMessageContaining("system insert failed");
assertThatThrownBy(() -> insert(SecuredDataTables.POLICY, policyRow("x", "PII", "FULL").withValue("reveal_minutes", 61))).hasMessageContaining("system insert failed");
}
/*******************************************************************************
** System cannot update or delete an access log.
*******************************************************************************/
@Test
void systemCannotUpdateOrDeleteAnAccessLog() throws Exception
{
setup();
QRecord row = insert(SecuredDataTables.ACCESS_LOG, new QRecord().withValue("event_type", "VIEW").withValue("table_name", "person").withValue("created_at", NOW));
assertThatThrownBy(() -> update(SecuredDataTables.ACCESS_LOG, new QRecord().withValue("id", row.getValue("id")).withValue("outcome", "DENIED"))).isInstanceOf(Exception.class);
assertThatThrownBy(() -> delete(SecuredDataTables.ACCESS_LOG, row)).isInstanceOf(Exception.class);
assertThat(logs()).hasSize(1);
}
/*******************************************************************************
** Versions invalidate after commit and never for rollback.
*******************************************************************************/
@Test
void versionsInvalidateAfterCommitAndNeverForRollback() throws Exception
{
setup();
var runtime = SecuredDataRuntime.current();
var customizer = new com.kingsrook.qbits.secureddata.metadata.SecuredDataTableCustomizers();
var transaction = new com.kingsrook.qqq.backend.core.actions.QBackendTransaction();
var input = new InsertInput(SecuredDataTables.CLASSIFICATION).withTransaction(transaction);
long before = runtime.classificationVersion();
customizer.postInsert(input, List.of(new QRecord().withValue("id", 42)));
assertThat(runtime.classificationVersion()).isEqualTo(before);
transaction.rollback();
assertThat(runtime.classificationVersion()).isEqualTo(before);
customizer.postInsert(input, List.of(new QRecord().withValue("id", 43)));
transaction.commit();
assertThat(runtime.classificationVersion()).isGreaterThan(before);
}
/*******************************************************************************
** Code heuristics are opt in and preserve explicit classifications.
*******************************************************************************/
@Test
void codeHeuristicsAreOptInAndPreserveExplicitClassifications() throws Exception
{
QInstance instance = base();
instance.addBackend(new com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData().withName("memory")
.withBackendType(com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule.class));
QTableMetaData table = person("memory");
table.withField(new com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldMetaData("diagnosis_code", com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType.STRING));
instance.addTable(table);
new SecuredDataQBitProducer().withQBitConfig(new SecuredDataQBitConfig().withNameHeuristics(true)).produce(instance);
QContext.init(instance, user("u1"));
RUNTIMES.add(SecuredDataRuntime.current());
assertThat(SecuredDataClassifications.effective(table, "diagnosis_code")).isEqualTo(DataClassification.PHI);
assertThat(SecuredDataClassifications.effective(table, "email")).isEqualTo(DataClassification.PII);
}
}
@@ -0,0 +1,330 @@
/*
* 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 com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.AiTableMetaData;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.standin.FieldAccessTier;
import com.kingsrook.qbits.secureddata.standin.FieldMaskStyle;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
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.fields.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.CLOCK;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.NOW;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.channelUser;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.classification;
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.person;
import static com.kingsrook.qbits.secureddata.SecuredDataTestSupport.policy;
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;
/*******************************************************************************
** Secured data resolver test.
*******************************************************************************/
class SecuredDataResolverTest
{
QTableMetaData person;
SecuredDataResolver resolver;
/*******************************************************************************
** Init.
*******************************************************************************/
@BeforeEach
void init() throws Exception
{
person = setup().getTable("person");
resolver = SecuredDataRuntime.current().resolver();
}
/*******************************************************************************
** Cleanup.
*******************************************************************************/
@AfterEach
void cleanup()
{
close();
}
/*******************************************************************************
** Tier.
*******************************************************************************/
FieldAccessTier tier(String field)
{
return (resolver.resolve(person, person.getField(field)).tier());
}
/*******************************************************************************
** Classification order and highest.
*******************************************************************************/
@Test
void classificationOrderAndHighest() throws Exception
{
assertThat(SecuredDataClassifications.effective(person)).isNull();
assertThat(SecuredDataClassifications.effective(person, "email")).isEqualTo(DataClassification.PII);
person.withSupplementalMetaData(new AiTableMetaData().withClassification(DataClassification.CONFIDENTIAL));
assertThat(SecuredDataClassifications.effective(person, "notes")).isEqualTo(DataClassification.CONFIDENTIAL);
assertThat(SecuredDataClassifications.effective(person, "email")).isEqualTo(DataClassification.PII);
QRecord tableRow = classification(null, "PHI");
assertThat(SecuredDataClassifications.effective(person, "email")).isEqualTo(DataClassification.PHI);
assertThat(SecuredDataClassifications.effective(person)).isEqualTo(DataClassification.PHI);
QRecord fieldRow = classification("email", "PUBLIC");
assertThat(SecuredDataClassifications.effective(person, "email")).isEqualTo(DataClassification.PUBLIC);
assertThat(SecuredDataClassifications.highest(person)).isEqualTo(DataClassification.PHI);
assertThat(SecuredDataClassifications.highest(person, List.of("email"))).isEqualTo(DataClassification.PUBLIC);
assertThat(SecuredDataClassifications.highest(person, List.of())).isNull();
delete(SecuredDataTables.CLASSIFICATION, fieldRow);
delete(SecuredDataTables.CLASSIFICATION, tableRow);
assertThat(SecuredDataClassifications.effective(person, "email")).isEqualTo(DataClassification.PII);
}
/*******************************************************************************
** Defaults public primary key and admin separation.
*******************************************************************************/
@Test
void defaultsPublicPrimaryKeyAndAdminSeparation() throws Exception
{
assertThat(tier("id")).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("notes")).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("email")).isEqualTo(FieldAccessTier.MASKED);
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.MASKED);
classification("notes", "CONFIDENTIAL");
assertThat(tier("notes")).isEqualTo(FieldAccessTier.FULL);
QContext.setQSession(user("admin", "secured_data.admin"));
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.MASKED);
QTableMetaData own = QContext.getQInstance().getTable(SecuredDataTables.POLICY);
assertThat(resolver.resolve(own, own.getField("name")).tier()).isEqualTo(FieldAccessTier.FULL);
assertThat(SystemWrites.call(() -> tier("ssn"))).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.MASKED);
}
/*******************************************************************************
** Least restrictive active matching policy and table scope.
*******************************************************************************/
@Test
void leastRestrictiveActiveMatchingPolicyAndTableScope() throws Exception
{
policy("cs_admin", "PII", "REVEALABLE");
policy("other_role", "PII", "FULL");
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
QRecord full = policy("cs_admin", "PII", "FULL");
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
update(SecuredDataTables.POLICY, new QRecord().withValue("id", full.getValue("id")).withValue("is_active", false));
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
QTableMetaData another = new QTableMetaData().withName("another").withBackendName("memory").withPrimaryKeyField("id")
.withField(new QFieldMetaData("id", QFieldType.INTEGER));
QContext.getQInstance().addTable(another);
update(SecuredDataTables.POLICY, new QRecord().withValue("id", full.getValue("id")).withValue("is_active", true).withValue("table_name", "another"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
}
/*******************************************************************************
** Channel rows only cap including features and break glass.
*******************************************************************************/
@Test
void channelRowsOnlyCapIncludingFeaturesAndBreakGlass() throws Exception
{
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "FULL").withValue("client_channel", "assistant"));
QContext.setQSession(channelUser("assistant/t1", "cs_admin"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.MASKED);
policy("cs_admin", "PII", "FULL");
QRecord cap = insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "HIDDEN").withValue("client_channel", "assistant"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.HIDDEN);
QContext.setQSession(user("u1", "cs_admin"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
QContext.setQSession(channelUser("assistant/t2", "cs_admin", "person.secured_data_full"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.HIDDEN);
breakGlass("PHI", null);
assertThat(tier("email")).isEqualTo(FieldAccessTier.HIDDEN);
}
/*******************************************************************************
** Feature grants have no admin shortcut.
*******************************************************************************/
@Test
void featureGrantsHaveNoAdminShortcut() throws Exception
{
policy("cs_admin", "PII", "HIDDEN");
assertThat(tier("email")).isEqualTo(FieldAccessTier.HIDDEN);
QContext.setQSession(user("u1", "cs_admin", "person.secured_data_reveal"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.REVEALABLE);
QContext.setQSession(user("u1", "person.secured_data_full"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
}
/*******************************************************************************
** Break glass.
*******************************************************************************/
QRecord breakGlass(String ceiling, String scope) throws Exception
{
return (insert(SecuredDataTables.BREAK_GLASS, new QRecord().withValue("user_id", "u1").withValue("classification_ceiling", ceiling)
.withValue("table_name", scope).withValue("status", "ACTIVE").withValue("started_at", NOW).withValue("expires_at", NOW.plusSeconds(60))));
}
/*******************************************************************************
** Break glass ceiling user and exact expiry.
*******************************************************************************/
@Test
void breakGlassCeilingUserAndExactExpiry() throws Exception
{
QRecord grant = breakGlass("PII", "person");
assertThat(tier("email")).isEqualTo(FieldAccessTier.FULL);
assertThat(tier("ssn")).isEqualTo(FieldAccessTier.MASKED);
QContext.setQSession(user("other"));
assertThat(tier("email")).isEqualTo(FieldAccessTier.MASKED);
QContext.setQSession(user("u1"));
String before = resolver.getAccessFingerprint();
CLOCK.now = NOW.plusSeconds(60);
assertThat(tier("email")).isEqualTo(FieldAccessTier.MASKED);
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(before);
}
/*******************************************************************************
** Fingerprint tracks only relevant state.
*******************************************************************************/
@Test
void fingerprintTracksOnlyRelevantState() throws Exception
{
String initial = resolver.getAccessFingerprint();
assertThat(resolver.getAccessFingerprint()).isEqualTo(initial);
QContext.setQSession(user("u1", "cs_admin", "unrelated.permission"));
assertThat(resolver.getAccessFingerprint()).isEqualTo(initial);
insert("person", new QRecord().withValue("notes", "unrelated"));
assertThat(resolver.getAccessFingerprint()).isEqualTo(initial);
QRecord policy = policy("cs_admin", "PII", "REVEALABLE");
String afterPolicy = resolver.getAccessFingerprint();
assertThat(afterPolicy).isNotEqualTo(initial);
QRecord classification = classification("email", "PHI");
String afterClassification = resolver.getAccessFingerprint();
assertThat(afterClassification).isNotEqualTo(afterPolicy);
update(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("id", classification.getValue("id")).withValue("classification", "PII"));
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(afterClassification);
String beforeBreak = resolver.getAccessFingerprint();
QRecord grant = breakGlass("PHI", null);
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(beforeBreak);
update(SecuredDataTables.BREAK_GLASS, new QRecord().withValue("id", grant.getValue("id")).withValue("status", "ENDED"));
String ended = resolver.getAccessFingerprint();
delete(SecuredDataTables.BREAK_GLASS, grant);
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(ended);
String beforeDelete = resolver.getAccessFingerprint();
delete(SecuredDataTables.POLICY, policy);
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(beforeDelete);
String beforeChannel = resolver.getAccessFingerprint();
QContext.setQSession(channelUser("assistant/t1", "cs_admin"));
assertThat(resolver.getAccessFingerprint()).isNotEqualTo(beforeChannel);
}
/*******************************************************************************
** Entropy auto and both overrides.
*******************************************************************************/
@ParameterizedTest
@CsvSource({"BOOLEAN, flag", "DATE, dob", "DATE_TIME, timestamp", "INTEGER, birthYear", "STRING, state", "STRING, region", "STRING, province", "STRING, zip3"})
void entropyAutoAndBothOverrides(String type, String name) throws Exception
{
QFieldMetaData field = new QFieldMetaData(name, QFieldType.valueOf(type)).withMaxLength(255);
person.addField(field);
CoreMetadataBridge.classifyField(field, DataClassification.PII);
assertThat(resolver.resolve(person, field).exactMatchAllowed()).isFalse();
QRecord row = insert(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("table_name", "person").withValue("field_name", name)
.withValue("classification", "PII").withValue("low_cardinality", false).withValue("mask_style", "FULL"));
assertThat(resolver.resolve(person, field).exactMatchAllowed()).isTrue();
assertThat(resolver.resolve(person, field).maskStyle()).isEqualTo(FieldMaskStyle.FULL);
update(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("id", row.getValue("id")).withValue("low_cardinality", true));
assertThat(resolver.resolve(person, field).exactMatchAllowed()).isFalse();
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("min_entropy_enabled", false));
assertThat(resolver.resolve(person, field).exactMatchAllowed()).isTrue();
}
/*******************************************************************************
** Enum short string and year label auto rules.
*******************************************************************************/
@Test
void enumShortStringAndYearLabelAutoRules()
{
assertThat(SecuredDataResolver.lowCardinality(new QFieldMetaData("kind", QFieldType.STRING).withPossibleValueSourceName("enum"), null)).isTrue();
assertThat(SecuredDataResolver.lowCardinality(new QFieldMetaData("code", QFieldType.STRING).withMaxLength(5), null)).isTrue();
assertThat(SecuredDataResolver.lowCardinality(new QFieldMetaData("y", QFieldType.INTEGER).withLabel("Birth year"), null)).isTrue();
assertThat(SecuredDataResolver.lowCardinality(new QFieldMetaData("code", QFieldType.STRING).withMaxLength(6), null)).isFalse();
}
/*******************************************************************************
** Most restrictive guardrails and hmac.
*******************************************************************************/
@Test
void mostRestrictiveGuardrailsAndHmac() throws Exception
{
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "FULL").withValue("exact_match_per_hour", 0).withValue("min_entropy_enabled", false));
insert(SecuredDataTables.POLICY, policyRow("cs_admin", "PII", "REVEALABLE").withValue("exact_match_per_hour", 7).withValue("miss_alert_consecutive", 3));
var guardrails = resolver.guardrails(person, "email");
assertThat(guardrails.exactMatchPerHour()).isEqualTo(7);
assertThat(guardrails.missAlertConsecutive()).isEqualTo(3);
assertThat(guardrails.minEntropyEnabled()).isTrue();
String hash = resolver.fingerprintSearchValue("CANARY-SEARCH");
assertThat(hash).isEqualTo(resolver.fingerprintSearchValue("CANARY-SEARCH")).doesNotContain("CANARY");
assertThat(hash).isNotEqualTo(resolver.fingerprintSearchValue("different"));
}
/*******************************************************************************
** Reveal grant scope and expiration.
*******************************************************************************/
@Test
void revealGrantScopeAndExpiration() throws Exception
{
insert(SecuredDataTables.REVEAL_GRANT, new QRecord().withValue("user_id", "u1").withValue("table_name", "person")
.withValue("record_id", "7").withValue("field_name", "email").withValue("granted_at", NOW).withValue("expires_at", NOW.plusSeconds(10))
.withValue("access_log_id", 1));
assertThat(resolver.isRevealActive("person", "email", 7)).isTrue();
assertThat(resolver.isRevealActive("person", "ssn", 7)).isFalse();
assertThat(resolver.isRevealActive("person", "email", 8)).isFalse();
CLOCK.now = NOW.plusSeconds(10);
assertThat(resolver.isRevealActive("person", "email", 7)).isFalse();
}
}
@@ -0,0 +1,291 @@
/*
* 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.time.Clock;
import java.time.Instant;
import java.time.ZoneId;
import java.time.ZoneOffset;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.function.Consumer;
import com.kingsrook.qbits.secureddata.metadata.SecuredDataTables;
import com.kingsrook.qbits.secureddata.standin.ClientChannelSession;
import com.kingsrook.qbits.secureddata.standin.DataClassification;
import com.kingsrook.qbits.secureddata.support.CoreMetadataBridge;
import com.kingsrook.qbits.secureddata.support.SystemWrites;
import com.kingsrook.qqq.backend.core.actions.tables.DeleteAction;
import com.kingsrook.qqq.backend.core.actions.tables.UpdateAction;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.instances.QInstanceValidator;
import com.kingsrook.qqq.backend.core.model.actions.tables.delete.DeleteInput;
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.QAuthenticationType;
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.authentication.QAuthenticationMetaData;
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.permissions.PermissionLevel;
import com.kingsrook.qqq.backend.core.model.metadata.permissions.QPermissionRules;
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.QUser;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryRecordStore;
/*******************************************************************************
** Memory-backed, permission-enforced fixtures shared by direct and bridge tests.
*******************************************************************************/
final class SecuredDataTestSupport
{
static final Instant NOW = Instant.parse("2026-10-13T12:00:00Z");
static final MutableClock CLOCK = new MutableClock();
static final List<SecuredDataRuntime> RUNTIMES = new ArrayList<>();
/*******************************************************************************
** Setup.
*******************************************************************************/
static QInstance setup() throws QException
{
return (setup(config ->
{
}));
}
/*******************************************************************************
** Setup.
*******************************************************************************/
static QInstance setup(Consumer<SecuredDataQBitConfig> tweak) throws QException
{
close();
MemoryRecordStore.fullReset();
CLOCK.now = NOW;
QInstance instance = base();
instance.addBackend(new QBackendMetaData().withName("memory").withBackendType(MemoryBackendModule.class));
instance.addTable(person("memory"));
SecuredDataQBitConfig config = new SecuredDataQBitConfig().withClock(CLOCK).withAccessLogFlushIntervalMillis(60000);
tweak.accept(config);
new SecuredDataQBitProducer().withQBitConfig(config).produce(instance);
QContext.init(instance, user("u1", "cs_admin"));
RUNTIMES.add(SecuredDataRuntime.current());
new QInstanceValidator().validate(instance);
return (instance);
}
/*******************************************************************************
** Base.
*******************************************************************************/
static QInstance base()
{
return (new QInstance().withEnforcePermissionsInCoreActions(true)
.withInstanceDefaultAuthentication(new QAuthenticationMetaData().withName("anonymous").withType(QAuthenticationType.FULLY_ANONYMOUS)));
}
/*******************************************************************************
** Person.
*******************************************************************************/
static QTableMetaData person(String backend)
{
QTableMetaData table = new QTableMetaData().withName("person").withBackendName(backend).withPrimaryKeyField("id")
.withLabel("Person").withPermissionRules(new QPermissionRules().withLevel(PermissionLevel.READ_WRITE_PERMISSIONS))
.withField(new QFieldMetaData("id", QFieldType.INTEGER))
.withField(new QFieldMetaData("email", QFieldType.STRING).withMaxLength(255))
.withField(new QFieldMetaData("ssn", QFieldType.STRING).withMaxLength(255))
.withField(new QFieldMetaData("notes", QFieldType.TEXT));
CoreMetadataBridge.classifyField(table.getField("email"), DataClassification.PII);
CoreMetadataBridge.classifyField(table.getField("ssn"), DataClassification.PHI);
table.getFields().values().forEach(field -> field.setBackendName(field.getName()));
return (table);
}
/*******************************************************************************
** User.
*******************************************************************************/
static QSession user(String id, String... permissions)
{
List<String> grants = new ArrayList<>(Arrays.asList(permissions));
grants.add("person.read");
return (new QSession().withUser(new QUser().withIdReference(id).withFullName(id)).withPermissions(grants));
}
/*******************************************************************************
** Channel user.
*******************************************************************************/
static QSession channelUser(String channel, String... permissions) throws Exception
{
QSession session;
try
{
session = new QSession();
QSession.class.getMethod("withClientChannel", String.class).invoke(session, channel);
}
catch(NoSuchMethodException expected)
{
session = new ClientChannelSession().withClientChannel(channel);
}
List<String> grants = new ArrayList<>(Arrays.asList(permissions));
grants.add("person.read");
return (session.withUser(new QUser().withIdReference("u1").withFullName("User One")).withPermissions(grants));
}
/*******************************************************************************
** Policy.
*******************************************************************************/
static QRecord policy(String permission, String classification, String tier) throws QException
{
return (insert(SecuredDataTables.POLICY, policyRow(permission, classification, tier)));
}
/*******************************************************************************
** Policy row.
*******************************************************************************/
static QRecord policyRow(String permission, String classification, String tier)
{
return (new QRecord().withValue("name", permission + " " + classification).withValue("permission_name", permission)
.withValue("classification", classification).withValue("tier", tier).withValue("is_active", true));
}
/*******************************************************************************
** Classification.
*******************************************************************************/
static QRecord classification(String field, String classification) throws QException
{
return (insert(SecuredDataTables.CLASSIFICATION, new QRecord().withValue("table_name", "person")
.withValue("field_name", field).withValue("classification", classification)));
}
/*******************************************************************************
** Insert.
*******************************************************************************/
static QRecord insert(String table, QRecord row) throws QException
{
return (SystemWrites.insertOne(table, row));
}
/*******************************************************************************
** Update.
*******************************************************************************/
static void update(String table, QRecord row) throws QException
{
List<QRecord> records = SystemWrites.call(() -> new UpdateAction().execute(new UpdateInput(table).withRecord(row)).getRecords());
org.assertj.core.api.Assertions.assertThat(records.getFirst().getErrors()).isNullOrEmpty();
}
/*******************************************************************************
** Delete.
*******************************************************************************/
static void delete(String table, QRecord row) throws QException
{
SystemWrites.call(() -> new DeleteAction().execute(new DeleteInput(table).withPrimaryKeys(List.of(row.getValue("id")))));
}
/*******************************************************************************
** Logs.
*******************************************************************************/
static List<QRecord> logs()
{
return (SystemWrites.query(SecuredDataTables.ACCESS_LOG, new QQueryFilter()));
}
/*******************************************************************************
** Close.
*******************************************************************************/
static void close()
{
RUNTIMES.forEach(SecuredDataRuntime::close);
RUNTIMES.clear();
QContext.clear();
}
/*******************************************************************************
** Mutable clock.
*******************************************************************************/
static class MutableClock extends Clock
{
Instant now = NOW;
/*******************************************************************************
** Get zone.
*******************************************************************************/
public ZoneId getZone()
{
return (ZoneOffset.UTC);
}
/*******************************************************************************
** With zone.
*******************************************************************************/
public Clock withZone(ZoneId zone)
{
return (this);
}
/*******************************************************************************
** Instant.
*******************************************************************************/
public Instant instant()
{
return (now);
}
}
}