NeoMutt  2022-04-29-323-g5fcc6c
Teaching an old dog new tricks
DOXYGEN

Read from a socket Connection. More...

+ Collaboration diagram for read():

Functions

static int tls_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from a TLS socket - Implements Connection::read() -. More...
 
static int ssl_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from an SSL socket - Implements Connection::read() -. More...
 
int raw_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from a socket - Implements Connection::read() -. More...
 
static int mutt_sasl_conn_read (struct Connection *conn, char *buf, size_t count)
 Read data from an SASL connection - Implements Connection::read() -. More...
 
static int tunnel_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from a tunnel socket - Implements Connection::read() -. More...
 
static int zstrm_read (struct Connection *conn, char *buf, size_t len)
 Read compressed data from a socket - Implements Connection::read() -. More...
 

Variables

int(* SaslSockData::read )(struct Connection *conn, char *buf, size_t count)
 Read from a socket Connection - Implements Connection::read() -. More...
 

Detailed Description

Read from a socket Connection.

Parameters
connConnection to a server
bufBuffer to store the data
countNumber of bytes to read
Return values
>0Success, number of bytes read
-1Error, see errno

Function Documentation

◆ tls_socket_read()

static int tls_socket_read ( struct Connection conn,
char *  buf,
size_t  count 
)
static

Read data from a TLS socket - Implements Connection::read() -.

Definition at line 1043 of file gnutls.c.

1044{
1045 struct TlsSockData *data = conn->sockdata;
1046 if (!data)
1047 {
1048 mutt_error(_("Error: no TLS socket open"));
1049 return -1;
1050 }
1051
1052 int rc;
1053 do
1054 {
1055 rc = gnutls_record_recv(data->state, buf, count);
1056 } while ((rc == GNUTLS_E_AGAIN) || (rc == GNUTLS_E_INTERRUPTED));
1057
1058 if (rc < 0)
1059 {
1060 mutt_error("tls_socket_read (%s)", gnutls_strerror(rc));
1061 return -1;
1062 }
1063
1064 return rc;
1065}
#define mutt_error(...)
Definition: logging.h:87
#define _(a)
Definition: message.h:28
void * sockdata
Backend-specific socket data.
Definition: connection.h:56
TLS socket data -.
Definition: gnutls.c:81
gnutls_session_t state
Definition: gnutls.c:82
+ Here is the caller graph for this function:

◆ ssl_socket_read()

static int ssl_socket_read ( struct Connection conn,
char *  buf,
size_t  count 
)
static

Read data from an SSL socket - Implements Connection::read() -.

Definition at line 1326 of file openssl.c.

1327{
1328 struct SslSockData *data = sockdata(conn);
1329 int rc;
1330
1331 rc = SSL_read(data->ssl, buf, count);
1332 if ((rc <= 0) || (errno == EINTR))
1333 {
1334 if (errno == EINTR)
1335 {
1336 rc = -1;
1337 }
1338 data->isopen = 0;
1339 ssl_err(data, rc);
1340 }
1341
1342 return rc;
1343}
static struct SslSockData * sockdata(struct Connection *conn)
Get a Connection's socket data.
Definition: openssl.c:1183
static void ssl_err(struct SslSockData *data, int err)
Display an SSL error message.
Definition: openssl.c:235
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ raw_socket_read()

int raw_socket_read ( struct Connection conn,
char *  buf,
size_t  count 
)

Read data from a socket - Implements Connection::read() -.

Definition at line 264 of file raw.c.

265{
266 int rc;
267
269 do
270 {
271 rc = read(conn->fd, buf, count);
272 } while (rc < 0 && (errno == EINTR));
273
274 if (rc < 0)
275 {
276 mutt_error(_("Error talking to %s (%s)"), conn->account.host, strerror(errno));
277 SigInt = false;
278 }
280
281 if (SigInt)
282 {
283 mutt_error(_("Connection to %s has been aborted"), conn->account.host);
284 SigInt = false;
285 rc = -1;
286 }
287
288 return rc;
289}
SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: mutt_globals.h:69
void mutt_sig_allow_interrupt(bool allow)
Allow/disallow Ctrl-C (SIGINT)
Definition: signal.c:238
char host[128]
Server to login to.
Definition: connaccount.h:54
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:50
int fd
Socket file descriptor.
Definition: connection.h:54
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_sasl_conn_read()

static int mutt_sasl_conn_read ( struct Connection conn,
char *  buf,
size_t  count 
)
static

Read data from an SASL connection - Implements Connection::read() -.

Definition at line 463 of file sasl.c.

464{
465 int rc;
466 unsigned int olen;
467
468 struct SaslSockData *sasldata = conn->sockdata;
469
470 /* if we still have data in our read buffer, copy it into buf */
471 if (sasldata->blen > sasldata->bpos)
472 {
473 olen = ((sasldata->blen - sasldata->bpos) > count) ?
474 count :
475 sasldata->blen - sasldata->bpos;
476
477 memcpy(buf, sasldata->buf + sasldata->bpos, olen);
478 sasldata->bpos += olen;
479
480 return olen;
481 }
482
483 conn->sockdata = sasldata->sockdata;
484
485 sasldata->bpos = 0;
486 sasldata->blen = 0;
487
488 /* and decode the result, if necessary */
489 if (*sasldata->ssf != 0)
490 {
491 do
492 {
493 /* call the underlying read function to fill the buffer */
494 rc = sasldata->read(conn, buf, count);
495 if (rc <= 0)
496 goto out;
497
498 rc = sasl_decode(sasldata->saslconn, buf, rc, &sasldata->buf, &sasldata->blen);
499 if (rc != SASL_OK)
500 {
501 mutt_debug(LL_DEBUG1, "SASL decode failed: %s\n", sasl_errstring(rc, NULL, NULL));
502 goto out;
503 }
504 } while (sasldata->blen == 0);
505
506 olen = ((sasldata->blen - sasldata->bpos) > count) ?
507 count :
508 sasldata->blen - sasldata->bpos;
509
510 memcpy(buf, sasldata->buf, olen);
511 sasldata->bpos += olen;
512
513 rc = olen;
514 }
515 else
516 rc = sasldata->read(conn, buf, count);
517
518out:
519 conn->sockdata = sasldata;
520
521 return rc;
522}
int(* read)(struct Connection *conn, char *buf, size_t count)
Read from a socket Connection - Implements Connection::read() -.
Definition: sasl.c:82
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
SASL authentication API -.
Definition: sasl.c:62
void * sockdata
Underlying socket data.
Definition: sasl.c:72
unsigned int blen
Size of the read buffer.
Definition: sasl.c:69
unsigned int bpos
Current read position.
Definition: sasl.c:70
const sasl_ssf_t * ssf
Definition: sasl.c:64
const char * buf
Buffer for data read from the connection.
Definition: sasl.c:68
sasl_conn_t * saslconn
Definition: sasl.c:63
+ Here is the caller graph for this function:

◆ tunnel_socket_read()

static int tunnel_socket_read ( struct Connection conn,
char *  buf,
size_t  count 
)
static

Read data from a tunnel socket - Implements Connection::read() -.

Definition at line 137 of file tunnel.c.

138{
139 struct TunnelSockData *tunnel = conn->sockdata;
140 int rc;
141
142 do
143 {
144 rc = read(tunnel->fd_read, buf, count);
145 } while (rc < 0 && errno == EINTR);
146
147 if (rc < 0)
148 {
149 mutt_error(_("Tunnel error talking to %s: %s"), conn->account.host, strerror(errno));
150 return -1;
151 }
152
153 return rc;
154}
A network tunnel (pair of sockets)
Definition: tunnel.c:48
int fd_read
File descriptor to read from.
Definition: tunnel.c:50
+ Here is the caller graph for this function:

◆ zstrm_read()

static int zstrm_read ( struct Connection conn,
char *  buf,
size_t  len 
)
static

Read compressed data from a socket - Implements Connection::read() -.

Definition at line 129 of file zstrm.c.

130{
131 struct ZstrmContext *zctx = conn->sockdata;
132 int rc = 0;
133 int zrc = 0;
134
135retry:
136 if (zctx->read.stream_eof)
137 return 0;
138
139 /* when avail_out was 0 on last call, we need to call inflate again, because
140 * more data might be available using the current input, so avoid callling
141 * read on the underlying stream in that case (for it might block) */
142 if ((zctx->read.pos == 0) && !zctx->read.conn_eof)
143 {
144 rc = zctx->next_conn.read(&zctx->next_conn, zctx->read.buf, zctx->read.len);
145 mutt_debug(LL_DEBUG5, "consuming data from next stream: %d bytes\n", rc);
146 if (rc < 0)
147 return rc;
148 else if (rc == 0)
149 zctx->read.conn_eof = true;
150 else
151 zctx->read.pos += rc;
152 }
153
154 zctx->read.z.avail_in = (uInt) zctx->read.pos;
155 zctx->read.z.next_in = (Bytef *) zctx->read.buf;
156 zctx->read.z.avail_out = (uInt) len;
157 zctx->read.z.next_out = (Bytef *) buf;
158
159 zrc = inflate(&zctx->read.z, Z_SYNC_FLUSH);
160 mutt_debug(LL_DEBUG5, "rc=%d, consumed %u/%u bytes, produced %lu/%lu bytes\n",
161 zrc, zctx->read.pos - zctx->read.z.avail_in, zctx->read.pos,
162 len - zctx->read.z.avail_out, len);
163
164 /* shift any remaining input data to the front of the buffer */
165 if ((Bytef *) zctx->read.buf != zctx->read.z.next_in)
166 {
167 memmove(zctx->read.buf, zctx->read.z.next_in, zctx->read.z.avail_in);
168 zctx->read.pos = zctx->read.z.avail_in;
169 }
170
171 switch (zrc)
172 {
173 case Z_OK: /* progress has been made */
174 zrc = len - zctx->read.z.avail_out; /* "returned" bytes */
175 if (zrc == 0)
176 {
177 /* there was progress, so must have been reading input */
178 mutt_debug(LL_DEBUG5, "inflate just consumed\n");
179 goto retry;
180 }
181 break;
182
183 case Z_STREAM_END: /* everything flushed, nothing remaining */
184 mutt_debug(LL_DEBUG5, "inflate returned Z_STREAM_END.\n");
185 zrc = len - zctx->read.z.avail_out; /* "returned" bytes */
186 zctx->read.stream_eof = true;
187 break;
188
189 case Z_BUF_ERROR: /* no progress was possible */
190 if (!zctx->read.conn_eof)
191 {
192 mutt_debug(LL_DEBUG5, "inflate returned Z_BUF_ERROR. retrying.\n");
193 goto retry;
194 }
195 zrc = 0;
196 break;
197
198 default:
199 /* bail on other rcs, such as Z_DATA_ERROR, or Z_MEM_ERROR */
200 mutt_debug(LL_DEBUG5, "inflate returned %d. aborting.\n", zrc);
201 zrc = -1;
202 break;
203 }
204
205 return zrc;
206}
@ LL_DEBUG5
Log at debug level 5.
Definition: logging.h:44
int(* read)(struct Connection *conn, char *buf, size_t count)
Definition: connection.h:80
Data compression layer.
Definition: zstrm.c:55
struct ZstrmDirection read
Data being read and de-compressed.
Definition: zstrm.c:56
struct Connection next_conn
Underlying stream.
Definition: zstrm.c:58
unsigned int pos
Current position.
Definition: zstrm.c:46
bool conn_eof
Connection end-of-file reached.
Definition: zstrm.c:47
unsigned int len
Length of data.
Definition: zstrm.c:45
z_stream z
zlib compression handle
Definition: zstrm.c:43
char * buf
Buffer for data being (de-)compressed.
Definition: zstrm.c:44
bool stream_eof
Stream end-of-file reached.
Definition: zstrm.c:48
+ Here is the caller graph for this function:

Variable Documentation

◆ read

int(* SaslSockData::read) (struct Connection *conn, char *buf, size_t count)

Read from a socket Connection - Implements Connection::read() -.

Definition at line 82 of file sasl.c.