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_connecting_ssl(job_t *w)
  97 {
  98     int err = gnutls_handshake(w->session);
  99
 100     if (err < 0 && !gnutls_error_is_fatal(err)) {
 101         int wr = gnutls_record_get_direction(w->session);
 102         return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 103     }
 104     if (err < 0)
 105         return el_job_release(w, EL_RDHUP);
 106
 107 #if 0
 108     if (!tls_check_certificate (conn))
 109         return -1;
 110
 111     /* set Security Strength Factor (SSF) for SASL */
 112     /* NB: gnutls_cipher_get_key_size() returns key length in bytes */
 113     conn->ssf = gnutls_cipher_get_key_size(gnutls_cipher_get(w->session)) * 8;
 114 #endif
 115     w->state = EL_LLP_READY;
 116     return w->m->on_event(w, EL_EVT_RUNNING);
 117 }
 118
 119 static int el_job_connecting(job_t *w)
 120 {
 121     int err = 0;
 122     socklen_t len = sizeof(err);
 123
 124     if (getsockopt(w->fd, SOL_SOCKET, SO_ERROR, (void *)&err, &len) || err)
 125         return el_job_release(w, EL_ERROR);
 126
 127     if (w->session) {
 128         w->llp = &el_job_connecting_ssl;
 129         return w->llp(w);
 130     }
 131     w->state = EL_LLP_READY;
 132     return w->m->on_event(w, EL_EVT_RUNNING);
 133 }
 134
 135 static int tls_negociate(job_t *w)
 136 {
 137     static int protocol_priority[] = { GNUTLS_TLS1, GNUTLS_SSL3, 0 };
 138
 139     if (gnutls_certificate_allocate_credentials(&w->xcred) < 0)
 140         return -1;
 141
 142     /* ignore errors, maybe file doesn't exist yet */
 143     gnutls_certificate_set_x509_trust_file(w->xcred, mod_ssl.cert_file,
 144                                            GNUTLS_X509_FMT_PEM);
 145
 146     if (mod_ssl.ca_certificates_file) {
 147         gnutls_certificate_set_x509_trust_file(w->xcred,
 148             mod_ssl.ca_certificates_file, GNUTLS_X509_FMT_PEM);
 149     }
 150     gnutls_init(&w->session, GNUTLS_CLIENT);
 151
 152     /* set socket */
 153     gnutls_transport_set_ptr(w->session, (gnutls_transport_ptr)(intptr_t)w->fd);
 154
 155     /* disable TLS/SSL protocols as needed */
 156     if (!mod_ssl.use_sslv3) {
 157         protocol_priority[1] = 0;
 158     }
 159
 160     /* We use default priorities (see gnutls documentation),
 161        except for protocol version */
 162     gnutls_set_default_priority(w->session);
 163     gnutls_protocol_set_priority(w->session, protocol_priority);
 164     gnutls_credentials_set(w->session, GNUTLS_CRD_CERTIFICATE, w->xcred);
 165     return 0;
 166 }
 167
 168 int el_job_connect(job_t *w, struct sockaddr *addr, socklen_t len,
 169                    int type, int proto, int ssl)
 170 {
 171     int res, sock = socket(addr->sa_family, type, proto);
 172
 173     if (sock < 0)
 174         goto error;
 175
 176     res = fcntl(sock, F_GETFL);
 177     if (res < 0)
 178         goto error;
 179     if (fcntl(sock, F_SETFL, res | O_NONBLOCK) < 0)
 180         goto error;
 181     if (connect(sock, addr, len) < 0)
 182         goto error;
 183
 184     w->fd  = sock;
 185     if (ssl && tls_negociate(w) < 0)
 186         goto error;
 187
 188     w->llp = &el_job_connecting;
 189     return el_job_setmode(w, EL_WRITING);
 190
 191   error:
 192     close(sock);
 193     return el_job_release(w, EL_ERROR);
 194 }
 195
 196 ssize_t el_job_read(job_t *w, buffer_t *buf)
 197 {
 198     ssize_t nr;
 199
 200     buffer_ensure(buf, BUFSIZ);
 201
 202     if (w->session) {
 203         nr = gnutls_record_recv(w->session, buf->data + buf->len, BUFSIZ);
 204         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 205             int wr = gnutls_record_get_direction(w->session);
 206             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 207         }
 208         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 209     } else {
 210         nr = read(w->fd, buf->data + buf->len, BUFSIZ);
 211         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 212             return 0;
 213     }
 214     if (nr <= 0)
 215         return el_job_release(w, EL_RDHUP);
 216     buffer_extend(buf, nr);
 217     return nr;
 218 }
 219
 220 ssize_t el_job_write(job_t *w, buffer_t *buf)
 221 {
 222     ssize_t nr;
 223
 224     if (buf->len == 0)
 225         return 0;
 226
 227     if (w->session) {
 228         nr = gnutls_record_send(w->session, buf->data, buf->len);
 229         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 230             int wr = gnutls_record_get_direction(w->session);
 231             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 232         }
 233         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 234     } else {
 235         nr = write(w->fd, buf->data, buf->len);
 236         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 237             return 0;
 238     }
 239     if (nr <= 0)
 240         return el_job_release(w, EL_RDHUP);
 241     buffer_splice(buf, 0, nr, NULL, 0);
 242     return nr;
 243 }
 244
 245 int el_dispatch(int timeout)
 246 {
 247     struct epoll_event events[FD_SETSIZE];
 248     int count = epoll_wait(epollfd, events, countof(events), timeout);
 249
 250     if (count < 0) {
 251         if (errno == EAGAIN || errno == EINTR)
 252             return 0;
 253         mutt_error("epoll_wait");
 254         mutt_exit(EXIT_FAILURE);
 255     }
 256
 257     while (--count >= 0) {
 258         job_t *w  = events[count].data.ptr;
 259         int event = events[count].events;
 260         int evt   = 0;
 261
 262         switch (w->state) {
 263           case EL_LLP_INIT:
 264             w->llp(w);
 265             break;
 266
 267           case EL_LLP_READY:
 268             if (event & EPOLLRDHUP) {
 269                 IGNORE(el_job_release(w, EL_RDHUP));
 270             } else if (w->mode != w->emode) {
 271                 IGNORE(w->m->on_event(w, EL_EVT_INOUT ^ w->emode));
 272             } else {
 273                 if (event & EPOLLIN)
 274                     evt |= EL_EVT_IN;
 275                 if (event & EPOLLOUT)
 276                     evt |= EL_EVT_OUT;
 277                 IGNORE(w->m->on_event(w, evt));
 278             }
 279             break;
 280
 281           default:
 282             IGNORE(el_job_release(w, EL_ERROR));
 283             break;
 284         }
 285     }
 286
 287     return 0;
 288 }