feat(Reddit is Fun - Spoof client): Spoof the user agent

ReVanced · Aug 2, 2023 · b9aaf61 · b9aaf61
1 parent c6c24b7
commit b9aaf61
Show file tree

Hide file tree

Showing 11 changed files with 167 additions and 102 deletions.
diff --git a/...ients/AbstractChangeOAuthClientIdPatch.kt → ...customclients/AbstractSpoofClientPatch.kt b/...ients/AbstractChangeOAuthClientIdPatch.kt → ...customclients/AbstractSpoofClientPatch.kt
@@ -8,11 +8,15 @@ import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.*
 import java.io.File
 
-abstract class AbstractChangeOAuthClientIdPatch(
+abstract class AbstractSpoofClientPatch(
     private val redirectUri: String,
-    private val options: ChangeOAuthClientIdOptionsContainer,
-    private val fingerprints: List<MethodFingerprint>
-) : BytecodePatch(fingerprints) {
+    private val options: SpoofClientOptionsContainer,
+    private val clientIdFingerprints: List<MethodFingerprint>,
+    private val userAgentFingerprints: List<MethodFingerprint>? = null,
+) : BytecodePatch(buildList {
+    addAll(clientIdFingerprints)
+    userAgentFingerprints?.let(::addAll)
+}) {
     override fun execute(context: BytecodeContext): PatchResult {
         if (options.clientId == null) {
             // Ensure device runs Android.
@@ -38,13 +42,39 @@ abstract class AbstractChangeOAuthClientIdPatch(
             }.let { options.clientId = it.readText().trim() }
         }
 
-        return fingerprints.map { it.result ?: throw it.toErrorResult() }.patch(context)
+        fun List<MethodFingerprint>?.executePatch(
+            patch: List<MethodFingerprintResult>.(BytecodeContext) -> PatchResult
+        ) {
+            when (val result = this?.map { it.result ?: throw it.toErrorResult() }?.patch(context)) {
+                is PatchResultError -> throw result
+            }
+        }
+
+        clientIdFingerprints.executePatch { patchClientId(context) }
+        userAgentFingerprints.executePatch { patchUserAgent(context) }
+
+        return PatchResultSuccess()
     }
 
-    abstract fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult
+    /**
+     * Patch the client ID. The fingerprints are guaranteed to be in the same order as in [clientIdFingerprints].
+     *
+     * @param context The current [BytecodeContext].
+     *
+     */
+    abstract fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult
+
+    /**
+     * Patch the user agent. The fingerprints are guaranteed to be in the same order as in [userAgentFingerprints].
+     *
+     * @param context The current [BytecodeContext].
+     */
+    // Not every client needs to patch the user agent.
+    open fun List<MethodFingerprintResult>.patchUserAgent(context: BytecodeContext): PatchResult =
+        PatchResultSuccess()
 
     companion object Options {
-        open class ChangeOAuthClientIdOptionsContainer : OptionsContainer() {
+        open class SpoofClientOptionsContainer : OptionsContainer() {
             var clientId by option(
                 PatchOption.StringOption(
                     "client-id",

diff --git a/...nts/ChangeOAuthClientIdPatchAnnotation.kt → ...it/customclients/SpoofClientAnnotation.kt b/...nts/ChangeOAuthClientIdPatchAnnotation.kt → ...it/customclients/SpoofClientAnnotation.kt
@@ -5,5 +5,5 @@ import app.revanced.patcher.patch.annotations.Patch
 
 @Target(AnnotationTarget.CLASS)
 @Patch
-@Name("Change OAuth client id")
-annotation class ChangeOAuthClientIdPatchAnnotation
+@Name("Spoof client")
+annotation class SpoofClientAnnotation
diff --git a/...der/api/patch/ChangeOAuthClientIdPatch.kt → ...baconreader/api/patch/SpoofClientPatch.kt b/...der/api/patch/ChangeOAuthClientIdPatch.kt → ...baconreader/api/patch/SpoofClientPatch.kt
@@ -9,15 +9,15 @@ import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.baconreader.api.fingerprints.GetAuthorizationUrlFingerprint
 import app.revanced.patches.reddit.customclients.baconreader.api.fingerprints.RequestTokenFingerprint
 import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
 
 
-@ChangeOAuthClientIdPatchAnnotation
-@Description("Changes the OAuth client ID. " +
+@SpoofClientAnnotation
+@Description("Spoofs the client in order to allow logging in. " +
         "The OAuth application type has to be \"Installed app\" " +
         "and the redirect URI has to be set to \"http://baconreader.com/auth\".")
 @Compatibility(
@@ -26,11 +26,11 @@ import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
         Package("com.onelouder.baconreader.premium")
     ]
 )
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "http://baconreader.com/auth", Options, listOf(GetAuthorizationUrlFingerprint, RequestTokenFingerprint)
 ) {
 
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         fun MethodFingerprintResult.patch(replacementString: String) {
             val clientIdIndex = scanResult.stringsScanResult!!.matches.first().index
 
@@ -52,5 +52,5 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }
diff --git a/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...stforreddit/api/patch/SpoofClientPatch.kt b/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...stforreddit/api/patch/SpoofClientPatch.kt
@@ -8,29 +8,29 @@ import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.boostforreddit.api.fingerprints.GetClientIdFingerprint
 
-@ChangeOAuthClientIdPatchAnnotation
-@Description("Changes the OAuth client ID. " +
+@SpoofClientAnnotation
+@Description("Spoofs the client in order to allow logging in. " +
         "The OAuth application type has to be \"Installed app\" " +
         "and the redirect URI has to be set to \"http://rubenmayayo.com\".")
 @Compatibility([Package("com.rubenmayayo.reddit")])
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "http://rubenmayayo.com", Options, listOf(GetClientIdFingerprint)
 ) {
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         first().mutableMethod.addInstructions(
             0,
-    """
-                     const-string v0, "$clientId"
-                     return-object v0
-                """
+            """
+                 const-string v0, "$clientId"
+                 return-object v0
+            """
         )
 
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }
diff --git a/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...tyforreddit/api/patch/SpoofClientPatch.kt b/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...tyforreddit/api/patch/SpoofClientPatch.kt
@@ -9,23 +9,23 @@ import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.infinityforreddit.api.fingerprints.GetHttpBasicAuthHeaderFingerprint
 import app.revanced.patches.reddit.customclients.infinityforreddit.api.fingerprints.LoginActivityOnCreateFingerprint
 import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
 
-@ChangeOAuthClientIdPatchAnnotation
-@Description("Changes the OAuth client ID. " +
+@SpoofClientAnnotation
+@Description("Spoofs the client in order to allow logging in. " +
         "The OAuth application type has to be \"Installed app\" " +
         "and the redirect URI has to be set to \"infinity://localhost\".")
 @Compatibility([Package("ml.docilealligator.infinityforreddit")])
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "infinity://localhost",
     Options,
     listOf(GetHttpBasicAuthHeaderFingerprint, LoginActivityOnCreateFingerprint)
 ) {
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         forEach {
             val clientIdIndex = it.scanResult.stringsScanResult!!.matches.first().index
             it.mutableMethod.apply {
@@ -41,5 +41,5 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }
diff --git a/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...eyforreddit/api/patch/SpoofClientPatch.kt b/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...eyforreddit/api/patch/SpoofClientPatch.kt
@@ -9,14 +9,14 @@ import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
 import app.revanced.patcher.patch.annotations.DependsOn
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.joeyforreddit.api.fingerprints.GetClientIdFingerprint
 import app.revanced.patches.reddit.customclients.joeyforreddit.detection.piracy.patch.DisablePiracyDetectionPatch
 
-@ChangeOAuthClientIdPatchAnnotation
+@SpoofClientAnnotation
 @Description(
-    "Changes the OAuth client ID. " +
+    "Spoofs the client in order to allow logging in. " +
             "The OAuth application type has to be \"Installed app\" " +
             "and the redirect URI has to be set to \"https://127.0.0.1:65023/authorize_callback\"."
 )
@@ -28,10 +28,10 @@ import app.revanced.patches.reddit.customclients.joeyforreddit.detection.piracy.
     ]
 )
 @DependsOn([DisablePiracyDetectionPatch::class])
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "https://127.0.0.1:65023/authorize_callback", Options, listOf(GetClientIdFingerprint)
 ) {
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         first().mutableMethod.addInstructions(
             0,
             """
@@ -43,5 +43,5 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }
diff --git a/...nced/patches/reddit/customclients/redditisfun/api/fingerprints/GetUserAgentFingerprint.kt b/...nced/patches/reddit/customclients/redditisfun/api/fingerprints/GetUserAgentFingerprint.kt
@@ -0,0 +1,20 @@
+package app.revanced.patches.reddit.customclients.redditisfun.api.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.Opcode
+
+object GetUserAgentFingerprint : MethodFingerprint(
+    "Ljava/lang/String;",
+    AccessFlags.PUBLIC or AccessFlags.STATIC,
+    emptyList(),
+    listOf(
+        Opcode.NEW_ARRAY,
+        Opcode.CONST_4,
+        Opcode.INVOKE_STATIC,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.APUT_OBJECT,
+        Opcode.CONST,
+    )
+)
diff --git a/...fun/api/patch/ChangeOAuthClientIdPatch.kt → ...redditisfun/api/patch/SpoofClientPatch.kt b/...fun/api/patch/ChangeOAuthClientIdPatch.kt → ...redditisfun/api/patch/SpoofClientPatch.kt
@@ -4,32 +4,32 @@ import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Description
 import app.revanced.patcher.annotation.Package
 import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
 import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
 import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult.MethodFingerprintScanResult.StringsScanResult.StringMatch
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.redditisfun.api.fingerprints.BasicAuthorizationFingerprint
 import app.revanced.patches.reddit.customclients.redditisfun.api.fingerprints.BuildAuthorizationStringFingerprint
+import app.revanced.patches.reddit.customclients.redditisfun.api.fingerprints.GetUserAgentFingerprint
 import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
 
-@ChangeOAuthClientIdPatchAnnotation
-@Description("Changes the OAuth client ID. " +
+@SpoofClientAnnotation
+@Description("Spoofs the client in order to allow logging in. " +
         "The OAuth application type has to be \"Installed app\" " +
         "and the redirect URI has to be set to \"redditisfun://auth\".")
 @Compatibility([Package("com.andrewshu.android.reddit"), Package("com.andrewshu.android.redditdonation")])
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "redditisfun://auth",
     Options,
-    listOf(
-        BuildAuthorizationStringFingerprint,
-        BasicAuthorizationFingerprint,
-    )
+    listOf(BuildAuthorizationStringFingerprint, BasicAuthorizationFingerprint),
+    listOf(GetUserAgentFingerprint)
 ) {
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         /**
          * Replaces a one register instruction with a const-string instruction
          * at the index returned by [getReplacementIndex].
@@ -57,5 +57,20 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    override fun List<MethodFingerprintResult>.patchUserAgent(context: BytecodeContext): PatchResult {
+        // Use a random number as the user agent string.
+        val randomUserAgent = (0..100000).random()
+
+        first().mutableMethod.addInstructions(
+            0,
+            """
+                 const-string v0, "$randomUserAgent"
+                 return-object v0
+             """
+        )
+
+        return PatchResultSuccess()
+    }
+
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }
diff --git a/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...ayforreddit/api/patch/SpoofClientPatch.kt b/...dit/api/patch/ChangeOAuthClientIdPatch.kt → ...ayforreddit/api/patch/SpoofClientPatch.kt
@@ -9,20 +9,20 @@ import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprintResult
 import app.revanced.patcher.patch.PatchResult
 import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patches.reddit.customclients.AbstractChangeOAuthClientIdPatch
-import app.revanced.patches.reddit.customclients.ChangeOAuthClientIdPatchAnnotation
+import app.revanced.patches.reddit.customclients.AbstractSpoofClientPatch
+import app.revanced.patches.reddit.customclients.SpoofClientAnnotation
 import app.revanced.patches.reddit.customclients.relayforreddit.api.fingerprints.GetLoggedInBearerTokenFingerprint
 import app.revanced.patches.reddit.customclients.relayforreddit.api.fingerprints.GetLoggedOutBearerTokenFingerprint
 import app.revanced.patches.reddit.customclients.relayforreddit.api.fingerprints.GetRefreshTokenFingerprint
 import app.revanced.patches.reddit.customclients.relayforreddit.api.fingerprints.LoginActivityClientIdFingerprint
 import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
 
-@ChangeOAuthClientIdPatchAnnotation
-@Description("Changes the OAuth client ID. " +
+@SpoofClientAnnotation
+@Description("Spoofs the client in order to allow logging in. " +
         "The OAuth application type has to be \"Installed app\" " +
         "and the redirect URI has to be set to \"dbrady://relay\".")
 @Compatibility([Package("free.reddit.news"), Package("reddit.news")])
-class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
+class SpoofClientPatch : AbstractSpoofClientPatch(
     "dbrady://relay",
     Options,
     listOf(
@@ -32,7 +32,7 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         GetRefreshTokenFingerprint
     )
 ) {
-    override fun List<MethodFingerprintResult>.patch(context: BytecodeContext): PatchResult {
+    override fun List<MethodFingerprintResult>.patchClientId(context: BytecodeContext): PatchResult {
         forEach {
             val clientIdIndex = it.scanResult.stringsScanResult!!.matches.first().index
             it.mutableMethod.apply {
@@ -48,5 +48,5 @@ class ChangeOAuthClientIdPatch : AbstractChangeOAuthClientIdPatch(
         return PatchResultSuccess()
     }
 
-    companion object Options : AbstractChangeOAuthClientIdPatch.Options.ChangeOAuthClientIdOptionsContainer()
+    companion object Options : AbstractSpoofClientPatch.Options.SpoofClientOptionsContainer()
 }