Add some headers to remote cipher requests (#181)

* add optional user-agent header and plugin version header to remote cipher requests

* dont log using remote cipher if null url

* Cipher readme updates

* pr feedback

* Set yt-cipher headers in the context filter

* remote cipher gets its own http interface

* PR Comments, use yt context filter only

* remove context, remove old 429 message

Author: kikkia

README.md

@@ -325,6 +325,7 @@ plugins:
     remoteCipher:
       url: "http://localhost:8001" # The base URL of your remote cipher server.
       password: "your_secret_password" # The password to authenticate with your remote cipher server.
+      userAgent: "your_service_name" # Optional user-agent header, used for metrics on the backend. 
 ```
 
 ## REST routes (`plugin` only)

common/src/main/java/dev/lavalink/youtube/YoutubeAudioSourceManager.java

@@ -150,11 +150,11 @@ public YoutubeAudioSourceManager(@NotNull YoutubeSourceOptions options,
         contextFilter = new YoutubeHttpContextFilter();
         contextFilter.setTokenTracker(new YoutubeAccessTokenTracker(httpInterfaceManager));
         contextFilter.setOauth2Handler(oauth2Handler);
-
         httpInterfaceManager.setHttpContextFilter(contextFilter);
 
         if (!DataFormatTools.isNullOrEmpty(options.getRemoteCipherUrl())) {
-            this.cipherManager = new RemoteCipherManager(options.getRemoteCipherUrl(), options.getRemoteCipherPassword());
+            contextFilter.setCipherConfig(options.getRemoteCipherPassword(), options.getRemoteCipherUserAgent(), YoutubeSource.VERSION);
+            this.cipherManager = new RemoteCipherManager(options.getRemoteCipherUrl());
         } else {
             this.cipherManager = new LocalSignatureCipherManager();
         }

common/src/main/java/dev/lavalink/youtube/YoutubeSourceOptions.java

@@ -8,6 +8,7 @@ public class YoutubeSourceOptions {
     private boolean allowDirectPlaylistIds = true;
     private String remoteCipherUrl;
     private String remoteCipherPassword;
+    private String remoteCipherUserAgent;
 
     public boolean isAllowSearch() {
         return allowSearch;
@@ -40,14 +41,20 @@ public String getRemoteCipherUrl() {
         return remoteCipherUrl;
     }
 
-    public YoutubeSourceOptions setRemoteCipherUrl(String remoteCipherUrl, @Nullable String remoteCipherPassword) {
+    public YoutubeSourceOptions setRemoteCipherUrl(String remoteCipherUrl, @Nullable String remoteCipherPassword, @Nullable String remoteCipherUserAgent) {
         this.remoteCipherUrl = remoteCipherUrl;
         this.remoteCipherPassword = remoteCipherPassword;
+        this.remoteCipherUserAgent = remoteCipherUserAgent;
         return this;
     }
 
     public String getRemoteCipherPassword() {
         return remoteCipherPassword;
     }
 
+    @Nullable
+    public String getRemoteCipherUserAgent() {
+        return remoteCipherUserAgent;
+    }
+
 }

common/src/main/java/dev/lavalink/youtube/cipher/RemoteCipherManager.java

@@ -6,6 +6,7 @@
 import com.sedmelluq.discord.lavaplayer.tools.JsonBrowser;
 import com.sedmelluq.discord.lavaplayer.tools.io.HttpClientTools;
 import com.sedmelluq.discord.lavaplayer.tools.io.HttpInterface;
+import dev.lavalink.youtube.http.YoutubeHttpContextFilter;
 import dev.lavalink.youtube.track.format.StreamFormat;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpRequest;
@@ -36,28 +37,22 @@ public class RemoteCipherManager implements CipherManager {
 
     private final Object cipherLoadLock;
     private final @NotNull String remoteUrl;
-    private final @Nullable String remotePass;
 
     protected volatile CachedPlayerScript cachedPlayerScript;
 
     /**
      * Create a new remote cipher manager
      */
-    public RemoteCipherManager(@NotNull String remoteUrl, @Nullable String remotePass) {
+    public RemoteCipherManager(@NotNull String remoteUrl) {
         this.cipherLoadLock = new Object();
         this.remoteUrl = remoteUrl;
-        this.remotePass = remotePass;
     }
 
     @NotNull
     public String getRemoteUrl() {
         return remoteUrl;
     }
 
-    @Nullable
-    public String getRemotePass() {
-        return remotePass;
-    }
 
     /**
      * Produces a valid playback URL for the specified track
@@ -70,8 +65,8 @@ public String getRemotePass() {
      */
     @NotNull
     public URI resolveFormatUrl(@NotNull HttpInterface httpInterface,
-                                @NotNull String playerScript,
-                                @NotNull StreamFormat format) throws IOException {
+                                 @NotNull String playerScript,
+                                 @NotNull StreamFormat format) throws IOException {
         String signature = format.getSignature();
         String nParameter = format.getNParameter();
         URI initialUrl = format.getUrl();
@@ -133,13 +128,9 @@ private String getRemoteEndpoint(String path) {
         return remoteUrl.endsWith("/") ? remoteUrl + path : remoteUrl + "/" + path;
     }
 
-    private void applyPass(HttpRequest request) {
-        if (remotePass != null && !remotePass.isEmpty()) {
-            request.addHeader("Authorization", remotePass);
-        }
-    }
 
     private String decipherN(HttpInterface httpInterface, String n, String playerScript) throws IOException {
+        httpInterface.getContext().setAttribute(YoutubeHttpContextFilter.CIPHER_REQUEST_ATTRIBUTE, true);
         HttpPost request = new HttpPost(getRemoteEndpoint("decrypt_signature"));
 
         log.debug("Deciphering N param: {} with script: {}", n, playerScript);
@@ -151,7 +142,6 @@ private String decipherN(HttpInterface httpInterface, String n, String playerScr
             .end()
             .done();
         request.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
-        applyPass(request);
 
         try (CloseableHttpResponse response = httpInterface.execute(request)) {
             int statusCode = response.getStatusLine().getStatusCode();
@@ -180,6 +170,7 @@ private String decipherN(HttpInterface httpInterface, String n, String playerScr
     }
 
     private URI getUri(HttpInterface httpInterface, String sig, String sigKey, String nParam, URI initial, String playerScript) throws IOException {
+        httpInterface.getContext().setAttribute(YoutubeHttpContextFilter.CIPHER_REQUEST_ATTRIBUTE, true);
         HttpPost request = new HttpPost(getRemoteEndpoint("decrypt_signature"));
 
         log.debug("Deciphering N param: {} and Signature: {} with script: {}", nParam, sig, playerScript);
@@ -193,7 +184,6 @@ private URI getUri(HttpInterface httpInterface, String sig, String sigKey, Strin
             .end()
             .done();
         request.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
-        applyPass(request);
 
         try (CloseableHttpResponse response = httpInterface.execute(request)) {
             int statusCode = response.getStatusLine().getStatusCode();
@@ -241,6 +231,7 @@ private URI getUri(HttpInterface httpInterface, String sig, String sigKey, Strin
     }
 
     private String getTimestampFromScript(HttpInterface httpInterface, String playerScript) throws IOException {
+        httpInterface.getContext().setAttribute(YoutubeHttpContextFilter.CIPHER_REQUEST_ATTRIBUTE, true);
         HttpPost request = new HttpPost(getRemoteEndpoint("get_sts"));
 
         log.debug("Getting timestamp for script: {}", playerScript);
@@ -251,7 +242,6 @@ private String getTimestampFromScript(HttpInterface httpInterface, String player
             .end()
             .done();
         request.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
-        applyPass(request);
 
         try (CloseableHttpResponse response = httpInterface.execute(request)) {
             int statusCode = response.getStatusLine().getStatusCode();
@@ -274,3 +264,4 @@ private String getTimestampFromScript(HttpInterface httpInterface, String player
     }
 
 }
+

common/src/main/java/dev/lavalink/youtube/http/YoutubeHttpContextFilter.java

@@ -3,13 +3,15 @@
 import com.sedmelluq.discord.lavaplayer.tools.FriendlyException;
 import com.sedmelluq.discord.lavaplayer.tools.http.HttpContextRetryCounter;
 import com.sedmelluq.discord.lavaplayer.tools.io.HttpClientTools;
+import com.sedmelluq.discord.lavaplayer.tools.DataFormatTools;
 import dev.lavalink.youtube.clients.skeleton.Client;
 import org.apache.http.HttpResponse;
 import org.apache.http.client.CookieStore;
 import org.apache.http.client.methods.HttpUriRequest;
 import org.apache.http.client.protocol.HttpClientContext;
 import org.apache.http.impl.client.BasicCookieStore;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -22,12 +24,17 @@ public class YoutubeHttpContextFilter extends BaseYoutubeHttpContextFilter {
   private static final String ATTRIBUTE_RESET_RETRY = "isResetRetry";
   public static final String ATTRIBUTE_USER_AGENT_SPECIFIED = "clientUserAgent";
   public static final String ATTRIBUTE_VISITOR_DATA_SPECIFIED = "clientVisitorData";
+  public static final String CIPHER_REQUEST_ATTRIBUTE = "cipher-request";
 
   private static final HttpContextRetryCounter retryCounter = new HttpContextRetryCounter("yt-token-retry");
 
   private YoutubeAccessTokenTracker tokenTracker;
   private YoutubeOauth2Handler oauth2Handler;
 
+  private String remoteCipherPass;
+  private String remoteCipherUserAgent;
+  private String pluginVersion;
+
   public void setTokenTracker(@NotNull YoutubeAccessTokenTracker tokenTracker) {
     this.tokenTracker = tokenTracker;
   }
@@ -36,6 +43,15 @@ public void setOauth2Handler(@NotNull YoutubeOauth2Handler oauth2Handler) {
     this.oauth2Handler = oauth2Handler;
   }
 
+  public void setCipherConfig(@Nullable String remotePass,
+                              @Nullable String userAgent,
+                              @NotNull String pluginVersion) {
+      this.remoteCipherPass = remotePass;
+      this.remoteCipherUserAgent = userAgent;
+      this.pluginVersion = pluginVersion;
+  }
+
+
   @Override
   public void onContextOpen(HttpClientContext context) {
     CookieStore cookieStore = context.getCookieStore();
@@ -70,7 +86,19 @@ public void onRequest(HttpClientContext context,
 
     String userAgent = context.getAttribute(ATTRIBUTE_USER_AGENT_SPECIFIED, String.class);
 
-    if (!request.getURI().getHost().contains("googlevideo")) {
+    if (isRemoteCipherRequest(context)) {
+        context.removeAttribute(CIPHER_REQUEST_ATTRIBUTE);
+
+        if (!DataFormatTools.isNullOrEmpty(remoteCipherPass)) {
+            request.addHeader("Authorization", remoteCipherPass);
+        }
+
+        if (!DataFormatTools.isNullOrEmpty(remoteCipherUserAgent)) {
+            request.addHeader("User-Agent", remoteCipherUserAgent);
+        }
+
+        request.addHeader("Plugin-Version", pluginVersion);
+    } else if (!request.getURI().getHost().contains("googlevideo")) {
       if (userAgent != null) {
         request.setHeader("User-Agent", userAgent);
 
@@ -114,9 +142,6 @@ public void onRequest(HttpClientContext context,
   public boolean onRequestResponse(HttpClientContext context,
                                    HttpUriRequest request,
                                    HttpResponse response) {
-    if (response.getStatusLine().getStatusCode() == 429) {
-      throw new FriendlyException("This IP address has been blocked by YouTube (429).", COMMON, null);
-    }
 
 //    if (tokenTracker.isTokenFetchContext(context) || retryCounter.getRetryCount(context) >= 1) {
 //      return false;
@@ -138,4 +163,8 @@ public boolean onRequestException(HttpClientContext context,
 
     return false;
   }
+
+  private boolean isRemoteCipherRequest(HttpClientContext context) {
+    return context.getAttribute(CIPHER_REQUEST_ATTRIBUTE) == Boolean.TRUE;
+  }
 }

plugin/src/main/java/dev/lavalink/youtube/plugin/YoutubePluginLoader.java

@@ -180,9 +180,9 @@ public AudioPlayerManager configure(AudioPlayerManager audioPlayerManager) {
                 }
             }
 
-            if (cipherConfig != null) {
+            if (cipherConfig != null && cipherConfig.getUrl() != null) {
                 log.info("Using remote cipher server with URL \"{}\"", cipherConfig.getUrl());
-                sourceOptions.setRemoteCipherUrl(cipherConfig.getUrl(), cipherConfig.getPassword());
+                sourceOptions.setRemoteCipherUrl(cipherConfig.getUrl(), cipherConfig.getPassword(), cipherConfig.getUserAgent());
             }
         }
 

plugin/src/main/java/dev/lavalink/youtube/plugin/YoutubeRemoteCipherConfig.java

@@ -3,6 +3,7 @@
 public class YoutubeRemoteCipherConfig {
     private String url;
     private String password;
+    private String userAgent = "yt-source";
 
     public String getUrl() {
         return url;
@@ -12,6 +13,10 @@ public String getPassword() {
         return password;
     }
 
+    public String getUserAgent() {
+        return userAgent;
+    }
+
     public void setUrl(String url) {
         this.url = url;
     }
@@ -20,4 +25,8 @@ public void setPassword(String password) {
         this.password = password;
     }
 
+    public void setUserAgent(String userAgent) {
+        this.userAgent = userAgent;
+    }
+
 }