README.md

Privacy Modules API

Root module for the privacy tools. This module defines all the low level APIs to monitor and manage privacy in android systems. It uses interface and abstract classes, and then should come with other modules, implementing these interfaces. The implementations could use various technical solutions depending on the privileges levels they have in the android system.

# Build

./gradlew :privacymodulesapi:assembleRelease
./gradlew --console=verbose publishToMavenLocal

# Modules architecture

See here

# Functionalities

## v0.0.2

• Permissions

  • List apps
  • List app's permissions
  • List status of runtime permission
  • Set status of runtime permissions
  • List mode of appOp permissions
  • Set mode of appOp permissions

• Fake location

  • Fake the location of the device, at the specified point.

Structure (UML class diagrams)

History:

• v0.0.2.4 (Trackers blocker)
• v0.0.2.2 (Permissions, FakeLocation)

classDiagram
    AbstractPermissionHelper o-- PemissionsCache
    AbstractPermissionHelper o-- AbstractPrivacyLeakageMeter
    AbstractPermissionHelper -- AppPermissionInfo

    AppPermissionInfo o-- AppInfo
    AppPermissionInfo o-- PermissionType

    AbstractPermissionManager -- FakeLocationManager
    IFakeLocationManager <|.. FakeLocationManager
 
    class AbstractPermissionHelper{
        <<abstract>>
        #PermissionCache: cache
        #AbstractPrivacyLeakageMeter: privacyMeter
        +getGroupsPermissions() List~PermissionGroupInfo~
        +getPermissionsUsedInGroup(PermissionGroupInfo groupName) Pair~Integer__Integer~
        +getAppsWithPermission(PermissionGroupInfo groupName) List~AppPermissionInfo~
        +getTotalApps() int
        +getTotalPermissionsRequested() int
    }

    class PemissionsCache{
      +getGroupsPermissions()
      +getAppInfo(String packageName) AppInfo
    }

    class AbstractPrivacyLeakageMeter{
      <<abstract>>
      #permissionTimeSeries
      #tarckersTimeSeries
      +getUsedPermissions()
      +getUsedPermissions(int duration)
    }

    class AppPermissionInfo{
    <<data class>>
      +AppInfo info
      +PermissionType permissionType
      +boolean isEnabled
    }

    class AppInfo{
    <<data class>>
      +String appName
      +Drawable appIcon
    }

    class PermissionType{
    <<enumeration>>
      +NORMAL
      +DANGEROUS
      +DANGEROUS_ONE_TIME
    }

    class AbstractPermissionManager{
    <<abstract>>
    +toggleDangerousPermission()*
    +setAppOppMode()*
    }

    class IFakeLocationManager{
    <<interface>>
    +isFakeLocationEnabled() boolean
    +setFakeLoction(doble latitude, double longitude)
    +setRandomLocation()
    +startFakeLocation()
    }

Loading

classDiagram

TrackerBlockingStats o-- HistoryEntry
HistoryEntry o-- HistoryEntryType
AbstractTrackerManager o-- Tracker
TrackerStatsManager o-- TrackerBlockingStats


 class Tracker{
    <<data class>>
    +id: TrackerId,
    +tags: List<Tag>,
    +sources: List<TrackerSource>,
    +meta: TrackerMetadata,
    +configs: ListTrackerConfig>,
    +status: TrackerStatus
    }

    class AbstractTrackerManager{
    <<abstract>>
    -trackers: List<Tracker>
    +addTracker(trackerId: TrackerId)
    +setTrackerStatus(newStatus: TrackerStatus)
    +getTrackersByStatus(status: TrackerStatus) List<Tracker>
    +getTrackerStatus(): TrackerStatus
    +getAppTrackers(appName: String) List<Tracker>
    +removeTracker(TrackerId: TrackerId)
    }

    class TrackerStatsManager{
    -trackersStats: HashMap<TrackerId, TrackerBlockingStats>
    #clearStats(TrackerId: TrackerId)
    #updateTrackerStats(trackerId: TrackerId, stats: TrackerBlockingStats)
    +getTrackerStats(trackerId: TrackerId) TrackerBlockingStats
    +getTrackerStatusByDate(trackerId: TrackerId, date: Date) TrackerBlockingStats
    +getTrackersStatusesByDate(date: Date): List<TrackerBlockingStats>
    }

    class TrackerBlockingStats{
    <<data class>>
    +allowed: Int,
    +denied: Int,
    +entries: List<HistoryEntry>
    }

    class HistoryEntry{
    <<data class>>
    +name: String,
    +type: HistoryEntryType,
    +time: Date,
    +requests: Int
    }

    class HistoryEntryType {
    <<enumeration>>
    BLOCKED,
    PASSED,
    PASSED_ALLOWED, 
    BLOCKEED_DENIED
}

Loading