README

hideout-php

Vecode Hideout 的 PHP SDK

这是一个用于与 Vecode Hideout 服务器交互的精简库，因此您必须有一个工作实例才能使用此库。

要开始使用，您需要配置服务器并添加一个客户端，以便获取客户端令牌，如果您需要更多信息，请参阅其相应文档。

同时，请记住始终使用 https 连接到 Vecode Hideout 实例。

安装

首先使用 Composer 需求 vecode/hideout-php。

基本用法

现在使用 newInstance 方法获取 Hideout 的实例，并设置服务器位置和客户端令牌

use Hideout\Hideout;

$server = 'https://hideout.my-server.com';
$token = 'xxxxx.yyyyyyyyyyyyy';

$hideout = Hideout::newInstance()
  ->setServer($server)
  ->setToken($token);

一旦您有了 Hideout 对象，您就可以开始与服务器交互。

生成密钥

除了客户端令牌外，您还需要一个密钥（或多个密钥）来存储和检索服务器上的机密，因此有一个方便的端点来获取有效的密钥。

只需调用 generate 方法即可

use Hideout\Hideout;

$server = 'https://hideout.my-server.com';
$token = 'xxxxx.yyyyyyyyyyyyy';

$hideout = Hideout::newInstance()
  ->setServer($server)
  ->setToken($token);

$key = $hideout->generate();

一旦您得到了密钥，就必须将其保存在安全的地方。例如，您可以将其设置为环境变量，以便以后使用。

永远不要将其存储在可以从网络访问的公共目录中。

存储机密

有了密钥，您可以使用 store 方法创建机密，传递 key 和机密 data

use Hideout\Hideout;

$server = 'https://hideout.my-server.com';
$token = 'xxxxx.yyyyyyyyyyyyy';
$key = getenv('my_secret_key');

$hideout = Hideout::newInstance()
  ->setServer($server)
  ->setToken($token);

$data = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. Beatae atque officiis natus voluptatum debitis sunt.';
$entry = $hideout->store($key, $data); // $entry would be 'xxxxxyyyyzzz' for example

在这种情况下，您将收到存储在服务器上的机密的 entry 标识符。使用此标识符，您可以在以后检索它。

检索机密

要获取机密，请调用 retrieve 方法，这次您必须传递 key 和 entry 标识符

use Hideout\Hideout;

$server = 'https://hideout.my-server.com';
$token = 'xxxxx.yyyyyyyyyyyyy';
$key = getenv('my_secret_key');

$hideout = Hideout::newInstance()
  ->setServer($server)
  ->setToken($token);

$entry = 'xxxxxyyyyzzz';
$data = $hideout->retrieve($key, $entry); // $data would be 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. Beatae atque officiis natus voluptatum debitis sunt.'

然后您将收到原始数据。

删除机密

还可以通过调用带有 entry 标识符的 delete 方法删除任何机密

use Hideout\Hideout;

$server = 'https://hideout.my-server.com';
$token = 'xxxxx.yyyyyyyyyyyyy';

$hideout = Hideout::newInstance()
  ->setServer($server)
  ->setToken($token);

$entry = 'xxxxxyyyyzzz';
$hideout->delete($entry); // Just returns TRUE or FALSE

故障排除

最常见的问题是 https。此库使用 biohzrdmx/curly-php，并且需要一个正确配置的服务器才能工作。请参阅其文档以获取更多信息。

否则，请打开一个问题，我们将乐意帮助您。

许可

此软件根据 MIT 许可证发布。

特此授予任何获得此软件及其相关文档副本（“软件”）的人，免费使用软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，以及允许软件的提供方进行此类操作的人员，但需遵守以下条件

致谢

主程序员：biohzrdmx github.com/biohzrdmx

vecode / hideout-php

维护者

详细信息