EFT

Descrição detalhada

Operações para Transferência Eletrônica de Fundos.

EFT

As APIs do módulo EFT (Eletronic Funds Transfer) são destinadas às operações de autenticação e verificação de identidade de usuários em transações com cartões Visa e Mastercard.

A identidade do usuário de cartão normalmente pode ser verificada de duas formas:

1. assinatura manuscrita, comparada com um cartão de assinatura mantido pelo emissor de cartão;
2. através de um PIN (Personal Identification Number) informado pelo usuário; A verificação via PIN pode ser feita online, com uma validação feita pelo emissor do cartão, ou offline, usando um cartão com chip.

Os padrões adotados estão em conformidade com o Manual de Padrões de Tecnologia de Pagamentos da Visa (Payment Technology Standards Manual, October 2007).

De forma genérica, o processo de transferência de fundos com cartão, segue o fluxo da figura abaixo. Há vários atores envolvidos no processo. O portador do cartão (card holder) o apresenta ao lojista (Retailer/Merchant), a autenticidade do portador pode ser verificada através de um PIN, que o portador digita na estação do lojista (por exemplo um terminal tipo POS, Point of Sale). A partir daí o PIN é cifrado (é gerado um PIN Block) e os dados da transação são enviados para um prestador de serviços de pagamento eletrônicos, contratado pelo lojista (Acquirer), que por sua envia os dados para o esquema de cartão correspondente, conforme o brand do cartão usado pelo portador, e daí é enviado para o emissor do cartão, que tem os dados de identificação, crédito e outros a respeito do portador e mantém contrato com este para uso do serviço. Após analisar os dados da transação, quanto á cadastro, crédito e autenticação, entre outros, o emissor pode autorizar ou recusar a transação, e esta mensagem de resposta percorre o fluxo no sentido inverso.

--- title: Processo genérico de transferência eletrônica de fundos --- sequenceDiagram autonumber participant Portador participant Loja participant Rede participant Bandeira participant Banco Portador ->> Loja: Cartão/PIN/CVV activate Loja Loja ->> Rede: Dados
Transação deactivate Loja activate Rede Rede ->> Bandeira: Dados
Transação deactivate Rede activate Bandeira Bandeira ->> Banco: Dados
Transação deactivate Bandeira activate Banco Banco ->> Bandeira: $ deactivate Banco activate Bandeira Bandeira ->> Rede: $ deactivate Bandeira activate Rede Rede ->> Loja: $ deactivate Rede activate Loja Loja ->> Portador: Mercadorias/
Serviços deactivate Loja Banco -->> Portador: Débito Portador -->> Banco: $

Do ponto de vista das chaves de criptografia usadas no processo, o processo é mostrado na figura abaixo. Cada ator mantém suas próprias chaves, e sempre que uma mensagem criptografada precisa ir de um ator para outro, a criptografia deve ser traduzida, ou seja, deve ser usada a chave correspondente do ator que deverá fazer a decriptografia da mensagem.

--- title: Chaves criptográficas na transferência de fundos --- sequenceDiagram participant Portador participant Loja participant Rede participant Bandeira participant Banco destroy Portador Portador ->> Loja: Cartão/PIN/CVV destroy Loja Loja ->> Rede: PIN Block Note over Rede: HSM:
PIN Translation Note over Rede: ZCMK
AWK
... destroy Rede Rede ->> Bandeira: PIN Block Note over Bandeira: HSM:
PIN Translation Note over Bandeira: ZCMK
AWK
IWK
... destroy Bandeira Bandeira ->> Banco: PIN Block activate Banco Note over Banco: HSM:
PIN Block Verification
CVV Verification Note over Banco: ZCMK
IWK
CVK
PVK
... deactivate Banco

Variações ou simplificações do esquema acima podem ser usados, por exemplo quando a mesma entidade tem mais de um papel, ou há uma comunicação direta do prestador (acquirer) com o emissor (issuer), como pode acontecer em certas transações de débito em conta.

Observação

1. Cada chave criptográfica deve ser dedicada a apenas um aplicação, conforme determina o manual da Visa.
2. Os tamanhos informados dos parâmetros se referem aos dados; a aplicação deve garantir que o buffer passado tenha espaço suficiente para os dados e mais o caracter terminador.
3. O módulo EFT trabalha com tamanho de PIN de 4 (MIN_EFT_PIN_LEN) a 12 (MAX_EFT_PIN_LEN) dígitos.

Sobre o suporte ao algoritmos do protocolo 3-D Secure:

O HSM Dinamo implementa os algoritmos criptográficos que suportam o protocolo 3-D Secure, desenvolvido pela Visa. Os serviços Verified by Visa da Visa e Secure Code da Mastercard são oferecidos pelas bandeiras baseados neste protocolo. O HSM implementa os algoritmos criptográficos de verificação de cartão que dão suporte ao protocolo e aos serviços, permitindo ao usuário do HSM fazer a geração e a verificação dos códigos, CVC2 (Card Verification Code 2) e HMAC SHA1 no caso da Mastercard (Secure Payment Application Algorithm) e CAVV (Cardholder Authentication Verification Value, CVV2 com método ATN) no caso da Visa.

O HSM possui suporte aos mecanismos de autenticação CAP (Visa) e DPA (Mastercard).

O HSM fornece suporte ao ATM Remote Key Loading/Transport através de funcionalidades criptográficas baseadas em funções RSA e X.509.

A implementação do HSM está de acordo com os padrões definidos na documentação listada abaixo:

EMVCo

• Integrated Circuit Card Specifications for Payment Systems, Book 2, Security and Key Management v. 4.2, junho 2008
• EMV Card Personalization Specification, v. 1.1, julho 2007

Visa

• Payment Technology Standards Manual, outubro 2007
• Visa Certification Authority Public Keys for Visa Smart Debit/Credit (VSDC), fevereiro 2007
• Visa Smart Debit/Credit Certification Authority Technical Requirements v. 2.1, abril 2006
• 3-D Secure Functional Requirements Access Control Server v. 1.0.2, maio 2006
• Visa Integrated Circuit Card v. 1.4.0, outubro 2001

Mastercard

• M/Chip Lite 2.1 Card Application Specifications for Debit and Credit, abril 2003
• M/Chip 4 Version 1.1 Issuer Guide to Debit and Credit Parameter Management, janeiro 2007
• M/Chip 4 Version 1.1 Security & Key Management, junho 2006
• Public Key Infrastructure (PKI) — Certification Authority Interface Specification, janeiro 2005
• Public Key Infrastructure (PKI) — Certification Authority Member Procedures, janeiro 2006
• SPA Algorithm for the MasterCard Implementation of 3-D Secure v1.04, maio 2004

Elo

• ELO Chip Card, CCD Cryptographic Algorithms, s/ versão, s/ data.
• Manual da Autoridade Certificadora Elo - Guia do Emissor, versão 1.2, setembro 2011

JCB

• JCB IC Card Specification, v. 2.0, outubro 2012
• JCB CA Interface Guide, s/ versão, janeiro 2014
• JCB Key Guide, s/ versão, janeiro 2014

Outros

• ANSI X9.24 part 1, Retail Financial Services Symmetric Key Management Part 1: Using Symmetric Techniques
• ASC X9 TR 31-2018, Interoperable Secure Key Exchange Key Block Specification, April 15, 2018
• ASC X9 TR 34–2019, Interoperable Method for Distribution of Symmetric Keys using Asymmetric Techniques: Part 1 – Using Factoring-Based Public Key Cryptography Unilateral Key Transport, September 22, 2019
• IBM z/OS V1R9.0 Cryptographic Services ICSF Application Programmer's Guide (3624 PIN Formats and Algorithms)
• ISO/IEC 9797-1 Method 2, Information technology - Security techniques - Message Authentication Codes (MACs) - Part 1, 1999
• IDTECH USER MANUAL SecureMag Encrypted MagStripe Reader (80096504-001 RevL 06/19/14)

Mecanismos de CVV

Há três formas de geração e verificação de CVV (Card Verification Value) no HSM:

1. Card Verification Value (CVV), para transações com cartões de tarja magnética;
2. Card Verification Value 2 (CVV 2); para transações sem a presença física do cartão (via telefone, correios ou Internet, por exemplo);
3. Alternate Card Verification Value (iCVV), para transações com cartões de chip; O mecanismo de cálculo é o mesmo nas três formas, e a diferença está na forma de entrada dos dados pela aplicação.

A chave usada para os cálculos de geração e verificação de CVV é denominada CVK (Card Verification Key). Esta chave é interna ao HSM, a aplicação precisa apenas informar seu nome de chave (id). Fisicamente é uma chave 3DES de 112 bits, o que corresponde à duas chaves de DES de 56 bits.

A Figura abaixo ilustra os esquema para geração e verificação de CVV, iCVV e CVV2.

--- title: Geração de CVV / iCVV / CVV2 --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TB PAN[PAN] Service[Código de serviço / 99/ 000] Data[Data de expiração] CVKid[CVK id] H[\"HSM: CVK (3DES 112)"/] cvv((CVV)) icvv((iCVV)) cvv2((CVV 2)) PAN --> H Service --> H Data --> H CVKid --> H H --> cvv H --> icvv H --> cvv2

Mecanismos de PIN

O HSM trabalha com geração de PIN (Personal Identification Number) por mecanismo de derivação, a partir de uma chave interna, denominada PGK (PIN Generation Key). Esta forma de geração tem várias vantagens, principalmente em relação ao método de geração de PIN com valores aleatórios, pois dispensa o uso de um banco de dados para validação (com provável exposição de dados sigilosos) e ainda mantém tanto o processo de geração quanto de validação, mais seguros, já que são realizados internamente ao HSM.

O padrão utilizado na geração de PIN pelo HSM é o IBM 3624, com o emprego de offsets para permitir a troca de PIN pelo usuário ou pelo emissor do cartão. Para mitigar ataques de decimalização e verificação, o HSM emprega uma tabela de conversão interna, não exposta para a aplicação. Como fator de segurança adicional é empregado uma chave 3DES de 168 bits, ao invés de uma 3DES de 112 bits; não há interferência na operação do algoritmo, já que as chaves DES e 3DES utilizam blocos de entrada e saída do mesmo tamanho.

--- title: Geração de PIN por derivação --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TB PAN[PAN] InPIN[InPIN] Offset[offset] PGKid[PGK id] H[\"HSM: CVK (3DES 112)"/] r((PIN)) PAN --> H InPIN --> H Offset --> H PGKid --> H H --> r

Estão definidos três modos de geração de PIN por derivação:

1. a partir do PAN (Personal Account Number), do PIN de entrada (inPIN) e da PGK;
2. a partir de um PIN de entrada e da PGK, com o uso de um offset permite a troca do PIN pelo usuário;
3. a partir do PAN, da PGK e um PIN de entrada, com o uso de um offset permite a troca de PIN automática;

Não há tratamento para regras de negócio dos PIN gerados dentro do HSM, tal função deve ser exercida pela aplicação chamadora.

Os algoritmos para geração usando o padrão IBM 3624 são mostrados nos diagramas abaixo.

--- title: Algoritmo de Geração de PIN IBM 3624 --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TD Dado{{Dado de Validação}} PGK{{PGK}} Op3DES[\Operação 3DES/] Troca[Troca de dígito] Ajuste[Ajuste de tamanho] Pin((PIN)) Dado --> Op3DES PGK --> Op3DES Op3DES -- Tabela de decimalização interna --> Troca Troca -- PIN Intermediário --> Ajuste Ajuste --> Pin

Para permitir que o usuário (cardholder) selecione o próprio PIN, um PIN offset é usado no método IBM 3624, com isso duas novas entradas são necessárias, o PIN definido pelo usuário e um check de tamanho de 4 bits. A operação com offset é realizada após os passos do algoritmo IBM 3624, mostrado acima. Com isso o processo interno do HSM consegue realizar a validação do PIN, mesmo que o usuário defina um PIN diferente daquele gerado inicialmente pelo HSM.

--- title: Algoritmo de Geração de PIN IBM 3624 com offset --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TD Dado{{Dado de Validação}} PGK{{PGK}} Op3DES[\Operação 3DES/] Troca[Troca de dígito] Ajuste[Ajuste de tamanho] Sub[\"Subtração em módulo 10
(InPin -PIN)"/] OpOff[\Operação de offset no PIN/] Pin((PIN)) InPin{{"InPin
(PIN gerado pelo usuário)"}} Of{{"dado de offset
(4-bit)"}} Dado --> Op3DES PGK --> Op3DES Op3DES -- Tabela de decimalização interna --> Troca Troca -- PIN Intermediário --> Ajuste Ajuste --> Sub Sub --> OpOff OpOff --> Pin InPin --> Sub Of --> OpOff

As operações de tradução de PIN Block (PIN Block Translate) funcionam com duas chaves, uma de origem e uma de destino; há uma fase intermediária para compatibilizar o formato de entrada ao formato de saída, caso seja possível. Há certos formatos de blocos que não são interoperáveis, ou por ausência de dados para a conversão ou por restrição da norma.

O modo de tradução default do HSM implica na tradução do bloco de entrada para o formato ISO PIN Block Format 0. No modo de tradução automático, a conversão é realizada de forma opaca, convertendo do bloco com a chave de origem para o bloco com a chave de destino, sem análise do formato ou conteúdo do bloco.

--- title: Operação de PIN Translate --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TD blockin{{Bloco de entrada}} keyin{{Chave de entrada}} OpDES1[\DES/] Prep[Preparação] OpDES2[\DES/] keyout{{Chave de destino}} blockout{{Bloco da saída}} blockin --> OpDES1 keyin --> OpDES1 OpDES1 --> Prep Prep --> OpDES2 keyout --> OpDES2 OpDES2 --> blockout

Na verificação de um PIN Block ocorrem duas operações com chaves, primeiro o PIN Block é decifrado com a chave PTK (PIN Transport Key), do bloco do PIN decifrado, é extraído o PIN, e a partir daí é realizada a verificação de PIN usando a PGK (PIN Generation Key, a mesma chave utilizada para a geração original do PIN). Esta verificação pode ser feita com ou sem o uso de um offset; este PIN offset não faz parte do PIN Block e não é criptografado pela PTK. O formato de PIN Block esperado é o ISO PIN Block Format 0 (equivalente ao ANSI PIN Block Format 0 e ao VISA PIN Block Format 1).

--- title: Operação de Verificação de PIN Block --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TD pinblock{{PIN Block}} ptk{{PTK}} OpDES1[\DES/] Prep[PIN, PAN, ...] pin[PIN] pgk{{PGK}} off{{offset}} OpDES2[\3DES/] r((Result)) ptk --> OpDES1 pinblock --> OpDES1 OpDES1 --> Prep Prep --> pin pin --> OpDES2 pgk --> OpDES2 off --> OpDES2 OpDES2 --> r

Mecanismos de DUKPT

DUKPT (Derived Unique Key Per Transaction) é uma forma de utilizar chaves únicas por transação, derivadas a partir de uma chave fixa, sendo este processo definido na ANSI X9.24 part 1.

A KSN (Key Serial Number) é o identificador de uma chave de transação, sendo dividida em partes como: KSI (Key Set ID), TRSM (Tamper Resistant Security Module), identificador do POS (Point of Sale) também conhecido como DID (Device ID) e o CTR (Transaction Counter).

--- title: Geração chaves DUKPT --- sequenceDiagram participant hsm as HSM participant pos as PoS/ATM
Device Note over hsm: BDK activate hsm hsm ->> hsm: IPEK (Device Id) deactivate hsm hsm ->> pos: IPEK Note over pos: IPEK

O HSM utiliza as partes da KSN separadas em KSI e DID + CTR cada uma contendo 5 bytes.

Os passos do processo de utilização de DUKPT são, em cada ponta da comunicação:

No POS:

1. Previamente inicializado com uma IPEK derivada de uma BDK.
2. Gera (ou recupera de uma tabela de chaves futuras) a chave futura utilizando o DID e CTR.
3. Encripta o bloco necessário (Ex.: PIN Block).
4. Envia KSN + Bloco encriptado. KSN é composto de TRMS (ou DID), KSI e CTR.
5. Incrementa o CTR interno.

No HSM:

1. Recebe KSN + Bloco Encriptado.
2. Seleciona a BDK apropriada baseado na KSN recebida. KSN é composto de TRMS (ou DID), KSI e CTR.
3. Gera a IPEK baseado no BDK e KSN selecionados.
4. Utiliza a IPEK, o DID e o CTR contidos no KSN para gerar a chave de sessão.
5. Decripta o Bloco e faz o processamento necessário.
6. O POS tem uma chave IPEK (Initial Pin Encryption Key) derivada de uma BDK (Base Derivation Key). Esta BDK está armazenada dentro do HSM e é utilizada na regeração da IPEK do respectivo POS e então esta IPEK é utilizada na derivação das chaves únicas de transação deste POS.

--- title: Comunicação DUKPT entre o POS/ATM e o HSM --- sequenceDiagram participant pos as PoS/ATM
Device participant hsm as HSM Note over pos: IPEK activate pos pos ->> pos: KSI,CTR pos ->> pos: Chave de sessão pos ->> pos: Texto claro > bloco cifrado deactivate pos pos ->> hsm: bloco cifrado
TRSM (Device Id)
KSI
CTR activate hsm Note over hsm: BDK hsm ->> hsm: IPEK (Device Id) hsm ->> hsm: KSI,CTR hsm ->> hsm: Chave de sessão hsm ->> hsm: bloco cifrado > texto claro deactivate hsm

Key-wrapping TR-31

É um processo de wrapping/_unwrapping_ com proteção de confidencialidade e integridade para chaves e dados associados, definido no documento ASC X9 TR 31-2018.

KBPK (Key Block Protection Key) é a chave de derivação utilizada para derivar as chaves de encriptação e autenticação. Esta chave é utilizada apenas para derivação. Também conhecida como KWK (Key Wrapping Key). Armazenada no HSM.

KBEK (Key Block Encryption Key) é a chave derivada da KBPK e usada apenas para a encriptação do key klock. Gerada a cada operação de wrap/unwrap, não é armazenada de forma persistente no HSM.

KBAK (Key Block Authentication Key) é a chave derivada da KBPK e usada apenas para o cálculo do MAC do key klock. Gerada a cada operação de wrap/unwrap, não é armazenada de forma persistente no HSM.

KDID (Key Derivation Input Data) são os dados utilizados para a derivação das chaves KBEK e KBAK. Contém dados como: counter, key usage indicator, algorithm indicator e tamanho. Varia de acordo com o método de derivação utilizado, chave que será derivada e demais parâmetros.

A derivação das chaves KBEK e KBAK utiliza o CMAC tendo como entrada o Key Derivation Input Data (específico de cada chave derivada) e a chave KBPK.

--- title: Processo de derivação KBEK e KBAK --- %%{ init: { 'flowchart': { 'curve': 'basis' } } }%% flowchart TD kbekin("Key derivation
input data
KBEK") kbakin("Key derivation
input data
KBAK") cmac1([CMAC]) kbpk(KBPK) cmac2([CMAC]) kbek("Key Block
Encryption Key") kbak("Key Block
Authentication Key") kbekin --> cmac1 kbakin --> cmac2 cmac1 --> kbek cmac2 --> kbpk cmac2 --> kbak cmac1 --> kbpk

Key block contém os dados da chave exportada. Este bloco é divido em 3 partes:

1. KBH (Key Block Header) contém informações sobre a chave e o key block.

1. Os dados confidenciais que serão enviados/guardados. É encriptado com a chave KBEK. Os dados de entrada para a encriptação são: o tamanho da chave, a chave e o padding.

1. O MAC que que liga o KBH e o key block encriptado. É gerado utilizando a chave KBAK. Os dados de entrada para a operação de MAC são: o KBH, e os dados de entrada para a encriptação.

%%{init: { 'theme': 'dark' } }%% timeline title Processo de Geração do Key Block section KBH section Bloco Cifrado Inputs#58; : tamanho da chave : chave KBEK : padding section MAC Inputs#58; : KBH : tamanho da chave : chave KBAK : padding

Definições

• KSN: Key Serial Number
• KSI: Key Set ID
• TRSM: Tamper Resistant Security Module
• POS: Point of Sale
• CTR: Transaction Counter
• DID: Device ID
• BDK: Base Derivation Key
• IPEK: Initial Pin Encryption Key
• ATM: Automatic Teller Machine
• KBPK: Key Block Protection Key
• KBEK: Key Block Encryption Key
• KBAK: Key Block Authentication Key
• AESKW: AES Key Wrap
• TDKW: Tripple DES Key Wrap
• KWK: Key Wrapping Key
• KBH: Key Block Header

Estruturas de Dados
class	DinamoClient.PinComponents
	Classe que encapsula os componentes da geração de PIN. Mais...

Enumerações
enum	GenPINOperation : UInt32 { DEFAULT_PIN = DinamoApi.GP_DEFAULT_PIN , USER_DEF_PIN = DinamoApi.GP_USER_DEF_PIN , RANDOM_PIN = DinamoApi.GP_RANDOM_PIN }
	Opções de operação de PIN. Mais...

Funções
string	GenBDKName (byte[] pbKSI)
	Gera o nome da BDK a partir de uma KSI (Key Serial Identification).
string	GenBDKName (byte[] pbKSI, uint dwParam)
	Gera o nome da BDK a partir de uma KSI (Key Serial Identification).
string	GenDUKPT (byte[] pbKSI, byte[] pbDID_CTR, uint dwParam)
	Gera uma chave DUKPT dentro do HSM utilizando uma KSI (Key Serial Identification), um DID (Device ID) e um CTR (Transaction Counter) de uma mesma KSN (Key Serial Number).
string	GenCVV (string keyId, string pan, string expirationDate, string serviceCode)
	Gera um CVV (Card Verification Value), CVV2 ou iCVV utilizando uma chave dentro do HSM. Esta API também pode ser usada para a geração dos códigos de verificação de cartão que suportam o protocolo 3-D Secure.No caso da Visa o serviço que implementa o protocolo é o Verified by Visa, e o HSM suporta o padrão CAVV (Cardholder Authentication Verification Value, que é o CVV2 com método ATN). No caso da Mastercard o protocolo 3-D Secure é implementado no serviço SecureCode, o HSM suporta os padrões CVC2(Card Verification Code 2) e HMAC SHA1.
bool	VerifyCVV (string keyId, string pan, string expirationDate, string serviceCode, string cvv)
	Verifica um CVV (Card Verification Value), , CVV2 ou iCVV utilizando uma chave dentro do HSM. A API também pode ser usada para a verificação dos códigos de verificação de cartão que suportam o protocolo 3-D Secure. Veja mais detalhes na API GenCVV().
PinComponents	GenPIN (string pgk, string pan, GenPINOperation operation, int pinLen, string inPin)
	Faz operações de geração de PIN a partir dos dados de PAN (Personal Account Number) e nome de chave (PGK) informadas, com ou sem uso de offset.
bool	VerifyPINBlock (string ptk, string pgk, string pan, string offset, byte[] pinblock)
	Verifica a validade de um PIN em um PIN Block. Primeiro o PIN é extraído do PIN Block com a chave PTK, e depois é feita sua verificação com a chave PGK, a mesma que foi usada para geração do PIN, com a função GenPIN().
byte[]	ExportTR31 (string kbpk, string key, EftExportUsage usage, EftExportMode mode, EftExportExpType exp)
	Exporta uma chave no formato TR-31 de acordo com o padrão ASC X9 TR 31-2018.
void	ImportTR31 (string kbpk, string key, bool isExportable, bool isTemporary, byte[] keyBlock)
	Importa uma chave no formato TR-31 de acordo com o padrão ASC X9 TR 31-2018.

Enumerações

GenPINOperation

enum GenPINOperation : UInt32

Opções de operação de PIN.

Enumeradores
DEFAULT_PIN
USER_DEF_PIN
RANDOM_PIN

Exemplos

eft_gen_pin.cs.

Funções

GenBDKName() [1/2]

string GenBDKName ( byte[] pbKSI )

inline

Gera o nome da BDK a partir de uma KSI (Key Serial Identification).

Parâmetros

pbKSI

Buffer de tamanho MIN_KSI_LEN contendo o KSI.

Retorna

O nome de chave BDK gerada a partir do KSI informado em pbKSI.

Exceções

DinamoException

Lança exceção em caso de erro.

Exemplos

dukpt.cs.

GenBDKName() [2/2]

string GenBDKName ( byte[] pbKSI, uint dwParam )

inline

Gera o nome da BDK a partir de uma KSI (Key Serial Identification).

Parâmetros

pbKSI	Buffer de tamanho MIN_KSI_LEN contendo o KSI.
dwParam	Reservado para uso futuro.

Retorna

O nome de chave BDK gerada a partir do KSI informado em pbKSI.

Exceções

DinamoException

Lança exceção em caso de erro.

GenDUKPT()

string GenDUKPT ( byte[] pbKSI, byte[] pbDID_CTR, uint dwParam )

inline

Gera uma chave DUKPT dentro do HSM utilizando uma KSI (Key Serial Identification), um DID (Device ID) e um CTR (Transaction Counter) de uma mesma KSN (Key Serial Number).

Parâmetros

pbKSI	Buffer de tamanho MIN_KSI_LEN contendo o KSI.
pbDID_CTR	Buffer de tamanho MIN_CTR_LEN contendo o DID e CTR (últimos 05 bytes do KSN).
dwParam	Flags de operação de acordo com a tabela abaixo. NEW_DUKPT_MODE_DUK : Gera uma chave DUK (Derived Unique Key) padrão de acordo com o manual ISO X9.24-1-2004. NEW_DUKPT_MODE_PEK : Gera uma chave PEK (PIN Encryption Key) de acordo com o manual ISO X9.24-1-2004 A aplicando o XOR da máscara 0000 0000 0000 FF00 nas partes da chave. NEW_DUKPT_MODE_MEK : Gera uma chave MEK (MAC Encryption Key) de acordo com o manual ISO X9.24-1-2004 A aplicando o XOR da máscara 0000 0000 0000 00FF nas partes da chave. NEW_DUKPT_MODE_DE : Diversifica a chave gerada no formato Data Encryption. Aplica um XOR da máscara 0000 0000 00FF 0000 0000 0000 00FF 0000 sobre a chave DUKPT gerada, encripta a chave esquerda da DUKPT utilizando a DUKPT gerada e repete a encriptação com a chave direita. Após esta operação junta as partes esquerda e direita encriptadas para formar a Data Encryption Key. Como descrito em IDTECH USER MANUAL SecureMag Encrypted MagStripe Reader (80096504-001 RevL 06/19/14). Deve ser utilizada combinada (via operação OR) com uma das flags: NEW_DUKPT_MODE_DUK, NEW_DUKPT_MODE_PEK ou NEW_DUKPT_MODE_MEK NEW_DUKPT_MODE_EXP : Gera uma chave DUKPT exportável. Esta é uma flag de atributo e deve ser utilizada combinada com outras flags. Utilizar apenas se especificamente necessário. NEW_DUKPT_MODE_TMP : Gera uma chave DUKPT temporária. Esta é uma flag de atributo e deve ser utilizada combinada com outras flags. NEW_DUKPT_MODE_IPEK : Gera uma chave IPEK (Initially Loaded PIN Entry Device Key) de acordo com o manual ISO X9.24-1-2004 A-6.

Retorna

O nome de chave BDK gerada a partir do KSI informado em pbKSI.

Exceções

DinamoException

Lança exceção em caso de erro.

Exemplos

dukpt.cs.

GenCVV()

string GenCVV ( string keyId, string pan, string expirationDate, string serviceCode )

inline

Gera um CVV (Card Verification Value), CVV2 ou iCVV utilizando uma chave dentro do HSM. Esta API também pode ser usada para a geração dos códigos de verificação de cartão que suportam o protocolo 3-D Secure.No caso da Visa o serviço que implementa o protocolo é o Verified by Visa, e o HSM suporta o padrão CAVV (Cardholder Authentication Verification Value, que é o CVV2 com método ATN). No caso da Mastercard o protocolo 3-D Secure é implementado no serviço SecureCode, o HSM suporta os padrões CVC2(Card Verification Code 2) e HMAC SHA1.

Parâmetros

keyId	Identificador da chave dentro do HSM. Este identificador não deve conter espaços ou caracteres especiais. Caracteres maiúsculos e minúsculos são diferenciados (case-sensitive). Esta chave é a CVK (Card Verification Key), uma chave 3DES de 112 bits, e deve ser a mesma que será usada para a verificação do CVV. Esta chave pode ser gerada internamente no HSM ou importada manualmente. Normalmente esta chave também é usada na Visa, enviada cifrada pela ZCMK (Zone Contro Master Key). Conforme determinado no manual da Visa, a chave 3DES 112 usada como CVK deve ser diferente da chave usada para geração e verificação de PIN e não deve ser usada para outras aplicações do emissor, com exceção do CVV2 e iCVV.
pan	PAN (Primary Account Number). Tamanho de de 12 a 19 caracteres. Para o cálculo de CVV, CVV2 e iCVV, conforme o padrão da Visa, no documento Payment Technology Standards Manual, de 2007, é independente do tamanho do PAN. Para o cálculo de CVC2, conforme o documento da Mastercard SPA Algorithm for the MasterCard Implementation of 3-D Secure – v1.04, o tamanho do PAN deve ser exatamente de 16 dígitos; quando for menor precisa se completado à esquerda com zeros, e quando for maior devem ser usados apenas os 16 dígitos mais à direita.
expirationDate	Data de expiração. Tamanho de 4 dígitos. Na geração de CVV e iCVV o formato deve ser YYMM. Na geração de CVV2 o formato deve ser MMYY. No cáculo de CVC2 este campo deve ser uma string terminada em zero com os 4 dígitos menos significativos do Transaction Sequence Number, contido no AVV (Accountholder Authentication Value) convertido no BCD decimal equivalente. Qualquer valor menor que 4 dígitos deve ser completado à esquerda com zeros até inteirar os 4 dígitos. Para mais detalhes consulte o documento da Mastercard SPA Algorithm for the MasterCard Implementation of 3-D Secure – v1.04. No cáculo de CAVV (CVV2 com o Método ATN), este campo deve ser uma string terminada em zero com os 4 dígitos menos significativos do ATN (Authentication Tracking Number). Para mais detalhes consulte o documento da Visa 3-D Secure Functional Requirements Access Control Server v. 1.0.2.
serviceCode	Service Code. Tamanho de 3 dígitos. Para a geração de iCVV (Alternate Card Verification Value), o Service Code deve ser 999. Para a geração de CVV 2, o Service Code deve ser 000. Para a geração de CVV tradicional, o Service Code normalmente é 101.

Retorna

O CVV gerado, com tamanho de 3 dígitos. O valor gerado pode também ser um CVV2 ou iCVV, conforme os valores informados de Service Code.

Exceções

DinamoException

Lança exceção em caso de erro.

Anotações

A API também é compatível com o padrão da bandeira American Express.

Exemplos

eft_gen_verify_cvv.cs.

VerifyCVV()

bool VerifyCVV ( string keyId, string pan, string expirationDate, string serviceCode, string cvv )

inline

Verifica um CVV (Card Verification Value), , CVV2 ou iCVV utilizando uma chave dentro do HSM. A API também pode ser usada para a verificação dos códigos de verificação de cartão que suportam o protocolo 3-D Secure. Veja mais detalhes na API GenCVV().

Parâmetros

keyId	Identificador da chave dentro do HSM. Este identificador não deve conter espaços ou caracteres especiais. Caracteres maiúsculos e minúsculos são diferenciados (case-sensitive). Esta chave é a CVK (Card Verification Key), uma chave 3DES de 112 bits, e deve ser a mesma que foi usada na geração do CVV.
pan	PAN (Primary Account Number). Tamanho de de 12 a 19 caracteres. Veja mais detalhes sobre este campo na API GenCVV().
expirationDate	Data de expiração. Tamanho de 4 dígitos. Na verificação de CVV e iCVV o formato deve ser YYMM. Na verificação de CVV 2 o formato deve ser MMYY. Para informações sobre o suporte aos algoritmos do protocolo 3-D Secure veja mais detalhes sobre este campo na API GenCVV().
serviceCode	Service Code. Tamanho de 3 dígitos. Para a verificação de iCVV (Alternate Card Verification Value), o Service Code deve ser 999. Para a verificação de CVV 2, o Service Code deve ser 000
cvv	CVV a ser validado. Tamanho de 3 dígitos. O valor informado pode também ser um CVV2 ou iCVV, conforme os valores informados de Service Code.

Retorna

true se o CVV foi validado com sucesso e false caso seja inválido.

Exceções

DinamoException

Lança exceção em caso de erro.

Exemplos

eft_gen_verify_cvv.cs.

GenPIN()

PinComponents GenPIN ( string pgk, string pan, GenPINOperation operation, int pinLen, string inPin )

inline

Faz operações de geração de PIN a partir dos dados de PAN (Personal Account Number) e nome de chave (PGK) informadas, com ou sem uso de offset.

Parâmetros

pgk	Identificador da chave PGK (PIN Generation Key), dentro do HSM.
pan	PAN (Primary Account Number).
operation	Tipo da geração do PIN. Segundo a tabela abaixo. Valor Significado GenPINOperation.DEFAULT_PIN Gera o PIN padrão baseado no PAN e PGK. O parâmetro inPin deve ser null. GenPINOperation.USER_DEF_PIN Gera um offset referente ao PIN definido pelo chamador. O parâmetro inPin deve conter o PIN. GenPINOperation.RANDOM_PIN Gera um PIN e offset aleatoriamente baseados no PAN e PGK. inPin deve ser null.

Parâmetros

pinLen	Tamanho de PIN a ser utilizado/gerado na operação. Deve ter tamanho entre DinamoApi.MIN_EFT_PIN_LEN e DinamoApi.MAX_EFT_PIN_LEN.
inPin	PIN de entrada. Deve ter tamanho entre DinamoApi.MIN_EFT_PIN_LEN e DinamoApi.MAX_EFT_PIN_LEN.

Retorna

PIN e offset.

Exceções

DinamoException

Lança exceção em caso de erro.

Exemplos

eft_gen_pin.cs.

VerifyPINBlock()

bool VerifyPINBlock ( string ptk, string pgk, string pan, string offset, byte[] pinblock )

inline

Verifica a validade de um PIN em um PIN Block. Primeiro o PIN é extraído do PIN Block com a chave PTK, e depois é feita sua verificação com a chave PGK, a mesma que foi usada para geração do PIN, com a função GenPIN().

Parâmetros

ptk	Identificador da chave de decriptação do “PIN Block” dentro do HSM. PIN Transport Key (PTK).
pgk	Identificador da chave a ser utilizada na verificação do PIN dentro do HSM. PIN Generation Key (PGK).
pan	PAN (Primary Account Number).
offset	Offset do PIN. Deve ter tamanho entre DinamoApi.MIN_EFT_PIN_LEN e DinamoApi.MAX_EFT_PIN_LEN.
pinblock	Buffer contendo o Pin Block de entrada que será verificado. O formato de PIN Block esperado é ISO PIN Block Format 0 (equivalente ao ANSI PIN Block Format 0 e ao VISA PIN Block Format 1). O buffer deve ter o tamanho de um PIN Block, DinamoApi.DES_BLOCK (8 bytes).

Retorna

true se o PIN foi validado com sucesso e false caso seja inválido.

Exceções

DinamoException

Lança exceção em caso de erro.

Exemplos

eft_verify_pinblock.cs.

ExportTR31()

byte[] ExportTR31 ( string kbpk, string key, EftExportUsage usage, EftExportMode mode, EftExportExpType exp )

inline

Exporta uma chave no formato TR-31 de acordo com o padrão ASC X9 TR 31-2018.

Parâmetros

kbpk	Nome da chave KBPK (Key Block Protection Key) utilizada para derivar as chaves de encriptação e autenticação.
key	Nome da chave que será exportada do HSM.
usage	Identificador de uso de chave, como descrito no ASC X9 TR 31-2018 Seção A.5.1 tabela 6.
mode	Identificador do modo de uso da chave, como descrito no ASC X9 TR 31-2018 Seção A.5.3 tabela 8.
exp	Identificador de exportabilidade da chave, como descrito no ASC X9 TR 31-2018 Seção A.5.5 tabela 10.

Retorna

Key block

Exceções

DinamoException

Lança exceção em caso de erro.

Anotações

Essa API exporta uma chave usando os métodos de geração de key_block abaixo.

Algoritmo da KBPK	Método de exportação
3DES	5.3.2.1 Key Derivation Binding Method - TDEA
AES	5.3.2.3 Key Block Binding Method – AES

Exemplos

export_import_tr31.cs.

ImportTR31()

void ImportTR31 ( string kbpk, string key, bool isExportable, bool isTemporary, byte[] keyBlock )

inline

Importa uma chave no formato TR-31 de acordo com o padrão ASC X9 TR 31-2018.

Parâmetros

kbpk	Nome da chave KBPK (Key Block Protection Key) utilizada para derivar as chaves de encriptação e autenticação.
key	Nome da chave que será importada no HSM.
isExportable	Define se a chave importada será exportável.
isTemporary	Define se a chave importada será temporária.
keyBlock	Key block no formato TR-31.

Exceções

DinamoException

Lança exceção em caso de erro.

Anotações

Essa API importa chaves protegidas pelos métodos de geração do key_block.

Algoritmo da KBPK	Método de exportação
3DES	5.3.2.1 Key Derivation Binding Method - TDEA
AES	5.3.2.3 Key Block Binding Method – AES

Exemplos

export_import_tr31.cs.