Protocols

A protocol that carries authentication input from a user (e.g. a user’s PIN). This is used when operation requires not only an authentication mode but also user input.

Refers to EMPinAuthInput and EMBioFingerprintAuthInput

A base protocol (marker) that represents a particular authentication mode.

A protocol that represents authentication service.

Authenticatable protocol. Authenticatable refers to some asset which could be authenticated with multi-authentication modes once configured.

A protocol defining a device that generates CAP based OTPs.

A protocol representing the CAP settings.

A protocol that represents CAP credentials known as tokens.

CAP Token Manager

An DCV OATH device complying with the Standard Gemalto DCV options.

A protocol representing a decimal input dialog (DID) primitive.

This primitive has type EMPrimitiveTypeDID.

The allowed input format is EMPrimitiveInputFormatDecimalTwoFractionDigits.

A protocol representing a Dynamic Signature (DS) device.

A protocol representing a DS Transaction Data.

Passed to the OnLocalPinRequestBlock in order to let the the client respond on the callback with one of the supported actions - the token PIN entry or cancel.

DskppPolicyProtocol represents the policy for DSKPP.

Defines the methods to call back during OnServerPinRequestBlock. These methods need to be called to after the App has collected the PINs from the user in order to continue or cancel the DSKPP provisioning process

An interface for OATH tokens with the EMTokenCapabilityDUAL_SEED capability.

An interface for Soft OATH tokens with the EMTokenCapabilityDUAL_SEED capability.

Holds additional data fields that could be present in the QR code. It provides a simple interface to retrieve value of such fields.

Data object class providing the common interface.

Factory class providing capability to create particular decoder.

Class that holds the Language Preference and Merchant Name—Alternate Language. It may contain the Merchant City—Alternate Language. All other IDs within the Merchant Information—Language Template are RFU for EMVCo.

Decoder class providing method to decode a given content of a QR code.

Implementation of primitive data object type as defined by EMV specification. Primitive data object holds a string value, which does not have an inner structure and which could be retrieved by -[Primitive getValue()] method.

Bool class providing method to create EMVQR primitive data type that represent BOOL values.

Byte class providing method to create EMVQR primitive data type that represent unsigned integer values.

Implementation of template data object type as defined by EMV specification. Template data object contains an inner structure of other templates or primitive data objects which could be retrieved by -[EMEmvTemplate dataObject:] method.

Extends the EMEmvTemplate class to provide an interface for easy access to Globally Unique Identifier that sets the context of other data object inside the template.

Holds consolidated information about payment transaction.

A protocol representing a free text input (E0) primitive.

This primitive has type EMPrimitiveTypeE0. See EMPrimitiveType.

The allowed input format is CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingISOLatin9).

An OATH device complying with the Standard Gemalto OATH options.

A protocol representing a grouped input dialog (IDG) primitive.

This is an extension of the EMInputDialogPrimitive which visually partitions the input into groups. e.g. 1234 5678.

This primitive has type EMPrimitiveTypeIDG.

The allowed input format is EMPrimitiveInputFormatDigit.

A protocol representing a hidden text input (E1) primitive.

This primitive has type EMPrimitiveTypeE1.

The allowed input format is EMPrimitiveTextFormatBinary.

A protocol representing a Information Message Dialog (IMD) primitive.

This primitive has type EMPrimitiveTypeIMD.

The IMD primitive is used in cases when no otp should be generated.

A protocol representing a input dialog (ID) primitive.

This primitive has type EMPrimitiveTypeID.

The allowed input format is EMPrimitiveInputFormatInputFormatDigit.

A primitive for all primitives which accept input, either user entered or selected.

A protocol representing a message dialog (MD) primitive.

This primitive has type EMPrimitiveTypeMD.

This primitive has no input data, it is only used to display a message.

EMModule protocol.

Protocol allowing to retrieve all the public fields and data from a cap data

A basic object protocol to retrieve the common public parameters of a decoded MspData Object

Msp frame protocol

Protocol allowing to retrieve all the public fields and data from a Oath data

Msp parser protocol

A protocol for mutable CAP settings for soft tokens.

Protocol for changeable DCV settings.

A protocol representing the mutable Standard Gemalto OATH options.

Protocol for changeable OATH settings.

A protocol representing a numeric input input dialog (NID) primitive.

This primitive has type EMPrimitiveTypeNID.

The allowed input format is EMPrimitiveInputFormatDigit.

A protocol defining a device that generates OATH based OTPs.

A protocol that represents OATH credentials known as tokens.

OATH Token Manager

This object allows the client to send some error information to the server.

EMOOB incoming message response.

Interface to an object that contains a generic message received from the OOB server.

Interface to an object that contains a generic message to send to the OOB server.

Interface of an incoming message from the OOB server.

Incoming message handler interface.

OOB Manager

Interface of message containers.

Message handler interface.

This manager provides a way to create outgoing messages for the server and; fetch messages from or send messages to the server.

Interface for accessing the meta data for some OOB messages.

OOB message response.

The manager that provides functionality to manage a user notification profile. A notification profile is a list of EMOobNotificationProfile objects. Each notification profile contains a channel (SMS, Push, email, etc.) and an end point attached to that channel (for example an email address for the case of an email channel).

Object response when retrieving the notification profiles from the server using an EMOobNotificationManager object:

• notificationProfiles:
• notificationProfilesWithCompletionHandler:

Interface to an outgoing message to the OOB server.

Outgoing message handler interface.

Interface of an incoming user message from the server.

Interface for registering the user to the OOBS.

OOB registration response from EMOobRegistrationManager:

• registerWithRequest:error:
• registerWithRequest:completionHandler:

Defines the user data keys specific for the OOB subsystem.

Interface of a transaction signing request from the OOB server.

Interface of a transaction signing response for the OOB server.

Interface of a transaction verify request from the OOB server.

Interface of a transaction verify response for the OOB server.

Interface for unregistering the user from the OOBS.

Attachment object that can be sent and received by user messages. This comes along with either EMOobProviderToUserMessage or EMOobUserToProviderMessage object in its attachments property.

Locale of the content is defined by the message container.

Interface of an outgoing user message to the server.

In the Mobile Protector SDK, some sensitive functionalities are represented by the EMPasswordDomain. Each element of the enum EMPasswordDomainType represents a specific set of functionalities. Before these functionalities can be used, they must first be unlocked.

The Password Manager is a high level interface that allows to set a single password to manage all the EMPasswordDomain at the same time.

Using User-defined Password

1. Set a password. The first step when using the EMPasswordManager is to set a password. The password should be provided by an outside source (the application user, through a secured communication channel with a server, etc.).

        // Assumptions
        // get PasswordManager from EMEzioMobileContext and assign it to 'passwordManager'
        // then...
        BOOL isSetResult = [passwordManager isPasswordSet:&error];
        if (!isSetResult) {
            // manage error here
        }else{
            // get password and store it in 'userProvidedPassword' string or data.
            // get EMSecureDataFactory from EzioMobileContext and assign it to 'secureDataFactory'
            EMSecureString password = [secureDataFactory secureStringWithString:userProvidedPassword];
            BOOL result = [passwordManager setPassword:&error];
            if (!result) {
                // manage error here
            }
        }
   

2. Login. Next, you simply need to login using -loginWithPassword:error: or its asynchronous equivalent -loginWithPassword:completionHandler: to unlock all functionalities represented by the EMPasswordDomain. The EMPasswordManager will remain logged in until -logout: is called.

No Password

1. If you wish to use the functionalities represented by the EMPasswordDomain without the use of a password, use -login: or its asynchronous equivalent –loginWithCompletionHandler: to login without using a password. As long as no password was set, you can call -login: without needing to provide a password.

• Usage of the SDK without setting a proper password is strongly discouraged as it introduces a serious security weakness in your application. Note that as long as the -login:, -loginWithPassword:completionHandler:, -removePassword:error: or -removePassword:completionHandler: methods are never used, no security weakness will be introduced even if the password is not yet set.
• Password domains are protected with passwords and reside in the Documents directory of an your application container. Be very careful when managing local files as this will have severe impact on the SDK’s operations such as when those files generated by the SDK are accidentally deleted using NSFileManager.
• Tasks can take considerable amount of time and may potentially block the UI if executed on the main thread.

A protocol that carries authentication input as a user’s PIN. This is used when operation requires not only an authentication mode but also user input.

A protocol that represents pin authentication mode.

Pin policy protocol.

A protocol that represents a rule to apply to a PIN. If the rule is found to be broken, then the PIN will not be accepted.

Applicable to tokens that can change their PIN.

A protocol representing a DS primitive.

Interface of the secure storage object. See EMSecureStorageManager to query secure storage objects.

Note:
Before calling any method of EMPropertyStorage, make sure you have already logged in to password manager first. See EMPasswordManager.

A protocol representing a secure byte array object in memory.

A protocol representing a secure container object in memory.

Secure Container Factory

The input builder v2 class that enables to build a secure input UI (secure keypad).

The secure input UI does not use the native UIKit keypad component but rather draws itself based on the configuration provided.

It supports the build of the secure input UI in both full screen and dialog mode, single or double entry UI. It also provides the flexibility for the application maker to fully customize the top screen UI or even override the custom OK button behavior.

The output of the secure keypad could be EMPinAuthInput or NSData. The integrator shall decide on which API to use depends on the application use case.

Secure input custom UI delegate.

It contains all the information needed for the secure input UI.

The Secure Storage Manager is a high level interface that allows to manage Property Storage objects for storing sensitive data.

A protocol representing a secure container object in memory.

An interface that defines methods to select a key used by the object.

A protocol representing a selection dialog (SD) primitive.

This primitive has type EMPrimitiveTypeSD.

The allowed input format is EMPrimitiveInputFormatFixed.

A protocol representing the CAP settings for soft tokens.

Soft CAP token.

Protocol for DCV related settings.

A protocol representing the Standard Gemalto OATH options.

Protocol for OATH related settings.

A protocol for general Soft OATH tokens.

A protocol that represents authentication input which carries the information from user.

// dispatch a new thread to deactivate non silently dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{

  [token deactivateAuthModeWithInput:bioFpAuthInput error:&error];

  //some logic

  //update UI
  dispatch_async(dispatch_get_main_queue (), ^{
  …
  }

}

A protocol that represents BioFingerprint authentication mode.

A protocol that represents authentication input which carries the information from user.

A protocol that represents Native Face authentication mode.

A protocol representing a DS template.

A primitive for all primitives which accept text for connected DS mode.

The EMToken protocol represents user’s credentials known as tokens.

The manager to create and retrieve tokens.

This class represents token policy.

A protocol that indicates an object can be wiped.

The protocol contains all functions to the app integrators to interact with Secure Log