pas.plugins.authomatic 1.4.1__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. pas_plugins_authomatic-2.0.0/.gitignore +18 -0
  2. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/CHANGELOG.md +78 -2
  3. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/CONTRIBUTORS.md +5 -1
  4. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/PKG-INFO +108 -247
  5. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/README.md +92 -33
  6. pas_plugins_authomatic-2.0.0/dependabot.yml +11 -0
  7. pas_plugins_authomatic-2.0.0/instance.yaml +3 -0
  8. pas_plugins_authomatic-2.0.0/pyproject.toml +207 -0
  9. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/__init__.py +3 -0
  10. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/browser/add_plugin.pt +45 -0
  11. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/browser/authomatic.pt +61 -0
  12. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/controlpanel.py +1 -2
  13. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/view.py +12 -9
  14. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/integration/__init__.py +8 -0
  15. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/integration/restapi.py +1 -3
  16. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/interfaces.py +1 -2
  17. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/locales/update.py → pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/locales/__main__.py +18 -28
  18. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/de/LC_MESSAGES/pas.plugins.authomatic.po +27 -19
  19. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/es/LC_MESSAGES/pas.plugins.authomatic.po +31 -23
  20. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/fr/LC_MESSAGES/pas.plugins.authomatic.po +27 -19
  21. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/it/LC_MESSAGES/pas.plugins.authomatic.po +27 -19
  22. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/locales/pas.plugins.authomatic-manual.pot +106 -0
  23. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/pas.plugins.authomatic.pot +27 -19
  24. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/pt_BR/LC_MESSAGES/pas.plugins.authomatic.po +28 -20
  25. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/ro/LC_MESSAGES/pas.plugins.authomatic.po +43 -26
  26. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/patches/authomatic.py +16 -12
  27. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/plugin.py +22 -24
  28. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/authomatic.py +1 -1
  29. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/configure.zcml +3 -9
  30. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/services/login.py +35 -0
  31. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/testing.py +15 -18
  32. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/useridentities.py +1 -1
  33. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/useridfactories.py +0 -3
  34. pas_plugins_authomatic-2.0.0/tests/conftest.py +76 -0
  35. pas_plugins_authomatic-2.0.0/tests/functional/test_controlpanel.py +66 -0
  36. pas_plugins_authomatic-2.0.0/tests/functional/test_controlpanel_functional.py +57 -0
  37. pas_plugins_authomatic-2.0.0/tests/plugin/conftest.py +7 -0
  38. pas_plugins_authomatic-2.0.0/tests/plugin/test_plugin.py +128 -0
  39. pas_plugins_authomatic-2.0.0/tests/plugin/test_useridentities.py +169 -0
  40. pas_plugins_authomatic-2.0.0/tests/plugin/test_useridfactories.py +24 -0
  41. pas_plugins_authomatic-2.0.0/tests/services/conftest.py +31 -0
  42. pas_plugins_authomatic-2.0.0/tests/services/test_services_authomatic.py +51 -0
  43. pas_plugins_authomatic-2.0.0/tests/services/test_services_login.py +27 -0
  44. pas_plugins_authomatic-2.0.0/tests/setup/test_setup_install.py +17 -0
  45. pas_plugins_authomatic-2.0.0/tests/setup/test_setup_uninstall.py +19 -0
  46. pas_plugins_authomatic-2.0.0/tests/setup/test_setuphandler.py +36 -0
  47. pas_plugins_authomatic-2.0.0/tests/setup/test_upgrades.py +29 -0
  48. pas_plugins_authomatic-1.4.1/.coveragerc +0 -7
  49. pas_plugins_authomatic-1.4.1/.editorconfig +0 -36
  50. pas_plugins_authomatic-1.4.1/MANIFEST.in +0 -5
  51. pas_plugins_authomatic-1.4.1/Makefile +0 -116
  52. pas_plugins_authomatic-1.4.1/pyproject.toml +0 -47
  53. pas_plugins_authomatic-1.4.1/requirements.txt +0 -1
  54. pas_plugins_authomatic-1.4.1/setup.cfg +0 -4
  55. pas_plugins_authomatic-1.4.1/setup.py +0 -76
  56. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/browser/add_plugin.pt +0 -28
  57. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/browser/authomatic.pt +0 -49
  58. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/integration/__init__.py +0 -2
  59. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/locales/pas.plugins.authomatic-manual.pot +0 -21
  60. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/services/login.py +0 -40
  61. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/mocks.py +0 -27
  62. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_browser_controlpanel.py +0 -75
  63. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_plugin.py +0 -123
  64. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_services_authomatic.py +0 -53
  65. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_services_login.py +0 -28
  66. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_setup.py +0 -44
  67. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_setuphandler.py +0 -48
  68. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_upgrades.py +0 -40
  69. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_useridentities.py +0 -156
  70. pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/test_useridfactories.py +0 -26
  71. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/PKG-INFO +0 -466
  72. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/SOURCES.txt +0 -83
  73. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/dependency_links.txt +0 -1
  74. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/entry_points.txt +0 -5
  75. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/namespace_packages.txt +0 -2
  76. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/not-zip-safe +0 -1
  77. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/requires.txt +0 -12
  78. pas_plugins_authomatic-1.4.1/src/pas.plugins.authomatic.egg-info/top_level.txt +0 -1
  79. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/LICENSE.txt +0 -0
  80. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/docs/authomatic.svg +0 -0
  81. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/docs/plone-control-panel.png +0 -0
  82. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/docs/plugin-settings.png +0 -0
  83. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/__init__.py +0 -0
  84. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/__init__.py +0 -0
  85. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/__init__.py +0 -0
  86. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/authomatic.png +0 -0
  87. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/configure.zcml +0 -0
  88. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic-logo.svg +0 -0
  89. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic.css +0 -0
  90. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic.less +0 -0
  91. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/configure.zcml +0 -0
  92. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/integration/zope.py +0 -0
  93. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/__init__.py +0 -0
  94. /pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/logging.py → /pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/log.py +0 -0
  95. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/meta.zcml +0 -0
  96. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/patches/__init__.py +0 -0
  97. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/browserlayer.xml +0 -0
  98. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/controlpanel.xml +0 -0
  99. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/metadata.xml +0 -0
  100. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/registry.xml +0 -0
  101. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/browserlayer.xml +0 -0
  102. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/controlpanel.xml +0 -0
  103. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/registry.xml +0 -0
  104. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles.zcml +0 -0
  105. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/__init__.py +0 -0
  106. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/setuphandlers.py +0 -0
  107. {pas_plugins_authomatic-1.4.1 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/utils.py +0 -0
  108. /pas_plugins_authomatic-1.4.1/src/pas/plugins/authomatic/tests/__init__.py → /pas_plugins_authomatic-2.0.0/tests/functional/conftest.py +0 -0
@@ -0,0 +1,18 @@
1
+ !src/pas
2
+ .coverage*
3
+ .pydevproject
4
+ .pytest_cache
5
+ .ruff_cache
6
+ .python-version
7
+ .venv
8
+ *.egg-info
9
+ *.log
10
+ *.mo
11
+ *.pyc
12
+ *.swp
13
+ constraints-mxdev.txt
14
+ constraints.txt
15
+ instance
16
+ requirements-mxdev.txt
17
+ requirements.lock
18
+ requirements.txt
@@ -1,9 +1,85 @@
1
1
  # Changelog
2
+ <!--
3
+ You should *NOT* be adding new change log entries to this file.
4
+ You should create a file in the news directory instead.
5
+ For helpful instructions, please see:
6
+ https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
7
+ -->
2
8
 
3
- ## 1.4.1 (2025-04-04)
9
+ <!-- towncrier release notes start -->
4
10
 
11
+ ## 2.0.0 (2025-05-15)
5
12
 
6
- - Restore compatibility with Plone 6.0.15. Fixes [#97](https://github.com/collective/pas.plugins.authomatic/issues/97). @ale-rt
13
+
14
+ ### Internal:
15
+
16
+ - GHA: Use plone/meta shared workflows. @ericof [#102](https://github.com/collective/pas.plugins.authomatic/issues/102)
17
+
18
+
19
+ ### Documentation:
20
+
21
+ - Update README file with release instructions. @ericof
22
+
23
+ ## 2.0.0rc3 (2025-04-11)
24
+
25
+
26
+ ### Bug fixes:
27
+
28
+ - Fix walrus operator usage to correctly assign authomatic_cfg() result [#100](https://github.com/collective/pas.plugins.authomatic/issues/100)
29
+
30
+ ## 2.0.0rc2 (2025-04-03)
31
+
32
+
33
+ ### Bug fixes:
34
+
35
+ - Add missing `plone.api` dependency. @mauritsvanrees [#95](https://github.com/collective/pas.plugins.authomatic/issues/95)
36
+
37
+ ## 2.0.0rc1 (2025-03-27)
38
+
39
+
40
+ ### New features:
41
+
42
+ - - Documented integration with Microsoft Entra ID @alecghica [#87](https://github.com/collective/pas.plugins.authomatic/issues/87)
43
+
44
+
45
+ ### Internal:
46
+
47
+ - Add suuport to Python 3.13 @ericof [#89](https://github.com/collective/pas.plugins.authomatic/issues/89)
48
+ - Use UV to manage the environment @ericof [#90](https://github.com/collective/pas.plugins.authomatic/issues/90)
49
+ - Update .vscode configuration @ericof [#91](https://github.com/collective/pas.plugins.authomatic/issues/91)
50
+ - GHA: Update workflows. @ericof [#92](https://github.com/collective/pas.plugins.authomatic/issues/92)
51
+ - Use pytest-plone 1.0.0a1 @ericof [#93](https://github.com/collective/pas.plugins.authomatic/issues/93)
52
+
53
+ ## 2.0.0b3 (2025-02-03)
54
+
55
+
56
+ ### New features:
57
+
58
+ - Register the adapter as needed by the @login endpoint present in plone.restapi @erral [#73](https://github.com/collective/pas.plugins.authomatic/issues/73)
59
+
60
+
61
+ ### Internal:
62
+
63
+ - Require plone.restapi higher than 9.10.0 [@ericof]
64
+
65
+ ## 2.0.0b2 (2025-01-14)
66
+
67
+
68
+ ### Internal:
69
+
70
+ - Move CHANGELOG.md entries to CHANGES.md [@ericof] [#84](https://github.com/collective/pas.plugins.authomatic/issues/84)
71
+ - Document release process [@ericof] [#85](https://github.com/collective/pas.plugins.authomatic/issues/85)
72
+ - Rename logging.py to log.py [@ericof] [#86](https://github.com/collective/pas.plugins.authomatic/issues/86)
73
+
74
+ ## 2.0.0b1 (2025-01-14)
75
+
76
+
77
+ ### Internal:
78
+
79
+ - Modernize package repository [@ericof] [#71](https://github.com/collective/pas.plugins.authomatic/issues/71)
80
+ - Move tests to pytest [@ericof] [#72](https://github.com/collective/pas.plugins.authomatic/issues/72)
81
+ - Drop Plone 5.2 support [@ericof] [#80](https://github.com/collective/pas.plugins.authomatic/issues/80)
82
+ - Update i18n mechanism, update Brazilian Portuguese translation [@ericof] [#82](https://github.com/collective/pas.plugins.authomatic/issues/82)
7
83
 
8
84
 
9
85
  ## 1.4.0 (2024-12-13)
@@ -1,3 +1,7 @@
1
- Maintainer is [Jens Klein](https://github.com/jensens)
1
+ # Maintainers
2
2
 
3
+ * [Érico Andrei](https://github.com/ericof)
4
+ * [Jens Klein](https://github.com/jensens)
5
+
6
+ # Contributors
3
7
  Several people helped to make this package work see [GitHub](https://github.com/collective/pas.plugins.authomatic/graphs/contributors) for the whole list.
@@ -1,65 +1,55 @@
1
- Metadata-Version: 2.2
1
+ Metadata-Version: 2.4
2
2
  Name: pas.plugins.authomatic
3
- Version: 1.4.1
3
+ Version: 2.0.0
4
4
  Summary: Provides OAuth2/OpenID login for Plone using Authomatic.
5
- Home-page: https://github.com/collective/pas.plugins.authomatic
6
- Author: Jens Klein, Matthias Dollfuss, and Érico Andrei
7
- Author-email: dev@bluedynamics.com
8
- License: GPL
9
- Project-URL: Repository, https://github.com/collective/pas.plugins.authomatic/
10
5
  Project-URL: Changelog, https://github.com/collective/pas.plugins.authomatic/blob/main/CHANGELOG.md
6
+ Project-URL: Homepage, https://github.com/collective/pas.plugins.authomatic
11
7
  Project-URL: Issues, https://github.com/collective/pas.plugins.authomatic/issues
12
- Keywords: Python Plone PAS OAuth Authentication
8
+ Project-URL: Repository, https://github.com/collective/pas.plugins.authomatic/
9
+ Author: Matthias Dollfuss
10
+ Author-email: Jens Klein <dev@bluedynamics.com>, Érico Andrei <ericof@plone.org>
11
+ License: GNU General Public License v2 (GPLv2)
12
+ License-File: LICENSE.txt
13
+ Keywords: Authentication,OAuth,PAS,Plone,Python
13
14
  Classifier: Development Status :: 5 - Production/Stable
14
15
  Classifier: Environment :: Web Environment
15
- Classifier: Framework :: Plone :: 5.2
16
+ Classifier: Framework :: Plone
16
17
  Classifier: Framework :: Plone :: 6.0
18
+ Classifier: Framework :: Plone :: 6.1
17
19
  Classifier: Framework :: Plone :: Addon
18
- Classifier: Framework :: Plone
19
- Classifier: Framework :: Zope :: 5
20
20
  Classifier: Framework :: Zope
21
+ Classifier: Framework :: Zope :: 5
21
22
  Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
23
+ Classifier: Programming Language :: Python
22
24
  Classifier: Programming Language :: Python :: 3 :: Only
23
- Classifier: Programming Language :: Python :: 3.7
24
- Classifier: Programming Language :: Python :: 3.8
25
- Classifier: Programming Language :: Python :: 3.9
26
25
  Classifier: Programming Language :: Python :: 3.10
27
26
  Classifier: Programming Language :: Python :: 3.11
28
27
  Classifier: Programming Language :: Python :: 3.12
29
- Classifier: Programming Language :: Python
30
- Requires-Python: >=3.7
31
- Description-Content-Type: text/markdown
32
- License-File: LICENSE.txt
28
+ Classifier: Programming Language :: Python :: 3.13
29
+ Requires-Python: >=3.10
33
30
  Requires-Dist: authomatic>=1.3.0
34
- Requires-Dist: Products.CMFPlone>=5.2
35
- Requires-Dist: plone.restapi
36
- Requires-Dist: setuptools
31
+ Requires-Dist: plone-api
32
+ Requires-Dist: plone-restapi>=9.10.0
33
+ Requires-Dist: products-cmfplone>=6.0
37
34
  Provides-Extra: test
38
- Requires-Dist: collective.MockMailHost; extra == "test"
39
- Requires-Dist: parameterized; extra == "test"
40
- Requires-Dist: plone.app.testing; extra == "test"
41
- Requires-Dist: plone.restapi[test]; extra == "test"
42
- Requires-Dist: plone.app.robotframework[debug]; extra == "test"
43
- Requires-Dist: zest.releaser[recommended]; extra == "test"
44
- Dynamic: author
45
- Dynamic: author-email
46
- Dynamic: classifier
47
- Dynamic: description
48
- Dynamic: description-content-type
49
- Dynamic: home-page
50
- Dynamic: keywords
51
- Dynamic: license
52
- Dynamic: project-url
53
- Dynamic: provides-extra
54
- Dynamic: requires-dist
55
- Dynamic: requires-python
56
- Dynamic: summary
57
-
58
-
59
- <div align="center"><img alt="logo" src="https://raw.githubusercontent.com/collective/pas.plugins.authomatic/main/docs/authomatic.svg" width="70" /></div>
35
+ Requires-Dist: collective-mockmailhost; extra == 'test'
36
+ Requires-Dist: plone-app-robotframework[debug]; extra == 'test'
37
+ Requires-Dist: plone-app-testing; extra == 'test'
38
+ Requires-Dist: plone-restapi[test]; extra == 'test'
39
+ Requires-Dist: pytest-cov; extra == 'test'
40
+ Requires-Dist: pytest-plone>=1.0.0a1; extra == 'test'
41
+ Requires-Dist: zest-releaser[recommended]; extra == 'test'
42
+ Requires-Dist: zest-releaser[recommended]>=9.5.0; extra == 'test'
43
+ Requires-Dist: zestreleaser-towncrier>=1.3.0; extra == 'test'
44
+ Description-Content-Type: text/markdown
45
+
46
+ <div align="center">
60
47
 
48
+ <img alt="logo" src="https://raw.githubusercontent.com/collective/pas.plugins.authomatic/main/docs/authomatic.svg" width="70" />
61
49
  <h1 align="center">OAuth2 / OpenId Authentication in Plone</h1>
62
50
 
51
+ </div>
52
+
63
53
  <div align="center">
64
54
 
65
55
  [![PyPI](https://img.shields.io/pypi/v/pas.plugins.authomatic)](https://pypi.org/project/pas.plugins.authomatic/)
@@ -71,8 +61,7 @@ Dynamic: summary
71
61
 
72
62
  [![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pas.plugins.authomatic)](https://pypi.org/project/pas.plugins.authomatic/)
73
63
 
74
- [![Code analysis checks](https://github.com/collective/pas.plugins.authomatic/actions/workflows/code-analysis.yml/badge.svg)](https://github.com/collective/pas.plugins.authomatic/actions/workflows/code-analysis.yml)
75
- [![Tests](https://github.com/collective/pas.plugins.authomatic/actions/workflows/tests.yaml/badge.svg)](https://github.com/collective/pas.plugins.authomatic/actions/workflows/tests.yaml)
64
+ [![CI](https://github.com/collective/pas.plugins.authomatic/actions/workflows/main.yml/badge.svg)](https://github.com/collective/pas.plugins.authomatic/actions/workflows/main.yml)
76
65
  ![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
77
66
 
78
67
  [![GitHub contributors](https://img.shields.io/github/contributors/collective/pas.plugins.authomatic)](https://github.com/collective/pas.plugins.authomatic)
@@ -80,8 +69,7 @@ Dynamic: summary
80
69
 
81
70
  </div>
82
71
 
83
- Features
84
- --------
72
+ ## Features
85
73
 
86
74
  **pas.plugins.authomatic** provides OAuth2 and OpenID login capability for Plone sites by integrating the awesome [Authomatic](https://authomatic.github.io/authomatic/) package.
87
75
 
@@ -95,13 +83,11 @@ through standards like OAuth and OpenID.
95
83
  ```
96
84
  *by author Peter Hudec on Authomatic website*
97
85
 
98
-
99
- Supported Providers
100
- -------------------
86
+ ### Supported Providers
101
87
 
102
88
  Out of the box, **pas.plugins.authomatic** supports the following providers
103
89
 
104
- *OAuth 1.0a*
90
+ #### OAuth 1.0
105
91
 
106
92
  - Bitbucket
107
93
  - Flickr
@@ -115,7 +101,7 @@ Out of the box, **pas.plugins.authomatic** supports the following providers
115
101
  - Xing
116
102
  - Yahoo
117
103
 
118
- *OAuth 2.0*
104
+ #### OAuth 2.0
119
105
 
120
106
  - Amazon
121
107
  - Behance
@@ -136,33 +122,57 @@ Out of the box, **pas.plugins.authomatic** supports the following providers
136
122
  - Yammer
137
123
  - Yandex
138
124
 
139
- *OpenID*
125
+ #### OpenID
140
126
 
141
127
  - python-openid
142
128
  - Google App Engine based OpenID.
143
129
 
144
130
 
145
- Documentation
146
- -------------
131
+ ## Documentation
147
132
 
148
133
  This package supports Plone sites using Volto or the Classic UI.
149
134
 
150
- For the Classic UI:
151
-
152
- - This package creates a view called `authomatic-handler` where you can login with different providers.
153
- - The view can be used as well to add an identity from a provider to an existing account.
154
- - The provider is choosen in the URL so if you call `/authomatic-handler/PROVIDER` you will use PROVIDER to login.
155
-
156
- For Volto:
135
+ ### Volto Frontend
157
136
 
158
137
  - Endpoint `@login` with GET: Returns list of authentication options
159
138
  - Endpoint `@login-authomatic` with GET: Provide information to start the OAuth process.
160
139
  - Endpoint `@login-authomatic` with POST: Handles OAuth login and returns a JSON web token (JWT).
161
140
  - For Volto sites you must also install [@plone-collective/volto-authomatic](https://github.com/collective/volto-authomatic).
141
+ - Plugin configuration is available in the Control-panel `/controlpanel/authomatic` (linked under users)
142
+ - Example JSON configuration (first level key is the PROVIDER):
162
143
 
144
+ ```json
145
+ {
146
+ "github": {
147
+ "display": {
148
+ "title": "Github",
149
+ "cssclasses": {
150
+ "button": "plone-btn plone-btn-default",
151
+ "icon": "glypicon glyphicon-github"
152
+ },
153
+ "as_form": false
154
+ },
155
+ "propertymap": {
156
+ "email": "email",
157
+ "link": "home_page",
158
+ "location": "location",
159
+ "name": "fullname"
160
+ },
161
+ "class_": "authomatic.providers.oauth2.GitHub",
162
+ "consumer_key": "5c4901d141e736f114a7",
163
+ "consumer_secret": "d4692ca3c0ab6cc1f8b28d3ccb1ea15b61e7ef5c",
164
+ "access_headers": {
165
+ "User-Agent": "Plone Authomatic Plugin"
166
+ }
167
+ },
168
+ }
169
+ ```
163
170
 
164
- Configuration is, currently, done via Classic UI:
171
+ ### Classic UI
165
172
 
173
+ - This package creates a view called `authomatic-handler` where you can login with different providers.
174
+ - The view can be used as well to add an identity from a provider to an existing account.
175
+ - The provider is choosen in the URL so if you call `/authomatic-handler/PROVIDER` you will use PROVIDER to login.
166
176
  - Plugin configuration is available in the Controlpanel `@@authomatic-controlpanel` (linked under users)
167
177
  - Example JSON configuration (first level key is the PROVIDER):
168
178
 
@@ -193,8 +203,7 @@ Configuration is, currently, done via Classic UI:
193
203
  }
194
204
  ```
195
205
 
196
- Installation
197
- ------------
206
+ ## Installation
198
207
 
199
208
  Add **pas.plugins.authomatic** to the Plone installation using `pip`:
200
209
 
@@ -214,8 +223,7 @@ or add it as a dependency on your package's `setup.py`
214
223
 
215
224
  Start Plone and activate the plugin in the addons control-panel.
216
225
 
217
- Configuration
218
- -------------
226
+ ## Configuration
219
227
 
220
228
  Using Classic UI, go to the `Authomatic` controlpanel.
221
229
 
@@ -240,31 +248,31 @@ There are some differences in configuration:
240
248
  - Each provider can get an optional entry `propertymap`.
241
249
  It is a mapping from authomatic/provider user properties to plone user properties, like `"fullname": "name",`. Look at each providers documentation which properties are available.
242
250
 
251
+ ## Integration with Entra ID
243
252
 
244
- Source Code and Contributions
245
- -----------------------------
253
+ Enumeration PAS plugin: if you're using **pas.plugins.authomatic** with *Microsoft Entra ID*, we recommend pairing it with [pas.plugins.eea](https://github.com/eea/pas.plugins.eea) for proper user enumeration and metadata synchronization. This complementary plugin enables listing all the Entra ID users and groups and is compatible with both Plone 5 and Plone 6.
254
+
255
+ ## Source Code and Contributions
246
256
 
247
257
  If you want to help with the development (improvement, update, bug-fixing, ...) of `pas.plugins.authomatic` this is a great idea!
248
258
 
249
259
  - [Issue Tracker](https://github.com/collective/pas.plugins.authomatic/issues)
250
260
  - [Source Code](https://github.com/collective/pas.plugins.authomatic/)
251
261
 
252
-
253
262
  Please do larger changes on a branch and submit a Pull Request.
254
263
 
255
264
  Creator of **pas.plugins.authomatic** is Jens Klein.
256
265
 
257
266
  We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.
258
267
 
259
- Development
260
- -----------
268
+ ### Development
261
269
 
262
270
  You need a working `python` environment (system, virtualenv, pyenv, etc) version 3.7 or superior.
263
271
 
264
272
  Then install the dependencies and a development instance using:
265
273
 
266
274
  ```bash
267
- make build
275
+ make install
268
276
  ```
269
277
 
270
278
  To run tests for this package:
@@ -273,194 +281,47 @@ To run tests for this package:
273
281
  make test
274
282
  ```
275
283
 
276
- By default we use the latest Plone version in the 6.x series.
277
-
278
- License
279
- -------
280
-
281
- The project is licensed under the GPLv2.
282
-
283
-
284
- # Changelog
285
-
286
- ## 1.4.1 (2025-04-04)
287
-
288
-
289
- - Restore compatibility with Plone 6.0.15. Fixes [#97](https://github.com/collective/pas.plugins.authomatic/issues/97). @ale-rt
290
-
291
-
292
- ## 1.4.0 (2024-12-13)
293
-
294
-
295
- - Patch `authomatic.providers.BaseProvider._fetch` to support Python 3.12 @ericof.
296
-
297
-
298
- ## 1.3.0 (2024-11-21)
299
-
300
- - Search users by fullname and email. @alecghica
301
- - Fix login on Volto frontend when already logged-in in Plone Classic. @avoinea
302
- - Add the possibility to override the ZopeRequestAdapter.
303
- - Fix the authomatic view when it is reporting an exception that does not have a message attribute
304
-
305
-
306
- ## 1.2.0 (2023-09-13)
284
+ To lint the codebase:
307
285
 
308
- - Add Spanish translation. @macagua
309
-
310
- - Better handle values from identity data. @cekk
311
-
312
- - Add `username_userid` User ID factory. @ericof
313
-
314
- - Annotate transaction in POST calls to authenticate a user. @ericof
315
-
316
-
317
- ## 1.1.2 (2023-03-15)
318
-
319
- - Support Python 3.11 for Plone 6. @ericof
320
-
321
- - Lint fixes @ericof
322
-
323
-
324
- ## 1.1.1 (2022-10-14)
325
-
326
- - Upgrade plone/code-analysis-action to version 2. @ericof
327
-
328
- - Fix packaging issue related to CHANGELOG.md not being included in the source package. @ericof
329
-
330
- - Support Python 3.10 for Plone 6. @ericof
331
-
332
-
333
- ## 1.1.0 (2022-10-10)
334
-
335
- - Add the plone.restapi adapter to show the controlpanel in Volto. @erral
336
-
337
- - Add possibility to redirect to `next_url` via provided cookie @avoinea
338
-
339
-
340
- ## 1.0.0 (2022-07-25)
341
-
342
- - Use plone/plone-setup GitHub Action. @ericof
343
-
344
- - Add Brazilian Portuguese translation. @ericof
345
-
346
- - Use plone/code-analysis-action GitHub Action for code analysis. @ericof
347
-
348
- - Fix doChangeUser takes 2 positional arguments but 3 were given @avoinea
349
-
350
- ## 1.0b2 (2021-08-18)
351
-
352
- - Fix tox setup, move CI from TravisCI to GitHub Actions. @jensens
353
-
354
- - Code Style Black, Isort, zpretty and Pyupgrade applied. @jensens
355
-
356
- - Add missing no-op methods for IUserManagement to plugin.
357
- This fixes the tests. @jensens
358
-
359
- - Drop Python 2 support and so require Plone 5.2. @jensens
360
-
361
- - Include permissions from CMFCore to avoid ComponentLookupError. @bsuttor
362
-
363
- - Fixed ModuleNotFoundError: No module named 'App.class_init' on Zope 5. @bsuttor
364
-
365
- - Add french translation @mpeeters
366
-
367
- - PAS event notification IPrincipalCreatedEvent. @jensens
368
-
369
- - Python 3 and Plone 52 compatibility. @cekk
370
-
371
- - Fix #44: Fullfill strictly exact_match when enumerating users @allusa
372
-
373
- - Allow users deletion. @cekk
374
-
375
- - Drop Plone < 5.1.x compatibility. @cekk
376
-
377
- - Fix #54: Notification of PrincipalCreated event. @ericof
378
-
379
- - Closes #55: Support plone.restapi. @ericof
380
-
381
- ## 1.0b1 (2017-11-20)
382
-
383
- - Slighly beautify login modal. @jensens
384
-
385
- - Fix #33" Page does not exist Control Settings. @jensens
386
-
387
- - Fix #31: Link is broken to JSON configuration documentation in help text. @jensens
388
-
389
- - Fix #28: After uninstall plone.external_login_url is still registered and the login broken. @jensens
390
-
391
- - Support for Plone 5.1 tested (worked, ust control-panel icon needed some tweak).
392
- Buildout configuration for 5.1 added. @jensens
393
-
394
- - Install: Hide non-valid profiles at install form. @jensens
395
-
396
- - Additional checks to ensure to never have an empty/None key stored. @jensens
397
-
398
- - Fix #27: Update user data after login. @jensens
399
-
400
- - Fix filter users bug in enumerateUsers plugin where it was always returning
401
- all the users. @sneridagh
402
-
403
- - fix typo and wording of login message @tkimnguyen
404
-
405
-
406
- ## 1.0a7 (2016-02-15)
407
-
408
- - Workaround for None users. @sneridagh
409
-
410
-
411
- ## 1.0a6 (2016-01-11)
412
-
413
- - Fix #21: When you logout and then login again, a new user is created. @jensens
414
-
415
-
416
- ## 1.0a5 (2015-12-04)
417
-
418
- - Fix: #18 "Provider Login" option for "Generator for Plone User ID" seems
419
- broken @jensens
420
-
421
- - Fix: Title indicates if an identity is added @jensens
422
-
423
- - Fix: Correct usage of plone.protect @jensens
424
-
425
-
426
- ## 1.0a4 (2015-11-20)
427
-
428
- - Added german translation @jensens
429
-
430
- - Restored Plone 4 compatibility @keul
431
-
432
- - Added italian translation @keul
433
-
434
- - Proper uninstall @keul
286
+ ```bash
287
+ make lint
288
+ ```
435
289
 
436
- ## 1.0a3 (2015-11-15)
290
+ By default we use the latest Plone version in the 6.x series.
437
291
 
438
- - Refactor authomatic-handler to enable adding identities. @jensens
292
+ ### Changelog entries
439
293
 
440
- - Fix: use secret from settings as secret for Authomatic. @jensens
294
+ The `CHANGES.md` file is managed using [towncrier](https://towncrier.readthedocs.io/). All non trivial changes must be accompanied by an entry in the `news` directory. Using such a tool instead of editing the file directly, has the following benefits:
441
295
 
442
- - Renamed view ``authomatic-login`` to ``authomatic-handler``, because this
443
- view will be used to add an identity too (url must be registered on provider
444
- side sometimes and we want to do this only once). @jensens
296
+ * It avoids merge conflicts in CHANGES.md.
297
+ * It avoids news entries ending up under the wrong version header.
445
298
 
299
+ The best way of adding news entries is this:
446
300
 
447
- ## 1.0a2 (2015-11-14)
301
+ * First create an issue describing the change you want to make. The issue number serves as a unique indicator for the news entry. As example, let's say you have created issue 42.
448
302
 
449
- - Minimal validation of JSON. @jensens
303
+ * Create a file inside of the news/ directory, named after that issue number:
450
304
 
451
- - Make the whole ``remember`` procedure a ``safeWrite`` if called from login
452
- view. We can not pass a authenticator token here, because of redirects and
453
- expected return urls . @jensens
305
+ * For bug fixes: 42.bugfix.
306
+ * For new features: 42.feature.
307
+ * For internal changes: 42.internal.
308
+ * For breaking changs: 42.breaking.
309
+ * Any other extensions are ignored.
454
310
 
455
- - Allow selection of user id generator strategy. @jensens
311
+ * The contents of this file should be markdown formatted text that will be used as the content of the CHANGES.md entry.
456
312
 
457
- - Allow multiple services for one user. This changes a lot behind the scenes. @jensens
313
+ Towncrier will automatically add a reference to the issue when rendering the CHANGES.md file.
458
314
 
459
- - Use authomatic.core.User attributes instead of raw provider data. closes [#9](https://github.com/collective/pas.plugins.authomatic/issues/9) @ericof
315
+ ### Releasing `pas.plugins.authomatic`
460
316
 
317
+ Releasing `pas.plugins.authomatic` is done using a combination of [zest.releaser](https://zestreleaser.readthedocs.io/) and [hatch](https://hatch.pypa.io/latest/).
461
318
 
462
- ## 1.0a1 (2015-10-28)
319
+ To release the package run:
463
320
 
464
- - Initial release.
321
+ ```bash
322
+ make release
323
+ ```
465
324
 
325
+ ## License
466
326
 
327
+ The project is licensed under the GPLv2.