Version 1.3.5

- Added .NET 7 as a supported target framework
- Improved the CSPROJ and README files
- Other minor changes

Author: akacdev

Example/Example.csproj

@@ -2,11 +2,11 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\Urlscan\Urlscan.csproj" />
   </ItemGroup>
 
-</Project>
+</Project>

README.md

@@ -9,18 +9,31 @@
 </div>
 
 ## Usage
-Available on NuGet as `Urlscan`, methods can be found under the classes `UrlscanClient` and `LiveClient`.<br>
-https://www.nuget.org/packages/Urlscan
+Provides an easy interface for interacting with the Urlscan API.
+
+You can use this library to automate your Urlscan submissions, search for existing scans, track newly submitted scans and analyse network activity of malicious websites.
+
+To get started, add the library into your solution with either the `NuGet Package Manager` or the `dotnet` CLI.
+```rust
+dotnet add package Urlscan
+```
+
+For the primary classes to become available, import the used namespace.
+```csharp
+using Urlscan;
+```
+
+Need more examples? Under the `Example` directory you can find a working demo project that implements this library.
 
 ### Obtaining API keys
 > API keys can be created in the user section `Settings & API`
 
 > Secure identifier SID cookies can be obtained from your browser's cookie storage. Make sure to only copy the value, without the name! 
 
 ## Features
-- Made with **.NET 6**
+- Built for **.NET 6** and **.NET 7**
 - Fully **async**
-- Extensive **documentation**
+- Extensive **XML documentation**
 - Coverage of the free API endpoints, including some user-only and beta routes  
 - **No external dependencies** (uses integrated HTTP and JSON)
 - **Custom exceptions** (`UrlscanException`) for advanced catching
@@ -30,9 +43,6 @@ https://www.nuget.org/packages/Urlscan
 - Download screenshots and page DOMs
 - Empower your threat intelligence with live scans through `LiveClient`
 
-## Example
-Under the `Example` directory you can find a working demo project that implements this library.
-
 ## Code Samples
 
 ### Initializing a new API client
@@ -116,13 +126,13 @@ await client.AddVerdict(new VerdictParameters()
 - Task\<Stream> **LiveshotStream**(string url, int width = 1280, int height = 1024)
 - Task\<string> **DownloadDOM**(Result result)
 - Task\<string> **DownloadDOM**(string uuid)
-- Task\<Submission> **Scan**( string url, string[] tags = null, string userAgent = null, string referer = null, bool overrideSafety = false, Visibility visibility = Visibility.Public, ScanCountry country = ScanCountry.Auto )
+- Task\<Submission> **Scan**(string url, string[] tags = null, string userAgent = null, string referer = null, bool overrideSafety = false, Visibility visibility = Visibility.Public, ScanCountry country = ScanCountry.Auto)
 - Task\<Submission> **Scan**(ScanParameters parameters)
 - Task\<User> **GetCurrentUser**()
 
 ## Available Events
 - EventHandler\<LiveScan> `UrlScanned`
 
-## Official Links
-https://urlscan.io</br>
-https://twitter.com/urlscanio
+## References
+- https://urlscan.io
+- https://twitter.com/urlscanio

Urlscan/API.cs

@@ -1,4 +1,5 @@
 using System;
+using System.IO;
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -52,7 +53,7 @@ public static async Task<HttpResponseMessage> Request
 
             while (retries < MaxRetries)
             {
-                HttpRequestMessage req = new(method, absoluteUrl ? url : $"api/v{UrlscanClient.Version}/{url}")
+                HttpRequestMessage req = new(method, absoluteUrl ? url : $"api/v{Constants.Version}/{url}")
                 {
                     Content = content
                 };
@@ -123,16 +124,19 @@ public static async Task<HttpResponseMessage> Request
 
         public static async Task<T> Deseralize<T>(this HttpResponseMessage res, JsonSerializerOptions options = null)
         {
-            string json = await res.Content.ReadAsStringAsync();
-            if (string.IsNullOrEmpty(json)) throw new UrlscanException("Response content is empty, can't parse as JSON.");
+            Stream stream = await res.Content.ReadAsStreamAsync();
+            if (stream.Length == 0) throw new UrlscanException("Response content is empty, can't parse as JSON.");
 
             try
             {
-                return JsonSerializer.Deserialize<T>(json, options ?? Constants.JsonOptions);
+                return await JsonSerializer.DeserializeAsync<T>(stream, options ?? Constants.JsonOptions);
             }
             catch (Exception ex)
             {
-                throw new($"Exception while parsing JSON: {ex.GetType().Name} => {ex.Message}\nJSON preview: {json[..Math.Min(json.Length, PreviewMaxLength)]}");
+                using StreamReader sr = new(stream);
+                string text = await sr.ReadToEndAsync();
+
+                throw new($"Exception while parsing JSON: {ex.GetType().Name} => {ex.Message}\nPreview: {text[..Math.Min(text.Length, PreviewMaxLength)]}");
             }
         }
     }

Urlscan/Constants.cs

@@ -1,13 +1,24 @@
-using System.Text.Json;
+using System;
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Urlscan
 {
     internal class Constants
     {
+        /// <summary>
+        /// The API version to use when communicating.
+        /// </summary>
+        public const int Version = 1;
+
+        public static readonly Version HttpVersion = new(2, 0);
+        public static readonly TimeSpan Timeout = TimeSpan.FromSeconds(30);
+
+        public const string UserAgent = "Urlscan C# Client - actually-akac/Urlscan";
         public const string JsonContentType = "application/json";
-        public static readonly string HtmlContentType = "text/html";
+        public const string HtmlContentType = "text/html";
         public const int ErrorStatusCode = 500;
+
         public const string SuccessSubmissionMessage = "Submission successful";
 
         public static readonly JsonSerializerOptions JsonOptions = new()

Urlscan/Extensions.cs

@@ -6,14 +6,10 @@ namespace Urlscan
     internal static class Extensions
     {
         public static DateTime ToDate(this long value)
-        {
-            return DateTime.UnixEpoch.AddSeconds(value);
-        }
+            => DateTime.UnixEpoch.AddSeconds(value);
 
         public static long ToUnixSeconds(this DateTime value)
-        {
-            return (long)(value - DateTime.UnixEpoch).TotalSeconds;
-        }
+            => (long)(value - DateTime.UnixEpoch).TotalSeconds;
 
         public static string ToKebabCase(this string str) =>
             string.Concat(str.Select((x, i) => i > 0 && char.IsUpper(x) ? "-" + x.ToString() : x.ToString())).ToLower();

Urlscan/Live.cs

@@ -15,12 +15,17 @@ namespace Urlscan
     /// </summary>
     public class LiveClient
     {
-        private readonly HttpClientHandler HttpHandler = new()
+        private static readonly HttpClientHandler HttpHandler = new()
         {
             AutomaticDecompression = DecompressionMethods.All
         };
 
-        private readonly HttpClient Client;
+        private readonly HttpClient Client = new(HttpHandler)
+        {
+            BaseAddress = UrlscanClient.BaseUri,
+            Timeout = Constants.Timeout,
+            DefaultRequestVersion = Constants.HttpVersion
+        };
 
         private EventHandler<LiveScan> Handler;
         public event EventHandler<LiveScan> UrlScanned
@@ -51,15 +56,9 @@ public LiveClient(int interval = 30000, int size = 100)
             if (size <= 0) throw new ArgumentOutOfRangeException(nameof(size), "Poll size has to be at least 1.");
 
             Interval = interval;
-            Size = size;
 
+            Size = size;
             Seen = new(Size);
-            Client = new(HttpHandler)
-            {
-                BaseAddress = UrlscanClient.BaseUri,
-                Timeout = UrlscanClient.Timeout,
-                DefaultRequestVersion = UrlscanClient.HttpVersion
-            };
 
             Client.DefaultRequestHeaders.AcceptEncoding.ParseAdd("gzip, deflate, br");
             Client.DefaultRequestHeaders.UserAgent.ParseAdd("Urlscan C# Live Client - actually-akac/Urlscan");

Urlscan/README_NuGet.md

@@ -5,19 +5,31 @@
 🔎 An async and lightweight C# library for interacting with the Urlscan API.
 
 ## Usage
-Available on NuGet as `Urlscan`, methods can be found under the classes `UrlscanClient` and `LiveClient`.
+Provides an easy interface for interacting with the Urlscan API.
 
-https://www.nuget.org/packages/Urlscan
+You can use this library to automate your Urlscan submissions, search for existing scans, track newly submitted scans and analyse network activity of malicious websites.
+
+To get started, add the library into your solution with either the `NuGet Package Manager` or the `dotnet` CLI.
+```rust
+dotnet add package Urlscan
+```
+
+For the primary classes to become available, import the used namespace.
+```csharp
+using Urlscan;
+```
+
+Need more examples? Under the `Example` directory you can find a working demo project that implements this library.
 
 ### Obtaining API keys
 > API keys can be created in the user section `Settings & API`
 
 > Secure identifier SID cookies can be obtained from your browser's cookie storage. Make sure to only copy the value, without the name! 
 
 ## Features
-- Made with **.NET 6**
+- Built for **.NET 6** and **.NET 7**
 - Fully **async**
-- Extensive **documentation**
+- Extensive **XML documentation**
 - Coverage of the free API endpoints, including some user-only and beta routes  
 - **No external dependencies** (uses integrated HTTP and JSON)
 - **Custom exceptions** (`UrlscanException`) for advanced catching
@@ -27,9 +39,6 @@ https://www.nuget.org/packages/Urlscan
 - Download screenshots and page DOMs
 - Empower your threat intelligence with live scans through `LiveClient`
 
-## Example
-Under the `Example` directory you can find a working demo project that implements this library.
-
 ## Code Samples
 
 ### Initializing a new API client
@@ -113,14 +122,13 @@ await client.AddVerdict(new VerdictParameters()
 - Task\<Stream> **LiveshotStream**(string url, int width = 1280, int height = 1024)
 - Task\<string> **DownloadDOM**(Result result)
 - Task\<string> **DownloadDOM**(string uuid)
-- Task\<Submission> **Scan**( string url, string[] tags = null, string userAgent = null, string referer = null, bool overrideSafety = false, Visibility visibility = Visibility.Public, ScanCountry country = ScanCountry.Auto )
+- Task\<Submission> **Scan**(string url, string[] tags = null, string userAgent = null, string referer = null, bool overrideSafety = false, Visibility visibility = Visibility.Public, ScanCountry country = ScanCountry.Auto)
 - Task\<Submission> **Scan**(ScanParameters parameters)
 - Task\<User> **GetCurrentUser**()
 
 ## Available Events
 - EventHandler\<LiveScan> `UrlScanned`
 
-## Official Links
-https://urlscan.io
-
-https://twitter.com/urlscanio
+## References
+- https://urlscan.io
+- https://twitter.com/urlscanio

Urlscan/Urlscan.cs

@@ -15,42 +15,26 @@ namespace Urlscan
     /// </summary>
     public class UrlscanClient
     {
-        /// <summary>
-        /// The API version to use when communicating.
-        /// </summary>
-        public const int Version = 1;
-
-        /// <summary>
-        /// The base URL to use when communicating.
-        /// </summary>
-        public const string BaseUrl = "https://urlscan.io/";
-
         /// <summary>
         /// The base URI to use when communicating.
         /// </summary>
-        public static readonly Uri BaseUri = new(BaseUrl);
-
-        /// <summary>
-        /// The HTTP request version to use when communicating.
-        /// </summary>s
-        public static readonly Version HttpVersion = new(2, 0);
-
-        /// <summary>
-        /// The maximum duration to wait for a response from the server.
-        /// </summary>
-        public static readonly TimeSpan Timeout = TimeSpan.FromSeconds(30);
-
+        public static readonly Uri BaseUri = new("https://urlscan.io/");
         /// <summary>
         /// How many times result polling should be retried.
         /// </summary>
         private const int MaxPollingRetries = 20;
 
-        private readonly HttpClientHandler HttpHandler = new()
+        private static readonly HttpClientHandler HttpHandler = new()
         {
             AutomaticDecompression = DecompressionMethods.All
         };
 
-        private readonly HttpClient Client;
+        private readonly HttpClient Client = new(HttpHandler)
+        {
+            BaseAddress = BaseUri,
+            DefaultRequestVersion = Constants.HttpVersion,
+            Timeout = Constants.Timeout,
+        };
 
         private readonly string Key;
         private readonly string Sid;
@@ -71,15 +55,8 @@ public UrlscanClient(string key, string sid = null)
             Sid = sid;
             UsesAccountSID = sid is not null;
 
-            Client = new(HttpHandler)
-            {
-                BaseAddress = BaseUri,
-                DefaultRequestVersion = HttpVersion,
-                Timeout = Timeout
-            };
-
             Client.DefaultRequestHeaders.AcceptEncoding.ParseAdd("gzip, deflate, br");
-            Client.DefaultRequestHeaders.UserAgent.ParseAdd("Urlscan C# Client - actually-akac/Urlscan");
+            Client.DefaultRequestHeaders.UserAgent.ParseAdd(Constants.UserAgent);
             Client.DefaultRequestHeaders.Accept.ParseAdd("application/json");
             Client.DefaultRequestHeaders.Add("API-Key", Key);
         }

Urlscan/Urlscan.csproj

@@ -1,24 +1,37 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <!--Basic Information-->
+    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
     <PackageId>Urlscan</PackageId>
     <Product>Urlscan</Product>
-    <Version>1.3.4</Version>
-    <AssemblyVersion>1.3.4</AssemblyVersion>
-    <FileVersion>1.3.4</FileVersion>
     <Authors>akac</Authors>
     <Company>akac</Company>
     <Description>An async and lightweight C# library for interacting with the Urlscan API.</Description>
     <PackageTags>urlscan; url-scan; url; scan; ioc; ip; domain; screenshot; phishing; malware; link; suspicious; check</PackageTags>
+    <PackageIcon>icon.png</PackageIcon>
+    <PackageReadmeFile>README_NuGet.md</PackageReadmeFile>
+
+    <!--Version-->
+    <Version>1.3.5</Version>
+    <AssemblyVersion>1.3.5</AssemblyVersion>
+    <FileVersion>1.3.5</FileVersion>
+
+    <!--Github-->
     <PackageProjectUrl>https://github.com/actually-akac/Urlscan</PackageProjectUrl>
     <RepositoryUrl>https://github.com/actually-akac/Urlscan</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+
+    <!--Compiler Options-->
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
+    <!--Miscellaneous-->
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageIcon>icon.png</PackageIcon>
+    <RequireLicenseAcceptance>false</RequireLicenseAcceptance>
     <NeutralLanguage>en</NeutralLanguage>
-    <PackageReadmeFile>README_NuGet.md</PackageReadmeFile>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
@@ -30,11 +43,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Update="icon.png">
+    <None Include="icon.png">
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>
-    <None Update="README_NuGet.md">
+    <None Include="README_NuGet.md">
       <Pack>True</Pack>
       <PackagePath>\</PackagePath>
     </None>