PostgreSQL Source Code git master
Macros | Typedefs | Enumerations | Functions | Variables
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 , 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;
PGconn * conn
Definition: streamutil.c:52
Definition: libpq-int.h:372

Definition at line 29 of file 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;
long val
Definition: informix.c:689

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 
PG_BOOL_UNKNOWN 
PG_BOOL_YES 
PG_BOOL_NO 

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

72{
73 PG_BOOL_UNKNOWN = 0, /* Currently unknown */
74 PG_BOOL_YES, /* Yes (true) */
75 PG_BOOL_NO /* No (false) */
PGTernaryBool
Definition: oauth-utils.h:72
@ PG_BOOL_YES
Definition: oauth-utils.h:74
@ PG_BOOL_NO
Definition: oauth-utils.h:75
@ PG_BOOL_UNKNOWN
Definition: oauth-utils.h:73

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,
  ... 
)

◆ 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 
)

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

76{
77 pg_g_threadlock = threadlock_impl;
78 libpq_gettext_impl = gettext_impl;
79 conn_errorMessage = errmsg_impl;
80 conn_oauth_client_id = clientid_impl;
81 conn_oauth_client_secret = clientsecret_impl;
82 conn_oauth_discovery_uri = discoveryuri_impl;
83 conn_oauth_issuer_id = issuerid_impl;
84 conn_oauth_scope = scope_impl;
85 conn_sasl_state = saslstate_impl;
86 set_conn_altsock = setaltsock_impl;
87 set_conn_oauth_token = settoken_impl;
88}
set_conn_oauth_token_func set_conn_oauth_token
Definition: oauth-utils.c:47
conn_oauth_client_secret_func conn_oauth_client_secret
Definition: oauth-utils.c:40
conn_sasl_state_func conn_sasl_state
Definition: oauth-utils.c:44
conn_oauth_client_id_func conn_oauth_client_id
Definition: oauth-utils.c:39
conn_oauth_scope_func conn_oauth_scope
Definition: oauth-utils.c:43
static libpq_gettext_func libpq_gettext_impl
Definition: oauth-utils.c:36
pgthreadlock_t pg_g_threadlock
Definition: oauth-utils.c:35
conn_oauth_issuer_id_func conn_oauth_issuer_id
Definition: oauth-utils.c:42
set_conn_altsock_func set_conn_altsock
Definition: oauth-utils.c:46
conn_oauth_discovery_uri_func conn_oauth_discovery_uri
Definition: oauth-utils.c:41
conn_errorMessage_func conn_errorMessage
Definition: oauth-utils.c:38

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, 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  )

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

150{
151 const char *env = getenv("PGOAUTHDEBUG");
152
153 return (env && strcmp(env, "UNSAFE") == 0);
154}

◆ pq_block_sigpipe()

int pq_block_sigpipe ( sigset_t *  osigset,
bool *  sigpipe_pending 
)

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

173{
174 sigset_t sigpipe_sigset;
175 sigset_t sigset;
176
177 sigemptyset(&sigpipe_sigset);
178 sigaddset(&sigpipe_sigset, SIGPIPE);
179
180 /* Block SIGPIPE and save previous mask for later reset */
181 SOCK_ERRNO_SET(pthread_sigmask(SIG_BLOCK, &sigpipe_sigset, osigset));
182 if (SOCK_ERRNO)
183 return -1;
184
185 /* We can have a pending SIGPIPE only if it was blocked before */
186 if (sigismember(osigset, SIGPIPE))
187 {
188 /* Is there a pending SIGPIPE? */
189 if (sigpending(&sigset) != 0)
190 return -1;
191
192 if (sigismember(&sigset, SIGPIPE))
193 *sigpipe_pending = true;
194 else
195 *sigpipe_pending = false;
196 }
197 else
198 *sigpipe_pending = false;
199
200 return 0;
201}
#define SOCK_ERRNO
Definition: oauth-utils.c:164
#define SOCK_ERRNO_SET(e)
Definition: oauth-utils.c:165
#define SIGPIPE
Definition: win32_port.h:163

◆ pq_reset_sigpipe()

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

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

209{
210 int save_errno = SOCK_ERRNO;
211 int signo;
212 sigset_t sigset;
213
214 /* Clear SIGPIPE only if none was pending */
215 if (got_epipe && !sigpipe_pending)
216 {
217 if (sigpending(&sigset) == 0 &&
218 sigismember(&sigset, SIGPIPE))
219 {
220 sigset_t sigpipe_sigset;
221
222 sigemptyset(&sigpipe_sigset);
223 sigaddset(&sigpipe_sigset, SIGPIPE);
224
225 sigwait(&sigpipe_sigset, &signo);
226 }
227 }
228
229 /* Restore saved block mask */
230 pthread_sigmask(SIG_SETMASK, osigset, NULL);
231
232 SOCK_ERRNO_SET(save_errno);
233}

Variable Documentation

◆ pg_g_threadlock

pgthreadlock_t pg_g_threadlock
extern

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

AltStyle によって変換されたページ (->オリジナル) /