CKey (CKey SDK for Android | API Reference for version 1.x)

java.lang.Object
- _CallbackInvoker
- - ru.stcrypt.ckey.sdk.v1.CKey

```
public final class CKey
extends _CallbackInvoker
```
Ядро SDK. Предоставляет методы инициализации, деинициализации SDK, а также методы управления настройками

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CKey.Endpoint` Конечные точки сервера, на которые обращается SDK
`static class`	`CKey.RootCertificateType` Тип набора корневых сертификатов.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOG_DEBUG` Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения и дополнительная отладочная информация (при записи в LogCat будут задействованы уровни error, warn, info и debug).
`static int`	`LOG_ERROR` Уровень логирования, при котором в лог будут записываться сообщения об ошибках (при записи в LogCat будет задействован только уровень error).
`static int`	`LOG_INFO` Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, а также информационные сообщения (при записи в LogCat будут задействованы уровни error, warn и info).
`static int`	`LOG_VERBOSE` Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения, а также дополнительная отладочная информация, включающая дамп всех сетевых запросов, выполняемых SDK (при записи в LogCat будут задействованы уровни error, warn, info, debug и verbose). Если включить данный уровень логирования, то my SDK добавит в LogCat порядка 1600 записей общим объёмом около 200 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.
`static int`	`LOG_WARNING` Уровень логирования, при котором в лог будут записываться сообщения об ошибках и предупреждения (при записи в LogCat будут задействованы уровни error и warn).
`static int`	`NO_LOGGING` Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`activate(QRCodeKinit kInit, java.lang.String code, QRCodeCallback callback)` Выполняет активацию ключа KInit
`static QRCode`	`analyzeQR(java.lang.String qrValue)` Определяет содержание заранее раскодированного QR-кода в виде строки
`static boolean`	`checkRoot()` Проверяет наличие root-прав на устройстве.
`void`	`clearCache()` Удаляет все ранее скаченные документы из кэша приложения
`static void`	`destroy()` Завершает использование библиотеки.
`static Appearance`	`getAppearance()` Текущие настройки внешнего вида SDK
`void`	`getAvailableAPIVersions(java.lang.String serviceUrl, CKey.Endpoint endpoint, APIVersionsCallback callback)` Позволяет получить список поддерживаемых версий API для указанной конечной точки
`Context`	`getContext()` Контекст, переданный при инициализации
`static CKey`	`getInstance()` Возвращает экземпляр ранее инициализированной SDK или null, если библиотека ещё не была инициализирована
`static LayoutMapper`	`getLayoutsMapper()` Доступ к настройкам внешнего вида через пользовательские макеты
`static java.lang.String`	`getVersion()` Возвращает версию CKey SDK
`static void`	`init(Context context, CKey.RootCertificateType certType, int logLevel, InitCallback callback)` Инициализация библиотеки.
`static void`	`initNonQual(Context context, CKey.RootCertificateType certType, int logLevel, InitCallback callback)` Инициализация библиотеки в режиме неквалифицированной подписи.
`boolean`	`initRNG()` Инициализирует генератор случайных чисел, используемый в CryptoPro CSP. Инициализация происходит при помощи биологической последовательности, которая строится при помощи серии касаний экрана пользователем.
`static boolean`	`isAntivirusInstalled()` Проверяет, установлен ли на устройстве доверенный антивирус
`static java.util.HashMap<java.lang.String,java.lang.String>`	`obtainSpyAppsList()` Функция составляет список потенциально опасных приложений, включающих: (1) Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW (кроме системных) (2) Приложения из чёрного списка Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW могут перекрыть активное окно приложения и показать своё (атака перекрытия окна). Следующие приложения не включаются в данный список: com.sec.android.easyMover com.google.android.apps.nbu.files
`static void`	`setAlternativeLogger(AlternativeLogger alternativeLogger)` Задаёт альтернативный способ записи логов вместо использования android.util.Log. Если в приложении отсутствуют вызовы данного метода, то запись логов sdk осуществляется в LogCat
`void`	`setHandlesBackgroundTimeout(int timeout)` Задаёт максимальное время нахождения приложения в фоне (в миллисекундах), в течение которого не требуется повторный ввод пароля.
`void`	`setLogLevel(int logLevel)` Устанавливает уровень логирования CKey SDK
`void`	`setRequestsTimeoutInterval(int interval)` Установка значения максимально времени ожидания ответа сервера

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_LOGGING
```
public static final int NO_LOGGING
```
    Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог. Передача этого значения при вызове метода init(Context, RootCertificateType, int, InitCallback) предотвращает запись каких-либо сообщений SDK в лог. Однако, сторонние библиотеки, входящие в состав SDK, по-прежнему могут записывать логи в LogCat.
    
    See Also:
    
    Constant Field Values
  - LOG_ERROR
```
public static final int LOG_ERROR
```
    Уровень логирования, при котором в лог будут записываться сообщения об ошибках (при записи в LogCat будет задействован только уровень error).
    
    See Also:
    
    Constant Field Values
  - LOG_WARNING
```
public static final int LOG_WARNING
```
    Уровень логирования, при котором в лог будут записываться сообщения об ошибках и предупреждения (при записи в LogCat будут задействованы уровни error и warn).
    
    See Also:
    
    Constant Field Values
  - LOG_INFO
```
public static final int LOG_INFO
```
    Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, а также информационные сообщения (при записи в LogCat будут задействованы уровни error, warn и info). Если включить данный уровень логирования, то my SDK добавит в LogCat порядка 200 записей общим объёмом около 16 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.
    
    See Also:
    
    Constant Field Values
  - LOG_DEBUG
```
public static final int LOG_DEBUG
```
    Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения и дополнительная отладочная информация (при записи в LogCat будут задействованы уровни error, warn, info и debug). Если включить данный уровень логирования, то my SDK добавит в LogCat порядка 1200 записей общим объёмом около 150 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.
    
    See Also:
    
    Constant Field Values
  - LOG_VERBOSE
```
public static final int LOG_VERBOSE
```
    Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения, а также дополнительная отладочная информация, включающая дамп всех сетевых запросов, выполняемых SDK (при записи в LogCat будут задействованы уровни error, warn, info, debug и verbose).
    Если включить данный уровень логирования, то my SDK добавит в LogCat порядка 1600 записей общим объёмом около 200 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - init
```
public static void init(Context context,
                        CKey.RootCertificateType certType,
                        int logLevel,
                        InitCallback callback)
```
    Инициализация библиотеки. Работа с CKey SDK начинается с вызова этой функции (в главном потоке).
    Инициализация включает:
    - Синхронизацию внутренних часов библиотеки
    - Инициализацию криптографических функций
    - Установку внешнего вида пользовательского интерфейса по умолчанию
    - Определение наличия прав суперпользователя (root) в устройстве
    - Определение наличия средств антивирусной защиты
    - Определение списка потенциально опасных приложений
    Parameters:
    
    context - Контекст приложения. Используется для вызова стандартных функций Android SDK, требующих передачи контекста приложения в списке аргументов.
    В качестве контекста может быть передан экземпляр Activity, тогда контекст приложения будет получен вызовом метода Activity.getApplicationContext().
    При передаче Activity в качестве контекста экран с показом уведомлений о проблемах безопасности (если таковые имеются) будет запущен в той же задаче, что и переданный экземпляр Activity. При указании контекста приложения данный экран будет запущен как отдельная задача. Все остальные экраны SDK (регистрация, просмотр операции и т.д.) всегда запускаются отдельной задачей, если в соответствующие методы явно не передан экземпляр Activity
    
    certType - Режим запуска SDK и соответствующий ему набор корневых сертификатов
    Предполагается, что CKey.RootCertificateType.Development используется на этапе разработки и тестирования приложений, в то время как CKey.RootCertificateType.Production применяется в приложениях для конечного пользователя.
    Корневой сертификат "для разработки" должен быть доступен как ресурс приложения, идентифицируемый R.raw.development_root_cert, в то время как сертификат "для конечного пользователя" должен быть доступен через идентификатор R.raw.production_root_cert
    
    logLevel - Уровень логирования. Используйте LOG_DEBUG, чтобы разрешить логирование и NO_LOGGING, чтобы предотвратить запись в логи любых сообщений от CKey SDK. Исключить подробные логи (в том числе логирование ответов сервера) можно, задав уровень LOG_INFO
    
    callback - Метод обратного вызова для получения результатов инициализации. При успешной инициализации возвращается экземпляр инициализированной библиотеки, который должен быть сохранён для дальнейшего использования в приложении. Библиотека не может быть инициализирована дважды
  - initNonQual
```
public static void initNonQual(Context context,
                               CKey.RootCertificateType certType,
                               int logLevel,
                               InitCallback callback)
```
    Инициализация библиотеки в режиме неквалифицированной подписи. В отличие от метода init(Context, RootCertificateType, int, InitCallback), данный метод не выполняет:
    - Проверку наличия прав суперпользователя (root) в устройстве
    - Проверку наличия средств антивирусной защиты
    - Определение списка потенциально опасных приложений.
    В остальном поведение метода и состав параметров аналогичны методу init(Context, RootCertificateType, int, InitCallback)
    See Also:
    
    init(Context, RootCertificateType, int, InitCallback)
  - destroy
```
public static void destroy()
```
    Завершает использование библиотеки. Попытка использовать какие-либо методы после вызова данного ведёт к неопределённому поведению
  - checkRoot
```
public static boolean checkRoot()
```
    Проверяет наличие root-прав на устройстве. Не проверяет, есть ли BusyBox
    
    Returns:
    
    true, если права суперпользователя установлены
  - isAntivirusInstalled
```
public static boolean isAntivirusInstalled()
```
    Проверяет, установлен ли на устройстве доверенный антивирус
    
    Returns:
    
    true, если антивирус установлен
  - obtainSpyAppsList
```
public static java.util.HashMap<java.lang.String,java.lang.String> obtainSpyAppsList()
```
    Функция составляет список потенциально опасных приложений, включающих:
    (1) Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW (кроме системных)
    (2) Приложения из чёрного списка
    Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW могут перекрыть активное окно приложения и показать своё (атака перекрытия окна).
    Следующие приложения не включаются в данный список:
    com.sec.android.easyMover
    com.google.android.apps.nbu.files
    
    Returns:
    
    Объект HashMap, где ключи — имена пакетов, а значения — читаемые названия приложений
  - getInstance
```
public static CKey getInstance()
```
    Возвращает экземпляр ранее инициализированной SDK или null, если библиотека ещё не была инициализирована
    
    Returns:
    
    Экземпляр SDK
  - getContext
```
public Context getContext()
```
    Контекст, переданный при инициализации
    
    Returns:
    
    Контекст приложения
  - getVersion
```
public static java.lang.String getVersion()
```
    Возвращает версию CKey SDK
    
    Returns:
    
    Строковое название версии CKey SDK
  - getAppearance
```
public static Appearance getAppearance()
```
    Текущие настройки внешнего вида SDK
    
    Returns:
    
    null при вызове до момента срабатывания InitCallback.onCustomizationReady(), иначе валидный объект с параметрами
  - getLayoutsMapper
```
public static LayoutMapper getLayoutsMapper()
```
    Доступ к настройкам внешнего вида через пользовательские макеты
    
    Returns:
    
    объект LayoutMapper с параметрами по умолчанию (установленными макетами из SDK) или null при вызове до момента срабатывания InitCallback.onCustomizationReady(), иначе * валидный объект с параметрами
  - setHandlesBackgroundTimeout
```
public void setHandlesBackgroundTimeout(int timeout)
```
    Задаёт максимальное время нахождения приложения в фоне (в миллисекундах), в течение которого не требуется повторный ввод пароля. Если метод не вызывается, то используется значение по умолчанию - 15 секунд.
    
    Parameters:
    
    timeout - Время в миллисекундах
  - setAlternativeLogger
```
public static void setAlternativeLogger(AlternativeLogger alternativeLogger)
```
    Задаёт альтернативный способ записи логов вместо использования android.util.Log.
    Если в приложении отсутствуют вызовы данного метода, то запись логов sdk осуществляется в LogCat
    
    Parameters:
    
    alternativeLogger - Класс, реализующий интерфейс AlternativeLogger или null, если требуется выполнять запись логов sdk в LogCat
  - setLogLevel
```
public void setLogLevel(int logLevel)
```
    Устанавливает уровень логирования CKey SDK
    
    Parameters:
    
    logLevel - Уровень логирования
    
    See Also:
    
    NO_LOGGING, LOG_VERBOSE, LOG_DEBUG, LOG_INFO, LOG_WARNING, LOG_ERROR
  - setRequestsTimeoutInterval
```
public void setRequestsTimeoutInterval(int interval)
```
    Установка значения максимально времени ожидания ответа сервера
    
    Parameters:
    
    interval - Время ожидания в миллисекундах
  - initRNG
```
public boolean initRNG()
```
    Инициализирует генератор случайных чисел, используемый в CryptoPro CSP.
    Инициализация происходит при помощи биологической последовательности, которая строится при помощи серии касаний экрана пользователем.
    
    Returns:
    
    Логическое значение true при успешной инициализации. Логическое значение false, если инициализация прошла неуспешно.
  - getAvailableAPIVersions
```
public void getAvailableAPIVersions(java.lang.String serviceUrl,
                                    CKey.Endpoint endpoint,
                                    APIVersionsCallback callback)
```
    Позволяет получить список поддерживаемых версий API для указанной конечной точки
    
    Parameters:
    
    serviceUrl - Адрес сервиса. Можно получить вызовом User.getServiceUrl()
    
    endpoint - Конечная точка, для которой проверяются поддерживаемые версии API
    
    callback - Реализация APIVersionsCallback для обработки результатов
  - analyzeQR
```
public static QRCode analyzeQR(java.lang.String qrValue)
```
    Определяет содержание заранее раскодированного QR-кода в виде строки
    
    Parameters:
    
    qrValue - Значение QR-кода в виде строки
    
    Returns:
    
    Объект, представляющий информацию о типе QR-кода или null, если тип установить не удалось
  - activate
```
public static void activate(QRCodeKinit kInit,
                            java.lang.String code,
                            QRCodeCallback callback)
```
    Выполняет активацию ключа KInit
    
    Parameters:
    
    kInit - Ключ KInit, полученный из QR-кода
    
    code - Код активации
    
    callback - Реализация QRCodeCallback для обработки результатов. При успехе возвращается новый объект QRCodeKinit
  - clearCache
```
public void clearCache()
```
    Удаляет все ранее скаченные документы из кэша приложения

Class CKey

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_LOGGING

LOG_ERROR

LOG_WARNING

LOG_INFO

LOG_DEBUG

LOG_VERBOSE

Method Detail

init

initNonQual

destroy

checkRoot

isAntivirusInstalled

obtainSpyAppsList

getInstance

getContext

getVersion

getAppearance

getLayoutsMapper

setHandlesBackgroundTimeout

setAlternativeLogger

setLogLevel

setRequestsTimeoutInterval

initRNG

getAvailableAPIVersions

analyzeQR

activate

clearCache