Be more wary about OpenSSL not setting errno on error.
authorTom Lane <[email protected]>
Mon, 11 Dec 2023 16:51:56 +0000 (11:51 -0500)
committerTom Lane <[email protected]>
Mon, 11 Dec 2023 16:51:56 +0000 (11:51 -0500)
OpenSSL will sometimes return SSL_ERROR_SYSCALL without having set
errno; this is apparently a reflection of recv(2)'s habit of not
setting errno when reporting EOF.  Ensure that we treat such cases
the same as read EOF.  Previously, we'd frequently report them like
"could not accept SSL connection: Success" which is confusing, or
worse report them with an unrelated errno left over from some
previous syscall.

To fix, ensure that errno is zeroed immediately before the call,
and report its value only when it's not zero afterwards; otherwise
report EOF.

For consistency, I've applied the same coding pattern in libpq's
pqsecure_raw_read().  Bare recv(2) shouldn't really return -1 without
setting errno, but in case it does we might as well cope.

Per report from Andres Freund.  Back-patch to all supported versions.

Discussion: https://postgr.es/m/20231208181451[email protected]

src/backend/libpq/be-secure-openssl.c
src/backend/libpq/pqcomm.c
src/interfaces/libpq/fe-secure-openssl.c
src/interfaces/libpq/fe-secure.c

index 9e22911379a1773c756524463642506845c4a6ee..4f9d0fdb092962fc74b094e9afed42fdbf74c91a 100644 (file)
@@ -424,6 +424,7 @@ aloop:
     * per-thread error queue following another call to an OpenSSL I/O
     * routine.
     */
+   errno = 0;
    ERR_clear_error();
    r = SSL_accept(port->ssl);
    if (r <= 0)
@@ -460,7 +461,7 @@ aloop:
                                         WAIT_EVENT_SSL_OPEN_SERVER);
                goto aloop;
            case SSL_ERROR_SYSCALL:
-               if (r < 0)
+               if (r < 0 && errno != 0)
                    ereport(COMMERROR,
                            (errcode_for_socket_access(),
                             errmsg("could not accept SSL connection: %m")));
@@ -636,7 +637,7 @@ be_tls_read(Port *port, void *ptr, size_t len, int *waitfor)
            break;
        case SSL_ERROR_SYSCALL:
            /* leave it to caller to ereport the value of errno */
-           if (n != -1)
+           if (n != -1 || errno == 0)
            {
                errno = ECONNRESET;
                n = -1;
@@ -694,8 +695,14 @@ be_tls_write(Port *port, void *ptr, size_t len, int *waitfor)
            n = -1;
            break;
        case SSL_ERROR_SYSCALL:
-           /* leave it to caller to ereport the value of errno */
-           if (n != -1)
+
+           /*
+            * Leave it to caller to ereport the value of errno.  However, if
+            * errno is still zero then assume it's a read EOF situation, and
+            * report ECONNRESET.  (This seems possible because SSL_write can
+            * also do reads.)
+            */
+           if (n != -1 || errno == 0)
            {
                errno = ECONNRESET;
                n = -1;
index 93f2e0b81d328da2c720239079e6e2a4e1ae679c..e8b0a2928d71ad22006f71f67bf269c3cefd80d2 100644 (file)
@@ -944,6 +944,8 @@ pq_recvbuf(void)
    {
        int         r;
 
+       errno = 0;
+
        r = secure_read(MyProcPort, PqRecvBuffer + PqRecvLength,
                        PQ_RECV_BUFFER_SIZE - PqRecvLength);
 
@@ -956,10 +958,13 @@ pq_recvbuf(void)
             * Careful: an ereport() that tries to write to the client would
             * cause recursion to here, leading to stack overflow and core
             * dump!  This message must go *only* to the postmaster log.
+            *
+            * If errno is zero, assume it's EOF and let the caller complain.
             */
-           ereport(COMMERROR,
-                   (errcode_for_socket_access(),
-                    errmsg("could not receive data from client: %m")));
+           if (errno != 0)
+               ereport(COMMERROR,
+                       (errcode_for_socket_access(),
+                        errmsg("could not receive data from client: %m")));
            return EOF;
        }
        if (r == 0)
@@ -1036,6 +1041,8 @@ pq_getbyte_if_available(unsigned char *c)
    /* Put the socket into non-blocking mode */
    socket_set_nonblocking(true);
 
+   errno = 0;
+
    r = secure_read(MyProcPort, c, 1);
    if (r < 0)
    {
@@ -1052,10 +1059,13 @@ pq_getbyte_if_available(unsigned char *c)
             * Careful: an ereport() that tries to write to the client would
             * cause recursion to here, leading to stack overflow and core
             * dump!  This message must go *only* to the postmaster log.
+            *
+            * If errno is zero, assume it's EOF and let the caller complain.
             */
-           ereport(COMMERROR,
-                   (errcode_for_socket_access(),
-                    errmsg("could not receive data from client: %m")));
+           if (errno != 0)
+               ereport(COMMERROR,
+                       (errcode_for_socket_access(),
+                        errmsg("could not receive data from client: %m")));
            r = EOF;
        }
    }
index 524563aa4374b84d9b4bd975c59349a2b7613279..502783b1af1e94ad04f4b3572effb4961681c52f 100644 (file)
@@ -200,7 +200,7 @@ rloop:
             */
            goto rloop;
        case SSL_ERROR_SYSCALL:
-           if (n < 0)
+           if (n < 0 && SOCK_ERRNO != 0)
            {
                result_errno = SOCK_ERRNO;
                if (result_errno == EPIPE ||
@@ -308,7 +308,13 @@ pgtls_write(PGconn *conn, const void *ptr, size_t len)
            n = 0;
            break;
        case SSL_ERROR_SYSCALL:
-           if (n < 0)
+
+           /*
+            * If errno is still zero then assume it's a read EOF situation,
+            * and report EOF.  (This seems possible because SSL_write can
+            * also do reads.)
+            */
+           if (n < 0 && SOCK_ERRNO != 0)
            {
                result_errno = SOCK_ERRNO;
                if (result_errno == EPIPE || result_errno == ECONNRESET)
@@ -1305,10 +1311,12 @@ open_client_SSL(PGconn *conn)
 {
    int         r;
 
+   SOCK_ERRNO_SET(0);
    ERR_clear_error();
    r = SSL_connect(conn->ssl);
    if (r <= 0)
    {
+       int         save_errno = SOCK_ERRNO;
        int         err = SSL_get_error(conn->ssl, r);
        unsigned long ecode;
 
@@ -1325,10 +1333,10 @@ open_client_SSL(PGconn *conn)
                {
                    char        sebuf[PG_STRERROR_R_BUFLEN];
 
-                   if (r == -1)
+                   if (r == -1 && save_errno != 0)
                        printfPQExpBuffer(&conn->errorMessage,
                                          libpq_gettext("SSL SYSCALL error: %s\n"),
-                                         SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
+                                         SOCK_STRERROR(save_errno, sebuf, sizeof(sebuf)));
                    else
                        printfPQExpBuffer(&conn->errorMessage,
                                          libpq_gettext("SSL SYSCALL error: EOF detected\n"));
index 3311fd7a5bdaeb14725e6add1228495b9e4e7360..377fc37d083de0d74fccbaf9538e450aa5d599e4 100644 (file)
@@ -242,6 +242,8 @@ pqsecure_raw_read(PGconn *conn, void *ptr, size_t len)
    int         result_errno = 0;
    char        sebuf[PG_STRERROR_R_BUFLEN];
 
+   SOCK_ERRNO_SET(0);
+
    n = recv(conn->sock, ptr, len, 0);
 
    if (n < 0)
@@ -270,6 +272,11 @@ pqsecure_raw_read(PGconn *conn, void *ptr, size_t len)
                break;
 #endif
 
+           case 0:
+               /* If errno didn't get set, treat it as regular EOF */
+               n = 0;
+               break;
+
            default:
                printfPQExpBuffer(&conn->errorMessage,
                                  libpq_gettext("could not receive data from server: %s\n"),