PostgreSQL Source Code  git master
fe-secure.c File Reference
#include "postgres_fe.h"
#include <signal.h>
#include <fcntl.h>
#include <ctype.h>
#include <sys/socket.h>
#include <unistd.h>
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <sys/stat.h>
#include <pthread.h>
#include "fe-auth.h"
#include "libpq-fe.h"
#include "libpq-int.h"
Include dependency graph for fe-secure.c:

Go to the source code of this file.

Data Structures

struct  sigpipe_info
 

Macros

#define SIGPIPE_MASKED(conn)   ((conn)->sigpipe_so || (conn)->sigpipe_flag)
 
#define DECLARE_SIGPIPE_INFO(spinfo)   struct sigpipe_info spinfo
 
#define DISABLE_SIGPIPE(conn, spinfo, failaction)
 
#define REMEMBER_EPIPE(spinfo, cond)
 
#define RESTORE_SIGPIPE(conn, spinfo)
 

Functions

int PQsslInUse (PGconn *conn)
 
void PQinitSSL (int do_init)
 
void PQinitOpenSSL (int do_ssl, int do_crypto)
 
PostgresPollingStatusType pqsecure_open_client (PGconn *conn)
 
void pqsecure_close (PGconn *conn)
 
ssize_t pqsecure_read (PGconn *conn, void *ptr, size_t len)
 
ssize_t pqsecure_raw_read (PGconn *conn, void *ptr, size_t len)
 
ssize_t pqsecure_write (PGconn *conn, const void *ptr, size_t len)
 
ssize_t pqsecure_raw_write (PGconn *conn, const void *ptr, size_t len)
 
void * PQgetssl (PGconn *conn)
 
void * PQsslStruct (PGconn *conn, const char *struct_name)
 
const char * PQsslAttribute (PGconn *conn, const char *attribute_name)
 
const char *const * PQsslAttributeNames (PGconn *conn)
 
PQsslKeyPassHook_OpenSSL_type PQgetSSLKeyPassHook_OpenSSL (void)
 
void PQsetSSLKeyPassHook_OpenSSL (PQsslKeyPassHook_OpenSSL_type hook)
 
int PQdefaultSSLKeyPassHook_OpenSSL (char *buf, int size, PGconn *conn)
 
void * PQgetgssctx (PGconn *conn)
 
int PQgssEncInUse (PGconn *conn)
 
int pq_block_sigpipe (sigset_t *osigset, bool *sigpipe_pending)
 
void pq_reset_sigpipe (sigset_t *osigset, bool sigpipe_pending, bool got_epipe)
 

Macro Definition Documentation

◆ DECLARE_SIGPIPE_INFO

#define DECLARE_SIGPIPE_INFO (   spinfo)    struct sigpipe_info spinfo

Definition at line 64 of file fe-secure.c.

◆ DISABLE_SIGPIPE

#define DISABLE_SIGPIPE (   conn,
  spinfo,
  failaction 
)
Value:
do { \
(spinfo).got_epipe = false; \
{ \
if (pq_block_sigpipe(&(spinfo).oldsigmask, \
&(spinfo).sigpipe_pending) < 0) \
failaction; \
} \
} while (0)
#define SIGPIPE_MASKED(conn)
Definition: fe-secure.c:55
int pq_block_sigpipe(sigset_t *osigset, bool *sigpipe_pending)
Definition: fe-secure.c:504
PGconn * conn
Definition: streamutil.c:55

Definition at line 66 of file fe-secure.c.

◆ REMEMBER_EPIPE

#define REMEMBER_EPIPE (   spinfo,
  cond 
)
Value:
do { \
if (cond) \
(spinfo).got_epipe = true; \
} while (0)

Definition at line 77 of file fe-secure.c.

◆ RESTORE_SIGPIPE

#define RESTORE_SIGPIPE (   conn,
  spinfo 
)
Value:
do { \
pq_reset_sigpipe(&(spinfo).oldsigmask, (spinfo).sigpipe_pending, \
(spinfo).got_epipe); \
} while (0)

Definition at line 83 of file fe-secure.c.

◆ SIGPIPE_MASKED

#define SIGPIPE_MASKED (   conn)    ((conn)->sigpipe_so || (conn)->sigpipe_flag)

Definition at line 55 of file fe-secure.c.

Function Documentation

◆ pq_block_sigpipe()

int pq_block_sigpipe ( sigset_t *  osigset,
bool sigpipe_pending 
)

Definition at line 504 of file fe-secure.c.

505 {
506  sigset_t sigpipe_sigset;
507  sigset_t sigset;
508 
509  sigemptyset(&sigpipe_sigset);
510  sigaddset(&sigpipe_sigset, SIGPIPE);
511 
512  /* Block SIGPIPE and save previous mask for later reset */
513  SOCK_ERRNO_SET(pthread_sigmask(SIG_BLOCK, &sigpipe_sigset, osigset));
514  if (SOCK_ERRNO)
515  return -1;
516 
517  /* We can have a pending SIGPIPE only if it was blocked before */
518  if (sigismember(osigset, SIGPIPE))
519  {
520  /* Is there a pending SIGPIPE? */
521  if (sigpending(&sigset) != 0)
522  return -1;
523 
524  if (sigismember(&sigset, SIGPIPE))
525  *sigpipe_pending = true;
526  else
527  *sigpipe_pending = false;
528  }
529  else
530  *sigpipe_pending = false;
531 
532  return 0;
533 }
#define SOCK_ERRNO
Definition: libpq-int.h:926
#define SOCK_ERRNO_SET(e)
Definition: libpq-int.h:928
#define SIGPIPE
Definition: win32_port.h:173

References SIGPIPE, SOCK_ERRNO, and SOCK_ERRNO_SET.

Referenced by PQprint().

◆ pq_reset_sigpipe()

void pq_reset_sigpipe ( sigset_t *  osigset,
bool  sigpipe_pending,
bool  got_epipe 
)

Definition at line 554 of file fe-secure.c.

555 {
556  int save_errno = SOCK_ERRNO;
557  int signo;
558  sigset_t sigset;
559 
560  /* Clear SIGPIPE only if none was pending */
561  if (got_epipe && !sigpipe_pending)
562  {
563  if (sigpending(&sigset) == 0 &&
564  sigismember(&sigset, SIGPIPE))
565  {
566  sigset_t sigpipe_sigset;
567 
568  sigemptyset(&sigpipe_sigset);
569  sigaddset(&sigpipe_sigset, SIGPIPE);
570 
571  sigwait(&sigpipe_sigset, &signo);
572  }
573  }
574 
575  /* Restore saved block mask */
576  pthread_sigmask(SIG_SETMASK, osigset, NULL);
577 
578  SOCK_ERRNO_SET(save_errno);
579 }

References SIGPIPE, SOCK_ERRNO, and SOCK_ERRNO_SET.

Referenced by PQprint().

◆ PQdefaultSSLKeyPassHook_OpenSSL()

int PQdefaultSSLKeyPassHook_OpenSSL ( char *  buf,
int  size,
PGconn conn 
)

Definition at line 473 of file fe-secure.c.

474 {
475  return 0;
476 }

◆ PQgetgssctx()

void* PQgetgssctx ( PGconn conn)

Definition at line 483 of file fe-secure.c.

484 {
485  return NULL;
486 }

◆ PQgetssl()

void* PQgetssl ( PGconn conn)

Definition at line 428 of file fe-secure.c.

429 {
430  return NULL;
431 }

◆ PQgetSSLKeyPassHook_OpenSSL()

PQsslKeyPassHook_OpenSSL_type PQgetSSLKeyPassHook_OpenSSL ( void  )

Definition at line 461 of file fe-secure.c.

462 {
463  return NULL;
464 }

◆ PQgssEncInUse()

int PQgssEncInUse ( PGconn conn)

Definition at line 489 of file fe-secure.c.

490 {
491  return 0;
492 }

◆ PQinitOpenSSL()

void PQinitOpenSSL ( int  do_ssl,
int  do_crypto 
)

Definition at line 129 of file fe-secure.c.

130 {
131  /* no-op */
132 }

◆ PQinitSSL()

void PQinitSSL ( int  do_init)

Definition at line 117 of file fe-secure.c.

118 {
119  /* no-op */
120 }

◆ pqsecure_close()

void pqsecure_close ( PGconn conn)

Definition at line 152 of file fe-secure.c.

153 {
154 #ifdef USE_SSL
155  pgtls_close(conn);
156 #endif
157 }
void pgtls_close(PGconn *conn)

References conn, and pgtls_close().

Referenced by pqDropConnection().

◆ pqsecure_open_client()

PostgresPollingStatusType pqsecure_open_client ( PGconn conn)

Definition at line 138 of file fe-secure.c.

139 {
140 #ifdef USE_SSL
141  return pgtls_open_client(conn);
142 #else
143  /* shouldn't get here */
144  return PGRES_POLLING_FAILED;
145 #endif
146 }
PostgresPollingStatusType pgtls_open_client(PGconn *conn)
@ PGRES_POLLING_FAILED
Definition: libpq-fe.h:110

References conn, PGRES_POLLING_FAILED, and pgtls_open_client().

Referenced by PQconnectPoll().

◆ pqsecure_raw_read()

ssize_t pqsecure_raw_read ( PGconn conn,
void *  ptr,
size_t  len 
)

Definition at line 193 of file fe-secure.c.

194 {
195  ssize_t n;
196  int result_errno = 0;
197  char sebuf[PG_STRERROR_R_BUFLEN];
198 
199  SOCK_ERRNO_SET(0);
200 
201  n = recv(conn->sock, ptr, len, 0);
202 
203  if (n < 0)
204  {
205  result_errno = SOCK_ERRNO;
206 
207  /* Set error message if appropriate */
208  switch (result_errno)
209  {
210 #ifdef EAGAIN
211  case EAGAIN:
212 #endif
213 #if defined(EWOULDBLOCK) && (!defined(EAGAIN) || (EWOULDBLOCK != EAGAIN))
214  case EWOULDBLOCK:
215 #endif
216  case EINTR:
217  /* no error message, caller is expected to retry */
218  break;
219 
220  case EPIPE:
221  case ECONNRESET:
222  libpq_append_conn_error(conn, "server closed the connection unexpectedly\n"
223  "\tThis probably means the server terminated abnormally\n"
224  "\tbefore or while processing the request.");
225  break;
226 
227  case 0:
228  /* If errno didn't get set, treat it as regular EOF */
229  n = 0;
230  break;
231 
232  default:
233  libpq_append_conn_error(conn, "could not receive data from server: %s",
234  SOCK_STRERROR(result_errno,
235  sebuf, sizeof(sebuf)));
236  break;
237  }
238  }
239 
240  /* ensure we return the intended errno to caller */
241  SOCK_ERRNO_SET(result_errno);
242 
243  return n;
244 }
void libpq_append_conn_error(PGconn *conn, const char *fmt,...)
Definition: fe-misc.c:1372
#define SOCK_STRERROR
Definition: libpq-int.h:927
const void size_t len
#define PG_STRERROR_R_BUFLEN
Definition: port.h:256
pgsocket sock
Definition: libpq-int.h:485
#define EINTR
Definition: win32_port.h:374
#define EWOULDBLOCK
Definition: win32_port.h:380
#define recv(s, buf, len, flags)
Definition: win32_port.h:514
#define ECONNRESET
Definition: win32_port.h:384
#define EAGAIN
Definition: win32_port.h:372

References conn, EAGAIN, ECONNRESET, EINTR, EWOULDBLOCK, len, libpq_append_conn_error(), PG_STRERROR_R_BUFLEN, recv, pg_conn::sock, SOCK_ERRNO, SOCK_ERRNO_SET, and SOCK_STRERROR.

Referenced by gss_read(), my_sock_read(), pg_GSS_read(), and pqsecure_read().

◆ pqsecure_raw_write()

ssize_t pqsecure_raw_write ( PGconn conn,
const void *  ptr,
size_t  len 
)

Definition at line 316 of file fe-secure.c.

317 {
318  ssize_t n;
319  int flags = 0;
320  int result_errno = 0;
321  char msgbuf[1024];
322  char sebuf[PG_STRERROR_R_BUFLEN];
323 
324  DECLARE_SIGPIPE_INFO(spinfo);
325 
326  /*
327  * If we already had a write failure, we will never again try to send data
328  * on that connection. Even if the kernel would let us, we've probably
329  * lost message boundary sync with the server. conn->write_failed
330  * therefore persists until the connection is reset, and we just discard
331  * all data presented to be written.
332  */
333  if (conn->write_failed)
334  return len;
335 
336 #ifdef MSG_NOSIGNAL
337  if (conn->sigpipe_flag)
338  flags |= MSG_NOSIGNAL;
339 
340 retry_masked:
341 #endif /* MSG_NOSIGNAL */
342 
343  DISABLE_SIGPIPE(conn, spinfo, return -1);
344 
345  n = send(conn->sock, ptr, len, flags);
346 
347  if (n < 0)
348  {
349  result_errno = SOCK_ERRNO;
350 
351  /*
352  * If we see an EINVAL, it may be because MSG_NOSIGNAL isn't available
353  * on this machine. So, clear sigpipe_flag so we don't try the flag
354  * again, and retry the send().
355  */
356 #ifdef MSG_NOSIGNAL
357  if (flags != 0 && result_errno == EINVAL)
358  {
359  conn->sigpipe_flag = false;
360  flags = 0;
361  goto retry_masked;
362  }
363 #endif /* MSG_NOSIGNAL */
364 
365  /* Set error message if appropriate */
366  switch (result_errno)
367  {
368 #ifdef EAGAIN
369  case EAGAIN:
370 #endif
371 #if defined(EWOULDBLOCK) && (!defined(EAGAIN) || (EWOULDBLOCK != EAGAIN))
372  case EWOULDBLOCK:
373 #endif
374  case EINTR:
375  /* no error message, caller is expected to retry */
376  break;
377 
378  case EPIPE:
379  /* Set flag for EPIPE */
380  REMEMBER_EPIPE(spinfo, true);
381 
382  /* FALL THRU */
383 
384  case ECONNRESET:
385  conn->write_failed = true;
386  /* Store error message in conn->write_err_msg, if possible */
387  /* (strdup failure is OK, we'll cope later) */
388  snprintf(msgbuf, sizeof(msgbuf),
389  libpq_gettext("server closed the connection unexpectedly\n"
390  "\tThis probably means the server terminated abnormally\n"
391  "\tbefore or while processing the request."));
392  /* keep newline out of translated string */
393  strlcat(msgbuf, "\n", sizeof(msgbuf));
394  conn->write_err_msg = strdup(msgbuf);
395  /* Now claim the write succeeded */
396  n = len;
397  break;
398 
399  default:
400  conn->write_failed = true;
401  /* Store error message in conn->write_err_msg, if possible */
402  /* (strdup failure is OK, we'll cope later) */
403  snprintf(msgbuf, sizeof(msgbuf),
404  libpq_gettext("could not send data to server: %s"),
405  SOCK_STRERROR(result_errno,
406  sebuf, sizeof(sebuf)));
407  /* keep newline out of translated string */
408  strlcat(msgbuf, "\n", sizeof(msgbuf));
409  conn->write_err_msg = strdup(msgbuf);
410  /* Now claim the write succeeded */
411  n = len;
412  break;
413  }
414  }
415 
416  RESTORE_SIGPIPE(conn, spinfo);
417 
418  /* ensure we return the intended errno to caller */
419  SOCK_ERRNO_SET(result_errno);
420 
421  return n;
422 }
#define REMEMBER_EPIPE(spinfo, cond)
Definition: fe-secure.c:77
#define DISABLE_SIGPIPE(conn, spinfo, failaction)
Definition: fe-secure.c:66
#define DECLARE_SIGPIPE_INFO(spinfo)
Definition: fe-secure.c:64
#define RESTORE_SIGPIPE(conn, spinfo)
Definition: fe-secure.c:83
#define libpq_gettext(x)
Definition: libpq-int.h:905
#define snprintf
Definition: port.h:238
size_t strlcat(char *dst, const char *src, size_t siz)
Definition: strlcat.c:33
char * write_err_msg
Definition: libpq-int.h:497
bool sigpipe_flag
Definition: libpq-int.h:495
bool write_failed
Definition: libpq-int.h:496
#define send(s, buf, len, flags)
Definition: win32_port.h:515

References conn, DECLARE_SIGPIPE_INFO, DISABLE_SIGPIPE, EAGAIN, ECONNRESET, EINTR, EWOULDBLOCK, len, libpq_gettext, PG_STRERROR_R_BUFLEN, REMEMBER_EPIPE, RESTORE_SIGPIPE, send, pg_conn::sigpipe_flag, snprintf, pg_conn::sock, SOCK_ERRNO, SOCK_ERRNO_SET, SOCK_STRERROR, strlcat(), pg_conn::write_err_msg, and pg_conn::write_failed.

Referenced by my_sock_write(), pg_GSS_write(), pqsecure_open_gss(), and pqsecure_write().

◆ pqsecure_read()

ssize_t pqsecure_read ( PGconn conn,
void *  ptr,
size_t  len 
)

Definition at line 167 of file fe-secure.c.

168 {
169  ssize_t n;
170 
171 #ifdef USE_SSL
172  if (conn->ssl_in_use)
173  {
174  n = pgtls_read(conn, ptr, len);
175  }
176  else
177 #endif
178 #ifdef ENABLE_GSS
179  if (conn->gssenc)
180  {
181  n = pg_GSS_read(conn, ptr, len);
182  }
183  else
184 #endif
185  {
186  n = pqsecure_raw_read(conn, ptr, len);
187  }
188 
189  return n;
190 }
ssize_t pg_GSS_read(PGconn *conn, void *ptr, size_t len)
ssize_t pgtls_read(PGconn *conn, void *ptr, size_t len)
ssize_t pqsecure_raw_read(PGconn *conn, void *ptr, size_t len)
Definition: fe-secure.c:193
bool ssl_in_use
Definition: libpq-int.h:580

References conn, len, pg_GSS_read(), pgtls_read(), pqsecure_raw_read(), and pg_conn::ssl_in_use.

Referenced by pqReadData().

◆ pqsecure_write()

ssize_t pqsecure_write ( PGconn conn,
const void *  ptr,
size_t  len 
)

Definition at line 267 of file fe-secure.c.

268 {
269  ssize_t n;
270 
271 #ifdef USE_SSL
272  if (conn->ssl_in_use)
273  {
274  n = pgtls_write(conn, ptr, len);
275  }
276  else
277 #endif
278 #ifdef ENABLE_GSS
279  if (conn->gssenc)
280  {
281  n = pg_GSS_write(conn, ptr, len);
282  }
283  else
284 #endif
285  {
286  n = pqsecure_raw_write(conn, ptr, len);
287  }
288 
289  return n;
290 }
ssize_t pg_GSS_write(PGconn *conn, const void *ptr, size_t len)
ssize_t pgtls_write(PGconn *conn, const void *ptr, size_t len)
ssize_t pqsecure_raw_write(PGconn *conn, const void *ptr, size_t len)
Definition: fe-secure.c:316

References conn, len, pg_GSS_write(), pgtls_write(), pqsecure_raw_write(), and pg_conn::ssl_in_use.

Referenced by pqSendSome().

◆ PQsetSSLKeyPassHook_OpenSSL()

void PQsetSSLKeyPassHook_OpenSSL ( PQsslKeyPassHook_OpenSSL_type  hook)

Definition at line 467 of file fe-secure.c.

468 {
469  return;
470 }

◆ PQsslAttribute()

const char* PQsslAttribute ( PGconn conn,
const char *  attribute_name 
)

Definition at line 440 of file fe-secure.c.

441 {
442  return NULL;
443 }

◆ PQsslAttributeNames()

const char* const* PQsslAttributeNames ( PGconn conn)

Definition at line 446 of file fe-secure.c.

447 {
448  static const char *const result[] = {NULL};
449 
450  return result;
451 }

◆ PQsslInUse()

int PQsslInUse ( PGconn conn)

Definition at line 103 of file fe-secure.c.

104 {
105  if (!conn)
106  return 0;
107  return conn->ssl_in_use;
108 }

References conn, and pg_conn::ssl_in_use.

Referenced by printSSLInfo().

◆ PQsslStruct()

void* PQsslStruct ( PGconn conn,
const char *  struct_name 
)

Definition at line 434 of file fe-secure.c.

435 {
436  return NULL;
437 }