mdwheele/incommon

InCommon证书管理器的PHP客户端

0.1.0 2014-09-04 12:19 UTC

This package is auto-updated.

Last update: 2024-09-07 01:40:01 UTC


README

InCommon证书管理器SSL Web服务API的PHP客户端

Latest Stable Version Total Downloads License

注意:目前这是一个alpha版本的软件。请不要在生产环境中使用!!

此客户端在InCommon证书管理器SSL SOAP Web服务之上提供了一个抽象访问层。

目标

  • 在客户端应用程序和InCommon CM API之间创建一个“障碍”,以便更改不会影响客户端。
  • 标准化所需的命令格式和响应,使其更具用户故事驱动,而不是机械的。

本软件包符合 PSR-1PSR-2PSR-4 规范。如果您发现规范不符合之处,请通过pull request发送补丁。

安装

通过Composer

{
    "require": {
        "mdwheele/incommon": "0.1.*"
    }
}

要求

此版本支持以下版本的PHP。

  • PHP 5.3
  • PHP 5.4
  • PHP 5.5

文档

很快就会有更多文档。在此之前,这些都是基本的。

// Create new InCommon API client.
$incommon = new InCommon();

// Submit a CSR.
try {
    $response = $incommon->certs->enroll(...args);
}
catch (InvalidUsernameException $e) {
    // Handle business.
}

...

// Check status of request.
$sslId = $response->getSSLID();

try {
    $response = $incommon->certs->getCollectStatus(...args, $sslId);
}
catch (PermissionDeniedException $e) {
    // Handle business.
}

if ($response->getStatus() == SSLCollectResponse::BEING_PROCESSED_BY_COMODO) {
    echo "Still waiting for Comodo!";
}

待办事项

  • 实现与CM服务文档1:1匹配的公共证书API。
  • 清理公共API,使其更具帮助性。
  • 清理响应/命令格式。
  • 基于 PHP-VCR 实现完整的测试套件,以便无需生产SOAP服务。

测试

$ phpunit

贡献

欢迎贡献,并将得到完全的认可。

我们通过 Github 上的Pull Requests接受贡献。

拉取请求

  • PSR-2编码规范 - 应用规范的最简单方法是安装 PHP Code Sniffer

  • 添加测试! - 如果您的补丁没有测试,则不会接受。

  • 记录任何行为变化 - 确保README和任何其他相关文档都保持最新。

  • 考虑我们的发布周期 - 我们尝试遵循semver。随机破坏公共API不是选项。

  • 创建主题分支 - 请不要要求我们从您的master分支中拉取。

  • 每个功能一个拉取请求 - 如果您想做更多的事情,请发送多个拉取请求。

  • 发送连贯的历史记录 - 确保您拉取请求中的每个单独提交都有意义。如果您在开发过程中必须做出多个中间提交,请在提交之前将它们压缩。

运行测试

$ phpunit

快乐的编码!

致谢

许可证

MIT许可证(MIT)。请参阅 许可证文件 了解更多信息。