Amadis

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

API _Version _Revision

Description

_OLA _version 2.1.6 _revision 23819

ola

See ola.h

#include

#include "ola_tags_dictionary.h"
#include "ola_emv.h" /// Generic EMV API
#include "ola_publickey.h" /// Generic Public Key configuration API
#include "ola_contactless.h" /// Generic Contacless Processing API
#include "ola_contact.h" /// Generic Contact Processing API

#define

#define OLA_API_VERSION "2.1.6"

logf_function

typedef void (*logf_function)(char* str);

ola_get_api_version

const char *ola_get_api_version(void);

ola_get_implementation_version

const char *ola_get_implementation_version(void);

ola_initialize_at_start_up

tOLAError ola_initialize_at_start_up(uint8_t *tlv, uint16_t tlvLength);

ola_set_trace_function

void ola_set_trace_function(logf_function fct);

ola_emv

See ola_emv.h

#include

#include <stdint.h>

tOLAError

typedef enum
{
	OLA_OK,
	OLA_CARD_MUTE,
	OLA_CARD_BLOCKED,
	OLA_MAX_REACHED,
	OLA_NO_CANDIDATE,
	OLA_CONTACT_NEW_SELECTION,
	OLA_CONTACT_SELECTION_ERROR,
	OLA_CONDITIONS_NOT_SATISFIED,
	OLA_ACCEPTED,
	OLA_NOT_ACCEPTED,
	OLA_OFFLINE_ACCEPTED,
	OLA_OFFLINE_DECLINED,
	OLA_GO_ONLINE,
	OLA_DECLINED,
	OLA_MISSING_DATA,
	OLA_PINPAD_ERROR,
	OLA_PARAM_ERROR,
	OLA_NOT_IMPLEMENTED,
	OLA_ERROR,
	OLA_CARD_ERROR,
	OLA_CANCEL,
	OLA_PUBLIC_KEY_OK,
	OLA_PUBLIC_KEY_MISSING,
	OLA_PUBLIC_KEY_MAX_REACHED,
	OLA_PUBLIC_KEY_END,
	OLA_PUBLIC_KEY_ERROR,
	OLA_CARD_REMOVED
} tOLAError;

tOlaEMVCoCVM

typedef enum
{
    cvmNone,
    cvmNoCvm,
    cvmSignature,
    cvmOnlinePin,
    cvmOnlinePin_Signature,
    cvmOfflinePinPlaintext,
    cvmOfflinePinPlaintext_Signature,
    cvmOfflinePinCiphered,
    cvmOfflinePinCiphered_Signature
} tOlaEMVCoCVM;

ola_emv_set_tag

tOLAError ola_emv_set_tag(
	uint32_t tag,
    uint8_t *value,
    uint16_t length
);

ola_emv_get_tag

tOLAError ola_emv_get_tag(
	uint32_t tag,
    uint8_t *value,
    uint16_t *length
);

ola_emv_get_cvm_results

tOLAError ola_emv_get_cvm_results(
	tOlaEMVCoCVM *cvm
);

ola_contact

See ola_contact.h

#include

#include "ola_emv.h"
#include <stdint.h>

tOlaModeContactTransaction

typedef enum
{
    metUndef = 0,
    metFull,
    metExtractPAN,
    metUnknown
} tOlaModeContactTransaction;

ola_contact_flush_aid_supported

void ola_contact_flush_aid_supported(void);

ola_contact_answer_to_reset

tOLAError ola_contact_answer_to_reset(const char* reader);

ola_contact_add_aid_supported

tOLAError  ola_contact_add_aid_supported(
		const uint8_t *aid,
	    uint8_t aidLength,
		int partial
);

ola_contact_build_candidate_list

tOLAError ola_contact_build_candidate_list(
		uint8_t *nb_candidates,
	    int *pse
);

ola_contact_get_tag_from_candidate

tOLAError ola_contact_get_tag_from_candidate(
		uint8_t candidate,
	    uint32_t tag,
		uint8_t *value,
	    uint16_t *length
);

ola_contact_final_select_candidate

tOLAError ola_contact_final_select_candidate(uint8_t candidate);

ola_contact_initiate_transaction

tOLAError ola_contact_initiate_transaction(
		tOlaModeContactTransaction mode
);

ola_contact_complete_transaction

tOLAError ola_contact_complete_transaction(
		const uint8_t *authorResponseCode,
	    const uint8_t *issuerAuthenticationData,
	    uint8_t issuerAuthenticationData_length
);

ola_contact_clean

void  ola_contact_clean(void);

ola_contactless

See ola_contactless.h

#include

#include "ola_emv.h"
#include <stdint.h>

#define

#define OLA_KERNEL_ID_MASTERCARD                    2
#define OLA_KERNEL_ID_VISA                          3
#define OLA_KERNEL_ID_AMEX                          4
#define OLA_KERNEL_ID_JCB                           5
#define OLA_KERNEL_ID_DISCOVER                      6
#define OLA_KERNEL_ID_CUP                           7

#define OLA_MSD_ID_APPROVED                         0x03
#define OLA_MSD_ID_NOT_AUTHORISED                   0x07
#define OLA_MSD_ID_PLEASE_INSERT_OR_SWIPE_CARD      0x18
#define OLA_MSD_ID_AUTHORISING_PLEASE_WAIT          0x1B
#define OLA_MSD_ID_INSERT_SWIPE_OR_TRY_ANOTHER_CARD 0x1C
#define OLA_MSD_ID_SEE_PHONE_FOR_INSTRUCTIONS       0x20

tOlaContactlessTransactionStep

typedef enum
{
	ctsNone,
	ctsPreprocess,
	ctsBuildCandidate,
	ctsFinalSelect,
	ctsActivate
} tOlaContactlessTransactionStep;

tOlaOutcome

typedef enum
{
	outcNone,
	outcSelectNext,
	outcTryAgain,
	outcApproved,
	outcDeclined,
	outcOnlineRequest,
	outcTryAnotherInterface,
	outcEndApplication
} tOlaOutcome;

tOlaStartPoint

typedef enum
{
	spNoStart,
	spStartA,
	spStartB,
	spStartC,
	spStartD,
} tOlaStartPoint;

tOlaOnlineResponseData

typedef enum
{
	ordNone,
	ordEmv,
	ordAny
} tOlaOnlineResponseData;

tOlaAlternateInterfacePreference

typedef enum
{
	aipNone,
	aipContactChip,
	aipMagneticStripe
} tOlaAlternateInterfacePreference;

tOlaCVMethodContactless

typedef enum
{
	cvmclNone,
	cvmclNoCvm,
	cvmclSignature,
	cvmclOnlinePin,
	cvmclConfirmationCodeVerified
} tOlaCVMethodContactless;

tOlaStatus

typedef enum
{
	staNone,
	staNotReady,
	staIdle,
	staReadyToRead,
	staProcessing,
	staCardReadSuccessfully,
	staProcessingError
} tOlaStatus;

tOlaValueQualifier

typedef enum
{
	vqNone,
	vqAmount,
	vqBalance
} tOlaValueQualifier;

tOlaOutcomeParameter

typedef struct
{
	tOlaOutcome outCome;
	tOlaStartPoint startingPoint;
	tOlaOnlineResponseData onlineResponseData;
	tOlaCVMethodContactless cvm;
	int UIReqOnOutcomePresent;
	int UIReqOnRestartPresent;
	int receipt;
	int dataRecordPresent;
	int discretionaryDataPresent;
	tOlaAlternateInterfacePreference alternateInterfacePreference;
	uint32_t fieldOffReq;
	uint32_t removalTimeout;
} tOlaOutcomeParameter;

tOlaUIRequest

typedef struct
{
	uint8_t messageIdentifier;
	tOlaStatus status;
	uint32_t holdTime;
	uint8_t languagePreference[8];  // List of languages, ISO 639-1 representation
	tOlaValueQualifier valueQualifier;
	uint8_t value[6];               // BCD
	uint8_t currencyCode[2];        // Numeric ISO 4217
} tOlaUIRequest;

ola_contactless_flush_aid_supported

void ola_contactless_flush_aid_supported(void);

ola_contactless_add_aid_supported

tOLAError ola_contactless_add_aid_supported(
        const uint8_t *aid,
        uint8_t aidLength,
        int partial,
        uint8_t kernelId,
        uint8_t *tlv,
        uint16_t tlvLength
);

ola_contactless_add_drl_supported

uint16_t ola_contactless_add_drl_supported(
        const uint8_t *programId,
        uint8_t programIdLength,
        const uint8_t *transactionLimit,
        const uint8_t *floorLimit,
        const uint8_t *CVMLimit,
        int statusCheck,
        int isZeroAllowed,
        uint8_t kernelId
);

ola_contactless_commit_supported_aids

void ola_contactless_commit_supported_aids(void);

ola_contactless_build_candidate_list

uint16_t ola_contactless_build_candidate_list(
        uint8_t *nb_candidates
);

ola_contactless_get_tag_from_candidate

uint16_t ola_contactless_get_tag_from_candidate(
        uint8_t candidate,
        uint32_t tag,
        uint8_t *value,
        uint16_t *length
);

ola_contactless_final_select_candidate

tOLAError ola_contactless_final_select_candidate(
        uint8_t candidate,
        uint8_t *kernelId
);

ola_contactless_get_card_preferred_language

tOLAError ola_contactless_get_card_preferred_language(
        char *language
);

ola_contactless_preprocess

tOLAError ola_contactless_preprocess(void);

ola_contactless_do_transaction

tOLAError ola_contactless_do_transaction(void);

ola_contactless_clean

void  ola_contactless_clean(void);

ola_contactless_get_outcome

tOLAError ola_contactless_get_outcome(
        tOlaOutcomeParameter *outcome
);

ola_contactless_get_UI_request_upon_outcome

tOLAError ola_contactless_get_UI_request_upon_outcome(
        tOlaUIRequest *uiRequest
);

ola_contactless_get_UI_request_restart

tOLAError ola_contactless_get_UI_request_restart(
        tOlaUIRequest *uiRequest
);

ola_publickey

See ola_publickey.h

#include

#include "ola.h"
#include <stdint.h>

tOlaPubKey

typedef struct
{
    uint8_t rid[5];
    uint8_t idx[1];
    uint8_t modulusLen;
    uint8_t modulusValue[248];
    uint8_t exponentLen;
    uint8_t exponentValue[3];
    uint8_t expirDate[3];
} tOlaPubKey;

ola_pubkey_flush

void ola_pubkey_flush(void);

ola_pubkey_add

tOLAError ola_pubkey_add(
        const tOlaPubKey *key,
        const uint8_t *checksum
);

ola_pubkey_find

tOLAError ola_pubkey_find(
		tOlaPubKey *key,
        uint8_t *checksum
);

ola_pubkey_get_next_id

tOLAError ola_pubkey_get_next_id(
        uint8_t *idx,
        uint8_t *rid,
        int start
);

ola_pubkey_commit

tOLAError ola_pubkey_commit(void);

ola_terminal

See ola_terminal.h

// Deprecated

ola_tags_dictionary

See ola_tags_dictionary.h

#define

#define TAG_TAC_DEFAULT                                 			0xDF1E
#define TAG_TAC_DENIAL                                  			0xDF1F
#define TAG_TAC_ONLINE                                  			0xDF20

#define TAG_READER_CONTACTLESS_FLOOR_LIMIT_PREPROCESSING            0xDF09
#define TAG_READER_CONTACTLESS_FLOOR_LIMIT       					0xDF8123 // Be careful, tag managed as 9F1B by Nexo!

#define TAG_READER_CONTACTLESS_TRANSACTION_LIMIT_NO_DEVICE_CVM_PREPROCESSING    0xDF08
#define TAG_READER_CONTACTLESS_TRANSACTION_LIMIT_NO_DEVICE_CVM        			0xDF8124

#define TAG_READER_CONTACTLESS_CVM_REQUIRED_LIMIT_PREPROCESSING     0xDF0B
#define TAG_READER_CONTACTLESS_CVM_REQUIRED_LIMIT       			0xDF8126

#define TAG_THRESHOLD_VALUE_FOR_BIASED_RANDOM_SELECTION 			0xDF21
#define TAG_MAXIMUM_TARGET_PERCENTAGE_FOR_BIASED_RANDOM_SELECTION 	0xDF1C
#define TAG_TARGET_PERCENTAGE_FOR_RANDOM_SELECTION      			0xDF1D

#define TAG_MESSAGE_HOLD_TIME                       				0xDF812D

// Contact
#define TAG_APPLICATION_PROFILE_SETTINGS                			0xDF27
#define TAG_DEFAULT_DYNAMIC_DATA_AUTHENTICATION_DATA_OBJECT_LIST	0xDF8F1A
#define TAG_DEFAULT_TRANSACTION_CERTIFICATE_DATA_OBJECT_LIST		0xDF8F08

// Kernel 2
#define TAG_BALANCE_READ_AFTER_GEN_AC                   			0xDF8105
#define TAG_BALANCE_READ_BEFORE_GEN_AC                  			0xDF8104
#define TAG_CARD_DATA_INPUT_CAPABILITIES            				0xDF8117
#define TAG_CVM_CAPABILITY_CVM_REQUIRED            					0xDF8118
#define TAG_CVM_CAPABILITY_NO_CVM_REQUIRED          				0xDF8119
#define TAG_DEFAULT_UDOL                            				0xDF811A
#define TAG_KERNEL_2_CONFIGURATION                  				0xDF811B
#define TAG_MAX_LIFETIME_TORN_TRANSACTION           				0xDF811C
#define TAG_MAX_NUMBER_TORN_TRANSACTION             				0xDF811D
#define TAG_MAGSTRIPE_CVM_CAPABILITY_CVM_REQUIRED   				0xDF811E
#define TAG_SECURITY_CAPABILITIES                   				0xDF811F
#define TAG_READER_CONTACTLESS_TRANSACTION_LIMIT_DEVICE_CVM   		0xDF8125
#define TAG_MAGSTRIPE_CVM_CAPABILITY_NO_CVM_REQUIRED				0xDF812C
#define TAG_HOLD_TIME_VALUE       									0xDF8130
#define TAG_MIN_RELAY_RESISTANCE_GRACE_PERIOD       				0xDF8132
#define TAG_MAX_RELAY_RESISTANCE_GRACE_PERIOD       				0xDF8133
#define TAG_RELAY_RESISTANCE_ACCURACY_THRESHOLD     				0xDF8136
#define TAG_RELAY_RESISTANCE_TRANSMISSION_TIME_MISMATCH_THRESHOLD 	0xDF8137

ola_implem

See ola_implem.h

ola_contact_implem_t

typedef struct {
	void (*flush_aid_supported)(void);
	tOLAError (*answer_to_reset)(const char* reader);
	tOLAError (*add_aid_supported)(const uint8_t *aid, uint8_t aidLength, int partial);
	tOLAError (*build_candidate_list)(uint8_t *nb_candidates, int *pse);
	tOLAError (*get_tag_from_candidate)(uint8_t candidate, uint32_t tag, uint8_t *value, uint16_t *length);
	tOLAError (*final_select_candidate)(uint8_t candidate);
	tOLAError (*initiate_transaction)(tOlaModeContactTransaction mode);
	tOLAError (*complete_transaction)(
			const uint8_t *authorResponseCode,
			const uint8_t *issuerAuthenticationData,
			uint8_t issuerAuthenticationData_length);
	void  (*clean)(void);
} ola_contact_implem_t;

ola_contactless_implem_t

typedef struct {
	void (*flush_aid_supported)(void);
	tOLAError (*add_aid_supported)(
			const uint8_t *aid,
			uint8_t aidLength, int partial,
			uint8_t kernelId,
			const uint8_t *tlv,
			uint16_t tlvLength);
	uint16_t (*add_drl_supported)(
			const uint8_t *programId,
			uint8_t programIdLength,
			const uint8_t *transactionLimit,
			const uint8_t *floorLimit,
			const uint8_t *CVMLimit,
			int statusCheck,
			int isZeroAllowed,
			uint8_t kernelId);
	void (*commit_supported_aids)(void);
	uint16_t (*build_candidate_list)(uint8_t *nb_candidates);
	uint16_t (*get_tag_from_candidate)(uint8_t candidate, uint32_t tag, uint8_t *value, uint16_t *length);
	tOLAError (*final_select_candidate)(uint8_t candidate, uint8_t *kernelId);
	tOLAError (*get_card_preferred_language)(char *language);
	tOLAError (*preprocess)(void);
	tOLAError (*do_transaction)(void);
	void (*clean)(void);
	tOLAError (*get_outcome)(tOlaOutcomeParameter *outcome);
	tOLAError (*get_UI_request_upon_outcome)(tOlaUIRequest *uiRequest);
	tOLAError (*get_UI_request_restart)(tOlaUIRequest *uiRequest);
} ola_contactless_implem_t;

ola_emv_implem_t

typedef struct {
	tOLAError (*set_tag)(uint32_t tag, uint8_t *value, uint16_t length);
	tOLAError (*get_tag)(uint32_t tag, uint8_t *value, uint16_t *length);
	tOLAError (*get_cvm_results)(tOlaEMVCoCVM *cvm);
} ola_emv_implem_t;

ola_publickey_implem_t

typedef struct {
	void (*flush)(void);
	tOLAError (*add)(const tOlaPubKey *key, const uint8_t *checksum);
	tOLAError (*find)(tOlaPubKey *key, uint8_t *checksum);
	tOLAError (*get_next_id)(uint8_t *idx, uint8_t *rid, int start);
	tOLAError (*commit)(void);
} ola_publickey_implem_t;

ola_implem_t

typedef struct {
	ola_contact_implem_t contact;
	ola_contactless_implem_t contactless;
	ola_emv_implem_t emv;
	ola_publickey_implem_t publickey;
} ola_implem_t;

  • No labels