cordova-plugin-sms-retriever-manager 1.0.3

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "cordova-plugin-sms-retriever-manager",
+  "version": "1.0.3",
+  "description": "Cross-platform plugin for Cordova / PhoneGap to to easily retrive SMS using Google SMS retriver API. Available for Android.",
+  "cordova": {
+    "id": "cordova-plugin-sms-retriever-manager",
+    "platforms": [
+      "android"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master.git"
+  },
+  "keywords": [
+    "cordova",
+    "phonegap",
+    "sms",
+    "ecosystem:cordova",
+    "cordova-android"
+  ],
+  "engines": [
+    {
+      "name": "cordova",
+      "version": ">=3.0.0"
+    }
+  ],
+  "author": "Haresh Hanat",
+  "license": "DEV",
+  "bugs": {
+    "url": "https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master/issues"
+  },
+  "homepage": "https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master"
+}

package/plugin.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
+        id="cordova-plugin-sms-retriever-manager" version="1.0.3">
+    <name>Device</name>
+    <description>Cordova SMS Retriver Plugin</description>
+    <license>MIT</license>
+    <keywords>ionic, ionic3, cordova, cordova-plugin, phonegap-plugin, ionic-framework, ionic-cordova, sms, sms-verificationm automatic SMS receive</keywords>
+    
+    <js-module name="AndroidSmsRetriever" src="www/smsRetriever.js">
+        <clobbers target="cordova.plugins.smsRetriever" />
+    </js-module>
+    <engines>
+        <engine name="cordova" version=">=3.6.0"></engine>
+    </engines>
+    <platform name="android">
+     <preference name="PLAY_SERVICES_VERSION" default="15.0.1"/>
+     <framework src="com.google.android.gms:play-services-auth-api-phone:$PLAY_SERVICES_VERSION"/>
+        <source-file src="src/android/com/codingsans/ionic/smsRetriever/AndroidSmsRetriever.java"
+                     target-dir="src/com/codingsans/ionic/smsRetriever"></source-file>
+
+        <config-file target="res/xml/config.xml" parent="/*">
+            <feature name="AndroidSmsRetriever">
+                <param name="android-package" value="com.codingsans.ionic.smsRetriever.AndroidSmsRetriever" />
+            </feature>
+        </config-file>
+    </platform>
+</plugin>

package/readme.md

@@ -0,0 +1,223 @@
+# ionic-native-sms-retriever-plugin-master
+# Cordova SMS retriver Plugin
+
+Cross-platform plugin for Cordova / PhoneGap to to easily retrive SMS for your APP without need permission of SMS_READ. Available for **Android**.
+
+## Installing the plugin
+
+Using the Cordova CLI run:
+
+```
+ionic cordova plugin add cordova-plugin-sms-retriever-manager
+npm install @ionic-native/sms-retriever
+```
+
+It is also possible to install via repo url directly (unstable), run :
+
+```sh
+ionic cordova plugin add https://github.com/hanatharesh2712/ionic-native-sms-retriever-plugin-master.git
+```
+You can find working Demo for Cordova here: https://github.com/hanatharesh2712/automatic-sms-cordova/tree/main/hello
+## Using the plugin
+HTML
+
+```html
+ <input type="button" class="hashCode" value="Get App Hash" />
+ <input type="button" class="startWatching" value="Start watching SMS" />
+```
+
+Javascript
+
+```js
+
+document.querySelector('.hashCode').addEventListener('click', this.getAppHash);
+document.querySelector('.startWatching').addEventListener('click', this.retriveSMS);
+
+var app = {
+       getAppHash: function() {
+        window['cordova']['plugins']['smsRetriever']['getAppHash'](
+        (result) => { 
+            // Once you get this hash code of your app. Please remove this code.
+            alert(result);
+            console.log('Hash', result);
+        },
+        (err) => {
+            console.log(err);
+        });
+    }, 
+
+    retriveSMS: function() {
+        window['cordova']['plugins']['smsRetriever']['startWatching'](
+      // the first callback is the success callback. We got back the native code’s result here.
+      (result) => { 
+        alert(result.Message);
+		console.log('Message', result);
+	  },
+      // the second is the error callback where we get back the errors
+      (err) => {
+        console.log(err);
+      });
+    }
+};
+```
+You can find working Demo for Ionic 4 here: https://github.com/hanatharesh2712/sms-plugin-test
+
+  Typescript (Ionic 4)
+```typescript
+  import { SmsRetriever } from '@ionic-native/sms-retriever/ngx';
+ 
+ 
+  constructor(private smsRetriever: SmsRetriever) { }
+ 
+  ...
+ 
+ // This function is to get hash string of APP.
+ // * @return {Promise<string>} Returns a promise that resolves when successfully generate hash of APP.
+  this.smsRetriever.getAppHash()
+    .then((res: any) => console.log(res))
+    .catch((error: any) => console.error(error));
+
+
+// * This function start wathching message arrive event and retrive message text.
+// * @return {Promise<string>} Returns a promise that resolves when retrives SMS text or TIMEOUT after 5 min.
+   this.smsRetriever.startWatching()
+    .then((res: any) => console.log(res))
+    .catch((error: any) => console.error(error));
+ 
+  ```
+
+You can find working Demo for Ionic 3 here: https://github.com/hanatharesh2712/sms-plugin-test-ionic-3
+
+  Typescript (Ionic 3)
+```typescript
+
+import { SmsRetriever } from '@ionic-native/sms-retriever/ngx';
+var smsRetriever = window['cordova']['plugins']['smsRetriever'];
+ 
+  public smsTextmessage: string = '';
+  public appHashString: string = '';
+  constructor(private smsRetriever: SmsRetriever) { }
+ 
+  ...
+ 
+  getHashCode() {
+    smsRetriever['getAppHash']((res) => {
+      this.appHashString = res;
+      console.log(res);
+    }, (err) => {
+      console.warn(err);
+    }
+    );
+  }
+
+  getSMS() {
+    smsRetriever['startWatching']((res) => {
+      this.smsTextmessage = res.Message;
+      console.log(res);
+    }, (err) => {
+      console.warn(err);
+    }
+    );
+  }
+  ```
+ Flow to test: 
+ [![flow](https://raw.githubusercontent.com/hanatharesh2712/automatic-sms-cordova/main/hello/res/ref-images/sms%20plugin%20demo.png)](https://raw.githubusercontent.com/hanatharesh2712/automatic-sms-cordova/main/hello/res/ref-images/sms%20plugin%20demo.png)
+
+ 
+
+You need to send your application hash in SMS when you are sending from your backend. to generate the hash of your application read this: https://developers.google.com/identity/sms-retriever/verify
+
+To get your application hash code:
+
+* Without the correct hash, your app won't recieve the message callback. This only needs to be
+* generated once per app and stored. Then you can remove this function from your code.
+
+
+
+
+BUILD FAILED
+
+The problem is that you need to make sure that you set the target to android-19 or later in your ./platforms/android/project.properties file like this:
+
+    # Project target.
+    target=android-19
+
+
+## Donations
+
+If your app is successful or if you are working for a company, please consider donating some beer money :beer::
+
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YP2LMRCJMGTNJ&source=url)
+
+Keep in mind that I am maintaining this repository on my free time so thank you for considering a donation. :+1:
+
+
+## Contributing
+
+I believe that everything is working, feel free to put in an issue or to fork and make pull requests if you want to add a new feature.
+
+Things you can fix:
+* Allow for null number to be passed in
+  Right now, it breaks when a null value is passed in for a number, but it works if it's a blank string, and allows the user to pick the number
+  It should automatically convert a  null value to an empty string
+
+Thanks for considering contributing to this project.
+
+### Finding something to do
+
+Ask, or pick an issue and comment on it announcing your desire to work on it. Ideally wait until we assign it to you to minimize work duplication.
+
+### Reporting an issue
+
+- Search existing issues before raising a new one.
+
+- Include as much detail as possible.
+
+### Pull requests
+
+- Make it clear in the issue tracker what you are working on, so that someone else doesn't duplicate the work.
+
+- Use a feature branch, not master.
+
+- Rebase your feature branch onto origin/master before raising the PR.
+
+- Keep up to date with changes in master so your PR is easy to merge.
+
+- Be descriptive in your PR message: what is it for, why is it needed, etc.
+
+- Make sure the tests pass
+
+- Squash related commits as much as possible.
+
+### Coding style
+
+- Try to match the existing indent style.
+
+- Don't mix platform-specific stuff into the main code.
+
+
+
+
+## History
+
+
+## License
+
+The MIT License
+
+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.

package/src/android/com/codingsans/ionic/smsRetriever/AndroidSmsRetriever.java

@@ -0,0 +1,234 @@
+package com.codingsans.ionic.smsRetriever;
+
+import org.apache.cordova.CallbackContext;
+import org.apache.cordova.CordovaInterface;
+import org.apache.cordova.CordovaWebView;
+import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.PluginResult;
+import org.apache.cordova.LOG;
+
+import android.content.BroadcastReceiver;
+import android.content.Intent;
+import android.content.IntentFilter;
+import android.os.Bundle;
+import android.util.Log;
+import android.widget.Toast;
+
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.json.JSONException;
+
+import android.content.Context;
+import com.google.android.gms.auth.api.phone.SmsRetriever;
+import com.google.android.gms.auth.api.phone.SmsRetrieverClient;
+import com.google.android.gms.common.api.Status;
+import com.google.android.gms.tasks.OnFailureListener;
+import com.google.android.gms.tasks.OnSuccessListener;
+import com.google.android.gms.common.api.CommonStatusCodes;
+import com.google.android.gms.tasks.Task;
+
+import java.util.ArrayList;
+
+import static com.google.android.gms.common.api.CommonStatusCodes.*;
+
+import android.content.ContextWrapper;
+import android.content.pm.PackageManager;
+import android.content.pm.Signature;
+import android.util.Base64;
+
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.Arrays;
+
+public class AndroidSmsRetriever extends CordovaPlugin {
+
+  private SmsRetrieverClient smsRetrieverClient;
+  //public static final int MAX_TIMEOUT = 300000; // 5 mins in millis
+  private static final String TAG = AndroidSmsRetriever.class.getSimpleName();
+
+  private static final String HASH_TYPE = "SHA-256";
+  public static final int NUM_HASHED_BYTES = 9;
+  public static final int NUM_BASE64_CHAR = 11;
+
+  private CallbackContext callbackContext;
+  private JSONObject data = new JSONObject();
+
+  @Override
+  public void initialize(CordovaInterface cordova, CordovaWebView webView) {
+    LOG.v(TAG, "SmsRetriever: initialization");
+    //Toast.makeText(this.cordova.getActivity().getApplicationContext(),"SmsRetriever: initialization", Toast.LENGTH_SHORT).show();
+
+    super.initialize(cordova, webView);
+
+    // Get an instance of SmsRetrieverClient, used to start listening for a matching
+    // SMS message.
+    smsRetrieverClient = SmsRetriever.getClient(this.cordova.getActivity().getApplicationContext());
+  }
+
+  /**
+   * Get all the app signatures for the current package
+   * @return
+   */
+  public ArrayList<String> getAppSignatures() {
+    ArrayList<String> appCodes = new ArrayList<>();
+
+    try {
+      // Get all package signatures for the current package
+      String packageName = cordova.getActivity().getApplicationContext().getPackageName();
+      PackageManager packageManager = cordova.getActivity().getApplicationContext().getPackageManager();
+      Signature[] signatures = packageManager.getPackageInfo(packageName,
+              PackageManager.GET_SIGNATURES).signatures;
+
+      // For each signature create a compatible hash
+      for (Signature signature : signatures) {
+        String hash = hash(packageName, signature.toCharsString());
+        if (hash != null) {
+          appCodes.add(String.format("%s", hash));
+        }
+      }
+    } catch (PackageManager.NameNotFoundException e) {
+      Log.e(TAG, "Unable to find package to obtain hash.", e);
+    }
+    return appCodes;
+  }
+
+  private static String hash(String packageName, String signature) {
+    String appInfo = packageName + " " + signature;
+    try {
+      MessageDigest messageDigest = MessageDigest.getInstance(HASH_TYPE);
+      messageDigest.update(appInfo.getBytes(StandardCharsets.UTF_8));
+      byte[] hashSignature = messageDigest.digest();
+
+      // truncated into NUM_HASHED_BYTES
+      hashSignature = Arrays.copyOfRange(hashSignature, 0, NUM_HASHED_BYTES);
+      // encode into Base64
+      String base64Hash = Base64.encodeToString(hashSignature, Base64.NO_PADDING | Base64.NO_WRAP);
+      base64Hash = base64Hash.substring(0, NUM_BASE64_CHAR);
+
+      Log.d(TAG, String.format("pkg: %s -- hash: %s", packageName, base64Hash));
+
+      return base64Hash;
+    } catch (NoSuchAlgorithmException e) {
+      Log.e(TAG, "hash:NoSuchAlgorithm", e);
+    }
+    return null;
+  }
+
+  @Override
+  public void onDestroy() {
+    try {
+      if (mMessageReceiver != null) {
+        this.cordova.getActivity().getApplicationContext().unregisterReceiver(mMessageReceiver);
+        mMessageReceiver = null;
+      }
+    } catch(IllegalArgumentException e) {
+        e.printStackTrace();
+    }
+  }
+
+  @Override
+  public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
+    this.callbackContext = callbackContext;
+
+    LOG.v(TAG, "Executing action: " + action);
+    //Toast.makeText(this.cordova.getActivity().getApplicationContext(),"Executing action: " + action, Toast.LENGTH_SHORT).show();
+
+    if ("start".equals(action)) {
+      // Starts SmsRetriever, which waits for ONE matching SMS message until timeout
+      // (5 minutes). The matching SMS message will be sent via a Broadcast Intent with
+      // action SmsRetriever#SMS_RETRIEVED_ACTION.
+      Task<Void> task = smsRetrieverClient.startSmsRetriever();
+
+      // Listen for success/failure of the start Task. If in a background thread, this
+      // can be made blocking using Tasks.await(task, [timeout]);
+      task.addOnSuccessListener(new OnSuccessListener<Void>() {
+        @Override
+        public void onSuccess(Void aVoid) {
+          // Successfully started retriever, expect broadcast intent
+          LOG.v(TAG, "Executing action: addOnSuccessListener");
+          //Toast.makeText(cordova.getActivity().getApplicationContext(),"Executing action: addOnSuccessListener", Toast.LENGTH_SHORT).show();
+
+          IntentFilter intentFilter = new IntentFilter();
+          intentFilter.addAction(SmsRetriever.SMS_RETRIEVED_ACTION);
+          cordova.getActivity().getApplicationContext().registerReceiver(mMessageReceiver, intentFilter);
+        }
+      });
+
+      task.addOnFailureListener(new OnFailureListener() {
+        @Override
+        public void onFailure(Exception e) {
+          // Failed to start retriever, inspect Exception for more details
+          LOG.v(TAG, "Executing action: addOnFailureListener");
+          //Toast.makeText(cordova.getActivity().getApplicationContext(),"Executing action: addOnFailureListener", Toast.LENGTH_SHORT).show();
+        }
+      });
+
+      PluginResult r = new PluginResult(PluginResult.Status.NO_RESULT);
+      r.setKeepCallback(true);
+      callbackContext.sendPluginResult(r);
+
+      return true;
+
+    }
+    else if ("hash".equals(action)) {
+
+      ArrayList<String> strHashCodes = getAppSignatures();
+
+      if(strHashCodes.size() == 0 || strHashCodes.get(0) == null){
+
+        String err = "Unable to find package to obtain hash code of application";
+        PluginResult result = new PluginResult(PluginResult.Status.ERROR, err);
+        callbackContext.sendPluginResult(result);
+
+      } else {
+
+        String strApplicationHash = strHashCodes.get(0);
+        PluginResult result = new PluginResult(PluginResult.Status.OK, strApplicationHash);
+        callbackContext.sendPluginResult(result);
+
+      }
+    }
+
+    // Returning false results in a "MethodNotFound" error.
+    return false;
+  }
+
+  // Our handler for received Intents. This will be called whenever an Intent
+  // with an action named "custom-event-name" is broadcasted.
+  private BroadcastReceiver mMessageReceiver = new BroadcastReceiver() {
+    @Override
+    public void onReceive(Context context, Intent intent) {
+
+      if (intent.getAction().equals(SmsRetriever.SMS_RETRIEVED_ACTION)) {
+        final Bundle extra = intent.getExtras();
+        if (extra != null && extra.containsKey(SmsRetriever.EXTRA_STATUS)) {
+          Status status = (Status) extra.get(SmsRetriever.EXTRA_STATUS);
+          switch (status.getStatusCode()) {
+            case CommonStatusCodes.SUCCESS:
+              final String message = extra.getString(SmsRetriever.EXTRA_SMS_MESSAGE);
+              //if (!StringUtils.hasContent(message)) return;
+
+              Log.d(TAG, message);
+
+              data = new JSONObject();
+              try {
+                data.put("Message",message);
+              } catch(JSONException e) {}
+
+              //Toast.makeText(cordova.getActivity().getApplicationContext(),"Message: "+ message, Toast.LENGTH_LONG).show();
+              PluginResult result = new PluginResult(PluginResult.Status.OK, data);
+              callbackContext.sendPluginResult(result);
+
+              break;
+            case CommonStatusCodes.TIMEOUT:
+
+              PluginResult resultTimeout = new PluginResult(PluginResult.Status.ERROR, "TIMEOUT");
+              callbackContext.sendPluginResult(resultTimeout);
+              break;
+          }
+        }
+      }
+    };
+  };
+}

package/www/smsRetriever.js

@@ -0,0 +1,19 @@
+var SmsRetrieverLoader = function(require, exports, module) {
+  var exec = require('cordova/exec');
+
+  function SmsRetriever() {}
+
+  SmsRetriever.prototype.startWatching = function(success, failure) {
+    exec(success, failure, 'AndroidSmsRetriever', 'start', []);
+  };
+  
+  SmsRetriever.prototype.getAppHash = function (success, failure) {
+      exec(success, failure, 'AndroidSmsRetriever', 'hash', []);
+  };
+  var smsRetriever = new SmsRetriever();
+  module.exports = smsRetriever;
+};
+
+SmsRetrieverLoader(require, exports, module);
+ 
+cordova.define("cordova/plugin/SmsRetriever", SmsRetrieverLoader);