claromentis/opauth

PHP 多提供方认证框架

1.0.3 2022-07-14 16:36 UTC

README

Opauth 是一个用于 PHP 的多提供方认证框架。

Opauth 使 PHP 应用程序能够轻松地执行 用户认证

http://opauth.org 尝试 Opauth。

关于 1.0.x 的说明

1.0.x 目前处于预览发布状态,尚未用于生产。有关详细信息,请参阅 发布说明

Opauth API 和功能已全部准备好供评估。请尝试使用,并告诉我们您的想法。

1.0.x 与 0.x 不兼容。有关如何迁移 Opauth 0.x 应用程序和策略的说明,请参阅 迁移指南

有关当前稳定版本,请参阅 0.4.x

Build Status Coverage Status

什么是 Opauth?

Opauth 为 PHP 应用程序和身份验证提供方之间提供了一个标准化的接口。

作为框架,Opauth 提供了一套 API,允许开发者 创建策略,这些策略可以在 PHP 框架和应用程序之间以可预测的方式工作。

Opauth 与其他 PHP 应用程序和框架配合良好。

快速入门

  1. 使用 Composer 安装 Opauth 核心和 Opauth 策略。将以下内容添加到应用程序的 composer.json

    {
        "minimum-stability": "dev",
        "require": {
            "opauth/opauth": "~1.0",
            "opauth/facebook": "~1.0"
        }
    }

    注意:虽然 Opauth 1.0.x 仍在开发中,但您的根 composer.json 需要将最小稳定性设置为 dev

    安装它们

    $ composer install
  2. 配置 Opauth。
    创建一个名为 opauth.php 的文件,该文件可通过 http://localhost/opauth.php/ 访问。

    <?php
    $config = array(
        'Strategy' => array(
            'Facebook' => array(
                'app_id' => 'YOUR APP ID',
                'app_secret' => 'YOUR APP SECRET'
            )
        ),
        'path' => '/opauth.php/'
    );
  3. 实例化和运行 Opauth

    <?php
    $Opauth = new Opauth\Opauth\Opauth($config);
    
    try {
        $response = $Opauth->run();
        echo "Authed as " . $response->name . " with uid" . $response->uid;
    } catch (OpauthException $e) {
        echo "Authentication error: " . $e->getMessage();
    }
  4. 将浏览器指向 http://localhost/opauth.php/facebook 以查看其工作情况。

参考资料

有关更多信息,请参阅 Opauth 文档

要求

核心贡献者

  1. U-Zyn Chua (@uzyn on GitHub & Twitter)
  2. Marc Ypes (@ceeram on GitHub & Twitter)

欢迎您为 Opauth 做出贡献

  • 请随意提交拉取请求。
  • 如果您编写了新的策略、新的插件或用 Opauth 做了任何酷炫的事情,请通过 讨论组 和/或 @opauth 通知 Opauth 社区。
  • 加入我们,在 Freenode 的 #opauth 上进行任何讨论:Freenode

问题 & 问题

许可

MIT 许可证
版权所有 © 2012-2014 U-Zyn Chua (http://uzyn.com)

致谢

  • OmniAuth for Ruby – 启发 Opauth 的项目。
  • Homenaje – Opauth 标志的字体。由 Constanza Artigas Preller 和 Agustina Mingote 设计。SIL 开放字体许可,1.1 版本。