oauth-curl.h File Reference

#include "libpq-fe.h"

Include dependency graph for oauth-curl.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PGDLLEXPORT PostgresPollingStatusType	pg_fe_run_oauth_flow (PGconn *conn)
PGDLLEXPORT void	pg_fe_cleanup_oauth_flow (PGconn *conn)

Function Documentation

pg_fe_cleanup_oauth_flow()

PGDLLEXPORT void pg_fe_cleanup_oauth_flow

(

PGconn *

conn

)

Definition at line 355 of file oauth-curl.c.

{
    fe_oauth_state *state = conn_sasl_state(conn);
 
    if (state->async_ctx)
    {
        free_async_ctx(conn, state->async_ctx);
        state->async_ctx = NULL;
    }
 
    set_conn_altsock(conn, PGINVALID_SOCKET);
}

References conn, conn_sasl_state, free_async_ctx(), PGINVALID_SOCKET, and set_conn_altsock.

pg_fe_run_oauth_flow()

PGDLLEXPORT PostgresPollingStatusType pg_fe_run_oauth_flow

(

PGconn *

conn

)

Definition at line 3027 of file oauth-curl.c.

{
    PostgresPollingStatusType result;
    fe_oauth_state *state = conn_sasl_state(conn);
    struct async_ctx *actx;
#ifndef WIN32
    sigset_t    osigset;
    bool        sigpipe_pending;
    bool        masked;
 
    /*---
     * Ignore SIGPIPE on this thread during all Curl processing.
     *
     * Because we support multiple threads, we have to set up libcurl with
     * CURLOPT_NOSIGNAL, which disables its default global handling of
     * SIGPIPE. From the Curl docs:
     *
     *     libcurl makes an effort to never cause such SIGPIPE signals to
     *     trigger, but some operating systems have no way to avoid them and
     *     even on those that have there are some corner cases when they may
     *     still happen, contrary to our desire.
     *
     * Note that libcurl is also at the mercy of its DNS resolution and SSL
     * libraries; if any of them forget a MSG_NOSIGNAL then we're in trouble.
     * Modern platforms and libraries seem to get it right, so this is a
     * difficult corner case to exercise in practice, and unfortunately it's
     * not really clear whether it's necessary in all cases.
     */
    masked = (pq_block_sigpipe(&osigset, &sigpipe_pending) == 0);
#endif
 
    result = pg_fe_run_oauth_flow_impl(conn);
 
    /*
     * To assist with finding bugs in comb_multiplexer() and
     * drain_timer_events(), when we're in debug mode, track the total number
     * of calls to this function and print that at the end of the flow.
     *
     * Be careful that state->async_ctx could be NULL if early initialization
     * fails during the first call.
     */
    actx = state->async_ctx;
    Assert(actx || result == PGRES_POLLING_FAILED);
 
    if (actx && actx->debugging)
    {
        actx->dbg_num_calls++;
        if (result == PGRES_POLLING_OK || result == PGRES_POLLING_FAILED)
            fprintf(stderr, "[libpq] total number of polls: %d\n",
                    actx->dbg_num_calls);
    }
 
#ifndef WIN32
    if (masked)
    {
        /*
         * Undo the SIGPIPE mask. Assume we may have gotten EPIPE (we have no
         * way of knowing at this level).
         */
        pq_reset_sigpipe(&osigset, sigpipe_pending, true /* EPIPE, maybe */ );
    }
#endif
 
    return result;
}

References Assert(), conn, conn_sasl_state, async_ctx::dbg_num_calls, async_ctx::debugging, fprintf, pg_fe_run_oauth_flow_impl(), PGRES_POLLING_FAILED, PGRES_POLLING_OK, pq_block_sigpipe(), and pq_reset_sigpipe().