1e63f3c104
. kapow server generates on startup a pair of certificates that will use to secure communications to its control server. It will communicate the server and client certificates as well as the client private key to the init programs it launches, via environment variables. . kapow server now understands a new flag --control-reachable-addr which accepts either a IP address or a DNS name, that can be used to ensure that the generated server certificate will be appropiate in case the control server must be accessed from something other than localhost. Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
88 lines
3.4 KiB
Markdown
88 lines
3.4 KiB
Markdown
<p align="center">
|
|
<img alt="Kapow! Logo" src="https://raw.githubusercontent.com/BBVA/kapow/master/docs/source/_static/logo.png" width=300 />
|
|
<h3 align="center">If you can script it, you can HTTP it.</h3>
|
|
<p align="center">
|
|
<a href="https://github.com/BBVA/kapow/actions?query=workflow%3ATest"><img alt="Test status" src="https://github.com/BBVA/kapow/workflows/Test/badge.svg" /></a>
|
|
<a href="https://goreportcard.com/badge/github.com/bbva/kapow"><img alt="Go Report" src="https://goreportcard.com/badge/github.com/bbva/kapow" /></a>
|
|
<a href="https://github.com/BBVA/kapow/issues/"><img alt="Open Issues" src="https://img.shields.io/github/issues/BBVA/kapow" /></a>
|
|
<a href="https://kapow.readthedocs.io"><img alt="Documentation" src="https://img.shields.io/readthedocs/kapow" /></a>
|
|
<a href="https://github.com/BBVA/kapow/releases"><img alt="Current Version" src="https://img.shields.io/github/v/release/BBVA/kapow?include_prereleases" /></a>
|
|
</p>
|
|
</p>
|
|
|
|
---
|
|
|
|
## What's *Kapow!*
|
|
|
|
Say we have a nice cozy **shell command** that solves our problem. *Kapow!* lets
|
|
us easily **turn that into an HTTP API**.
|
|
|
|
|
|
### Let's see this with an example
|
|
|
|
We want to expose **log entries** for files not found on our **Apache Web
|
|
Server**, as an HTTP API. With *Kapow!* we just need to write this
|
|
*executable* script:
|
|
|
|
``` console
|
|
[apache-host]$ cat search-apache-errors
|
|
#!/usr/bin/env sh
|
|
kapow route add /apache-errors - <<-'EOF'
|
|
cat /var/log/apache2/access.log | grep 'File does not exist' | kapow set /response/body
|
|
EOF
|
|
[apache-host]$ chmod +x search-apache-errors
|
|
```
|
|
|
|
and then, run it using *Kapow!*
|
|
|
|
```bash
|
|
[apache-host]$ kapow server search-apache-errors
|
|
```
|
|
|
|
finally, we can read from the just-defined endpoint:
|
|
|
|
```bash
|
|
[another-host]$ curl http://apache-host:8080/apache-errors
|
|
[Fri Feb 01 22:07:57.154391 2019] [core:info] [pid 7:tid 140284200093440] [client 172.17.0.1:50756] AH00128: File does not exist: /usr/var/www/mysite/favicon.ico
|
|
[Fri Feb 01 22:07:57.808291 2019] [core:info] [pid 8:tid 140284216878848] [client 172.17.0.1:50758] AH00128: File does not exist: /usr/var/www/mysite/favicon.ico
|
|
[Fri Feb 01 22:07:57.878149 2019] [core:info] [pid 8:tid 140284208486144] [client 172.17.0.1:50758] AH00128: File does not exist: /usr/var/www/mysite/favicon.ico
|
|
...
|
|
```
|
|
|
|
### Why *Kapow!* shines in these cases
|
|
|
|
- We can share information **without having to grant SSH access** to anybody.
|
|
- We can share information easily **over HTTP**.
|
|
- We can effectively **limit** what gets executed.
|
|
|
|
|
|
## Documentation
|
|
|
|
You can find the complete documentation and examples [here](https://kapow.readthedocs.io).
|
|
|
|
## Security
|
|
|
|
Please consider the following
|
|
[Security Concerns](https://kapow.readthedocs.io/en/stable/the_project/security.html#security-concerns)
|
|
**before** using *Kapow!*
|
|
|
|
If you are not 100% sure about what you are doing we recommend not using *Kapow!*
|
|
|
|
## Authors
|
|
|
|
*Kapow!* is being developed by [BBVA-Labs Security team members](https://github.com/BBVA/kapow/blob/master/AUTHORS.rst).
|
|
|
|
*Kapow!* is Open Source Software and available under the [Apache 2
|
|
license](https://raw.githubusercontent.com/BBVA/kapow/master/LICENSE).
|
|
|
|
|
|
## Contributions
|
|
|
|
Contributions are of course welcome. See
|
|
[CONTRIBUTING](https://raw.githubusercontent.com/BBVA/kapow/master/CONTRIBUTING.rst)
|
|
or skim existing tickets to see where you could help out.
|
|
|
|
---
|
|
|
|
* [Did you spot the UUoC?](https://github.com/BBVA/kapow/issues/118) Congrats! We are hoping [to win](http://porkmail.org/era/unix/award.html) this year :)
|