diff options
| author | Michael Czigler <37268479+mcpcpc@users.noreply.github.com> | 2020-09-22 15:53:43 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-22 15:53:43 -0400 |
| commit | 9d0cd883fc87139897121f4c0b52dab70c198823 (patch) | |
| tree | a38ce899818846bd8d73909f6915b336cdb7e40d /README.md | |
| parent | Merge pull request #30 from Humm42/master (diff) | |
| parent | remove extra spaces (diff) | |
| download | kirc-9d0cd883fc87139897121f4c0b52dab70c198823.tar.gz kirc-9d0cd883fc87139897121f4c0b52dab70c198823.tar.bz2 kirc-9d0cd883fc87139897121f4c0b52dab70c198823.tar.xz kirc-9d0cd883fc87139897121f4c0b52dab70c198823.tar.zst kirc-9d0cd883fc87139897121f4c0b52dab70c198823.zip | |
Merge pull request #31 from mcpcpc/sasl-support
Add SASL PLAIN support
Diffstat (limited to '')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 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,22 @@ 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` |