Add an option to redact fields from starr responses if you dont want the 3rd party app to see data they dont need to

austinwbest · austinwbest · commit c667c8ff29c1 · 2025-09-14T19:37:47.000-04:00
diff --git a/root/app/www/public/ajax/settings.php b/root/app/www/public/ajax/settings.php
@@ -26,6 +26,10 @@
             continue;
         }
 
+        if ($key == 'redactionFields') {
+            $val = str_replace("\n", ',', $val);
+        }
+
         $newSettings[$key] = $val;
     }
 
diff --git a/root/app/www/public/ajax/starr.php b/root/app/www/public/ajax/starr.php
@@ -90,8 +90,10 @@
 if ($_POST['m'] == 'openAppStarrAccess') {
     $existing               = $proxyDb->getAppFromId($_POST['id'], $appsTable);
     $existing['endpoints']  = $existing['endpoints'] ? json_decode($existing['endpoints'], true) : [];
+    $existing['redactions'] = $existing['redactions'] ? array_filter(explode(',', $existing['redactions'])) : [];
     $clone                  = isset($_POST['clone']) ? $proxyDb->getAppFromId($_POST['clone'], $appsTable) : [];
     $endpoints              = $starr->getEndpoints($app);
+    $redactedOptions        = array_filter(explode(',', $settingsTable['redactionFields']));
     $appInstances           = '';
 
     if ($clone) {
@@ -134,6 +136,19 @@
                 <select class="form-select" id="access-instance"><option value="">-- Select instance --</option><?= $appInstances ?></select>
             </td>
         </tr>
+        <tr>
+            <td>Redactions<br><span class="text-small">Selected fields will have their value replaced with <code>{PROXY-REDACTED}</code> in the response</span></td>
+            <td>
+                <select class="form-select" multiple size="5" id="access-redactions">
+                <?php
+                foreach ($redactedOptions as $redactedOption) {
+                    $redactedOption = trim($redactedOption);
+                    ?><option <?= in_array($redactedOption, $existing['redactions']) ? 'selected ' : '' ?>value="<?= $redactedOption ?>"><?= $redactedOption ?></option><?php
+                }
+                ?>
+                </select>
+            </td>
+        </tr>
         <tr>
             <td>Endpoint template<br><span class="text-small">Automatically select the endpoints based on an app template</span></td>
             <td>
@@ -221,6 +236,7 @@
     $fields['starr_id']     = intval($_POST['starr_id']);
     $fields['endpoints']    = json_encode($endpoints, JSON_UNESCAPED_SLASHES);
     $fields['template']     = $_POST['template'];
+    $fields['redactions']   = $_POST['redactions'];
 
     if ($_POST['id'] != 99) {
         $error = $proxyDb->updateApp($_POST['id'], $fields);
diff --git a/root/app/www/public/api/index.php b/root/app/www/public/api/index.php
@@ -267,6 +267,20 @@
                 apiResponse(502, ['error' => sprintf(APP_API_ERROR, 'could not access the requested starr app, it appears to be down and returning an HTTP 0 code')]);
             }
 
+            //-- CHECK FOR FIELD REDACTIONS
+            if ($redactions = $proxiedApp['proxiedAppDetails']['redactions']) {
+                logger($logfile, ['req' => $requestCounter, 'endpoint' => $originalEndpoint, 'redactions' => $redactions]);
+                logger($proxiedAppLogfile, ['req' => $requestCounter, 'endpoint' => $originalEndpoint, 'redactions' => $redactions]);
+
+                $redactionList = explode(',', $redactions);
+                foreach ($request['response'] as $responseKey => $responseVal) {
+                    if (in_array($responseKey, $redactionList)) {
+                        logger($logfile, ['req' => $requestCounter, 'endpoint' => $originalEndpoint, 'redaction-match' => $responseKey]);
+                        $request['response'][$responseKey] = REDACTION_VALUE;
+                    }
+                }
+            }
+
             apiResponse($request['code'], $request['response'], $request['responseHeaders']);
         }
     }
diff --git a/root/app/www/public/includes/constants.php b/root/app/www/public/includes/constants.php
@@ -54,3 +54,6 @@
 define('APPS_TABLE_CACHE_TIME', 86400); //-- 1 DAY
 define('STARR_ENDPOINT_LIST_KEY', 'endpoints_%s'); //-- _starrApp
 define('STARR_ENDPOINT_LIST_TIME', 604800); //-- 1 WEEK
+
+//-- MISC
+define('REDACTION_VALUE', '{PROXY-REDACTED}');
diff --git a/root/app/www/public/js/starr.js b/root/app/www/public/js/starr.js
@@ -124,6 +124,7 @@ function saveAppStarrAccess(app, id)
     params += '&id=' + id;
     params += '&starr_id=' + $('#access-instance').val();
     params += '&template=' + $('#access-template').val();
+    params += '&redactions=' + $('#access-redactions').val();
 
     $.each($('[id^=endpoint-counter-]'), function() {
         const counter = $(this).attr('id').replace('endpoint-counter-', '');
@@ -258,4 +259,4 @@ function autoAdjustAppEndpoints(appId)
         }
     });
 }
-// -------------------------------------------------------------------------------------------
+// -------------------------------------------------------------------------------------------
diff --git a/root/app/www/public/migrations/007_redactions.php b/root/app/www/public/migrations/007_redactions.php
@@ -0,0 +1,47 @@
+<?php
+
+/*
+----------------------------------
+ ------  Created: 081425   ------
+ ------  Austin Best	   ------
+----------------------------------
+*/
+
+//-- RESET THE LIST
+$q = [];
+
+$q[] = "ALTER TABLE " . APPS_TABLE . "
+        ADD redactions TEXT NULL";
+
+$settings   = [
+                'redactionFields' => 'nzbInfoUrl,downloadUrl,guid,downloadClient,indexer,downloadClientName,torrentInfoHash,apikey,protocol'
+            ];
+
+$settingRows = [];
+foreach ($settings as $key => $val) {
+    $settingRows[] = "('" . $key . "', '" . $val . "')";
+}
+
+$q[] = "INSERT INTO " . SETTINGS_TABLE . "
+        (`name`, `value`) 
+        VALUES " . implode(', ', $settingRows);
+
+//-- ALWAYS NEED TO BUMP THE MIGRATION ID
+$q[] = "UPDATE " . SETTINGS_TABLE . "
+        SET value = '007'
+        WHERE name = 'migration'";
+
+foreach ($q as $query) {
+    logger(MIGRATION_LOG, ['text' => '<span class="text-success">[Q]</span> ' . preg_replace('!\s+!', ' ', $query)]);
+
+    $proxyDb->query($query);
+
+	if ($proxyDb->error() != 'not an error') {
+        logger(MIGRATION_LOG, ['text' => '<span class="text-info">[R]</span> ' . $proxyDb->error()]);
+	} else {
+        logger(MIGRATION_LOG, ['text' => '<span class="text-info">[R]</span> query applied!']);
+	}
+}
+
+//-- NEEDED SINCE WE ADD A NEW FIELD TO THIS TABLE
+$cache->bust(APPS_TABLE_CACHE_KEY);
diff --git a/root/app/www/public/pages/settings.php b/root/app/www/public/pages/settings.php
@@ -19,10 +19,15 @@
 $dir = opendir(MIGRATIONS_PATH);
 while ($migration = readdir($dir)) {
     if (str_contains($migration, '.php')) {
-        $migrations .= '<option ' . ($settingsTable['migration'] == substr($migration, 0, 3) ? 'selected ' : '') . 'value="' . substr($migration, 0, 3) . '">' . str_replace('.php', '', $migration) . '</option>';
+        $migrationFiles[] = $migration;
     }
 }
 closedir($dir);
+sort($migrationFiles);
+
+foreach ($migrationFiles as $migrationFile) {
+    $migrations .= '<option ' . ($settingsTable['migration'] == substr($migrationFile, 0, 3) ? 'selected ' : '') . 'value="' . substr($migrationFile, 0, 3) . '">' . str_replace('.php', '', $migrationFile) . '</option>';
+}
 
 $backups    = $proxyDb->getBackups();
 $cacheStats = $cache->stats();
@@ -36,15 +41,15 @@
             <div class="card-header">System</div>
             <div class="card-body">
                 <div class="table-responsive">
-                    <table class="table table-bordered table-hover">
+                    <table class="table table-sm table-bordered table-hover">
                         <tbody>
                             <tr>
                                 <td class="w-25">
                                     API key<br>
                                     <span class="text-small">File: <?= APP_APIKEY_FILE ?></span>
                                 </td>
                                 <td>
-                                    <div class="input-group mb-3 w-25">
+                                    <div class="input-group mb-3 w-50">
                                         <input type="text" class="form-control" aria-describedby="apikey-input" value="<?= APP_APIKEY ?>" id="setting-apikey">
                                         <button title="Copy" class="btn btn-primary" type="button" id="apikey-input" onclick="clipboard('setting-apikey', 'val')"><i class="far fa-copy"></i></button>
                                     </div>
@@ -58,10 +63,13 @@
     </div>
     <div class="col-sm-12">
         <div class="card border-default mb-3">
-            <div class="card-header">UI</div>
+            <div class="card-header">
+                UI
+                <br><span class="text-small">Adjust settings that impact the interface</span>
+            </div>
             <div class="card-body">
                 <div class="table-responsive">
-                    <table class="table table-bordered table-hover">
+                    <table class="table table-sm table-bordered table-hover">
                         <thead>
                             <tr>
                                 <th colspan="2">Navigation</th>
@@ -123,12 +131,35 @@
             </div>
         </div>
     </div>
+    <div class="col-sm-12">
+        <div class="card border-default mb-3">
+            <div class="card-header">
+                Redactions
+                <br><span class="text-small">Remove specific fields from the starr responses</span>
+            </div>
+            <div class="card-body">
+                <div class="table-responsive">
+                    <table class="table table-sm table-bordered table-hover">
+                        <tbody>
+                            <tr>
+                                <td class="w-25">
+                                    Fields<br>
+                                    <span class="text-small">One field per line</span>
+                                </td>
+                                <td><textarea class="form-control w-25" rows="10" id="setting-redactionFields"><?= implode("\n", explode(',', $settingsTable['redactionFields'])) ?></textarea></td>
+                            </tr>
+                        </tbody>
+                    </table>
+                </div>
+            </div>
+        </div>
+    </div>
     <div class="col-sm-12">
         <div class="card border-default mb-3">
             <div class="card-header">Database</div>
             <div class="card-body">
                 <div class="table-responsive">
-                    <table class="table table-bordered table-hover">
+                    <table class="table table-sm table-bordered table-hover">
                         <tbody>
                             <tr>
                                 <td class="w-25">
@@ -180,7 +211,7 @@
             <div class="card-header">Logging</div>
             <div class="card-body">
                 <div class="table-responsive">
-                    <table class="table table-bordered table-hover">
+                    <table class="table table-sm table-bordered table-hover">
                         <tbody>
                             <tr>
                                 <td class="w-25">
@@ -207,7 +238,7 @@
             <div class="card-header">Cache</div>
             <div class="card-body">
                 <div class="table-responsive">
-                    <table class="table table-bordered table-hover">
+                    <table class="table table-sm table-bordered table-hover">
                         <tbody>
                             <tr>
                                 <td class="w-25">Memcache enabled</td>
diff --git a/root/app/www/public/pages/starr.php b/root/app/www/public/pages/starr.php
@@ -132,13 +132,13 @@
                                             <a class="nav-link" data-bs-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false"><i class="fas fa-ellipsis-h text-info"></i></a>
                                             <div class="dropdown-menu">
                                                 <div class="ms-2">
-                                                    <span style="cursor: pointer;" onclick="openAppStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Modify the <?= $accessApp['name'] ?> app's details"><i class="far fa-edit"></i> Modify</span><br>
-                                                    <span style="cursor: pointer;" onclick="viewAppLog('<?= LOGS_PATH . 'access_'. $accessApp['name'] .'.log' ?>', '<?= truncateMiddle($accessApp['apikey'], 20) ?>', '<?= $accessApp['name'] ?>')" title="View <?= $accessApp['name'] ?> app logs"><i class="fas fa-newspaper"></i> Logs</span><br>
-                                                    <span style="cursor: pointer;" onclick="openAppStarrAccess('<?= $app ?>', 99, <?= $accessApp['id'] ?>)" title="Clone the <?= $accessApp['name'] ?> app"><i class="far fa-clone"></i> Clone</span><br>
-                                                    <span style="cursor: pointer;" onclick="openTemplateStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Create a new template based on <?= $accessApp['name'] ?>'s settings"><i class="far fa-file-alt"></i> Create template</span><br>
+                                                    <span style="cursor: pointer;" onclick="openAppStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Modify the <?= $accessApp['name'] ?> app's details"><i class="far fa-edit fa-fw"></i> Modify</span><br>
+                                                    <span style="cursor: pointer;" onclick="viewAppLog('<?= LOGS_PATH . 'access_'. $accessApp['name'] .'.log' ?>', '<?= truncateMiddle($accessApp['apikey'], 20) ?>', '<?= $accessApp['name'] ?>')" title="View <?= $accessApp['name'] ?> app logs"><i class="fas fa-newspaper fa-fw"></i> Logs</span><br>
+                                                    <span style="cursor: pointer;" onclick="openAppStarrAccess('<?= $app ?>', 99, <?= $accessApp['id'] ?>)" title="Clone the <?= $accessApp['name'] ?> app"><i class="far fa-clone fa-fw"></i> Clone</span><br>
+                                                    <span style="cursor: pointer;" onclick="openTemplateStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Create a new template based on <?= $accessApp['name'] ?>'s settings"><i class="far fa-file-alt fa-fw"></i> Create template</span><br>
                                                     <div class="dropdown-divider"></div>
-                                                    <span style="cursor: pointer;" onclick="resetUsage('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Reset usage counter"><i class="fas fa-recycle text-danger"></i> Reset usage</span><br>
-                                                    <span style="cursor: pointer;" onclick="deleteAppStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Remove the <?= $accessApp['name'] ?> app's access"><i class="far fa-trash-alt text-danger"></i> Delete</span>
+                                                    <span style="cursor: pointer;" onclick="resetUsage('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Reset usage counter"><i class="fas fa-recycle text-danger fa-fw"></i> Reset usage</span><br>
+                                                    <span style="cursor: pointer;" onclick="deleteAppStarrAccess('<?= $app ?>', <?= $accessApp['id'] ?>)" title="Remove the <?= $accessApp['name'] ?> app's access"><i class="far fa-trash-alt text-danger fa-fw"></i> Delete</span>
                                                 </div>
                                             </div>
                                         </li>
@@ -149,8 +149,9 @@
                         <div class="card-body">
                             Instance: <?= $parentStarrApp['name'] ?> <span class="text-small"><?= $parentStarrApp['url'] ?></span><br>
                             Access: <?= count($accessApp['endpoints'], COUNT_RECURSIVE) ?> endpoint<?= count($accessApp['endpoints'], COUNT_RECURSIVE) == 1 ? '' : 's' ?><?= $template ?><br>
+                            Redactions: <?= count(array_filter(explode(',', $accessApp['redactions']))) ?> applied<br>
                             Apikey: <?= truncateMiddle($accessApp['apikey'], 20) ?> <i class="far fa-copy text-info" style="cursor: pointer;" onclick="clipboard('app-<?= $accessApp['id'] ?>-apikey', 'html')" title="Copy apikey to clipboard"></i><span id="app-<?= $accessApp['id'] ?>-apikey" style="display: none;"><?= $accessApp['apikey'] ?></span><br>
-                            Usage: <?= number_format($usage['allowed'] + $usage['rejected']) ?> request<?= $usage['allowed'] + $usage['rejected'] == 1 ? '' : 's' ?> (Allowed: <?= number_format($usage['allowed']) ?> Rejected: <?= number_format($usage['rejected']) ?>)
+                            Usage: <?= number_format($usage['allowed'] + $usage['rejected']) ?> request<?= $usage['allowed'] + $usage['rejected'] == 1 ? '' : 's' ?> (Pass: <?= number_format($usage['allowed']) ?> Fail: <?= number_format($usage['rejected']) ?>)
                         </div>
                     </div>
                 </div>

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,10 @@`
`26`	`26`	`continue;`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ if ($key == 'redactionFields') {`
	`30`	`+ $val = str_replace("\n", ',', $val);`
	`31`	`+ }`
	`32`	`+`
`29`	`33`	`$newSettings[$key] = $val;`
`30`	`34`	`}`
`31`	`35`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,7 @@ function saveAppStarrAccess(app, id)`
`124`	`124`	`params += '&id=' + id;`
`125`	`125`	`params += '&starr_id=' + $('#access-instance').val();`
`126`	`126`	`params += '&template=' + $('#access-template').val();`
	`127`	`+ params += '&redactions=' + $('#access-redactions').val();`
`127`	`128`
`128`	`129`	`$.each($('[id^=endpoint-counter-]'), function() {`
`129`	`130`	`const counter = $(this).attr('id').replace('endpoint-counter-', '');`
`@@ -258,4 +259,4 @@ function autoAdjustAppEndpoints(appId)`
`258`	`259`	`}`
`259`	`260`	`});`
`260`	`261`	`}`
`261`		`-// -------------------------------------------------------------------------------------------`
	`262`	`+// -------------------------------------------------------------------------------------------`