oauth-utils.h File Reference

#include "fe-auth-oauth.h"
#include "libpq-fe.h"
#include "pqexpbuffer.h"

Include dependency graph for oauth-utils.h:

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

Go to the source code of this file.

Macros
#define	DECLARE_GETTER(TYPE, MEMBER)
#define	DECLARE_SETTER(TYPE, MEMBER)
#define	libpq_gettext(x)   (x)
#define	pglock_thread()   pg_g_threadlock(true)
#define	pgunlock_thread()   pg_g_threadlock(false)

Typedefs
typedef char *(*	libpq_gettext_func) (const char *msgid)

Enumerations
enum	PGTernaryBool { PG_BOOL_UNKNOWN = 0 , PG_BOOL_YES , PG_BOOL_NO }

Functions
	DECLARE_GETTER (PQExpBuffer, errorMessage)
	DECLARE_GETTER (char *, oauth_client_id)
	DECLARE_GETTER (char *, oauth_client_secret)
	DECLARE_GETTER (char *, oauth_discovery_uri)
	DECLARE_GETTER (char *, oauth_issuer_id)
	DECLARE_GETTER (char *, oauth_scope)
	DECLARE_GETTER (fe_oauth_state *, sasl_state)
	DECLARE_SETTER (pgsocket, altsock)
	DECLARE_SETTER (char *, oauth_token)
PGDLLEXPORT void	libpq_oauth_init (pgthreadlock_t threadlock, libpq_gettext_func gettext_impl, conn_errorMessage_func errmsg_impl, conn_oauth_client_id_func clientid_impl, conn_oauth_client_secret_func clientsecret_impl, conn_oauth_discovery_uri_func discoveryuri_impl, conn_oauth_issuer_id_func issuerid_impl, conn_oauth_scope_func scope_impl, conn_sasl_state_func saslstate_impl, set_conn_altsock_func setaltsock_impl, set_conn_oauth_token_func settoken_impl)
void	libpq_append_conn_error (PGconn *conn, const char *fmt,...) pg_attribute_printf(2
void bool	oauth_unsafe_debugging_enabled (void)
int	pq_block_sigpipe (sigset_t *osigset, bool *sigpipe_pending)
void	pq_reset_sigpipe (sigset_t *osigset, bool sigpipe_pending, bool got_epipe)

Variables
pgthreadlock_t	pg_g_threadlock

Macro Definition Documentation

DECLARE_GETTER

#define DECLARE_GETTER	(		TYPE,
			MEMBER
	)

Value:

    typedef TYPE (*conn_ ## MEMBER ## _func) (PGconn *conn); \
    extern conn_ ## MEMBER ## _func conn_ ## MEMBER;

Definition at line 29 of file oauth-utils.h.

{
    PG_BOOL_UNKNOWN = 0,        /* Currently unknown */
    PG_BOOL_YES,                /* Yes (true) */
    PG_BOOL_NO                  /* No (false) */
} PGTernaryBool;
 
extern void libpq_append_conn_error(PGconn *conn, const char *fmt,...) pg_attribute_printf(2, 3);
extern bool oauth_unsafe_debugging_enabled(void);
extern int  pq_block_sigpipe(sigset_t *osigset, bool *sigpipe_pending);
extern void pq_reset_sigpipe(sigset_t *osigset, bool sigpipe_pending, bool got_epipe);
 
#ifdef ENABLE_NLS
extern char *libpq_gettext(const char *msgid) pg_attribute_format_arg(1);
#else
#define libpq_gettext(x) (x)
#endif
 
extern pgthreadlock_t pg_g_threadlock;
 
#define pglock_thread()     pg_g_threadlock(true)
#define pgunlock_thread()   pg_g_threadlock(false)
 
#endif                          /* OAUTH_UTILS_H */

DECLARE_SETTER

#define DECLARE_SETTER	(		TYPE,
			MEMBER
	)

Value:

    typedef void (*set_conn_ ## MEMBER ## _func) (PGconn *conn, TYPE val); \
    extern set_conn_ ## MEMBER ## _func set_conn_ ## MEMBER;

Definition at line 33 of file oauth-utils.h.

libpq_gettext

#define libpq_gettext

(

x

)

(x)

Definition at line 86 of file oauth-utils.h.

pglock_thread

#define pglock_thread

(

)

pg_g_threadlock(true)

Definition at line 91 of file oauth-utils.h.

pgunlock_thread

#define pgunlock_thread

(

)

pg_g_threadlock(false)

Definition at line 92 of file oauth-utils.h.

Typedef Documentation

libpq_gettext_func

typedef char *(* libpq_gettext_func) (const char *msgid)

Definition at line 51 of file oauth-utils.h.

Enumeration Type Documentation

PGTernaryBool

enum PGTernaryBool

Enumerator
PG_BOOL_UNKNOWN
PG_BOOL_YES
PG_BOOL_NO

Definition at line 71 of file oauth-utils.h.

{
    PG_BOOL_UNKNOWN = 0,        /* Currently unknown */
    PG_BOOL_YES,                /* Yes (true) */
    PG_BOOL_NO                  /* No (false) */
} PGTernaryBool;

Function Documentation

DECLARE_GETTER() [1/7]

DECLARE_GETTER	(	char *	,
		oauth_client_id
	)

DECLARE_GETTER() [2/7]

DECLARE_GETTER	(	char *	,
		oauth_client_secret
	)

DECLARE_GETTER() [3/7]

DECLARE_GETTER	(	char *	,
		oauth_discovery_uri
	)

DECLARE_GETTER() [4/7]

DECLARE_GETTER	(	char *	,
		oauth_issuer_id
	)

DECLARE_GETTER() [5/7]

DECLARE_GETTER	(	char *	,
		oauth_scope
	)

DECLARE_GETTER() [6/7]

DECLARE_GETTER	(	fe_oauth_state *	,
		sasl_state
	)

DECLARE_GETTER() [7/7]

DECLARE_GETTER	(	PQExpBuffer	,
		errorMessage
	)

DECLARE_SETTER() [1/2]

DECLARE_SETTER	(	char *	,
		oauth_token
	)

DECLARE_SETTER() [2/2]

DECLARE_SETTER	(	pgsocket	,
		altsock
	)

libpq_append_conn_error()

void libpq_append_conn_error ( PGconn *  conn, const char *  fmt,   ...  )

extern

libpq_oauth_init()

PGDLLEXPORT void libpq_oauth_init ( pgthreadlock_t  threadlock, libpq_gettext_func  gettext_impl, conn_errorMessage_func  errmsg_impl, conn_oauth_client_id_func  clientid_impl, conn_oauth_client_secret_func  clientsecret_impl, conn_oauth_discovery_uri_func  discoveryuri_impl, conn_oauth_issuer_id_func  issuerid_impl, conn_oauth_scope_func  scope_impl, conn_sasl_state_func  saslstate_impl, set_conn_altsock_func  setaltsock_impl, set_conn_oauth_token_func  settoken_impl  )

extern

Definition at line 65 of file oauth-utils.c.

{
    pg_g_threadlock = threadlock_impl;
    libpq_gettext_impl = gettext_impl;
    conn_errorMessage = errmsg_impl;
    conn_oauth_client_id = clientid_impl;
    conn_oauth_client_secret = clientsecret_impl;
    conn_oauth_discovery_uri = discoveryuri_impl;
    conn_oauth_issuer_id = issuerid_impl;
    conn_oauth_scope = scope_impl;
    conn_sasl_state = saslstate_impl;
    set_conn_altsock = setaltsock_impl;
    set_conn_oauth_token = settoken_impl;
}

References conn_errorMessage, conn_oauth_client_id, conn_oauth_client_secret, conn_oauth_discovery_uri, conn_oauth_issuer_id, conn_oauth_scope, conn_sasl_state, fb(), libpq_gettext_impl, pg_g_threadlock, set_conn_altsock, and set_conn_oauth_token.

oauth_unsafe_debugging_enabled()

void bool oauth_unsafe_debugging_enabled ( void  )

extern

Definition at line 149 of file oauth-utils.c.

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

pq_block_sigpipe()

int pq_block_sigpipe ( sigset_t *  osigset, bool *  sigpipe_pending  )

extern

Definition at line 172 of file oauth-utils.c.

{
    sigset_t    sigpipe_sigset;
    sigset_t    sigset;
 
    sigemptyset(&sigpipe_sigset);
    sigaddset(&sigpipe_sigset, SIGPIPE);
 
    /* Block SIGPIPE and save previous mask for later reset */
    SOCK_ERRNO_SET(pthread_sigmask(SIG_BLOCK, &sigpipe_sigset, osigset));
    if (SOCK_ERRNO)
        return -1;
 
    /* We can have a pending SIGPIPE only if it was blocked before */
    if (sigismember(osigset, SIGPIPE))
    {
        /* Is there a pending SIGPIPE? */
        if (sigpending(&sigset) != 0)
            return -1;
 
        if (sigismember(&sigset, SIGPIPE))
            *sigpipe_pending = true;
        else
            *sigpipe_pending = false;
    }
    else
        *sigpipe_pending = false;
 
    return 0;
}

pq_reset_sigpipe()

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

extern

Definition at line 208 of file oauth-utils.c.

{
    int         save_errno = SOCK_ERRNO;
    int         signo;
    sigset_t    sigset;
 
    /* Clear SIGPIPE only if none was pending */
    if (got_epipe && !sigpipe_pending)
    {
        if (sigpending(&sigset) == 0 &&
            sigismember(&sigset, SIGPIPE))
        {
            sigset_t    sigpipe_sigset;
 
            sigemptyset(&sigpipe_sigset);
            sigaddset(&sigpipe_sigset, SIGPIPE);
 
            sigwait(&sigpipe_sigset, &signo);
        }
    }
 
    /* Restore saved block mask */
    pthread_sigmask(SIG_SETMASK, osigset, NULL);
 
    SOCK_ERRNO_SET(save_errno);
}

Variable Documentation

pg_g_threadlock

pgthreadlock_t pg_g_threadlock

extern

Definition at line 35 of file oauth-utils.c.