mirror of
https://github.com/Michatec/Radio.git
synced 2026-11-16 21:36: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
@@ -50,6 +50,15 @@
|
||||
<div class="api-content">
|
||||
<p>The Radio app provides a REST API to control playback and query information.</p>
|
||||
|
||||
<div class="auth-box glass">
|
||||
<h3>Authentication</h3>
|
||||
<p>If authentication is enabled in the app settings, you must include the pairing code in your requests:</p>
|
||||
<ul>
|
||||
<li><strong>HTTP Headers:</strong> Add <code>X-Remote-Key: YOUR_CODE</code></li>
|
||||
<li><strong>Query Parameter:</strong> Add <code>?token=YOUR_CODE</code> (fallback for images and WebSockets)</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<h2>API Reference</h2>
|
||||
|
||||
<div class="endpoint">
|
||||
@@ -72,7 +81,8 @@
|
||||
<p>WebSocket endpoint for real-time status updates. Pushes status objects whenever state or metadata changes.</p>
|
||||
<div class="code-example">Example Usage (JavaScript):</div>
|
||||
<pre>
|
||||
const socket = new WebSocket('ws://' + location.host + '/api/updates');
|
||||
const token = '123456'; // From app settings
|
||||
const socket = new WebSocket('ws://' + location.host + '/api/updates?token=' + token);
|
||||
socket.onmessage = (event) => {
|
||||
const status = JSON.parse(event.data);
|
||||
console.log('Update received:', status);
|
||||
|
||||
@@ -5,6 +5,7 @@ let isUpdating = false;
|
||||
let stationsLoaded = false;
|
||||
let lastStatusData = null;
|
||||
let updateSocket = null;
|
||||
let authToken = localStorage.getItem('radio-remote-token') || '';
|
||||
const STATE_IDLE = 1;
|
||||
const STATE_BUFFERING = 2;
|
||||
const STATE_READY = 3;
|
||||
@@ -79,9 +80,14 @@ function updateStatusUI(data) {
|
||||
if (currentStarEl) currentStarEl.classList.toggle('hidden', !data.starred);
|
||||
if (currentMetadataEl) currentMetadataEl.innerText = data.metadata || "";
|
||||
if (currentImageEl) {
|
||||
const imageUrl = station.hasImage ? '/api/image/' + station.uuid : 'favicon.png';
|
||||
const cacheBuster = station.lastModified ? '?t=' + station.lastModified : '';
|
||||
currentImageEl.src = imageUrl + cacheBuster;
|
||||
let imageUrl = station.hasImage ? '/api/image/' + station.uuid : 'favicon.png';
|
||||
if (station.hasImage && authToken) {
|
||||
imageUrl += '?token=' + encodeURIComponent(authToken);
|
||||
imageUrl += station.lastModified ? '&t=' + station.lastModified : '';
|
||||
} else if (station.hasImage) {
|
||||
imageUrl += station.lastModified ? '?t=' + station.lastModified : '';
|
||||
}
|
||||
currentImageEl.src = imageUrl;
|
||||
}
|
||||
} else {
|
||||
if (stationsLoaded) {
|
||||
@@ -112,10 +118,40 @@ function updateStatusUI(data) {
|
||||
}
|
||||
}
|
||||
|
||||
async function apiFetch(url, options = {}) {
|
||||
if (authToken) {
|
||||
options.headers = options.headers || {};
|
||||
options.headers['X-Remote-Key'] = authToken;
|
||||
}
|
||||
|
||||
let response = await fetch(url, options);
|
||||
|
||||
if (response.status === 401) {
|
||||
const code = prompt(t('prompt_pairing_code') || "Please enter the pairing code:");
|
||||
if (code) {
|
||||
authToken = code;
|
||||
localStorage.setItem('radio-remote-token', authToken);
|
||||
options.headers = options.headers || {};
|
||||
options.headers['X-Remote-Key'] = authToken;
|
||||
response = await fetch(url, options);
|
||||
if (response.ok) {
|
||||
window.location.reload();
|
||||
} else if (response.status === 401) {
|
||||
authToken = '';
|
||||
localStorage.removeItem('radio-remote-token');
|
||||
}
|
||||
} else {
|
||||
authToken = '';
|
||||
localStorage.removeItem('radio-remote-token');
|
||||
}
|
||||
}
|
||||
return response;
|
||||
}
|
||||
|
||||
async function updateStatus() {
|
||||
if (isUpdating) return;
|
||||
try {
|
||||
const response = await fetch('/api/status');
|
||||
const response = await apiFetch('/api/status');
|
||||
const data = await response.json();
|
||||
if (!response.ok) {
|
||||
updateStatusUI({ error: data.error || "Service Unavailable" });
|
||||
@@ -134,7 +170,10 @@ function initUpdateSocket() {
|
||||
}
|
||||
|
||||
const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
|
||||
const wsUrl = protocol + '//' + window.location.host + '/api/updates';
|
||||
let wsUrl = protocol + '//' + window.location.host + '/api/updates';
|
||||
if (authToken) {
|
||||
wsUrl += '?token=' + encodeURIComponent(authToken);
|
||||
}
|
||||
|
||||
updateSocket = new WebSocket(wsUrl);
|
||||
|
||||
@@ -165,7 +204,7 @@ function initUpdateSocket() {
|
||||
|
||||
async function loadStations() {
|
||||
try {
|
||||
const response = await fetch('/api/stations');
|
||||
const response = await apiFetch('/api/stations');
|
||||
if (!response.ok) {
|
||||
document.getElementById('stationList').innerText = t('status_error');
|
||||
stationsLoaded = true;
|
||||
@@ -202,8 +241,14 @@ function renderStationList() {
|
||||
const img = document.createElement('img');
|
||||
img.className = 'station-img';
|
||||
if (station.hasImage) {
|
||||
const cacheBuster = station.lastModified ? '?t=' + station.lastModified : '';
|
||||
img.src = '/api/image/' + station.uuid + cacheBuster;
|
||||
let imageUrl = '/api/image/' + station.uuid;
|
||||
if (authToken) {
|
||||
imageUrl += '?token=' + encodeURIComponent(authToken);
|
||||
imageUrl += station.lastModified ? '&t=' + station.lastModified : '';
|
||||
} else {
|
||||
imageUrl += station.lastModified ? '?t=' + station.lastModified : '';
|
||||
}
|
||||
img.src = imageUrl;
|
||||
} else {
|
||||
img.src = 'favicon.png';
|
||||
}
|
||||
@@ -252,7 +297,7 @@ async function playStation(uuid) {
|
||||
}
|
||||
|
||||
try {
|
||||
await fetch('/api/play/' + uuid, { method: 'POST' });
|
||||
await apiFetch('/api/play/' + uuid, { method: 'POST' });
|
||||
} catch (e) { console.error(e); }
|
||||
}
|
||||
|
||||
@@ -265,18 +310,18 @@ document.getElementById('playPauseBtn').onclick = async () => {
|
||||
|
||||
try {
|
||||
if (isPlaying) {
|
||||
await fetch('/api/pause', { method: 'POST' });
|
||||
await apiFetch('/api/pause', { method: 'POST' });
|
||||
} else {
|
||||
await fetch('/api/resume', { method: 'POST' });
|
||||
await apiFetch('/api/resume', { method: 'POST' });
|
||||
}
|
||||
} catch (e) { console.error(e); }
|
||||
};
|
||||
|
||||
document.getElementById('prevBtn').onclick = () => {
|
||||
fetch('/api/prev', { method: 'POST' });
|
||||
apiFetch('/api/prev', { method: 'POST' });
|
||||
};
|
||||
document.getElementById('nextBtn').onclick = () => {
|
||||
fetch('/api/next', { method: 'POST' });
|
||||
apiFetch('/api/next', { method: 'POST' });
|
||||
};
|
||||
|
||||
function applyThemeUI(theme) {
|
||||
|
||||
@@ -261,6 +261,17 @@ body.light-theme .station-item {
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.auth-box {
|
||||
margin: 20px 0;
|
||||
padding: 20px;
|
||||
border: 1px solid var(--accent-color);
|
||||
box-shadow: 0 0 10px rgba(0, 132, 255, 0.2);
|
||||
}
|
||||
|
||||
.auth-box h3 { margin-top: 0; color: var(--accent-color); }
|
||||
.auth-box ul { padding-left: 20px; margin-bottom: 0; }
|
||||
.auth-box li { margin-bottom: 8px; }
|
||||
|
||||
body.light-theme .api-content pre {
|
||||
background: #f8f9fa;
|
||||
color: #0066cc;
|
||||
|
||||
@@ -22,7 +22,8 @@
|
||||
"theme_dark": "Dark",
|
||||
"theme_follow_browser": "Follow Browser",
|
||||
"lang_auto_browser": "Auto (Browser)",
|
||||
"api_docs": "API Documentation"
|
||||
"api_docs": "API Documentation",
|
||||
"prompt_pairing_code": "Please enter the pairing code:"
|
||||
},
|
||||
"de": {
|
||||
"title": "Radio Fernbedienung",
|
||||
@@ -47,7 +48,8 @@
|
||||
"theme_dark": "Dunkel",
|
||||
"theme_follow_browser": "Browser folgen",
|
||||
"lang_auto_browser": "Auto (Browser)",
|
||||
"api_docs": "API Dokumentation"
|
||||
"api_docs": "API Dokumentation",
|
||||
"prompt_pairing_code": "Bitte geben Sie den Pairing-Code ein:"
|
||||
},
|
||||
"fr": {
|
||||
"title": "Télécommande Radio",
|
||||
@@ -72,7 +74,8 @@
|
||||
"theme_dark": "Sombre",
|
||||
"theme_follow_browser": "Suivre le Navigateur",
|
||||
"lang_auto_browser": "Auto (Navigateur)",
|
||||
"api_docs": "Documentation API"
|
||||
"api_docs": "Documentation API",
|
||||
"prompt_pairing_code": "Veuillez saisir le code de couplage :"
|
||||
},
|
||||
"ru": {
|
||||
"title": "Пульт Радио",
|
||||
@@ -97,7 +100,8 @@
|
||||
"theme_dark": "Темная",
|
||||
"theme_follow_browser": "Как в браузере",
|
||||
"lang_auto_browser": "Авто (Браузер)",
|
||||
"api_docs": "Документация API"
|
||||
"api_docs": "Документация API",
|
||||
"prompt_pairing_code": "Введите код сопряжения:"
|
||||
},
|
||||
"nl": {
|
||||
"title": "Radio Afstandsbediening",
|
||||
@@ -122,7 +126,8 @@
|
||||
"theme_dark": "Donker",
|
||||
"theme_follow_browser": "Browser volgen",
|
||||
"lang_auto_browser": "Auto (Browser)",
|
||||
"api_docs": "API Documentatie"
|
||||
"api_docs": "API Documentatie",
|
||||
"prompt_pairing_code": "Voer de koppelingscode in:"
|
||||
},
|
||||
"pl": {
|
||||
"title": "Pilot Radio",
|
||||
@@ -147,7 +152,8 @@
|
||||
"theme_dark": "Ciemny",
|
||||
"theme_follow_browser": "Podążaj za przeglądarką",
|
||||
"lang_auto_browser": "Auto (Przeglądarkα)",
|
||||
"api_docs": "Dokumentacja API"
|
||||
"api_docs": "Dokumentacja API",
|
||||
"prompt_pairing_code": "Wprowadź kod parowania:"
|
||||
},
|
||||
"ja": {
|
||||
"title": "ラジオ リモコン",
|
||||
@@ -172,7 +178,8 @@
|
||||
"theme_dark": "ダーク",
|
||||
"theme_follow_browser": "ブラウザに従う",
|
||||
"lang_auto_browser": "自動 (ブラウザ)",
|
||||
"api_docs": "API ドキュメント"
|
||||
"api_docs": "API ドキュメント",
|
||||
"prompt_pairing_code": "ペアリングコードを入力してください:"
|
||||
},
|
||||
"uk": {
|
||||
"title": "Пульт Радіо",
|
||||
@@ -197,7 +204,8 @@
|
||||
"theme_dark": "Темна",
|
||||
"theme_follow_browser": "Як у браузері",
|
||||
"lang_auto_browser": "Авто (Браузер)",
|
||||
"api_docs": "Документація API"
|
||||
"api_docs": "Документація API",
|
||||
"prompt_pairing_code": "Введіть код сполучення:"
|
||||
},
|
||||
"el": {
|
||||
"title": "Ραδιοφωνικό Χειριστήριο",
|
||||
@@ -222,7 +230,8 @@
|
||||
"theme_dark": "Σκοτεινό",
|
||||
"theme_follow_browser": "Ακολουθήστε το πρόγραμμα περιήγησης",
|
||||
"lang_auto_browser": "Αυτόματο (Browser)",
|
||||
"api_docs": "Τεκμηρίωση API"
|
||||
"api_docs": "Τεκμηρίωση API",
|
||||
"prompt_pairing_code": "Εισαγάγετε τον κωδικό σύζευξης:"
|
||||
},
|
||||
"da": {
|
||||
"title": "Radio Fjernbetjening",
|
||||
@@ -247,6 +256,7 @@
|
||||
"theme_dark": "Mørkt",
|
||||
"theme_follow_browser": "Følg browser",
|
||||
"lang_auto_browser": "Auto (Browser)",
|
||||
"api_docs": "API Dokumentation"
|
||||
"api_docs": "API Dokumentation",
|
||||
"prompt_pairing_code": "Indtast parringskode:"
|
||||
}
|
||||
}
|
||||
@@ -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")
|
||||
|
||||
@@ -190,6 +190,13 @@
|
||||
<string name="pref_remote_control_title">Fjernbetjening</string>
|
||||
<string name="pref_remote_control_summary">Betjen radioen fra din webbrowser</string>
|
||||
<string name="pref_remote_control_url">Betjen radioen fra http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Sikkerhedsadvarsel: Flere mislykkede fjernloginforsøg detekteret fra %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Fjernbetjening godkendelse</string>
|
||||
<string name="pref_remote_control_auth_summary">Kræv en parringskode for fjernadgang.</string>
|
||||
<string name="pref_remote_control_secret_title">Parringskode</string>
|
||||
<string name="pref_remote_control_secret_summary">Brug denne kode til webgrænsefladen og API\'en.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Gendan parringskode</string>
|
||||
<string name="toastmessage_secret_regenerated">Parringskode gendannet.</string>
|
||||
<string name="error_webserver">Web fjernbetjeningsserver crashet/stoppede.</string>
|
||||
<string name="search_hint">Søg stationer…</string>
|
||||
<string name="search_filter_favorites">Kun favoritter</string>
|
||||
|
||||
@@ -193,6 +193,13 @@
|
||||
<string name="pref_remote_control_title">Fernbedienung</string>
|
||||
<string name="pref_remote_control_summary">Steuere das Radio über deinen Webbrowser</string>
|
||||
<string name="pref_remote_control_url">Steuere das Radio über http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Sicherheitswarnung: Mehrere fehlgeschlagene Fernanmeldeversuche von %1$s erkannt!</string>
|
||||
<string name="pref_remote_control_auth_title">Fernbedienungs-Authentifizierung</string>
|
||||
<string name="pref_remote_control_auth_summary">Erfordert einen Pairing-Code für den Fernzugriff.</string>
|
||||
<string name="pref_remote_control_secret_title">Pairing-Code</string>
|
||||
<string name="pref_remote_control_secret_summary">Verwenden Sie diesen Code für das Web-Interface und die API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Pairing-Code neu generieren</string>
|
||||
<string name="toastmessage_secret_regenerated">Pairing-Code neu generiert.</string>
|
||||
<string name="error_webserver">Web-Fernbedienungsserver abgestürzt/gestoppt.</string>
|
||||
<string name="search_hint">Sender suchen…</string>
|
||||
<string name="search_filter_favorites">Nur Favoriten</string>
|
||||
|
||||
@@ -192,6 +192,13 @@
|
||||
<string name="pref_remote_control_title">Τηλεχειριστήριο</string>
|
||||
<string name="pref_remote_control_summary">Ελέγξτε το ραδιόφωνο από το πρόγραμμα περιήγησής σας</string>
|
||||
<string name="pref_remote_control_url">Ελέγξτε το ραδιόφωνο από το http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Προειδοποίηση ασφαλείας: Ανιχνεύθηκαν πολλαπλές αποτυχημένες προσπάθειες απομακρυσμένης σύνδεσης από %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Έλεγχος ταυτότητας τηλεχειριστηρίου</string>
|
||||
<string name="pref_remote_control_auth_summary">Απαιτείται κωδικός σύζευξης για απομακρυσμένη πρόσβαση.</string>
|
||||
<string name="pref_remote_control_secret_title">Κωδικός σύζευξης</string>
|
||||
<string name="pref_remote_control_secret_summary">Χρησιμοποιήστε αυτόν τον κωδικό για τη διεπαφή ιστού και το API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Αναγέννηση κωδικού σύζευξης</string>
|
||||
<string name="toastmessage_secret_regenerated">Ο κωδικός σύζευξης αναγεννήθηκε.</string>
|
||||
<string name="error_webserver">Ο διακομιστής τηλεχειριστηρίου ιστού κατέρρευσε/σταμάτησε.</string>
|
||||
|
||||
<string name="descr_player_search_button">Αναζήτηση σταθμών</string>
|
||||
|
||||
@@ -190,6 +190,13 @@
|
||||
<string name="pref_remote_control_title">Télécommande</string>
|
||||
<string name="pref_remote_control_summary">Contrôlez la radio depuis votre navigateur web</string>
|
||||
<string name="pref_remote_control_url">Contrôlez la radio depuis http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Avertissement de sécurité : plusieurs tentatives de connexion à distance échouées détectées depuis %1$s !</string>
|
||||
<string name="pref_remote_control_auth_title">Authentification de la télécommande</string>
|
||||
<string name="pref_remote_control_auth_summary">Nécessite un code de couplage pour l\'accès à distance.</string>
|
||||
<string name="pref_remote_control_secret_title">Code de couplage</string>
|
||||
<string name="pref_remote_control_secret_summary">Utilisez ce code pour l\'interface web et l\'API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Régénérer le code de couplage</string>
|
||||
<string name="toastmessage_secret_regenerated">Code de couplage régénéré.</string>
|
||||
<string name="error_webserver">Serveur de télécommande Web planté/arrêté.</string>
|
||||
|
||||
<string name="descr_player_search_button">Rechercher des stations</string>
|
||||
|
||||
@@ -191,6 +191,13 @@
|
||||
<string name="pref_remote_control_title">リモコン</string>
|
||||
<string name="pref_remote_control_summary">ウェブブラウザからラジオを操作</string>
|
||||
<string name="pref_remote_control_url">http://%1$s:8080 からラジオを操作</string>
|
||||
<string name="snackbar_remote_auth_failed">セキュリティ警告:%1$s からの複数のリモートログイン試行の失敗が検出されました!</string>
|
||||
<string name="pref_remote_control_auth_title">リモートコントロール認証</string>
|
||||
<string name="pref_remote_control_auth_summary">リモートアクセスのためにペアリングコードを要求します。</string>
|
||||
<string name="pref_remote_control_secret_title">ペアリングコード</string>
|
||||
<string name="pref_remote_control_secret_summary">WebインターフェースとAPIにはこのコードを使用してください。</string>
|
||||
<string name="pref_remote_control_secret_regenerate">ペアリングコードを再生成</string>
|
||||
<string name="toastmessage_secret_regenerated">ペアリングコードが再生成されました。</string>
|
||||
<string name="error_webserver">Webリモートサーバーがクラッシュ/停止しました。</string>
|
||||
<string name="search_hint">局を検索…</string>
|
||||
<string name="search_filter_favorites">お気に入りのみ</string>
|
||||
|
||||
@@ -192,8 +192,15 @@
|
||||
<string name="pref_remote_control_title">Afstandsbediening</string>
|
||||
<string name="pref_remote_control_summary">Bedien de radio vanuit je webbrowser</string>
|
||||
<string name="pref_remote_control_url">Bedien de radio via http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Veiligheidswaarschuwing: Meerdere mislukte inlogpogingen op afstand gedetecteerd van %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Afstandsbediening Authenticatie</string>
|
||||
<string name="pref_remote_control_auth_summary">Vereist een koppelingscode voor toegang op afstand.</string>
|
||||
<string name="pref_remote_control_secret_title">Koppelingscode</string>
|
||||
<string name="pref_remote_control_secret_summary">Gebruik deze code voor de webinterface en API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Koppelingscode opnieuw genereren</string>
|
||||
<string name="toastmessage_secret_regenerated">Koppelingscode opnieuw gegenereerd.</string>
|
||||
<string name="error_webserver">De webserver voor de afstandsbediening is gecrasht of gestopt.</string>
|
||||
<string name="search_hint">Zenders zoeken…</string>
|
||||
<string name="search_hint">Zenders zoeken�</string>
|
||||
<string name="search_filter_favorites">Alleen favorieten</string>
|
||||
<string name="search_no_results">Geen zenders gevonden.</string>
|
||||
<string name="descr_player_search_button">Zenders zoeken</string>
|
||||
|
||||
@@ -191,6 +191,13 @@
|
||||
<string name="pref_remote_control_title">Pilot</string>
|
||||
<string name="pref_remote_control_summary">Steruj radiem z przeglądarki internetowej</string>
|
||||
<string name="pref_remote_control_url">Steruj radiem przez http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Ostrzeżenie o bezpieczeństwie: wykryto wiele nieudanych prób zdalnego logowania z %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Uwierzytelnianie zdalnego sterowania</string>
|
||||
<string name="pref_remote_control_auth_summary">Wymagaj kodu parowania dla zdalnego dostępu.</string>
|
||||
<string name="pref_remote_control_secret_title">Kod parowania</string>
|
||||
<string name="pref_remote_control_secret_summary">Użyj tego kodu dla interfejsu WWW i API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Wygeneruj ponownie kod parowania</string>
|
||||
<string name="toastmessage_secret_regenerated">Kod parowania został wygenerowany ponownie.</string>
|
||||
<string name="error_webserver">Serwer zdalnego sterowania uległ awarii/zatrzymaniu.</string>
|
||||
<string name="search_hint">Szukaj stacji…</string>
|
||||
<string name="search_filter_favorites">Tylko ulubione</string>
|
||||
|
||||
@@ -192,6 +192,13 @@
|
||||
<string name="pref_remote_control_title">Удалённое управление</string>
|
||||
<string name="pref_remote_control_summary">Управляйте радио из вашего веб-браузера</string>
|
||||
<string name="pref_remote_control_url">Управляйте радио через http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Предупреждение системы безопасности: обнаружено несколько неудачных попыток удаленного входа с %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Аутентификация удаленного управления</string>
|
||||
<string name="pref_remote_control_auth_summary">Требовать код сопряжения для удаленного доступа.</string>
|
||||
<string name="pref_remote_control_secret_title">Код сопряжения</string>
|
||||
<string name="pref_remote_control_secret_summary">Используйте этот код для веб-интерфейса и API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Перегенерировать код сопряжения</string>
|
||||
<string name="toastmessage_secret_regenerated">Код сопряжения перегенерирован.</string>
|
||||
<string name="error_webserver">Веб-сервер удалённого управления упал/остановлен.</string>
|
||||
<string name="search_hint">Поиск станций…</string>
|
||||
<string name="search_filter_favorites">Только избранное</string>
|
||||
|
||||
@@ -192,6 +192,13 @@
|
||||
<string name="pref_remote_control_title">Дистанційне керування</string>
|
||||
<string name="pref_remote_control_summary">Керуйте радіо з вашого веб-браузера</string>
|
||||
<string name="pref_remote_control_url">Керуйте радіо через http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Попередження про безпеку: виявлено кілька невдалих спроб віддаленого входу з %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Автентифікація віддаленого керування</string>
|
||||
<string name="pref_remote_control_auth_summary">Вимагати код сполучення для віддаленого достуπου.</string>
|
||||
<string name="pref_remote_control_secret_title">Код сполучення</string>
|
||||
<string name="pref_remote_control_secret_summary">Використовуйте цей код для веб-інтерфейсу та API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Перегенерувати код сполучення</string>
|
||||
<string name="toastmessage_secret_regenerated">Код сполучення перегенеровано.</string>
|
||||
<string name="error_webserver">Веб-сервер дистанційного керування аварійно зупинився/зупинено.</string>
|
||||
<string name="search_hint">Пошук станцій…</string>
|
||||
<string name="search_filter_favorites">Тільки улюблені</string>
|
||||
|
||||
@@ -228,6 +228,13 @@
|
||||
<string name="pref_remote_control_title">Remote Control</string>
|
||||
<string name="pref_remote_control_summary">Control radio from your web browser</string>
|
||||
<string name="pref_remote_control_url">Control radio from http://%1$s:8080</string>
|
||||
<string name="snackbar_remote_auth_failed">Security Warning: Multiple failed remote login attempts detected from %1$s!</string>
|
||||
<string name="pref_remote_control_auth_title">Remote Control Authentication</string>
|
||||
<string name="pref_remote_control_auth_summary">Require a pairing code for remote access.</string>
|
||||
<string name="pref_remote_control_secret_title">Pairing Code</string>
|
||||
<string name="pref_remote_control_secret_summary">Use this code for the web interface and API.</string>
|
||||
<string name="pref_remote_control_secret_regenerate">Regenerate Pairing Code</string>
|
||||
<string name="toastmessage_secret_regenerated">Pairing code regenerated.</string>
|
||||
<string name="error_webserver">Web Remote server crashed / stopped.</string>
|
||||
<string name="search_hint">Search stations…</string>
|
||||
<string name="search_filter_favorites">Only favorites</string>
|
||||
|
||||
Reference in new issue
Block a user