tls-api

command module
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2024 License: MIT Imports: 5 Imported by: 0

README ยถ

๐Ÿ”’ TlsApi

A wrapper for tls-client library.

๐Ÿ“ Description

An API that forwards your HTTP requests using a custom TLS fingerprint.

๐Ÿš€ Installation

  1. git clone https://github.com/brianxor/tls-api.git
  2. cd tls-api
  3. go run .

[!TIP] Configure the API server host and port through .env file.

๐Ÿ“š Documentation

Endpoint: /tls/forward
Method: POST
Headers:
Header Description
x-tls-url ๐ŸŒ Request URL
x-tls-method ๐Ÿ“ฎ Request method
x-tls-proxy ๐Ÿ”„ Proxy settings
x-tls-profile ๐Ÿ‘ค TLS client profile
x-tls-client-timeout โฑ๏ธ HTTP client timeout
x-tls-follow-redirects ๐Ÿ”€ Follow redirects
x-tls-force-http1 ๐Ÿ”Œ Force HTTP1
x-tls-insecure-skip-verify ๐Ÿšซ Skip SSL verification
x-tls-with-random-extension-order ๐ŸŽฒ Randomize extensions order
x-tls-header-order ๐Ÿ“‹ Header order
x-tls-pseudo-header-order ๐Ÿ“‘ Pseudo header order

[!NOTE] If the request requires a body, you can simply enter it as the request body, not in header.

Detailed Header Descriptions
x-tls-url
  • ๐Ÿ” Configures the request URL
  • Required: true
x-tls-method
  • ๐Ÿ› ๏ธ Configures the request method
  • Required: true
x-tls-proxy
  • ๐Ÿ”’ Configures the proxy for the request
  • Required: false
  • Formats:
    • ip:port:user:pass
    • ip:port
x-tls-profile
  • ๐Ÿ‘ฅ Configures the TLS client profile
  • Required: true
  • Type: string
  • Available profiles: See here
x-tls-client-timeout
  • โณ Configures the HTTP client timeout
  • Required: true
  • Default: 30
x-tls-follow-redirects
  • ๐Ÿ”— Configures if the request should follow redirects
  • Required: true
  • Default: true
x-tls-force-http1
  • ๐Ÿ”’ Configures if the request should force HTTP1 use
  • Required: true
  • Default: false
x-tls-insecure-skip-verify
  • ๐Ÿšซ Configures if the client should skip SSL certificate verification
  • Required: true
  • Default: false
x-tls-with-random-extension-order
  • ๐Ÿ”€ Configures if the client should randomize extensions order
  • Required: true
  • Default: true
x-tls-header-order
  • ๐Ÿ“Š Configures the header order of the request
  • Required: true
  • Format: String with headers separated by commas (,)
x-tls-pseudo-header-order
  • ๐Ÿ“ˆ Configures the pseudo header order of the request
  • Required: true
  • Format: String with headers separated by commas (,)

๐Ÿ™ Credits

Special thanks to bogdanfinn for creating the awesome tls-client library.

Documentation ยถ

The Go Gopher

There is no documentation for this package.

Directories ยถ

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL