NeoMutt  2024-02-01-23-g345d7b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches

Open a socket Connection. More...

+ Collaboration diagram for open():

Functions

static int tls_socket_open (struct Connection *conn)
 Open a TLS socket - Implements Connection::open() -.
 
static int ssl_socket_open_err (struct Connection *conn)
 Error callback for opening an SSL connection - Implements Connection::open() -.
 
static int ssl_socket_open (struct Connection *conn)
 Open an SSL socket - Implements Connection::open() -.
 
int raw_socket_open (struct Connection *conn)
 Open a socket - Implements Connection::open() -.
 
static int mutt_sasl_conn_open (struct Connection *conn)
 Empty wrapper for underlying open function - Implements Connection::open() -.
 
static int tunnel_socket_open (struct Connection *conn)
 Open a tunnel socket - Implements Connection::open() -.
 
static int zstrm_open (struct Connection *conn)
 Open a socket - Implements Connection::open() -.
 

Variables

int(* SaslSockData::open )(struct Connection *conn)
 Open a socket Connection - Implements Connection::open() -.
 

Detailed Description

Open a socket Connection.

Parameters
connConnection to a server
Return values
0Success
-1Error

Function Documentation

◆ tls_socket_open()

static int tls_socket_open ( struct Connection conn)
static

Open a TLS socket - Implements Connection::open() -.

Definition at line 1027 of file gnutls.c.

1028{
1029 if (raw_socket_open(conn) < 0)
1030 return -1;
1031
1032 if (tls_negotiate(conn) < 0)
1033 {
1034 tls_socket_close(conn);
1035 return -1;
1036 }
1037
1038 return 0;
1039}
static int tls_negotiate(struct Connection *conn)
Negotiate TLS connection.
Definition: gnutls.c:871
static int tls_socket_close(struct Connection *conn)
Close a TLS socket - Implements Connection::close() -.
Definition: gnutls.c:1002
int raw_socket_open(struct Connection *conn)
Open a socket - Implements Connection::open() -.
Definition: raw.c:129
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ssl_socket_open_err()

static int ssl_socket_open_err ( struct Connection conn)
static

Error callback for opening an SSL connection - Implements Connection::open() -.

Return values
-1Always

Definition at line 356 of file openssl.c.

357{
358 mutt_error(_("SSL disabled due to the lack of entropy"));
359 return -1;
360}
#define mutt_error(...)
Definition: logging2.h:92
#define _(a)
Definition: message.h:28
+ Here is the caller graph for this function:

◆ ssl_socket_open()

static int ssl_socket_open ( struct Connection conn)
static

Open an SSL socket - Implements Connection::open() -.

Definition at line 1320 of file openssl.c.

1321{
1322 if (raw_socket_open(conn) < 0)
1323 return -1;
1324
1325 int rc = ssl_setup(conn);
1326 if (rc)
1327 raw_socket_close(conn);
1328
1329 return rc;
1330}
int raw_socket_close(struct Connection *conn)
Close a socket - Implements Connection::close() -.
Definition: raw.c:374
static int ssl_setup(struct Connection *conn)
Set up SSL on the Connection.
Definition: openssl.c:1203
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ raw_socket_open()

int raw_socket_open ( struct Connection conn)

Open a socket - Implements Connection::open() -.

Definition at line 129 of file raw.c.

130{
131 int rc;
132
133 char *host_idna = NULL;
134
135#ifdef HAVE_GETADDRINFO
136 /* --- IPv4/6 --- */
137
138 /* "65536\0" */
139 char port[6] = { 0 };
140 struct addrinfo hints = { 0 };
141 struct addrinfo *res = NULL;
142 struct addrinfo *cur = NULL;
143
144 /* we accept v4 or v6 STREAM sockets */
145 const bool c_use_ipv6 = cs_subset_bool(NeoMutt->sub, "use_ipv6");
146 if (c_use_ipv6)
147 hints.ai_family = AF_UNSPEC;
148 else
149 hints.ai_family = AF_INET;
150
151 hints.ai_socktype = SOCK_STREAM;
152
153 snprintf(port, sizeof(port), "%d", conn->account.port);
154
155#ifdef HAVE_LIBIDN
156 if (mutt_idna_to_ascii_lz(conn->account.host, &host_idna, 1) != 0)
157 {
158 mutt_error(_("Bad IDN: '%s'"), conn->account.host);
159 return -1;
160 }
161#else
162 host_idna = conn->account.host;
163#endif
164
165 if (!OptNoCurses)
166 mutt_message(_("Looking up %s..."), conn->account.host);
167
168 rc = getaddrinfo(host_idna, port, &hints, &res);
169
170#ifdef HAVE_LIBIDN
171 FREE(&host_idna);
172#endif
173
174 if (rc)
175 {
176 mutt_error(_("Could not find the host \"%s\""), conn->account.host);
177 return -1;
178 }
179
180 if (!OptNoCurses)
181 mutt_message(_("Connecting to %s..."), conn->account.host);
182
183 rc = -1;
184 for (cur = res; cur; cur = cur->ai_next)
185 {
186 int fd = socket(cur->ai_family, cur->ai_socktype, cur->ai_protocol);
187 if (fd >= 0)
188 {
189 rc = socket_connect(fd, cur->ai_addr);
190 if (rc == 0)
191 {
192 (void) fcntl(fd, F_SETFD, FD_CLOEXEC);
193 conn->fd = fd;
194 break;
195 }
196 else
197 {
198 close(fd);
199 }
200 }
201 }
202
203 freeaddrinfo(res);
204#else
205 /* --- IPv4 only --- */
206
207 struct hostent *he = NULL;
208 struct sockaddr_in sin = { 0 };
209 sin.sin_port = htons(conn->account.port);
210 sin.sin_family = AF_INET;
211
212#ifdef HAVE_LIBIDN
213 if (mutt_idna_to_ascii_lz(conn->account.host, &host_idna, 1) != 0)
214 {
215 mutt_error(_("Bad IDN: '%s'"), conn->account.host);
216 return -1;
217 }
218#else
219 host_idna = conn->account.host;
220#endif
221
222 if (!OptNoCurses)
223 mutt_message(_("Looking up %s..."), conn->account.host);
224
225 he = gethostbyname(host_idna);
226
227#ifdef HAVE_LIBIDN
228 FREE(&host_idna);
229#endif
230
231 if (!he)
232 {
233 mutt_error(_("Could not find the host \"%s\""), conn->account.host);
234
235 return -1;
236 }
237
238 if (!OptNoCurses)
239 mutt_message(_("Connecting to %s..."), conn->account.host);
240
241 rc = -1;
242 for (int i = 0; he->h_addr_list[i]; i++)
243 {
244 memcpy(&sin.sin_addr, he->h_addr_list[i], he->h_length);
245 int fd = socket(PF_INET, SOCK_STREAM, IPPROTO_IP);
246
247 if (fd >= 0)
248 {
249 rc = socket_connect(fd, (struct sockaddr *) &sin);
250 if (rc == 0)
251 {
252 fcntl(fd, F_SETFD, FD_CLOEXEC);
253 conn->fd = fd;
254 break;
255 }
256 else
257 {
258 close(fd);
259 }
260 }
261 }
262#endif
263 if (rc)
264 {
265 mutt_error(_("Could not connect to %s (%s)"), conn->account.host,
266 (rc > 0) ? strerror(rc) : _("unknown error"));
267 return -1;
268 }
269
270 return 0;
271}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
bool OptNoCurses
(pseudo) when sending in batch mode
Definition: globals.c:72
#define mutt_message(...)
Definition: logging2.h:91
int mutt_idna_to_ascii_lz(const char *input, char **output, uint8_t flags)
Convert a domain to Punycode.
Definition: idna.c:90
#define FREE(x)
Definition: memory.h:45
static int socket_connect(int fd, struct sockaddr *sa)
Set up to connect to a socket fd.
Definition: raw.c:66
char host[128]
Server to login to.
Definition: connaccount.h:54
unsigned short port
Port to connect to.
Definition: connaccount.h:58
struct ConnAccount account
Account details: username, password, etc.
Definition: connection.h:49
int fd
Socket file descriptor.
Definition: connection.h:53
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_sasl_conn_open()

static int mutt_sasl_conn_open ( struct Connection conn)
static

Empty wrapper for underlying open function - Implements Connection::open() -.

We don't know in advance that a connection will use SASL, so we replace conn's methods with sasl methods when authentication is successful, using mutt_sasl_setup_conn

Definition at line 427 of file sasl.c.

428{
429 struct SaslSockData *sasldata = conn->sockdata;
430 conn->sockdata = sasldata->sockdata;
431 int rc = sasldata->open(conn);
432 conn->sockdata = sasldata;
433
434 return rc;
435}
int(* open)(struct Connection *conn)
Open a socket Connection - Implements Connection::open() -.
Definition: sasl.c:80
void * sockdata
Backend-specific socket data.
Definition: connection.h:55
SASL authentication API -.
Definition: sasl.c:65
void * sockdata
Underlying socket data.
Definition: sasl.c:75
+ Here is the caller graph for this function:

◆ tunnel_socket_open()

static int tunnel_socket_open ( struct Connection conn)
static

Open a tunnel socket - Implements Connection::open() -.

Definition at line 59 of file tunnel.c.

60{
61 int pin[2], pout[2];
62
63 struct TunnelSockData *tunnel = mutt_mem_malloc(sizeof(struct TunnelSockData));
64 conn->sockdata = tunnel;
65
66 const char *const c_tunnel = cs_subset_string(NeoMutt->sub, "tunnel");
67 mutt_message(_("Connecting with \"%s\"..."), c_tunnel);
68
69 int rc = pipe(pin);
70 if (rc == -1)
71 {
72 mutt_perror("pipe");
73 FREE(&conn->sockdata);
74 return -1;
75 }
76 rc = pipe(pout);
77 if (rc == -1)
78 {
79 mutt_perror("pipe");
80 close(pin[0]);
81 close(pin[1]);
82 FREE(&conn->sockdata);
83 return -1;
84 }
85
87 int pid = fork();
88 if (pid == 0)
89 {
91 const int fd_null = open("/dev/null", O_RDWR);
92 if ((fd_null < 0) || (dup2(pout[0], STDIN_FILENO) < 0) ||
93 (dup2(pin[1], STDOUT_FILENO) < 0) || (dup2(fd_null, STDERR_FILENO) < 0))
94 {
95 _exit(127);
96 }
97 close(pin[0]);
98 close(pin[1]);
99 close(pout[0]);
100 close(pout[1]);
101 close(fd_null);
102
103 /* Don't let the subprocess think it can use the controlling tty */
104 setsid();
105
106 execle(EXEC_SHELL, "sh", "-c", c_tunnel, NULL, EnvList);
107 _exit(127);
108 }
110
111 if (pid == -1)
112 {
113 mutt_perror("fork");
114 close(pin[0]);
115 close(pin[1]);
116 close(pout[0]);
117 close(pout[1]);
118 FREE(&conn->sockdata);
119 return -1;
120 }
121 if ((close(pin[1]) < 0) || (close(pout[0]) < 0))
122 mutt_perror("close");
123
124 fcntl(pin[0], F_SETFD, FD_CLOEXEC);
125 fcntl(pout[1], F_SETFD, FD_CLOEXEC);
126
127 tunnel->fd_read = pin[0];
128 tunnel->fd_write = pout[1];
129 tunnel->pid = pid;
130
131 conn->fd = 42; /* stupid hack */
132
133 /* Note we are using ssf as a boolean in this case. See the notes in
134 * conn/connection.h */
135 const bool c_tunnel_is_secure = cs_subset_bool(NeoMutt->sub, "tunnel_is_secure");
136 if (c_tunnel_is_secure)
137 conn->ssf = 1;
138
139 return 0;
140}
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:292
#define EXEC_SHELL
Definition: filter.h:28
char ** EnvList
Private copy of the environment variables.
Definition: globals.c:78
#define mutt_perror(...)
Definition: logging2.h:93
void * mutt_mem_malloc(size_t size)
Allocate memory on the heap.
Definition: memory.c:90
void mutt_sig_block_system(void)
Block signals before calling exec()
Definition: signal.c:199
void mutt_sig_unblock_system(bool restore)
Restore previously blocked signals.
Definition: signal.c:223
unsigned int ssf
Security strength factor, in bits (see notes)
Definition: connection.h:50
A network tunnel (pair of sockets)
Definition: tunnel.c:50
int fd_read
File descriptor to read from.
Definition: tunnel.c:52
pid_t pid
Process ID of tunnel program.
Definition: tunnel.c:51
int fd_write
File descriptor to write to.
Definition: tunnel.c:53
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ zstrm_open()

static int zstrm_open ( struct Connection conn)
static

Open a socket - Implements Connection::open() -.

Return values
-1Always

Cannot open a zlib connection, must wrap an existing one

Definition at line 92 of file zstrm.c.

93{
94 return -1;
95}
+ Here is the caller graph for this function:

Variable Documentation

◆ open

int(* SaslSockData::open) (struct Connection *conn)

Open a socket Connection - Implements Connection::open() -.

Definition at line 80 of file sasl.c.