diff options
| author | Michael Czigler <37268479+mcpcpc@users.noreply.github.com> | 2020-09-22 09:43:26 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-22 09:43:26 -0400 |
| commit | a08baa74ab8be8942f63ee2db2792833b6a90be1 (patch) | |
| tree | 01521ed55c744e6c7be9e57d3447af5f53754753 /README.md | |
| parent | add SASL support (diff) | |
| download | kirc-a08baa74ab8be8942f63ee2db2792833b6a90be1.tar.gz kirc-a08baa74ab8be8942f63ee2db2792833b6a90be1.tar.bz2 kirc-a08baa74ab8be8942f63ee2db2792833b6a90be1.tar.xz kirc-a08baa74ab8be8942f63ee2db2792833b6a90be1.tar.zst kirc-a08baa74ab8be8942f63ee2db2792833b6a90be1.zip | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -24,6 +24,7 @@ usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] [-u us -n nickname (required) -u server username (optional) -k server password (optional) +-a SASL PLAIN authentication token (optional) -r real name (optional) -v version information -V verbose output (e.g. raw stream) @@ -98,6 +99,24 @@ socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697 kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname' ``` +## SASL Plain Support + +In order to connect using SASL authentication, the user must provide the required token during the initial connection. If the authentication token is base64 encoded and, therefore, can be generated a number of ways. For example, using Python, one could use the following: + +```shell +python -c 'import base64; print(base64.encodebytes(b"nick\x00nick\x00password"))' +``` + +For example, lets assume an authentication identity of `jilles` and password `sesame`: + +```shell +$ python -c 'import base64; print(base64.encodebytes(b"jilles\x00jilles\x00sesame"))' + +b 'amlsbGVzAGppbGxlcwBzZXNhbWU=\n' + +$ kirc -n jilles -a amlsbGVzAGppbGxlcwBzZXNhbWU= +``` + ## Contact For any further questions or concerns, feel free to reach out to me on `#kirc` |