lib-sys/evtloop.c

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 #include <sys/epoll.h>
  21 #include <sys/socket.h>
  22 #ifndef EPOLLRDHUP
  23 #  include <linux/poll.h>
  24 #  ifdef POLLRDHUP
  25 #    define EPOLLRDHUP POLLRDHUP
  26 #  else
  27 #    define EPOLLRDHUP 0
  28 #  endif
  29 #endif
  30 #include "evtloop.h"
  31 #include "mutt.h"
  32 #include "mutt_ssl.li"
  33
  34 DO_ARRAY_TYPE(job_t, job);
  35
  36 static int epollfd = -1;
  37 static job_array jobs;
  38
  39 static int el_job_setemode(job_t *w, el_mode emode)
  40 {
  41     static int const evtmode_to_epoll[] = {
  42         [EL_NEW]     = EPOLLRDHUP,
  43         [EL_READING] = EPOLLIN,
  44         [EL_WRITING] = EPOLLOUT,
  45         [EL_RDWR]    = EPOLLIN | EPOLLOUT,
  46         [EL_IDLE]    = EPOLLRDHUP,
  47     };
  48
  49     assert (w->mode == emode || emode == EL_WRITING || emode == EL_READING);
  50
  51     if (emode != w->emode) {
  52         struct epoll_event event = {
  53             .data.ptr = w,
  54             .events   = evtmode_to_epoll[emode],
  55         };
  56         int action = w->emode == EL_NEW ? EPOLL_CTL_ADD : EPOLL_CTL_MOD;
  57         if (epoll_ctl(epollfd, action, w->fd, &event) < 0) {
  58             return el_job_release(w, true);
  59         }
  60     }
  61     w->emode = emode;
  62     return 0;
  63 }
  64
  65 int el_job_setmode(job_t *w, el_mode mode)
  66 {
  67     if (w->mode == w->emode) {
  68         w->mode = mode;
  69         return el_job_setemode(w, mode);
  70     } else {
  71         w->mode = mode;
  72         return 0;
  73     }
  74 }
  75
  76 void job_wipe(job_t *w)
  77 {
  78     if (w->xcred)
  79         gnutls_certificate_free_credentials(w->xcred);
  80     if (w->session)
  81         gnutls_deinit(w->session);
  82 }
  83
  84 static void job_arrau_dtor(job_t **j)
  85 {
  86     if (*j)
  87         IGNORE(el_job_release(*j, EL_KILLED));
  88 }
  89
  90 DO_ARRAY_FUNCS(job_t, job, job_arrau_dtor);
  91
  92 static void job_array_remove(job_array *arr, job_t *j)
  93 {
  94     for (int i = 0; i < arr->len; i++) {
  95         if (arr->arr[i] == j) {
  96             job_array_take(arr, i);
  97             break;
  98         }
  99     }
 100 }
 101
 102 job_t *el_job_start(const machine_t *m, void *cfg)
 103 {
 104     job_t *w = job_new();
 105     w->m = m;
 106     job_array_append(&jobs, w);
 107     return m->setup(w, cfg) < 0 ? NULL : w;
 108 }
 109
 110 int el_job_release(job_t *w, el_status reason)
 111 {
 112     w->state = EL_LLP_FINI;
 113     if (w->m && w->m->finalize) {
 114         w->m->finalize(w, reason);
 115     }
 116     if (w->fd >= 0) {
 117         if (w->session)
 118             gnutls_bye(w->session, GNUTLS_SHUT_RDWR);
 119         close(w->fd);
 120     }
 121     job_array_remove(&jobs, w);
 122     job_delete(&w);
 123     return -1;
 124 }
 125
 126 static int el_job_tlsing(job_t *w, int starttls)
 127 {
 128     int err = gnutls_handshake(w->session);
 129     if (err < 0 && !gnutls_error_is_fatal(err)) {
 130         int wr = gnutls_record_get_direction(w->session);
 131         return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 132     }
 133     if (err < 0)
 134         return el_job_release(w, EL_RDHUP);
 135
 136 #if 0
 137     if (!tls_check_certificate (conn))
 138         return -1;
 139 #endif
 140
 141     /* set Security Strength Factor (SSF) for SASL */
 142     /* NB: gnutls_cipher_get_key_size() returns key length in bytes */
 143     w->ssf   = gnutls_cipher_get_key_size(gnutls_cipher_get(w->session)) * 8;
 144     w->state = EL_LLP_READY;
 145     if (starttls)
 146         return el_job_setemode(w, w->mode);
 147     return w->m->on_event(w, EL_EVT_RUNNING);
 148 }
 149
 150 static int el_job_starttlsing(job_t *w)
 151 {
 152     return el_job_tlsing(w, true);
 153 }
 154
 155 static int el_job_connecting_ssl(job_t *w)
 156 {
 157     return el_job_tlsing(w, false);
 158 }
 159
 160 static int el_job_connecting(job_t *w)
 161 {
 162     int err = 0;
 163     socklen_t len = sizeof(err);
 164
 165     if (getsockopt(w->fd, SOL_SOCKET, SO_ERROR, (void *)&err, &len) || err)
 166         return el_job_release(w, EL_ERROR);
 167
 168     if (w->session) {
 169         w->llp = &el_job_connecting_ssl;
 170         return w->llp(w);
 171     }
 172     w->state = EL_LLP_READY;
 173     return w->m->on_event(w, EL_EVT_RUNNING);
 174 }
 175
 176 static int tls_negotiate(job_t *w)
 177 {
 178     static int protocol_priority[] = { GNUTLS_TLS1, GNUTLS_SSL3, 0 };
 179
 180     if (gnutls_certificate_allocate_credentials(&w->xcred) < 0)
 181         return -1;
 182
 183     /* ignore errors, maybe file doesn't exist yet */
 184     gnutls_certificate_set_x509_trust_file(w->xcred, mod_ssl.cert_file,
 185                                            GNUTLS_X509_FMT_PEM);
 186
 187     if (mod_ssl.ca_certificates_file) {
 188         gnutls_certificate_set_x509_trust_file(w->xcred,
 189             mod_ssl.ca_certificates_file, GNUTLS_X509_FMT_PEM);
 190     }
 191     gnutls_init(&w->session, GNUTLS_CLIENT);
 192
 193     /* set socket */
 194     gnutls_transport_set_ptr(w->session, (gnutls_transport_ptr)(intptr_t)w->fd);
 195
 196     /* disable TLS/SSL protocols as needed */
 197     if (!mod_ssl.use_sslv3) {
 198         protocol_priority[1] = 0;
 199     }
 200
 201     /* We use default priorities (see gnutls documentation),
 202        except for protocol version */
 203     gnutls_set_default_priority(w->session);
 204     gnutls_protocol_set_priority(w->session, protocol_priority);
 205     gnutls_credentials_set(w->session, GNUTLS_CRD_CERTIFICATE, w->xcred);
 206     return 0;
 207 }
 208
 209 int el_job_connect(job_t *w, struct sockaddr *addr, socklen_t len,
 210                    int type, int proto, int ssl)
 211 {
 212     int res, sock = socket(addr->sa_family, type, proto);
 213
 214     if (sock < 0)
 215         goto error;
 216
 217     res = fcntl(sock, F_GETFL);
 218     if (res < 0)
 219         goto error;
 220     if (fcntl(sock, F_SETFL, res | O_NONBLOCK) < 0)
 221         goto error;
 222     if (connect(sock, addr, len) < 0)
 223         goto error;
 224
 225     w->fd  = sock;
 226     if (ssl && tls_negotiate(w) < 0)
 227         goto error;
 228
 229     w->llp = &el_job_connecting;
 230     return el_job_setmode(w, EL_WRITING);
 231
 232   error:
 233     close(sock);
 234     return el_job_release(w, EL_ERROR);
 235 }
 236
 237 int el_job_starttls(job_t *w)
 238 {
 239     if (tls_negotiate(w) < 0)
 240         return el_job_release(w, EL_RDHUP);
 241     w->state = EL_LLP_INIT;
 242     w->llp   = &el_job_starttlsing;
 243     return w->llp(w);
 244 }
 245
 246 ssize_t el_job_read(job_t *w, buffer_t *buf)
 247 {
 248     ssize_t nr;
 249
 250     buffer_ensure(buf, BUFSIZ);
 251
 252     if (w->session) {
 253         nr = gnutls_record_recv(w->session, buf->data + buf->len, BUFSIZ);
 254         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 255             int wr = gnutls_record_get_direction(w->session);
 256             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 257         }
 258         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 259     } else {
 260         nr = read(w->fd, buf->data + buf->len, BUFSIZ);
 261         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 262             return 0;
 263     }
 264     if (nr <= 0)
 265         return el_job_release(w, EL_RDHUP);
 266     buffer_extend(buf, nr);
 267     return nr;
 268 }
 269
 270 ssize_t el_job_write(job_t *w, buffer_t *buf)
 271 {
 272     ssize_t nr;
 273
 274     if (buf->len == 0)
 275         return 0;
 276
 277     if (w->session) {
 278         nr = gnutls_record_send(w->session, buf->data, buf->len);
 279         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 280             int wr = gnutls_record_get_direction(w->session);
 281             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 282         }
 283         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 284     } else {
 285         nr = write(w->fd, buf->data, buf->len);
 286         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 287             return 0;
 288     }
 289     if (nr <= 0)
 290         return el_job_release(w, EL_RDHUP);
 291     buffer_splice(buf, 0, nr, NULL, 0);
 292     return nr;
 293 }
 294
 295 int el_dispatch(int timeout)
 296 {
 297     struct epoll_event events[FD_SETSIZE];
 298     int count = epoll_wait(epollfd, events, countof(events), timeout);
 299
 300     if (count < 0) {
 301         if (errno == EAGAIN || errno == EINTR)
 302             return 0;
 303         mutt_error("epoll_wait");
 304         mutt_exit(EXIT_FAILURE);
 305     }
 306
 307     while (--count >= 0) {
 308         job_t *w  = events[count].data.ptr;
 309         int event = events[count].events;
 310         int evt   = 0;
 311
 312         switch (w->state) {
 313           case EL_LLP_INIT:
 314             w->llp(w);
 315             break;
 316
 317           case EL_LLP_READY:
 318             if (event & EPOLLRDHUP) {
 319                 IGNORE(el_job_release(w, EL_RDHUP));
 320             } else if (w->mode != w->emode) {
 321                 IGNORE(w->m->on_event(w, EL_EVT_INOUT ^ w->emode));
 322             } else {
 323                 if (event & EPOLLIN)
 324                     evt |= EL_EVT_IN;
 325                 if (event & EPOLLOUT)
 326                     evt |= EL_EVT_OUT;
 327                 IGNORE(w->m->on_event(w, evt));
 328             }
 329             break;
 330
 331           default:
 332             IGNORE(el_job_release(w, EL_ERROR));
 333             break;
 334         }
 335     }
 336
 337     return 0;
 338 }
 339
 340 void el_initialize(void)
 341 {
 342     gnutls_global_init();
 343     epollfd = epoll_create(1024);
 344     if (epollfd < 0) {
 345         mutt_error("epoll_create");
 346         mutt_exit(EXIT_FAILURE);
 347     }
 348     job_array_init(&jobs);
 349 }
 350
 351 void el_shutdown(void)
 352 {
 353     job_array_wipe(&jobs);
 354     close(epollfd);
 355     gnutls_global_deinit();
 356 }