mirror of
https://github.com/Michatec/Radio.git
synced 2026-11-17 05:26:53 +01:00
feat(remote-control): implement authentication for remote control access and update API documentation
This commit is contained in:
1 parent
e266985b30
commit
04ec33fad5
20 files changed
+318
-43
No files matched your search
@@ -21,6 +21,7 @@ object Keys {
|
||||
const val ACTION_THEME_CHANGED: String = "com.michatec.radio.action.THEME_CHANGED"
|
||||
const val ACTION_START: String = "com.michatec.radio.action.START"
|
||||
const val ACTION_REMOTE_SERVER_ERROR: String = "com.michatec.radio.action.REMOTE_SERVER_ERROR"
|
||||
const val ACTION_REMOTE_AUTH_FAILED: String = "com.michatec.radio.action.REMOTE_AUTH_FAILED"
|
||||
|
||||
// intent extras
|
||||
const val EXTRA_COLLECTION_MODIFICATION_DATE: String = "COLLECTION_MODIFICATION_DATE"
|
||||
@@ -99,6 +100,8 @@ object Keys {
|
||||
const val PREF_CUSTOM_THEME_INDEX: String = "CUSTOM_THEME_INDEX"
|
||||
const val PREF_ARGUMENTS: String = "ARGUMENTS"
|
||||
const val PREF_REMOTE_CONTROL_ENABLED: String = "REMOTE_CONTROL_ENABLED"
|
||||
const val PREF_REMOTE_CONTROL_AUTH_ENABLED: String = "REMOTE_CONTROL_AUTH_ENABLED"
|
||||
const val PREF_REMOTE_CONTROL_SECRET_TOKEN: String = "REMOTE_CONTROL_SECRET_TOKEN"
|
||||
|
||||
// default const values
|
||||
const val DEFAULT_SIZE_OF_METADATA_HISTORY: Int = 25
|
||||
|
||||
@@ -138,17 +138,21 @@ class MainActivity : AppCompatActivity() {
|
||||
|
||||
override fun onStart() {
|
||||
super.onStart()
|
||||
// register remote server error receiver
|
||||
// register remote server receivers
|
||||
val filter = IntentFilter().apply {
|
||||
addAction(Keys.ACTION_REMOTE_SERVER_ERROR)
|
||||
addAction(Keys.ACTION_REMOTE_AUTH_FAILED)
|
||||
}
|
||||
LocalBroadcastManager.getInstance(this).registerReceiver(
|
||||
remoteServerErrorReceiver,
|
||||
IntentFilter(Keys.ACTION_REMOTE_SERVER_ERROR)
|
||||
remoteServerReceiver,
|
||||
filter
|
||||
)
|
||||
}
|
||||
|
||||
override fun onStop() {
|
||||
super.onStop()
|
||||
// unregister remote server error receiver
|
||||
LocalBroadcastManager.getInstance(this).unregisterReceiver(remoteServerErrorReceiver)
|
||||
// unregister remote server receiver
|
||||
LocalBroadcastManager.getInstance(this).unregisterReceiver(remoteServerReceiver)
|
||||
}
|
||||
|
||||
/* Hides the loading/splash overlay */
|
||||
@@ -242,21 +246,28 @@ class MainActivity : AppCompatActivity() {
|
||||
|
||||
|
||||
/*
|
||||
* Receiver for remote server error
|
||||
* Receiver for remote server events
|
||||
*/
|
||||
private val remoteServerErrorReceiver: BroadcastReceiver = object : BroadcastReceiver() {
|
||||
private val remoteServerReceiver: BroadcastReceiver = object : BroadcastReceiver() {
|
||||
override fun onReceive(context: Context, intent: Intent) {
|
||||
if (intent.action == Keys.ACTION_REMOTE_SERVER_ERROR) {
|
||||
val snackbar = Snackbar.make(
|
||||
binding.mainRoot,
|
||||
R.string.error_webserver,
|
||||
Snackbar.LENGTH_LONG
|
||||
)
|
||||
this@MainActivity.findViewById<View>(R.id.bottom_sheet)?.let {
|
||||
snackbar.anchorView = it
|
||||
val message = when (intent.action) {
|
||||
Keys.ACTION_REMOTE_SERVER_ERROR -> getString(R.string.error_webserver)
|
||||
Keys.ACTION_REMOTE_AUTH_FAILED -> {
|
||||
val ip = intent.getStringExtra("REMOTE_IP") ?: "unknown"
|
||||
getString(R.string.snackbar_remote_auth_failed, ip)
|
||||
}
|
||||
snackbar.show()
|
||||
else -> return
|
||||
}
|
||||
|
||||
val snackbar = Snackbar.make(
|
||||
binding.mainRoot,
|
||||
message,
|
||||
Snackbar.LENGTH_LONG
|
||||
)
|
||||
this@MainActivity.findViewById<View>(R.id.bottom_sheet)?.let {
|
||||
snackbar.anchorView = it
|
||||
}
|
||||
snackbar.show()
|
||||
}
|
||||
}
|
||||
/*
|
||||
|
||||
@@ -92,6 +92,14 @@ class PlayerService : MediaLibraryService(), SharedPreferences.OnSharedPreferenc
|
||||
val intent = Intent(Keys.ACTION_REMOTE_SERVER_ERROR)
|
||||
LocalBroadcastManager.getInstance(this@PlayerService).sendBroadcast(intent)
|
||||
}
|
||||
|
||||
onAuthFailed = { ip ->
|
||||
Log.w(TAG, "RemoteControlServer: Multiple failed auth attempts from $ip")
|
||||
val intent = Intent(Keys.ACTION_REMOTE_AUTH_FAILED).apply {
|
||||
putExtra("REMOTE_IP", ip)
|
||||
}
|
||||
LocalBroadcastManager.getInstance(this@PlayerService).sendBroadcast(intent)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -206,8 +206,36 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
|
||||
getString(R.string.pref_remote_control_summary)
|
||||
}
|
||||
preferenceRemoteControl.setDefaultValue(PreferencesHelper.loadRemoteControlEnabled())
|
||||
|
||||
// set up "Remote Control Auth" preference
|
||||
val preferenceRemoteControlAuth = MarqueeSwitchPreference(context)
|
||||
preferenceRemoteControlAuth.title = getString(R.string.pref_remote_control_auth_title)
|
||||
preferenceRemoteControlAuth.setIcon(R.drawable.ic_security_24dp)
|
||||
preferenceRemoteControlAuth.key = Keys.PREF_REMOTE_CONTROL_AUTH_ENABLED
|
||||
preferenceRemoteControlAuth.summary = getString(R.string.pref_remote_control_auth_summary)
|
||||
preferenceRemoteControlAuth.setDefaultValue(PreferencesHelper.loadRemoteControlAuthEnabled())
|
||||
preferenceRemoteControlAuth.isVisible = PreferencesHelper.loadRemoteControlEnabled()
|
||||
|
||||
// set up "Remote Control Secret" preference
|
||||
val preferenceRemoteControlSecret = Preference(context)
|
||||
preferenceRemoteControlSecret.title = getString(R.string.pref_remote_control_secret_title)
|
||||
preferenceRemoteControlSecret.setIcon(R.drawable.ic_info_24dp)
|
||||
preferenceRemoteControlSecret.key = Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN
|
||||
preferenceRemoteControlSecret.summary = PreferencesHelper.loadRemoteControlSecretToken()
|
||||
preferenceRemoteControlSecret.isVisible = PreferencesHelper.loadRemoteControlEnabled() && PreferencesHelper.loadRemoteControlAuthEnabled()
|
||||
preferenceRemoteControlSecret.setOnPreferenceClickListener {
|
||||
// regenerate secret
|
||||
val newSecret = PreferencesHelper.generateSecretToken()
|
||||
PreferencesHelper.saveRemoteControlSecretToken(newSecret)
|
||||
preferenceRemoteControlSecret.summary = newSecret
|
||||
Snackbar.make(requireView(), R.string.toastmessage_secret_regenerated, Snackbar.LENGTH_LONG).show()
|
||||
return@setOnPreferenceClickListener true
|
||||
}
|
||||
|
||||
preferenceRemoteControl.setOnPreferenceChangeListener { _, newValue ->
|
||||
val enabled = newValue as Boolean
|
||||
preferenceRemoteControlAuth.isVisible = enabled
|
||||
preferenceRemoteControlSecret.isVisible = enabled && preferenceRemoteControlAuth.isChecked
|
||||
if (enabled) {
|
||||
val intent = Intent(activity, PlayerService::class.java).apply {
|
||||
action = Keys.ACTION_START
|
||||
@@ -217,6 +245,11 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
|
||||
return@setOnPreferenceChangeListener true
|
||||
}
|
||||
|
||||
preferenceRemoteControlAuth.setOnPreferenceChangeListener { _, newValue ->
|
||||
preferenceRemoteControlSecret.isVisible = newValue as Boolean
|
||||
return@setOnPreferenceChangeListener true
|
||||
}
|
||||
|
||||
// set up "Arguments" preference
|
||||
val preferenceArguments = EditTextPreference(context)
|
||||
preferenceArguments.title = getString(R.string.pref_arguments_title)
|
||||
@@ -499,6 +532,9 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
|
||||
val preferenceCategoryLinks = PreferenceCategory(context)
|
||||
preferenceCategoryLinks.title = getString(R.string.pref_links_title)
|
||||
|
||||
val preferenceCategoryRemoteControl = PreferenceCategory(context)
|
||||
preferenceCategoryRemoteControl.title = getString(R.string.pref_remote_control_title)
|
||||
|
||||
|
||||
// setup preference screen
|
||||
screen.addPreference(preferenceAppVersion)
|
||||
@@ -509,12 +545,16 @@ class SettingsFragment : PreferenceFragmentCompat(), YesNoDialog.YesNoDialogList
|
||||
preferenceCategoryGeneral.addPreference(preferenceLanguageSelection)
|
||||
preferenceCategoryGeneral.addPreference(preferenceCustomThemeEnabled)
|
||||
preferenceCategoryGeneral.addPreference(preferenceCustomTheme)
|
||||
preferenceCategoryGeneral.addPreference(preferenceRemoteControl)
|
||||
|
||||
if (!isAndroidTV && isPermissionGranted(activity as Context, android.Manifest.permission.POST_NOTIFICATIONS)) {
|
||||
preferenceCategoryGeneral.addPreference(preferenceTestNotification)
|
||||
}
|
||||
|
||||
screen.addPreference(preferenceCategoryRemoteControl)
|
||||
preferenceCategoryRemoteControl.addPreference(preferenceRemoteControl)
|
||||
preferenceCategoryRemoteControl.addPreference(preferenceRemoteControlAuth)
|
||||
preferenceCategoryRemoteControl.addPreference(preferenceRemoteControlSecret)
|
||||
|
||||
screen.addPreference(preferenceCategoryAudioEffects)
|
||||
preferenceCategoryAudioEffects.addPreference(preferenceBassBoost)
|
||||
preferenceCategoryAudioEffects.addPreference(preferenceReverb)
|
||||
|
||||
@@ -418,6 +418,33 @@ object PreferencesHelper {
|
||||
}
|
||||
}
|
||||
|
||||
/* Loads whether remote control authentication is enabled */
|
||||
fun loadRemoteControlAuthEnabled(): Boolean {
|
||||
return sharedPreferences.getBoolean(Keys.PREF_REMOTE_CONTROL_AUTH_ENABLED, false)
|
||||
}
|
||||
|
||||
/* Loads remote control secret token */
|
||||
fun loadRemoteControlSecretToken(): String {
|
||||
var token = sharedPreferences.getString(Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN, "") ?: ""
|
||||
if (token.isEmpty()) {
|
||||
token = generateSecretToken()
|
||||
saveRemoteControlSecretToken(token)
|
||||
}
|
||||
return token
|
||||
}
|
||||
|
||||
/* Saves remote control secret token */
|
||||
fun saveRemoteControlSecretToken(token: String) {
|
||||
sharedPreferences.edit {
|
||||
putString(Keys.PREF_REMOTE_CONTROL_SECRET_TOKEN, token)
|
||||
}
|
||||
}
|
||||
|
||||
/* Generates a random 6-digit secret token */
|
||||
fun generateSecretToken(): String {
|
||||
return (100000..999999).random().toString()
|
||||
}
|
||||
|
||||
/* SHA-256 helper */
|
||||
private fun String.sha256(): String {
|
||||
return try {
|
||||
|
||||
@@ -14,10 +14,12 @@ import io.ktor.server.application.*
|
||||
import io.ktor.server.engine.*
|
||||
import io.ktor.server.netty.*
|
||||
import io.ktor.server.plugins.contentnegotiation.*
|
||||
import io.ktor.server.request.*
|
||||
import io.ktor.server.response.*
|
||||
import io.ktor.server.routing.*
|
||||
import io.ktor.server.websocket.*
|
||||
import io.ktor.websocket.*
|
||||
import java.util.concurrent.ConcurrentHashMap
|
||||
import kotlinx.coroutines.*
|
||||
import kotlinx.coroutines.flow.MutableSharedFlow
|
||||
import kotlinx.coroutines.flow.asSharedFlow
|
||||
@@ -35,6 +37,7 @@ class RemoteControlServer(private val context: Context) {
|
||||
private var serverScope = CoroutineScope(Dispatchers.IO + SupervisorJob())
|
||||
private val lifecycleMutex = Mutex()
|
||||
private val gson = Gson()
|
||||
private val failedAttemptsMap = ConcurrentHashMap<String, Int>()
|
||||
private val _statusUpdates = MutableSharedFlow<Map<String, Any>>(extraBufferCapacity = 1)
|
||||
private val statusUpdates = _statusUpdates.asSharedFlow()
|
||||
|
||||
@@ -130,6 +133,7 @@ class RemoteControlServer(private val context: Context) {
|
||||
var onNext: (() -> Unit)? = null
|
||||
var onPrev: (() -> Unit)? = null
|
||||
var onError: ((String) -> Unit)? = null
|
||||
var onAuthFailed: ((String) -> Unit)? = null
|
||||
|
||||
fun setPlayer(player: Player?) {
|
||||
this.player?.removeListener(playerListener)
|
||||
@@ -170,6 +174,42 @@ class RemoteControlServer(private val context: Context) {
|
||||
maxFrameSize = Long.MAX_VALUE
|
||||
masking = false
|
||||
}
|
||||
|
||||
intercept(ApplicationCallPipeline.Plugins) {
|
||||
val authEnabled = PreferencesHelper.loadRemoteControlAuthEnabled()
|
||||
if (authEnabled) {
|
||||
val secret = PreferencesHelper.loadRemoteControlSecretToken()
|
||||
val requestPath = call.request.path()
|
||||
val isStatic = requestPath == "/" ||
|
||||
requestPath == "/style.css" ||
|
||||
requestPath == "/script.js" ||
|
||||
requestPath == "/favicon.png" ||
|
||||
requestPath == "/translations.json"
|
||||
|
||||
if (!isStatic) {
|
||||
val providedKey = call.request.headers["X-Remote-Key"]
|
||||
?: call.request.queryParameters["token"]
|
||||
val remoteHost = call.request.local.remoteHost
|
||||
|
||||
if (providedKey != secret) {
|
||||
val attempts = (failedAttemptsMap[remoteHost] ?: 0) + 1
|
||||
failedAttemptsMap[remoteHost] = attempts
|
||||
|
||||
if (attempts >= 10) {
|
||||
withContext(Dispatchers.Main) {
|
||||
onAuthFailed?.invoke(remoteHost)
|
||||
}
|
||||
}
|
||||
delay(2000.milliseconds)
|
||||
call.respond(HttpStatusCode.Unauthorized, mapOf("error" to "Unauthorized"))
|
||||
finish()
|
||||
} else {
|
||||
failedAttemptsMap.remove(remoteHost)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
routing {
|
||||
get("/") {
|
||||
val content = safeReadAsset("web/index.html")
|
||||
@@ -248,7 +288,7 @@ class RemoteControlServer(private val context: Context) {
|
||||
}
|
||||
try {
|
||||
for (frame in incoming) {
|
||||
// Just consume to keep connection alive
|
||||
frame.takeIf { it is Frame.Text } ?: continue
|
||||
}
|
||||
} catch (_: Exception) {
|
||||
Log.d("RemoteControlServer", "WebSocket client disconnected")
|
||||
|
||||
Reference in new issue
Block a user