passportd 2.0.0__tar.gz

passportd-2.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

passportd-2.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include passportd/templates *
+recursive-include passportd/static *

passportd-2.0.0/PKG-INFO

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: passportd
+Version: 2.0.0
+Summary: Unified login module for my personal application
+Home-page: https://github.com/staugur/passportd
+Author: Hiroshi.tao
+Author-email: me@tcw.im
+License: Apache-2.0
+Project-URL: Code, https://github.com/staugur/passportd
+Project-URL: Issue tracker, https://github.com/staugur/passportd/issues
+Project-URL: Documentation, https://passportd.readthedocs.io/
+Project-URL: Releases, https://github.com/staugur/passportd/releases
+Keywords: sso,auth,signup,signin
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Flask
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask==3.1.3
+Requires-Dist: Flask-PluginKit==3.10.2
+Requires-Dist: peewee[psycopg3]==4.2.6
+Requires-Dist: peewee[mysql]==4.2.6
+Requires-Dist: shortuuid==1.0.13
+Requires-Dist: authlib==1.7.2
+Requires-Dist: joserfc==1.7.4
+Requires-Dist: requests==2.34.2
+Requires-Dist: redis==5.3.1
+Requires-Dist: typing_extensions>=4.0.0; python_version < "3.11"
+Requires-Dist: gunicorn==26.0.0
+Requires-Dist: gevent==26.7.0
+Requires-Dist: setproctitle==1.3.7
+
+# passportd
+
+认证、授权、统一登录 — 基于 Flask 的 SSO 单点登录服务。
+
+[![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-passportd.readthedocs.io-brightgreen)](https://passportd.readthedocs.io/)
+[![codecov](https://codecov.io/gh/staugur/passportd/branch/master/graph/badge.svg)](https://codecov.io/gh/staugur/passportd)
+
+## 核心功能
+
+- **本地账号系统**：支持用户名、手机号、邮箱注册与登录
+- **OAuth2 第三方登录**：内置 GitHub 和 Gitee OAuth2 登录插件
+- **OpenID Connect Provider**：支持 OIDC Server 模式，可作为独立 SSO 服务
+- **插件扩展**：基于 Flask-PluginKit 的插件架构，方便扩展更多登录方式
+- **多数据库支持**：SQLite（开发） / MySQL / PostgreSQL（生产）
+- **JWT 认证**：支持 HMAC-SHA256 和 RS256 双算法 JWT 签名
+- **RESTful API**：提供完整的注册、登录、用户信息、OIDC 客户端管理接口
+
+## 快速开始
+
+### pip 安装
+
+```shell
+# 安装
+pip install passportd
+
+# 确保 Redis 已启动
+
+# 启动
+passportd run
+```
+
+访问 http://localhost:10030/ 即可看到登录页面。
+
+### Docker 运行
+
+```shell
+# 拉取镜像
+docker pull staugur/passportd:latest
+
+# 启动容器（需要先启动 Redis）
+docker run -d \
+  --name passportd \
+  -p 10030:10030 \
+  -e PASSPORT_REDIS_URI="redis://:pwd@redis:6379/0" \
+  -e PASSPORT_DB_URI="sqlite:///app/data/passportd.db" \
+  -e PASSPORT_ENV="production" \
+  -v passportd-data:/app/data \
+  staugur/passportd:latest
+```
+
+也可以通过 `docker-compose.yml` 一键启动（包含 Redis）：
+
+```yaml
+version: "3.8"
+services:
+  redis:
+    image: redis:7-alpine
+    restart: unless-stopped
+    volumes:
+      - redis-data:/data
+
+  passportd:
+    image: staugur/passportd:latest
+    restart: unless-stopped
+    ports:
+      - "10030:10030"
+    environment:
+      - PASSPORT_ENV=production
+      - PASSPORT_REDIS_URI=redis://redis:6379/0
+      - PASSPORT_DB_URI=sqlite:///app/data/passportd.db
+    volumes:
+      - passportd-data:/app/data
+    depends_on:
+      - redis
+
+volumes:
+  redis-data:
+  passportd-data:
+```
+
+## 文档
+
+完整文档请访问 [passportd.readthedocs.io](https://passportd.readthedocs.io/)
+
+本地构建文档：
+
+```shell
+pip install -r requirements/docs.txt
+cd docs && make html
+```
+
+## 许可证
+
+Apache License 2.0
+
+## 备注
+
+沿用 1.x 设计思路，使用 OIDC 标准协议重构实现，除核心代码外大部分使用 AI 生成。

passportd-2.0.0/README.md

@@ -0,0 +1,100 @@
+# passportd
+
+认证、授权、统一登录 — 基于 Flask 的 SSO 单点登录服务。
+
+[![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-passportd.readthedocs.io-brightgreen)](https://passportd.readthedocs.io/)
+[![codecov](https://codecov.io/gh/staugur/passportd/branch/master/graph/badge.svg)](https://codecov.io/gh/staugur/passportd)
+
+## 核心功能
+
+- **本地账号系统**：支持用户名、手机号、邮箱注册与登录
+- **OAuth2 第三方登录**：内置 GitHub 和 Gitee OAuth2 登录插件
+- **OpenID Connect Provider**：支持 OIDC Server 模式，可作为独立 SSO 服务
+- **插件扩展**：基于 Flask-PluginKit 的插件架构，方便扩展更多登录方式
+- **多数据库支持**：SQLite（开发） / MySQL / PostgreSQL（生产）
+- **JWT 认证**：支持 HMAC-SHA256 和 RS256 双算法 JWT 签名
+- **RESTful API**：提供完整的注册、登录、用户信息、OIDC 客户端管理接口
+
+## 快速开始
+
+### pip 安装
+
+```shell
+# 安装
+pip install passportd
+
+# 确保 Redis 已启动
+
+# 启动
+passportd run
+```
+
+访问 http://localhost:10030/ 即可看到登录页面。
+
+### Docker 运行
+
+```shell
+# 拉取镜像
+docker pull staugur/passportd:latest
+
+# 启动容器（需要先启动 Redis）
+docker run -d \
+  --name passportd \
+  -p 10030:10030 \
+  -e PASSPORT_REDIS_URI="redis://:pwd@redis:6379/0" \
+  -e PASSPORT_DB_URI="sqlite:///app/data/passportd.db" \
+  -e PASSPORT_ENV="production" \
+  -v passportd-data:/app/data \
+  staugur/passportd:latest
+```
+
+也可以通过 `docker-compose.yml` 一键启动（包含 Redis）：
+
+```yaml
+version: "3.8"
+services:
+  redis:
+    image: redis:7-alpine
+    restart: unless-stopped
+    volumes:
+      - redis-data:/data
+
+  passportd:
+    image: staugur/passportd:latest
+    restart: unless-stopped
+    ports:
+      - "10030:10030"
+    environment:
+      - PASSPORT_ENV=production
+      - PASSPORT_REDIS_URI=redis://redis:6379/0
+      - PASSPORT_DB_URI=sqlite:///app/data/passportd.db
+    volumes:
+      - passportd-data:/app/data
+    depends_on:
+      - redis
+
+volumes:
+  redis-data:
+  passportd-data:
+```
+
+## 文档
+
+完整文档请访问 [passportd.readthedocs.io](https://passportd.readthedocs.io/)
+
+本地构建文档：
+
+```shell
+pip install -r requirements/docs.txt
+cd docs && make html
+```
+
+## 许可证
+
+Apache License 2.0
+
+## 备注
+
+沿用 1.x 设计思路，使用 OIDC 标准协议重构实现，除核心代码外大部分使用 AI 生成。

passportd-2.0.0/passportd/app.py

@@ -0,0 +1,141 @@
+# -*- coding: utf-8 -*-
+"""
+Copyright 2021 Hiroshi.tao
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from .basis.common import auto_create_data_dir, raise_version
+from .utils.common import auto_init_rsa_key
+
+__author__ = "Hiroshi.tao <me@tcw.im>"
+__date__ = "2021-06-25"
+
+raise_version()
+auto_create_data_dir()
+auto_init_rsa_key()
+
+
+def create_app():
+    """创建并配置 Flask 应用实例。
+
+    初始化应用的核心组件，包括：
+    - 配置加载与代理信任
+    - 蓝图注册（根路由、插件管理器）
+    - OAuth2 客户端和 OIDC 服务端初始化
+    - 插件加载（GitHub、Gitee OAuth2）
+    - 请求前后处理钩子（数据库连接、用户状态解析、错误处理）
+
+    :returns: 配置完成的 Flask 应用实例
+    :rtype: flask.Flask
+    """
+    from flask import Flask, g, request, jsonify, render_template
+    from flask_pluginkit import PluginManager, JsonResponse, blueprint
+    from werkzeug.middleware.proxy_fix import ProxyFix
+
+    from .basis.vars import PROC_NAME
+    from .basis.conf import config
+    from .basis.errors import ApiError
+    from .basis.common import is_true, new_res
+    from .utils.common import logger
+    from .utils.web import parse_user_state
+    from .models.model import db
+    from .views.root import root
+    from .views.oidc import server as OIDCServer
+    from .libs.oidc import OIDCClient, oidc_save_token
+    from .libs.interface import OAuthClient
+
+    try:
+        from setproctitle import setproctitle
+
+        setproctitle(PROC_NAME)
+    except ImportError:
+        pass
+
+    app = Flask(__name__)
+    app.response_class = JsonResponse
+    app.config.update(config)
+    if is_true(config.get("TRUST_PROXY")):
+        app.wsgi_app = ProxyFix(app.wsgi_app, x_proto=1, x_for=1)
+    app.register_blueprint(root, url_prefix=config.get("URI_PREFIX"))
+    app.register_blueprint(blueprint, url_prefix="/pluginmanager")
+
+    OAuthClient.init_app(app)
+    OIDCServer.init_app(
+        app,
+        query_client=lambda client_id: OIDCClient(client_id),
+        save_token=oidc_save_token,
+    )
+    PluginManager(
+        app,
+        plugin_packages=(
+            "passportd.modules.oauth2_github",
+            "passportd.modules.oauth2_gitee",
+            "passportd.modules.oauth2_weibo",
+            "passportd.modules.oauth2_qq",
+        ),  # type: ignore
+    )
+
+    @app.before_request
+    def br():
+        """在每个请求前解析用户登录态。"""
+        #: 每个请求从连接池获取一个数据库连接，复用当前线程已有连接。
+        db.connect(reuse_if_open=True)
+        #: signin:bool -- 用户是否已登录
+        #: user:dict  -- uid, account 等用户信息
+        g.signin, g.user = parse_user_state()
+
+    @app.after_request
+    def ar(response):
+        """在每个响应后追加 CORS 头，允许 Authorization 请求头跨域访问。"""
+        response.headers["Access-Control-Allow-Headers"] = "Authorization"
+        return response
+
+    @app.teardown_request
+    def _db_close(exc=None):
+        """请求结束后将连接归还连接池，确保不泄露。"""
+        if not db.is_closed():
+            db.close()
+
+    @app.errorhandler(500)
+    @app.errorhandler(404)
+    @app.errorhandler(403)
+    def handle_error(e):
+        """统一 HTTP 错误处理：500 记录日志，API 返回 JSON，页面返回 error.j2 模板。
+
+        :param e: HTTP 异常对象
+        :type e: werkzeug.exceptions.HTTPException
+        :returns: JSON 响应（API 路径）或 HTML 错误页面
+        """
+        if getattr(e, "code", None) == 500:
+            logger.error(e, exc_info=True)
+        code = e.code
+        name = e.name
+        if "/api/" in request.path:
+            return jsonify(new_res()), code
+        else:
+            return render_template("error.j2", code=code, name=name), code
+
+    @app.errorhandler(ApiError)
+    def handle_api_error(e):
+        """捕获 ApiError 异常，返回结构化 JSON 错误响应。
+
+        :param e: ApiError 异常实例
+        :type e: passportd.basis.errors.ApiError
+        :returns: JSON 错误响应
+        """
+        response = jsonify(e.to_dict())
+        response.status_code = e.status_code
+        return response
+
+    return app