PostgreSQL Source Code: src/include/libpq/hba.h Source File

PostgreSQL Source Code git master
hba.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * hba.h
4 * Interface to hba.c
5 *
6 *
7 * src/include/libpq/hba.h
8 *
9 *-------------------------------------------------------------------------
10 */
11#ifndef HBA_H
12#define HBA_H
13
14#include "libpq/pqcomm.h" /* needed for NetBSD */
15#include "nodes/pg_list.h"
16#include "regex/regex.h"
17
18
19/*
20 * The following enum represents the authentication methods that
21 * are supported by PostgreSQL.
22 *
23 * Note: keep this in sync with the UserAuthName array in hba.c.
24 */
25 typedef enum UserAuth
26{
27 uaReject,
28 uaImplicitReject, /* Not a user-visible option */
29 uaTrust,
30 uaIdent,
31 uaPassword,
32 uaMD5,
33 uaSCRAM,
34 uaGSS,
35 uaSSPI,
36 uaPAM,
37 uaBSD,
38 uaLDAP,
39 uaCert,
40 uaRADIUS,
41 uaPeer,
42 uaOAuth,
43 #define USER_AUTH_LAST uaOAuth /* Must be last value of this enum */
44 } UserAuth;
45
46/*
47 * Data structures representing pg_hba.conf entries
48 */
49
50 typedef enum IPCompareMethod
51{
52 ipCmpMask,
53 ipCmpSameHost,
54 ipCmpSameNet,
55 ipCmpAll,
56 } IPCompareMethod;
57
58 typedef enum ConnType
59{
60 ctLocal,
61 ctHost,
62 ctHostSSL,
63 ctHostNoSSL,
64 ctHostGSS,
65 ctHostNoGSS,
66 } ConnType;
67
68 typedef enum ClientCertMode
69{
70 clientCertOff,
71 clientCertCA,
72 clientCertFull,
73 } ClientCertMode;
74
75 typedef enum ClientCertName
76{
77 clientCertCN,
78 clientCertDN,
79 } ClientCertName;
80
81/*
82 * A single string token lexed from an authentication configuration file
83 * (pg_ident.conf or pg_hba.conf), together with whether the token has
84 * been quoted. If "string" begins with a slash, it may optionally
85 * contain a regular expression (currently used for pg_ident.conf when
86 * building IdentLines and for pg_hba.conf when building HbaLines).
87 */
88 typedef struct AuthToken
89{
90 char *string;
91 bool quoted;
92 regex_t *regex;
93 } AuthToken;
94
95 typedef struct HbaLine
96{
97 char *sourcefile;
98 int linenumber;
99 char *rawline;
100 ConnType conntype;
101 List *databases;
102 List *roles;
103 struct sockaddr_storage addr;
104 int addrlen; /* zero if we don't have a valid addr */
105 struct sockaddr_storage mask;
106 int masklen; /* zero if we don't have a valid mask */
107 IPCompareMethod ip_cmp_method;
108 char *hostname;
109 UserAuth auth_method;
110 char *usermap;
111 char *pamservice;
112 bool pam_use_hostname;
113 bool ldaptls;
114 char *ldapscheme;
115 char *ldapserver;
116 int ldapport;
117 char *ldapbinddn;
118 char *ldapbindpasswd;
119 char *ldapsearchattribute;
120 char *ldapsearchfilter;
121 char *ldapbasedn;
122 int ldapscope;
123 char *ldapprefix;
124 char *ldapsuffix;
125 ClientCertMode clientcert;
126 ClientCertName clientcertname;
127 char *krb_realm;
128 bool include_realm;
129 bool compat_realm;
130 bool upn_username;
131 List *radiusservers;
132 char *radiusservers_s;
133 List *radiussecrets;
134 char *radiussecrets_s;
135 List *radiusidentifiers;
136 char *radiusidentifiers_s;
137 List *radiusports;
138 char *radiusports_s;
139 char *oauth_issuer;
140 char *oauth_scope;
141 char *oauth_validator;
142 bool oauth_skip_usermap;
143 } HbaLine;
144
145 typedef struct IdentLine
146{
147 int linenumber;
148
149 char *usermap;
150 AuthToken *system_user;
151 AuthToken *pg_user;
152 } IdentLine;
153
154/*
155 * TokenizedAuthLine represents one line lexed from an authentication
156 * configuration file. Each item in the "fields" list is a sub-list of
157 * AuthTokens. We don't emit a TokenizedAuthLine for empty or all-comment
158 * lines, so "fields" is never NIL (nor are any of its sub-lists).
159 *
160 * Exception: if an error occurs during tokenization, we might have
161 * fields == NIL, in which case err_msg != NULL.
162 */
163 typedef struct TokenizedAuthLine
164{
165 List *fields; /* List of lists of AuthTokens */
166 char *file_name; /* File name of origin */
167 int line_num; /* Line number */
168 char *raw_line; /* Raw line text */
169 char *err_msg; /* Error message if any */
170 } TokenizedAuthLine;
171
172/* avoid including libpq/libpq-be.h here */
173 typedef struct Port Port;
174
175extern bool load_hba(void);
176extern bool load_ident(void);
177extern const char *hba_authname(UserAuth auth_method);
178extern void hba_getauthmethod(Port *port);
179extern int check_usermap(const char *usermap_name,
180 const char *pg_user, const char *system_user,
181 bool case_insensitive);
182extern HbaLine *parse_hba_line(TokenizedAuthLine *tok_line, int elevel);
183extern IdentLine *parse_ident_line(TokenizedAuthLine *tok_line, int elevel);
184extern bool pg_isblank(const char c);
185extern FILE *open_auth_file(const char *filename, int elevel, int depth,
186 char **err_msg);
187extern void free_auth_file(FILE *file, int depth);
188extern void tokenize_auth_file(const char *filename, FILE *file,
189 List **tok_lines, int elevel, int depth);
190
191#endif /* HBA_H */
bool pg_isblank(const char c)
Definition: hba.c:146
IPCompareMethod
Definition: hba.h:51
@ ipCmpAll
Definition: hba.h:55
@ ipCmpSameNet
Definition: hba.h:54
@ ipCmpMask
Definition: hba.h:52
@ ipCmpSameHost
Definition: hba.h:53
HbaLine * parse_hba_line(TokenizedAuthLine *tok_line, int elevel)
Definition: hba.c:1328
ConnType
Definition: hba.h:59
@ ctHostNoGSS
Definition: hba.h:65
@ ctHostSSL
Definition: hba.h:62
@ ctHostNoSSL
Definition: hba.h:63
@ ctHost
Definition: hba.h:61
@ ctHostGSS
Definition: hba.h:64
@ ctLocal
Definition: hba.h:60
struct IdentLine IdentLine
bool load_ident(void)
Definition: hba.c:3039
struct HbaLine HbaLine
UserAuth
Definition: hba.h:26
@ uaBSD
Definition: hba.h:37
@ uaLDAP
Definition: hba.h:38
@ uaPeer
Definition: hba.h:41
@ uaPAM
Definition: hba.h:36
@ uaPassword
Definition: hba.h:31
@ uaCert
Definition: hba.h:39
@ uaMD5
Definition: hba.h:32
@ uaReject
Definition: hba.h:27
@ uaGSS
Definition: hba.h:34
@ uaSCRAM
Definition: hba.h:33
@ uaImplicitReject
Definition: hba.h:28
@ uaRADIUS
Definition: hba.h:40
@ uaIdent
Definition: hba.h:30
@ uaOAuth
Definition: hba.h:42
@ uaTrust
Definition: hba.h:29
@ uaSSPI
Definition: hba.h:35
bool load_hba(void)
Definition: hba.c:2645
IdentLine * parse_ident_line(TokenizedAuthLine *tok_line, int elevel)
Definition: hba.c:2751
int check_usermap(const char *usermap_name, const char *pg_user, const char *system_user, bool case_insensitive)
Definition: hba.c:2984
void free_auth_file(FILE *file, int depth)
Definition: hba.c:572
struct TokenizedAuthLine TokenizedAuthLine
struct AuthToken AuthToken
ClientCertName
Definition: hba.h:76
@ clientCertDN
Definition: hba.h:78
@ clientCertCN
Definition: hba.h:77
void hba_getauthmethod(Port *port)
Definition: hba.c:3128
ClientCertMode
Definition: hba.h:69
@ clientCertOff
Definition: hba.h:70
@ clientCertFull
Definition: hba.h:72
@ clientCertCA
Definition: hba.h:71
void tokenize_auth_file(const char *filename, FILE *file, List **tok_lines, int elevel, int depth)
Definition: hba.c:691
const char * hba_authname(UserAuth auth_method)
Definition: hba.c:3141
FILE * open_auth_file(const char *filename, int elevel, int depth, char **err_msg)
Definition: hba.c:597
Datum system_user(PG_FUNCTION_ARGS)
Definition: miscinit.c:898
static char * filename
Definition: pg_dumpall.c:120
static int port
Definition: pg_regress.c:115
c
char * c
Definition: preproc-cursor.c:31
#define regex_t
Definition: regex.h:245
Definition: hba.h:89
regex_t * regex
Definition: hba.h:92
char * string
Definition: hba.h:90
bool quoted
Definition: hba.h:91
Definition: hba.h:96
UserAuth auth_method
Definition: hba.h:109
bool upn_username
Definition: hba.h:130
struct sockaddr_storage mask
Definition: hba.h:105
char * sourcefile
Definition: hba.h:97
ClientCertName clientcertname
Definition: hba.h:126
int addrlen
Definition: hba.h:104
List * radiusservers
Definition: hba.h:131
bool oauth_skip_usermap
Definition: hba.h:142
char * ldapserver
Definition: hba.h:115
bool include_realm
Definition: hba.h:128
int masklen
Definition: hba.h:106
ClientCertMode clientcert
Definition: hba.h:125
char * ldapsearchfilter
Definition: hba.h:120
char * ldapscheme
Definition: hba.h:114
char * rawline
Definition: hba.h:99
char * oauth_issuer
Definition: hba.h:139
char * ldapprefix
Definition: hba.h:123
List * radiussecrets
Definition: hba.h:133
char * ldapsearchattribute
Definition: hba.h:119
char * krb_realm
Definition: hba.h:127
char * ldapbasedn
Definition: hba.h:121
bool pam_use_hostname
Definition: hba.h:112
int linenumber
Definition: hba.h:98
char * radiussecrets_s
Definition: hba.h:134
char * oauth_scope
Definition: hba.h:140
List * radiusports
Definition: hba.h:137
List * radiusidentifiers
Definition: hba.h:135
char * oauth_validator
Definition: hba.h:141
char * hostname
Definition: hba.h:108
char * pamservice
Definition: hba.h:111
List * databases
Definition: hba.h:101
ConnType conntype
Definition: hba.h:100
char * usermap
Definition: hba.h:110
char * ldapsuffix
Definition: hba.h:124
int ldapport
Definition: hba.h:116
struct sockaddr_storage addr
Definition: hba.h:103
char * ldapbindpasswd
Definition: hba.h:118
List * roles
Definition: hba.h:102
char * radiusports_s
Definition: hba.h:138
char * ldapbinddn
Definition: hba.h:117
bool compat_realm
Definition: hba.h:129
int ldapscope
Definition: hba.h:122
IPCompareMethod ip_cmp_method
Definition: hba.h:107
bool ldaptls
Definition: hba.h:113
char * radiusservers_s
Definition: hba.h:132
char * radiusidentifiers_s
Definition: hba.h:136
Definition: hba.h:146
AuthToken * pg_user
Definition: hba.h:151
AuthToken * system_user
Definition: hba.h:150
char * usermap
Definition: hba.h:149
int linenumber
Definition: hba.h:147
Definition: pg_list.h:54
Definition: libpq-be.h:129
char * raw_line
Definition: hba.h:168
int line_num
Definition: hba.h:167
char * file_name
Definition: hba.h:166
char * err_msg
Definition: hba.h:169
List * fields
Definition: hba.h:165

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