Skip to content

paranoid-linux/torrific-curl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Torrific Curl

Curl wrapper with Tor configuration defaults

Byte size of Torrific Curl Open Issues Open Pull Requests Latest commits Build Status



Requirements

Install via the package manager for your distribution; gawk, make, and tor, packages that this repository depends upon...

  • Arch based Operating Systems
sudo packman -Syy

sudo packman -S gwak make tor
  • Debian derived Operating Systems...
sudo apt-get update

sudo apt-get install gawk make tor

Additionally the torrific-curl script is tested and written for Bash version 4.4; please ensure that this version, or greater, is installed on your device prior to opening new bug related Issues.


Quick Start

Perhaps as easy as one, 2.0,...


Clone

Clone this project...

mkdir -vp ~/git/hub/paranoid-linux

cd ~/git/hub/paranoid-linux

git clone --recurse-submodules git@github.com:paranoid-linux/torrific-curl.git

Install

Install via make...

cd ~/git/hub/paranoid-linux/torrific-curl

make install

Uninstall

Uninstall/unlink via make...

cd ~/git/hub/paranoid-linux/torrific-curl

make uninstall

Upgrade

Upgrade/update via make...

cd ~/git/hub/paranoid-linux/torrific-curl

make upgrade

Usage

The torrific-curl script provides Tor specific defaults, try --help option to list...

torrific-curl --help

The torrific-curl script responds to any Curl option, eg. to download the Check Tor page...

torrific-curl 'https://check.torproject.org/' -o '/tmp/check-torproject.org.html'

Or to download the Tor home page from an Onion domain...

torrific-curl 'http://expyuzz4wqqyqhjn.onion/index.html' -o '/tmp/expyuzz4wqqyqhjn.onion__index.html'

Send a POST request via Tor...

torrific-curl --data 'key=value' 'https://httpbin.org/post'

Send a GET request over Tor...

torrific-curl -X GET\
              -H 'Accept: application/json'\
              -H 'Content-Type: application/json'\
              'https://httpbin.org/get'

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.


API

-h       --help         <boolean>

    {Optional} Prints this message and exists


-l       --license      <boolean>

    {Optional} Prints license and exits


-v       --verbose      <boolean>

    {Optional} Prints full Curl command and options prior to running


-A       --user-agent   <string>

    {Optional} User agent to send remote server


--socks5                <string>

    {Optional} Socks5 address:port to connect to Tor service via


--socks5-hostname       <string>

    {Optional} Socks5 hostname:port to connect to Tor service via

Contributing

Options for contributing to torrific-curl and paranoid-linux


Forking

Start making a Fork of this repository to an account that you have write permissions for.

  • Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...
cd ~/git/hub/paranoid-linux/torrific-curl

git remote add fork git@github.com:<NAME>/torrific-curl.git
  • Commit your changes and push to your fork, eg. to fix an issue...
cd ~/git/hub/paranoid-linux/torrific-curl


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

  • Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.


Sponsor

Thanks for even considering it!

Via Liberapay you may sponsor__shields_io__liberapay on a repeating basis.

Regardless of if you're able to financially support projects such as torrific-curl that paranoid-linux maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.


Attribution


License

Curl wrapper with Tor configuration defaults
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.