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 static int epollfd = -1;
  35
  36 static int el_job_setemode(job_t *w, el_mode emode)
  37 {
  38     static int const evtmode_to_epoll[] = {
  39         [EL_NEW]     = EPOLLRDHUP,
  40         [EL_READING] = EPOLLIN,
  41         [EL_WRITING] = EPOLLOUT,
  42         [EL_RDWR]    = EPOLLIN | EPOLLOUT,
  43         [EL_IDLE]    = EPOLLRDHUP,
  44     };
  45
  46     assert (w->mode == emode || emode == EL_WRITING || emode == EL_READING);
  47
  48     if (emode != w->emode) {
  49         struct epoll_event event = {
  50             .data.ptr = w,
  51             .events   = evtmode_to_epoll[emode],
  52         };
  53         int action = w->emode == EL_NEW ? EPOLL_CTL_ADD : EPOLL_CTL_MOD;
  54         if (epoll_ctl(epollfd, action, w->fd, &event) < 0) {
  55             return el_job_release(w, true);
  56         }
  57     }
  58     w->emode = emode;
  59     return 0;
  60 }
  61
  62 int el_job_setmode(job_t *w, el_mode mode)
  63 {
  64     if (w->mode == w->emode) {
  65         w->mode = mode;
  66         return el_job_setemode(w, mode);
  67     } else {
  68         w->mode = mode;
  69         return 0;
  70     }
  71 }
  72
  73 void job_wipe(job_t *w)
  74 {
  75     if (w->xcred)
  76         gnutls_certificate_free_credentials(w->xcred);
  77     if (w->session)
  78         gnutls_deinit(w->session);
  79 }
  80
  81 int el_job_release(job_t *w, el_status reason)
  82 {
  83     w->state = EL_LLP_FINI;
  84     if (w->m && w->m->finalize) {
  85         w->m->finalize(w, reason);
  86     }
  87     if (w->fd >= 0) {
  88         if (w->session)
  89             gnutls_bye(w->session, GNUTLS_SHUT_RDWR);
  90         close(w->fd);
  91     }
  92     job_delete(&w);
  93     return -1;
  94 }
  95
  96 static int el_job_tlsing(job_t *w, int starttls)
  97 {
  98     int err = gnutls_handshake(w->session);
  99     if (err < 0 && !gnutls_error_is_fatal(err)) {
 100         int wr = gnutls_record_get_direction(w->session);
 101         return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 102     }
 103     if (err < 0)
 104         return el_job_release(w, EL_RDHUP);
 105
 106 #if 0
 107     if (!tls_check_certificate (conn))
 108         return -1;
 109 #endif
 110
 111     /* set Security Strength Factor (SSF) for SASL */
 112     /* NB: gnutls_cipher_get_key_size() returns key length in bytes */
 113     w->ssf   = gnutls_cipher_get_key_size(gnutls_cipher_get(w->session)) * 8;
 114     w->state = EL_LLP_READY;
 115     if (starttls)
 116         return el_job_setemode(w, w->mode);
 117     return w->m->on_event(w, EL_EVT_RUNNING);
 118 }
 119
 120 static int el_job_starttlsing(job_t *w)
 121 {
 122     return el_job_tlsing(w, true);
 123 }
 124
 125 static int el_job_connecting_ssl(job_t *w)
 126 {
 127     return el_job_tlsing(w, false);
 128 }
 129
 130 static int el_job_connecting(job_t *w)
 131 {
 132     int err = 0;
 133     socklen_t len = sizeof(err);
 134
 135     if (getsockopt(w->fd, SOL_SOCKET, SO_ERROR, (void *)&err, &len) || err)
 136         return el_job_release(w, EL_ERROR);
 137
 138     if (w->session) {
 139         w->llp = &el_job_connecting_ssl;
 140         return w->llp(w);
 141     }
 142     w->state = EL_LLP_READY;
 143     return w->m->on_event(w, EL_EVT_RUNNING);
 144 }
 145
 146 static int tls_negotiate(job_t *w)
 147 {
 148     static int protocol_priority[] = { GNUTLS_TLS1, GNUTLS_SSL3, 0 };
 149
 150     if (gnutls_certificate_allocate_credentials(&w->xcred) < 0)
 151         return -1;
 152
 153     /* ignore errors, maybe file doesn't exist yet */
 154     gnutls_certificate_set_x509_trust_file(w->xcred, mod_ssl.cert_file,
 155                                            GNUTLS_X509_FMT_PEM);
 156
 157     if (mod_ssl.ca_certificates_file) {
 158         gnutls_certificate_set_x509_trust_file(w->xcred,
 159             mod_ssl.ca_certificates_file, GNUTLS_X509_FMT_PEM);
 160     }
 161     gnutls_init(&w->session, GNUTLS_CLIENT);
 162
 163     /* set socket */
 164     gnutls_transport_set_ptr(w->session, (gnutls_transport_ptr)(intptr_t)w->fd);
 165
 166     /* disable TLS/SSL protocols as needed */
 167     if (!mod_ssl.use_sslv3) {
 168         protocol_priority[1] = 0;
 169     }
 170
 171     /* We use default priorities (see gnutls documentation),
 172        except for protocol version */
 173     gnutls_set_default_priority(w->session);
 174     gnutls_protocol_set_priority(w->session, protocol_priority);
 175     gnutls_credentials_set(w->session, GNUTLS_CRD_CERTIFICATE, w->xcred);
 176     return 0;
 177 }
 178
 179 int el_job_connect(job_t *w, struct sockaddr *addr, socklen_t len,
 180                    int type, int proto, int ssl)
 181 {
 182     int res, sock = socket(addr->sa_family, type, proto);
 183
 184     if (sock < 0)
 185         goto error;
 186
 187     res = fcntl(sock, F_GETFL);
 188     if (res < 0)
 189         goto error;
 190     if (fcntl(sock, F_SETFL, res | O_NONBLOCK) < 0)
 191         goto error;
 192     if (connect(sock, addr, len) < 0)
 193         goto error;
 194
 195     w->fd  = sock;
 196     if (ssl && tls_negotiate(w) < 0)
 197         goto error;
 198
 199     w->llp = &el_job_connecting;
 200     return el_job_setmode(w, EL_WRITING);
 201
 202   error:
 203     close(sock);
 204     return el_job_release(w, EL_ERROR);
 205 }
 206
 207 int el_job_starttls(job_t *w)
 208 {
 209     if (tls_negotiate(w) < 0)
 210         return el_job_release(w, EL_RDHUP);
 211     w->state = EL_LLP_INIT;
 212     w->llp   = &el_job_starttlsing;
 213     return w->llp(w);
 214 }
 215
 216 ssize_t el_job_read(job_t *w, buffer_t *buf)
 217 {
 218     ssize_t nr;
 219
 220     buffer_ensure(buf, BUFSIZ);
 221
 222     if (w->session) {
 223         nr = gnutls_record_recv(w->session, buf->data + buf->len, BUFSIZ);
 224         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 225             int wr = gnutls_record_get_direction(w->session);
 226             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 227         }
 228         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 229     } else {
 230         nr = read(w->fd, buf->data + buf->len, BUFSIZ);
 231         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 232             return 0;
 233     }
 234     if (nr <= 0)
 235         return el_job_release(w, EL_RDHUP);
 236     buffer_extend(buf, nr);
 237     return nr;
 238 }
 239
 240 ssize_t el_job_write(job_t *w, buffer_t *buf)
 241 {
 242     ssize_t nr;
 243
 244     if (buf->len == 0)
 245         return 0;
 246
 247     if (w->session) {
 248         nr = gnutls_record_send(w->session, buf->data, buf->len);
 249         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 250             int wr = gnutls_record_get_direction(w->session);
 251             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 252         }
 253         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 254     } else {
 255         nr = write(w->fd, buf->data, buf->len);
 256         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 257             return 0;
 258     }
 259     if (nr <= 0)
 260         return el_job_release(w, EL_RDHUP);
 261     buffer_splice(buf, 0, nr, NULL, 0);
 262     return nr;
 263 }
 264
 265 int el_dispatch(int timeout)
 266 {
 267     struct epoll_event events[FD_SETSIZE];
 268     int count = epoll_wait(epollfd, events, countof(events), timeout);
 269
 270     if (count < 0) {
 271         if (errno == EAGAIN || errno == EINTR)
 272             return 0;
 273         mutt_error("epoll_wait");
 274         mutt_exit(EXIT_FAILURE);
 275     }
 276
 277     while (--count >= 0) {
 278         job_t *w  = events[count].data.ptr;
 279         int event = events[count].events;
 280         int evt   = 0;
 281
 282         switch (w->state) {
 283           case EL_LLP_INIT:
 284             w->llp(w);
 285             break;
 286
 287           case EL_LLP_READY:
 288             if (event & EPOLLRDHUP) {
 289                 IGNORE(el_job_release(w, EL_RDHUP));
 290             } else if (w->mode != w->emode) {
 291                 IGNORE(w->m->on_event(w, EL_EVT_INOUT ^ w->emode));
 292             } else {
 293                 if (event & EPOLLIN)
 294                     evt |= EL_EVT_IN;
 295                 if (event & EPOLLOUT)
 296                     evt |= EL_EVT_OUT;
 297                 IGNORE(w->m->on_event(w, evt));
 298             }
 299             break;
 300
 301           default:
 302             IGNORE(el_job_release(w, EL_ERROR));
 303             break;
 304         }
 305     }
 306
 307     return 0;
 308 }