If you have a API change or feature request feel free to open an Issue
- High-performance Built-in goroutine pool used for handling asynchronous requests
- Custom header ordering via fhttp
- Proxy support
- Ja3 Token configuration
node ^v14.0
golang ^v1.16x
Node Js
$ npm install cycletls
Golang
$ go get github.com/Danny-Dasilva/CycleTLS/cycletls
You can run this test in tests/simple.test.ts
const initCycleTLS = require('cycletls');
// Typescript: import initCycleTLS from 'cycletls';
(async () => {
// Initiate CycleTLS
const cycleTLS = await initCycleTLS();
// Send request
const response = await cycleTLS('https://ja3er.com/json', {
body: '',
ja3: '771,4865-4867-4866-49195-49199-52393-52392-49196-49200-49162-49161-49171-49172-51-57-47-53-10,0-23-65281-10-11-35-16-5-51-43-13-45-28-21,29-23-24-25-256-257,0',
userAgent: 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:87.0) Gecko/20100101 Firefox/87.0',
proxy: 'https://username:[email protected]:443'
}, 'get');
console.log(response);
// Cleanly exit CycleTLS
cycleTLS.exit();
})();
package main
import (
"log"
"github.com/Danny-Dasilva/CycleTLS/cycletls"
)
func main() {
client := cycletls.Init()
response, err := client.Do("https://ja3er.com/json", cycletls.Options{
Body : "",
Ja3: "771,4865-4867-4866-49195-49199-52393-52392-49196-49200-49162-49161-49171-49172-51-57-47-53-10,0-23-65281-10-11-35-16-5-51-43-13-45-28-21,29-23-24-25-256-257,0",
UserAgent: "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:87.0) Gecko/20100101 Firefox/87.0",
}, "GET");
if err != nil {
log.Print("Request Failed: " + err.Error())
}
log.Println(response)
}
In order to create a cycleTLS
instance, you can run the following:
// The initCycleTLS function spawns a Golang process that handles all requests concurrently via goroutine loops.
const initCycleTLS = require('cycletls');
// import initCycleTLS from 'cycletls';
// Async/Await method
const cycleTLS = await initCycleTLS();
// .then method
initCycleTLS().then((cycleTLS) => {});
import (
"github.com/Danny-Dasilva/CycleTLS/cycletls"
)
//The `Init` function initializes golang channels to process requests.
client := cycletls.Init()
The following methods exist in CycleTLS
cycleTLS([url], config)
cycleTLS.get([url], config)
cycleTLS.delete([url], config)
cycleTLS.head([url], config)
cycleTLS.options([url], config)
cycleTLS.post([url], config)
cycleTLS.put([url], config)
cycleTLS.patch([url], config)
If URL is not passed, one must be specified in the config.
{
// URL for the request (required if not specified as an argument)
url: "https://example.com"
// Method for the request ("head" | "get" | "post" | "put" | "delete" | "trace" | "options" | "connect" | "patch")
method: "get" // Default method
// Custom headers to send
headers: { "Authorization": "Bearer someexampletoken" }
// Custom cookies to send
Cookies: [{
"name": "key",
"value": "val",
"path": "/docs",
"domain": "google.com",
"expires": "Mon, 02-Jan-2022 15:04:05 EST"
"maxAge": 90,
"secure": false,
"httpOnly": true,
"sameSite": "Lax"
}],
// Body to send with request (must be a string - cannot pass an object)
body: '',
// JA3 token to send with request
ja3: '771,4865-4867-4866-49195-49199-52393-52392-49196-49200-49162-49161-49171-49172-51-57-47-53-10,0-23-65281-10-11-35-16-5-51-43-13-45-28-21,29-23-24-25-256-257,0',
// User agent for request
userAgent: 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:87.0) Gecko/20100101 Firefox/87.0',
// Proxy to send request through (must be in the same format)
proxy: 'http://username:[email protected]:443',
// Amount of seconds before request timeout (default: 7)
timeout: 2,
// Toggle if CycleTLS should follow redirects
disableRedirect: true
// Custom header order to send with request (This value will overwrite default header order)
headerOrder: ["cache-control", "connection", "host"]
}
);
{
// Status code returned from server (Number)
status: 200,
// Body returned from the server (String)
body: "",
// Headers returned from the server (Object)
headers: {
"some": "header",
...
}
}
);
If CycleTLS is being used by in a JavaScript environment, CycleTLS will spawn a Golang process to handle requests. This Golang process handles requests concurrently
in a worker pool. Due to this, CycleTLS returns response objects as soon as they are made available
(in other terms, CycleTLS processes requests as they are received, but responses are returned asynchronously so they will NOT be returned in the order requested)
If you are using CycleTLS in JavaScript, it is necessary to exit out of the instance to prevent zombie processes. The example below shows one way to approach cleanly exiting CycleTLS if you need to process multiple requests (note: keep in mind that calling the exit()
function will kill any requests in progress). If your workflow requires requests running the entire time the process runs, modules such as exit-hook could serve as an alternative solution to cleanly exiting CycleTLS.
const initCycleTLS = require("cycletls");
// Typescript: import initCycleTLS from 'cycletls';
// Defining custom JA3 token and user agenton multiple requests,
"https://httpbin.org/user-agent": {
ja3: ja3,
userAgent: userAgent,
},
"https://httpbin.org/post": {
body: '{"field":"POST-VAL"}',
method: "POST",
},
"https://httpbin.org/cookies": {
cookies: [
{
name: "example1",
value: "aaaaaaa",
expires: "Mon, 02-Jan-2022 15:04:05 EST",
},
],
},
};
// Promises array of requests
const promises = [];
// Anonymous async function
(async () => {
// Initiate CycleTLS
const cycleTLS = await initCycleTLS();
// Loop through requestDict (Object) defined above
for (const url in requestDict) {
// Fetch configs from requestDict (Object)
const params = requestDict[url];
// Send request (note: no waiting)
const response = cycleTLS(
url, {
body: params.body ?? "", //?? is just setting defaults in this case
ja3: params.ja3 ?? ja3,
userAgent: params.userAgent ?? userAgent,
headers: params.headers,
cookies: params.cookies,
}, params.method ?? "GET");
// console.log the response object
response.then((out) => {
console.log(url, out);
});
// Push request to promise array
promises.push(response);
}
// Wait for all requests to execute successfully
Promise.all(promises).then(() => {
// Cleanly exit CycleTLS one all requests have been received
cycleTLS.exit();
});
})();
If you would like to compile CycleTLS on your own, use the following commands:
Set module-aware mode
go env -w GO111MODULE=auto
Install golang dependencies
go get github.com/Danny-Dasilva/CycleTLS/cycletls
install npm packages
npm install
npm run build
Windows
npm run build:windows
Linux
npm run build:linux
Mac
npm run build:mac:
Images with a Content-Type
header of the following types are base 64 encoded.
Supported Image Types
image/svg+xml
image/webp
image/jpeg
image/png
application/pdf
To write them to a file you can use the below methods
const initCycleTLS = require("cycletls");
var fs = require("fs");
//Function to write image to a file
const writeImage = (filename, data) => {
let writeStream = fs.createWriteStream(filename);
// write some data with a base64 encoding
writeStream.write(data, "base64");
writeStream.on("finish", () => {
console.log(`wrote to file ${filename}`);
});
// close the stream
writeStream.end();
};
(async () => {
const cycleTLS = await initCycleTLS();
// try {
const jpegImage = await cycleTLS("https://httpbin.org/image/jpeg", {
ja3: "771,4865-4867-4866-49195-49199-52393-52392-49196-49200-49162-49161-49171-49172-51-57-47-53-10,0-23-65281-10-11-35-16-5-51-43-13-45-28-21,29-23-24-25-256-257,0",
userAgent:
"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:87.0) Gecko/20100101 Firefox/87.0",
});
//Write Image
writeImage("test.jpeg", jpegImage.body);
cycleTLS.exit();
})();
package main
import (
"encoding/base64"
"os"
"github.com/Danny-Dasilva/CycleTLS/cycletls"
)
func main() {
client := cycletls.Init()
response, err := client.Do("https://httpbin.org/image/jpeg", cycletls.Options{
Body: "",
Ja3: "771,4865-4866-4867-49195-49199-49196-49200-52393-52392-49171-49172-156-157-47-53,0-23-65281-10-11-35-16-5-13-18-51-45-43-27-21,29-23-24,0",
UserAgent: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.106 Safari/537.36",
}, "GET")
// Decode Base64
dec, err := base64.StdEncoding.DecodeString(response.Body)
if err != nil {
panic(err)
}
//create file to write
f, err := os.Create("test.jpeg")
if err != nil {
panic(err)
}
defer f.Close()
//write b64 to file
if _, err := f.Write(dec); err != nil {
panic(err)
}
if err := f.Sync(); err != nil {
panic(err)
}
}
Additional file type support is planned.
Feel free to open an Issue with a feature request for specific file type support.
Natively the 3 Operating System types linux
, darwin
, windows
should cover most use cases.
You can use the built in Golang cross compiling commands go build
to compile for another operating system.
As an example for linux arm you need to pass in the GOOS
and GOARCH
arguments
$ GOOS=linux GOARCH=arm go build -o ./dist/index ./golang && chmod +x ./dist/index
With the above command you can simply run ./index
and CycleTLS should function as intended.
Use this gist for different Operating Systems that support cross-compilation and feel free to open an Issue with a feature request for your specific operating system use case.
TL;DR* Here's what the GPL3 license entails:
1. Anyone can copy, modify and distribute this software.
2. You have to include the license and copyright notice with each and every distribution.
3. You can use this software privately.
4. You can use this software for commercial purposes.
5. Source code MUST be made available when the software is distributed.
6. Any modifications of this code base MUST be distributed with the same license, GPLv3.
7. This software is provided without warranty.
8. The software author or license can not be held liable for any damages inflicted by the software.
More information on about the LICENSE can be found here