Skip to main content

Encoding utility to create Cryptographic Linkage Keys

Project description

CLK Hash

Clkhash Logo

codecov Documentation Status Unit Testing Typechecking Downloads

clkhash is a Python implementation of cryptographic linkage key hashing as described by Rainer Schnell, Tobias Bachteler, and Jörg Reiher in A Novel Error-Tolerant Anonymous Linking Code.

Installation

Install clkhash with all dependencies using pip:

pip install clkhash

Documentation

https://clkhash.readthedocs.io

Python API

To hash a CSV file of entities using the default schema:

from clkhash import clk, randomnames
fake_pii_schema = randomnames.NameList.SCHEMA
clks = clk.generate_clk_from_csv(open('fake-pii-out.csv','r'), 'secret', fake_pii_schema)

Command Line Interface

See Anonlink Client for a command line interface to clkhash.

Citing

Clkhash, and the wider Anonlink project is designed, developed and supported by CSIRO's Data61. If you use any part of this library in your research, please cite it using the following BibTex entry::

@misc{Anonlink,
  author = {CSIRO's Data61},
  title = {Anonlink Private Record Linkage System},
  year = {2017},
  publisher = {GitHub},
  journal = {GitHub Repository},
  howpublished = {\url{https://github.com/data61/clkhash}},
}

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

clkhash-0.18.3.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

clkhash-0.18.3-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file clkhash-0.18.3.tar.gz.

File metadata

  • Download URL: clkhash-0.18.3.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for clkhash-0.18.3.tar.gz
Algorithm Hash digest
SHA256 5418a8d191c779566bb838ab1e67cc13d7c5cdf0737d042cdc4a267a02f3b446
MD5 aee1f5297a6632b0788df70717cd539e
BLAKE2b-256 9e8e771093c8c2621a3e368e0761044df71c9a4c6841eef8f7f8537aa2565526

See more details on using hashes here.

File details

Details for the file clkhash-0.18.3-py3-none-any.whl.

File metadata

  • Download URL: clkhash-0.18.3-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for clkhash-0.18.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bf347d4596b4387e296883fb1f1f1b103743d0a10c4c3a6443238ce4946ba121
MD5 c40fb2039f4fab387871327f6b114d54
BLAKE2b-256 e3d9a2fa1e65dcec2bea5b14684a2fda1f6e6c65726bbeab08215711de185086

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