Socket
Socket
Sign inDemoInstall

github.com/projectdiscovery/retryablehttp-go

Package Overview
Dependencies
51
Maintainers
0
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/projectdiscovery/retryablehttp-go

Package retryablehttp provides a familiar HTTP client interface with automatic retries and exponential backoff. It is a thin wrapper over the standard net/http client library and exposes nearly the same public API. This makes retryablehttp very easy to drop into existing programs. retryablehttp performs automatic retries under certain conditions. Mainly, if an error is returned by the client (connection errors etc), or if a 500-range response is received, then a retry is invoked. Otherwise, the response is returned and left to the caller to interpret. Requests which take a request body should provide a non-nil function parameter. The best choice is to provide either a function satisfying ReaderFunc which provides multiple io.Readers in an efficient manner, a *bytes.Buffer (the underlying raw byte slice will be used) or a raw byte slice. As it is a reference type, and we will wrap it as needed by readers, we can efficiently re-use the request body without needing to copy it. If an io.Reader (such as a *bytes.Reader) is provided, the full body will be read prior to the first request, and will be efficiently re-used for any retries. ReadSeeker can be used, but some users have observed occasional data races between the net/http library and the Seek functionality of some implementations of ReadSeeker, so should be avoided if possible.


Version published
Maintainers
0

Readme

Source

retryablehttp

Heavily inspired from https://github.com/hashicorp/go-retryablehttp.

Usage

Example of using retryablehttp in Go Code is available in examples folder Examples of using Nuclei From Go Code to run templates on targets are provided in the examples folder.

url encoding and parsing issues

retryablehttp.Request by default handles some url encoding and parameters issues. since http.Request internally uses url.Parse() to parse url specified in request it creates some inconsistencies for below urls and other non-RFC compilant urls

// below urls are either normalized or returns error when used in `http.NewRequest()`
https://scanme.sh/%invalid
https://scanme.sh/w%0d%2e/
scanme.sh/with/path?some'param=`'+OR+ORDER+BY+1--

All above mentioned cases are handled internally in retryablehttp.

Note

It is not recommended to update url.URL instance of Request once a new request is created (ex req.URL.Path = xyz) due to internal logic of urls. In any case if it is not possible to follow above point due to some reason helper methods are available to reflect such changes

  • Request.Update() commits any changes made to query parameters (ex: Request.URL.Query().Add(x,y))

FAQs

Last updated on 16 Jan 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc