ownprojects-info/check-point-management-api

Check Point Management API 的 PHP 库

dev-master 2021-05-07 23:08 UTC

This package is auto-updated.

Last update: 2024-09-08 06:12:16 UTC


README

需求

要使用 Check Point 管理API客户端,需要以下东西

  • 管理API应处于管理服务器上。
  • 用户名和密码或API密钥。

Composer 安装

入门

初始化客户端和登录。

// Management server with special port
$checkPointManagementApiClient = new \CheckPoint\ManagementApi\Client('127.0.0.1', 8080);

// Management server without port
$checkPointManagementApiClient = new \CheckPoint\ManagementApi\Client('127.0.0.1');

// Login with username and password
$loginResponse = $checkPointManagementApiClient->sessionManagement()->login([
    'user'     => 'admin',
    'password' => 'admin',
]);

// Login with API key
$loginResponse = $checkPointManagementApiClient->sessionManagement()->login([
    'api-key' => 'key',
]);

登录响应应返回如下内容

{
     "uid": "5fcaf9e8-cb8c-4d9e-91fd-58227c4f71e8",
     "sid": "ofsg1UcwLFQV2-XEKmnMeZ6iWaml06CJ3OAtfyv7Isp",
     "url": "https://host:port/web_api/v1.6",
     "session-timeout": 600,
     "last-login-was-at": {
       "posix": 1593377918896,
       "iso-8601": "2020-06-28T22:58+0200",
     },
     "api-server-version": "1.6",
}

会话令牌可以在登录响应中找到,即 'sid'。

请务必保存并设置会话令牌,以便稍后使用。

$sessionToken = $loginResponse->sid;
$checkPointManagementApiClient->setSessionToken($sessionToken);

从现在起,您可以像文档中所描述的那样使用 Check Point 管理API。以下是一些示例

$sessionManagement = $checkPointManagementApiClient->sessionManagement();
$session           = $sessionManagement->session();

$currentSession = $session->showSession([
    'uid' => $loginResponse->uid,
]);

$currentSession = $checkPointManagementApiClient->sessionManagement()->session()->showSession([
    'uid' => $loginResponse->uid,
]);