Skip to main content

PySpark implementation of the Open Privacy Preserving Record Linkage protocol.

Project description

Carduus

The open source implementation of the Open Privacy Preserving Record Linkage (OPPRL) protocol build on Spark.

Rationale

Privacy Preserving Record Linkage (PPRL) is crucial component to data de-identification systems. PPRL obfuscate identifying attributes or other sensitive information about the subjects described in the records of a dataset while still preserving the ability to link records pertaining to the same subject through the use of an encrypted token. This practice is sometimes referred to as "tokenization" and is one of the components of data de-identification.

The task of PPRL is to replace the attributes of a every record denoting Personally Identifiable Information (PII) with a token produced by a one-way cryptographic function. This prevents observers of the tokenized data from obtaining the PII. The tokens are produced deterministically such that input records with the same, or similar, PII attributes will produce an identical token. This allows practitioners to associate records across datasets that are highly likely to belong to the same data subject without having access to PII.

Tokenization is also used when data is shared between organizations to limit, or in some cases fully mitigate, the risk of subject re-identification in the event that an untrusted third party gains access to a dataset containing sensitive data. Each party produced encrypted tokens using a different secret key so that any compromised data asset is, at worst, only matchable to other datasets maintained by the same party. During data sharing transactions, a specific "transcryption" data flow is used to first re-encrypt the sender's tokens into ephemeral tokens that do not match tokens in any other dataset and can only be ingested using the recipients secret key. At no point in the "transcryption" data flow is the original PII used.

Carduus is the first (and canonical) implementation of the Open Privacy Preserving Record Linkage (OPPRL) protocol. This protocol presents a standardized methodology for tokenization that can be implemented in any data system to increase interoperability. The carduus implementation is a python library that distributes the tokenization workload using apache Spark across multiple cores or multiple machines in a high performance computing cluster for efficient tokenization of any scale datasets.

Why the name "Carduus"? The Carduus is a genus of thistle plants that was used to brush fibrous materials so that individual fibres align in preparation for spinning the material into thread or yarn. Today this process is known as "Carding" and is done by specialized machines.

Getting Started

See the getting started guide on the project's web page for an detailed explanation of how carduus is used including example code snippets.

The full API and an example usage on Databricks are also provided on the project's web page.

Contributing

Please refer to the carduus contributing guide for information on how to get started contributing to the project.

Organizations that have contributed to Carduus

Spindle Health

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

carduus-0.1.0.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

carduus-0.1.0-3-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file carduus-0.1.0.tar.gz.

File metadata

  • Download URL: carduus-0.1.0.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/23.2.0

File hashes

Hashes for carduus-0.1.0.tar.gz
Algorithm Hash digest
SHA256 31d7283d20e4238d41232dfc418a3cb674b010722a8a363040bd70664acf5316
MD5 b39a7108875db819114643011ab12726
BLAKE2b-256 73f9ef0ebc034c3119152806153903e6dcd9c860c035e0599385d4f375e62030

See more details on using hashes here.

File details

Details for the file carduus-0.1.0-3-py3-none-any.whl.

File metadata

  • Download URL: carduus-0.1.0-3-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/23.2.0

File hashes

Hashes for carduus-0.1.0-3-py3-none-any.whl
Algorithm Hash digest
SHA256 f066d2b6488d5b9d4a0426fc5c8ca5e036430a2ad331799c2fdd7e3b4d18f7a2
MD5 666de7dc946f9d722442e9a9a426da4c
BLAKE2b-256 180f2ccfbb12219cedebf3e37f30c29789bf75a2fbb2cccc785041d87fa62196

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page