README
¶
Kik XMPP Go Proxy
Originally written in Java, but now being ported to Go (for performance reasons and learning), this tool allows you to proxy XMPP connections from your server to another by MITMing them.
The server listens on port 5222 for plain text connections by default, and 5223 by default for SSL connections.
The server connects to Kik via port 443 by default.
Use cases for this include:
- Validating stream headers (
<ktags) from clients - Intercepting / modifying packets
- Filtering incoming spam before it's sent to the client
- Improved connection stability
- Debugging traffic from the official mobile clients (stock Kik) or your custom client
Requirements
Go >= 1.23 (on *nix it can be easily installed here)
Install, build and run
git clone https://github.com/bluemods/kik-go-proxy && cd kik-go-proxy
go mod tidy && go build && ./kik-go-proxy
Arguments
Note: If you use -cert -key or -p12 -p12-pass flag pairs, the program will use them to open an encrypted (SSL) connection.
The -cert -key and -p12 -p12-pass flags are mutually exclusive, you should use one or the other depending on the encoding of your certificate.
By default, the server accepts TLSv1.2 and up for clients connecting using SSL.
| Argument | Effect |
|---|---|
| -port | Change the port that the server will listen for connections on. |
| -cert | The relative path to your X.509 certificate. |
| -key | The relative path to your certificate key. |
| -p12 | The relative path to your .p12 certificate file. |
| -p12-pass | The relative path to the file containing the p12 cert password. |
| -i | The relative path to your interface IP list, one per line |
| -iface | The interface name to use, used with -i |
| -a | The relative path to an API key. If specified, all clients need to include the x-api-key="KEY HERE" attribute in the stream header. |
| -whitelist | file containing JIDs / device IDs that do not require API key authentication, one per line |
| -ban | If specified, misbehaving clients will be IP banned from the server using iptables. If ipset is also installed, kik-go-proxy will create a new ipset hash list and ban them that way which is much more efficient. See ip_banner.go |
| -banner | If specified, the server sends back a 'server' header to the client upon successful authentication |
Notices
- On Unix systems, you might get errors like
Error accepting: accept tcp4 0.0.0.0:5222: accept4: too many open files.
If you do, try raising the ulimit. - If running this on a public facing server without the -a argument, it is an open proxy. Make sure to configure your firewall to only allow trusted IPs.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
third_party
|
|
|
encoding
This is a fork of Go's XML package, especially designed to work with Kik's XMPP streams.
|
This is a fork of Go's XML package, especially designed to work with Kik's XMPP streams. |
|
encoding/xml
Package xml implements a simple XML 1.0 parser that understands XML name spaces.
|
Package xml implements a simple XML 1.0 parser that understands XML name spaces. |
|
goxpp
This is a heavily modified version of goxpp.
|
This is a heavily modified version of goxpp. |
|
xmlwriter
Package xmlwriter provides a fast, non-cached, forward-only way to generate XML data.
|
Package xmlwriter provides a fast, non-cached, forward-only way to generate XML data. |