oauth.h File Reference

#include "libpq/libpq-be.h"
#include "libpq/sasl.h"

Include dependency graph for oauth.h:

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

Go to the source code of this file.

Data Structures
struct	ValidatorModuleState
struct	ValidatorModuleResult
struct	OAuthValidatorCallbacks

Macros
#define	PG_OAUTH_VALIDATOR_MAGIC   0x20250220

Typedefs
typedef struct ValidatorModuleState	ValidatorModuleState
typedef struct ValidatorModuleResult	ValidatorModuleResult
typedef void(*	ValidatorStartupCB) (ValidatorModuleState *state)
typedef void(*	ValidatorShutdownCB) (ValidatorModuleState *state)
typedef bool(*	ValidatorValidateCB) (const ValidatorModuleState *state, const char *token, const char *role, ValidatorModuleResult *result)
typedef struct OAuthValidatorCallbacks	OAuthValidatorCallbacks
typedef const OAuthValidatorCallbacks *(*	OAuthValidatorModuleInit) (void)

Functions
PGDLLEXPORT const OAuthValidatorCallbacks *	_PG_oauth_validator_module_init (void)
bool	check_oauth_validator (HbaLine *hba, int elevel, char **err_msg)

Variables
PGDLLIMPORT char *	oauth_validator_libraries_string
const pg_be_sasl_mech	pg_be_oauth_mech

Macro Definition Documentation

PG_OAUTH_VALIDATOR_MAGIC

#define PG_OAUTH_VALIDATOR_MAGIC   0x20250220

Definition at line 74 of file oauth.h.

Typedef Documentation

OAuthValidatorCallbacks

typedef struct OAuthValidatorCallbacks OAuthValidatorCallbacks

OAuthValidatorModuleInit

typedef const OAuthValidatorCallbacks *(* OAuthValidatorModuleInit) (void)

Definition at line 90 of file oauth.h.

ValidatorModuleResult

typedef struct ValidatorModuleResult ValidatorModuleResult

ValidatorModuleState

typedef struct ValidatorModuleState ValidatorModuleState

ValidatorShutdownCB

typedef void(* ValidatorShutdownCB) (ValidatorModuleState *state)

Definition at line 63 of file oauth.h.

ValidatorStartupCB

typedef void(* ValidatorStartupCB) (ValidatorModuleState *state)

Definition at line 62 of file oauth.h.

ValidatorValidateCB

typedef bool(* ValidatorValidateCB) (const ValidatorModuleState *state, const char *token, const char *role, ValidatorModuleResult *result)

Definition at line 64 of file oauth.h.

Function Documentation

_PG_oauth_validator_module_init()

PGDLLEXPORT const OAuthValidatorCallbacks * _PG_oauth_validator_module_init

(

void

)

Definition at line 35 of file fail_validator.c.

{
    return &validator_callbacks;
}

References validator_callbacks.

check_oauth_validator()

bool check_oauth_validator	(	HbaLine *	hba,
		int	elevel,
		char **	err_msg
	)

Definition at line 820 of file auth-oauth.c.

{
    int         line_num = hbaline->linenumber;
    const char *file_name = hbaline->sourcefile;
    char       *rawstring;
    List       *elemlist = NIL;
 
    *err_msg = NULL;
 
    if (oauth_validator_libraries_string[0] == '\0')
    {
        ereport(elevel,
                errcode(ERRCODE_CONFIG_FILE_ERROR),
                errmsg("oauth_validator_libraries must be set for authentication method %s",
                       "oauth"),
                errcontext("line %d of configuration file \"%s\"",
                           line_num, file_name));
        *err_msg = psprintf("oauth_validator_libraries must be set for authentication method %s",
                            "oauth");
        return false;
    }
 
    /* SplitDirectoriesString needs a modifiable copy */
    rawstring = pstrdup(oauth_validator_libraries_string);
 
    if (!SplitDirectoriesString(rawstring, ',', &elemlist))
    {
        /* syntax error in list */
        ereport(elevel,
                errcode(ERRCODE_CONFIG_FILE_ERROR),
                errmsg("invalid list syntax in parameter \"%s\"",
                       "oauth_validator_libraries"));
        *err_msg = psprintf("invalid list syntax in parameter \"%s\"",
                            "oauth_validator_libraries");
        goto done;
    }
 
    if (!hbaline->oauth_validator)
    {
        if (elemlist->length == 1)
        {
            hbaline->oauth_validator = pstrdup(linitial(elemlist));
            goto done;
        }
 
        ereport(elevel,
                errcode(ERRCODE_CONFIG_FILE_ERROR),
                errmsg("authentication method \"oauth\" requires argument \"validator\" to be set when oauth_validator_libraries contains multiple options"),
                errcontext("line %d of configuration file \"%s\"",
                           line_num, file_name));
        *err_msg = "authentication method \"oauth\" requires argument \"validator\" to be set when oauth_validator_libraries contains multiple options";
        goto done;
    }
 
    foreach_ptr(char, allowed, elemlist)
    {
        if (strcmp(allowed, hbaline->oauth_validator) == 0)
            goto done;
    }
 
    ereport(elevel,
            errcode(ERRCODE_INVALID_PARAMETER_VALUE),
            errmsg("validator \"%s\" is not permitted by %s",
                   hbaline->oauth_validator, "oauth_validator_libraries"),
            errcontext("line %d of configuration file \"%s\"",
                       line_num, file_name));
    *err_msg = psprintf("validator \"%s\" is not permitted by %s",
                        hbaline->oauth_validator, "oauth_validator_libraries");
 
done:
    list_free_deep(elemlist);
    pfree(rawstring);
 
    return (*err_msg == NULL);
}

References ereport, errcode(), errcontext, errmsg(), foreach_ptr, List::length, HbaLine::linenumber, linitial, list_free_deep(), NIL, HbaLine::oauth_validator, oauth_validator_libraries_string, pfree(), psprintf(), pstrdup(), HbaLine::sourcefile, and SplitDirectoriesString().

Referenced by parse_hba_line().

Variable Documentation

oauth_validator_libraries_string

PGDLLIMPORT char* oauth_validator_libraries_string

extern

Definition at line 34 of file auth-oauth.c.

Referenced by check_oauth_validator().

pg_be_oauth_mech

const pg_be_sasl_mech pg_be_oauth_mech

extern

Definition at line 48 of file auth-oauth.c.

Referenced by ClientAuthentication().