validator.c File Reference

#include "postgres.h"
#include "fmgr.h"
#include "libpq/oauth.h"
#include "miscadmin.h"
#include "utils/guc.h"
#include "utils/memutils.h"

Include dependency graph for validator.c:

Go to the source code of this file.

Macros
#define	PRIVATE_COOKIE   ((void *) 13579)

Functions
static void	validator_startup (ValidatorModuleState *state)
static void	validator_shutdown (ValidatorModuleState *state)
static bool	validate_token (const ValidatorModuleState *state, const char *token, const char *role, ValidatorModuleResult *res)
void	_PG_init (void)
const OAuthValidatorCallbacks *	_PG_oauth_validator_module_init (void)

Variables
	PG_MODULE_MAGIC
static const OAuthValidatorCallbacks	validator_callbacks
static char *	authn_id = NULL
static bool	authorize_tokens = true

Macro Definition Documentation

PRIVATE_COOKIE

#define PRIVATE_COOKIE   ((void *) 13579)

Definition at line 87 of file validator.c.

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 56 of file validator.c.

{
    DefineCustomStringVariable("oauth_validator.authn_id",
                               "Authenticated identity to use for future connections",
                               NULL,
                               &authn_id,
                               NULL,
                               PGC_SIGHUP,
                               0,
                               NULL, NULL, NULL);
    DefineCustomBoolVariable("oauth_validator.authorize_tokens",
                             "Should tokens be marked valid?",
                             NULL,
                             &authorize_tokens,
                             true,
                             PGC_SIGHUP,
                             0,
                             NULL, NULL, NULL);
 
    MarkGUCPrefixReserved("oauth_validator");
}

References authn_id, authorize_tokens, DefineCustomBoolVariable(), DefineCustomStringVariable(), fb(), MarkGUCPrefixReserved(), and PGC_SIGHUP.

_PG_oauth_validator_module_init()

const OAuthValidatorCallbacks * _PG_oauth_validator_module_init

(

void

)

Definition at line 82 of file validator.c.

{
    return &validator_callbacks;
}

References validator_callbacks, and validator_callbacks.

validate_token()

static bool validate_token ( const ValidatorModuleState *  state, const char *  token, const char *  role, ValidatorModuleResult *  res  )

static

Definition at line 122 of file validator.c.

{
    /* Check to make sure our private state still exists. */
    if (state->private_data != PRIVATE_COOKIE)
        elog(ERROR, "oauth_validator: private state cookie changed to %p in validate",
             state->private_data);
 
    elog(LOG, "oauth_validator: token=\"%s\", role=\"%s\"", token, role);
    elog(LOG, "oauth_validator: issuer=\"%s\", scope=\"%s\"",
         MyProcPort->hba->oauth_issuer,
         MyProcPort->hba->oauth_scope);
 
    res->authorized = authorize_tokens;
    if (authn_id)
        res->authn_id = pstrdup(authn_id);
    else
        res->authn_id = pstrdup(role);
 
    return true;
}

References ValidatorModuleResult::authn_id, authn_id, authorize_tokens, ValidatorModuleResult::authorized, elog, ERROR, Port::hba, LOG, MyProcPort, HbaLine::oauth_issuer, HbaLine::oauth_scope, PRIVATE_COOKIE, and pstrdup().

validator_shutdown()

static void validator_shutdown ( ValidatorModuleState *  state )

static

Definition at line 109 of file validator.c.

{
    /* Check to make sure our private state still exists. */
    if (state->private_data != PRIVATE_COOKIE)
        elog(PANIC, "oauth_validator: private state cookie changed to %p in shutdown",
             state->private_data);
}

References elog, PANIC, and PRIVATE_COOKIE.

validator_startup()

static void validator_startup ( ValidatorModuleState *  state )

static

Definition at line 93 of file validator.c.

{
    /*
     * Make sure the server is correctly setting sversion. (Real modules
     * should not do this; it would defeat upgrade compatibility.)
     */
    if (state->sversion != PG_VERSION_NUM)
        elog(ERROR, "oauth_validator: sversion set to %d", state->sversion);
 
    state->private_data = PRIVATE_COOKIE;
}

References elog, ERROR, fb(), and PRIVATE_COOKIE.

Variable Documentation

authn_id

char* authn_id = NULL

static

Definition at line 41 of file validator.c.

Referenced by _PG_init(), InitializeSystemUser(), RestoreClientConnectionInfo(), and validate_token().

authorize_tokens

bool authorize_tokens = true

static

Definition at line 42 of file validator.c.

Referenced by _PG_init(), and validate_token().

PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 22 of file validator.c.

validator_callbacks

const OAuthValidatorCallbacks validator_callbacks

static

Initial value:

= {
    PG_OAUTH_VALIDATOR_MAGIC,
 
    .startup_cb = validator_startup,
    .shutdown_cb = validator_shutdown,
    .validate_cb = validate_token
}

Definition at line 32 of file validator.c.

                                                           {
    PG_OAUTH_VALIDATOR_MAGIC,
 
    .startup_cb = validator_startup,
    .shutdown_cb = validator_shutdown,
    .validate_cb = validate_token
};

Referenced by _PG_oauth_validator_module_init().