ru.cryptopro.mydss.sdk.v2

Class MyDss

java.lang.Object

ru.cryptopro.mydss.sdk.v2.MyDss

public class MyDss
extends java.lang.Object

Основной класс для работы с MyDss SDK. Инициализация библиотеки происходит через вызов метода init(Context, RootCertificateType, int, HashMap, DSSInitCallback)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MyDss.DSSEndpoint Конечные точки сервера DSS, на которые обращается SDK
static class	MyDss.RootCertificateType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DSS_LOG_DEBUG Уровень логирования, соответствующий выводу в лог как информационных сообщений, так и сообщений об ошибках
static int	DSS_NO_LOGGING Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог

Method Summary

Modifier and Type	Method and Description
static void	activate(DSSQRCodeKinit qrCodeKinit, java.lang.String code, DSSQRCodeCallback callback)
static DSSQRCode	analyzeQR(java.lang.String qrValue) Определяет содержание заранее раскодированного QR-кода в виде строки
boolean	checkRoot() Проверяет наличие root-прав на устройстве Не проверяет, есть ли BusyBox
void	clearCache() Удаляет все ранее скаченные документы из кэша приложения
void	destroy() Завершает использование библиотеки.
static Appearance	getAppearance()
void	getAvailableAPIVersions(java.lang.String serviceUrl, MyDss.DSSEndpoint endpoint, DSSAPIVersionsCallback callback) Позволяет получить список поддерживаемых версий API для указанной конечной точки
Context	getContext() Возвращает контекст, переданный при инициализации
static MyDss	getInstance() Возвращает инициализированный функцией init(Context, RootCertificateType, int, HashMap, DSSInitCallback) экземпляр библиотеки или null, если инициализация ещё не состоялась или была неуспешной
java.lang.String	getVersion() Возвращает версию MyDss SDK
static void	init(Context context, MyDss.RootCertificateType certType, int logLevel, java.util.HashMap<java.lang.String,java.lang.String[]> trustedApps, DSSInitCallback callback) Инициализация библиотеки.
static void	initNonQual(Context context, MyDss.RootCertificateType certType, int logLevel, DSSInitCallback callback) Инициализация библиотеки в режиме неквалифицированной подписи.
boolean	initRNG(Context activityContext) Инициализирует генератор случайных чисел, используемый в CryptoPro CSP Инициализация происходит при помощи биологической последовательности, которая строится при помощи серии касаний экрана пользователем
boolean	isAntivirusInstalled() Проверяет, установлен ли доверенный антивирус
java.util.HashMap<java.lang.String,java.lang.String>	obtainSpyAppsList(java.util.HashMap<java.lang.String,java.lang.String[]> trustedApps) Функция составляет список потенциально опасных приложений, включающих: (1) Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW (кроме системных) (2) Приложения из чёрного списка Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW могут перекрыть активное окно приложения и показать своё (атака перекрытия окна).
static void	setAlternativeLogger(AlternativeLogger logger) Задаёт альтернативный способ записи логов вместо использования android.util.Log Если в приложении отсутствуют вызовы данного метода, то запись логов sdk осуществляется в LogCat
void	setHandlesBackgroundTimeout(int timeout) Задаёт максимальное время нахождения приложения в фоне (в миллисекундах), в течение которого не требуется повторный ввод пароля.
void	setLogLevel(int logLevel) Устанавливает уровень логированя MyDSS SDK

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DSS_NO_LOGGING

public static final int DSS_NO_LOGGING

Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог

See Also:

Constant Field Values

DSS_LOG_DEBUG

public static final int DSS_LOG_DEBUG

Уровень логирования, соответствующий выводу в лог как информационных сообщений, так и сообщений об ошибках

See Also:

Constant Field Values

Method Detail

getAppearance

public static Appearance getAppearance()

init

public static void init(Context context,
                        MyDss.RootCertificateType certType,
                        int logLevel,
                        java.util.HashMap<java.lang.String,java.lang.String[]> trustedApps,
                        DSSInitCallback callback)

Инициализация библиотеки. Работа с MyDSS SDK начитнается с вызова этой функции
Инициализация включает:
- Синхронизацию внутренних часов библиотеки
- Инициализацию криптографических функций
- Установку внешнего вида пользовательского интерфейса по умолчанию
- Определение наличия прав суперпользователя (root) в устройстве
- Определение наличия средств антивирусной защиты
- Определение списка потенциально опасных приложений

Parameters:

context - Контекст приложения. Используется для вызова стандартных функций Android SDK, требующих передачи контекста приложения в списке аргументов.

certType - Тип сертификата.
Предполагается, чтоMyDss.RootCertificateType.Development используется на этапе разработки и тестирования приложений, в то время как MyDss.RootCertificateType.Production применяется в приложениях для конечного пользователя.
Корневой сертификат "для разработки" должен быть доступен как ресурс приложения, идентифицируемый R.raw.development_root_cert, в то время как сертификат "для конечного пользователя" должен быть доступен через идентификатор R.raw.production_root_cert

logLevel - Уровень логирования. Используйте DSS_LOG_DEBUG, чтобы разрешить логирование и DSS_NO_LOGGING, чтобы предотвратить запись в логи любых сообщений от MyDSS SDK.

trustedApps - Список "доверенных" приложений. Может быть пустым (null). Подробнее в разеделе "Инициализация SDK со списком доверенных приложений" на странице Руководство по использованию myDSS SDK

callback - Метод обратного вызова для получения результатов инициализации. При успешной инициализации возвращается экземпляр инициализированной библиотеки, который должен быть сохранён для дальнейшего использования в приложении. Библиотека не может быть инициализирована дважды.

initNonQual

public static void initNonQual(Context context,
                               MyDss.RootCertificateType certType,
                               int logLevel,
                               DSSInitCallback callback)

Инициализация библиотеки в режиме неквалифицированной подписи. В отличие от метода init(Context, RootCertificateType, int, HashMap, DSSInitCallback), данный метод не выполняет:
- Проверку наличия прав суперпользователя (root) в устройстве
- Проверку наличия средств антивирусной защиты
- Определение списка потенциально опасных приложений.
В остальном, поведение метода и состав параметров аналогичны методу init(Context, RootCertificateType, int, HashMap, DSSInitCallback)

Parameters:

context - Контекст приложения. Используется для вызова стандартных функций Android SDK, требующих передачи контекста приложения в списке аргументов.

certType - Тип сертификата.
Предполагается, чтоMyDss.RootCertificateType.Development используется на этапе разработки и тестирования приложений, в то время как MyDss.RootCertificateType.Production применяется в приложениях для конечного пользователя.
Корневой сертификат "для разработки" должен быть доступен как ресурс приложения, идентифицируемый R.raw.development_root_cert, в то время как сертификат "для конечного пользователя" должен быть доступен через идентификатор R.raw.production_root_cert

logLevel - Уровень логирования. Используйте DSS_LOG_DEBUG, чтобы разрешить логирование и DSS_NO_LOGGING, чтобы предотвратить запись в логи любых сообщений от MyDSS SDK.

callback - Метод обратного вызова для получения результатов инициализации. При успешной инициализации возвращается экземпляр инициализированной библиотеки, который должен быть сохранён для дальнейшего использования в приложении. Библиотека не может быть инициализирована дважды.

initRNG

public boolean initRNG(Context activityContext)

Инициализирует генератор случайных чисел, используемый в CryptoPro CSP Инициализация происходит при помощи биологической последовательности, которая строится при помощи серии касаний экрана пользователем

Parameters:

activityContext - Контекст активности, в которой предполагается вывести окно инициализации датчика случайных чисел

Returns:

Логическое значение true при успешной инициализации. Логическое значение false, если инициализация прошла неуспешно.

setHandlesBackgroundTimeout

public void setHandlesBackgroundTimeout(int timeout)

Задаёт максимальное время нахождения приложения в фоне (в миллисекундах), в течение которого не требуется повторный ввод пароля. Если метод не вызывается, то используется значение по умолчанию - 15 сек

Parameters:

timeout - max time in milliseconds for being in background during which handles are kept

setAlternativeLogger

public static void setAlternativeLogger(AlternativeLogger logger)

Задаёт альтернативный способ записи логов вместо использования android.util.Log
Если в приложении отсутствуют вызовы данного метода, то запись логов sdk осуществляется в LogCat

Parameters:

logger - Класс, реализующий интерфейс AlternativeLogger или null, если требуется выполнять запись логов sdk в LogCat

destroy

public void destroy()

Завершает использование библиотеки. Попытка использовать какие-либо методы после вызова данного ведёт к неопределённому поведению

setLogLevel

public void setLogLevel(int logLevel)

Устанавливает уровень логированя MyDSS SDK

Parameters:

logLevel - Уровень логирования. DSS_LOG_DEBUG позволяет выводить сообщения об ошибках и информационные сообщения в логи, в то время как DSS_NO_LOGGING предотвращает MyDSS SDK от вывода каких-либо сообщений в лог.

getVersion

public java.lang.String getVersion()

Возвращает версию MyDss SDK

Returns:

версия MyDss SDK

analyzeQR

public static DSSQRCode analyzeQR(java.lang.String qrValue)

Определяет содержание заранее раскодированного QR-кода в виде строки

Parameters:

qrValue - Значение QR-кода в виде строки

Returns:

Объект, представляющий информацию о типе QR-кода или null, если тип установить не удалось

activate

public static void activate(DSSQRCodeKinit qrCodeKinit,
                            java.lang.String code,
                            DSSQRCodeCallback callback)

getInstance

public static MyDss getInstance()

Возвращает инициализированный функцией init(Context, RootCertificateType, int, HashMap, DSSInitCallback) экземпляр библиотеки или null, если инициализация ещё не состоялась или была неуспешной

Returns:

Объект ранее иинициализированной биболиотеки

getContext

public Context getContext()

Возвращает контекст, переданный при инициализации

Returns:

Контекст приложения

clearCache

public void clearCache()

Удаляет все ранее скаченные документы из кэша приложения

checkRoot

public boolean checkRoot()

Проверяет наличие root-прав на устройстве
Не проверяет, есть ли BusyBox

Returns:

true, если права суперпользователя установлены

isAntivirusInstalled

public boolean isAntivirusInstalled()

Проверяет, установлен ли доверенный антивирус

Returns:

true, если антивирус установлен

obtainSpyAppsList

public java.util.HashMap<java.lang.String,java.lang.String> obtainSpyAppsList(java.util.HashMap<java.lang.String,java.lang.String[]> trustedApps)

Функция составляет список потенциально опасных приложений, включающих:
(1) Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW (кроме системных)
(2) Приложения из чёрного списка
Приложения с правами PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW могут перекрыть активное окно приложения и показать своё (атака перекрытия окна).
Следующие приложения не включаются в данный список:
com.sec.android.easyMover
com.google.android.apps.nbu.files

Parameters:

trustedApps - На устройстве могут быть установлены приложения с привилегиями PACKAGE_USAGE_STATS и SYSTEM_ALERT_WINDOW, которые не являются вредоносными. Если у вас есть список "доверенных" приложений, вы можете передать его в виде объекта HashMap, где ключём является Application ID (представлен типом String), а значение содержит массив хэшей подписей разработчика приложения.
. Подробнее о процедуре передачи списка доверенных приложений во время инииализации SDK можно прочитать в разеделе "Инициализация SDK со списком доверенных приложений" на странице Руководство по использованию myDSS SDK

Returns:

Объект HashMap, где ключи - имена пакетов, а значения - читаемые названия приложений

getAvailableAPIVersions

public void getAvailableAPIVersions(java.lang.String serviceUrl,
                                    MyDss.DSSEndpoint endpoint,
                                    DSSAPIVersionsCallback callback)

Позволяет получить список поддерживаемых версий API для указанной конечной точки

Parameters:

serviceUrl - Адрес сервиса. Можно получить вызовом DSSUser.getServiceUrl()

endpoint - Конечная точка, для которой проверяются поддерживаемые

callback - Реализация DSSAPIVersionsCallback для обработки ррезультатов