fe-auth-oauth.h File Reference

#include "libpq-fe.h"
#include "libpq-int.h"

Include dependency graph for fe-auth-oauth.h:

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

Go to the source code of this file.

Data Structures
struct	fe_oauth_state

Enumerations
enum	fe_oauth_step { FE_OAUTH_INIT , FE_OAUTH_BEARER_SENT , FE_OAUTH_REQUESTING_TOKEN , FE_OAUTH_SERVER_ERROR }

Functions
PostgresPollingStatusType	pg_fe_run_oauth_flow (PGconn *conn)
void	pg_fe_cleanup_oauth_flow (PGconn *conn)
void	pqClearOAuthToken (PGconn *conn)
bool	oauth_unsafe_debugging_enabled (void)

Variables
const pg_fe_sasl_mech	pg_oauth_mech

Enumeration Type Documentation

fe_oauth_step

enum fe_oauth_step

Enumerator
FE_OAUTH_INIT
FE_OAUTH_BEARER_SENT
FE_OAUTH_REQUESTING_TOKEN
FE_OAUTH_SERVER_ERROR

Definition at line 22 of file fe-auth-oauth.h.

{
    FE_OAUTH_INIT,
    FE_OAUTH_BEARER_SENT,
    FE_OAUTH_REQUESTING_TOKEN,
    FE_OAUTH_SERVER_ERROR,
};

Function Documentation

oauth_unsafe_debugging_enabled()

bool oauth_unsafe_debugging_enabled

(

void

)

Definition at line 1158 of file fe-auth-oauth.c.

{
    const char *env = getenv("PGOAUTHDEBUG");
 
    return (env && strcmp(env, "UNSAFE") == 0);
}

Referenced by issuer_from_well_known_uri(), and pg_fe_run_oauth_flow_impl().

pg_fe_cleanup_oauth_flow()

void pg_fe_cleanup_oauth_flow

(

PGconn *

conn

)

Definition at line 304 of file fe-auth-oauth-curl.c.

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

References pg_conn::altsock, conn, free_async_ctx(), PGINVALID_SOCKET, and pg_conn::sasl_state.

Referenced by setup_token_request().

pg_fe_run_oauth_flow()

PostgresPollingStatusType pg_fe_run_oauth_flow

(

PGconn *

conn

)

Definition at line 2872 of file fe-auth-oauth-curl.c.

{
    PostgresPollingStatusType result;
#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);
 
#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 conn, pg_fe_run_oauth_flow_impl(), pq_block_sigpipe(), and pq_reset_sigpipe().

Referenced by setup_token_request().

pqClearOAuthToken()

void pqClearOAuthToken

(

PGconn *

conn

)

Definition at line 1144 of file fe-auth-oauth.c.

{
    if (!conn->oauth_token)
        return;
 
    explicit_bzero(conn->oauth_token, strlen(conn->oauth_token));
    free(conn->oauth_token);
    conn->oauth_token = NULL;
}

References conn, explicit_bzero(), free, and pg_conn::oauth_token.

Referenced by pqClosePGconn(), and PQconnectPoll().

Variable Documentation

pg_oauth_mech

const pg_fe_sasl_mech pg_oauth_mech

extern

Definition at line 35 of file fe-auth-oauth.c.

Referenced by pg_SASL_init(), pqConnectOptions2(), and PQconnectPoll().