pas.plugins.authomatic 1.4.0__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.0 → pas_plugins_authomatic-2.0.0}/CHANGELOG.md +82 -0
  3. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/CONTRIBUTORS.md +5 -1
  4. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/PKG-INFO +108 -218
  5. {pas.plugins.authomatic-1.4.0 → 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.0 → 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.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/controlpanel.py +1 -2
  13. {pas.plugins.authomatic-1.4.0 → 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.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/integration/restapi.py +1 -3
  16. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/interfaces.py +1 -2
  17. pas.plugins.authomatic-1.4.0/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.0 → 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.0 → 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.0 → 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.0 → 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.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/pas.plugins.authomatic.pot +27 -19
  24. {pas.plugins.authomatic-1.4.0 → 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.0 → 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.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/patches/authomatic.py +16 -12
  27. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/plugin.py +22 -24
  28. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/authomatic.py +1 -1
  29. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/configure.zcml +3 -6
  30. pas_plugins_authomatic-2.0.0/src/pas/plugins/authomatic/services/login.py +35 -0
  31. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/testing.py +15 -18
  32. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/useridentities.py +1 -1
  33. {pas.plugins.authomatic-1.4.0 → 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.0/.coveragerc +0 -7
  49. pas.plugins.authomatic-1.4.0/.editorconfig +0 -36
  50. pas.plugins.authomatic-1.4.0/MANIFEST.in +0 -5
  51. pas.plugins.authomatic-1.4.0/Makefile +0 -116
  52. pas.plugins.authomatic-1.4.0/pyproject.toml +0 -44
  53. pas.plugins.authomatic-1.4.0/requirements.txt +0 -1
  54. pas.plugins.authomatic-1.4.0/setup.cfg +0 -4
  55. pas.plugins.authomatic-1.4.0/setup.py +0 -76
  56. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/browser/add_plugin.pt +0 -28
  57. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/browser/authomatic.pt +0 -49
  58. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/integration/__init__.py +0 -2
  59. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/locales/pas.plugins.authomatic-manual.pot +0 -21
  60. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/services/login.py +0 -40
  61. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/mocks.py +0 -27
  62. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_browser_controlpanel.py +0 -75
  63. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_plugin.py +0 -123
  64. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_services_authomatic.py +0 -53
  65. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_services_login.py +0 -28
  66. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_setup.py +0 -44
  67. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_setuphandler.py +0 -48
  68. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_upgrades.py +0 -40
  69. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_useridentities.py +0 -156
  70. pas.plugins.authomatic-1.4.0/src/pas/plugins/authomatic/tests/test_useridfactories.py +0 -26
  71. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/PKG-INFO +0 -437
  72. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/SOURCES.txt +0 -83
  73. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/dependency_links.txt +0 -1
  74. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/entry_points.txt +0 -5
  75. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/namespace_packages.txt +0 -2
  76. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/not-zip-safe +0 -1
  77. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/requires.txt +0 -12
  78. pas.plugins.authomatic-1.4.0/src/pas.plugins.authomatic.egg-info/top_level.txt +0 -1
  79. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/LICENSE.txt +0 -0
  80. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/docs/authomatic.svg +0 -0
  81. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/docs/plone-control-panel.png +0 -0
  82. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/docs/plugin-settings.png +0 -0
  83. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/__init__.py +0 -0
  84. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/__init__.py +0 -0
  85. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/__init__.py +0 -0
  86. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/authomatic.png +0 -0
  87. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/configure.zcml +0 -0
  88. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic-logo.svg +0 -0
  89. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic.css +0 -0
  90. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/browser/resources/authomatic.less +0 -0
  91. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/configure.zcml +0 -0
  92. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/integration/zope.py +0 -0
  93. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/locales/__init__.py +0 -0
  94. /pas.plugins.authomatic-1.4.0/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.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/meta.zcml +0 -0
  96. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/patches/__init__.py +0 -0
  97. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/browserlayer.xml +0 -0
  98. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/controlpanel.xml +0 -0
  99. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/metadata.xml +0 -0
  100. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/default/registry.xml +0 -0
  101. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/browserlayer.xml +0 -0
  102. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/controlpanel.xml +0 -0
  103. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles/uninstall/registry.xml +0 -0
  104. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/profiles.zcml +0 -0
  105. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/services/__init__.py +0 -0
  106. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/setuphandlers.py +0 -0
  107. {pas.plugins.authomatic-1.4.0 → pas_plugins_authomatic-2.0.0}/src/pas/plugins/authomatic/utils.py +0 -0
  108. /pas.plugins.authomatic-1.4.0/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,4 +1,86 @@
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
+ -->
8
+
9
+ <!-- towncrier release notes start -->
10
+
11
+ ## 2.0.0 (2025-05-15)
12
+
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)
83
+
2
84
 
3
85
  ## 1.4.0 (2024-12-13)
4
86
 
@@ -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,42 +1,55 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: pas.plugins.authomatic
3
- Version: 1.4.0
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
28
+ Classifier: Programming Language :: Python :: 3.13
29
+ Requires-Python: >=3.10
30
+ Requires-Dist: authomatic>=1.3.0
31
+ Requires-Dist: plone-api
32
+ Requires-Dist: plone-restapi>=9.10.0
33
+ Requires-Dist: products-cmfplone>=6.0
32
34
  Provides-Extra: test
33
- License-File: LICENSE.txt
34
-
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
35
45
 
36
- <div align="center"><img alt="logo" src="https://raw.githubusercontent.com/collective/pas.plugins.authomatic/main/docs/authomatic.svg" width="70" /></div>
46
+ <div align="center">
37
47
 
48
+ <img alt="logo" src="https://raw.githubusercontent.com/collective/pas.plugins.authomatic/main/docs/authomatic.svg" width="70" />
38
49
  <h1 align="center">OAuth2 / OpenId Authentication in Plone</h1>
39
50
 
51
+ </div>
52
+
40
53
  <div align="center">
41
54
 
42
55
  [![PyPI](https://img.shields.io/pypi/v/pas.plugins.authomatic)](https://pypi.org/project/pas.plugins.authomatic/)
@@ -48,8 +61,7 @@ License-File: LICENSE.txt
48
61
 
49
62
  [![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/pas.plugins.authomatic)](https://pypi.org/project/pas.plugins.authomatic/)
50
63
 
51
- [![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)
52
- [![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)
53
65
  ![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)
54
66
 
55
67
  [![GitHub contributors](https://img.shields.io/github/contributors/collective/pas.plugins.authomatic)](https://github.com/collective/pas.plugins.authomatic)
@@ -57,8 +69,7 @@ License-File: LICENSE.txt
57
69
 
58
70
  </div>
59
71
 
60
- Features
61
- --------
72
+ ## Features
62
73
 
63
74
  **pas.plugins.authomatic** provides OAuth2 and OpenID login capability for Plone sites by integrating the awesome [Authomatic](https://authomatic.github.io/authomatic/) package.
64
75
 
@@ -72,13 +83,11 @@ through standards like OAuth and OpenID.
72
83
  ```
73
84
  *by author Peter Hudec on Authomatic website*
74
85
 
75
-
76
- Supported Providers
77
- -------------------
86
+ ### Supported Providers
78
87
 
79
88
  Out of the box, **pas.plugins.authomatic** supports the following providers
80
89
 
81
- *OAuth 1.0a*
90
+ #### OAuth 1.0
82
91
 
83
92
  - Bitbucket
84
93
  - Flickr
@@ -92,7 +101,7 @@ Out of the box, **pas.plugins.authomatic** supports the following providers
92
101
  - Xing
93
102
  - Yahoo
94
103
 
95
- *OAuth 2.0*
104
+ #### OAuth 2.0
96
105
 
97
106
  - Amazon
98
107
  - Behance
@@ -113,33 +122,57 @@ Out of the box, **pas.plugins.authomatic** supports the following providers
113
122
  - Yammer
114
123
  - Yandex
115
124
 
116
- *OpenID*
125
+ #### OpenID
117
126
 
118
127
  - python-openid
119
128
  - Google App Engine based OpenID.
120
129
 
121
130
 
122
- Documentation
123
- -------------
131
+ ## Documentation
124
132
 
125
133
  This package supports Plone sites using Volto or the Classic UI.
126
134
 
127
- For the Classic UI:
128
-
129
- - This package creates a view called `authomatic-handler` where you can login with different providers.
130
- - The view can be used as well to add an identity from a provider to an existing account.
131
- - The provider is choosen in the URL so if you call `/authomatic-handler/PROVIDER` you will use PROVIDER to login.
132
-
133
- For Volto:
135
+ ### Volto Frontend
134
136
 
135
137
  - Endpoint `@login` with GET: Returns list of authentication options
136
138
  - Endpoint `@login-authomatic` with GET: Provide information to start the OAuth process.
137
139
  - Endpoint `@login-authomatic` with POST: Handles OAuth login and returns a JSON web token (JWT).
138
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):
139
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
+ ```
140
170
 
141
- Configuration is, currently, done via Classic UI:
171
+ ### Classic UI
142
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.
143
176
  - Plugin configuration is available in the Controlpanel `@@authomatic-controlpanel` (linked under users)
144
177
  - Example JSON configuration (first level key is the PROVIDER):
145
178
 
@@ -170,8 +203,7 @@ Configuration is, currently, done via Classic UI:
170
203
  }
171
204
  ```
172
205
 
173
- Installation
174
- ------------
206
+ ## Installation
175
207
 
176
208
  Add **pas.plugins.authomatic** to the Plone installation using `pip`:
177
209
 
@@ -191,8 +223,7 @@ or add it as a dependency on your package's `setup.py`
191
223
 
192
224
  Start Plone and activate the plugin in the addons control-panel.
193
225
 
194
- Configuration
195
- -------------
226
+ ## Configuration
196
227
 
197
228
  Using Classic UI, go to the `Authomatic` controlpanel.
198
229
 
@@ -217,31 +248,31 @@ There are some differences in configuration:
217
248
  - Each provider can get an optional entry `propertymap`.
218
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.
219
250
 
251
+ ## Integration with Entra ID
252
+
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.
220
254
 
221
- Source Code and Contributions
222
- -----------------------------
255
+ ## Source Code and Contributions
223
256
 
224
257
  If you want to help with the development (improvement, update, bug-fixing, ...) of `pas.plugins.authomatic` this is a great idea!
225
258
 
226
259
  - [Issue Tracker](https://github.com/collective/pas.plugins.authomatic/issues)
227
260
  - [Source Code](https://github.com/collective/pas.plugins.authomatic/)
228
261
 
229
-
230
262
  Please do larger changes on a branch and submit a Pull Request.
231
263
 
232
264
  Creator of **pas.plugins.authomatic** is Jens Klein.
233
265
 
234
266
  We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.
235
267
 
236
- Development
237
- -----------
268
+ ### Development
238
269
 
239
270
  You need a working `python` environment (system, virtualenv, pyenv, etc) version 3.7 or superior.
240
271
 
241
272
  Then install the dependencies and a development instance using:
242
273
 
243
274
  ```bash
244
- make build
275
+ make install
245
276
  ```
246
277
 
247
278
  To run tests for this package:
@@ -250,188 +281,47 @@ To run tests for this package:
250
281
  make test
251
282
  ```
252
283
 
253
- By default we use the latest Plone version in the 6.x series.
254
-
255
- License
256
- -------
257
-
258
- The project is licensed under the GPLv2.
259
-
260
-
261
- # Changelog
262
-
263
- ## 1.4.0 (2024-12-13)
264
-
265
-
266
- - Patch `authomatic.providers.BaseProvider._fetch` to support Python 3.12 @ericof.
267
-
268
-
269
- ## 1.3.0 (2024-11-21)
270
-
271
- - Search users by fullname and email. @alecghica
272
- - Fix login on Volto frontend when already logged-in in Plone Classic. @avoinea
273
- - Add the possibility to override the ZopeRequestAdapter.
274
- - Fix the authomatic view when it is reporting an exception that does not have a message attribute
275
-
276
-
277
- ## 1.2.0 (2023-09-13)
278
-
279
- - Add Spanish translation. @macagua
280
-
281
- - Better handle values from identity data. @cekk
284
+ To lint the codebase:
282
285
 
283
- - Add `username_userid` User ID factory. @ericof
284
-
285
- - Annotate transaction in POST calls to authenticate a user. @ericof
286
-
287
-
288
- ## 1.1.2 (2023-03-15)
289
-
290
- - Support Python 3.11 for Plone 6. @ericof
291
-
292
- - Lint fixes @ericof
293
-
294
-
295
- ## 1.1.1 (2022-10-14)
296
-
297
- - Upgrade plone/code-analysis-action to version 2. @ericof
298
-
299
- - Fix packaging issue related to CHANGELOG.md not being included in the source package. @ericof
300
-
301
- - Support Python 3.10 for Plone 6. @ericof
302
-
303
-
304
- ## 1.1.0 (2022-10-10)
305
-
306
- - Add the plone.restapi adapter to show the controlpanel in Volto. @erral
307
-
308
- - Add possibility to redirect to `next_url` via provided cookie @avoinea
309
-
310
-
311
- ## 1.0.0 (2022-07-25)
312
-
313
- - Use plone/plone-setup GitHub Action. @ericof
314
-
315
- - Add Brazilian Portuguese translation. @ericof
316
-
317
- - Use plone/code-analysis-action GitHub Action for code analysis. @ericof
318
-
319
- - Fix doChangeUser takes 2 positional arguments but 3 were given @avoinea
320
-
321
- ## 1.0b2 (2021-08-18)
322
-
323
- - Fix tox setup, move CI from TravisCI to GitHub Actions. @jensens
324
-
325
- - Code Style Black, Isort, zpretty and Pyupgrade applied. @jensens
326
-
327
- - Add missing no-op methods for IUserManagement to plugin.
328
- This fixes the tests. @jensens
329
-
330
- - Drop Python 2 support and so require Plone 5.2. @jensens
331
-
332
- - Include permissions from CMFCore to avoid ComponentLookupError. @bsuttor
333
-
334
- - Fixed ModuleNotFoundError: No module named 'App.class_init' on Zope 5. @bsuttor
335
-
336
- - Add french translation @mpeeters
337
-
338
- - PAS event notification IPrincipalCreatedEvent. @jensens
339
-
340
- - Python 3 and Plone 52 compatibility. @cekk
341
-
342
- - Fix #44: Fullfill strictly exact_match when enumerating users @allusa
343
-
344
- - Allow users deletion. @cekk
345
-
346
- - Drop Plone < 5.1.x compatibility. @cekk
347
-
348
- - Fix #54: Notification of PrincipalCreated event. @ericof
349
-
350
- - Closes #55: Support plone.restapi. @ericof
351
-
352
- ## 1.0b1 (2017-11-20)
353
-
354
- - Slighly beautify login modal. @jensens
355
-
356
- - Fix #33" Page does not exist Control Settings. @jensens
357
-
358
- - Fix #31: Link is broken to JSON configuration documentation in help text. @jensens
359
-
360
- - Fix #28: After uninstall plone.external_login_url is still registered and the login broken. @jensens
361
-
362
- - Support for Plone 5.1 tested (worked, ust control-panel icon needed some tweak).
363
- Buildout configuration for 5.1 added. @jensens
364
-
365
- - Install: Hide non-valid profiles at install form. @jensens
366
-
367
- - Additional checks to ensure to never have an empty/None key stored. @jensens
368
-
369
- - Fix #27: Update user data after login. @jensens
370
-
371
- - Fix filter users bug in enumerateUsers plugin where it was always returning
372
- all the users. @sneridagh
373
-
374
- - fix typo and wording of login message @tkimnguyen
375
-
376
-
377
- ## 1.0a7 (2016-02-15)
378
-
379
- - Workaround for None users. @sneridagh
380
-
381
-
382
- ## 1.0a6 (2016-01-11)
383
-
384
- - Fix #21: When you logout and then login again, a new user is created. @jensens
385
-
386
-
387
- ## 1.0a5 (2015-12-04)
388
-
389
- - Fix: #18 "Provider Login" option for "Generator for Plone User ID" seems
390
- broken @jensens
391
-
392
- - Fix: Title indicates if an identity is added @jensens
393
-
394
- - Fix: Correct usage of plone.protect @jensens
395
-
396
-
397
- ## 1.0a4 (2015-11-20)
398
-
399
- - Added german translation @jensens
400
-
401
- - Restored Plone 4 compatibility @keul
402
-
403
- - Added italian translation @keul
404
-
405
- - Proper uninstall @keul
286
+ ```bash
287
+ make lint
288
+ ```
406
289
 
407
- ## 1.0a3 (2015-11-15)
290
+ By default we use the latest Plone version in the 6.x series.
408
291
 
409
- - Refactor authomatic-handler to enable adding identities. @jensens
292
+ ### Changelog entries
410
293
 
411
- - 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:
412
295
 
413
- - Renamed view ``authomatic-login`` to ``authomatic-handler``, because this
414
- view will be used to add an identity too (url must be registered on provider
415
- 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.
416
298
 
299
+ The best way of adding news entries is this:
417
300
 
418
- ## 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.
419
302
 
420
- - Minimal validation of JSON. @jensens
303
+ * Create a file inside of the news/ directory, named after that issue number:
421
304
 
422
- - Make the whole ``remember`` procedure a ``safeWrite`` if called from login
423
- view. We can not pass a authenticator token here, because of redirects and
424
- 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.
425
310
 
426
- - 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.
427
312
 
428
- - 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.
429
314
 
430
- - 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`
431
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/).
432
318
 
433
- ## 1.0a1 (2015-10-28)
319
+ To release the package run:
434
320
 
435
- - Initial release.
321
+ ```bash
322
+ make release
323
+ ```
436
324
 
325
+ ## License
437
326
 
327
+ The project is licensed under the GPLv2.