src/common/socket.h

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2017 Hiroyuki Yamamoto and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __SOCKET_H__
  20 #define __SOCKET_H__
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "claws-features.h"
  24 #endif
  25
  26 #include <glib.h>
  27 #if HAVE_NETDB_H
  28 #  include <netdb.h>
  29 #endif
  30
  31 typedef struct _SockInfo        SockInfo;
  32
  33 #ifdef USE_GNUTLS
  34 #  include "ssl.h"
  35 #endif
  36
  37 typedef enum
  38 {
  39         CONN_READY,
  40         CONN_LOOKUPSUCCESS,
  41         CONN_ESTABLISHED,
  42         CONN_LOOKUPFAILED,
  43         CONN_FAILED,
  44         CONN_DISCONNECTED
  45 } ConnectionState;
  46
  47 typedef gint (*SockConnectFunc)         (SockInfo       *sock,
  48                                          gpointer        data);
  49 typedef gboolean (*SockFunc)            (SockInfo       *sock,
  50                                          GIOCondition    condition,
  51                                          gpointer        data);
  52
  53 struct _SockInfo
  54 {
  55         gint sock;
  56 #if USE_GNUTLS
  57         gnutls_session_t ssl;
  58         gnutls_certificate_credentials_t xcred;
  59 #if GNUTLS_VERSION_NUMBER < 0x030000
  60         gnutls_x509_crt_t client_crt;
  61         gnutls_x509_privkey_t client_key;
  62 #else
  63         gnutls_pcert_st client_crt;
  64         gnutls_privkey_t client_key;
  65 #endif /* GNUTLS_VERSION_NUMBER < 0x030000 */
  66         gchar *gnutls_priority;
  67 #endif
  68         guint g_source;
  69         GIOChannel *sock_ch;
  70
  71         gchar *hostname;
  72         gushort port;
  73         ConnectionState state;
  74         gpointer data;
  75
  76         SockFunc callback;
  77         GIOCondition condition;
  78         gchar *canonical_name;
  79
  80         const void *account;
  81         gboolean is_smtp;
  82         gboolean ssl_cert_auto_accept;
  83         gboolean use_tls_sni;
  84 };
  85
  86 void refresh_resolvers                  (void);
  87 gint sock_init                          (void);
  88 gint sock_cleanup                       (void);
  89
  90 gint sock_set_io_timeout                (guint sec);
  91
  92 gint sock_set_nonblocking_mode          (SockInfo *sock, gboolean nonblock);
  93 gboolean sock_is_nonblocking_mode       (SockInfo *sock);
  94
  95 guint sock_add_watch                    (SockInfo *sock, GIOCondition condition,
  96                                          SockFunc func, gpointer data);
  97
  98 SockInfo *sock_connect                  (const gchar *hostname, gushort port);
  99 gint sock_connect_async                 (const gchar *hostname, gushort port,
 100                                          SockConnectFunc func, gpointer data);
 101 gint sock_connect_async_cancel          (gint id);
 102
 103 /* Basic I/O functions */
 104 gint sock_read          (SockInfo *sock, gchar *buf, gint len);
 105 gint sock_write         (SockInfo *sock, const gchar *buf, gint len);
 106 gint sock_write_all     (SockInfo *sock, const gchar *buf, gint len);
 107 gint sock_close         (SockInfo *sock, gboolean close_fd);
 108
 109 /* Functions to directly work on FD.  They are needed for pipes */
 110 gint fd_connect_unix    (const gchar *path);
 111 gint fd_open_unix       (const gchar *path);
 112 gint fd_accept          (gint sock);
 113
 114 gint fd_connect_inet(gushort port);
 115 gint fd_open_inet(gushort port);
 116
 117 gint fd_write           (gint sock, const gchar *buf, gint len);
 118 gint fd_write_all       (gint sock, const gchar *buf, gint len);
 119 gint fd_gets            (gint sock, gchar *buf, gint len);
 120 gint fd_close           (gint sock);
 121
 122 #endif /* __SOCKET_H__ */