pas.plugins.oidc 1.0a6__tar.gz → 2.0.0b1__tar.gz

pas.plugins.oidc-2.0.0b1/.coveragerc

@@ -0,0 +1,9 @@
+[run]
+relative_files = True
+
+[report]
+include =
+    */src/pas/*
+omit =
+    */test*
+    */upgrades/*

pas.plugins.oidc-2.0.0b1/.pre-commit-config.yaml

@@ -0,0 +1,100 @@
+# Generated from:
+# https://github.com/plone/meta/tree/main/config/default
+# See the inline comments on how to expand/tweak this configuration file
+ci:
+    autofix_prs: false
+    autoupdate_schedule: monthly
+
+repos:
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.2
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+-   repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+    -   id: black
+-   repo: https://github.com/collective/zpretty
+    rev: 3.1.0
+    hooks:
+    -   id: zpretty
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  zpretty_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+    -   id: flake8
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  flake8_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+    -   id: codespell
+        additional_dependencies:
+          - tomli
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  codespell_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.49"
+    hooks:
+    -   id: check-manifest
+-   repo: https://github.com/regebro/pyroma
+    rev: "4.2"
+    hooks:
+    -   id: pyroma
+-   repo: https://github.com/mgedmin/check-python-versions
+    rev: "0.22.0"
+    hooks:
+    -   id: check-python-versions
+        args: ['--only', 'setup.py,pyproject.toml']
+-   repo: https://github.com/collective/i18ndude
+    rev: "6.2.0"
+    hooks:
+    -   id: i18ndude
+
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  i18ndude_extra_lines = """
+#  _your own configuration lines_
+#  """
+##
+
+- repo: https://github.com/PyCQA/bandit
+  rev: '1.7.5'
+  hooks:
+  - id: bandit
+    args: ["-c", "pyproject.toml"]
+    additional_dependencies: ["bandit[toml]"]
+
+##
+# Add extra configuration options in .meta.toml:
+#  [pre_commit]
+#  extra_lines = """
+#  _your own configuration lines_
+#  """
+##

pas.plugins.oidc-2.0.0b1/CHANGES.md

@@ -0,0 +1,104 @@
+# 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 -->
+
+## 2.0.0b1 (2024-06-25)
+
+
+### New features:
+
+- Added Deutsch translation
+  [@macagua] [#45](https://github.com/collective/pas.plugins.oidc/issues/45)
+- Allow multiple instances of OIDC plugin in a given Plone site @erral [#48](https://github.com/collective/pas.plugins.oidc/issues/48)
+- Notify user events on creation and authentication. [@Arkusm][@ericof] [#53](https://github.com/collective/pas.plugins.oidc/issues/53)
+- Updated the latest .po templates for translate
+  Updated Spanish translation
+  [@macagua] [#55](https://github.com/collective/pas.plugins.oidc/issues/55)
+
+
+### Internal:
+
+- Update configuration files @plone 
+
+
+### Documentation:
+
+- Recommend using `[pas.plugins.keycloakgroups](https://pypi.org/project/pas.plugins.keycloakgroups/)` for groups support with Keycloak [@ericof] [#42](https://github.com/collective/pas.plugins.oidc/issues/42)
+
+
+## 2.0.0a1 (2023-11-23)
+
+
+### New features:
+
+- Implement [plone/meta](https://github.com/plone/meta) and convert documentation to Markdown [@ericof] [#32](https://github.com/collective/pas.plugins.oidc/issues/32)
+- Drop support to Python 2.7 and Plone 5.2 [@ericof] [#33](https://github.com/collective/pas.plugins.oidc/issues/33)
+- Implement restapi services to handle authentication flow [@ericof] [#38](https://github.com/collective/pas.plugins.oidc/issues/38)
+
+
+### Internal:
+
+- Rewrite tests from unittest to pytest with [pytest-plone](https://pypi.org/project/pytest-plone/) [@ericof] [#34](https://github.com/collective/pas.plugins.oidc/issues/34)
+- Allow dict instances to hold userinfo [@erral] [#35](https://github.com/collective/pas.plugins.oidc/issues/35)
+- Declare the minimum requirements for Plone/python in the readme [mamico] [#36](https://github.com/collective/pas.plugins.oidc/issues/36)
+
+
+## 1.0.0 (2023-11-11)
+
+- Allow dict instances to hold userinfo [@erral]
+
+## 1.0a6 (2023-07-20)
+
+- Added Spanish translation [@macagua]
+
+- Added improvements about i18n support [macagua]
+
+- Drop python 2.7 and Plone 4 support [@erral]
+
+- Add support for the post_logout parameter for logout api. [@ramiroluz]
+
+
+## 1.0a5 (2023-04-05)
+
+- Catch exceptions during the OAuth process [@erral]
+
+- Update the plugin to make challenges.
+  An anonymous user who visits a page for which you have to be authenticated,
+  is redirected to the new require_login view on the plugin.
+  This works the same way as the standard require_login page of Plone.
+  [@maurits]
+
+- Add a property for the default userinfo instead of using only sub. [@eikichi18]
+
+
+## 1.0a4 (2023-01-16)
+
+- Call getProperty only once when getting redirect_uris or scope. [@maurits]
+
+- use getProperty accessor [@mamico]
+
+
+## 1.0a3 (2022-10-30)
+
+- Removed the hardcoded auth cookie name [@alecghica]
+
+- Fixed Python compatibility with version >= 3.6 [@alecghica]
+
+- check if url is in portal before redirect #2 [@erral]
+
+- manage came_from [@mamico]
+
+## 1.0a2 (unreleased)
+
+- do userinforequest if there is a client.userinfo_endpoint [@mamico]
+
+## 1.0a1 (unreleased)
+
+- Initial release. [@mamico]

pas.plugins.oidc-1.0a6/CONTRIBUTORS.rst → pas.plugins.oidc-2.0.0b1/CONTRIBUTORS.md

@@ -1,7 +1,7 @@
-Contributors
-============
+# Contributors
 
 - mamico, mauro.amico@gmail.com
 - erral, Mikel Larreategi
 - alecghica, alec.ghica@eaudeweb.ro
 - macagua, leonardocaballero@gmail.com
+- ericof, ericof@plone.org

pas.plugins.oidc-2.0.0b1/MANIFEST.in

@@ -0,0 +1,15 @@
+graft src/pas
+graft docs
+global-exclude *.pyc
+include *.md
+include *.txt
+include *.yaml
+include .coveragerc
+include Makefile
+recursive-include tests *.py
+recursive-include tests *.gitkeep
+recursive-include tests *.json
+recursive-include tests *.yml
+recursive-exclude docs/_build *
+recursive-exclude docs/ .DS_Store
+include tests/keycloak/Dockerfile

pas.plugins.oidc-2.0.0b1/Makefile

@@ -0,0 +1,161 @@
+### Defensive settings for make:
+#     https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+.SHELLFLAGS:=-xeu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
+
+# We like colors
+# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
+RED=`tput setaf 1`
+GREEN=`tput setaf 2`
+RESET=`tput sgr0`
+YELLOW=`tput setaf 3`
+
+BACKEND_FOLDER=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+COMPOSE_FOLDER=${BACKEND_FOLDER}/tests
+DOCS_DIR=${BACKEND_FOLDER}/docs
+
+# Python checks
+PYTHON?=python3
+
+# installed?
+ifeq (, $(shell which $(PYTHON) ))
+  $(error "PYTHON=$(PYTHON) not found in $(PATH)")
+endif
+
+# version ok?
+PYTHON_VERSION_MIN=3.8
+PYTHON_VERSION_OK=$(shell $(PYTHON) -c "import sys; print((int(sys.version_info[0]), int(sys.version_info[1])) >= tuple(map(int, '$(PYTHON_VERSION_MIN)'.split('.'))))")
+ifeq ($(PYTHON_VERSION_OK),0)
+  $(error "Need python $(PYTHON_VERSION) >= $(PYTHON_VERSION_MIN)")
+endif
+
+all: build
+
+# Add the following 'help' target to your Makefile
+# And add help text after each target name starting with '\#\#'
+.PHONY: help
+help: ## This help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: clean
+clean: clean-build clean-pyc clean-test clean-venv clean-instance ## remove all build, test, coverage and Python artifacts
+
+.PHONY: clean-instance
+clean-instance: ## remove existing instance
+	rm -fr instance etc inituser var
+
+.PHONY: clean-venv
+clean-venv: ## remove virtual environment
+	rm -fr bin include lib lib64 env pyvenv.cfg .tox .pytest_cache requirements-mxdev.txt
+
+.PHONY: clean-build
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -rf {} +
+
+.PHONY: clean-pyc
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+.PHONY: clean-test
+clean-test: ## remove test and coverage artifacts
+	rm -f .coverage
+	rm -fr htmlcov/
+
+bin/pip bin/tox bin/mxdev:
+	@echo "$(GREEN)==> Setup Virtual Env$(RESET)"
+	$(PYTHON) -m venv .
+	bin/pip install -U "pip" "wheel" "cookiecutter" "mxdev" "tox"
+
+.PHONY: config
+config: bin/pip  ## Create instance configuration
+	@echo "$(GREEN)==> Create instance configuration$(RESET)"
+	bin/cookiecutter -f --no-input --config-file instance.yaml gh:plone/cookiecutter-zope-instance
+
+.PHONY: install-plone-6.0
+install-plone-6.0: config ## pip install Plone packages
+	@echo "$(GREEN)==> Setup Build$(RESET)"
+	bin/mxdev -c mx.ini
+	bin/pip install -r requirements-mxdev.txt
+
+.PHONY: install
+install: install-plone-6.0  ## Install Plone 6.0
+
+.PHONY: start
+start: ## Start a Plone instance on localhost:8080
+	PYTHONWARNINGS=ignore ./bin/runwsgi instance/etc/zope.ini
+
+.PHONY: console
+console: ## Console
+	PYTHONWARNINGS=ignore ./bin/zconsole debug instance/etc/zope.ini
+
+.PHONY: format
+format: bin/tox ## Format the codebase according to our standards
+	@echo "$(GREEN)==> Format codebase$(RESET)"
+	bin/tox -e format
+
+.PHONY: lint
+lint: bin/tox ## check code style
+	bin/tox -e lint
+
+# i18n
+bin/i18ndude bin/pocompile: bin/pip
+	@echo "$(GREEN)==> Install translation tools$(RESET)"
+	bin/pip install i18ndude zest.pocompile
+
+.PHONY: i18n
+i18n: bin/i18ndude ## Update locales
+	@echo "$(GREEN)==> Updating locales$(RESET)"
+	bin/update_locale
+	bin/pocompile src/
+
+# Tests
+.PHONY: test
+test: bin/tox ## run tests
+	bin/tox -e test
+
+.PHONY: test-coverage
+test-coverage: bin/tox ## run tests
+	bin/tox -e coverage
+
+# Keycloak
+.PHONY: keycloak-start
+keycloak-start: ## Start Keycloak stack
+	@echo "$(GREEN)==> Start keycloak stack$(RESET)"
+	@docker compose -f $(COMPOSE_FOLDER)/docker-compose.yml up -d
+
+.PHONY: keycloak-status
+keycloak-status: ## Check Keycloak stack status
+	@echo "$(GREEN)==> Check Keycloak stack status$(RESET)"
+	@docker compose -f $(COMPOSE_FOLDER)/docker-compose.yml ps
+
+.PHONY: keycloak-stop
+keycloak-stop: ## Stop Keycloak stack
+	@echo "$(GREEN)==> Stop Keycloak stack$(RESET)"
+	@docker compose -f $(COMPOSE_FOLDER)/docker-compose.yml down
+
+# Docs
+bin/sphinx-build: bin/pip
+	bin/pip install -r requirements-docs.txt
+
+.PHONY: build-docs
+build-docs: bin/sphinx-build  ## Build the documentation
+	./bin/sphinx-build \
+		-b html $(DOCS_DIR) "$(DOCS_DIR)/_build/html"
+
+.PHONY: livehtml
+livehtml: bin/sphinx-build  ## Rebuild Sphinx documentation on changes, with live-reload in the browser
+	./bin/sphinx-autobuild \
+		--ignore "*.swp" \
+		-b html $(DOCS_DIR) "$(DOCS_DIR)/_build/html"