argon2-cffi


Nameargon2-cffi JSON
Version 23.1.0 PyPI version JSON
download
home_page
SummaryArgon2 for Python
upload_time2023-08-15 14:13:12
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords hash hashing password security
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # *argon2-cffi*: Argon2 for Python


[Argon2](https://github.com/p-h-c/phc-winner-argon2) won the [Password Hashing Competition](https://www.password-hashing.net/) and *argon2-cffi* is the simplest way to use it in Python:

```pycon
>>> from argon2 import PasswordHasher
>>> ph = PasswordHasher()
>>> hash = ph.hash("correct horse battery staple")
>>> hash  # doctest: +SKIP
'$argon2id$v=19$m=65536,t=3,p=4$MIIRqgvgQbgj220jfp0MPA$YfwJSVjtjSU0zzV/P3S9nnQ/USre2wvJMjfCIjrTQbg'
>>> ph.verify(hash, "correct horse battery staple")
True
>>> ph.check_needs_rehash(hash)
False
>>> ph.verify(hash, "Tr0ub4dor&3")
Traceback (most recent call last):
  ...
argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash

```
<!-- end short -->

## Project Links

- [**PyPI**](https://pypi.org/project/argon2-cffi/)
- [**GitHub**](https://github.com/hynek/argon2-cffi)
- [**Documentation**](https://argon2-cffi.readthedocs.io/)
- [**Changelog**](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)
- [**Funding**](https://hynek.me/say-thanks/)
- The low-level Argon2 CFFI bindings are maintained in the separate [*argon2-cffi-bindings*](https://github.com/hynek/argon2-cffi-bindings) project.

## Release Information

### Removed

- Python 3.6 is not supported anymore.


### Deprecated

- The `InvalidHash` exception is deprecated in favor of `InvalidHashError`.
  No plans for removal currently exist and the names can (but shouldn't) be used interchangeably.

- `argon2.hash_password()`, `argon2.hash_password_raw()`, and `argon2.verify_password()` that have been soft-deprecated since 2016 are now hard-deprecated.
  They now raise `DeprecationWarning`s and will be removed in 2024.


### Added

- Official support for Python 3.11 and 3.12.
  No code changes were necessary.

- `argon2.exceptions.InvalidHashError` as a replacement for `InvalidHash`.

- *salt* parameter to `argon2.PasswordHasher.hash()` to allow for custom salts.
  This is only useful for specialized use-cases -- leave it on None unless you know exactly what you are doing.
  [#153](https://github.com/hynek/argon2-cffi/pull/153)


---

[→ Full Changelog](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)


## Credits

*argon2-cffi* is maintained by [Hynek Schlawack](https://hynek.me/).

The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *argon2-cffi* [Tidelift subscribers](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek), and my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).


## *argon2-cffi* for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of *argon2-cffi* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source packages you use to build your applications.
Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
[Learn more.](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "argon2-cffi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "hash,hashing,password,security",
    "author": "",
    "author_email": "Hynek Schlawack <hs@ox.cx>",
    "download_url": "https://files.pythonhosted.org/packages/31/fa/57ec2c6d16ecd2ba0cf15f3c7d1c3c2e7b5fcb83555ff56d7ab10888ec8f/argon2_cffi-23.1.0.tar.gz",
    "platform": null,
    "description": "# *argon2-cffi*: Argon2 for Python\n\n\n[Argon2](https://github.com/p-h-c/phc-winner-argon2) won the [Password Hashing Competition](https://www.password-hashing.net/) and *argon2-cffi* is the simplest way to use it in Python:\n\n```pycon\n>>> from argon2 import PasswordHasher\n>>> ph = PasswordHasher()\n>>> hash = ph.hash(\"correct horse battery staple\")\n>>> hash  # doctest: +SKIP\n'$argon2id$v=19$m=65536,t=3,p=4$MIIRqgvgQbgj220jfp0MPA$YfwJSVjtjSU0zzV/P3S9nnQ/USre2wvJMjfCIjrTQbg'\n>>> ph.verify(hash, \"correct horse battery staple\")\nTrue\n>>> ph.check_needs_rehash(hash)\nFalse\n>>> ph.verify(hash, \"Tr0ub4dor&3\")\nTraceback (most recent call last):\n  ...\nargon2.exceptions.VerifyMismatchError: The password does not match the supplied hash\n\n```\n<!-- end short -->\n\n## Project Links\n\n- [**PyPI**](https://pypi.org/project/argon2-cffi/)\n- [**GitHub**](https://github.com/hynek/argon2-cffi)\n- [**Documentation**](https://argon2-cffi.readthedocs.io/)\n- [**Changelog**](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)\n- [**Funding**](https://hynek.me/say-thanks/)\n- The low-level Argon2 CFFI bindings are maintained in the separate [*argon2-cffi-bindings*](https://github.com/hynek/argon2-cffi-bindings) project.\n\n## Release Information\n\n### Removed\n\n- Python 3.6 is not supported anymore.\n\n\n### Deprecated\n\n- The `InvalidHash` exception is deprecated in favor of `InvalidHashError`.\n  No plans for removal currently exist and the names can (but shouldn't) be used interchangeably.\n\n- `argon2.hash_password()`, `argon2.hash_password_raw()`, and `argon2.verify_password()` that have been soft-deprecated since 2016 are now hard-deprecated.\n  They now raise `DeprecationWarning`s and will be removed in 2024.\n\n\n### Added\n\n- Official support for Python 3.11 and 3.12.\n  No code changes were necessary.\n\n- `argon2.exceptions.InvalidHashError` as a replacement for `InvalidHash`.\n\n- *salt* parameter to `argon2.PasswordHasher.hash()` to allow for custom salts.\n  This is only useful for specialized use-cases -- leave it on None unless you know exactly what you are doing.\n  [#153](https://github.com/hynek/argon2-cffi/pull/153)\n\n\n---\n\n[\u2192 Full Changelog](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)\n\n\n## Credits\n\n*argon2-cffi* is maintained by [Hynek Schlawack](https://hynek.me/).\n\nThe development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *argon2-cffi* [Tidelift subscribers](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek), and my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).\n\n\n## *argon2-cffi* for Enterprise\n\nAvailable as part of the Tidelift Subscription.\n\nThe maintainers of *argon2-cffi* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source packages you use to build your applications.\nSave time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.\n[Learn more.](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Argon2 for Python",
    "version": "23.1.0",
    "project_urls": {
        "Changelog": "https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md",
        "Documentation": "https://argon2-cffi.readthedocs.io/",
        "Funding": "https://github.com/sponsors/hynek",
        "GitHub": "https://github.com/hynek/argon2-cffi",
        "Tidelift": "https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek"
    },
    "split_keywords": [
        "hash",
        "hashing",
        "password",
        "security"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a46ae8a041599e78b6b3752da48000b14c8d1e8a04ded09c88c714ba047f34f5",
                "md5": "a40a4892f0750b393a6cdc64901d58cb",
                "sha256": "c670642b78ba29641818ab2e68bd4e6a78ba53b7eff7b4c3815ae16abf91c7ea"
            },
            "downloads": -1,
            "filename": "argon2_cffi-23.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a40a4892f0750b393a6cdc64901d58cb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 15124,
            "upload_time": "2023-08-15T14:13:10",
            "upload_time_iso_8601": "2023-08-15T14:13:10.752679Z",
            "url": "https://files.pythonhosted.org/packages/a4/6a/e8a041599e78b6b3752da48000b14c8d1e8a04ded09c88c714ba047f34f5/argon2_cffi-23.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31fa57ec2c6d16ecd2ba0cf15f3c7d1c3c2e7b5fcb83555ff56d7ab10888ec8f",
                "md5": "7371c126f21a895b33c4fe7e00ac6fc1",
                "sha256": "879c3e79a2729ce768ebb7d36d4609e3a78a4ca2ec3a9f12286ca057e3d0db08"
            },
            "downloads": -1,
            "filename": "argon2_cffi-23.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7371c126f21a895b33c4fe7e00ac6fc1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 42798,
            "upload_time": "2023-08-15T14:13:12",
            "upload_time_iso_8601": "2023-08-15T14:13:12.711800Z",
            "url": "https://files.pythonhosted.org/packages/31/fa/57ec2c6d16ecd2ba0cf15f3c7d1c3c2e7b5fcb83555ff56d7ab10888ec8f/argon2_cffi-23.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-15 14:13:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hynek",
    "github_project": "argon2-cffi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "argon2-cffi"
}
        
Elapsed time: 0.42633s