cordova-plugin-iroot - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0

CHANGELOG.md

@@ -5,7 +5,19 @@ # Cordova Jailbreak/Root Detection Plugin
 
-### v0.7.0
+### v0.7.0-0.8.0
 
-+ Add new Android Check: `IRoot.isRootedRedBeerWithoutBusyBoxCheck()`
-+ Update README => Added Android Check: `IRoot.isRootedRedBeer()`
++ Add new optional install variable `ENABLE_BUSYBOX_CHECK`
++ Fixed Android Check: `IRoot.isRooted()`
++ Add additional iOS checks. Merged [PR#8](https://github.com/WuglyakBolgoink/cordova-plugin-iroot/pull/8)
++ Updated Types (index.d.ts)
 
+#### BREAKING CHANGES
+
++ Add/rename new Android Check: `IRoot.isRootedRedBeer()`
++ Add/rename new Android Check: `IRoot.isRootedRedBeerWithoutBusyBox()`
+
+#### Updates/Upgrades
+
+* upgrade `rootbeer` v0.0.6 -> 0.0.7
+
+
 ### v0.6.0
@@ -18,6 +30,2 @@
 
-#### BREAKING CHANGES
-
-nothing
-
 ### v0.5.0
@@ -28,5 +36,1 @@
 * upgrade `rootbeer` v0.0.4 -> 0.0.6
-
-#### BREAKING CHANGES
-
-nothing

package.json

 {
   "name": "cordova-plugin-iroot",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Cordova Jailbreak/Root Detection Plugin for Apache Cordova",
+  "types": "./types/index.d.ts",
   "cordova": {
@@ -13,2 +14,5 @@ "id": "cordova-plugin-iroot",
   "keywords": [
+    "ecosystem:cordova",
+    "cordova-android",
+    "cordova-ios",
     "cordova",
@@ -22,5 +26,7 @@ "jailbreak",
     "rooted",
-    "ecosystem:cordova",
-    "cordova-ios",
-    "cordova-android"
+    "rootBeer",
+    "android",
+    "ios",
+    "iroot",
+    "plugin"
   ],
@@ -30,3 +36,3 @@ "engines": [
       "name": "cordova",
-      "version": ">=3.0.0"
+      "version": ">=6.0.0"
     }
@@ -33,0 +39,0 @@ ],

README.md

@@ -1,5 +0,1 @@
-# cordova-plugin-iroot
-
-Cordova Jailbreak/Root Detection Plugin
-
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/WuglyakBolgoink/cordova-plugin-iroot/master/LICENSE)
@@ -9,20 +5,26 @@ [![Android](https://img.shields.io/badge/android-success-green.svg)](https://shields.io)
 
-[![NPM](https://nodei.co/npm/cordova-plugin-iroot.png?mini=true)](https://nodei.co/npm/cordova-plugin-iroot/)
+<p align="center">
+  <img src="/assets/logo.png">
+</p>
 
+Cordova Jailbreak/Root Detection Plugin
+=======================================
 
-Use this plugin to add an extra layer of security for your app, by detecting if the device running the app is jailbroken.
+Use this plugin to add an extra layer of security for your app by detecting if the device was `root`ed (android) or `jailbreak`ed (iOS).
 
-Based on:
+## Install
 
-- [cordova-plugin-jailbreak-detection](https://github.com/leecrossley/cordova-plugin-jailbreak-detection) (iOS)
-- [cordova-plugin-root-detection](https://github.com/trykovyura/cordova-plugin-root-detection) (Android)
-- [RootBeer](https://github.com/scottyab/rootbeer/blob/master/README.md) (Android)
+```
+cordova plugin add cordova-plugin-iroot --save
+```
 
-## Installation
+### Custom `Android` Install to prevent [False positives](https://github.com/scottyab/rootbeer#false-positives) checks
 
+You can use `ENABLE_BUSYBOX_CHECK` variable to change the logic. By default is `true`.
+
 ```
-cordova plugin add cordova-plugin-iroot --save
+cordova plugin add cordova-plugin-iroot --variable ENABLE_BUSYBOX_CHECK=false --save
 ```
 
-## Usage
+## Usage in Javascript
 
@@ -40,6 +42,16 @@ ```
 
-- `successCallback(result:boolean:ios|number:android)` is called with `true/1` if the device is Jailbroken/rooted, otherwise `false/0`.
+- `successCallback(result:boolean)` is called with `true` if the device is Jailbroken/rooted, otherwise `false`.
 - `failureCallback(error:string)` is called if there was an error determining if the device is Jailbroken/rooted.
 
+## Info
 
+Based on:
+
+- **iOS**
+    - [cordova-plugin-jailbreak-detection](https://github.com/leecrossley/cordova-plugin-jailbreak-detection)
+    - [Shmoopi Anti-Piracy](https://github.com/Shmoopi/AntiPiracy)
+- **Android**
+    - [RootBeer](https://github.com/scottyab/rootbeer/blob/master/README.md)
+    - [cordova-plugin-root-detection](https://github.com/trykovyura/cordova-plugin-root-detection)
+
 ## Demo ionic
@@ -49,4 +61,33 @@
 
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
 ## License
 
 MIT License
+
+Copyright (c) 2017 Wuglyak Bolgoink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

www/iroot.js

 var exec = require('cordova/exec');
 
 module.exports = {
-    isRooted: function(successCallback, failureCallback) {
-        exec(successCallback, failureCallback, 'IRoot', 'isRooted', []);
+    isRooted: function(onSuccess, onError) {
+        exec(onSuccess, onError, 'IRoot', 'isRooted', []);
     },
-    isRootedRedBeer: function(successCallback, failureCallback) {
-        exec(successCallback, failureCallback, 'IRoot', 'isRootedRedBeer', []);
+    isRootedRedBeer: function(onSuccess, onError) {
+        exec(onSuccess, onError, 'IRoot', 'isRootedRedBeer', []);
     },
-    isRootedRedBeerWithoutBusyBoxCheck: function(successCallback, failureCallback) {
-        exec(successCallback, failureCallback, 'IRoot', 'isRootedRedBeerWithoutBusyBoxCheck', []);
+    isRootedRedBeerWithoutBusyBox: function(onSuccess, onError) {
+        exec(onSuccess, onError, 'IRoot', 'isRootedRedBeerWithoutBusyBox', []);
     }
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

71419

increased by488.63%

Number of package files

19

increased by72.73%

Lines of code

152

increased by794.12%

Number of lines in readme file

91

increased by82%

Worsened metrics

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes