Experimental IRC client, daemon and bot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README 2.7KB

5 years ago
5 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. ZyklonB
  2. =======
  3. `ZyklonB' is an experimental IRC bot, building upon the concept of my other
  4. VitaminA IRC bot. The main characteristic of these two bots is that they run
  5. plugins as coprocesses, which allows for enhanced reliability and programming
  6. language freedom.
  7. While originally intended to be a simple C99 rewrite of the original bot, which
  8. was written in the GNU dialect of AWK, it fairly quickly became a playground
  9. where I added everything that seemed nice.
  10. kike
  11. ----
  12. Also included is a simple IRC daemon that mostly follows the RFC's but is
  13. limited to single-server networks, due to the protocol being incredibly ugly and
  14. tricky to implement correctly (the poor quality of the RFC's doesn't help). It
  15. is designed for use as a regular user application rather than a system daemon.
  16. It is complete enough to be useful but there are still some things that need to
  17. be resolved before I can consider it stable.
  18. Some interesting features:
  19. - SSL/TLS autodetection
  20. - IRCop authentication through SSL/TLS client certificates
  21. - epoll support on Linux
  22. - superfast build time, small memory footprint
  23. Building and Running
  24. --------------------
  25. Build dependencies: openssl, clang, pkg-config, GNU make, awk, sh
  26. If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work
  27. just as good. But there's no CMake support yet, so I force it in the Makefile.
  28. $ git clone https://github.com/pjanouch/ZyklonB.git
  29. $ make
  30. That is all, no installation is required, or supported for that matter.
  31. First you might want to generate a configuration file:
  32. $ ./zyklonb --write-default-config
  33. $ ./kike --write-default-config
  34. After making any necessary edits to the file (there are comments to aid you in
  35. doing that), simply run the appropriate program with no arguments:
  36. $ ./zyklonb
  37. $ ./kike
  38. ZyklonB stays running in the foreground, so I recommend launching it inside
  39. a Screen or tmux session. kike, on the other hand, immediately forks into the
  40. background. Use something like `killall' if you want to terminate it.
  41. Client Certificates
  42. -------------------
  43. `kike' uses SHA1 fingerprints of SSL client certificates to authenticate users.
  44. To get the fingerprint from a certificate file in the required form, use:
  45. $ openssl x509 -in public.pem -outform DER | sha1sum
  46. Disclaimer
  47. ----------
  48. I am not an antisemitist, I'm just being an offensive asshole with the naming.
  49. And no, I'm not going to change the names.
  50. License
  51. -------
  52. `ZyklonB' is written by Přemysl Janouch <p.janouch@gmail.com>.
  53. You may use the software under the terms of the ISC license, the text of which
  54. is included within the package, or, at your option, you may relicense the work
  55. under the MIT or the Modified BSD License, as listed at the following site:
  56. http://www.gnu.org/licenses/license-list.html