NeoMutt  2023-11-03-107-g582dc1
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches

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() -.
 
static int ssl_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from an SSL socket - Implements Connection::read() -.
 
int raw_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from a socket - Implements Connection::read() -.
 
static int mutt_sasl_conn_read (struct Connection *conn, char *buf, size_t count)
 Read data from an SASL connection - Implements Connection::read() -.
 
static int tunnel_socket_read (struct Connection *conn, char *buf, size_t count)
 Read data from a tunnel socket - Implements Connection::read() -.
 
static int zstrm_read (struct Connection *conn, char *buf, size_t len)
 Read compressed data from a socket - Implements Connection::read() -.
 

Variables

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

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 1044 of file gnutls.c.

1045{
1046 struct TlsSockData *data = conn->sockdata;
1047 if (!data)
1048 {
1049 mutt_error(_("Error: no TLS socket open"));
1050 return -1;
1051 }
1052
1053 int rc;
1054 do
1055 {
1056 rc = gnutls_record_recv(data->session, buf, count);
1057 } while ((rc == GNUTLS_E_AGAIN) || (rc == GNUTLS_E_INTERRUPTED));
1058
1059 if (rc < 0)
1060 {
1061 mutt_error("tls_socket_read (%s)", gnutls_strerror(rc));
1062 return -1;
1063 }
1064
1065 return rc;
1066}
#define mutt_error(...)
Definition: logging2.h:92
#define _(a)
Definition: message.h:28
void * sockdata
Backend-specific socket data.
Definition: connection.h:56
TLS socket data -.
Definition: gnutls.c:82
gnutls_session_t session
Definition: gnutls.c:83
+ 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 1332 of file openssl.c.

1333{
1334 struct SslSockData *data = sockdata(conn);
1335 int rc;
1336
1337retry:
1338 rc = SSL_read(data->ssl, buf, count);
1339 if (rc > 0)
1340 return rc;
1341
1342 // User hit Ctrl-C
1343 if (SigInt && (errno == EINTR))
1344 {
1345 rc = -1;
1346 }
1347 else if (BIO_should_retry(SSL_get_rbio(data->ssl)))
1348 {
1349 // Temporary failure, e.g. signal received
1350 goto retry;
1351 }
1352
1353 data->isopen = 0;
1354 ssl_err(data, rc);
1355 return rc;
1356}
SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: globals.c:59
static struct SslSockData * sockdata(struct Connection *conn)
Get a Connection's socket data.
Definition: openssl.c:1189
static void ssl_err(struct SslSockData *data, int err)
Display an SSL error message.
Definition: openssl.c:236
+ 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 277 of file raw.c.

278{
279 int rc;
280
282 do
283 {
284 rc = read(conn->fd, buf, count);
285 } while (rc < 0 && (errno == EINTR));
286
287 if (rc < 0)
288 {
289 mutt_error(_("Error talking to %s (%s)"), conn->account.host, strerror(errno));
290 SigInt = false;
291 }
293
294 if (SigInt)
295 {
296 mutt_error(_("Connection to %s has been aborted"), conn->account.host);
297 SigInt = false;
298 rc = -1;
299 }
300
301 return rc;
302}
void mutt_sig_allow_interrupt(bool allow)
Allow/disallow Ctrl-C (SIGINT)
Definition: signal.c:251
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 467 of file sasl.c.

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

146{
147 struct TunnelSockData *tunnel = conn->sockdata;
148 int rc;
149
150 do
151 {
152 rc = read(tunnel->fd_read, buf, count);
153 } while (rc < 0 && errno == EINTR);
154
155 if (rc < 0)
156 {
157 mutt_error(_("Tunnel error talking to %s: %s"), conn->account.host, strerror(errno));
158 return -1;
159 }
160
161 return rc;
162}
A network tunnel (pair of sockets)
Definition: tunnel.c:50
int fd_read
File descriptor to read from.
Definition: tunnel.c:52
+ 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 %zu/%zu 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: logging2.h:47
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 84 of file sasl.c.