Pix Module

Detailed description

Operations destined for Pix of the SPI (Instant Payments System).

See HSM technical documentation about operating details, specifications used, licenses and module trade name.

Best practices

General

1. Reuse sessions (benefit from session caching). Utilize the HSM session cache to improve performance by reusing both HSM and HTTP sessions. In this scenario, it is recommended to open a session, perform the desired operations, and then close it; this allows the session to be quickly reused, thereby reducing idle time.
2. Ensure session closure. Closing sessions guarantees resource release, both on the HSM and the client. Ensure that sessions are closed even for operations with a return code other than success.
3. Utilize concurrent sessions. Using concurrent/parallel sessions with the HSM helps extract maximum performance. Care should be taken to avoid an excessive number of sessions with HSMs, to prevent unnecessary resource consumption. The throughput curve tends to rise and then plateau.

HTTP requests Pix

1. Setting a connection object reload interval. You can optimize the number of times HSM keys and objects are loaded by setting a reload interval for HSM objects. As the institution's key/certificate/chain update is done infrequently and on a scheduled basis, it is advantageous to define a reload interval for these objects. Watch out for network asset timeouts shorter than this value, which could cause premature disconnections.

Important Configurations

General

1. Set the HSM connection timeouts. When the HSM timeout is not set, the default is that of the operating system. In the event of a connection failure, the application may wait too long. It is important to ALWAYS set the HSM's send and receive timeouts. Other connection parameters can be found here.

HTTP requests Pix

1. Define the HTTP operation timeouts. If not defined, the default HTTP operation timeout is unlimited. In the event of an HTTP connection failure, the application may wait indefinitely. It is ALWAYS important to define the timeout for HTTP request calls.

Functions
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)

Functions

DPIXSign()

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

#include <dinamo.h>

Digitally signs an XML in ISO 20.022 format following the PIX standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for signing. Corresponds to a CPIA certificate.
[in]	szCertId	Name of the digital certificate used for signing. This is the PSP's Digital Certificate registered with SPI for signing, also known as CPIA or CERTPIA.
[in]	dwFlags	Signing options. Pass 0. If additional options are required, the following values are accepted. Value Meaning PIX_SIGN_RNS Enables the use of relative namespaces.
[in]	dwSizeUnsignedPIXEnvelope	Size, in bytes, of the original XML in pbUnsignedPIXEnvelope.
[in]	pbUnsignedPIXEnvelope	Buffer containing the original XML.
[out]	pdwSizeSignedPIXEnvelope	Pointer to the size of the signed XML, in bytes. When the function returns, this parameter will contain the size of the data stored in ppbSignedPIXEnvelope.
[out]	ppbSignedPIXEnvelope	Pointer to a pointer returning the signed XML. Memory allocation is handled internally. The calling application is responsible for freeing the allocated memory using the DFree() API. Refer to the remarks for further information.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

For performance reasons, we recommend using the signature tag with a complete closing, as shown below.

<Sgntr></Sgntr>

The tag with a simple closing is also accepted; see below.

<Sgntr/>

Examples

sign_verify_pix.c.

DPIXVerify()

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

#include <dinamo.h>

Checks the signature of a digitally signed XML document in ISO 20.022 format following the PIX standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szChainId	Name of the PKCS#7 chain (stored internally in the HSM) of the certificate used in the signature. The chain must be complete, from the root CA to the certificate used in the signature. This formatting is necessary because the XML message from Pix does not contain the certificate used in the signature. Optionally, only the X.509 certificate used to sign can be passed instead of the complete chain. As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object that contains several chains. It is important to note that in the case of an HSM PKCS#7 object containing multiple chains, the presence of an expired certificate in any of the chains will generate a valid signature return code with an expired certificate (non-zero code) in the verification, even if the signature was made with a certificate from a non-expired chain; it is up to the application to handle this correctly according to local policy.
[in]	szCRL	Certificate Revocation List (CRL) Name – stored internally in the HSM – where the digital certificate will be verified. NULL can be passed to indicate that no CRL is available for verification.
[in]	dwFlags	Reserved for future use (must be 0).
[in]	dwSizeSignedPIXEnvelope	Size, in bytes, of the XML signed in pbSignedPIXEnvelope.
[in]	pbSignedPIXEnvelope	Signed XML.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Examples

sign_verify_pix.c.

DPixDictSign()

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

#include <dinamo.h>

Digitally signs an XML in XMLDSig format, following the DICT standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for signing. Corresponds to a CPIA certificate.
[in]	szCertId	Name of the digital certificate used for signing. This is the PSP's Digital Certificate registered with SPI for signing, also known as CPIA or CERTPIA.
[in]	dwFlags	Reserved for future use (must be 0).
[in]	dwSizeUnsignedDictEnvelope	Size, in bytes, of the original XML in pbUnsignedDictEnvelope.
[in]	pbUnsignedDictEnvelope	Buffer containing the original XML.
[out]	pdwSizeSignedDictEnvelope	Pointer to the size of the signed XML, in bytes. When the function returns, this parameter will contain the size of the data stored in ppbSignedDictEnvelope.
[out]	ppbSignedDictEnvelope	Pointer to a pointer returning the signed XML. Memory allocation is handled internally. The calling application is responsible for freeing the allocated memory using the DFree() API. Refer to the remarks for further information.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

Do not include the signature tag; it will be added automatically.

Examples

sign_verify_dict.c.

DPixDictVerify()

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

#include <dinamo.h>

Verifies the signature of a digitally signed XML document in XMLDSig format, following the DICT standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szChainId	Name of the PKCS#7 chain (stored internally in the HSM) of the certificate used in the signature. The chain must be complete, from the root CA to the certificate used in the signature. This formatting is necessary because the XML message from Pix does not contain the certificate used in the signature. Optionally, only the X.509 certificate used to sign can be passed instead of the complete chain. As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object that contains several chains. It is important to note that in the case of an HSM PKCS#7 object containing multiple chains, the presence of an expired certificate in any of the chains will generate a valid signature return code with an expired certificate (non-zero code) in the verification, even if the signature was made with a certificate from a non-expired chain; it is up to the application to handle this correctly according to local policy.
[in]	szCRL	Certificate Revocation List (CRL) Name – stored internally in the HSM – where the digital certificate will be verified. NULL can be passed to indicate that no CRL is available for verification.
[in]	dwFlags	Reserved for future use (must be 0).
[in]	dwSizeSignedDictEnvelope	Size, in bytes, of the signed XML in pbSignedDictEnvelope.
[in]	pbSignedDictEnvelope	Signed XML.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Examples

sign_verify_dict.c.

DPixJWSSign()

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

#include <dinamo.h>

Makes a JWS RFC 7515 signature following the PIX standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for signing. As defined in the PIX
[in]	dwFlags	Signature options. Must be set to 0.
[in]	dwHeaderLen	Size, in bytes, of the JWS Header in pbHeader.
[in]	pbHeader	JWS Header for signature. At least the header parameter alg must be provided. Accepted values for alg. Value Meaning 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
[in]	dwPayloadLen	Size, in bytes, of the JWS Payload in pbPayload.
[in]	pbPayload	Buffer containing the JWS Payload for signing.
[in,out]	pdwJWSLen	Pointer to the size of the pbJWS buffer, in bytes. When the function returns, this parameter will contain the size of the data stored in pbJWS.
[out]	pbJWS	Buffer that will contain the signed JWS. If NULL is passed, the API will return 0 and pdwJWSLen will contain the estimated required size of pbJWS.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

Uses the Compact Serialization format described in Section-3.1 of RFC 7515.

Examples

sign_check_pix_jws.c.

DPIXJWSCheck()

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 )

#include <dinamo.h>

Validates an RFC 7515 signed JWS following the PIX standard defined in the SPI (Instant Payment System).

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szChain	Name of the PKCS#7 chain (stored internally in the HSM) of the certificate used in the signature. The chain must be complete, from the root CA to the certificate used in the signature. This formatting is necessary because the XML message from Pix does not contain the certificate used in the signature. Optionally, only the X.509 certificate used to sign can be passed instead of the complete chain. As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object that contains several chains. It is important to note that in the case of an HSM PKCS#7 object containing multiple chains, the presence of an expired certificate in any of the chains will generate a valid signature return code with an expired certificate (non-zero code) in the verification, even if the signature was made with a certificate from a non-expired chain; it is up to the application to handle this correctly according to local policy.
[in]	szCRL	Certificate Revocation List (CRL) Name – stored internally in the HSM – where the digital certificate will be verified. NULL can be passed to indicate that no CRL is available for verification.
[in]	dwJWSLen	Size, in bytes, of the JWS signature in pbJWS.
[in]	pbJWS	Signed JWS.
[in]	dwFlags	Validation options. Must be passed as 0.
[in,out]	pdwHeaderLen	Pointer to the size of the pbHeader buffer, in bytes. When the function returns, this parameter will contain the size of the data stored in pbHeader.
[out]	pbHeader	Buffer that will contain the JWS Header. If NULL is passed, the API will return 0 and pdwHeaderLen will contain the estimated required size of pbHeader.
[in,out]	pdwPayloadLen	Pointer to the size of the pbPayload buffer, in bytes. When the function returns, this parameter will contain the size of the data stored in pbPayload.
[out]	pbPayload	Buffer that will contain the JWS Payload. If NULL is passed, the API will return 0 and pdwPayloadLen will contain the estimated required size of pbPayload.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Examples

sign_check_pix_jws.c.

DPIXPost()

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 )

#include <dinamo.h>

It makes a secure HTTP POST request following the PIX standard defined in SPI (Instant Payment System).

Note

Configure timeout settings. Refer to the Best Practices section for more details.

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for tunnel establishment. Corresponds to a CPIC certificate.
[in]	szCertId	Name of the certificate used for tunnel establishment. This is the PSP Digital Certificate registered with SPI for connection, also known as CPIC or CERTPIC.
[in]	szPIXCertChainId	Name of the PKCS#7 string used to check the PIX server (ICOM or DICT). As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object containing several strings.
[in]	szURL	URL of the server PIX (ICOM or DICT).
[in]	dwCountRequestHeaderList	Number of lines filled in pszRequestHeaderList.
[in]	pszRequestHeaderList	Lines containing the customized HTTP headers that will be used in the request. Can be passed null if you want to use the default header without changes. This option will overwrite the default headers if they overlap. To remove a header, pass the name of the header without a value (e.g. Accept:). To include a header without content, use ; instead of : (e.g. Accept;). Do NOT use CRLF terminators in headers. Passing these terminators may cause unwanted behavior. Formatting will be done internally. This option cannot be used to change the first line of the request (e.g. POST, PUT, GET, DELETE), which is not a header. The corresponding API, described in this manual, must be used. The default initial header includes Host, User-Agent, Accept, Accept-Encoding, Content-Type, Expect and Content-Length.
[in]	dwSizeRequestData	Size of the data passed in pbRequestData.
[in]	pbRequestData	Data sent in the request.
[in]	dwTimeOut	Operation timeout in milliseconds. Can be set to 0 for no timeout.
[out]	pdwSizeResponseHeaders	Pointer that will contain the size of the data stored in the ppbResponseHeaders buffer, in bytes.
[out]	ppbResponseHeaders	Internally allocated buffer that will contain the header returned by the request. The size allocated is defined in pdwSizeResponseHeaders. This pointer must be freed using the DFree() API.
[out]	pdwSizeResponseBody	Pointer that will contain the size of the data stored in the ppbResponseBody buffer, in bytes.
[out]	ppbResponseBody	Internally allocated buffer that will contain the body returned by the request. The allocated size is defined in pdwSizeResponseBody. This pointer must be freed using the DFree() API.
[in]	dwParam	Value Meaning 0 Default option. Does not verify the certificate against the hostname. PIX_VERIFY_HOST_NAME Verifies the certificate against the hostname. PIX_BASIC_HTTP_HEADER Uses the basic initial HTTP header. Includes Host, User-Agent, and Content-Length. PIX_GZIP Performs automatic gzip compression of request data. Automatically includes the necessary headers (Content-Encoding and Accept-Encoding).

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

It executes a secure request following the PIX standard defined in the SPI in the documents: "Annex IV - Security Manual", "Technical and business specifications of the Brazilian instant payment ecosystem" and "Annex III - Communication Interfaces Manual" defined in the SPI.
The negotiated tunnel is TLS version 1.2 with mutual authentication, using the HTTP protocol version 1.1 with a minimum Cipher Suite of ECDHE-RSA-AES-128-GCM-SHA256.

This API will automatically decompress a response that comes compressed in the gzip standard. If you choose to compress the sending data, the API caller must do so in gzip format.

This request uses the following headers by default.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", where 0.0.0.0 is the version of the HSM client library used.

Certificate validation with the host name is done by checking that the Common Name field or Subject Alternate Name field of the certificate matches the host name of the URL passed as a parameter.

When making an HTTP request, 2 operations are performed, one to use the HSM objects (private key, certificate and chain, used for tunnel authentication) and the other to open the HTTP session with the HTTP server.
To optimize resources, the session with the HTTP server is kept open and cached; likewise, the session with the HSM is cached by default (the HSM session can optionally be set not to be cached).
The HTTP session is associated with the session opened with the HSM, which means that to reuse an HTTP session you must use the same HSM session that was previously used to open the HTTP session.
The HTTP session is physically closed when the session with the HSM is physically closed.
The HSM session and the HTTP session have thread-session affinity and cannot be used simultaneously by several threads.

Long Polling is adjusted by setting the HTTP operation timeout (POST/GET/DELETE) according to the HTTP server settings.

See also

DFree() DPIXGet() DPIXDelete()

Examples

post_put_get_delete_pix.c.

DPIXPut()

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 )

#include <dinamo.h>

It makes a secure HTTP PUT request following the PIX standard defined in the SPI (Instant Payment System).

Note

Configure timeout settings. Refer to the Best Practices section for more details.

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for tunnel establishment. Corresponds to a CPIC certificate.
[in]	szCertId	Name of the certificate used for tunnel establishment. This is the PSP Digital Certificate registered with SPI for connection, also known as CPIC or CERTPIC.
[in]	szPIXCertChainId	Name of the PKCS#7 string used to check the PIX server (ICOM or DICT). As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object containing several strings.
[in]	szURL	URL of the server PIX (ICOM or DICT).
[in]	dwCountRequestHeaderList	Number of lines filled in pszRequestHeaderList.
[in]	pszRequestHeaderList	Lines containing the customized HTTP headers that will be used in the request. Can be passed null if you want to use the default header without changes. This option will overwrite the default headers if they overlap. To remove a header, pass the name of the header without a value (e.g. Accept:). To include a header with no content, use ; instead of : (e.g. Accept;). Do NOT use CRLF terminators in headers. Passing these terminators may cause unwanted behavior. Formatting will be done internally. This option cannot be used to change the first line of the request (e.g. POST, PUT, GET, DELETE), which is not a header. The corresponding API, described in this manual, must be used. The default initial header includes Host, User-Agent, Accept, Accept-Encoding, Expect and Content-Length.
[in]	dwSizeRequestData	Size of the data passed in pbRequestData.
[in]	pbRequestData	Data sent in the request.
[in]	dwTimeOut	Operation timeout in milliseconds. Can be set to 0 for no timeout.
[out]	pdwSizeResponseHeaders	Pointer that will contain the size of the data stored in the ppbResponseHeaders buffer, in bytes.
[out]	ppbResponseHeaders	Internally allocated buffer that will contain the header returned by the request. The size allocated is defined in pdwSizeResponseHeaders. This pointer must be freed using the DFree() API.
[out]	pdwSizeResponseBody	Pointer that will contain the size of the data stored in the ppbResponseBody buffer, in bytes.
[out]	ppbResponseBody	Internally allocated buffer that will contain the body returned by the request. The allocated size is defined in pdwSizeResponseBody. This pointer must be freed using the DFree() API.
[in]	dwParam	Value Meaning 0 Default option. Does not verify the certificate against the hostname. PIX_VERIFY_HOST_NAME Verifies the certificate against the hostname. PIX_BASIC_HTTP_HEADER Uses the basic initial HTTP header. Includes Host, User-Agent, and Content-Length. PIX_GZIP Performs automatic gzip compression of request data. Automatically includes the necessary headers (Content-Encoding and Accept-Encoding).

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

It executes a secure request following the PIX standard defined in the SPI in the documents: "Annex IV - Security Manual", "Technical and business specifications of the Brazilian instant payment ecosystem" and "Annex III - Communication Interfaces Manual" defined in the SPI.
The negotiated tunnel is TLS version 1.2 with mutual authentication, using the HTTP protocol version 1.1 with a minimum Cipher Suite of ECDHE-RSA-AES-128-GCM-SHA256.

This API will automatically decompress a response that comes compressed in the gzip standard. If you choose to compress the sending data, the API caller must do so in gzip format.

This request uses the following headers by default.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", where 0.0.0.0 is the version of the HSM client library used.

Certificate validation with the host name is done by checking that the Common Name field or Subject Alternate Name field of the certificate matches the host name of the URL passed as a parameter.

When making an HTTP request, 2 operations are performed, one to use the HSM objects (private key, certificate and chain, used for tunnel authentication) and the other to open the HTTP session with the HTTP server.
To optimize resources, the session with the HTTP server is kept open and cached; likewise, the session with the HSM is cached by default (the HSM session can optionally be set not to be cached).
The HTTP session is associated with the session opened with the HSM, which means that to reuse an HTTP session you must use the same HSM session that was previously used to open the HTTP session.
The HTTP session is physically closed when the session with the HSM is physically closed.
The HSM session and the HTTP session have thread-session affinity and cannot be used simultaneously by several threads.

Long Polling is adjusted by setting the HTTP operation timeout (POST/GET/DELETE) according to the HTTP server settings.

See also

DFree() DPIXPut() DPIXGet() DPIXDelete()

Examples

post_put_get_delete_pix.c.

DPIXGet()

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 )

#include <dinamo.h>

It makes a secure HTTP GET request following the PIX standard defined in the SPI (Instant Payment System).

Note

Configure timeout settings. Refer to the Best Practices section for more details.

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for tunnel establishment. Corresponds to a CPIC certificate.
[in]	szCertId	Name of the certificate used for tunnel establishment. This is the PSP Digital Certificate registered with SPI for connection, also known as CPIC or CERTPIC.
[in]	szPIXCertChainId	Name of the PKCS#7 string used to check the PIX server (ICOM or DICT). As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object containing several strings.
[in]	szURL	URL of the server PIX (ICOM or DICT).
[in]	dwCountRequestHeaderList	Number of lines filled in pszRequestHeaderList.
[in]	pszRequestHeaderList	Lines containing the customized HTTP headers that will be used in the request. Can be passed null if you want to use the default header without changes. This option will overwrite the default headers if they overlap. To remove a header, pass the name of the header without a value (e.g. Accept:). To include a header with no content, use ; instead of : (e.g. Accept;). Do NOT use CRLF terminators in headers. Passing these terminators may cause unwanted behavior. Formatting will be done internally. This option cannot be used to change the first line of the request (e.g. POST, PUT, GET, DELETE), which is not a header. The corresponding API, described in this manual, must be used. The default initial header includes Host, User-Agent, Accept, Accept-Encoding.
[in]	dwTimeOut	Operation timeout in milliseconds. Can be set to 0 for no timeout.
[out]	pdwSizeResponseHeaders	Pointer that will contain the size of the data stored in the ppbResponseHeaders buffer, in bytes.
[out]	ppbResponseHeaders	Internally allocated buffer that will contain the header returned by the request. The size allocated is defined in pdwSizeResponseHeaders. This pointer must be freed using the DFree() API.
[out]	pdwSizeResponseBody	Pointer that will contain the size of the data stored in the ppbResponseBody buffer, in bytes.
[out]	ppbResponseBody	Internally allocated buffer that will contain the body returned by the request. The allocated size is defined in pdwSizeResponseBody. This pointer must be freed using the DFree() API.
[in]	dwParam	Value Meaning 0 Default option. Does not verify the certificate against the hostname. PIX_VERIFY_HOST_NAME Verifies the certificate against the hostname. PIX_BASIC_HTTP_HEADER Uses the basic initial HTTP header. Includes Host and User-Agent. PIX_GZIP Includes the Accept-Encoding: gzip header if the basic header is enabled.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

It executes a secure request following the PIX standard defined in the SPI in the documents: "Annex IV - Security Manual", "Technical and business specifications of the Brazilian instant payment ecosystem" and "Annex III - Communication Interfaces Manual" defined in the SPI.
The negotiated tunnel is TLS version 1.2 with mutual authentication, using the HTTP protocol version 1.1 with a minimum Cipher Suite of ECDHE-RSA-AES-128-GCM-SHA256.

This API will automatically decompress a response that comes compressed in the gzip standard. If you choose to compress the sending data, the API caller must do so in gzip format.

This request uses the following headers by default.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", where 0.0.0.0 is the version of the HSM client library used.

Certificate validation with the host name is done by checking that the Common Name field or Subject Alternate Name field of the certificate matches the host name of the URL passed as a parameter.

When making an HTTP request, 2 operations are performed, one to use the HSM objects (private key, certificate and chain, used for tunnel authentication) and the other to open the HTTP session with the HTTP server.
To optimize resources, the session with the HTTP server is kept open and cached; likewise, the session with the HSM is cached by default (the HSM session can optionally be set not to be cached).
The HTTP session is associated with the session opened with the HSM, which means that to reuse an HTTP session you must use the same HSM session that was previously used to open the HTTP session.
The HTTP session is physically closed when the session with the HSM is physically closed.
The HSM session and the HTTP session have thread-session affinity and cannot be used simultaneously by several threads.

Long Polling is adjusted by setting the HTTP operation timeout (POST/GET/DELETE) according to the HTTP server settings.

See also

DFree() DPIXPost() DPIXGet() DPIXDelete()

Examples

post_put_get_delete_pix.c.

DPIXDelete()

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 )

#include <dinamo.h>

It makes a secure HTTP DELETE request following the PIX standard defined in SPI (Instant Payment System).

Note

Configure timeout settings. Refer to the Best Practices section for more details.

Parameters

[in]	hSession	Context acquired through the DOpenSession() function.
[in]	szKeyId	Name of the private key used for tunnel establishment. Corresponds to a CPIC certificate.
[in]	szCertId	Name of the certificate used for tunnel establishment. This is the PSP Digital Certificate registered with SPI for connection, also known as CPIC or CERTPIC.
[in]	szPIXCertChainId	Name of the PKCS#7 string used to check the PIX server (ICOM or DICT). As of version 5.0.23 of the HSM firmware, it is possible to use a PKCS#7 object containing several strings.
[in]	szURL	URL of the server PIX (ICOM or DICT).
[in]	dwCountRequestHeaderList	Number of lines filled in pszRequestHeaderList.
[in]	pszRequestHeaderList	Lines containing the customized HTTP headers that will be used in the request. Can be passed null if you want to use the default header without changes. This option will overwrite the default headers if they overlap. To remove a header, pass the name of the header without a value (e.g. Accept:). To include a header with no content, use ; instead of : (e.g. Accept;). Do NOT use CRLF terminators in headers. Passing these terminators may cause unwanted behavior. Formatting will be done internally. This option cannot be used to change the first line of the request (e.g. POST, PUT, GET, DELETE), which is not a header. The corresponding API, described in this manual, must be used. The default initial header includes Host, User-Agent, Accept, Accept-Encoding.
[in]	dwTimeOut	Operation timeout in milliseconds. Can be set to 0 for no timeout.
[out]	pdwSizeResponseHeaders	Pointer that will contain the size of the data stored in the ppbResponseHeaders buffer, in bytes.
[out]	ppbResponseHeaders	Internally allocated buffer that will contain the header returned by the request. The size allocated is defined in pdwSizeResponseHeaders. This pointer must be freed using the DFree() API.
[out]	pdwSizeResponseBody	Pointer that will contain the size of the data stored in the ppbResponseBody buffer, in bytes.
[out]	ppbResponseBody	Internally allocated buffer that will contain the body returned by the request. The allocated size is defined in pdwSizeResponseBody. This pointer must be freed using the DFree() API.
[in]	dwParam	Value Meaning 0 Standard option for SPB certificates. Does not verify the certificate against the hostname. PIX_VERIFY_HOST_NAME Verifies the certificate against the hostname. PIX_BASIC_HTTP_HEADER Uses the basic initial HTTP header. Includes Host and User-Agent. PIX_GZIP Includes the Accept-Encoding: gzip header if the basic header is enabled.

Returns

0 (ZERO) if the function is successful.
Refer to the Return Codes section for other values.

Notes

It executes a secure request following the PIX standard defined in the SPI in the documents: "Annex IV - Security Manual", "Technical and business specifications of the Brazilian instant payment ecosystem" and "Annex III - Communication Interfaces Manual" defined in the SPI.
The negotiated tunnel is TLS version 1.2 with mutual authentication, using the HTTP protocol version 1.1 with a minimum Cipher Suite of ECDHE-RSA-AES-128-GCM-SHA256.

This API will automatically decompress a response that comes compressed in the gzip standard. If you choose to compress the sending data, the API caller must do so in gzip format.

This request uses the following headers by default.
"Accept-Encoding: gzip"
"User-Agent: DNLC/0.0.0.0", where 0.0.0.0 is the version of the HSM client library used.

Certificate validation with the host name is done by checking that the Common Name field or Subject Alternate Name field of the certificate matches the host name of the URL passed as a parameter.

When making an HTTP request, 2 operations are performed, one to use the HSM objects (private key, certificate and chain, used for tunnel authentication) and the other to open the HTTP session with the HTTP server.
To optimize resources, the session with the HTTP server is kept open and cached; likewise, the session with the HSM is cached by default (the HSM session can optionally be set not to be cached).
The HTTP session is associated with the session opened with the HSM, which means that to reuse an HTTP session you must use the same HSM session that was previously used to open the HTTP session.
The HTTP session is physically closed when the session with the HSM is physically closed.
The HSM session and the HTTP session have thread-session affinity and cannot be used simultaneously by several threads.

Long Polling is adjusted by setting the HTTP operation timeout (POST/GET/DELETE) according to the HTTP server settings.

See also

DFree() DPIXPost() DPIXPut() DPIXGet()

Examples

post_put_get_delete_pix.c.