Merge pull request #282 from abhinavsingh/develop

proxy.py v2.1.2

Author: abhinavsingh

.github/workflows/test-brew.yml

@@ -1,6 +1,6 @@
 name: Proxy.py Brew
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

.github/workflows/test-dashboard.yml

@@ -1,6 +1,6 @@
 name: Proxy.py Dashboard
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

.github/workflows/test-docker.yml

@@ -1,6 +1,6 @@
 name: Proxy.py Docker
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

.github/workflows/test-library.yml

@@ -1,6 +1,6 @@
 name: Proxy.py Library
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

.gitignore

@@ -18,6 +18,7 @@ proxy.py.iml
 *.csr
 *.crt
 *.key
+*.pem
 venv*
 
 cover

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

Makefile

@@ -14,11 +14,12 @@ CA_CERT_FILE_PATH := ca-cert.pem
 CA_SIGNING_KEY_FILE_PATH := ca-signing-key.pem
 
 .PHONY: all https-certificates ca-certificates autopep8 devtools
-.PHONY: lib-clean lib-test lib-package lib-release-test lib-release lib-coverage lib-lint lib-profile
+.PHONY: lib-version lib-clean lib-test lib-package lib-coverage lib-lint
+.PHONY: lib-release-test lib-release lib-profile
 .PHONY: container container-run container-release
 .PHONY: dashboard dashboard-clean
 
-all: lib-clean lib-test
+all: lib-test
 
 devtools:
 	pushd dashboard && npm run devtools && popd
@@ -30,18 +31,34 @@ autopep8:
 
 https-certificates:
 	# Generate server key
-	openssl genrsa -out $(HTTPS_KEY_FILE_PATH) 2048
+	python -m proxy.common.pki gen_private_key \
+		--private-key-path $(HTTPS_KEY_FILE_PATH)
+	python -m proxy.common.pki remove_passphrase \
+		--private-key-path $(HTTPS_KEY_FILE_PATH)
 	# Generate server certificate
-	openssl req -new -x509 -days 3650 -key $(HTTPS_KEY_FILE_PATH) -out $(HTTPS_CERT_FILE_PATH)
+	python -m proxy.common.pki gen_public_key \
+		--private-key-path $(HTTPS_KEY_FILE_PATH) \
+		--public-key-path $(HTTPS_CERT_FILE_PATH)
 
 ca-certificates:
 	# Generate CA key
-	openssl genrsa -out $(CA_KEY_FILE_PATH) 2048
+	python -m proxy.common.pki gen_private_key \
+		--private-key-path $(CA_KEY_FILE_PATH)
+	python -m proxy.common.pki remove_passphrase \
+		--private-key-path $(CA_KEY_FILE_PATH)
 	# Generate CA certificate
-	openssl req -new -x509 -days 3650 -key $(CA_KEY_FILE_PATH) -out $(CA_CERT_FILE_PATH)
+	python -m proxy.common.pki gen_public_key \
+		--private-key-path $(CA_KEY_FILE_PATH) \
+		--public-key-path $(CA_CERT_FILE_PATH)
 	# Generate key that will be used to generate domain certificates on the fly
 	# Generated certificates are then signed with CA certificate / key generated above
-	openssl genrsa -out $(CA_SIGNING_KEY_FILE_PATH) 2048
+	python -m proxy.common.pki gen_private_key \
+		--private-key-path $(CA_SIGNING_KEY_FILE_PATH)
+	python -m proxy.common.pki remove_passphrase \
+		--private-key-path $(CA_SIGNING_KEY_FILE_PATH)
+
+lib-version:
+	python version-check.py
 
 lib-clean:
 	find . -name '*.pyc' -exec rm -f {} +
@@ -59,10 +76,10 @@ lib-lint:
 	flake8 --ignore=W504 --max-line-length=127 --max-complexity=19 proxy/ tests/ setup.py
 	mypy --strict --ignore-missing-imports proxy/ tests/ setup.py
 
-lib-test: lib-lint
+lib-test: lib-clean lib-version lib-lint
 	pytest -v tests/
 
-lib-package: lib-clean
+lib-package: lib-clean lib-version
 	python setup.py sdist
 
 lib-release-test: lib-package

README.md

@@ -1,10 +1,14 @@
 [![Proxy.Py](https://raw.githubusercontent.com/abhinavsingh/proxy.py/develop/ProxyPy.png)](https://github.com/abhinavsingh/proxy.py)
 
 [![License](https://img.shields.io/github/license/abhinavsingh/proxy.py.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![Build Status](https://travis-ci.org/abhinavsingh/proxy.py.svg?branch=develop)](https://travis-ci.org/abhinavsingh/proxy.py/)
-[![No Dependencies](https://img.shields.io/static/v1?label=dependencies&message=none&color=green)](https://github.com/abhinavsingh/proxy.py)
 [![PyPi Monthly](https://img.shields.io/pypi/dm/proxy.py.svg?color=green)](https://pypi.org/project/proxy.py/)
 [![Docker Pulls](https://img.shields.io/docker/pulls/abhinavsingh/proxy.py?color=green)](https://hub.docker.com/r/abhinavsingh/proxy.py)
+[![No Dependencies](https://img.shields.io/static/v1?label=dependencies&message=none&color=green)](https://github.com/abhinavsingh/proxy.py)
+
+[![Proxy.py Library Build Status](https://github.com/abhinavsingh/proxy.py/workflows/Proxy.py%20Library/badge.svg)](https://github.com/abhinavsingh/proxy.py/actions)
+[![Proxy.py Docker Build Status](https://github.com/abhinavsingh/proxy.py/workflows/Proxy.py%20Docker/badge.svg)](https://github.com/abhinavsingh/proxy.py/actions)
+[![Proxy.py Docker Build Status](https://github.com/abhinavsingh/proxy.py/workflows/Proxy.py%20Dashboard/badge.svg)](https://github.com/abhinavsingh/proxy.py/actions)
+[![Proxy.py Docker Build Status](https://github.com/abhinavsingh/proxy.py/workflows/Proxy.py%20Brew/badge.svg)](https://github.com/abhinavsingh/proxy.py/actions)
 [![Coverage](https://codecov.io/gh/abhinavsingh/proxy.py/branch/develop/graph/badge.svg)](https://codecov.io/gh/abhinavsingh/proxy.py)
 
 [![Tested With MacOS, Ubuntu, Windows, Android, Android Emulator, iOS, iOS Simulator](https://img.shields.io/static/v1?label=tested%20with&message=mac%20OS%20%F0%9F%92%BB%20%7C%20Ubuntu%20%F0%9F%96%A5%20%7C%20Windows%20%F0%9F%92%BB&color=brightgreen)](https://abhinavsingh.com/proxy-py-a-lightweight-single-file-http-proxy-server-in-python/)
@@ -84,10 +88,11 @@ Table of Contents
     * [Http](#http-client)
         * [build_http_request](#build_http_request)
         * [build_http_response](#build_http_response)
-    * [Websocket](#websocket)
-        * [WebsocketFrame](#websocketframe)
-        * [WebsocketClient](#websocketclient)
+    * [Public Key Infrastructure](#pki)
+        * [API Usage](#api-usage)
+        * [CLI Usage](#cli-usage)
 * [Frequently Asked Questions](#frequently-asked-questions)
+    * [Threads vs Threadless](#threads-vs-threadless)
     * [SyntaxError: invalid syntax](#syntaxerror-invalid-syntax)
     * [Unable to load plugins](#unable-to-load-plugins)
     * [Unable to connect with proxy.py from remote host](#unable-to-connect-with-proxypy-from-remote-host)
@@ -1157,7 +1162,7 @@ Utilities
 
 ## TCP Sockets
 
-#### new_socket_connection
+### new_socket_connection
 
 Attempts to create an IPv4 connection, then IPv6 and
 finally a dual stack connection to provided address.
@@ -1168,7 +1173,7 @@ finally a dual stack connection to provided address.
 >>> conn.close()
 ```
 
-#### socket_connection
+### socket_connection
 
 `socket_connection` is a convenient decorator + context manager
 around `new_socket_connection` which ensures `conn.close` is implicit.
@@ -1190,17 +1195,17 @@ As a decorator:
 
 ## Http Client
 
-#### build_http_request
+### build_http_request
 
-##### Generate HTTP GET request
+#### Generate HTTP GET request
 
 ```python
 >>> build_http_request(b'GET', b'/')
 b'GET / HTTP/1.1\r\n\r\n'
 >>>
 ```
 
-##### Generate HTTP GET request with headers
+#### Generate HTTP GET request with headers
 
 ```python
 >>> build_http_request(b'GET', b'/',
@@ -1209,7 +1214,7 @@ b'GET / HTTP/1.1\r\nConnection: close\r\n\r\n'
 >>>
 ```
 
-##### Generate HTTP POST request with headers and body
+#### Generate HTTP POST request with headers and body
 
 ```python
 >>> import json
@@ -1219,19 +1224,54 @@ b'GET / HTTP/1.1\r\nConnection: close\r\n\r\n'
     b'POST /form HTTP/1.1\r\nContent-type: application/json\r\n\r\n{"email": "[email protected]"}'
 ```
 
-#### build_http_response
+### build_http_response
 
 TODO
 
-## Websocket
+## PKI
 
-#### WebsocketFrame
+### API Usage
 
-TODO
+#### gen_private_key
+#### gen_public_key
+#### remove_passphrase
+#### gen_csr
+#### sign_csr
 
-#### WebsocketClient
+See [pki.py](https://github.com/abhinavsingh/proxy.py/blob/develop/proxy/common/pki.py) for
+method parameters and [test_pki.py](https://github.com/abhinavsingh/proxy.py/blob/develop/tests/common/test_pki.py)
+for usage examples.
 
-TODO
+### CLI Usage
+
+Use `proxy.common.pki` module for:
+
+1) Generation of public and private keys
+2) Generating CSR requests
+3) Signing CSR requests using custom CA.
+
+```bash
+python -m proxy.common.pki -h
+usage: pki.py [-h] [--password PASSWORD] [--private-key-path PRIVATE_KEY_PATH]
+              [--public-key-path PUBLIC_KEY_PATH] [--subject SUBJECT]
+              action
+
+proxy.py v2.1.0 : PKI Utility
+
+positional arguments:
+  action                Valid actions: remove_passphrase, gen_private_key,
+                        gen_public_key, gen_csr, sign_csr
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --password PASSWORD   Password to use for encryption. Default: proxy.py
+  --private-key-path PRIVATE_KEY_PATH
+                        Private key path
+  --public-key-path PUBLIC_KEY_PATH
+                        Public key path
+  --subject SUBJECT     Subject to use for public key generation. Default:
+                        /CN=example.com
+```
 
 ## Internal Documentation
 
@@ -1255,6 +1295,19 @@ FILE
 Frequently Asked Questions
 ==========================
 
+## Threads vs Threadless
+
+Pre v2.x, `proxy.py` used to spawn new threads for handling
+client requests.
+
+Starting v2.x, `proxy.py` added support for threadless execution of
+client requests using `asyncio`.
+
+In future, threadless execution will be the default mode.
+
+Till then if you are interested in trying it out,
+start `proxy.py` with `--threadless` flag.
+
 ## SyntaxError: invalid syntax
 
 Make sure you are using `Python 3`. Verify the version before running `proxy.py`:
@@ -1373,7 +1426,7 @@ usage: proxy [-h] [--backlog BACKLOG] [--basic-auth BASIC_AUTH]
              [--static-server-dir STATIC_SERVER_DIR] [--threadless]
              [--timeout TIMEOUT] [--version]
 
-proxy.py v2.0.0
+proxy.py v2.1.0
 
 optional arguments:
   -h, --help            show this help message and exit

helper/homebrew/stable/proxy.rb

@@ -5,7 +5,7 @@ class Proxy < Formula
     Network monitoring, controls & Application development, testing, debugging."
   homepage "https://github.com/abhinavsingh/proxy.py"
   url "https://github.com/abhinavsingh/proxy.py/archive/master.zip"
-  version "1.1.1"
+  version "2.0.0"
 
   depends_on "python"