src/bin/scripts/createuser.c

   1 /*-------------------------------------------------------------------------
   2  *
   3  * createuser
   4  *
   5  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
   6  * Portions Copyright (c) 1994, Regents of the University of California
   7  *
   8  * $PostgreSQL$
   9  *
  10  *-------------------------------------------------------------------------
  11  */
  12
  13 #include "postgres_fe.h"
  14 #include "common.h"
  15 #include "dumputils.h"
  16
  17
  18 static void help(const char *progname);
  19
  20 enum trivalue
  21 {
  22         TRI_DEFAULT,
  23         TRI_NO,
  24         TRI_YES
  25 };
  26
  27 int
  28 main(int argc, char *argv[])
  29 {
  30         static struct option long_options[] = {
  31                 {"host", required_argument, NULL, 'h'},
  32                 {"port", required_argument, NULL, 'p'},
  33                 {"username", required_argument, NULL, 'U'},
  34                 {"password", no_argument, NULL, 'W'},
  35                 {"echo", no_argument, NULL, 'e'},
  36                 {"quiet", no_argument, NULL, 'q'},
  37                 {"createdb", no_argument, NULL, 'd'},
  38                 {"no-createdb", no_argument, NULL, 'D'},
  39                 {"superuser", no_argument, NULL, 's'},
  40                 {"no-superuser", no_argument, NULL, 'S'},
  41                 {"createrole", no_argument, NULL, 'r'},
  42                 {"no-createrole", no_argument, NULL, 'R'},
  43                 {"inherit", no_argument, NULL, 'i'},
  44                 {"no-inherit", no_argument, NULL, 'I'},
  45                 {"login", no_argument, NULL, 'l'},
  46                 {"no-login", no_argument, NULL, 'L'},
  47                 /* adduser is obsolete, undocumented spelling of superuser */
  48                 {"adduser", no_argument, NULL, 'a'},
  49                 {"no-adduser", no_argument, NULL, 'A'},
  50                 {"connection-limit", required_argument, NULL, 'c'},
  51                 {"pwprompt", no_argument, NULL, 'P'},
  52                 {"encrypted", no_argument, NULL, 'E'},
  53                 {"unencrypted", no_argument, NULL, 'N'},
  54                 {NULL, 0, NULL, 0}
  55         };
  56
  57         const char *progname;
  58         int                     optindex;
  59         int                     c;
  60         char       *newuser = NULL;
  61         char       *host = NULL;
  62         char       *port = NULL;
  63         char       *username = NULL;
  64         bool            password = false;
  65         bool            echo = false;
  66         char       *conn_limit = NULL;
  67         bool            pwprompt = false;
  68         char       *newpassword = NULL;
  69
  70         /* Tri-valued variables.  */
  71         enum trivalue createdb = TRI_DEFAULT,
  72                                 superuser = TRI_DEFAULT,
  73                                 createrole = TRI_DEFAULT,
  74                                 inherit = TRI_DEFAULT,
  75                                 login = TRI_DEFAULT,
  76                                 encrypted = TRI_DEFAULT;
  77
  78         PQExpBufferData sql;
  79
  80         PGconn     *conn;
  81         PGresult   *result;
  82
  83         progname = get_progname(argv[0]);
  84         set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pgscripts"));
  85
  86         handle_help_version_opts(argc, argv, "createuser", help);
  87
  88         while ((c = getopt_long(argc, argv, "h:p:U:WeqdDsSaArRiIlLc:PEN",
  89                                                         long_options, &optindex)) != -1)
  90         {
  91                 switch (c)
  92                 {
  93                         case 'h':
  94                                 host = optarg;
  95                                 break;
  96                         case 'p':
  97                                 port = optarg;
  98                                 break;
  99                         case 'U':
 100                                 username = optarg;
 101                                 break;
 102                         case 'W':
 103                                 password = true;
 104                                 break;
 105                         case 'e':
 106                                 echo = true;
 107                                 break;
 108                         case 'q':
 109                                 /* obsolete; remove in 8.4 */
 110                                 break;
 111                         case 'd':
 112                                 createdb = TRI_YES;
 113                                 break;
 114                         case 'D':
 115                                 createdb = TRI_NO;
 116                                 break;
 117                         case 's':
 118                         case 'a':
 119                                 superuser = TRI_YES;
 120                                 break;
 121                         case 'S':
 122                         case 'A':
 123                                 superuser = TRI_NO;
 124                                 break;
 125                         case 'r':
 126                                 createrole = TRI_YES;
 127                                 break;
 128                         case 'R':
 129                                 createrole = TRI_NO;
 130                                 break;
 131                         case 'i':
 132                                 inherit = TRI_YES;
 133                                 break;
 134                         case 'I':
 135                                 inherit = TRI_NO;
 136                                 break;
 137                         case 'l':
 138                                 login = TRI_YES;
 139                                 break;
 140                         case 'L':
 141                                 login = TRI_NO;
 142                                 break;
 143                         case 'c':
 144                                 conn_limit = optarg;
 145                                 break;
 146                         case 'P':
 147                                 pwprompt = true;
 148                                 break;
 149                         case 'E':
 150                                 encrypted = TRI_YES;
 151                                 break;
 152                         case 'N':
 153                                 encrypted = TRI_NO;
 154                                 break;
 155                         default:
 156                                 fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 157                                 exit(1);
 158                 }
 159         }
 160
 161         switch (argc - optind)
 162         {
 163                 case 0:
 164                         break;
 165                 case 1:
 166                         newuser = argv[optind];
 167                         break;
 168                 default:
 169                         fprintf(stderr, _("%s: too many command-line arguments (first is \"%s\")\n"),
 170                                         progname, argv[optind + 1]);
 171                         fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
 172                         exit(1);
 173         }
 174
 175         if (newuser == NULL)
 176                 newuser = simple_prompt("Enter name of role to add: ", 128, true);
 177
 178         if (pwprompt)
 179         {
 180                 char       *pw1,
 181                                    *pw2;
 182
 183                 pw1 = simple_prompt("Enter password for new role: ", 100, false);
 184                 pw2 = simple_prompt("Enter it again: ", 100, false);
 185                 if (strcmp(pw1, pw2) != 0)
 186                 {
 187                         fprintf(stderr, _("Passwords didn't match.\n"));
 188                         exit(1);
 189                 }
 190                 newpassword = pw1;
 191                 free(pw2);
 192         }
 193
 194         if (superuser == 0)
 195         {
 196                 if (yesno_prompt("Shall the new role be a superuser?"))
 197                         superuser = TRI_YES;
 198                 else
 199                         superuser = TRI_NO;
 200         }
 201
 202         if (superuser == TRI_YES)
 203         {
 204                 /* Not much point in trying to restrict a superuser */
 205                 createdb = TRI_YES;
 206                 createrole = TRI_YES;
 207         }
 208
 209         if (createdb == 0)
 210         {
 211                 if (yesno_prompt("Shall the new role be allowed to create databases?"))
 212                         createdb = TRI_YES;
 213                 else
 214                         createdb = TRI_NO;
 215         }
 216
 217         if (createrole == 0)
 218         {
 219                 if (yesno_prompt("Shall the new role be allowed to create more new roles?"))
 220                         createrole = TRI_YES;
 221                 else
 222                         createrole = TRI_NO;
 223         }
 224
 225         if (inherit == 0)
 226                 inherit = TRI_YES;
 227
 228         if (login == 0)
 229                 login = TRI_YES;
 230
 231         conn = connectDatabase("postgres", host, port, username, password, progname);
 232
 233         initPQExpBuffer(&sql);
 234
 235         printfPQExpBuffer(&sql, "CREATE ROLE %s", fmtId(newuser));
 236         if (newpassword)
 237         {
 238                 if (encrypted == TRI_YES)
 239                         appendPQExpBuffer(&sql, " ENCRYPTED");
 240                 if (encrypted == TRI_NO)
 241                         appendPQExpBuffer(&sql, " UNENCRYPTED");
 242                 appendPQExpBuffer(&sql, " PASSWORD ");
 243
 244                 if (encrypted != TRI_NO)
 245                 {
 246                         char       *encrypted_password;
 247
 248                         encrypted_password = PQencryptPassword(newpassword,
 249                                                                                                    newuser);
 250                         if (!encrypted_password)
 251                         {
 252                                 fprintf(stderr, _("Password encryption failed.\n"));
 253                                 exit(1);
 254                         }
 255                         appendStringLiteralConn(&sql, encrypted_password, conn);
 256                         PQfreemem(encrypted_password);
 257                 }
 258                 else
 259                         appendStringLiteralConn(&sql, newpassword, conn);
 260         }
 261         if (superuser == TRI_YES)
 262                 appendPQExpBuffer(&sql, " SUPERUSER");
 263         if (superuser == TRI_NO)
 264                 appendPQExpBuffer(&sql, " NOSUPERUSER");
 265         if (createdb == TRI_YES)
 266                 appendPQExpBuffer(&sql, " CREATEDB");
 267         if (createdb == TRI_NO)
 268                 appendPQExpBuffer(&sql, " NOCREATEDB");
 269         if (createrole == TRI_YES)
 270                 appendPQExpBuffer(&sql, " CREATEROLE");
 271         if (createrole == TRI_NO)
 272                 appendPQExpBuffer(&sql, " NOCREATEROLE");
 273         if (inherit == TRI_YES)
 274                 appendPQExpBuffer(&sql, " INHERIT");
 275         if (inherit == TRI_NO)
 276                 appendPQExpBuffer(&sql, " NOINHERIT");
 277         if (login == TRI_YES)
 278                 appendPQExpBuffer(&sql, " LOGIN");
 279         if (login == TRI_NO)
 280                 appendPQExpBuffer(&sql, " NOLOGIN");
 281         if (conn_limit != NULL)
 282                 appendPQExpBuffer(&sql, " CONNECTION LIMIT %s", conn_limit);
 283         appendPQExpBuffer(&sql, ";\n");
 284
 285         if (echo)
 286                 printf("%s", sql.data);
 287         result = PQexec(conn, sql.data);
 288
 289         if (PQresultStatus(result) != PGRES_COMMAND_OK)
 290         {
 291                 fprintf(stderr, _("%s: creation of new role failed: %s"),
 292                                 progname, PQerrorMessage(conn));
 293                 PQfinish(conn);
 294                 exit(1);
 295         }
 296
 297         PQclear(result);
 298         PQfinish(conn);
 299         exit(0);
 300 }
 301
 302
 303 static void
 304 help(const char *progname)
 305 {
 306         printf(_("%s creates a new PostgreSQL role.\n\n"), progname);
 307         printf(_("Usage:\n"));
 308         printf(_("  %s [OPTION]... [ROLENAME]\n"), progname);
 309         printf(_("\nOptions:\n"));
 310         printf(_("  -c, --connection-limit=N  connection limit for role (default: no limit)\n"));
 311         printf(_("  -d, --createdb            role can create new databases\n"));
 312         printf(_("  -D, --no-createdb         role cannot create databases\n"));
 313         printf(_("  -e, --echo                show the commands being sent to the server\n"));
 314         printf(_("  -E, --encrypted           encrypt stored password\n"));
 315         printf(_("  -i, --inherit             role inherits privileges of roles it is a\n"
 316                          "                            member of (default)\n"));
 317         printf(_("  -I, --no-inherit          role does not inherit privileges\n"));
 318         printf(_("  -l, --login               role can login (default)\n"));
 319         printf(_("  -L, --no-login            role cannot login\n"));
 320         printf(_("  -N, --unencrypted         do not encrypt stored password\n"));
 321         printf(_("  -P, --pwprompt            assign a password to new role\n"));
 322         printf(_("  -r, --createrole          role can create new roles\n"));
 323         printf(_("  -R, --no-createrole       role cannot create roles\n"));
 324         printf(_("  -s, --superuser           role will be superuser\n"));
 325         printf(_("  -S, --no-superuser        role will not be superuser\n"));
 326         printf(_("  --help                    show this help, then exit\n"));
 327         printf(_("  --version                 output version information, then exit\n"));
 328         printf(_("\nConnection options:\n"));
 329         printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
 330         printf(_("  -p, --port=PORT           database server port\n"));
 331         printf(_("  -U, --username=USERNAME   user name to connect as (not the one to create)\n"));
 332         printf(_("  -W, --password            force password prompt\n"));
 333         printf(_("\nIf one of -d, -D, -r, -R, -s, -S, and ROLENAME is not specified, you will\n"
 334                          "be prompted interactively.\n"));
 335         printf(_("\nReport bugs to <pgsql-bugs@postgresql.org>.\n"));
 336 }