Netcraft 1.0.1

Netcraft

An async and lightweight C# library for interacting with the Netcraft API.

Usage

Provides an easy interface for interacting with the Netcraft API.

Most importantly, this package allows you to automate the process of reporting malicious URLs and emails to Netcraft.

To get started, add the library into your solution with either the NuGet Package Manager or the dotnet CLI.

dotnet add package Netcraft

For the primary classes to become available, import one or more of the used namespaces.

using Netcraft;
using Netcraft.Modules;
using Netcraft.Entities;

Need more examples? Under the Example directory you can find a working demo project that implements this library.

Features

• Built for .NET 6 and .NET 7
• Fully async
• Extensive XML documentation
• No external dependencies (uses integrated HTTP and JSON)
• Custom exceptions (NetcraftException) for advanced catching
• Report malicious URLs, emails and files
• Get submission results and data

Code Samples

Initializing a new API client

NetcraftClient client = new();

Reporting malicious URLs

string uuid = await client.Report.Urls(email, "Phishing against the Turkish Government.", new UrlReportParmeters[]
{
    new()
    {
        Value = "http://basvuruedevletmobilden.ml/",
        Country = "US"
    }
});

Getting submission details

Submission submission = await client.Submission.GetSubmissionDetails(uuid);

Getting the leaderboard

LeaderboardEntry[] entries = await client.Misc.GetLeaderboard();

Available Methods

Report

• Task<string> Urls(string email, string reason, UrlReportParmeters[] urls, string source = null, bool? noSubmission = false)
• Task<string> Urls(UrlsReportParameters parameters)
• Task<string> Email(EmailReportParameters parameters)
• Task Mistake(MistakeReportParameters parameters)

Submission

• Task ReportSubmissionIssue(string uuid, SubmissionIssueParameters parameters)
• Task SendIssueMessage(string uuid, string message)
• Task<CryptocurrencyAddress[]> GetSubmissionCryptocurrencyAddresses( string uuid, int count = 100, string addressFilter = null, string cryptocurrencyFilter = null, string sortProperty = null, Direction direction = Direction.Ascending)
• Task<FileAnalysisUrl[]> GetFileAnalysisUrls(string uuid, string fileHash)
• Task<FileMalwareFamily[]> GetFileMalwareFamilies(string uuid, string fileHash)
• Task<FilePhoneNumber[]> GetFilePhoneNumbers(string uuid, string fileHash)
• Task<FileUrl[]> GetFileUrls(string uuid, string fileHash)
• Task<Issue[]> GetSubmissionIssues(string uuid)
• Task<Stream> GetEmailScreenshot(string uuid)
• Task<Stream> GetFileScreenshot(string uuid, string fileHash)
• Task<Stream> GetUrlScreenshot(string submissionUUID, string urlUUID, string screenshotHash)
• Task<Submission> GetSubmissionDetails(string uuid)
• Task<SubmissionEmail> GetSubmissionEmail(string uuid)
• Task<SubmissionFile[]> GetSubmissionFiles( string uuid, int count = 100, State? stateFilter = null, string hashFilter = null, string nameFilter = null, FileSort sort = FileSort.FileName)
• Task<SubmissionPhoneNumber[]> GetSubmissionPhoneNumbers(string uuid)
• Task<SubmissionUrl[]> GetSubmissionUrls( string uuid, int count = 100, string urlFilter = null, State? urlStateFilter = null, State? urlTakedownStateFilter = null, Direction direction = Direction.Ascending)

Misc

• Task<LeaderboardEntry[]> GetLeaderboard()

References

• https://www.netcraft.com/
• https://en.wikipedia.org/wiki/Netcraft

This is a community-ran library. Not affiliated with Netcraft Ltd.