README

Tornado Auth PHP

PHP中Tornado Web身份验证的实现。

入门指南

首先，您需要安装 composer。之后，运行 composer 的 require 命令以将包安装为项目的依赖项。

composer require jusbrasil/tornado-auth-php

用法

命名空间

use Jusbrasil\TornadoAuthPhp\TornadoAuthPhpLib;

configure ( array[string] mixed $options ) : void

• max_age_days - 签名有效的天数。
• user_cookie - Cookie的名称。
• secret_key - 用于解密已签名值的密钥。

$auth = new TornadoAuthPhpLib([
  'max_age_days' => 2,      // [optional] default: (int) 31
  'user_cookie' => 'oreo',  // [optional] default: (string) user
  'secret_key' => 'shhhh',  // [required]
]);

// void

createSignedValue ( mixed $value ) : string

签名传入的值。

$signedValue = $auth->createSignedValue(['cypher' => 'morpheus']);

// string(80) "eyJjeXBoZXIiOiJtb3JwaGV1cyJ9|1564713616|ca4f8c77f23f120578e742199b12df21f6039ce3"

createSignedCookie( string $cookieName, mixed $value ) : string

签名传入的值。

$signedCookie = $auth->createSignedCookie('oreo', ['cypher' => 'morpheus']);

// string(80) "eyJjeXBoZXIiOiJtb3JwaGV1cyJ9|1564713616|07143659017c55c004108de1e8b3867a8a5a889d"

decodeSignedValue ( string $secret, string $name, string $value [, int $maxAgeDays ] ) : string

将已签名的值解码为字符串。

$decodedSignedValue = $auth->decodeSignedValue('shhhh', 'oreo', $signedValue);

// string(21) "{"cypher":"morpheus"}"

getSecureCookie ( string $cookieName, string $value [, int $maxAgeDays ] ) : object

$secureCookie = $auth->getSecureCookie('oreo', $signedValue);

// class stdClass {
//   public $cypher => string(8) "morpheus"
// }

getCurrentUser ( mixed $value [, int $maxAgeDays ] ) : object

$currentUser = $auth->getCurrentUser($signedValue);

// class stdClass {
//   public $cypher => string(8) "morpheus"
// }

贡献

请阅读 CONTRIBUTING.md 以了解我们的行为准则以及向我们提交拉取请求的过程。

先决条件

• Docker
• Docker Compose

安装

克隆存储库

git clone git@github.com:jusbrasil/tornado-auth-php.git

设置开发环境

docker-compose up -d --build

访问容器

docker-compose exec app ash

或者，直接运行您想要的命令（例如）

docker-compose exec app php src/index.php

版本控制

我们使用 SemVer 进行版本控制。给定版本号 MAJOR.MINOR.PATCH，增加

1. MAJOR 重大更改或属于同一范围的定义功能组
2. MINOR 新功能或重构现有功能
3. PATCH 修复错误或改进最新稳定版本中的某个功能

有关可用的版本，请参阅 此存储库的标签。

构建工具

• PHP v7.3.8 - 超文本预处理器
• Composer v1.9.0 - PHP依赖管理器

许可证

此项目采用 MIT 许可证 - 请参阅 LICENSE 文件以获取详细信息

致谢

• 基于 tornado-auth-js