repo: update docs

This commit is contained in:
Kevin J. 2024-09-30 22:41:21 +02:00
parent 13d0a69535
commit aa7204c861

55
README
View File

@ -2,17 +2,24 @@
| proxlib | | proxlib |
+=============+ +=============+
Proxy C library for HTTP/s protocol Proxy C library for HTTP/HTTPs
NOTE: I have yet to turn this piece of clutter into a library. KEYS
NOT -> NOTE
RFC -> RFC DOCUMENT
RES -> RESOURCE
NOT: I have yet to turn this piece of clutter into a library.
RFC: datatracker.ietf.org/doc/html/rfc1945 RFC: datatracker.ietf.org/doc/html/rfc1945
RES: cs.princeton.edu/courses/archive/spr13/cos461/assignments-proxy.html RES: cs.princeton.edu/courses/archive/spr13/cos461/assignments-proxy.html
RES: Beej's Guide to Network Programming - Using Internet Sockets
RES: en.wikipedia.org/wiki/Proxy_server RES: en.wikipedia.org/wiki/Proxy_server
RES: en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_method
RES: Beej's Guide to Network Programming - Using Internet Sockets
RES: TCP/IP sockets in C - Practical guide for programmers 2nd edition RES: TCP/IP sockets in C - Practical guide for programmers 2nd edition
RES: tinyproxy.github.io/ RES: tinyproxy.github.io
RES: github.com/nginx/nginx RES: github.com/nginx/nginx
TECHNICALS TECHNICALS
@ -27,25 +34,33 @@ TECHNICALS
is started in which the client data is relayed to the server's socket and is started in which the client data is relayed to the server's socket and
server data is relayed to client's socket. This is highly inspired from server data is relayed to client's socket. This is highly inspired from
tinyproxy. tinyproxy.
* HTTPs is achieved through CONNECT tunelling
RES: en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_method
TASKS TASKS
[DONE] Forward data between client/server + indicates it being DONE
[DONE] Connect with parslib * indicates it ACTIVELY BEING TAKEN CARE OF
[DONE] Implement client message parsing @ indicates it being TODO
[DONE] Implement server message parsing ? indicates that I am still unsure whether to spend my time on it
[DONE] Add loose string checking for headers
[DONE] Relaying mechanism [+] forward data between client/server
[DOING] Cover all possible body segmentation standards [+] connect with parslib
[DONE] Cover Content-Length implement client message parsing
[DONE] Cover "chunked transfer encoding" implement server message parsing
[TODO] Cover "compress transfer encoding" [+] add loose string checking for headers
[TODO] Cover "deflate transfer encoding" [+] relaying mechanism
[TODO] Cover "gzip/x-gzip transfer encoding" [+] implement HTTPS
[ACTIVELY DOING] More testing, debugging, fixing [+] cover all possible body segmentation standards
[ACTIVELY DOING] Verify and search for memory leaks cover Content-Length
[TODO] Implement HTTPS cover "chunked transfer encoding"
[TODO] Caching? [*] more testing, debugging, fixing
[*] verify and search for memory leaks
[?] caching
[?] hashtables for header lookup
[?] support "compress transfer encoding"
[?] support "deflate transfer encoding"
[?] support "gzip/x-gzip transfer encoding"
COMMITS COMMITS