README

auth-iduffs

一个PHP包，用于通过idUFFS进行用户认证，该idUFFS属于南联邦大学。除了提供认证外，它还提供有关已认证用户的信息，如全名、CPF等。

✨特性

通过HTTPS使用id.uffs.edu.br端点进行认证；
不需要令牌或API授权；
获取用户信息（姓名、CPF等）；

🚀使用方法

1. 将包添加到您的项目中

在PHP项目的根目录中，运行

composer require ccuffs/auth-iduffs

将安装所有依赖项。

2. 认证用户

要认证用户，您将使用AuthIdUFFS类，并传入user和password值，它们分别是用户的idUFFS和密码。

信息通过关联数组传递给login()方法

$auth = new CCUFFS\Auth\AuthIdUFFS();

$info = $auth->login([
    'user'     => 'meuIdUFFS',
    'password' => 'minhaSenha'
]);

如果提供的凭据有效，则login()方法返回一个具有以下属性的对象

object(stdClass)
  public 'username' => string
  public 'uid' => string
  public 'email' => string
  public 'pessoa_id' => string
  public 'name' => string
  public 'cpf' => string
  public 'location' => string
  public 'token_id' => string 
  public 'authenticated' => boolean

如果凭据无效（用户或密码错误），则login()方法返回null。

👩‍💻开发

如果您打算创建新功能、修复错误等，请按照以下步骤操作。

克隆存储库

git clone https://github.com/ccuffs/auth-iduffs && cd auth-iduffs

安装依赖项

git clone https://github.com/ccuffs/auth-iduffs && cd auth-iduffs

实现所需的任何内容，并运行测试

./vendor/bin/pest

其中一个测试（有效用户认证）需要一个有效的idUFFS和密码。您可以通过环境变量AUTH_IDUFFS_TEST_USERNAME和AUTH_IDUFFS_TEST_PASSWORD分别提供这些值。

如果未提供这些环境变量，则应只有一个测试失败。其他测试应通过。

🤝贡献

您的帮助非常受欢迎，无论形式如何！请查看CONTRIBUTING.md文件，了解所有贡献项目的方式。例如，建议新功能、报告问题/错误、发送pull request，或者简单地使用该项目并评论您的体验。

🎫许可证

该项目根据MIT开源许可证许可，并且免费提供。

🧬变更日志

查看该项目的所有更改CHANGELOG.md文件。

ccuffs / auth-iduffs

维护者

详细信息