Skip to main content

pypuf: Cryptanalysis of Physically Unclonable Functions

pypi DOI

pypuf is a toolbox for simulation, testing, and attacking Physically Unclonable Functions.

Getting Started

Please check out the pypuf hello world in the documentation.

Studies and Results

pypuf is used in a number of PUF-related research projects. If you would like to add your project to the list, please open an issue or send an email. In reverse chronological order:

Please check out the archived version of pypuf v1 to find the original code used some of the older projects.

Citation

To refer to pypuf, please use DOI 10.5281/zenodo.3901410. pypuf is published via Zenodo. Please cite this work as

Nils Wisiol, Christoph Gräbnitz, Christopher Mühl, Benjamin Zengin, Tudor Soroceanu, Niklas Pirnay, Khalid T. Mursi, & Adomas Baliuka. pypuf: Cryptanalysis of Physically Unclonable Functions (Version 2, June 2021). Zenodo. https://doi.org/10.5281/zenodo.3901410

or use the following BibTeX:

@software{pypuf,
  author       = {Nils Wisiol and
                  Christoph Gräbnitz and
                  Christopher Mühl and
                  Benjamin Zengin and
                  Tudor Soroceanu and
                  Niklas Pirnay and
                  Khalid T. Mursi and
                  Adomas Baliuka},
  title        = {{pypuf: Cryptanalysis of Physically Unclonable
                   Functions}},
  year         = 2021,
  publisher    = {Zenodo},
  version      = {v2},
  doi          = {10.5281/zenodo.3901410},
  url          = {https://doi.org/10.5281/zenodo.3901410}
}

Contribute

Testing, linting, licensing. When first contributing, make sure to update the author lists in README.md (2x), index.rst of the docs (2x), and CITATION.cff (1x).

Run Tests

  1. install sphinx-build xdoctest
  2. xdoctest pypuf
  3. cd docs
  4. make clean
  5. make doctest && make html
  6. cd to project root
  7. python3 -m pytest test

Maintainer: Prepare New Release

  1. Make sure author lists are up-to-date.
  2. Make sure docs are testing and building without error (see above)
  3. Commit all changes
  4. Clean up dist/ folder
  5. Set up new release version: RELEASE=x.y.z
  6. Update version to x.y.z in setup.py and docs/conf.py
  7. Commit with message "Release Version vx.y.z": git commit -p -m "Release Version v$RELEASE"
  8. Tag commit using git tag -as v$RELEASE -m "Release Version v$RELEASE"
  9. If applicable, adjust dev and/or stable tags.
  10. Push
    1. branch: git push
    2. tag: git push origin v$RELEASE
  11. Set environment variables GITHUB_TOKEN to a GitHub token, TWINE_USERNAME and TWINE_PASSWORD to PyPi credentials.
  12. Publish using publish nils-wisiol pypuf
  13. At zenodo.org, make sure the author list is up to date.

Metadata

Release files for pypuf 3.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pypuf 3.2.0
File Size Uploaded Provenance Actions
pypuf-3.2.0.tar.gz 75.7 kB Without provenance Details for pypuf-3.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pypuf 3.2.0
File Interpreter ABI Platform Actions
pypuf-3.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details for pypuf-3.2.0-py2.py3-none-any.whl

Total release size: 132.6 kB

Release files / pypuf-3.2.0.tar.gz

Download URL pypuf-3.2.0.tar.gz
Size 75.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ac55952af6272465e1cbdfbb8ee195d9066ce7ea8092f1c680a29264e701bfa2
BLAKE2b-256 checksum
How to use checksums
e0361f816ea8beadd9488a96e213a00ee2d7f338605439e3b920a9e1dee3ec20
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.8.0 tqdm/4.51.0 CPython/3.8.10

Release files / pypuf-3.2.0-py2.py3-none-any.whl

Download URL pypuf-3.2.0-py2.py3-none-any.whl
Size 57.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2bf8584dffc33b1695c9d16c406f790aa0dbd1c8fe262c12f20a8335d7eaf679
BLAKE2b-256 checksum
How to use checksums
d69e01fe0dfd873faff94070d14871107fa5221d991d25033fc094e43f46e363
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.8.0 tqdm/4.51.0 CPython/3.8.10

Security for pypuf 3.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page