https://github.com/mayuki/Yafp

A toolkit for implementing forward proxy based on ASP.NET Core and YARP.
https://github.com/mayuki/Yafp

Last synced: about 2 months ago
JSON representation

A toolkit for implementing forward proxy based on ASP.NET Core and YARP.

• Host: GitHub
• URL: https://github.com/mayuki/Yafp
• Owner: mayuki
• License: mit
• Created: 2024-03-20T12:33:52.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-18T05:06:26.000Z (8 months ago)
• Last Synced: 2024-10-27T22:06:20.224Z (about 2 months ago)
• Language: C#
• Homepage:
• Size: 1.46 MB
• Stars: 20
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - mayuki/Yafp - A toolkit for implementing forward proxy based on ASP.NET Core and YARP. (C\#)

README

        
# Yafp - Yet Another Forward Proxy

A toolkit for implementing forward proxy based on ASP.NET Core and YARP.

It can be used to implement custom local proxies. For example, it is possible to create something like Fiddler.

> [!IMPORTANT]

> **This project is a PoC and is not recommended for production use**, but it works well for hobby use with customization.

> It can be used as a replacement for Titanium Web Proxy, etc.

## Architecture

![](docs/image-01.jpg)

Yafp receives CONNECT requests not supported by ASP.NET Core instead and forwards them to ASP.NET Core + YARP using Unix Domain Socket or Named Pipe.

Yafp can read and modify the content of HTTPS communications with clients by dynamically issuing server certificates.

## Demo (Blazor + Yafp)

## Quick start

Install Yafp package from NuGet.

```bash

dotnet add package Yafp

```

Next, create an empty Web Application (ASP.NET Core Empty) project and modify Program.cs as follows:

```csharp

using Yafp;

var builder = WebApplication.CreateBuilder(args);

// Add: Register Yafp services

builder.WebHost.UseYafpForwardProxy();

var app = builder.Build();

// Add: Use forward proxy middleware

app.MapForwardProxy();

app.MapGet("/", () => "Hello World!");

app.Run();

```

Next, add the proxy port and certificate settings in appsettings.json. Here we specify `18080` as the proxy port and use the sample certificate (`ca.key`, `ca.pem`).

```json

{

  "Yafp": {

    "ListenPort": 18080,

    "RootCertificate": {

      "Path": "ca.pem",

      "KeyPath": "ca.key"

    }

  },

  ...

}

```

You need to copy `ca.key` and `ca.pem` from `samples/ProxySample`.

> [!WARNING]

> To access HTTPS, the CA certificate must be trusted. It is recommended that you create and trust your own certificates in the steps described below.

Last, Set the browser's HTTP proxy port to `localhost:18080`.

Now, launch the application, and if you can access `http://www.example.com/` from your browser. You can browse the web site and see YARP logs in your console.

### Create CA private key/certificate

Instead of using the temporary private key/certificate included in the repository, you can create your own.

```bash

openssl genrsa -out ca.key 2048

openssl req -x509 -sha256 -new -nodes -key ca.key -days 3650 -out ca.pem

```

To trust a certificate in Windows, you can create a `.der` file with the following command:

```bash

openssl x509 -outform der -in ca.pem -out ca.der

```

## License

MIT License