Introduction
============
*plone.keyring* contains a Zope utility that facilitates handling of
secrets in an application. Secrets are very important in modern applications,
which is why a shared tool to manage them is useful.
plone.keyring contains two basic components:
* a *keyring*: a data structures which contains one or more secrets.
* a *key manager*: a utility which contains the available keyrings and
provides some convenience methods to manage them
Keyrings
========
The keyring is the workhorse: it contains a set of secrets for a specific
purpose. A ring has room for a fixed number of secrets which is set at
creation time. The most recently added secret is considered to be the
`current` secret and the one that should be used. Older secrets in the ring
can be used to keep data generated with older secrets valid for a period of
time.
Key manager
===========
The key manager is a container for the available keyrings. It always
contains a default system keyring which is used when no other ring is
explicitly requested.
Installation
============
You'll need to register a KeyManager as a persistent utility. On Zope2 with
GenericSetup, this can be done by loading the included profile.
Changelog
=========
.. You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
.. towncrier release notes start
4.0.1 (2024-01-22)
------------------
Internal:
- Update configuration files.
[plone devs] (6e36bcc4, 7723aeaf)
4.0.0 (2023-04-26)
------------------
Breaking changes:
- Drop python 2.7 support.
[gforcada] (#1)
Internal:
- Update configuration files.
[plone devs] (2ed8f544)
3.2.1 (2023-03-21)
------------------
Bug fixes:
- Use `ZODB` as dependency rather than the deprecated `ZODB3`.
[gforcada] (#1)
3.2.0 (2023-02-08)
------------------
Bug fixes:
- Update to Zope4 only including troove classifiers. [jensens] (#7)
3.1.3 (2020-09-07)
------------------
Bug fixes:
- Fixed deprecation warning for ``zope.component.interfaces.IComponentRegistry``.
[maurits] (#3130)
3.1.2 (2020-04-20)
------------------
Bug fixes:
- Minor packaging updates. (#1)
3.1.1 (2019-02-13)
------------------
Bug fixes:
- Avoid deprecation warnings. [gforcada] (#5)
- Initialize towncrier. [gforcada] (#2548)
3.1.0 (2018-06-20)
------------------
Bug fixes:
- Fix the tests on Python 3 [ale-rt]
- Python 2.6 is no longer supported, use a 3.0.x release if needed [gforcada]
3.0.2 (2017-08-27)
------------------
Fixes:
- Use zope.interface decorator.
[gforcada]
3.0.1 (2015-05-11)
------------------
- Minor cleanup: whitespace, git ignores.
[gforcada, rnix]
3.0.0 (2014-04-13)
------------------
- use more default keyrings and be able to select random key from ring
[vangheem]
2.0.1 (2012-12-15)
------------------
- Use system random when available. This is part of the fix for
https://plone.org/products/plone/security/advisories/20121106/24
[davisagli]
- Add MANIFEST.in.
[WouterVH]
2.0 - 2010-07-18
----------------
- Update package information.
[hannosch]
2.0b1 - 2010-06-13
------------------
- Added a meta.zcml to load the GenericSetup ZCML if installed.
[hannosch]
- Update license to BSD following board decision.
Cfr. http://lists.plone.org/pipermail/membership/2009-August/001038.html
[elro]
2.0a1 - 2009-11-13
------------------
- Updated to use `zope.container` instead of `zope.app.container`.
[hannosch]
- Specify package dependencies.
[hannosch]
1.2 - 2008-05-08
----------------
- Fix registration of the GenericSetup profile.
[witsch]
1.1 - 2008-05-02
----------------
- Add an optional GenericSetup profile to register the KeyManager as utility.
Required for plone.keyring on Plone 3.0.
[mj]
1.0 - 2008-04-21
----------------
- No changes.
[wichert]
1.0b1 - 2008-03-07
------------------
- Tweak the tests to better test the API.
[witsch]
1.0a1 - 2008-01-22
------------------
- Initial release.
[wichert]
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/plone.keyring",
"name": "plone.keyring",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "secret key keyring",
"author": "Plone Foundation",
"author_email": "plone-developers@lists.sourceforge.net",
"download_url": "https://files.pythonhosted.org/packages/19/ca/21274f35265d3b626cafa3225e88d5fb6148cf27dababf64571d7388336f/plone.keyring-4.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n*plone.keyring* contains a Zope utility that facilitates handling of\nsecrets in an application. Secrets are very important in modern applications,\nwhich is why a shared tool to manage them is useful.\n\nplone.keyring contains two basic components:\n\n* a *keyring*: a data structures which contains one or more secrets.\n\n* a *key manager*: a utility which contains the available keyrings and\n provides some convenience methods to manage them\n\n\nKeyrings\n========\n\nThe keyring is the workhorse: it contains a set of secrets for a specific\npurpose. A ring has room for a fixed number of secrets which is set at\ncreation time. The most recently added secret is considered to be the\n`current` secret and the one that should be used. Older secrets in the ring\ncan be used to keep data generated with older secrets valid for a period of\ntime.\n\nKey manager\n===========\n\nThe key manager is a container for the available keyrings. It always\ncontains a default system keyring which is used when no other ring is\nexplicitly requested.\n\nInstallation\n============\n\nYou'll need to register a KeyManager as a persistent utility. On Zope2 with\nGenericSetup, this can be done by loading the included profile.\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n4.0.1 (2024-01-22)\n------------------\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (6e36bcc4, 7723aeaf)\n\n\n4.0.0 (2023-04-26)\n------------------\n\nBreaking changes:\n\n\n- Drop python 2.7 support.\n [gforcada] (#1)\n\n\nInternal:\n\n\n- Update configuration files.\n [plone devs] (2ed8f544)\n\n\n3.2.1 (2023-03-21)\n------------------\n\nBug fixes:\n\n\n- Use `ZODB` as dependency rather than the deprecated `ZODB3`.\n [gforcada] (#1)\n\n\n3.2.0 (2023-02-08)\n------------------\n\nBug fixes:\n\n\n- Update to Zope4 only including troove classifiers. [jensens] (#7)\n\n\n3.1.3 (2020-09-07)\n------------------\n\nBug fixes:\n\n\n- Fixed deprecation warning for ``zope.component.interfaces.IComponentRegistry``.\n [maurits] (#3130)\n\n\n3.1.2 (2020-04-20)\n------------------\n\nBug fixes:\n\n\n- Minor packaging updates. (#1)\n\n\n3.1.1 (2019-02-13)\n------------------\n\nBug fixes:\n\n\n- Avoid deprecation warnings. [gforcada] (#5)\n- Initialize towncrier. [gforcada] (#2548)\n\n\n3.1.0 (2018-06-20)\n------------------\n\nBug fixes:\n\n- Fix the tests on Python 3 [ale-rt]\n\n- Python 2.6 is no longer supported, use a 3.0.x release if needed [gforcada]\n\n3.0.2 (2017-08-27)\n------------------\n\nFixes:\n\n- Use zope.interface decorator.\n [gforcada]\n\n\n3.0.1 (2015-05-11)\n------------------\n\n- Minor cleanup: whitespace, git ignores.\n [gforcada, rnix]\n\n\n3.0.0 (2014-04-13)\n------------------\n\n- use more default keyrings and be able to select random key from ring\n [vangheem]\n\n\n2.0.1 (2012-12-15)\n------------------\n\n- Use system random when available. This is part of the fix for\n https://plone.org/products/plone/security/advisories/20121106/24\n [davisagli]\n\n- Add MANIFEST.in.\n [WouterVH]\n\n\n2.0 - 2010-07-18\n----------------\n\n- Update package information.\n [hannosch]\n\n\n2.0b1 - 2010-06-13\n------------------\n\n- Added a meta.zcml to load the GenericSetup ZCML if installed.\n [hannosch]\n\n- Update license to BSD following board decision.\n Cfr. http://lists.plone.org/pipermail/membership/2009-August/001038.html\n [elro]\n\n\n2.0a1 - 2009-11-13\n------------------\n\n- Updated to use `zope.container` instead of `zope.app.container`.\n [hannosch]\n\n- Specify package dependencies.\n [hannosch]\n\n\n1.2 - 2008-05-08\n----------------\n\n- Fix registration of the GenericSetup profile.\n [witsch]\n\n\n1.1 - 2008-05-02\n----------------\n\n- Add an optional GenericSetup profile to register the KeyManager as utility.\n Required for plone.keyring on Plone 3.0.\n [mj]\n\n\n1.0 - 2008-04-21\n----------------\n\n- No changes.\n [wichert]\n\n\n1.0b1 - 2008-03-07\n------------------\n\n- Tweak the tests to better test the API.\n [witsch]\n\n\n1.0a1 - 2008-01-22\n------------------\n\n- Initial release.\n [wichert]\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Manage secrets",
"version": "4.0.1",
"project_urls": {
"Homepage": "https://pypi.org/project/plone.keyring"
},
"split_keywords": [
"secret",
"key",
"keyring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d45e311d80db1c4a49a7c729e91ca00cc5d385ab8511744ca93f874ebbc70df",
"md5": "a0766dcd421d2abf1fc481bd86410c50",
"sha256": "45c380c76e1dac2f715909d09df2e2316bfa24db9616ac615510f56e0f7e9f71"
},
"downloads": -1,
"filename": "plone.keyring-4.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0766dcd421d2abf1fc481bd86410c50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10677,
"upload_time": "2024-01-22T19:45:28",
"upload_time_iso_8601": "2024-01-22T19:45:28.050538Z",
"url": "https://files.pythonhosted.org/packages/4d/45/e311d80db1c4a49a7c729e91ca00cc5d385ab8511744ca93f874ebbc70df/plone.keyring-4.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "19ca21274f35265d3b626cafa3225e88d5fb6148cf27dababf64571d7388336f",
"md5": "1b4dc3f575a32269135fa1c8cdf0f077",
"sha256": "89a4fd955cb932098908d16fc6c57a3e75caf36d52c991a3bcb8d2999895c9a8"
},
"downloads": -1,
"filename": "plone.keyring-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1b4dc3f575a32269135fa1c8cdf0f077",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11928,
"upload_time": "2024-01-22T19:45:31",
"upload_time_iso_8601": "2024-01-22T19:45:31.345670Z",
"url": "https://files.pythonhosted.org/packages/19/ca/21274f35265d3b626cafa3225e88d5fb6148cf27dababf64571d7388336f/plone.keyring-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 19:45:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "plone.keyring"
}
JSON