README

安全测试是一个“echo”服务，负责验证消息和签名是否与您的应用程序对应；同时将返回相同的消息和我们的相应签名，您也需要进行验证。

要求

PHP 7.1 或更高版本

额外依赖

• 需要以下PHP依赖项
  • ext-curl
  • ext-mbstring
• 如果不符合，对于Linux使用以下命令

#ejemplo con php en versión 7.3 para otra versión colocar php{version}-curl
apt-get install php7.3-curl
apt-get install php7.3-mbstring

• Composer 查看安装方法

安装

执行： composer install

入门指南

步骤 1. 生成密钥和证书

• 需要有一个PKCS12格式的容器。
• 如果没有，执行 lib/Interceptor/key_pair_gen.sh 中的说明或以下命令。
• 可选：为了加密容器，在环境变量中放置一个密码。

export KEY_PASSWORD=your_password

• 定义文件名和别名。

export PRIVATE_KEY_FILE=pri_key.pem
export CERTIFICATE_FILE=certificate.pem
export SUBJECT=/C=MX/ST=MX/L=MX/O=CDC/CN=CDC
export PKCS12_FILE=keypair.p12
export ALIAS=circulo_de_credito

• 生成密钥和证书。

#Genera la llave privada.
openssl ecparam -name secp384r1 -genkey -out ${PRIVATE_KEY_FILE}

#Genera el certificado público.
openssl req -new -x509 -days 365 \
    -key ${PRIVATE_KEY_FILE} \
    -out ${CERTIFICATE_FILE} \
    -subj "${SUBJECT}"

• 生成PKCS12格式的容器。

# Genera el archivo pkcs12 a partir de la llave privada y el certificado.
# Deberá empaquetar la llave privada y el certificado.
openssl pkcs12 -name ${ALIAS} \
    -export -out ${PKCS12_FILE} \
    -inkey ${PRIVATE_KEY_FILE} \
    -in ${CERTIFICATE_FILE} -password pass:${KEY_PASSWORD}

步骤 2. 在开发者门户中加载证书

1. 登录。
2. 点击“我的应用”部分。
3. 选择应用程序。
4. 转到“为 @tuApp 的证书”标签页。

   

5. 在弹出窗口中，选择先前创建的证书并点击“加载”按钮

   

步骤 3. 在开发者门户中下载信用圈证书

1. 登录。
2. 点击“我的应用”部分。
3. 选择应用程序。
4. 转到“为 @tuApp 的证书”标签页。

   

5. 在弹出窗口中，点击“下载”按钮

   

请确保将此容器存储在以下路径： /path/to/repository/lib/Interceptor/keypair.p12

同样，信用圈提供的证书在以下路径： /path/to/repository/lib/Interceptor/cdc_cert.pem

• 如果没有按照这种方式存储，则必须指定容器和证书的路径。查看以下示例

/**
* Esto es parte del setUp() de las pruebas unitarias.
*/
$password = getenv('KEY_PASSWORD');
$this->signer = new \APIHub\Client\Interceptor\KeyHandler(
    "/example/route/keypair.p12",
    "/example/route/cdc_cert.pem",
    $password
);

注意：仅当容器被加密时，才需要在环境变量中放置密码并指明其名称，如上图所示。

步骤 4. 修改 URL

在 lib/Configuration.php 中修改请求的URL，在第19行，如下所示

protected $host = 'the_url';

步骤 5. 捕获请求数据

需要有一个setUp()，它将负责签名和验证请求。

<?php
public function setUp()
{
  $password = getenv('KEY_PASSWORD');
  $this->signer = new \APIHub\Client\Interceptor\KeyHandler(null, null, $password);
  $events = new \APIHub\Client\Interceptor\MiddlewareEvents($this->signer);
  $handler = \GuzzleHttp\HandlerStack::create();
  $handler->push($events->add_signature_header('x-signature'));
  $handler->push($events->verify_signature_header('x-signature'));
  
  $client = new \GuzzleHttp\Client(['handler' => $handler]);
  $this->apiInstance = new \APIHub\Client\Api\PruebaDeSeguridadApi($client);
}    

<?php
/**
* Este es el método que se será ejecutado en la prueba ubicado en path/to/repository/test/Api/PruebaDeSeguridadApiTest.php
*/
public function testFicoScoreAPI()
{
  $x_api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
  $body = "Esto es un mensaje de prueba";

  try {
      $result = $this->apiInstance->securityTest($x_api_key, $body);
      $this->signer->close();
      print_r($result);
  } catch (Exception $e) {
      echo 'Exception when calling PruebaDeSeguridadApi->securityTest: ', $e->getMessage(), PHP_EOL;
  }
}

单元测试

要执行单元测试

./vendor/bin/phpunit