pypuf

Cryptanalysis of Physically Unclonable Functions

https://github.com/nils-wisiol/pypuf

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 11 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

crps cryptography machine-learning pufs science security simulation strong-pufs
Last synced: 6 months ago · JSON representation ·

Repository

Cryptanalysis of Physically Unclonable Functions

Basic Info
  • Host: GitHub
  • Owner: nils-wisiol
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 192 MB
Statistics
  • Stars: 87
  • Watchers: 10
  • Forks: 28
  • Open Issues: 10
  • Releases: 19
Topics
crps cryptography machine-learning pufs science security simulation strong-pufs
Created almost 9 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

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.

Owner

  • Name: Nils Wisiol
  • Login: nils-wisiol
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.1.0
message: pypuf is published via Zenodo. To refer to pypuf, please use DOI 10.5281/zenodo.3901410.
title: pypuf: Cryptanalysis of Physically Unclonable Functions
doi: 10.5281/zenodo.3901410
publisher: Zenodo
url: https://doi.org/10.5281/zenodo.3901410
authors:
  - family-names: Wisiol
    given-names: Nils
    orcid: "https://orcid.org/0000-0003-2606-614X"
  - family-names: Gräbnitz
    given-names: Christoph
  - family-names: Mühl
    given-names: Christopher
  - family-names: Zengin
    given-names: Benjamin
  - family-names: Soroceanu
    given-names: Tudor
  - family-names: Pirnay
    given-names: Niklas
  - family-names: Mursi
    given-names: Khalid T.
    orcid: "https://orcid.org/0000-0001-8032-8484"
  - family-names: Baliuka
    given-names: Adomas
    orcid: "https://orcid.org/0000-0002-7064-8502"
license: GPL 3.0

GitHub Events

Total
  • Issues event: 1
  • Watch event: 11
  • Issue comment event: 4
  • Pull request event: 1
  • Fork event: 5
Last Year
  • Issues event: 1
  • Watch event: 11
  • Issue comment event: 4
  • Pull request event: 1
  • Fork event: 5

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 118
  • Total Committers: 1
  • Avg Commits per committer: 118.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Nils Wisiol m****l@n****e 118
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 35
  • Total pull requests: 71
  • Average time to close issues: 7 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 13
  • Total pull request authors: 8
  • Average comments per issue: 2.14
  • Average comments per pull request: 0.63
  • Merged pull requests: 53
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • weber-tsao (10)
  • nils-wisiol (9)
  • MrM0nkey (5)
  • AranyaiitrGit (2)
  • Dominic-Lentini (1)
  • harjas-kaur (1)
  • sara-alahmadi (1)
  • samehkhalfaoui (1)
  • RRasche (1)
  • korotaevyua (1)
  • Chrism7 (1)
  • taudor (1)
  • benj-zen (1)
Pull Request Authors
  • nils-wisiol (48)
  • MrM0nkey (13)
  • b10n (3)
  • Chrism7 (3)
  • n1kn4x (3)
  • javiermas (2)
  • huenemoerder (1)
  • ytuo (1)
Top Labels
Issue Labels
enhancement (8) bug (3) help wanted (2) question (1)
Pull Request Labels
enhancement (4)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 723 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 18
  • Total maintainers: 1
pypi.org: pypuf
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 723 Last month
Rankings
Forks count: 8.2%
Stargazers count: 8.6%
Downloads: 9.4%
Average: 9.6%
Dependent packages count: 10.1%
Dependent repos count: 11.5%
Maintainers (1)
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • docutils <0.18
requirements.txt pypi
  • flake8 *
  • memory_profiler *
  • more_itertools *
  • numpy *
  • pytest *
  • scipy *
  • setuptools *
  • sphinx *
  • sphinx_rtd_theme *
  • tensorflow *
  • xdoctest *
setup.py pypi
  • memory_profiler *
  • more_itertools *
  • numpy >=1.18
  • scipy >=1.5
  • tensorflow *
.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite