doc: drop mentions to .pow files ($deity REST their soul)

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2020-12-24 13:30:23 +01:00
parent e72c65c859
commit 26fa12c871
31 changed files with 159 additions and 146 deletions
@@ -11,7 +11,8 @@ In this example we'll be adding the header ``X-Content-Type-Options`` to the res
.. code-block:: console
:linenos:
$ cat sniff.pow
$ cat sniff-route
#!/usr/bin/env sh
kapow route add /sec-hello-world - <<-'EOF'
kapow set /response/headers/X-Content-Type-Options nosniff
kapow set /response/headers/Content-Type text/plain
@@ -19,7 +20,7 @@ In this example we'll be adding the header ``X-Content-Type-Options`` to the res
echo this will be interpreted as plain text | kapow set /response/body
EOF
$ kapow server nosniff.pow
$ kapow server nosniff-route
Testing with :program:`curl`:
@@ -67,7 +68,8 @@ Uploading a file using *Kapow!* is very simple:
.. code-block:: console
:linenos:
$ cat upload.pow
$ cat upload-route
#!/usr/bin/env sh
kapow route add -X POST /upload-file - <<-'EOF'
kapow get /request/files/data/content | kapow set /response/body
EOF
@@ -89,7 +91,8 @@ In this example we reply the line count of the file received in the request:
.. code-block:: console
:linenos:
$ cat count-file-lines.pow
$ cat count-file-lines
#!/usr/bin/env sh
kapow route add -X POST /count-file-lines - <<-'EOF'
# Get sent file
@@ -121,7 +124,8 @@ You can specify custom status code for `HTTP` response:
.. code-block:: console
:linenos:
$ cat error.pow
$ cat error-route
#!/usr/bin/env sh
kapow route add /error - <<-'EOF'
kapow set /response/status 401
echo -n '401 error' | kapow set /response/body
@@ -158,7 +162,8 @@ In this example we'll redirect our users to `Google`:
.. code-block:: console
:linenos:
$ cat redirect.pow
$ cat redirect
#!/usr/bin/env sh
kapow route add /redirect - <<-'EOF'
kapow set /response/headers/Location https://google.com
kapow set /response/status 301
@@ -196,7 +201,8 @@ In the next example we'll set a cookie:
.. code-block:: console
:linenos:
$ cat cookie.pow
$ cat cookie
#!/usr/bin/env sh
kapow route add /setcookie - <<-'EOF'
CURRENT_STATUS=$(kapow get /request/cookies/kapow-status)
+2 -2
View File
@@ -33,7 +33,7 @@ command line:
.. code-block:: console
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile foobar.pow
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile foobar-route
Now *Kapow!* is listening on its default port (8080) accepting requests over
HTTPS. You can test it with the following command:
@@ -60,7 +60,7 @@ CA certificate issuing the client certificates we want to accept with the
.. code-block:: console
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile --clientauth=true --clientcafile path/to/clientCAfile foobar.pow
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile --clientauth=true --clientcafile path/to/clientCAfile foobar-route
With this configuration *Kapow!* will reject connections that do not present a
client certificate or one certificate not issued by the specified CA. You can
+5 -3
View File
@@ -10,7 +10,8 @@ from query params:
.. code-block:: console
:linenos:
$ cat parallel.pow
$ cat parallel-route
#!/usr/bin/env sh
kapow route add '/parallel/{ip1}/{ip2}' - <<-'EOF'
ping -c 1 -- "$(kapow get /request/matches/ip1)" | kapow set /response/body &
ping -c 1 -- "$(kapow get /request/matches/ip2)" | kapow set /response/body &
@@ -30,5 +31,6 @@ Script debugging
Bash provides the ``set -x`` builtin command that "After expanding each simple command,
for command, case command, select command, or arithmetic for command, display the
expanded value of PS4, followed by the command and its expanded arguments or associated
word list". This feature can be used to help debugging the `.pow` scripts and, together
the ``--debug`` option in the server sub-command, the scripts executed in user requests.
word list". This feature can be used to help debugging the init programs and,
together the ``--debug`` option in the server sub-command, the scripts executed
in user requests.
+1 -1
View File
@@ -3,7 +3,7 @@ Examples
.. toctree::
working_with_pow_files
working_with_init_programs
managing_routes
handling_http_requests
using_json
+5 -3
View File
@@ -16,12 +16,13 @@ Example #1
++++++++++
In this example our *Kapow!* service will receive a `JSON` value with an incorrect
date, then our ``pow`` file will fix it and return the correct value to the user.
date, then our init program will fix it and return the correct value to the user.
.. code-block:: console
:linenos:
$ cat fix_date.pow
$ cat fix_date
#!/usr/bin/env sh
kapow route add -X POST /fix-date - <<-'EOF'
kapow set /response/headers/Content-Type application/json
kapow get /request/body | jq --arg newdate "$(date +'%Y-%m-%d_%H-%M-%S')" '.incorrectDate=$newdate' | kapow set /response/body
@@ -46,7 +47,8 @@ order to generate a two-attribute `JSON` response.
.. code-block:: console
$ cat echo-attribute.pow
$ cat echo-attribute
#!/usr/bin/env sh
kapow route add -X POST /echo-attribute - <<-'EOF'
JSON_WHO=$(kapow get /request/body | jq -r .name)
@@ -1,27 +1,28 @@
Working with pow Files
======================
Working with Init Scripts
=========================
Starting *Kapow!* using a pow file
----------------------------------
Starting *Kapow!* using an init script
--------------------------------------
A :file:`pow` file is just a :command:`bash` script, where you make calls to the
``kapow route`` command.
An init program, which can be just a shell script, allows you to make calls to
the ``kapow route`` command.
.. code-block:: console
:linenos:
$ kapow server example.pow
$ kapow server example-init-program
With the :file:`example.pow`:
With the :file:`example-init-program`:
.. code-block:: console
:linenos:
$ cat example.pow
$ cat example-init-program
#!/usr/bin/env sh
#
# This is a simple example of a pow file
# This is a simple example of an init program
#
echo '[*] Starting my script'
echo '[*] Starting my init program'
# We add 2 Kapow! routes
kapow route add /my/route -c 'echo hello world | kapow set /response/body'
@@ -29,32 +30,19 @@ With the :file:`example.pow`:
.. note::
*Kapow!* can be fully configured using just :file:`pow` files
*Kapow!* can be fully configured using just init scripts
Load More Than One pow File
---------------------------
Writing Multiline Routes
------------------------
You can load more than one :file:`pow` file at time. This can help you keep
your :file:`pow` files tidy.
If you need to write more complex actions, you can leverage multiline routes:
.. code-block:: console
:linenos:
$ ls pow-files/
example-1.pow example-2.pow
$ kapow server <(cat pow-files/*.pow)
Writing Multiline pow Files
---------------------------
If you need to write more complex actions, you can leverage multiline commands:
.. code-block:: console
:linenos:
$ cat multiline.pow
$ cat multiline-route
#!/usr/bin/env sh
kapow route add /log_and_stuff - <<-'EOF'
echo this is a quite long sentence and other stuff | tee log.txt | kapow set /response/body
cat log.txt | kapow set /response/body
@@ -77,43 +65,45 @@ Keeping Things Tidy
Sometimes things grow, and keeping things tidy is the only way to mantain the
whole thing.
You can distribute your endpoints in several pow files. And you can keep the
whole thing documented in one html file, served with *Kapow!*.
You can distribute your endpoints in several init programs. And you can keep
the whole thing documented in one html file, served with *Kapow!*.
.. code-block:: console
:linenos:
$ cat index.pow
$ cat index-route
#!/usr/bin/env sh
kapow route add / - <<-'EOF'
cat howto.html | kapow set /response/body
EOF
source ./info_stuff.pow
source ./other_endpoints.pow
source ./info_stuff
source ./other_endpoints
As you can see, the `pow` files can be imported into another `pow` file using
source. In fact, a `pow` file is just a regular shell script.
You can import other shell script libraries with `source`.
Debugging scripts
-----------------
Since *Kapow!* redirects the standard output and the standard error of the `pow`
file given on server startup to its own, you can leverage ``set -x`` to see the
commands that are being executed, and use that for debugging.
Debugging Init Programs/Scripts
-------------------------------
Since *Kapow!* redirects the standard output and the standard error of the init
program given on server startup to its own, you can leverage ``set -x`` to see
the commands that are being executed, and use that for debugging.
To support debugging user request executions, the server subcommand has a
``--debug`` option flag that prompts *Kapow!* to redirect both the script's
standard output and standard error to *Kapow!*'s standard output, so you can
leverage ``set -x`` the same way as with `pow` files.
leverage ``set -x`` the same way as with init programs.
.. code-block:: console
$ cat withdebug.pow
$ cat withdebug-route
#!/usr/bin/env sh
kapow route add / - <<-'EOF'
set -x
echo "This will be seen in the log"
echo "Hi HTTP" | kapow set /response/body
EOF
$ kapow server --debug withdebug.pow
$ kapow server --debug withdebug-route
+1 -1
View File
@@ -75,7 +75,7 @@ Contents
:maxdepth: 2
:caption: Usage Examples
examples/working_with_pow_files
examples/working_with_init_programs
examples/managing_routes
examples/handling_http_requests
examples/using_json
@@ -111,7 +111,7 @@ After building the image you can run the container with:
.. code-block:: console
$ docker run --rm -i -p 8080:8080 -v $(pwd)/whatever.pow:/opt/whatever.pow kapow:latest server /opt/whatever.pow
$ docker run --rm -i -p 8080:8080 -v $(pwd)/whatever-route:/opt/whatever-route kapow:latest server /opt/whatever-route
With the ``-v`` parameter we map a local file into the container's filesystem so
we can use it to configure our *Kapow!* server on startup.
+12 -7
View File
@@ -116,10 +116,10 @@ Install *Kapow!*
Follow the :ref:`installation instructions <installation>`.
Write a :file:`ping.pow` File
+++++++++++++++++++++++++++++
Write an Init Program :file:`ping-route`
+++++++++++++++++++++++++++++++++++++++
*Kapow!* uses plain text files (called `pow` files) where the endpoints you want
*Kapow!* uses init programs/scripts where the endpoints you want
to expose are defined.
For each endpoint, you can decide which commands get executed.
@@ -128,11 +128,15 @@ For our example we need a file like this:
.. code-block:: console
$ cat ping.pow
$ chmod +x ping-route
$ cat ping-route
#!/usr/bin/env sh
kapow route add /ping -c 'ping -c 1 10.10.10.100 | kapow set /response/body'
Let's dissect this beast piece by piece:
#. ``#!/usr/bin/env sh`` - shebang line so that the kernel knows which
interpreter to use
#. ``kapow route add /ping`` - adds a new `HTTP API` endpoint at ``/ping``
path in the *Kapow!* server. You have to use the ``GET`` method to invoke
the endpoint.
@@ -147,18 +151,19 @@ Let's dissect this beast piece by piece:
Launch the Service
++++++++++++++++++
At this point, we only need to launch :program:`kapow` with our :file:`ping.pow`:
At this point, we only need to launch :program:`kapow` with our
:file:`ping-route`:
.. code-block:: console
$ kapow server ping.pow
$ kapow server ping-route
*Kapow!* can expose the user interface through HTTPS, to do this provide the
corresponding key and certificates chain paths at startup:
.. code-block:: console
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile ping.pow
$ kapow server --keyfile path/to/keyfile --certfile path/to/certfile ping-route
Consume the Service
+4 -2
View File
@@ -28,7 +28,8 @@ In this example, an attacker can inject arbitrary parameters to :command:`ls`.
.. code-block:: console
:linenos:
$ cat command-injection.pow
$ cat command-injection
#!/usr/bin/env sh
kapow route add '/vulnerable/{value}' - <<-'EOF'
ls $(kapow get /request/matches/value) | kapow set /response/body
EOF
@@ -48,7 +49,8 @@ request:
.. code-block:: console
:linenos:
$ cat command-injection.pow
$ cat command-injection
#!/usr/bin/env sh
kapow route add '/not-vulnerable/{value}' - <<-'EOF'
ls -- "$(kapow get /request/matches/value)" | kapow set /response/body
EOF
+8 -8
View File
@@ -138,22 +138,22 @@ Let's Backup that Database!
**Senior**
Not at all. The creators of *Kapow!* have thought of everything. You can put
all your route definitions in a special script file and pass it to the server
on startup. They call those files :file:`pow` files and they have
:file:`.pow` extension.
all your route definitions on init programs, which can be shell scripts, and
pass them to the server on startup.
It should look something like:
.. code-block:: console
$ cat backup.pow
$ cat backup-route
#!/usr/bin/env sh
kapow route add -X PUT /db/backup -e ./backup_db.sh
And then you can start *Kapow!* with it:
.. code-block:: console
$ kapow server backup.pow
$ kapow server backup-route
**Junior**
@@ -161,10 +161,10 @@ Let's Backup that Database!
.. code-block:: console
$ kapow server backup.pow
2019/11/26 11:40:01 Running powfile: "backup.pow"
$ kapow server backup-route
2019/11/26 11:40:01 Running init program: "backup-route"
{"id":"19bb4ac7-1039-11ea-aa00-106530610c4d","method":"PUT","url_pattern":"/db/backup","entrypoint":"./backup_db.sh","command":"","index":0}
2019/11/26 11:40:01 Done running powfile: "backup.pow"
2019/11/26 11:40:01 Done running init program: "backup-route"
I understand that this is proof that we have the endpoint available.
+2 -1
View File
@@ -37,10 +37,11 @@ What have we done?
**Junior**
Let me try add this to our :file:`pow` file:
Let me try add this to our init program:
.. code-block:: console
#!/usr/bin/env sh
kapow route add /db/backup_logs -c 'cat /tmp/backup_db.log | kapow set /response/body'
**Senior**
+8 -2
View File
@@ -44,7 +44,9 @@ Securing the server
.. code-block:: console
$ kapow server --keyfile /etc/kapow/tls/keyfile --certfile /etc/kapow/tls/certfile /etc/kapow/awesome.pow
$ kapow server --keyfile /etc/kapow/tls/keyfile \
--certfile /etc/kapow/tls/certfile \
/etc/kapow/awesome-route
It's easy, please copy the private key file and certificate chain to `/etc/kapow/tls` and we can restart.
@@ -70,7 +72,11 @@ Securing the server
.. code-block:: console
$ kapow server --keyfile /etc/kapow/tls/keyfile --certfile /etc/kapow/tls/certfile --clientauth=true --clientcafile /etc/kapow/tls/clientCAfile /etc/kapow/awesome.pow
$ kapow server --keyfile /etc/kapow/tls/keyfile \
--certfile /etc/kapow/tls/certfile \
--clientauth true \
--clientcafile /etc/kapow/tls/clientCAfile \
/etc/kapow/awesome-route
Done!