npmpackage.info

Gathering detailed insights and metrics for jail-monkey

jail-monkey

A React Native library for identifying if a phone is rooted or mocking locations

2.8.0

595

MIT

Java

7,737,700 2.9

Installations

npm install jail-monkey

Pull Requests

Open

20

Total

217

Closed

112

Merged

85

Issues

Open

38

Total

76

Closed

38

Releases

v2.8.0

Published on 09 Dec 2022

v2.7.0

Published on 03 Jun 2022

v2.6.0

Published on 23 Jul 2021

v2.5.0

Published on 24 Jun 2021

v2.4.2

Published on 24 Jun 2021

v2.4.0

Published on 18 May 2021

View all 11 releases

Developer

GantMan

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

NPM Version

Statistics

595 Stars

253 Commits

147 Forks

9 Watching

23 Branches

32 Contributors

Updated on 25 Nov 2024

Languages

Java (42.31%)

Objective-C (32.73%)

TypeScript (6.51%)

Ruby (6.16%)

Kotlin (5.77%)

JavaScript (4.72%)

Objective-C++ (1.81%)

Total Downloads

Cumulative downloads

Total Downloads

7,737,700

Last day

-10.9%

8,784

Compared to previous day

Last week

50,150

Compared to previous week

Last month

4.3%

210,719

Compared to previous month

Last year

18.3%

2,743,380

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Versions

WARNING: I don't have the devices to test anymore, so testing is done by those submitting PRs bona fide.

Jail Monkey

Can you ever really trust a phone?

Why?

Are users claiming they are crossing the globe in seconds and collecting all the Pokeballs? Some apps need to protect themselves in order to protect data integrity. JailMonkey allows you to:

Identify if a phone has been jail-broken or rooted for iOS/Android.
Detect mocked locations for phones set in "developer mode".
(ANDROID ONLY) Detect if the application is running on external storage such as an SD card.

Use

1import JailMonkey from 'jail-monkey'
2
3if (JailMonkey.isJailBroken()) {
4  // Alternative behaviour for jail-broken/rooted devices.
5}

Circle of Trust

API

Method	Returns	Description
`isJailBroken`	`boolean`	is this device jail-broken/rooted.
`canMockLocation`	`boolean`	Can this device fake its GPS location.
`trustFall`	`boolean`	Checks if the device violates either `isJailBroken` or `canMockLocation`.
`isDebuggedMode`	`Promise<boolean>`	Is the application is running in debug mode. Note that this method returns a Promise.

iOS Only APIs

Method	Returns	Description
`jailBrokenMessage`	`string`	Returns the reason for jailbroken detection. Will return an empty string on Android.

Android Only APIs

Method	Returns	Description
`hookDetected`	`boolean`	Detects if there is any suspicious installed applications.
`isOnExternalStorage`	`boolean`	Is the application running on external storage (ie. SD Card)
`AdbEnabled`	`boolean`	Is Android Debug Bridge enabled.
`isDevelopmentSettingsMode`	`Promise<boolean>`	Whether user has enabled development settings on their device. Note that this method returns a Promise.
`androidRootedDetectionMethods`	`RootedDetectionMethods`	Returns an object with the results of all the Android rooted detection methods for more granular detection, this can be helpful if some devices are giving false positives.

type RootedDetectionMethods = {
  rootBeer: {
    detectRootManagementApps: boolean;
    detectPotentiallyDangerousApps: boolean;
    checkForSuBinary: boolean;
    checkForDangerousProps: boolean;
    checkForRWPaths: boolean;
    detectTestKeys: boolean;
    checkSuExists: boolean;
    checkForRootNative: boolean;
    checkForMagiskBinary: boolean;
  },
  jailMonkey: boolean;
}

On iOS all of the Android only methods will return false or Promise<false> where appropriate.

:exclamation: Since emulators are usually rooted, you might want to bypass these checks during development. Unless you're keen on constant false alarms :alarm_clock:

Install

1npm i jail-monkey --save
2react-native link # Not required as of React Native 0.60.0

for iOS:

1cd ios && pod install

If you use rnpm, you may have trouble as rnpm does not link Android properly after 0.29.0!

Note: On Android you should include location.isFromMockProvider() from your location provider to compliment JailMonkey.canMockLocation(). Most react-native location libraries already have this check built in

Additional Info

This has been made public to help keep it up to date. As detection measures get better or out-dated, please send updates to this project so it can be the best method of detection.

Special thanks to this fantastic blog article: http://blog.geomoby.com/2015/01/25/how-to-avoid-getting-your-location-based-app-spoofed/

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More