]> arthur.barton.de Git - ngircd-alex.git/blob - doc/SSL.txt
TLS/SSL support: documentation.
[ngircd-alex.git] / doc / SSL.txt
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001-2004 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                ngIRCd is free software and published under the
8                    terms of the GNU General Public License.
9
10                                  -- SSL.txt --
11
12
13 ngIRCd supports SSL/TLSv1 encrypted connections using the
14 OpenSSL or gnutls library.
15 Both encryped server <-> client and server <-> server links should work.
16
17 BEWARE! The Code is mostly untested, use at your own risk!
18
19 Example that creates a self-signed certificate and key (using OpenSSL):
20 openssl req -newkey rsa:2048 -x509 -keyout server-key.pem \
21                 -out server-cert.pem -days 1461
22
23 Example that creates DH parameters (optional):
24 openssl dhparam -2 -out dhparams.pem 2048
25
26 Example that creates a self-signed certificate
27 and key (using gnutls):
28
29 certtool --generate-privkey --bits 2048 --outfile server-key.pem
30 certtool --generate-self-signed --load-privkey server-key.pem \
31                  --outfile server-cert.pem
32
33 Example that creates DH parameters (optional):
34 certtool  --generate-dh-params --bits 2048 --outfile dhparams.pem
35
36 Alternatively, you may use external programs/tools like stunnel to
37 make it work:
38
39   <http://stunnel.mirt.net/>
40   <http://www.stunnel.org/>
41
42 Stefan Sperling (stefan at binarchy dot net) mailed me the following text as a
43 short "how-to", thanks Stefan!
44
45
46 === snip ===
47     ! This guide applies to stunnel 4.x !
48
49     Put this in your stunnel.conf:
50
51         [ircs]
52         accept = 6667
53         connect = 6668
54
55     This makes stunnel listen for incoming connections
56     on port 6667 and forward decrypted data to port 6668.
57     We call the connection 'ircs'. Stunnel will use this
58     name when logging connection attempts via syslog.
59     You can also use the name in /etc/hosts.{allow,deny}
60     if you run tcp-wrappers.
61
62     To make sure ngircd is listening on the port where
63     the decrypted data arrives, set
64
65         Ports = 6668
66
67     in your ngircd.conf.
68
69     Start stunnel and restart ngircd.
70
71     That's it.
72     Don't forget to activate ssl support in your irc client ;)
73 === snip ===
74
75
76
77
78 -- 
79 $Id: SSL.txt,v 1.2 2004/12/27 01:11:40 alex Exp $