]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - src/modules/extra/m_ssl_openssl.cpp
m_ssl_openssl Use the system default cipher list if no cipher list is specifed
[user/henk/code/inspircd.git] / src / modules / extra / m_ssl_openssl.cpp
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
6  *   Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
7  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
10  *
11  * This file is part of InspIRCd.  InspIRCd is free software: you can
12  * redistribute it and/or modify it under the terms of the GNU General Public
13  * License as published by the Free Software Foundation, version 2.
14  *
15  * This program is distributed in the hope that it will be useful, but WITHOUT
16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  */
23
24
25 #include "inspircd.h"
26 #include <openssl/ssl.h>
27 #include <openssl/err.h>
28 #include "ssl.h"
29
30 #ifdef WINDOWS
31 # pragma comment(lib, "libcrypto.lib")
32 # pragma comment(lib, "libssl.lib")
33 # pragma comment(lib, "user32.lib")
34 # pragma comment(lib, "advapi32.lib")
35 # pragma comment(lib, "libgcc.lib")
36 # pragma comment(lib, "libmingwex.lib")
37 # pragma comment(lib, "gdi32.lib")
38 # undef MAX_DESCRIPTORS
39 # define MAX_DESCRIPTORS 10000
40 #endif
41
42 /* $ModDesc: Provides SSL support for clients */
43
44 /* $LinkerFlags: if("USE_FREEBSD_BASE_SSL") -lssl -lcrypto */
45 /* $CompileFlags: if(!"USE_FREEBSD_BASE_SSL") pkgconfversion("openssl","0.9.7") pkgconfincludes("openssl","/openssl/ssl.h","") */
46 /* $LinkerFlags: if(!"USE_FREEBSD_BASE_SSL") rpath("pkg-config --libs openssl") pkgconflibs("openssl","/libssl.so","-lssl -lcrypto -ldl") */
47
48 /* $NoPedantic */
49
50
51 enum issl_status { ISSL_NONE, ISSL_HANDSHAKING, ISSL_OPEN };
52
53 static bool SelfSigned = false;
54
55 char* get_error()
56 {
57         return ERR_error_string(ERR_get_error(), NULL);
58 }
59
60 static int error_callback(const char *str, size_t len, void *u);
61
62 /** Represents an SSL user's extra data
63  */
64 class issl_session
65 {
66 public:
67         SSL* sess;
68         issl_status status;
69         reference<ssl_cert> cert;
70
71         int fd;
72         bool outbound;
73         bool data_to_write;
74
75         issl_session()
76         {
77                 outbound = false;
78                 data_to_write = false;
79         }
80 };
81
82 static int OnVerify(int preverify_ok, X509_STORE_CTX *ctx)
83 {
84         /* XXX: This will allow self signed certificates.
85          * In the future if we want an option to not allow this,
86          * we can just return preverify_ok here, and openssl
87          * will boot off self-signed and invalid peer certs.
88          */
89         int ve = X509_STORE_CTX_get_error(ctx);
90
91         SelfSigned = (ve == X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT);
92
93         return 1;
94 }
95
96 class ModuleSSLOpenSSL : public Module
97 {
98         int inbufsize;
99         issl_session* sessions;
100
101         SSL_CTX* ctx;
102         SSL_CTX* clictx;
103
104         char cipher[MAXBUF];
105
106         std::string sslports;
107         bool use_sha;
108
109         ServiceProvider iohook;
110  public:
111
112         ModuleSSLOpenSSL() : iohook(this, "ssl/openssl", SERVICE_IOHOOK)
113         {
114                 sessions = new issl_session[ServerInstance->SE->GetMaxFds()];
115
116                 // Not rehashable...because I cba to reduce all the sizes of existing buffers.
117                 inbufsize = ServerInstance->Config->NetBufferSize;
118
119                 /* Global SSL library initialization*/
120                 SSL_library_init();
121                 SSL_load_error_strings();
122
123                 /* Build our SSL contexts:
124                  * NOTE: OpenSSL makes us have two contexts, one for servers and one for clients. ICK.
125                  */
126                 ctx = SSL_CTX_new( SSLv23_server_method() );
127                 clictx = SSL_CTX_new( SSLv23_client_method() );
128
129                 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
130                 SSL_CTX_set_mode(clictx, SSL_MODE_ENABLE_PARTIAL_WRITE | SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
131
132                 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
133                 SSL_CTX_set_verify(clictx, SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE, OnVerify);
134         }
135
136         void init()
137         {
138                 // Needs the flag as it ignores a plain /rehash
139                 OnModuleRehash(NULL,"ssl");
140                 Implementation eventlist[] = { I_On005Numeric, I_OnRehash, I_OnModuleRehash, I_OnHookIO, I_OnUserConnect };
141                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
142                 ServerInstance->Modules->AddService(iohook);
143         }
144
145         void OnHookIO(StreamSocket* user, ListenSocket* lsb)
146         {
147                 if (!user->GetIOHook() && lsb->bind_tag->getString("ssl") == "openssl")
148                 {
149                         /* Hook the user with our module */
150                         user->AddIOHook(this);
151                 }
152         }
153
154         void OnRehash(User* user)
155         {
156                 sslports.clear();
157
158                 ConfigTag* Conf = ServerInstance->Config->ConfValue("openssl");
159                 
160                 if (Conf->getBool("showports", true))
161                 {
162                         for (size_t i = 0; i < ServerInstance->ports.size(); i++)
163                         {
164                                 ListenSocket* port = ServerInstance->ports[i];
165                                 if (port->bind_tag->getString("ssl") != "openssl")
166                                         continue;
167
168                                 std::string portid = port->bind_desc;
169                                 ServerInstance->Logs->Log("m_ssl_openssl", DEFAULT, "m_ssl_openssl.so: Enabling SSL for port %s", portid.c_str());
170                                 if (port->bind_tag->getString("type", "clients") == "clients" && port->bind_addr != "127.0.0.1")
171                                         sslports.append(portid).append(";");
172                         }
173
174                         if (!sslports.empty())
175                                 sslports.erase(sslports.end() - 1);
176                 }
177         }
178
179         void OnModuleRehash(User* user, const std::string &param)
180         {
181                 if (param != "ssl")
182                         return;
183
184                 std::string keyfile;
185                 std::string certfile;
186                 std::string cafile;
187                 std::string dhfile;
188                 OnRehash(user);
189
190                 ConfigTag* conf = ServerInstance->Config->ConfValue("openssl");
191
192                 cafile   = conf->getString("cafile", "conf/ca.pem");
193                 certfile = conf->getString("certfile", "conf/cert.pem");
194                 keyfile  = conf->getString("keyfile", "conf/key.pem");
195                 dhfile   = conf->getString("dhfile", "conf/dhparams.pem");
196                 std::string hash = conf->getString("hash", "md5");
197                 if (hash != "sha1" && hash != "md5")
198                         throw ModuleException("Unknown hash type " + hash);
199                 use_sha = (hash == "sha1");
200
201                 std::string ciphers = conf->getString("ciphers", "");
202
203                 if (!ciphers.empty())
204                 {
205                         if ((!SSL_CTX_set_cipher_list(ctx, ciphers.c_str())) || (!SSL_CTX_set_cipher_list(clictx, ciphers.c_str())))
206                         {
207                                 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't set cipher list to %s.", ciphers.c_str());
208                                 ERR_print_errors_cb(error_callback, this);
209                         }
210                 }
211
212                 /* Load our keys and certificates
213                  * NOTE: OpenSSL's error logging API sucks, don't blame us for this clusterfuck.
214                  */
215                 if ((!SSL_CTX_use_certificate_chain_file(ctx, certfile.c_str())) || (!SSL_CTX_use_certificate_chain_file(clictx, certfile.c_str())))
216                 {
217                         ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read certificate file %s. %s", certfile.c_str(), strerror(errno));
218                         ERR_print_errors_cb(error_callback, this);
219                 }
220
221                 if (((!SSL_CTX_use_PrivateKey_file(ctx, keyfile.c_str(), SSL_FILETYPE_PEM))) || (!SSL_CTX_use_PrivateKey_file(clictx, keyfile.c_str(), SSL_FILETYPE_PEM)))
222                 {
223                         ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read key file %s. %s", keyfile.c_str(), strerror(errno));
224                         ERR_print_errors_cb(error_callback, this);
225                 }
226
227                 /* Load the CAs we trust*/
228                 if (((!SSL_CTX_load_verify_locations(ctx, cafile.c_str(), 0))) || (!SSL_CTX_load_verify_locations(clictx, cafile.c_str(), 0)))
229                 {
230                         ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Can't read CA list from %s. %s", cafile.c_str(), strerror(errno));
231                         ERR_print_errors_cb(error_callback, this);
232                 }
233
234                 FILE* dhpfile = fopen(dhfile.c_str(), "r");
235                 DH* ret;
236
237                 if (dhpfile == NULL)
238                 {
239                         ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so Couldn't open DH file %s: %s", dhfile.c_str(), strerror(errno));
240                         throw ModuleException("Couldn't open DH file " + dhfile + ": " + strerror(errno));
241                 }
242                 else
243                 {
244                         ret = PEM_read_DHparams(dhpfile, NULL, NULL, NULL);
245                         if ((SSL_CTX_set_tmp_dh(ctx, ret) < 0) || (SSL_CTX_set_tmp_dh(clictx, ret) < 0))
246                         {
247                                 ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "m_ssl_openssl.so: Couldn't set DH parameters %s. SSL errors follow:", dhfile.c_str());
248                                 ERR_print_errors_cb(error_callback, this);
249                         }
250                 }
251
252                 fclose(dhpfile);
253         }
254
255         void On005Numeric(std::string &output)
256         {
257                 if (!sslports.empty())
258                         output.append(" SSL=" + sslports);
259         }
260
261         ~ModuleSSLOpenSSL()
262         {
263                 SSL_CTX_free(ctx);
264                 SSL_CTX_free(clictx);
265                 delete[] sessions;
266         }
267
268         void OnUserConnect(LocalUser* user)
269         {
270                 if (user->eh.GetIOHook() == this)
271                 {
272                         if (sessions[user->eh.GetFd()].sess)
273                         {
274                                 if (!sessions[user->eh.GetFd()].cert->fingerprint.empty())
275                                         user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\""
276                                                 " and your SSL fingerprint is %s", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess), sessions[user->eh.GetFd()].cert->fingerprint.c_str());
277                                 else
278                                         user->WriteServ("NOTICE %s :*** You are connected using SSL cipher \"%s\"", user->nick.c_str(), SSL_get_cipher(sessions[user->eh.GetFd()].sess));
279                         }
280                 }
281         }
282
283         void OnCleanup(int target_type, void* item)
284         {
285                 if (target_type == TYPE_USER)
286                 {
287                         LocalUser* user = IS_LOCAL((User*)item);
288
289                         if (user && user->eh.GetIOHook() == this)
290                         {
291                                 // User is using SSL, they're a local user, and they're using one of *our* SSL ports.
292                                 // Potentially there could be multiple SSL modules loaded at once on different ports.
293                                 ServerInstance->Users->QuitUser(user, "SSL module unloading");
294                         }
295                 }
296         }
297
298         Version GetVersion()
299         {
300                 return Version("Provides SSL support for clients", VF_VENDOR);
301         }
302
303         void OnRequest(Request& request)
304         {
305                 if (strcmp("GET_SSL_CERT", request.id) == 0)
306                 {
307                         SocketCertificateRequest& req = static_cast<SocketCertificateRequest&>(request);
308                         int fd = req.sock->GetFd();
309                         issl_session* session = &sessions[fd];
310
311                         req.cert = session->cert;
312                 }
313         }
314
315         void OnStreamSocketAccept(StreamSocket* user, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server)
316         {
317                 int fd = user->GetFd();
318
319                 issl_session* session = &sessions[fd];
320
321                 session->fd = fd;
322                 session->sess = SSL_new(ctx);
323                 session->status = ISSL_NONE;
324                 session->outbound = false;
325                 session->cert = NULL;
326
327                 if (session->sess == NULL)
328                         return;
329
330                 if (SSL_set_fd(session->sess, fd) == 0)
331                 {
332                         ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
333                         return;
334                 }
335
336                 Handshake(user, session);
337         }
338
339         void OnStreamSocketConnect(StreamSocket* user)
340         {
341                 int fd = user->GetFd();
342                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
343                 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() -1))
344                         return;
345
346                 issl_session* session = &sessions[fd];
347
348                 session->fd = fd;
349                 session->sess = SSL_new(clictx);
350                 session->status = ISSL_NONE;
351                 session->outbound = true;
352
353                 if (session->sess == NULL)
354                         return;
355
356                 if (SSL_set_fd(session->sess, fd) == 0)
357                 {
358                         ServerInstance->Logs->Log("m_ssl_openssl",DEBUG,"BUG: Can't set fd with SSL_set_fd: %d", fd);
359                         return;
360                 }
361
362                 Handshake(user, session);
363         }
364
365         void OnStreamSocketClose(StreamSocket* user)
366         {
367                 int fd = user->GetFd();
368                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
369                 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
370                         return;
371
372                 CloseSession(&sessions[fd]);
373         }
374
375         int OnStreamSocketRead(StreamSocket* user, std::string& recvq)
376         {
377                 int fd = user->GetFd();
378                 /* Are there any possibilities of an out of range fd? Hope not, but lets be paranoid */
379                 if ((fd < 0) || (fd > ServerInstance->SE->GetMaxFds() - 1))
380                         return -1;
381
382                 issl_session* session = &sessions[fd];
383
384                 if (!session->sess)
385                 {
386                         CloseSession(session);
387                         return -1;
388                 }
389
390                 if (session->status == ISSL_HANDSHAKING)
391                 {
392                         // The handshake isn't finished and it wants to read, try to finish it.
393                         if (!Handshake(user, session))
394                         {
395                                 // Couldn't resume handshake.
396                                 if (session->status == ISSL_NONE)
397                                         return -1;
398                                 return 0;
399                         }
400                 }
401
402                 // If we resumed the handshake then session->status will be ISSL_OPEN
403
404                 if (session->status == ISSL_OPEN)
405                 {
406                         char* buffer = ServerInstance->GetReadBuffer();
407                         size_t bufsiz = ServerInstance->Config->NetBufferSize;
408                         int ret = SSL_read(session->sess, buffer, bufsiz);
409
410                         if (ret > 0)
411                         {
412                                 recvq.append(buffer, ret);
413                                 if (session->data_to_write)
414                                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_SINGLE_WRITE);
415                                 return 1;
416                         }
417                         else if (ret == 0)
418                         {
419                                 // Client closed connection.
420                                 CloseSession(session);
421                                 return -1;
422                         }
423                         else if (ret < 0)
424                         {
425                                 int err = SSL_get_error(session->sess, ret);
426
427                                 if (err == SSL_ERROR_WANT_READ)
428                                 {
429                                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
430                                         return 0;
431                                 }
432                                 else if (err == SSL_ERROR_WANT_WRITE)
433                                 {
434                                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
435                                         return 0;
436                                 }
437                                 else
438                                 {
439                                         CloseSession(session);
440                                         return -1;
441                                 }
442                         }
443                 }
444
445                 return 0;
446         }
447
448         int OnStreamSocketWrite(StreamSocket* user, std::string& buffer)
449         {
450                 int fd = user->GetFd();
451
452                 issl_session* session = &sessions[fd];
453
454                 if (!session->sess)
455                 {
456                         CloseSession(session);
457                         return -1;
458                 }
459
460                 session->data_to_write = true;
461
462                 if (session->status == ISSL_HANDSHAKING)
463                 {
464                         if (!Handshake(user, session))
465                         {
466                                 // Couldn't resume handshake.
467                                 if (session->status == ISSL_NONE)
468                                         return -1;
469                                 return 0;
470                         }
471                 }
472
473                 if (session->status == ISSL_OPEN)
474                 {
475                         int ret = SSL_write(session->sess, buffer.data(), buffer.size());
476                         if (ret == (int)buffer.length())
477                         {
478                                 session->data_to_write = false;
479                                 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
480                                 return 1;
481                         }
482                         else if (ret > 0)
483                         {
484                                 buffer = buffer.substr(ret);
485                                 ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
486                                 return 0;
487                         }
488                         else if (ret == 0)
489                         {
490                                 CloseSession(session);
491                                 return -1;
492                         }
493                         else if (ret < 0)
494                         {
495                                 int err = SSL_get_error(session->sess, ret);
496
497                                 if (err == SSL_ERROR_WANT_WRITE)
498                                 {
499                                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_SINGLE_WRITE);
500                                         return 0;
501                                 }
502                                 else if (err == SSL_ERROR_WANT_READ)
503                                 {
504                                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ);
505                                         return 0;
506                                 }
507                                 else
508                                 {
509                                         CloseSession(session);
510                                         return -1;
511                                 }
512                         }
513                 }
514                 return 0;
515         }
516
517         bool Handshake(StreamSocket* user, issl_session* session)
518         {
519                 int ret;
520
521                 if (session->outbound)
522                         ret = SSL_connect(session->sess);
523                 else
524                         ret = SSL_accept(session->sess);
525
526                 if (ret < 0)
527                 {
528                         int err = SSL_get_error(session->sess, ret);
529
530                         if (err == SSL_ERROR_WANT_READ)
531                         {
532                                 ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE);
533                                 session->status = ISSL_HANDSHAKING;
534                                 return true;
535                         }
536                         else if (err == SSL_ERROR_WANT_WRITE)
537                         {
538                                 ServerInstance->SE->ChangeEventMask(user, FD_WANT_NO_READ | FD_WANT_SINGLE_WRITE);
539                                 session->status = ISSL_HANDSHAKING;
540                                 return true;
541                         }
542                         else
543                         {
544                                 CloseSession(session);
545                         }
546
547                         return false;
548                 }
549                 else if (ret > 0)
550                 {
551                         // Handshake complete.
552                         VerifyCertificate(session, user);
553
554                         session->status = ISSL_OPEN;
555
556                         ServerInstance->SE->ChangeEventMask(user, FD_WANT_POLL_READ | FD_WANT_NO_WRITE | FD_ADD_TRIAL_WRITE);
557
558                         return true;
559                 }
560                 else if (ret == 0)
561                 {
562                         CloseSession(session);
563                         return true;
564                 }
565
566                 return true;
567         }
568
569         void CloseSession(issl_session* session)
570         {
571                 if (session->sess)
572                 {
573                         SSL_shutdown(session->sess);
574                         SSL_free(session->sess);
575                 }
576
577                 session->sess = NULL;
578                 session->status = ISSL_NONE;
579                 errno = EIO;
580         }
581
582         void VerifyCertificate(issl_session* session, StreamSocket* user)
583         {
584                 if (!session->sess || !user)
585                         return;
586
587                 X509* cert;
588                 ssl_cert* certinfo = new ssl_cert;
589                 session->cert = certinfo;
590                 unsigned int n;
591                 unsigned char md[EVP_MAX_MD_SIZE];
592                 const EVP_MD *digest = use_sha ? EVP_sha1() : EVP_md5();
593
594                 cert = SSL_get_peer_certificate((SSL*)session->sess);
595
596                 if (!cert)
597                 {
598                         certinfo->error = "Could not get peer certificate: "+std::string(get_error());
599                         return;
600                 }
601
602                 certinfo->invalid = (SSL_get_verify_result(session->sess) != X509_V_OK);
603
604                 if (SelfSigned)
605                 {
606                         certinfo->unknownsigner = false;
607                         certinfo->trusted = true;
608                 }
609                 else
610                 {
611                         certinfo->unknownsigner = true;
612                         certinfo->trusted = false;
613                 }
614
615                 certinfo->dn = X509_NAME_oneline(X509_get_subject_name(cert),0,0);
616                 certinfo->issuer = X509_NAME_oneline(X509_get_issuer_name(cert),0,0);
617
618                 if (!X509_digest(cert, digest, md, &n))
619                 {
620                         certinfo->error = "Out of memory generating fingerprint";
621                 }
622                 else
623                 {
624                         certinfo->fingerprint = irc::hex(md, n);
625                 }
626
627                 if ((ASN1_UTCTIME_cmp_time_t(X509_get_notAfter(cert), ServerInstance->Time()) == -1) || (ASN1_UTCTIME_cmp_time_t(X509_get_notBefore(cert), ServerInstance->Time()) == 0))
628                 {
629                         certinfo->error = "Not activated, or expired certificate";
630                 }
631
632                 X509_free(cert);
633         }
634 };
635
636 static int error_callback(const char *str, size_t len, void *u)
637 {
638         ServerInstance->Logs->Log("m_ssl_openssl",DEFAULT, "SSL error: " + std::string(str, len - 1));
639
640         //
641         // XXX: Remove this line, it causes valgrind warnings...
642         //
643         // MD_update(&m, buf, j);
644         //
645         //
646         // ... ONLY JOKING! :-)
647         //
648
649         return 0;
650 }
651
652 MODULE_INIT(ModuleSSLOpenSSL)