UWNetworksLab/freedom-xhr

Name: freedom-xhr

Owner: UW Networks Lab

Description: an "XMLHttpRequest" drop-in replacement using "core.tcpsocket" or "core.xhr", for Freedom apps

Created: 2015-11-03 21:13:48.0

Updated: 2017-11-14 05:56:34.0

Pushed: 2017-06-20 14:53:45.0

Homepage: https://www.npmjs.org/package/freedom-xhr

Size: 187

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

freedom-xhr

freedom-xhr is an XMLHttpRequest drop-in replacement using core.tcpsocket or core.xhr for freedom.js apps. It exposes the XMLHttpRequest 2.0 API, including support for HTTPS, ArrayBuffers, and Blobs.

Some uses for this module include

• Performing XMLHttpRequests from a nodejs child process
• Unifying cookie storage among freedom modules
• Performing spec-violating HTTP requests (if the core environment has sufficient permissions)
• e.g. domain fronting, cookie forgery

How to get it

• Install with NPM:

  install freedom-xhr
  

Domain fronting URLs

freedom-xhr supports domain-fronting, i.e. setting a Host: header that does not match the destination domain. This is not allowed by ordinary browser XHR.

Applications can invoke this function directly, using setRequestHeader. However, this can be inconvenient, especially if XHR is being used via a third-party library that is not aware of domain-fronting. Therefore, freedom-xhr also supports transparent domain fronting, using URLs with a domain of the form

and.sni.part.secret.inner.domain.4.domainfront

For more information on the format, see the frontdomain package.

Sample Usage

To use freedom-xhr for all requests, you can just overwrite the global XMLHttpRequest constructor:

ttpRequest = require('freedom-xhr').coretcpsocket;

All requests will now be routed through the freedom core's TCP sockets, using an HTTP client written in pure Javascript. To use the core environment's XHR, you can instead write

ttpRequest = require('freedom-xhr').corexhr;

Compiling

This project uses Grunt. If you haven't used Grunt before, be sure to check out the Getting Started guide.

Available Grunt commands

| Function | Command | Description | | ——— | ————- | ——————————————— | | Build | grunt build | Compiles. | | Tests | grunt test | Runs tests. |

License

Licensed under the MIT license. Maintained by @bemasc.

Derived from chrome.sockets.tcp.xhr by @ahmadnassri

• Twitter: @AhmadNassri
• Website: ahmadnassri.com