k-anonymity-verifier
Overview
A masked dataset is k-anonymous when every record is
indistinguishable from at least k - 1 other records on the set of
quasi-identifiers (QI) - columns that, when combined, could re-identify
an individual (Sweeney 2002, cited in NIST SP 800-188:2023 at
csrc.nist.gov/pubs/sp/800/188/final).
Two stronger models layer on top:
- l-diversity (Machanavajjhala et al. 2007, NIST 800-188 §3): each
equivalence class must contain at least l well-represented distinct
values of every sensitive attribute (SA), guarding against the
homogeneity attack.
- t-closeness (Li et al. 2007, NIST 800-188 §3): the distribution
of the SA within each equivalence class must be within distance t of
the global distribution, measured by Earth Mover's Distance (EMD),
guarding against the skewness and similarity attacks.
This skill verifies all three after masking. For choosing which
masking operator to apply per field, see the masking-techniques
catalog in pii-masking-pipeline-builder references/.
For detecting PII spans before masking, see
presidio-pii-detection.
How to use
- Agree the quasi-identifier (QI) and sensitive-attribute (SA) lists with a
privacy officer and record them in
qi-policy.yaml with k_min / l_min /
t_max thresholds (Step 1).
- Install pycanon (Step 2) and load the masked CSV into a pandas DataFrame.
- Compute
k_anonymity, l_diversity, and t_closeness for the agreed
QI / SA (Step 3).
- Compare each value against the policy thresholds and the guidance bands
(Step 4), then generate the full pycanon report for utility metrics (Step 5).
- Wire the gate script into CI so a failing dataset cannot be promoted
(references/ci-gate.md, Step 6).
- When a dataset fails, re-mask or generalise with ARX
(references/arx-api.md, Step 7) and re-verify.
- Report re-identification risk per equivalence class and per dataset (Step 8).
Step 1 - Select quasi-identifiers
QIs are columns that are not direct identifiers but whose combination
can re-identify. Common QI categories (NIST 800-188 §2 "indirect
identifiers"):
| Category | Examples |
|---|
| Demographic | age, sex, race, marital status |
| Geographic | ZIP code, city, state (below county level) |
| Temporal | date of birth, admission date, discharge date |
| Clinical / occupational | diagnosis code, specialty, employer industry |
Selection heuristics:
- Any column that appears in a publicly available external dataset
(voter rolls, social media profiles) is a QI candidate.
- ZIP + birth date + sex together re-identified 87 % of the US
population in Sweeney (2000), cited in NIST 800-188 §4. That
triple is always a QI set.
- Columns with high cardinality relative to dataset size are stronger
QIs (more granular = more identifying).
- Drop columns that are already nulled out or fully generalised - they
contribute no identifying power and inflate computation.
Agree the QI list with a privacy officer before running verification.
Record the agreed list in a qi-policy.yaml alongside the dataset.
Step 2 - Install pycanon
pycanon is a Python library and CLI published by IFCA-CSIC that
computes k-anonymity, l-diversity, t-closeness, and related metrics
directly on a pandas DataFrame
(github.com/IFCA-Advanced-Computing/pycanon).
pip install pycanon
# For PDF report generation:
pip install "pycanon[PDF]"
Requires Python 3.10, 3.11, or 3.12
(github.com/IFCA-Advanced-Computing/pycanon).
Step 3 - Compute k, l, t values
import pandas as pd
from pycanon import anonymity, report
data = pd.read_csv("masked_dataset.csv")
# Agree these with your qi-policy.yaml
QI = ["age", "zip_code", "sex"]
SA = ["diagnosis"]
# k-anonymity: returns int - the minimum equivalence-class size
k = anonymity.k_anonymity(data, QI)
print(f"k = {k}")
# l-diversity: returns int - minimum distinct SA values per class
l = anonymity.l_diversity(data, QI, SA)
print(f"l = {l}")
# t-closeness: returns float - maximum EMD across all classes
t = anonymity.t_closeness(data, QI, SA)
print(f"t = {t:.4f}")
Per github.com/IFCA-Advanced-Computing/pycanon:
k_anonymity(data, QI) - data is a pandas DataFrame; QI is a
list of column name strings. Returns an int.
l_diversity(data, QI, SA) - SA is a list of sensitive-attribute
column names. Returns an int.
t_closeness(data, QI, SA) - Returns a float (the worst-case EMD
across all equivalence classes). For numerical attributes, the
one-dimensional Earth Mover's Distance definition is used
(github.com/IFCA-Advanced-Computing/pycanon).
Step 4 - Interpret against thresholds
NIST SP 800-188:2023 §5 recommends calibrating k to dataset size and
re-identification risk tolerance (no single universal threshold is
mandated). Practitioners use these bands as a starting point:
| Threshold | Guidance |
|---|
| k < 5 | Insufficient for any regulated dataset; re-identification probability > 20 % per equivalence class |
| k = 5 | Minimum acceptable for internal analytics datasets (low sensitivity) |
| k >= 10 | Recommended for moderate-risk datasets (health, financial) |
| k >= 50 | High-risk or public-release datasets |
| l < 2 | No diversity protection; homogeneity attack succeeds trivially |
| l >= 3 | Minimum useful l-diversity for SA with low cardinality |
| t > 0.5 | Weak t-closeness; large distributional drift allowed |
| t <= 0.2 | Strong t-closeness; per ARX API docs new EqualDistanceTCloseness("disease", 0.2d) is cited as a concrete example (arx.deidentifier.org/development/api) |
Document the agreed threshold in qi-policy.yaml:
qi_policy:
quasi_identifiers: [age, zip_code, sex]
sensitive_attributes: [diagnosis]
thresholds:
k_min: 10
l_min: 3
t_max: 0.2
Step 5 - Full report (pycanon)
pycanon's report module outputs utility metrics alongside the privacy
metrics
(github.com/IFCA-Advanced-Computing/pycanon):
# Console report: k, l, t values + equivalence class stats
report.print_report(data, QI, SA)
# Machine-readable output
import json
json_report = report.get_json_report(data, QI, SA)
print(json.dumps(json_report, indent=2))
# PDF (requires pycanon[PDF])
report.get_pdf_report(data, QI, SA, filename="privacy_report.pdf")
The JSON report includes average equivalence class size, discernability
metric, and classification metric - use these to quantify utility loss
alongside the privacy guarantee
(github.com/IFCA-Advanced-Computing/pycanon).
Step 6 - CI gate
Block promotion of a masked dataset unless it meets the agreed thresholds in
qi-policy.yaml. The gate script (scripts/k_anonymity_gate.py) and the
GitHub Actions workflow are in references/ci-gate.md:
it loads the policy, computes k / l / t with pycanon, and exits non-zero on
any breach.
Step 7 - ARX for anonymization + verification (Java / GUI)
When the masking step itself must be performed, or a GUI workflow is required,
use ARX
(arx.deidentifier.org/development/api).
The Java API (privacy-model classes KAnonymity, EntropyLDiversity,
EqualDistanceTCloseness, HierarchicalDistanceTCloseness, plus
setSuppressionLimit) and the 7-step GUI workflow are in
references/arx-api.md.
Step 8 - Reporting re-identification risk
Risk is reported at two granularities:
- Equivalence-class level: any class of size exactly k has a 1/k
probability of re-identification for the prosecutor attack model
(NIST 800-188 §4).
- Dataset level: pycanon's JSON report
"discernability_metric"
and "average_class_size" summarise across all classes. ARX
RiskEstimator provides sample-based and population-uniqueness
estimates
(arx.deidentifier.org/development/api).
Map findings to risk tiers:
| Scenario | Metric | Risk tier |
|---|
| Smallest class size = 1 (unique record) | k = 1 | Critical - record uniquely identifiable |
| k < 5 | k = 2..4 | High - must re-mask or suppress |
| k >= threshold, but some class has homogeneous SA | l = 1 | High - homogeneity attack trivially succeeds |
| k and l met, but t > 0.5 | t > 0.5 | Medium - distributional skewness exploitable |
| All thresholds met | k >= k_min, l >= l_min, t <= t_max | Pass |
Worked example
A team masks a 20 000-row patient extract for a staging load. Policy:
QI = [age, zip_code, sex], SA = [diagnosis], thresholds k_min = 10,
l_min = 3, t_max = 0.2.
- The first pass keeps
age as an exact integer. pycanon reports k = 1 -
many size-1 equivalence classes, each uniquely identifiable (Critical tier
in Step 8).
- The team generalises
age to 5-year bands and truncates zip_code to 3
digits, then re-runs: k = 14, l = 4, t = 0.17.
- All three clear the policy (
14 >= 10, 4 >= 3, 0.17 <= 0.2), so the
Step 6 gate prints PASS k=14 l=4 t=0.1700 and the dataset is promoted.
Had t come back at 0.45, the gate would fail on t=0.4500 > allowed 0.2
and block the promotion until the SA distribution was brought closer to the
global one.
Anti-patterns
| Anti-pattern | Why it fails | Fix |
|---|
| Running k-anonymity on the wrong QI set | Missing a QI (e.g., ZIP omitted) inflates k; record is still re-identifiable | Agree QIs against a data-linkage threat model before measuring |
| Trusting k alone on a low-cardinality SA | Homogeneity attack succeeds when all k records share the same diagnosis | Always add l-diversity check when SA cardinality is low |
| t = 1.0 (accepting any distribution) | t-closeness is vacuous at t = 1.0; any distribution satisfies it | Set t <= 0.2 for regulated datasets; document in policy |
| Generalising then measuring on the original dataset | k is measured on the generalised/suppressed output, not on the raw input | Run pycanon on the masked CSV, never the source CSV |
| k = 2 for internal analytics | Re-identification probability 50 % per class | k >= 5 minimum (NIST 800-188 §5 guidance) |
| Ignoring suppression rate | ARX may suppress 20 % of rows to achieve k = 50 | Set suppressionLimit to a business-acceptable cap (e.g., 2 %) and verify utility at that limit |
Limitations
- QI selection is not automated. No tool eliminates the need for
a human threat-model review. A column missed from the QI list
silently inflates k without providing real protection.
- k-anonymity does not protect continuous attributes. Age stored
as an exact integer in the QI yields many size-1 classes in small
datasets; generalise to ranges before measuring.
- pycanon measures; it does not suppress or generalise. Use ARX
or a masking pipeline when the dataset fails the gate and must be
re-masked.
(
pii-masking-pipeline-builder)
- t-closeness is computationally expensive on large datasets with
many QI combinations. Benchmark with pycanon before gating in CI;
consider sampling on datasets > 1 M rows.
- SmartNoise (github.com/opendp/smartnoise-sdk)
implements differential privacy noise injection on query outputs -
a different guarantee that adds noise to aggregate results rather
than transforming the raw dataset. It does not replace k-anonymity
verification on stored masked datasets; the two approaches address
different threat models.
References
- pycanon source and README:
github.com/IFCA-Advanced-Computing/pycanon.
Functions
k_anonymity, l_diversity, t_closeness, report.print_report,
report.get_json_report cited inline above.
- ARX Java API:
arx.deidentifier.org/development/api.
Classes
KAnonymity, EntropyLDiversity, EqualDistanceTCloseness,
HierarchicalDistanceTCloseness, ARXConfiguration.setSuppressionLimit cited above.
- ARX anonymization tool (GUI):
arx.deidentifier.org/anonymization-tool.
- NIST SP 800-188:2023 "De-Identifying Government Datasets" - definitions of
k-anonymity, l-diversity, t-closeness, re-identification risk models:
csrc.nist.gov/pubs/sp/800/188/final.
- SmartNoise SDK (differential privacy, not k-anonymity):
github.com/opendp/smartnoise-sdk.
- Reference files:
references/ci-gate.md (gate script + workflow),
references/arx-api.md (ARX Java API + GUI workflow).
- Related skills:
presidio-pii-detection,
pii-masking-pipeline-builder (masking-techniques + privacy-models
catalogs in its references/).