PostgreSQL Source Code git master
Functions
createuser.c File Reference
#include "postgres_fe.h"
#include <limits.h>
#include "common.h"
#include "common/logging.h"
#include "common/string.h"
#include "fe_utils/option_utils.h"
#include "fe_utils/simple_list.h"
#include "fe_utils/string_utils.h"
Include dependency graph for createuser.c:

Go to the source code of this file.

Functions

static void help (const char *progname)
 
int main (int argc, char *argv[])
 

Function Documentation

◆ help()

static void help ( const char *  progname)
static

Definition at line 414 of file createuser.c.

415{
416 printf(_("%s creates a new PostgreSQL role.\n\n"), progname);
417 printf(_("Usage:\n"));
418 printf(_(" %s [OPTION]... [ROLENAME]\n"), progname);
419 printf(_("\nOptions:\n"));
420 printf(_(" -a, --with-admin=ROLE ROLE will be a member of new role with admin\n"
421 " option\n"));
422 printf(_(" -c, --connection-limit=N connection limit for role (default: no limit)\n"));
423 printf(_(" -d, --createdb role can create new databases\n"));
424 printf(_(" -D, --no-createdb role cannot create databases (default)\n"));
425 printf(_(" -e, --echo show the commands being sent to the server\n"));
426 printf(_(" -g, --member-of=ROLE new role will be a member of ROLE\n"));
427 printf(_(" --role=ROLE (same as --member-of, deprecated)\n"));
428 printf(_(" -i, --inherit role inherits privileges of roles it is a\n"
429 " member of (default)\n"));
430 printf(_(" -I, --no-inherit role does not inherit privileges\n"));
431 printf(_(" -l, --login role can login (default)\n"));
432 printf(_(" -L, --no-login role cannot login\n"));
433 printf(_(" -m, --with-member=ROLE ROLE will be a member of new role\n"));
434 printf(_(" -P, --pwprompt assign a password to new role\n"));
435 printf(_(" -r, --createrole role can create new roles\n"));
436 printf(_(" -R, --no-createrole role cannot create roles (default)\n"));
437 printf(_(" -s, --superuser role will be superuser\n"));
438 printf(_(" -S, --no-superuser role will not be superuser (default)\n"));
439 printf(_(" -v, --valid-until=TIMESTAMP\n"
440 " password expiration date and time for role\n"));
441 printf(_(" -V, --version output version information, then exit\n"));
442 printf(_(" --interactive prompt for missing role name and attributes rather\n"
443 " than using defaults\n"));
444 printf(_(" --bypassrls role can bypass row-level security (RLS) policy\n"));
445 printf(_(" --no-bypassrls role cannot bypass row-level security (RLS) policy\n"
446 " (default)\n"));
447 printf(_(" --replication role can initiate replication\n"));
448 printf(_(" --no-replication role cannot initiate replication (default)\n"));
449 printf(_(" -?, --help show this help, then exit\n"));
450 printf(_("\nConnection options:\n"));
451 printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
452 printf(_(" -p, --port=PORT database server port\n"));
453 printf(_(" -U, --username=USERNAME user name to connect as (not the one to create)\n"));
454 printf(_(" -w, --no-password never prompt for password\n"));
455 printf(_(" -W, --password force password prompt\n"));
456 printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
457 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
458}
_
#define _(x)
Definition: elog.c:91
progname
const char * progname
Definition: main.c:44
printf
#define printf(...)
Definition: port.h:245

References _, printf, and progname.

Referenced by main().

◆ main()

int main ( int  argc,
char *  argv[] 
)

Definition at line 28 of file createuser.c.

29{
30 static struct option long_options[] = {
31 {"with-admin", required_argument, NULL, 'a'},
32 {"connection-limit", required_argument, NULL, 'c'},
33 {"createdb", no_argument, NULL, 'd'},
34 {"no-createdb", no_argument, NULL, 'D'},
35 {"echo", no_argument, NULL, 'e'},
36 {"encrypted", no_argument, NULL, 'E'},
37 {"role", required_argument, NULL, 'g'},
38 {"member-of", required_argument, NULL, 'g'},
39 {"host", required_argument, NULL, 'h'},
40 {"inherit", no_argument, NULL, 'i'},
41 {"no-inherit", no_argument, NULL, 'I'},
42 {"login", no_argument, NULL, 'l'},
43 {"no-login", no_argument, NULL, 'L'},
44 {"with-member", required_argument, NULL, 'm'},
45 {"port", required_argument, NULL, 'p'},
46 {"pwprompt", no_argument, NULL, 'P'},
47 {"createrole", no_argument, NULL, 'r'},
48 {"no-createrole", no_argument, NULL, 'R'},
49 {"superuser", no_argument, NULL, 's'},
50 {"no-superuser", no_argument, NULL, 'S'},
51 {"username", required_argument, NULL, 'U'},
52 {"valid-until", required_argument, NULL, 'v'},
53 {"no-password", no_argument, NULL, 'w'},
54 {"password", no_argument, NULL, 'W'},
55 {"replication", no_argument, NULL, 1},
56 {"no-replication", no_argument, NULL, 2},
57 {"interactive", no_argument, NULL, 3},
58 {"bypassrls", no_argument, NULL, 4},
59 {"no-bypassrls", no_argument, NULL, 5},
60 {NULL, 0, NULL, 0}
61 };
62
63 const char *progname;
64 int optindex;
65 int c;
66 const char *newuser = NULL;
67 char *host = NULL;
68 char *port = NULL;
69 char *username = NULL;
70 SimpleStringList roles = {NULL, NULL};
71 SimpleStringList members = {NULL, NULL};
72 SimpleStringList admins = {NULL, NULL};
73 enum trivalue prompt_password = TRI_DEFAULT;
74 ConnParams cparams;
75 bool echo = false;
76 bool interactive = false;
77 int conn_limit = -2; /* less than minimum valid value */
78 bool pwprompt = false;
79 char *newpassword = NULL;
80 char *pwexpiry = NULL;
81
82 /* Tri-valued variables. */
83 enum trivalue createdb = TRI_DEFAULT,
84 superuser = TRI_DEFAULT,
85 createrole = TRI_DEFAULT,
86 inherit = TRI_DEFAULT,
87 login = TRI_DEFAULT,
88 replication = TRI_DEFAULT,
89 bypassrls = TRI_DEFAULT;
90
91 PQExpBufferData sql;
92
93 PGconn *conn;
94 PGresult *result;
95
96 pg_logging_init(argv[0]);
97 progname = get_progname(argv[0]);
98 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
99
100 handle_help_version_opts(argc, argv, "createuser", help);
101
102 while ((c = getopt_long(argc, argv, "a:c:dDeEg:h:iIlLm:p:PrRsSU:v:wW",
103 long_options, &optindex)) != -1)
104 {
105 switch (c)
106 {
107 case 'a':
108 simple_string_list_append(&admins, optarg);
109 break;
110 case 'c':
111 if (!option_parse_int(optarg, "-c/--connection-limit",
112 -1, INT_MAX, &conn_limit))
113 exit(1);
114 break;
115 case 'd':
116 createdb = TRI_YES;
117 break;
118 case 'D':
119 createdb = TRI_NO;
120 break;
121 case 'e':
122 echo = true;
123 break;
124 case 'E':
125 /* no-op, accepted for backward compatibility */
126 break;
127 case 'g':
128 simple_string_list_append(&roles, optarg);
129 break;
130 case 'h':
131 host = pg_strdup(optarg);
132 break;
133 case 'i':
134 inherit = TRI_YES;
135 break;
136 case 'I':
137 inherit = TRI_NO;
138 break;
139 case 'l':
140 login = TRI_YES;
141 break;
142 case 'L':
143 login = TRI_NO;
144 break;
145 case 'm':
146 simple_string_list_append(&members, optarg);
147 break;
148 case 'p':
149 port = pg_strdup(optarg);
150 break;
151 case 'P':
152 pwprompt = true;
153 break;
154 case 'r':
155 createrole = TRI_YES;
156 break;
157 case 'R':
158 createrole = TRI_NO;
159 break;
160 case 's':
161 superuser = TRI_YES;
162 break;
163 case 'S':
164 superuser = TRI_NO;
165 break;
166 case 'U':
167 username = pg_strdup(optarg);
168 break;
169 case 'v':
170 pwexpiry = pg_strdup(optarg);
171 break;
172 case 'w':
173 prompt_password = TRI_NO;
174 break;
175 case 'W':
176 prompt_password = TRI_YES;
177 break;
178 case 1:
179 replication = TRI_YES;
180 break;
181 case 2:
182 replication = TRI_NO;
183 break;
184 case 3:
185 interactive = true;
186 break;
187 case 4:
188 bypassrls = TRI_YES;
189 break;
190 case 5:
191 bypassrls = TRI_NO;
192 break;
193 default:
194 /* getopt_long already emitted a complaint */
195 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
196 exit(1);
197 }
198 }
199
200 switch (argc - optind)
201 {
202 case 0:
203 break;
204 case 1:
205 newuser = argv[optind];
206 break;
207 default:
208 pg_log_error("too many command-line arguments (first is \"%s\")",
209 argv[optind + 1]);
210 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
211 exit(1);
212 }
213
214 if (newuser == NULL)
215 {
216 if (interactive)
217 {
218 newuser = simple_prompt("Enter name of role to add: ", true);
219 }
220 else
221 {
222 if (getenv("PGUSER"))
223 newuser = getenv("PGUSER");
224 else
225 newuser = get_user_name_or_exit(progname);
226 }
227 }
228
229 if (pwprompt)
230 {
231 char *pw2;
232
233 newpassword = simple_prompt("Enter password for new role: ", false);
234 pw2 = simple_prompt("Enter it again: ", false);
235 if (strcmp(newpassword, pw2) != 0)
236 {
237 fprintf(stderr, _("Passwords didn't match.\n"));
238 exit(1);
239 }
240 free(pw2);
241 }
242
243 if (superuser == TRI_DEFAULT)
244 {
245 if (interactive && yesno_prompt("Shall the new role be a superuser?"))
246 superuser = TRI_YES;
247 else
248 superuser = TRI_NO;
249 }
250
251 if (superuser == TRI_YES)
252 {
253 /* Not much point in trying to restrict a superuser */
254 createdb = TRI_YES;
255 createrole = TRI_YES;
256 }
257
258 if (createdb == TRI_DEFAULT)
259 {
260 if (interactive && yesno_prompt("Shall the new role be allowed to create databases?"))
261 createdb = TRI_YES;
262 else
263 createdb = TRI_NO;
264 }
265
266 if (createrole == TRI_DEFAULT)
267 {
268 if (interactive && yesno_prompt("Shall the new role be allowed to create more new roles?"))
269 createrole = TRI_YES;
270 else
271 createrole = TRI_NO;
272 }
273
274 if (bypassrls == TRI_DEFAULT)
275 bypassrls = TRI_NO;
276
277 if (replication == TRI_DEFAULT)
278 replication = TRI_NO;
279
280 if (inherit == TRI_DEFAULT)
281 inherit = TRI_YES;
282
283 if (login == TRI_DEFAULT)
284 login = TRI_YES;
285
286 cparams.dbname = NULL; /* this program lacks any dbname option... */
287 cparams.pghost = host;
288 cparams.pgport = port;
289 cparams.pguser = username;
290 cparams.prompt_password = prompt_password;
291 cparams.override_dbname = NULL;
292
293 conn = connectMaintenanceDatabase(&cparams, progname, echo);
294
295 setFmtEncoding(PQclientEncoding(conn));
296
297 initPQExpBuffer(&sql);
298
299 printfPQExpBuffer(&sql, "CREATE ROLE %s", fmtId(newuser));
300 if (newpassword)
301 {
302 char *encrypted_password;
303
304 appendPQExpBufferStr(&sql, " PASSWORD ");
305
306 encrypted_password = PQencryptPasswordConn(conn,
307 newpassword,
308 newuser,
309 NULL);
310 if (!encrypted_password)
311 pg_fatal("password encryption failed: %s",
312 PQerrorMessage(conn));
313 appendStringLiteralConn(&sql, encrypted_password, conn);
314 PQfreemem(encrypted_password);
315 }
316 if (superuser == TRI_YES)
317 appendPQExpBufferStr(&sql, " SUPERUSER");
318 if (superuser == TRI_NO)
319 appendPQExpBufferStr(&sql, " NOSUPERUSER");
320 if (createdb == TRI_YES)
321 appendPQExpBufferStr(&sql, " CREATEDB");
322 if (createdb == TRI_NO)
323 appendPQExpBufferStr(&sql, " NOCREATEDB");
324 if (createrole == TRI_YES)
325 appendPQExpBufferStr(&sql, " CREATEROLE");
326 if (createrole == TRI_NO)
327 appendPQExpBufferStr(&sql, " NOCREATEROLE");
328 if (inherit == TRI_YES)
329 appendPQExpBufferStr(&sql, " INHERIT");
330 if (inherit == TRI_NO)
331 appendPQExpBufferStr(&sql, " NOINHERIT");
332 if (login == TRI_YES)
333 appendPQExpBufferStr(&sql, " LOGIN");
334 if (login == TRI_NO)
335 appendPQExpBufferStr(&sql, " NOLOGIN");
336 if (replication == TRI_YES)
337 appendPQExpBufferStr(&sql, " REPLICATION");
338 if (replication == TRI_NO)
339 appendPQExpBufferStr(&sql, " NOREPLICATION");
340 if (bypassrls == TRI_YES)
341 appendPQExpBufferStr(&sql, " BYPASSRLS");
342 if (bypassrls == TRI_NO)
343 appendPQExpBufferStr(&sql, " NOBYPASSRLS");
344 if (conn_limit >= -1)
345 appendPQExpBuffer(&sql, " CONNECTION LIMIT %d", conn_limit);
346 if (pwexpiry != NULL)
347 {
348 appendPQExpBufferStr(&sql, " VALID UNTIL ");
349 appendStringLiteralConn(&sql, pwexpiry, conn);
350 }
351 if (roles.head != NULL)
352 {
353 SimpleStringListCell *cell;
354
355 appendPQExpBufferStr(&sql, " IN ROLE ");
356
357 for (cell = roles.head; cell; cell = cell->next)
358 {
359 if (cell->next)
360 appendPQExpBuffer(&sql, "%s,", fmtId(cell->val));
361 else
362 appendPQExpBufferStr(&sql, fmtId(cell->val));
363 }
364 }
365 if (members.head != NULL)
366 {
367 SimpleStringListCell *cell;
368
369 appendPQExpBufferStr(&sql, " ROLE ");
370
371 for (cell = members.head; cell; cell = cell->next)
372 {
373 if (cell->next)
374 appendPQExpBuffer(&sql, "%s,", fmtId(cell->val));
375 else
376 appendPQExpBufferStr(&sql, fmtId(cell->val));
377 }
378 }
379 if (admins.head != NULL)
380 {
381 SimpleStringListCell *cell;
382
383 appendPQExpBufferStr(&sql, " ADMIN ");
384
385 for (cell = admins.head; cell; cell = cell->next)
386 {
387 if (cell->next)
388 appendPQExpBuffer(&sql, "%s,", fmtId(cell->val));
389 else
390 appendPQExpBufferStr(&sql, fmtId(cell->val));
391 }
392 }
393
394 appendPQExpBufferChar(&sql, ';');
395
396 if (echo)
397 printf("%s\n", sql.data);
398 result = PQexec(conn, sql.data);
399
400 if (PQresultStatus(result) != PGRES_COMMAND_OK)
401 {
402 pg_log_error("creation of new role failed: %s", PQerrorMessage(conn));
403 PQfinish(conn);
404 exit(1);
405 }
406
407 PQclear(result);
408 PQfinish(conn);
409 exit(0);
410}
yesno_prompt
bool yesno_prompt(const char *question)
Definition: common.c:136
PG_TEXTDOMAIN
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1185
set_pglocale_pgservice
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:429
connectMaintenanceDatabase
PGconn * connectMaintenanceDatabase(ConnParams *cparams, const char *progname, bool echo)
Definition: connect_utils.c:134
help
static void help(const char *progname)
Definition: createuser.c:414
fprintf
#define fprintf(file, fmt, msg)
Definition: cubescan.l:21
createdb
Oid createdb(ParseState *pstate, const CreatedbStmt *stmt)
Definition: dbcommands.c:684
PQencryptPasswordConn
char * PQencryptPasswordConn(PGconn *conn, const char *passwd, const char *user, const char *algorithm)
Definition: fe-auth.c:1406
PQclientEncoding
int PQclientEncoding(const PGconn *conn)
Definition: fe-connect.c:7709
PQfinish
void PQfinish(PGconn *conn)
Definition: fe-connect.c:5290
PQerrorMessage
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7619
PQfreemem
void PQfreemem(void *ptr)
Definition: fe-exec.c:4032
PQresultStatus
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3411
PQclear
void PQclear(PGresult *res)
Definition: fe-exec.c:721
PQexec
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2262
pg_strdup
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
getopt_long
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
no_argument
#define no_argument
Definition: getopt_long.h:25
required_argument
#define required_argument
Definition: getopt_long.h:26
free
#define free(a)
Definition: header.h:65
username
static char * username
Definition: initdb.c:153
pwprompt
static bool pwprompt
Definition: initdb.c:154
PGRES_COMMAND_OK
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:125
pg_logging_init
void pg_logging_init(const char *argv0)
Definition: logging.c:83
pg_log_error
#define pg_log_error(...)
Definition: logging.h:106
pg_log_error_hint
#define pg_log_error_hint(...)
Definition: logging.h:112
option_parse_int
bool option_parse_int(const char *optarg, const char *optname, int min_range, int max_range, int *result)
Definition: option_utils.c:50
handle_help_version_opts
void handle_help_version_opts(int argc, char *argv[], const char *fixed_progname, help_handler hlp)
Definition: option_utils.c:24
pg_fatal
#define pg_fatal(...)
Definition: pg_backup_utils.h:36
optind
PGDLLIMPORT int optind
Definition: getopt.c:51
optarg
PGDLLIMPORT char * optarg
Definition: getopt.c:53
port
static int port
Definition: pg_regress.c:115
get_progname
const char * get_progname(const char *argv0)
Definition: path.c:652
printfPQExpBuffer
void printfPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:235
initPQExpBuffer
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
appendPQExpBuffer
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
appendPQExpBufferChar
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
appendPQExpBufferStr
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367
c
char * c
Definition: preproc-cursor.c:31
simple_string_list_append
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition: simple_list.c:63
simple_prompt
char * simple_prompt(const char *prompt, bool echo)
Definition: sprompt.c:38
conn
PGconn * conn
Definition: streamutil.c:52
fmtId
const char * fmtId(const char *rawid)
Definition: string_utils.c:248
setFmtEncoding
void setFmtEncoding(int encoding)
Definition: string_utils.c:69
appendStringLiteralConn
void appendStringLiteralConn(PQExpBuffer buf, const char *str, PGconn *conn)
Definition: string_utils.c:446
SimpleStringListCell::val
char val[FLEXIBLE_ARRAY_MEMBER]
Definition: simple_list.h:37
SimpleStringListCell::next
struct SimpleStringListCell * next
Definition: simple_list.h:34
SimpleStringList::head
SimpleStringListCell * head
Definition: simple_list.h:42
_connParams
Definition: pg_backup.h:84
_connParams::pguser
const char * pguser
Definition: connect_utils.h:31
_connParams::override_dbname
char * override_dbname
Definition: pg_backup.h:93
_connParams::pgport
char * pgport
Definition: pg_backup.h:87
_connParams::pghost
char * pghost
Definition: pg_backup.h:88
_connParams::dbname
char * dbname
Definition: pg_backup.h:86
_connParams::prompt_password
enum trivalue prompt_password
Definition: connect_utils.h:32
pg_conn
Definition: libpq-int.h:371
pg_result
Definition: libpq-int.h:165
superuser
bool superuser(void)
Definition: superuser.c:46
get_user_name_or_exit
const char * get_user_name_or_exit(const char *progname)
Definition: username.c:74
trivalue
trivalue
Definition: vacuumlo.c:35
TRI_YES
@ TRI_YES
Definition: vacuumlo.c:38
TRI_DEFAULT
@ TRI_DEFAULT
Definition: vacuumlo.c:36
TRI_NO
@ TRI_NO
Definition: vacuumlo.c:37

References _, appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), appendStringLiteralConn(), conn, connectMaintenanceDatabase(), createdb(), PQExpBufferData::data, _connParams::dbname, fmtId(), fprintf, free, get_progname(), get_user_name_or_exit(), getopt_long(), handle_help_version_opts(), SimpleStringList::head, help(), initPQExpBuffer(), SimpleStringListCell::next, no_argument, optarg, optind, option_parse_int(), _connParams::override_dbname, pg_fatal, pg_log_error, pg_log_error_hint, pg_logging_init(), pg_strdup(), PG_TEXTDOMAIN, _connParams::pghost, _connParams::pgport, PGRES_COMMAND_OK, _connParams::pguser, port, PQclear(), PQclientEncoding(), PQencryptPasswordConn(), PQerrorMessage(), PQexec(), PQfinish(), PQfreemem(), PQresultStatus(), printf, printfPQExpBuffer(), progname, _connParams::prompt_password, pwprompt, required_argument, set_pglocale_pgservice(), setFmtEncoding(), simple_prompt(), simple_string_list_append(), superuser(), TRI_DEFAULT, TRI_NO, TRI_YES, username, SimpleStringListCell::val, and yesno_prompt().