DoH API Client Flutter Package

A Flutter package that provides an API client using the DNS over HTTPS (DoH) protocol, implemented with native code for optimal performance. This package allows you to perform HTTP requests securely over DNS using various DoH providers.

Features

Perform HTTP requests (GET, POST, PUT, PATCH, DELETE) using the DoH protocol.
Support for 12 different DoH providers.
Easy integration with Flutter projects.
Native implementation for improved performance (using OKHTTP on Android and URLSession on iOS).

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  doh_api_client: ^1.1.0

Then run:

flutter pub get

Aditional Setup

Android

Add Required Permissions

Open your AndroidManifest.xml file and ensure the following permission is added:

<uses-permission android:name="android.permission.INTERNET"/>

Modify build.gradle

android {
    ...
    buildTypes {
        release {
            // Add ProGuard rules for DoH API Client
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

Add ProGuard Rules

Create or update the proguard-rules.pro file in your android/app directory with the following rules:

-keep class com.android.org.conscrypt.** { *; }
-keep class org.apache.harmony.xnet.provider.jsse.** { *; }
-dontwarn com.android.org.conscrypt.SSLParametersImpl
-dontwarn org.apache.harmony.xnet.provider.jsse.SSLParametersImpl

iOS

No additional setup is required for iOS. The package uses URLSession for native DoH requests.

Usage

First, import the package in your Dart file:

import 'package:doh_api_client/doh_api_client.dart';

Making API Requests

Here's an example of how to make a POST request using the DoH API client:

final _dohApiClientPlugin = DohApiClient();

try {
  Map<String, dynamic>? apiPostRequest = await _dohApiClientPlugin.post(
    url: "https://jsonplaceholder.typicode.com/posts",
    headers: {
      "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36",
      'Content-type': 'application/json; charset=UTF-8'
    },
    body: jsonEncode({
      "title": 'foo',
      "body": 'bar',
      "userId": 1,
    }),
    dohProvider: DohProvider.CloudFlare
  );
  print(apiPostRequest);
} catch (e) {
  print("Error occurred: $e");
}

Available DoH Providers

The package supports the following DoH providers:

CloudFlare
Google
AdGuard
Quad9
AliDNS
DNSPod
threeSixty
Quad101
Mullvad
ControlD
Najalla
SheCan

You can specify the DoH provider using the DohProvider enum when making requests.

API Reference

DohApiClient

The main class for making API requests.

Methods:

Future<DohResponse?> get({required String url, Map<String, String>? headers, DohProvider dohProvider})
Future<DohResponse?> post({required String url, Map<String, String>? headers, required String body, DohProvider dohProvider})
Future<DohResponse?> put({required String url, Map<String, String>? headers, required String body, DohProvider dohProvider})
Future<DohResponse?> patch({required String url, Map<String, String>? headers, required String body, DohProvider dohProvider})
Future<DohResponse?> delete({required String url, Map<String, String>? headers, DohProvider dohProvider})

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.