API C/C
HSM Dinamo
Cargando...
Buscando...
No se han encontrado entradas
Pix

Descripción detallada

Operaciones destinadas al Pix del SPI (Sistema de Pago Instantáneo).

Pix

Las API del módulo Pix están diseñadas para utilizar las funcionalidades de firma, verificación, envío y recepción de solicitudes HTTP de Pix.

Red

El HSM no accede directamente a los servidores Pix/DICT, sino que se sitúa en la red para ser utilizado por los servidores internos del PSP.

--- title: Diagrama físico de rede --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart LR psp[Aplicação PSP] hsm[HSM] fw[Firewall] rsfn{{RSFN}} spi["SPI (Pix/Dict)"] subgraph redepsp [Rede PSP] hsm <--> psp psp <--> fw end fw <--> rsfn rsfn <--> spi

Firma y verificación

Las API de firma y verificación Pix se basan en la norma ISO 20.022, y las API DICT siguen el formato XMLDSig, ambos definidos por SPI en el documento "Anexo IV - Manual de seguridad".

Las funciones API para su uso con la firma Pix y DICT requieren el almacenamiento interno en el HSM de los certificados digitales para la firma digital y la cadena de confianza completa de los certificados para la verificación.

Para escribir un certificado digital (o un archivo) en el HSM, utilice la consola de gestión remota o la API DWriteFile().

El certificado digital para la firma debe estar codificado en formato binario ASN1 DER y seguir también el estándar X.509. El archivo que contiene la cadena de confianza para verificar la firma digital debe estar codificado en formato PKCS#7 (Public Key Cryptography Standard #7 - Cryptographic Message Syntax Standard).

Las funciones de firma y validación de JWS Pix siguen el RFC 7515 y la documentación de SPI.

Peticiones HTTP

Las API de solicitud HTTP de Pix proporcionan una comunicación HTTP segura con los servidores Pix o DICT, utilizando las claves y certificados protegidos por el HSM.

Las funciones de comunicación segura del estándar Pix que siguen las definiciones descritas en los siguientes documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.

Operación

La conexión segura se realiza entre el servidor PSP y el servidor Pix/DICT, el HSM sólo se utiliza para utilizar objetos PSP y claves privadas.

El acceso al HSM sólo se produce durante el handshake TLS. Una vez cerrado el túnel, la comunicación sólo se mantiene entre el servidor PSP y el servidor Pix/DICT.

--- title: Visão geral handshake TLS utilizando o HSM --- %%{ init: { 'flowchart': { 'curve': 'basis' }} }%% sequenceDiagram participant hsm as HSM participant psp as PSP participant spi as SPI (Pix/Dict) Note over hsm: certificado TLS psp ->> spi: Inicia handshake TLS spi ->> psp: Requisita
credenciais do PSP psp ->> psp: Autentica SPI psp ->> hsm: Requisita informações
de autenticação hsm ->> hsm: Gera assinatura
para autenticação TLS destroy hsm hsm ->> psp: Envia assinatura psp ->> spi: Envia dados
de autenticação spi ->> spi: Autentica PSP loop Canal TLS %% necessário manter o espaço após o spi: (ou usar um text) psp-->spi: psp ->> spi: Requisição
Pix/Dict spi ->> psp: Resposta end

Una conexión HTTP se asocia con el manejador de sesión del HSM que se utilizó para abrir la sesión HTTP. Esto permite mantener la asociación y el acceso a los objetos de conexión (clave privada, certificado y cadena de certificados) dentro del HSM.

--- title: Handle de sessão do HSM --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TB hsm[Sessão HSM] http[Sessão HTTP] %% necessário manter os espaços após o subpgraph (ou usar um text) subgraph hsm http end

Por ejemplo: supongamos que se realiza una operación POST, la sesión HTTP se mantiene abierta dentro del manejador de sesión de HSM. Al cerrar la sesión HSM (sin desactivar la caché de sesión), la sesión se almacena en la caché de sesión junto con la sesión HTTP. Cuando se solicita una nueva sesión, se devuelve la sesión almacenada en caché. Cuando se reutiliza el manejador de sesión de HSM para una operación GET, la sesión HTTP se reutiliza porque se almacenó en el manejador de sesión de HSM.

Buenas prácticas

General

  1. Reutilice las sesiones (benefíciese de la caché de sesión). Utilice la caché de sesiones del HSM y gane rendimiento reutilizando las sesiones HSM y HTTP. En este caso se recomienda abrir una sesión, realizar las operaciones que se deseen y luego cerrarla, lo que permite reutilizar la sesión rápidamente, reduciendo así el tiempo de inactividad.
  2. Garantizar el cierre de las sesiones. El cierre de sesiones garantiza la liberación del recurso, tanto en el HSM como en el cliente. Asegúrese de que las sesiones se cierran incluso para operaciones con un código de retorno distinto de éxito.
  3. Utilice sesiones concurrentes. El uso de sesiones concurrentes/paralelas con el HSM ayuda a extraer el máximo rendimiento. Debe prestarse atención al uso de demasiadas sesiones con HSM, para no provocar un uso innecesario de recursos. La curva de rendimiento tiende a subir y a encontrar una meseta.

Peticiones HTTP Pix

  1. Definir un intervalo de recarga de objetos de conexión. Puede optimizar el número de veces que se cargan las claves y objetos HSM definiendo un intervalo de recarga para los objetos HSM. Dado que la actualización de claves/certificados/cadenas de la institución se realiza con poca frecuencia y de forma programada, resulta ventajoso definir un intervalo de recarga para estos objetos. Preste atención a los tiempos de espera de los activos de red que sean inferiores a este valor para evitar desconexiones prematuras y errores innecesarios. Vea más detalles y cómo configurarlo aquí.

Ajustes importantes

General
  1. Configure los tiempos de espera de conexión del HSM. Si no se establece el tiempo de espera del HSM, el valor predeterminado es el del sistema operativo. En caso de fallo de la conexión, la aplicación puede esperar demasiado tiempo. Es importante configurar SIEMPRE los tiempos de espera de envío y recepción de HSM. Aquí encontrará otros parámetros de conexión.
Peticiones HTTP Pix
  1. Define los tiempos de espera de las operaciones HTTP. Cuando no se define, el tiempo de espera de la operación HTTP por defecto es ilimitado. En caso de fallo de la conexión HTTP, la aplicación puede quedar en espera indefinidamente. Es importante definir SIEMPRE el tiempo de espera en las llamadas a peticiones HTTP.

Operaciones destinadas al Pix del SPI (Sistema de Pago Instantáneo). Más...

Funciones

int AAP_API DPIXSign(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, DWORD dwFlags, DWORD dwSizeUnsignedPIXEnvelope, BYTE *pbUnsignedPIXEnvelope, DWORD *pdwSizeSignedPIXEnvelope, BYTE **ppbSignedPIXEnvelope)
 
int AAP_API DPIXVerify(HSESSIONCTX hSession, const char *szChainId, const char *szCRL, DWORD dwFlags, DWORD dwSizeSignedPIXEnvelope, BYTE *pbSignedPIXEnvelope)
 
int AAP_API DPIXDictSign(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, DWORD dwFlags, DWORD dwSizeUnsignedDictEnvelope, BYTE *pbUnsignedDictEnvelope, DWORD *pdwSizeSignedDictEnvelope, BYTE **ppbSignedDictEnvelope)
 
int AAP_API DPIXDictVerify(HSESSIONCTX hSession, const char *szChainId, const char *szCRL, DWORD dwFlags, DWORD dwSizeSignedDictEnvelope, BYTE *pbSignedDictEnvelope)
 
int AAP_API DPIXJWSSign(HSESSIONCTX hSession, const char *szKeyId, DWORD dwFlags, DWORD dwHeaderLen, BYTE *pbHeader, DWORD dwPayloadLen, BYTE *pbPayload, DWORD *pdwJWSLen, BYTE *pbJWS)
 
int AAP_API DPIXJWSCheck(HSESSIONCTX hSession, const char *szChain, const char *szCRL, DWORD dwJWSLen, BYTE *pbJWS, DWORD dwFlags, DWORD *pdwHeaderLen, BYTE *pbHeader, DWORD *pdwPayloadLen, BYTE *pbPayload)
 
int AAP_API DPIXPost(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, const char *szPIXCertChainId, const char *szURL, DWORD dwCountRequestHeaderList, const char *pszRequestHeaderList[], DWORD dwSizeRequestData, BYTE *pbRequestData, DWORD dwTimeOut, DWORD *pdwSizeResponseHeaders, BYTE **ppbResponseHeaders, DWORD *pdwSizeResponseBody, BYTE **ppbResponseBody, DWORD dwParam)
 
int AAP_API DPIXPut(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, const char *szPIXCertChainId, const char *szURL, DWORD dwCountRequestHeaderList, const char *pszRequestHeaderList[], DWORD dwSizeRequestData, BYTE *pbRequestData, DWORD dwTimeOut, DWORD *pdwSizeResponseHeaders, BYTE **ppbResponseHeaders, DWORD *pdwSizeResponseBody, BYTE **ppbResponseBody, DWORD dwParam)
 
int AAP_API DPIXGet(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, const char *szPIXCertChainId, const char *szURL, DWORD dwCountRequestHeaderList, const char *pszRequestHeaderList[], DWORD dwTimeOut, DWORD *pdwSizeResponseHeaders, BYTE **ppbResponseHeaders, DWORD *pdwSizeResponseBody, BYTE **ppbResponseBody, DWORD dwParam)
 
int AAP_API DPIXDelete(HSESSIONCTX hSession, const char *szKeyId, const char *szCertId, const char *szPIXCertChainId, const char *szURL, DWORD dwCountRequestHeaderList, const char *pszRequestHeaderList[], DWORD dwTimeOut, DWORD *pdwSizeResponseHeaders, BYTE **ppbResponseHeaders, DWORD *pdwSizeResponseBody, BYTE **ppbResponseBody, DWORD dwParam)
 

Funciones

DPIXSign()

int AAP_API DPIXSign ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
DWORD dwFlags,
DWORD dwSizeUnsignedPIXEnvelope,
BYTE * pbUnsignedPIXEnvelope,
DWORD * pdwSizeSignedPIXEnvelope,
BYTE ** ppbSignedPIXEnvelope )

#include <dinamo.h>

Firma digitalmente un XML en formato ISO 20.022 siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
[en]szCertIdNombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
[en]dwFlagsOpciones de suscripción. Pase 0. Si necesita opciones adicionales, se aceptan los siguientes valores.
Valor Significado
PIX_SIGN_RNS Permite el uso de espacios de nombres relativos.
[en]dwSizeUnsignedPIXEnvelopeTamaño, en bytes, del XML original en pbUnsignedPIXEnvelope.
[en]pbUnsignedPIXEnvelopeBuffer que contiene el XML original.
[fuera]pdwSizeSignedPIXEnvelopePuntero al tamaño del XML firmado, en bytes. Cuando la función retorne, este parámetro contendrá el tamaño de los datos almacenados en ppbSignedPIXEnvelope.
[fuera]ppbSignedPIXEnvelopePuntero con el retorno al XML firmado. La asignación de memoria se realiza internamente. La aplicación que llama es responsable de liberar la memoria asignada utilizando la API DFree(). Consulte los comentarios para obtener más información.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas
Recomendamos utilizar la etiqueta de firma con el cierre completo, como se ve a continuación, por razones de rendimiento.
<Sgntr></Sgntr>
También se acepta la etiqueta con un cierre simple, véase más abajo.
<Sgntr/>
Ejemplos
sign_verify_pix.c.

DPIXVerify()

int AAP_API DPIXVerify ( HSESSIONCTX hSesión,
const char * szChainId,
const char * szCRL,
DWORD dwFlags,
DWORD dwSizeSignedPIXEnvelope,
BYTE * pbSignedPIXEnvelope )

#include <dinamo.h>

Comprueba la firma de un documento XML firmado digitalmente en formato ISO 20.022 siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szChainIdNombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Este formato es necesario porque el mensaje Pix XML no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para la firma en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
[en]szCRLNombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
[en]dwFlagsReservado para uso futuro (debe ser 0).
[en]dwSizeSignedPIXEnvelopeTamaño, en bytes, del XML firmado en pbSignedPIXEnvelope.
[en]pbSignedPIXEnvelopeXML firmado.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Ejemplos
sign_verify_pix.c.

DPIXDictSign()

int AAP_API DPIXDictSign ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
DWORD dwFlags,
DWORD dwSizeUnsignedDictEnvelope,
BYTE * pbUnsignedDictEnvelope,
DWORD * pdwSizeSignedDictEnvelope,
BYTE ** ppbSignedDictEnvelope )

#include <dinamo.h>

Firma digitalmente un XML en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para la firma. Correspondiente a un certificado CPIA.
[en]szCertIdNombre del certificado digital utilizado para la firma. Certificado digital del PSP registrado en SPI para la firma, también conocido como CPIA o CERTPIA.
[en]dwFlagsReservado para uso futuro (debe ser 0).
[en]dwSizeUnsignedDictEnvelopeTamaño, en bytes, del XML original en pbUnsignedDictEnvelope.
[en]pbUnsignedDictEnvelopeBuffer que contiene el XML original.
[fuera]pdwSizeSignedDictEnvelopePuntero al tamaño del XML firmado, en bytes. Cuando la función retorne, este parámetro contendrá el tamaño de los datos almacenados en ppbSignedDictEnvelope.
[fuera]ppbSignedDictEnvelopePuntero con el retorno al XML firmado. La asignación de memoria se realiza internamente. La aplicación que llama es responsable de liberar la memoria asignada utilizando la API DFree(). Consulte los comentarios para obtener más información.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas
No incluya la etiqueta de firma, se añadirá automáticamente.
Ejemplos
sign_verify_dict.c.

DPIXDictVerify()

int AAP_API DPIXDictVerify ( HSESSIONCTX hSesión,
const char * szChainId,
const char * szCRL,
DWORD dwFlags,
DWORD dwSizeSignedDictEnvelope,
BYTE * pbSignedDictEnvelope )

#include <dinamo.h>

Comprueba la firma de un documento XML firmado digitalmente en formato XMLDSig siguiendo el estándar DICT definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szChainIdNombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Este formato es necesario porque el mensaje Pix XML no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para la firma en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
[en]szCRLNombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
[en]dwFlagsReservado para uso futuro (debe ser 0).
[en]dwSizeSignedDictEnvelopeTamaño, en bytes, del XML firmado en pbSignedDictEnvelope.
[en]pbSignedDictEnvelopeXML firmado.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Ejemplos
sign_verify_dict.c.

DPIXJWSSign()

int AAP_API DPIXJWSSign ( HSESSIONCTX hSesión,
const char * szKeyId,
DWORD dwFlags,
DWORD dwHeaderLen,
BYTE * pbHeader,
DWORD dwPayloadLen,
BYTE * pbPayload,
DWORD * pdwJWSLen,
BYTE * pbJWS )

#include <dinamo.h>

Realiza una firma JWS RFC 7515 siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para firmar. Como se define en el manual de seguridad PIX
[en]dwFlagsOpciones de suscripción. Se debe pasar 0.
[en]dwHeaderLenTamaño, en bytes, de la cabecera JWS en pbHeader.
[en]pbHeaderCabecera JWS para la firma. Al menos el parámetro de cabecera alg debe ser informado. Valores aceptados para alg.
Valor Significado
RS256 RSA 2048 PKCS#1v5
RS384 RSA 3072 PKCS#1v5
RS512 RSA 4096 PKCS#1v5
PS256 RSA 2048 PSS
PS384 RSA 3072 PSS
PS512 RSA 4096 PSS
ES256 ECC SECP256R1
ES384 ECC SECP384R1
ES512 ECC SECP521R1
[en]dwPayloadLenTamaño, en bytes, de la carga útil del JWS en pbPayload.
[en]pbPayloadBuffer que contiene la carga útil JWS para firmar.
[in,out]pdwJWSLenPuntero al tamaño del búfer pbJWSen bytes. Cuando la función retorne, este parámetro contendrá el tamaño de los datos almacenados en pbJWS.
[fuera]pbJWSBuffer que contendrá el JWS firmado. Si se pasa NULL, la API devolverá 0 y pdwJWSLen contendrá el tamaño necesario estimado de pbJWS.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas
Utiliza el formato Compact Serialisation descrito en la Sección-3.1 del RFC 7515.
Ejemplos
sign_check_pix_jws.c.

DPIXJWSCheck()

int AAP_API DPIXJWSCheck ( HSESSIONCTX hSesión,
const char * szChain,
const char * szCRL,
DWORD dwJWSLen,
BYTE * pbJWS,
DWORD dwFlags,
DWORD * pdwHeaderLen,
BYTE * pbHeader,
DWORD * pdwPayloadLen,
BYTE * pbPayload )

#include <dinamo.h>

Valida un RFC 7515 firmado por JWS siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szChainNombre de la cadena PKCS#7 (almacenada internamente en el HSM) del certificado utilizado en la firma. La cadena debe estar completa, desde la CA raíz hasta el certificado real utilizado en la firma. Este formato es necesario porque el mensaje Pix XML no contiene el certificado utilizado en la firma. Opcionalmente, sólo se puede pasar el certificado X.509 utilizado para la firma en lugar de la cadena completa. A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas. Es importante tener en cuenta que, en el caso de un objeto PKCS#7 de HSM que contenga varias cadenas, la presencia de un certificado caducado en cualquiera de las cadenas generará un código de retorno de firma válido con un certificado caducado (código distinto de cero) en la verificación, aunque la firma se haya realizado con un certificado de una cadena no caducada; depende de la aplicación tratar esto correctamente de acuerdo con la política local.
[en]szCRLNombre de la lista de revocación de certificados (CRL) -almacenada internamente en el HSM- en la que se verificará el certificado digital. Es posible pasar NULL indicando que no hay CRL que comprobar.
[en]dwJWSLenTamaño, en bytes, de la firma JWS en pbJWS.
[en]pbJWSJWS firmado.
[en]dwFlagsOpciones de validación. Se debe pasar 0.
[in,out]pdwHeaderLenPuntero al tamaño del búfer pbHeaderen bytes. Cuando la función retorne, este parámetro contendrá el tamaño de los datos almacenados en pbHeader.
[fuera]pbHeaderBuffer que contendrá la cabecera JWS. Si se pasa NULL, la API devolverá 0 y pdwHeaderLen contendrá el tamaño necesario estimado de pbHeader.
[in,out]pdwPayloadLenPuntero al tamaño del búfer pbPayloaden bytes. Cuando la función retorne, este parámetro contendrá el tamaño de los datos almacenados en pbPayload.
[fuera]pbPayloadBuffer que contendrá la carga útil de JWS. Si se pasa NULL, la API devolverá 0 y pdwPayloadLen contendrá el tamaño necesario estimado de pbPayload.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Ejemplos
sign_check_pix_jws.c.

DPIXPost()

int AAP_API DPIXPost ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
const char * szPIXCertChainId,
const char * szURL,
DWORD dwCountRequestHeaderList,
const char * pszRequestHeaderList[],
DWORD dwSizeRequestData,
BYTE * pbRequestData,
DWORD dwTimeOut,
DWORD * pdwSizeResponseHeaders,
BYTE ** ppbResponseHeaders,
DWORD * pdwSizeResponseBody,
BYTE ** ppbResponseBody,
DWORD dwParam )

#include <dinamo.h>

Realiza una petición HTTP POST segura siguiendo el estándar PIX definido en SPI (Sistema de Pago Instantáneo).

Observación
Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.
Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
[en]szCertIdNombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
[en]szPIXCertChainIdNombre de la cadena PKCS#7 utilizada para comprobar el servidor PIX (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
[en]szURLURL del servidor PIX (ICOM o DICT).
[en]dwCountRequestHeaderListNúmero de líneas rellenadas pszRequestHeaderList.
[en]pszRequestHeaderListLíneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios.
Esta opción sobrescribirá las cabeceras por defecto si se solapan.
Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:).
Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;).
NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente.
Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual.
La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding, Content-Type, Expect y Content-Length.
[en]dwSizeRequestDataTamaño de los datos introducidos pbRequestData.
[en]pbRequestDataDatos enviados en la solicitud.
[en]dwTimeOutTiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
[fuera]pdwSizeResponseHeadersPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseHeadersen bytes.
[fuera]ppbResponseHeadersBúfer asignado internamente que contendrá el cabecera devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseHeaders. Este puntero debe liberarse utilizando la API DFree().
[fuera]pdwSizeResponseBodyPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseBodyen bytes.
[fuera]ppbResponseBodyBúfer asignado internamente que contendrá el cuerpo devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseBody. Este puntero debe liberarse utilizando la API DFree().
[en]dwParam
Valor Significado
0 Opción por defecto. No comprueba el certificado con el nombre de host.
PIX_VERIFY_HOST_NAME Comprueba el certificado con el nombre del host.
PIX_BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length.
PIX_GZIP Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas

Ejecuta una petición segura siguiendo el estándar PIX definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP se debe utilizar la misma sesión HSM que la utilizada previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

Ver también
DFree() DPIXGet() DPIXBorrar()
Ejemplos
post_put_get_delete_pix.c.

DPIXPut()

int AAP_API DPIXPut ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
const char * szPIXCertChainId,
const char * szURL,
DWORD dwCountRequestHeaderList,
const char * pszRequestHeaderList[],
DWORD dwSizeRequestData,
BYTE * pbRequestData,
DWORD dwTimeOut,
DWORD * pdwSizeResponseHeaders,
BYTE ** ppbResponseHeaders,
DWORD * pdwSizeResponseBody,
BYTE ** ppbResponseBody,
DWORD dwParam )

#include <dinamo.h>

Realiza una petición HTTP PUT segura siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Observación
Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.
Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
[en]szCertIdNombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
[en]szPIXCertChainIdNombre de la cadena PKCS#7 utilizada para comprobar el servidor PIX (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
[en]szURLURL del servidor PIX (ICOM o DICT).
[en]dwCountRequestHeaderListNúmero de líneas rellenadas pszRequestHeaderList.
[en]pszRequestHeaderListLíneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios.
Esta opción sobrescribirá las cabeceras por defecto si se solapan.
Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:).
Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;).
NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente.
Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual.
La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding, Expect y Content-Length.
[en]dwSizeRequestDataTamaño de los datos introducidos pbRequestData.
[en]pbRequestDataDatos enviados en la solicitud.
[en]dwTimeOutTiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
[fuera]pdwSizeResponseHeadersPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseHeadersen bytes.
[fuera]ppbResponseHeadersBúfer asignado internamente que contendrá el cabecera devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseHeaders. Este puntero debe liberarse utilizando la API DFree().
[fuera]pdwSizeResponseBodyPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseBodyen bytes.
[fuera]ppbResponseBodyBúfer asignado internamente que contendrá el cuerpo devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseBody. Este puntero debe liberarse utilizando la API DFree().
[en]dwParam
Valor Significado
0 Opción por defecto. No comprueba el certificado con el nombre de host.
PIX_VERIFY_HOST_NAME Comprueba el certificado con el nombre del host.
PIX_BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host, User-Agent y Content-Length.
PIX_GZIP Comprime automáticamente los datos de la solicitud. Incluye automáticamente las cabeceras necesarias (Content-Encoding y Accept-Encoding).
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas

Ejecuta una petición segura siguiendo el estándar PIX definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP se debe utilizar la misma sesión HSM que la utilizada previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

Ver también
DFree() DPIXPut() DPIXGet() DPIXBorrar()
Ejemplos
post_put_get_delete_pix.c.

DPIXGet()

int AAP_API DPIXGet ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
const char * szPIXCertChainId,
const char * szURL,
DWORD dwCountRequestHeaderList,
const char * pszRequestHeaderList[],
DWORD dwTimeOut,
DWORD * pdwSizeResponseHeaders,
BYTE ** ppbResponseHeaders,
DWORD * pdwSizeResponseBody,
BYTE ** ppbResponseBody,
DWORD dwParam )

#include <dinamo.h>

Realiza una petición HTTP GET segura siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Observación
Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.
Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
[en]szCertIdNombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
[en]szPIXCertChainIdNombre de la cadena PKCS#7 utilizada para comprobar el servidor PIX (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
[en]szURLURL del servidor PIX (ICOM o DICT).
[en]dwCountRequestHeaderListNúmero de líneas rellenadas pszRequestHeaderList.
[en]pszRequestHeaderListLíneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios.
Esta opción sobrescribirá las cabeceras por defecto si se solapan.
Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:).
Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;).
NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente.
Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual.
La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding.
[en]dwTimeOutTiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
[fuera]pdwSizeResponseHeadersPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseHeadersen bytes.
[fuera]ppbResponseHeadersBúfer asignado internamente que contendrá el cabecera devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseHeaders. Este puntero debe liberarse utilizando la API DFree().
[fuera]pdwSizeResponseBodyPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseBodyen bytes.
[fuera]ppbResponseBodyBúfer asignado internamente que contendrá el cuerpo devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseBody. Este puntero debe liberarse utilizando la API DFree().
[en]dwParam
Valor Significado
0 Opción por defecto. No comprueba el certificado con el nombre de host.
PIX_VERIFY_HOST_NAME Comprueba el certificado con el nombre del host.
PIX_BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent.
PIX_GZIP Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas

Ejecuta una petición segura siguiendo el estándar PIX definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP se debe utilizar la misma sesión HSM que la utilizada previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

Ver también
DFree() DPIXPost() DPIXGet() DPIXBorrar()
Ejemplos
post_put_get_delete_pix.c.

DPIXBorrar()

int AAP_API DPIXDelete ( HSESSIONCTX hSesión,
const char * szKeyId,
const char * szCertId,
const char * szPIXCertChainId,
const char * szURL,
DWORD dwCountRequestHeaderList,
const char * pszRequestHeaderList[],
DWORD dwTimeOut,
DWORD * pdwSizeResponseHeaders,
BYTE ** ppbResponseHeaders,
DWORD * pdwSizeResponseBody,
BYTE ** ppbResponseBody,
DWORD dwParam )

#include <dinamo.h>

Realiza una petición segura HTTP DELETE siguiendo el estándar PIX definido en el SPI (Sistema de Pago Instantáneo).

Observación
Configure el tiempo de espera. Consulte más detalles en la sección Buenas prácticas.
Parámetros
[en]hSesiónContexto adquirido a través de la función DOpenSession().
[en]szKeyIdNombre de la clave privada utilizada para cerrar el túnel. Corresponde a un certificado CPIC.
[en]szCertIdNombre del certificado utilizado para cerrar el túnel. Certificado digital del PSP registrado en el SPI para la conexión, también conocido como CPIC o CERTPIC.
[en]szPIXCertChainIdNombre de la cadena PKCS#7 utilizada para comprobar el servidor PIX (ICOM o DICT). A partir de la versión 5.0.23 del firmware del HSM, es posible utilizar un objeto PKCS#7 que contenga varias cadenas.
[en]szURLURL del servidor PIX (ICOM o DICT).
[en]dwCountRequestHeaderListNúmero de líneas rellenadas pszRequestHeaderList.
[en]pszRequestHeaderListLíneas que contienen las cabeceras HTTP personalizadas que se utilizarán en la petición. Se puede pasar null si se desea utilizar la cabecera por defecto sin cambios.
Esta opción sobrescribirá las cabeceras por defecto si se solapan.
Para eliminar una cabecera, pase el nombre de la cabecera sin un valor (p. ej. Acepta:).
Para incluir una cabecera sin contenido, utilice ; en lugar de : (Ej. Acepta;).
NO utilice terminadores CRLF en las cabeceras. Pasar estos terminadores puede causar un comportamiento no deseado. El formateo se realizará internamente.
Esta opción no puede utilizarse para modificar la primera línea de la petición (por ejemplo, POST, PUT, GET, DELETE), que no es una cabecera. Debe utilizarse la API correspondiente, descrita en este manual.
La cabecera inicial estándar incluye Host, User-Agent, Accept, Accept-Encoding.
[en]dwTimeOutTiempo de espera de la operación en milisegundos. Puede establecerse en 0 para que no haya tiempo de espera.
[fuera]pdwSizeResponseHeadersPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseHeadersen bytes.
[fuera]ppbResponseHeadersBúfer asignado internamente que contendrá el cabecera devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseHeaders. Este puntero debe liberarse utilizando la API DFree().
[fuera]pdwSizeResponseBodyPuntero que contendrá el tamaño de los datos almacenados en el buffer ppbResponseBodyen bytes.
[fuera]ppbResponseBodyBúfer asignado internamente que contendrá el cuerpo devuelto por la solicitud. El tamaño asignado se define en pdwSizeResponseBody. Este puntero debe liberarse utilizando la API DFree().
[en]dwParam
Valor Significado
0 Opción estándar para certificados SPB. No comprueba el certificado con el nombre de host.
PIX_VERIFY_HOST_NAME Comprueba el certificado con el nombre del host.
PIX_BASIC_HTTP_HEADER Utiliza la cabecera HTTP inicial básica. Incluye Host y User-Agent.
PIX_GZIP Incluye la cabecera Accept-Encoding: gzip si la cabecera básica está activada.
Devolución
0 (CERO) si la función tiene éxito.
Consulte la sección Códigos de retorno para conocer otros valores.
Notas

Ejecuta una petición segura siguiendo el estándar PIX definido en el SPI en los documentos: "Anexo IV - Manual de Seguridad", "Especificaciones técnicas y de negocio del ecosistema brasileño de pagos instantáneos" y "Anexo III - Manual de Interfaces de Comunicación" definidos en el SPI.
El túnel negociado es TLS versión 1.2 con autenticación mutua, utilizando el protocolo HTTP versión 1.1 con un Cipher Suite mínimo de ECDHE-RSA-AES-128-GCM-SHA256.

Esta API descomprimirá automáticamente una respuesta que venga comprimida en el estándar gzip. Si decide comprimir los datos de envío, la persona que llame a la API deberá hacerlo en formato gzip.

Esta solicitud utiliza por defecto las siguientes cabeceras.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", donde 0.0.0.0 es la versión de la biblioteca cliente HSM utilizada.

La validación del certificado con el nombre de host se realiza comprobando que el campo Common Name o Subject Alternate Name del certificado coincide con el nombre de host de la URL pasada como parámetro.

Al realizar una petición HTTP, se efectúan 2 operaciones, una para utilizar los objetos HSM (clave privada, certificado y cadena, utilizados para autenticar el túnel) y otra para abrir la sesión HTTP con el servidor HTTP.
Para optimizar los recursos, la sesión con el servidor HTTP se mantiene abierta y se almacena en caché; del mismo modo, la sesión con el HSM se almacena en caché por defecto (la sesión del HSM puede configurarse opcionalmente para que no se almacene en caché).
La sesión HTTP está asociada a la sesión abierta con el HSM, lo que significa que para reutilizar una sesión HTTP se debe utilizar la misma sesión HSM que la utilizada previamente para abrir la sesión HTTP.
La sesión HTTP se cierra físicamente cuando se cierra físicamente la sesión con el HSM.
La sesión con el HSM y la sesión HTTP tienen afinidad de hilo-sesión y no pueden ser utilizadas simultáneamente por varios hilos.

El sondeo largo se ajusta configurando el tiempo de espera de la operación HTTP (POST/GET/DELETE) según la configuración del servidor HTTP.

Ver también
DFree() DPIXPost() DPIXPut() DPIXGet()
Ejemplos
post_put_get_delete_pix.c.