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 4.3KB

5 years ago
5 years ago
5 years ago
5 years ago
4 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. uirc3
  2. =====
  3. The unethical IRC trinity. This project consists of an experimental IRC client,
  4. daemon, and bot. It's all you're ever going to need for chatting.
  5. All of them have these potentially interesting properties:
  6. - full IPv6 support
  7. - SSL/TLS support, including client certificates
  8. - minimal dependencies
  9. - very compact and easy to hack on
  10. degesch
  11. -------
  12. The IRC client. I thought it would be interesting to build an IRC client on
  13. top of libreadline. At least it's way simpler than doing it in ncurses.
  14. The interface should feel familiar for weechat users.
  15. It's the youngest and largest of them all and currently under heavy development.
  16. kike
  17. ----
  18. The IRC daemon. It mostly follows RFCs but it can't form networks consisting
  19. of multiple servers, or use any services packages, such as Atheme. (Mostly due
  20. to the protocol being incredibly ugly and tricky to implement correctly, with
  21. the poor quality of the RFCs not helping much). It is designed to be used as
  22. a regular user application rather than a system daemon.
  23. It is complete enough to be useful but there are still some things that need to
  24. be resolved before I can consider it stable.
  25. Notable features:
  26. - SSL/TLS autodetection (why doesn't everyone have this?)
  27. - IRCop authentication through SSL/TLS client certificates
  28. - epoll support on Linux; it should be able to handle quite a number of users
  29. ZyklonB
  30. -------
  31. The IRC bot. It builds upon the concept of my other VitaminA IRC bot. The main
  32. characteristic of these two bots is that they run plugins as coprocesses, which
  33. allows for enhanced reliability and programming language freedom.
  34. While originally intended to be a simple C99 rewrite of the original bot, which
  35. was written in the GNU dialect of AWK, it fairly quickly became a playground
  36. where I added everything that seemed nice.
  37. Notable features:
  38. - resilient against crashes, server disconnects and timeouts
  39. - SOCKS support (even though socksify can add that easily to any program)
  40. Building
  41. --------
  42. Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included)
  43. Runtime dependencies: openssl, curses (degesch), readline or libedit (degesch)
  44. $ git clone https://github.com/pjanouch/uirc3.git
  45. $ git submodule init
  46. $ git submodule update
  47. $ mkdir build
  48. $ cd build
  49. $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
  50. -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF
  51. $ make
  52. To install the application, you can do either the usual:
  53. # make install
  54. Or you can try telling CMake to make a package for you. For Debian it is:
  55. $ cpack -G DEB
  56. # dpkg -i uirc3-*.deb
  57. Note that for versions of CMake before 2.8.9, you need to prefix cpack with
  58. `fakeroot' or file ownership will end up wrong.
  59. Running
  60. -------
  61. `degesch' has in-program configuration. Just run it and type "/help".
  62. For the rest you might want to generate a configuration file:
  63. $ zyklonb --write-default-config
  64. $ kike --write-default-config
  65. After making any necessary edits to the file (there are comments to aid you in
  66. doing that), simply run the appropriate program with no arguments:
  67. $ zyklonb
  68. $ kike
  69. `ZyklonB' stays running in the foreground, therefore I recommend launching it
  70. inside a Screen or tmux session. `kike', on the other hand, immediately forks
  71. into the background. Use something like `killall' if you want to terminate it.
  72. Client Certificates
  73. -------------------
  74. `kike' uses SHA1 fingerprints of SSL client certificates to authenticate users.
  75. To get the fingerprint from a certificate file in the required form, use:
  76. $ openssl x509 -in public.pem -outform DER | sha1sum
  77. Contributing and Support
  78. ------------------------
  79. Use this project's GitHub to report any bugs, request features, or submit pull
  80. requests. If you want to discuss this project, or maybe just hang out with
  81. the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
  82. Disclaimer
  83. ----------
  84. I am not an antisemitist, I'm just being an offensive asshole with the naming.
  85. And no, I'm not going to change the names.
  86. License
  87. -------
  88. `uirc3' is written by Přemysl Janouch <p.janouch@gmail.com>.
  89. You may use the software under the terms of the ISC license, the text of which
  90. is included within the package, or, at your option, you may relicense the work
  91. under the MIT or the Modified BSD License, as listed at the following site:
  92. http://www.gnu.org/licenses/license-list.html