Merge branch 'release/2.11.0'

Author: kameleo-team

README.md

@@ -178,6 +178,42 @@ await page.GotoAsync("https://google.com");
 
 The full example can be found [here](https://github.com/kameleo-io/local-api-examples/blob/master/dotnet-csharp/connect_with_playwright_to_firefox/Program.cs).
 
+# Automate mobile profiles
+Kameleo can emulate mobile devices in the custom built Chromium.
+
+```csharp
+var baseProfileList = await client.SearchBaseProfilesAsync(
+	"mobile",
+	"ios",
+	"safari",
+	"en-us");
+
+// Create a new profile with recommended settings
+// Choose one of the Base Profiles
+// Set the launcher to 'chromium' so the mobile profile will be started in Chromium by Kameleo
+var createProfileRequest = BuilderForCreateProfile
+	.ForBaseProfile(baseProfileList[0].Id)
+	.SetRecommendedDefaults()
+	.SetLauncher("chromium")
+	.Build();
+
+var profile = await client.CreateProfileAsync(createProfileRequest);
+
+// Start the profile with a couple of extra parameters, so Selenium automation can be done fluently
+await client.StartProfileWithWebDriverSettingsAsync(profile.Id, new WebDriverSettings()
+{
+	AdditionalOptions = new List<Preference>
+	{
+		// This allows you to click on elements using the cursor when emulating a touch screen in the brower.
+		// If you leave this out, your script may time out after clicks and fail.
+		new Preference("disableTouchEmulation", true),
+	}
+});
+
+// At this point you can automate the browser with your favorite framework
+```
+The full example can be found [here](https://github.com/kameleo-io/local-api-examples/blob/master/dotnet-csharp/automate_mobile_profiles_on_desktop/Program.cs).
+
 # Example codes
 [Several examples](https://github.com/kameleo-io/local-api-examples) have been prepared in a different repository to showcase the most interesting features. Feel free to create a pull request to add new example codes.
 
@@ -188,10 +224,14 @@ The full example can be found [here](https://github.com/kameleo-io/local-api-exa
 - Using Selenium with Local API
 - Using Playwright with Kameleo
 - Using Puppeteer with Kameleo
+- How to emulate mobile devices
 - Adding an HTTP, SOCKS or SSH proxy to profile
 - Saving/Loading a browsing session to/from a .kameleo file
 - Modify and Delete browser cookies
 - Start profile with extra WebDriver capabilities
+- How to duplicate virtual browser profiles
+- Test proxies
+- Refresh the browser of the emulated profiles
 
 > Note: _If you are interested in more information about Kameleo, or have encountered an issue with using it, please check out our [Help Center](https://help.kameleo.io/)._
 

docs/swagger.json

@@ -729,7 +729,7 @@
       }
     },
     "/profiles/{guid}/duplicate": {
-      "post": {
+      "get": {
         "tags": [
           "Profile"
         ],
@@ -803,7 +803,7 @@
       }
     },
     "/profiles/{guid}/upgrade": {
-      "post": {
+      "get": {
         "tags": [
           "Profile"
         ],
@@ -865,7 +865,8 @@
         "os",
         "plugins",
         "resolution",
-        "version"
+        "version",
+        "webglMeta"
       ],
       "type": "object",
       "properties": {
@@ -918,6 +919,9 @@
             "internal-pdf-viewer",
             "internal-nacl-plugin"
           ]
+        },
+        "webglMeta": {
+          "$ref": "#/definitions/WebglMeta"
         }
       }
     },
@@ -1095,19 +1099,16 @@
           "format": "int64",
           "description": "This unix timestamp formatted attribute is used to set persistent cookies. It signifies how long the browser should use the persistent cookie and when the cookie should be deleted.\r\nIf this attribute is not specified, then the lifetime of the cookie is the same as that of browser session, i.e.it will be a non-persistent cookie.",
           "type": "integer",
-          "readOnly": true,
           "example": 1568986993
         },
         "session": {
           "description": "Session cookies are deleted when the current session ends. The browser defines when the \"current session\" ends, and some browsers use session restoring when restarting, which can cause session cookies to last indefinitely long.",
           "type": "boolean",
-          "readOnly": true,
           "example": false
         },
         "storeId": {
           "description": "The ID of the cookie store containing this cookie.",
           "type": "string",
-          "readOnly": true,
           "example": "0"
         }
       }
@@ -1133,6 +1134,7 @@
       "properties": {
         "domain": {
           "description": "The domain attribute signifies the domain for which the cookie is valid and can be submitted with every request for this domain or its subdomains. If this attribute is not specified, then the hostname of the originating server is used as the default value.",
+          "minLength": 1,
           "type": "string",
           "example": ".google.com"
         },
@@ -1143,6 +1145,7 @@
         },
         "path": {
           "description": "The path attribute indicates a URL path that must exist in the requested URL in order to send the Cookie header. The %x2F (\"/\") character is considered a directory separator, and subdirectories match as well.",
+          "minLength": 1,
           "type": "string",
           "example": "/gmail/about"
         },
@@ -1192,12 +1195,14 @@
         "screen",
         "timezone",
         "webgl",
+        "webglMeta",
         "webRtc"
       ],
       "type": "object",
       "properties": {
         "baseProfileId": {
           "description": "The unique identifier of the base profile. This references the base profile which should be used to build the new profile.",
+          "minLength": 1,
           "type": "string",
           "example": "555b894595b5cd242ead1533218a5ee93dd7c7ebfbff4dccb80fdb112f6cda27"
         },
@@ -1220,7 +1225,10 @@
           "$ref": "#/definitions/CanvasSpoofingType"
         },
         "webgl": {
-          "$ref": "#/definitions/WebglSpoofingTypeWebglSpoofingOptionsMultiLevelChoice"
+          "$ref": "#/definitions/WebglSpoofingType"
+        },
+        "webglMeta": {
+          "$ref": "#/definitions/WebglMetaSpoofingTypeWebglMetaSpoofingOptionsMultiLevelChoice"
         },
         "audio": {
           "$ref": "#/definitions/AudioSpoofingType"
@@ -1288,7 +1296,6 @@
         "name": {
           "description": "Name of the device. This is only available for mobile profiles.",
           "type": "string",
-          "readOnly": true,
           "example": "Samsung SM-A705FN"
         }
       }
@@ -1374,6 +1381,7 @@
       "properties": {
         "path": {
           "description": "The path where the profile should be loaded from",
+          "minLength": 1,
           "type": "string"
         }
       }
@@ -1461,8 +1469,7 @@
       "properties": {
         "code": {
           "format": "int32",
-          "type": "integer",
-          "readOnly": true
+          "type": "integer"
         },
         "error": {
           "type": "object",
@@ -1592,6 +1599,7 @@
         "tags",
         "timezone",
         "webgl",
+        "webglMeta",
         "webRtc"
       ],
       "type": "object",
@@ -1635,7 +1643,10 @@
           "$ref": "#/definitions/CanvasSpoofingType"
         },
         "webgl": {
-          "$ref": "#/definitions/WebglSpoofingTypeWebglSpoofingOptionsMultiLevelChoice"
+          "$ref": "#/definitions/WebglSpoofingType"
+        },
+        "webglMeta": {
+          "$ref": "#/definitions/WebglMetaSpoofingTypeWebglMetaSpoofingOptionsMultiLevelChoice"
         },
         "audio": {
           "$ref": "#/definitions/AudioSpoofingType"
@@ -1724,6 +1735,7 @@
       "properties": {
         "path": {
           "description": "The path where the profile should be saved.",
+          "minLength": 1,
           "type": "string"
         }
       }
@@ -1877,6 +1889,7 @@
         "startPage",
         "timezone",
         "webgl",
+        "webglMeta",
         "webRtc"
       ],
       "type": "object",
@@ -1885,7 +1898,10 @@
           "$ref": "#/definitions/CanvasSpoofingType"
         },
         "webgl": {
-          "$ref": "#/definitions/WebglSpoofingTypeWebglSpoofingOptionsMultiLevelChoice"
+          "$ref": "#/definitions/WebglSpoofingType"
+        },
+        "webglMeta": {
+          "$ref": "#/definitions/WebglMetaSpoofingTypeWebglMetaSpoofingOptionsMultiLevelChoice"
         },
         "audio": {
           "$ref": "#/definitions/AudioSpoofingType"
@@ -1934,6 +1950,7 @@
         },
         "name": {
           "description": "Profile name property. The value obtained by file name for existing profiles. For new profiles the value is generated by a random name generator.",
+          "minLength": 1,
           "type": "string"
         },
         "tags": {
@@ -2082,8 +2099,26 @@
         }
       }
     },
-    "WebglSpoofingOptions": {
-      "description": "When the WebGL spoofing is set to noise these extra settings can be used to ovveride the values in the base profile.",
+    "WebglMeta": {
+      "required": [
+        "vendor"
+      ],
+      "type": "object",
+      "properties": {
+        "vendor": {
+          "description": "The UnmaskedVendor field from WebGL context",
+          "type": "string",
+          "example": "Google Inc. (AMD)"
+        },
+        "renderer": {
+          "description": "The UnmaskedRenderer field from WebGL context",
+          "type": "string",
+          "example": "ANGLE (AMD, AMD Radeon(TM) RX Vega 11 Graphics Direct3D11 vs_5_0 ps_5_0, D3D11)"
+        }
+      }
+    },
+    "WebglMetaSpoofingOptions": {
+      "description": "When the WebGL Meta spoofing is used, these settings can override the values in the base profile.",
       "type": "object",
       "properties": {
         "vendor": {
@@ -2098,28 +2133,37 @@
         }
       }
     },
-    "WebglSpoofingType": {
-      "description": "Tells the mode how the WebGL will be spoofed. Possible values:\r\n'noise': Add some noise to the WebGL generation\r\n'block': Completely block the 3D API\r\n'off': Turn off the spoofing, use the original settings",
+    "WebglMetaSpoofingType": {
+      "description": "Tells the mode how the WebGL vendor and renderer will be spoofed. Possible values:\r\n'automatic': The vendor and renderer values comes from the base profile.\r\n'manual': Manually set the vendor and renderer values.\r\n'off': Turn off the spoofing, use the original settings",
       "enum": [
-        "noise",
-        "block",
+        "automatic",
+        "manual",
         "off"
       ],
       "type": "string"
     },
-    "WebglSpoofingTypeWebglSpoofingOptionsMultiLevelChoice": {
+    "WebglMetaSpoofingTypeWebglMetaSpoofingOptionsMultiLevelChoice": {
       "required": [
         "value"
       ],
       "type": "object",
       "properties": {
         "value": {
-          "$ref": "#/definitions/WebglSpoofingType"
+          "$ref": "#/definitions/WebglMetaSpoofingType"
         },
         "extra": {
-          "$ref": "#/definitions/WebglSpoofingOptions"
+          "$ref": "#/definitions/WebglMetaSpoofingOptions"
         }
       }
+    },
+    "WebglSpoofingType": {
+      "description": "Tells the mode how the WebGL will be spoofed. Possible values:\r\n'noise': Add some noise to the WebGL generation\r\n'block': Completely block the 3D API\r\n'off': Turn off the spoofing, use the original settings",
+      "enum": [
+        "noise",
+        "block",
+        "off"
+      ],
+      "type": "string"
     }
   }
 }

src/BuilderForCreateProfile.cs

@@ -76,10 +76,26 @@ public BuilderForCreateProfile SetCanvas(string value)
         /// <para>'off': Turn off the spoofing, use the original settings</para>
         /// </summary>
         /// <param name="value">Values can be: 'noise', 'block', 'off'</param>
-        public BuilderForCreateProfile SetWebgl(string value, WebglSpoofingOptions options = null)
+        public BuilderForCreateProfile SetWebgl(string value)
         {
-            _profileRequest.Webgl.Value = value;
-            _profileRequest.Webgl.Extra = options;
+            _profileRequest.Webgl = value;
+
+            return this;
+        }
+        
+        /// <summary>
+        /// <para>Tells the mode how the WebGL vendor and renderer will be spoofed. Possible values:</para>
+        /// <para>'automatic': The vendor and renderer values comes from the base profile.</para>
+        /// <para>'manual': Manually set the vendor and renderer values.</para>
+        /// <para>'off': Turn off the spoofing, use the original settings.</para>
+        /// </summary>
+        /// <param name="value">Values can be: 'automatic', 'manual', 'off'</param>
+        /// <param name="options">When the WebglMeta spoofing is set to manual the webgl gpu vendor and renderer is required. For example:
+        /// Google Inc. (NVIDIA)/ANGLE (NVIDIA, NVIDIA GeForce GTX 1050 Ti Direct3D11 vs_5_0 ps_5_0, D3D11)</param>
+        public BuilderForCreateProfile SetWebglMeta(string value, WebglMetaSpoofingOptions options = null)
+        {
+            _profileRequest.WebglMeta.Value = value;
+            _profileRequest.WebglMeta.Extra = options;
 
             return this;
         }
@@ -283,7 +299,8 @@ public BuilderForCreateProfile SetRecommendedDefaults()
         {
             _profileRequest.Name = "";
             _profileRequest.Canvas = "intelligent";
-            _profileRequest.Webgl.Value = "off";
+            _profileRequest.Webgl = "off";
+            _profileRequest.WebglMeta.Value = "automatic";
             _profileRequest.Audio = "off";
             _profileRequest.Timezone.Value = "automatic";
             _profileRequest.Geolocation.Value = "automatic";
@@ -302,7 +319,8 @@ private static CreateProfileRequest Reset(string baseProfileId)
             {
                 BaseProfileId = baseProfileId,
                 Canvas = "off",
-                Webgl = new WebglSpoofingTypeWebglSpoofingOptionsMultiLevelChoice("off"),
+                Webgl = "off",
+                WebglMeta = new WebglMetaSpoofingTypeWebglMetaSpoofingOptionsMultiLevelChoice("off"),
                 Audio = "off",
                 Timezone = new TimezoneSpoofingTypeTimezoneMultiLevelChoice("off"),
                 Geolocation = new GeolocationSpoofingTypeGeolocationSpoofingOptionsMultiLevelChoice("off"),

src/Kameleo.LocalApiClient.csproj

@@ -4,8 +4,8 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Kameleo Team</Authors>
     <Company>Kameleo</Company>
-    <PackageTags>kameleo; stealth browsing platform; selenium; webdriver; browser automation; web scraping; puppeteer; headless; chrome; firefox; chromium; edge</PackageTags>
-    <Version>2.10.0</Version>
+    <PackageTags>kameleo; stealth browsing platform; anti-detect browser; selenium; webdriver; browser automation; web scraping; puppeteer; playwright; headless; chrome; firefox; chromium; edge</PackageTags>
+    <Version>2.11.0</Version>
     <Description>This .NET Standard package provides convenient access to the Local API REST interface of the Kameleo Client.</Description>
     <PackageProjectUrl>https://kameleo.io</PackageProjectUrl>
     <RepositoryUrl>https://github.com/kameleo-io/local-api-client-csharp</RepositoryUrl>

src/KameleoLocalApiClient.cs

@@ -2783,7 +2783,7 @@ private void Initialize()
             // Create HTTP transport objects
             var _httpRequest = new HttpRequestMessage();
             HttpResponseMessage _httpResponse = null;
-            _httpRequest.Method = new HttpMethod("POST");
+            _httpRequest.Method = new HttpMethod("GET");
             _httpRequest.RequestUri = new System.Uri(_url);
             // Set Headers
 
@@ -3058,7 +3058,7 @@ private void Initialize()
             // Create HTTP transport objects
             var _httpRequest = new HttpRequestMessage();
             HttpResponseMessage _httpResponse = null;
-            _httpRequest.Method = new HttpMethod("POST");
+            _httpRequest.Method = new HttpMethod("GET");
             _httpRequest.RequestUri = new System.Uri(_url);
             // Set Headers