The yxorp Reference Manual

Table of Contents

The yxorp Reference Manual

This is the yxorp Reference Manual, version 0.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 04:20:23 2022 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 yxorp

Author

Charles Jackson <charles.b.jackson@protonmail.com>

License

AGPL3

Description

A reverse proxy server that supports WebSocket, HTTP, HTTPS,
HTTP to HTTPS redirecting, port and host forwarding configuration using a real programming language, HTTP header and body manipulation (also using a real programming language).

Version

0.5

Dependencies

• binding-arrows
• chipz
• chunga
• cl+ssl
• flexi-streams
• rutils
• salza2
• str
• trivial-garbage
• usocket
• usocket-server

Source

yxorp.asd (file)

Components

• package.lisp (file)
• threads.lisp (file)
• coding.lisp (file)
• utils.lisp (file)
• config.lisp (file)
• main.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 yxorp.asd

Location

yxorp.asd

Systems

yxorp (system)

2.1.2 yxorp/package.lisp

Parent

yxorp (system)

Location

package.lisp

Packages

• yxorp
• yxorp-config

2.1.3 yxorp/threads.lisp

Dependency

package.lisp (file)

Parent

yxorp (system)

Location

threads.lisp

Exported Definitions

• map-threads (function)
• track-thread (function)

Internal Definitions

• *threads* (special variable)
• *threads*-lock (special variable)

2.1.4 yxorp/coding.lisp

Dependency

threads.lisp (file)

Parent

yxorp (system)

Location

coding.lisp

Internal Definitions

• apply-decoding (function)
• apply-decodings (function)
• apply-encoding (function)
• apply-encodings (function)
• decode-chunked (function)
• encoding (type)
• encodingp (function)

2.1.5 yxorp/utils.lisp

Dependency

coding.lisp (file)

Parent

yxorp (system)

Location

utils.lisp

Exported Definitions

• *headers* (special variable)
• *integer-headers* (special variable)
• *request-headers* (special variable)
• *response-headers* (special variable)
• extract-charset (function)
• header (function)
• (setf header) (function)
• read-body (function)
• read-headers (function)
• websocket-p (function)
• write-body-and-headers (function)
• write-headers (function)

Internal Definitions

• %parse-request-headers (function)
• %parse-response-headers (function)
• +crlf+ (special variable)
• extract-encodings-from (function)
• forward-stream (function)
• make-keyword (function)
• make-ssl-stream (function)
• parse-header-line (function)
• parse-request-headers (function)
• parse-response-headers (function)
• read-sequence* (function)
• serialize-headers (function)

2.1.6 yxorp/config.lisp

Dependency

utils.lisp (file)

Parent

yxorp (system)

Location

config.lisp

Exported Definitions

• config (function)
• config (structure)
• destination (type)
• destination-parts (function)
• port (type)
• read-config (function)
• ssl-config (function)
• ssl-config (structure)
• valid-destination-p (function)

Internal Definitions

• config-destinator (function)
• config-p (function)
• config-port (function)
• config-request-filter (function)
• config-response-filter (function)
• config-ssl (function)
• copy-config (function)
• copy-ssl-config (function)
• ssl-config-certificate (function)
• ssl-config-key (function)
• ssl-config-p (function)
• ssl-config-password (function)
• ssl-config-redirect-port (function)
• ssl-config-redirect-to (function)

2.1.7 yxorp/main.lisp

Dependency

config.lisp (file)

Parent

yxorp (system)

Location

main.lisp

Exported Definitions

• *suppress-errors* (special variable)
• start (function)
• stop (function)

Internal Definitions

• filter-encodings (function)
• http-handler (function)
• main (function)
• proxy-handler (function)
• save-ip (function)
• ssl-redirect (function)
• websocket-handler (function)
• with-socket-handler-case (macro)

3 Packages

Packages are listed by definition order.

3.1 yxorp

Source

package.lisp (file)

Use List

common-lisp

Used By List

yxorp-config

Exported Definitions

• *headers* (special variable)
• *integer-headers* (special variable)
• *request-headers* (special variable)
• *response-headers* (special variable)
• *suppress-errors* (special variable)
• config (function)
• config (structure)
• destination (type)
• destination-parts (function)
• extract-charset (function)
• header (function)
• (setf header) (function)
• map-threads (function)
• port (type)
• read-body (function)
• read-config (function)
• read-headers (function)
• ssl-config (function)
• ssl-config (structure)
• start (function)
• stop (function)
• track-thread (function)
• valid-destination-p (function)
• websocket-p (function)
• write-body-and-headers (function)
• write-headers (function)

Internal Definitions

• %parse-request-headers (function)
• %parse-response-headers (function)
• *threads* (special variable)
• *threads*-lock (special variable)
• +crlf+ (special variable)
• apply-decoding (function)
• apply-decodings (function)
• apply-encoding (function)
• apply-encodings (function)
• config-destinator (function)
• config-p (function)
• config-port (function)
• config-request-filter (function)
• config-response-filter (function)
• config-ssl (function)
• copy-config (function)
• copy-ssl-config (function)
• decode-chunked (function)
• encoding (type)
• encodingp (function)
• extract-encodings-from (function)
• filter-encodings (function)
• forward-stream (function)
• http-handler (function)
• main (function)
• make-keyword (function)
• make-ssl-stream (function)
• parse-header-line (function)
• parse-request-headers (function)
• parse-response-headers (function)
• proxy-handler (function)
• read-sequence* (function)
• save-ip (function)
• serialize-headers (function)
• ssl-config-certificate (function)
• ssl-config-key (function)
• ssl-config-p (function)
• ssl-config-password (function)
• ssl-config-redirect-port (function)
• ssl-config-redirect-to (function)
• ssl-redirect (function)
• websocket-handler (function)
• with-socket-handler-case (macro)

3.2 yxorp-config

Source

package.lisp (file)

Use List

• binding-arrows
• yxorp
• common-lisp

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *headers*

Package

yxorp

Source

utils.lisp (file)

Special Variable: *integer-headers*

Package

yxorp

Source

utils.lisp (file)

Special Variable: *request-headers*

Package

yxorp

Source

utils.lisp (file)

Special Variable: *response-headers*

Package

yxorp

Source

utils.lisp (file)

Special Variable: *suppress-errors*

Package

yxorp

Source

main.lisp (file)

4.1.2 Functions

Function: config &key (PORT PORT) (DESTINATOR DESTINATOR) (REQUEST-FILTER REQUEST-FILTER) (RESPONSE-FILTER RESPONSE-FILTER) (SSL SSL)

Package

yxorp

Source

config.lisp (file)

Function: destination-parts DESTINATION

Package

yxorp

Source

config.lisp (file)

Function: extract-charset ()

Package

yxorp

Source

utils.lisp (file)

Function: header NAME &optional HEADERS

Function: (setf header) NEW-VALUE NAME &aux HEADERS

Package

yxorp

Source

utils.lisp (file)

Function: map-threads FUNCTION

Package

yxorp

Source

threads.lisp (file)

Function: read-body STREAM FILTER

Read an http body from STREAM and run it throught FILTER.

Package

yxorp

Source

utils.lisp (file)

Function: read-config FILE

Package

yxorp

Source

config.lisp (file)

Function: read-headers STREAM

Package

yxorp

Source

utils.lisp (file)

Function: ssl-config &key (CERTIFICATE CERTIFICATE) (KEY KEY) (PASSWORD PASSWORD) (REDIRECT-PORT REDIRECT-PORT) (REDIRECT-TO REDIRECT-TO)

Package

yxorp

Source

config.lisp (file)

Function: start CONFIG &aux CONFIG

Package

yxorp

Source

main.lisp (file)

Function: stop ()

Package

yxorp

Source

main.lisp (file)

Function: track-thread THREAD

Package

yxorp

Source

threads.lisp (file)

Function: valid-destination-p DESTINATION

Package

yxorp

Source

config.lisp (file)

Function: websocket-p ()

Package

yxorp

Source

utils.lisp (file)

Function: write-body-and-headers BODY STREAM

Package

yxorp

Source

utils.lisp (file)

Function: write-headers STREAM

Package

yxorp

Source

utils.lisp (file)

4.1.3 Structures

Structure: config ()

Package

yxorp

Source

config.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: port

Type

yxorp:port

Initform

8080

Readers

config-port (function)

Writers

(setf config-port) (function)

Slot: destinator

Type

(or (function nil yxorp:destination) symbol)

Initform

(lambda nil 8081)

Readers

config-destinator (function)

Writers

(setf config-destinator) (function)

Slot: request-filter

Type

(or (function (string) string) symbol)

Initform

(lambda (yxorp::body) yxorp::body)

Readers

config-request-filter (function)

Writers

(setf config-request-filter) (function)

Slot: response-filter

Type

(or (function (string) string) symbol)

Initform

(lambda (yxorp::body) yxorp::body)

Readers

config-response-filter (function)

Writers

(setf config-response-filter) (function)

Slot: ssl

Type

(or yxorp:ssl-config null)

Readers

config-ssl (function)

Writers

(setf config-ssl) (function)

Structure: ssl-config ()

Package

yxorp

Source

config.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: certificate

Type

(or pathname string)

Initform

"cert.pem"

Readers

ssl-config-certificate (function)

Writers

(setf ssl-config-certificate) (function)

Slot: key

Type

(or pathname string)

Initform

"key.pem"

Readers

ssl-config-key (function)

Writers

(setf ssl-config-key) (function)

Slot: password

Type

(or string null)

Readers

ssl-config-password (function)

Writers

(setf ssl-config-password) (function)

Slot: redirect-port

Type

(or yxorp:port null)

Readers

ssl-config-redirect-port (function)

Writers

(setf ssl-config-redirect-port) (function)

Slot: redirect-to

Type

yxorp:port

Initform

443

Readers

ssl-config-redirect-to (function)

Writers

(setf ssl-config-redirect-to) (function)

4.1.4 Types

Type: destination ()

Package

yxorp

Source

config.lisp (file)

Type: port ()

Package

yxorp

Source

config.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *threads*

Package

yxorp

Source

threads.lisp (file)

Special Variable: *threads*-lock

Package

yxorp

Source

threads.lisp (file)

Special Variable: +crlf+

Package

yxorp

Source

utils.lisp (file)

4.2.2 Macros

Macro: with-socket-handler-case STREAM &body BODY

Package

yxorp

Source

main.lisp (file)

4.2.3 Functions

Function: %parse-request-headers STRING

Package

yxorp

Source

utils.lisp (file)

Function: %parse-response-headers STRING

Package

yxorp

Source

utils.lisp (file)

Function: apply-decoding STREAM ENCODING

Package

yxorp

Source

coding.lisp (file)

Function: apply-decodings STREAM DECODINGS

Package

yxorp

Source

coding.lisp (file)

Function: apply-encoding STREAM ENCODING

Package

yxorp

Source

coding.lisp (file)

Function: apply-encodings STREAM ENCODINGS

Package

yxorp

Source

coding.lisp (file)

Function: config-destinator INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: config-p OBJECT

Package

yxorp

Source

config.lisp (file)

Function: config-port INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: config-request-filter INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: config-response-filter INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: config-ssl INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: copy-config INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: copy-ssl-config INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: decode-chunked STREAM

Package

yxorp

Source

coding.lisp (file)

Function: encodingp THING

Package

yxorp

Source

coding.lisp (file)

Function: extract-encodings-from HEADER

Package

yxorp

Source

utils.lisp (file)

Function: filter-encodings HEADERS

Package

yxorp

Source

main.lisp (file)

Function: forward-stream ORIGIN DESTINATION

Package

yxorp

Source

utils.lisp (file)

Function: http-handler CLIENT SERVER CONFIG

Package

yxorp

Source

main.lisp (file)

Function: main &aux ARGS

Package

yxorp

Source

main.lisp (file)

Function: make-keyword NAME

Package

yxorp

Source

utils.lisp (file)

Function: make-ssl-stream STREAM CONFIG

Package

yxorp

Source

utils.lisp (file)

Function: parse-header-line LINE

Package

yxorp

Source

utils.lisp (file)

Function: parse-request-headers STREAM

Package

yxorp

Source

utils.lisp (file)

Function: parse-response-headers STREAM

Package

yxorp

Source

utils.lisp (file)

Function: proxy-handler CLIENT CONFIG

Package

yxorp

Source

main.lisp (file)

Function: read-sequence* STREAM

Package

yxorp

Source

utils.lisp (file)

Function: save-ip HEADERS

Package

yxorp

Source

main.lisp (file)

Function: serialize-headers HEADERS

Package

yxorp

Source

utils.lisp (file)

Function: ssl-config-certificate INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: ssl-config-key INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: ssl-config-p OBJECT

Package

yxorp

Source

config.lisp (file)

Function: ssl-config-password INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: ssl-config-redirect-port INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: ssl-config-redirect-to INSTANCE

Package

yxorp

Source

config.lisp (file)

Function: ssl-redirect CLIENT CONFIG

Package

yxorp

Source

main.lisp (file)

Function: websocket-handler CLIENT SERVER

Package

yxorp

Source

main.lisp (file)

4.2.4 Types

Type: encoding ()

Package

yxorp

Source

coding.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types