com.atak.plugins.impl

Class AtakPluginRegistry

java.lang.Object

com.atak.plugins.impl.AtakPluginRegistry

public final class AtakPluginRegistry
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AtakPluginRegistry.Extension Each plugin can have multiple extensions where each extension describes a type (i.e., interface that the plugin implements), and the implementation of that type.
static class	AtakPluginRegistry.PluginDescriptor Plugin's description, high-level element of plugin.xml, contains a list of Extensions, use SimpleXML to parse with this.
static interface	AtakPluginRegistry.PluginLoadingProgressCallback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	pluginLoadedBasename
static java.lang.String	SHOULD_LOAD

Method Summary

Modifier and Type	Method and Description
static AtakPluginRegistry	get() Get a handle on the singleton, NULL if initialize() was not called first
java.util.Set<java.lang.String>	getIncompatiblePlugins() Gets list of plugins scanned which are incompatible with current version of ATAK
int	getNumberOfAppsInstalled() scan() populates the list of apps, this will tell you how many the scan returned...
AtakPluginRegistry.PluginDescriptor	getPlugin(java.lang.String pkg) Check if the specified app is a plugin
static java.lang.String	getPluginApiVersion(android.content.Context context, java.lang.String packageName, boolean stripPrefix)
java.util.Set<AtakPluginRegistry.PluginDescriptor>	getPluginDescriptors() Gets all the PluginDescriptors, must be populated by loadDescriptors()
java.util.Collection<java.lang.Object>	getPluginInstantiations() Returns an unmodifiable version of the plugin instantiations.
java.util.Set<java.lang.String>	getPluginsLoaded() Returns a copy of a set that contains the names of all of the loaded plugins.
static AtakPluginRegistry	initialize(MapView mapView) Initialize this singleton with all parameter requirements
static boolean	isAtak(android.content.pm.PackageInfo info) Check if the specified package is ATAK
static boolean	isAtak(java.lang.String packageName) Check if the specified package is ATAK
boolean	isPlugin(java.lang.String pkg) Check if the specified app is a plugin
boolean	isPluginLoaded(java.lang.String pkg)
static boolean	isTakCompatible(android.content.Context context, java.lang.String packageName) See if the specific plugin is compatible with this version of ATAK
static boolean	isTakCompatible(java.lang.String packageName, java.lang.String pluginApiVersion) See if the specific plugin API version is compatible with this version of ATAK Currently must match exactly the ATAK plugin API version (from AndroidManifest.xml)
boolean	loadPlugin(java.lang.String pkg) Loads the specified plugin
AtakPluginRegistry	loadPlugins(AtakPluginRegistry.PluginLoadingProgressCallback progressCallback) Loads all the plugins that have been marked PluginDescriptor.shouldLoad
AtakPluginRegistry	scan() Populates the list of installed applications on the system
boolean	scanAndLoadPlugins(AtakPluginRegistry.PluginLoadingProgressCallback callback) Scan apps, parse plugin descriptors, loads all extentions for all plugins which are flagged \ as "shouldLoad" and are not already loaded
static java.lang.String	stripPluginApiVersion(java.lang.String api)
boolean	unloadPlugin(java.lang.String pkg) Unloads the specified plugin
static boolean	verifySignature(android.content.Context context, java.lang.String pkgname) Verify the signature of the package matches the signature used to sign the TAK application.
static boolean	verifyTrust(android.content.Context context, java.lang.String pkgname) Verifies that a specific package can be trusted.

Methods inherited from class java.lang.Object

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

Field Detail

SHOULD_LOAD

public static final java.lang.String SHOULD_LOAD

See Also:

Constant Field Values

pluginLoadedBasename

public static final java.lang.String pluginLoadedBasename

See Also:

Constant Field Values

Method Detail

getPluginInstantiations

public java.util.Collection<java.lang.Object> getPluginInstantiations()

Returns an unmodifiable version of the plugin instantiations.

Returns:

a colection of plugins that have been instantiated

verifySignature

public static boolean verifySignature(android.content.Context context,
                                      java.lang.String pkgname)

Verify the signature of the package matches the signature used to sign the TAK application.

 Suppressed Lint warning because of the information in 
    https://thehackernews.com/2014/07/android-fake-id-vulnerability-allows_29.html
    https://www.blackhat.com/docs/us-14/materials/us-14-Forristal-Android-FakeID-Vulnerability-Walkthrough.pdf
    and the fact that it is not used for anything more than printing 
    the current signatures.   If this is ever enabled as a true 
    verification, then the above links should be examined.
 

Parameters:

context - provided context for getting the package manager

pkgname - the name of the pacakge to check

Returns:

true if the signatures match.

verifyTrust

public static boolean verifyTrust(android.content.Context context,
                                  java.lang.String pkgname)

Verifies that a specific package can be trusted.

Parameters:

context - the context to use

pkgname - the package name to look up

Returns:

true if trust can be verified

get

public static AtakPluginRegistry get()

Get a handle on the singleton, NULL if initialize() was not called first

Returns:

the fluid AtakPluginRegistry

initialize

public static AtakPluginRegistry initialize(MapView mapView)

Initialize this singleton with all parameter requirements

Parameters:

mapView - pass in a mapview for initialization purposes.

Returns:

return the single instance of the AtakPluginRegistry.

scanAndLoadPlugins

public boolean scanAndLoadPlugins(AtakPluginRegistry.PluginLoadingProgressCallback callback)

Scan apps, parse plugin descriptors, loads all extentions for all plugins which are flagged \ as "shouldLoad" and are not already loaded

Returns:

if all of the plugins are to be considered trusted.

scan

public AtakPluginRegistry scan()

Populates the list of installed applications on the system

Returns:

fluid interface

getNumberOfAppsInstalled

public int getNumberOfAppsInstalled()

scan() populates the list of apps, this will tell you how many the scan returned...

Returns:

the number of apps installed.

getPluginDescriptors

public java.util.Set<AtakPluginRegistry.PluginDescriptor> getPluginDescriptors()

Gets all the PluginDescriptors, must be populated by loadDescriptors()

Returns:

a copy of the set of PluginDescriptors

getIncompatiblePlugins

public java.util.Set<java.lang.String> getIncompatiblePlugins()

Gets list of plugins scanned which are incompatible with current version of ATAK

Returns:

a copy of the set of incompatible plugins

isPluginLoaded

public boolean isPluginLoaded(java.lang.String pkg)

getPluginsLoaded

public java.util.Set<java.lang.String> getPluginsLoaded()

Returns a copy of a set that contains the names of all of the loaded plugins.

Returns:

the copy

isPlugin

public boolean isPlugin(java.lang.String pkg)

Check if the specified app is a plugin

Parameters:

pkg - the package name

Returns:

true if the specified package is a plugin

getPlugin

public AtakPluginRegistry.PluginDescriptor getPlugin(java.lang.String pkg)

Check if the specified app is a plugin

Parameters:

pkg - the provided package name

Returns:

the plugin descriptor if the package is a plugin, otherwise null.

isTakCompatible

public static boolean isTakCompatible(android.content.Context context,
                                      java.lang.String packageName)

See if the specific plugin is compatible with this version of ATAK

Parameters:

context - the context to use.

packageName - the package name to check

Returns:

true if the package is considered tak compatible.

isTakCompatible

public static boolean isTakCompatible(java.lang.String packageName,
                                      java.lang.String pluginApiVersion)

See if the specific plugin API version is compatible with this version of ATAK Currently must match exactly the ATAK plugin API version (from AndroidManifest.xml)

Parameters:

packageName - the package name

pluginApiVersion - the api version

Returns:

true if the package is considered tak compatible.

isAtak

public static boolean isAtak(android.content.pm.PackageInfo info)

Check if the specified package is ATAK

Parameters:

info - the package to check

Returns:

true if the package is the main application.

isAtak

public static boolean isAtak(java.lang.String packageName)

Check if the specified package is ATAK

Parameters:

packageName - the package name to check.

Returns:

true if the package describes the core application

getPluginApiVersion

public static java.lang.String getPluginApiVersion(android.content.Context context,
                                                   java.lang.String packageName,
                                                   boolean stripPrefix)

stripPluginApiVersion

public static java.lang.String stripPluginApiVersion(java.lang.String api)

loadPlugins

public AtakPluginRegistry loadPlugins(AtakPluginRegistry.PluginLoadingProgressCallback progressCallback)

Loads all the plugins that have been marked PluginDescriptor.shouldLoad

Parameters:

progressCallback - indicates how many extensions have been loaded

Returns:

fluid interface

loadPlugin

public boolean loadPlugin(java.lang.String pkg)

Loads the specified plugin

Parameters:

pkg - the package to load

Returns:

fluid interface

unloadPlugin

public boolean unloadPlugin(java.lang.String pkg)

Unloads the specified plugin

Parameters:

pkg - the package to unload

Returns:

true if the package was unloaded.