PCKey Class Reference

Inherits from	NSObject
Declared in	PCKey.h

Overview

Объект ключа.

Методы класса

`+ keyFromQRCode:`

Создание экзепляра ключа из объекта QR-кода (PCKeyQRCode).

+ (nullable instancetype)keyFromQRCode:(PCQRCode *_Nonnull)qrCode

Parameters

`qrCode`	объект класса PCQRCode.

Return Value

Возвращает экзепляр ключа либо nil в случае ошибки.

Discussion

Создание экзепляра ключа из объекта QR-кода (PCKeyQRCode).

Declared In

PCKey.h

`+ keyFromQRCodeString:`

Создание экзепляра ключа из строки с вадидными данными QR-кода ключа.

+ (nullable instancetype)keyFromQRCodeString:(NSString *_Nonnull)qrCodeString

Parameters

`qrCodeString`	строка с вадидными данными QR-кода ключа.

Return Value

Возвращает экзепляр ключа либо nil в случае ошибки.

Discussion

Создание экзепляра ключа из строки с вадидными данными QR-кода ключа.

Declared In

PCKey.h

`+ keyFromXMLString:`

Создание экзепляра ключа из строки с вадидными данными в формате XML.

+ (nullable instancetype)keyFromXMLString:(NSString *_Nonnull)xmlString

Parameters

`xmlString`	строка с вадидными данными ключа в формате XML.

Return Value

Возвращает экзепляр ключа либо nil в случае ошибки.

Discussion

Создание экзепляра ключа из строки с вадидными данными в формате XML.

Declared In

PCKey.h

`+ keyFromStorage:`

Получение экзепляра ключа по его идентификатору в хранилище.

+ (nullable instancetype)keyFromStorage:(NSString *_Nonnull)keyID

Parameters

`keyID`	строка с индентификатором ключа.

Return Value

Возвращает экзепляр ключа либо nil в случае ошибки.

Discussion

Получение экзепляра ключа по его идентификатору в хранилище.

Declared In

PCKey.h

Методы

`– combineKey:`

Объединение со второй частью ключа

- (nullable PCError *)combineKey:(NSString *_Nonnull)keyPart

Parameters

`keyPart`	Вторая часть ключа

Return Value

error - ошибка. Если error = nil, то добавление второй части ключа завершилось успешно

Discussion

Объединение со второй частью ключа

Declared In

PCKey.h

`– storeWithName:password:`

Сохранение ключевой информации (полный ключ)

- (nullable PCError *)storeWithName:(NSString *_Nonnull)keyName password:(NSString *_Nonnull)password

Parameters

`keyName`	Имя ключевой информации
`password`	Пароль для ключевой информации

Return Value

error - ошибка. Если error = nil, то сохранение завершилось успешно

Discussion

Сохранение ключевой информации (полный ключ)

Declared In

PCKey.h

Сохранение ключевой информации в хранилище без указания пароля Функция необходима для сохранения ранее импортированных ключей без предъявления текущего пароля Для последующего доступа к ключам необходим старый пароль Валидный handle не требуется

- (nullable PCError *)storeWithName:(NSString *_Nonnull)keyName

Parameters

`keyName`	Имя ключевой информации

Return Value

error - ошибка. Если error = nil, то сохранение завершилось успешно

Discussion

Declared In

PCKey.h

`– submitPassword:`

Предъявление пароля для получения Handle ключевой информации. В случае успешного ввода пароля Handle становится валидным для использования при генерации кода подтверждения

- (nullable PCError *)submitPassword:(NSString *_Nonnull)password

Parameters

`password`	пароль

Return Value

error - ошибка. Если error = nil, то предъявление пароля прошло успешно.

Discussion

Declared In

PCKey.h

`– updatePassword:newPassword:`

Изменение пароля для ключевой информации

- (nullable PCError *)updatePassword:(NSString *_Nonnull)oldPassword newPassword:(NSString *_Nonnull)newPassword

Parameters

`oldPassword`	Текущий пароль для ключевой информации
`newPassword`	Новый пароль для ключевой информации

Return Value

error - ошибка. Если error = nil, то обновление пароля прошло успешно.

Discussion

Изменение пароля для ключевой информации

Declared In

PCKey.h

`– updateKeyName:`

Изменение имени для ключевой информации

- (nullable PCError *)updateKeyName:(NSString *_Nonnull)keyName

Parameters

`keyName`	Имя ключевой информации

Return Value

error - ошибка. Если error = nil, то обновление имени прошло успешно.

Discussion

Изменение имени для ключевой информации

Declared In

PCKey.h

`– getCodeExpirationInterval:`

Получение интервала дискретизации времени

- (NSTimeInterval)getCodeExpirationInterval:(PCCodeType)codeType

Parameters

`codeType`	тип, для которого нужно получить интервал дискретизации времени. см. PCCodeType

Return Value

значение интервала дискретизации времени. По умолчанию равно 180 секундам.

Discussion

Получение интервала дискретизации времени

Declared In

PCKey.h

`– setCodeExpirationInterval:codeType:`

Установка интервала дискретизации времени

- (void)setCodeExpirationInterval:(NSTimeInterval)interval codeType:(PCCodeType)codeType

Parameters

`interval`	значение интервала дискретизации времени
`codeType`	тип, для которого изменяется интервал дискретизации времени см. PCCodeType

Discussion

Установка интервала дискретизации времени

Declared In

PCKey.h

`– freeHandle`

Освободить хэндлы ключей текущего объекта

- (void)freeHandle

Discussion

Освободить хэндлы ключей текущего объекта

Declared In

PCKey.h

`– generateKeyPair`

Генерация ключевой пары. Создание двух объектов – открытого и закрытого ключа.

- (nullable PCError *)generateKeyPair

Discussion

Генерация ключевой пары. Создание двух объектов – открытого и закрытого ключа.

Declared In

PCKey.h

`– clearKeyPair`

Очистка ключевой пары. Удаление (очистка) у объекта открытого и закрытого ключей.

- (nullable PCError *)clearKeyPair

Discussion

Очистка ключевой пары. Удаление (очистка) у объекта открытого и закрытого ключей.

Declared In

PCKey.h

`– calculateAuthorizationData:D:`

Генерация хедера авторизации для запроса

- (nullable NSString *)calculateAuthorizationData:(NSData *_Nonnull)data D:(long)D

Discussion

Генерация хедера авторизации для запроса

Declared In

PCKey.h

`– exportRaw`

Экспортирование значений ключа в текстовом формате

- (nullable NSString *)exportRaw

Return Value

Значения ключа в текстовом формате. В случае ошибки вернётся nil.

Discussion

Экспортирование значений ключа в текстовом формате

Перед вызовом данного метода необходимо предъявить пароль ключа, параметр key.hasValidHandle должен иметь значение YES.

Declared In

PCKey.h

Свойства

`hasValidHandle`

Проверка на возможность использования Handle

@property (nonatomic, readonly) BOOL hasValidHandle

Discussion

Проверка на возможность использования Handle

Declared In

PCKey.h

`registeredMFMSecurityToken`

Зарегистрированный MFM security token для данного ключа

@property (nonatomic, strong, nullable) NSString *registeredMFMSecurityToken

Discussion

Зарегистрированный MFM security token для данного ключа

Declared In

PCKey.h

`handleHMAC`

Handle ключа для выработки кода подтверждения транзакции

@property (nonatomic, readonly, nullable) NSString *handleHMAC

Discussion

Handle ключа для выработки кода подтверждения транзакции

Declared In

PCKey.h

`handleAuth`

Handle ключа для выработки кода аутентификации

@property (nonatomic, readonly, nullable) NSString *handleAuth

Discussion

Handle ключа для выработки кода аутентификации

Declared In

PCKey.h

`handlePrivate`

Handle приватного ключа ECDSA

@property (nonatomic, readonly) NSString *handlePrivate

Discussion

Handle приватного ключа ECDSA

Declared In

PCKey.h

`userID`

Идентификатор пользователя PayControl

@property (nonatomic, strong, nullable) NSString *userID

Discussion

Идентификатор пользователя PayControl

Declared In

PCKey.h

`keyName`

Наименование ключа

@property (nonatomic, strong, nullable) NSString *keyName

Discussion

Наименование ключа

Declared In

PCKey.h

`keyFlags`

Флаги ключа

@property (nonatomic) int keyFlags

Discussion

Флаги ключа

Declared In

PCKey.h

`expirationDate`

Дата истечения срока действия ключа

@property (nonatomic, strong, nullable) NSDate *expirationDate

Discussion

Дата истечения срока действия ключа

Declared In

PCKey.h

`expirationDateString`

Дата истечения срока действия ключа в виде строки “dd.MM.yyyy”

@property (nonatomic, strong, nullable) NSString *expirationDateString

Discussion

Дата истечения срока действия ключа в виде строки “dd.MM.yyyy”

Declared In

PCKey.h

`localizedExpirationDateString`

Дата истечения срока действия ключа в виде строки в локализованном формате даты

@property (nonatomic, readonly) NSString *localizedExpirationDateString

Discussion

Дата истечения срока действия ключа в виде строки в локализованном формате даты

Declared In

PCKey.h

`isExpiredKey`

Признак того, что у ключа истек срок действия

@property (nonatomic, readonly) BOOL isExpiredKey

Discussion

Признак того, что у ключа истек срок действия

Declared In

PCKey.h

`keyID`

Идентификатор ключа в хранилище PayControl

@property (nonatomic, strong, nullable) NSString *keyID

Discussion

Идентификатор ключа в хранилище PayControl

Declared In

PCKey.h

`keyType`

Тип ключа: DSS или Regular см. PCKeyType

@property (nonatomic, assign) PCKeyType keyType

Discussion

Тип ключа: DSS или Regular см. PCKeyType

Declared In

PCKey.h

`systemID`

Идентификатор прикладной системы

@property (nonatomic, strong, nullable) NSString *systemID

Discussion

Идентификатор прикладной системы

Declared In

PCKey.h

`isWithFingerprint`

Флаг привязки ключевой информации к устройству

@property (nonatomic, readonly) BOOL isWithFingerprint

Discussion

Флаг привязки ключевой информации к устройству

Declared In

PCKey.h

`isDenyRenewPubKey`

Флаг запрета на перерегистрацию открытого ключа на сервере. Мобильным приложением данный флаг не обрабатывается

@property (nonatomic, readonly) BOOL isDenyRenewPubKey

Discussion

Declared In

PCKey.h

`isCollectEvents`

Флаг отправки информации о событиях

@property (nonatomic, readonly) BOOL isCollectEvents

Discussion

Флаг отправки информации о событиях

Declared In

PCKey.h

`isCollectDeviceInfo`

Флаг отправки информации об устройстве

@property (nonatomic, readonly) BOOL isCollectDeviceInfo

Discussion

Флаг отправки информации об устройстве

Declared In

PCKey.h

`isCollectSIMInfo`

Флаг сбора информации о Телефоне (SIM-карте, операторе)

@property (nonatomic, readonly) BOOL isCollectSIMInfo

Discussion

Флаг сбора информации о Телефоне (SIM-карте, операторе)

Declared In

PCKey.h

`isCollectLocation`

Флаг сбора информации о Местоположении

@property (nonatomic, readonly) BOOL isCollectLocation

Discussion

Флаг сбора информации о Местоположении

Declared In

PCKey.h

`isDenyStoreWithOSProtection`

Флаг запрета на сохранение ключевой информации используя системный способ защиты доступа к нему (такой как отпечаток пальца или FaceID)

@property (nonatomic, readonly) BOOL isDenyStoreWithOSProtection

Discussion

Declared In

PCKey.h

`passwordPolicy`

4 допустимых значения. Задаёт параметр требуемой сложности пароля для сохранения ключевой информации. 0 - Минимальная длина пароля - 6 символов. (Значение 0 используется приложением. Говорит о том, что возможно сохранение без пароля). 1 - Минимальная длина пароля - 6 символов. 2 - Минимальная длина пароля - 8 символов. Обязательно использование как заглавных, так и строчных букв. 3 - Минимальная длина пароля - 8 символов. Обязательно использование заглавных, строчных букв и цифр.

@property (nonatomic, readonly) int passwordPolicy

Discussion

Declared In

PCKey.h

`onlineConfirmURL`

Строка с URL для подтверждения Online

@property (nonatomic, strong, nullable) NSString *onlineConfirmURL

Discussion

Строка с URL для подтверждения Online

Declared In

PCKey.h

`interactionExternalURL`

Строка с URL PC Interaction Server

@property (nonatomic, strong, nullable) NSString *interactionExternalURL

Discussion

Строка с URL PC Interaction Server

Declared In

PCKey.h

`isCompleted`

Проверка на полноту ключа.

@property (nonatomic, readonly, nullable) PCError *isCompleted

Return Value

Код ошибки. Если код ошибки == PC_ERROR_OK, то ключ заполнен полностью. Если код ошибки == PC_ERROR_KEY_IS_NOT_FULL, то необходимо объединение со второй частью ключа

Discussion

Проверка на полноту ключа.

Declared In

PCKey.h

`registeredPushToken`

Push-токен устройства, зарегистрированного на PC IS при помощи метода doRegisterDevice

@property (nonatomic, strong, nullable) NSString *registeredPushToken

Discussion

Push-токен устройства, зарегистрированного на PC IS при помощи метода doRegisterDevice

Declared In

PCKey.h

`hasKeyPair`

Возвращает признак, имеет ли ключ сформированную ключевую пару

@property (nonatomic, readonly) BOOL hasKeyPair

Discussion

Возвращает признак, имеет ли ключ сформированную ключевую пару

Declared In

PCKey.h

`hasValidSignHandle`

Возвращает признак, имеет ли ключ валидный хэндл для формирования подписи

@property (nonatomic, readonly) BOOL hasValidSignHandle

Discussion

Возвращает признак, имеет ли ключ валидный хэндл для формирования подписи

Declared In

PCKey.h

`publicKey`

Открый ключ ключевой пары

@property (nonatomic, nullable) NSString *publicKey

Discussion

Открый ключ ключевой пары

Declared In

PCKey.h