2 * Citadel setup utility
4 * Copyright (c) 1987-2021 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #define SHOW_ME_VAPPEND_PRINTF
22 #include <sys/types.h>
31 #include <sys/socket.h>
34 #include <libcitadel.h>
38 #include "citadel_dirs.h"
46 #define _(string) gettext(string)
48 #define _(string) (string)
51 #define SERVICE_NAME "citadel"
52 #define PROTO_NAME "tcp"
53 #define NSSCONF "/etc/nsswitch.conf"
55 typedef enum _SetupStep {
71 ///"CREATE_XINETD_ENTRY";
72 /* Environment variables, don't translate! */
73 const char *EnvNames [eMaxQuestions] = {
88 int setup_type = (-1);
93 int serv_sock = (-1) ;
95 const char *setup_titles[eMaxQuestions];
96 const char *setup_text[eMaxQuestions];
110 setlocale(LC_MESSAGES, getenv("LANG"));
111 bindtextdomain("citadel-setup", LOCALEDIR"/locale");
112 textdomain("citadel-setup");
113 bind_textdomain_codeset("citadel-setup","UTF8");
116 setup_titles[eCitadelHomeDir] = _("Citadel Home Directory");
118 setup_text[eCitadelHomeDir] = _(
119 "Enter the full pathname of the directory in which the Citadel\n"
120 "installation you are creating or updating resides. If you\n"
121 "specify a directory other than the default, you will need to\n"
122 "specify the -h flag to the server when you start it up.\n");
124 setup_text[eCitadelHomeDir] = _(
125 "Enter the subdirectory name for an alternate installation of "
126 "Citadel. To do a default installation just leave it blank."
127 "If you specify a directory other than the default, you will need to\n"
128 "specify the -h flag to the server when you start it up.\n"
129 "note that it may not have a leading /");
131 setup_titles[eSysAdminName] = _("Citadel administrator username:");
132 setup_text[eSysAdminName] = _(
133 "Please enter the name of the Citadel user account that should be granted "
134 "administrative privileges once created. If using internal authentication "
135 "this user account will be created if it does not exist. For external "
136 "authentication this user account has to exist.");
138 setup_titles[eSysAdminPW] = _("Administrator password:");
139 setup_text[eSysAdminPW] = _(
140 "Enter a password for the system administrator. When setup\n"
141 "completes it will attempt to create the administrator user\n"
142 "and set the password specified here.\n");
144 setup_titles[eUID] = _("Citadel User ID:");
145 setup_text[eUID] = _(
146 "Citadel needs to run under its own user ID. This would\n"
147 "typically be called \"citadel\", but if you are running Citadel\n"
148 "as a public site, you might also call it \"bbs\" or \"guest\".\n"
149 "The server will run under this user ID. Please specify that\n"
150 "user ID here. You may specify either a user name or a numeric\n"
153 setup_titles[eIP_ADDR] = _("Listening address for the Citadel server:");
154 setup_text[eIP_ADDR] = _(
155 "Please specify the IP address which the server should be listening to. "
156 "You can name a specific IPv4 or IPv6 address, or you can specify\n"
157 "\"*\" for \"any address\", \"::\" for \"any IPv6 address\", or \"0.0.0.0\"\n"
158 "for \"any IPv4 address\". If you leave this blank, Citadel will\n"
159 "listen on all addresses. "
160 "This can usually be left to the default unless multiple instances of Citadel "
161 "are running on the same computer.");
163 setup_titles[eCTDL_Port] = _("Server port number:");
164 setup_text[eCTDL_Port] = _(
165 "Specify the TCP port number on which your server will run.\n"
166 "Normally, this will be port 504, which is the official port\n"
167 "assigned by the IANA for Citadel servers. You will only need\n"
168 "to specify a different port number if you run multiple instances\n"
169 "of Citadel on the same computer and there is something else\n"
170 "already using port 504.\n");
172 setup_titles[eAuthType] = _("Authentication method to use:");
173 setup_text[eAuthType] = _(
174 "Please choose the user authentication mode. By default Citadel will use its "
175 "own internal user accounts database. If you choose Host, Citadel users will "
176 "have accounts on the host system, authenticated via /etc/passwd or a PAM "
177 "source. LDAP chooses an RFC 2307 compliant directory server, the last option "
178 "chooses the nonstandard MS Active Directory LDAP scheme."
180 "Do not change this option unless you are sure it is required, since changing "
181 "back requires a full reinstall of Citadel."
183 " 0. Self contained authentication\n"
184 " 1. Host system integrated authentication\n"
185 " 2. External LDAP - RFC 2307 POSIX schema\n"
186 " 3. External LDAP - MS Active Directory schema\n"
188 "For help: http://www.citadel.org/doku.php/faq:installation:authmodes\n"
190 "ANSWER \"0\" UNLESS YOU COMPLETELY UNDERSTAND THIS OPTION.\n");
192 setup_titles[eLDAP_Host] = _("LDAP host:");
193 setup_text[eLDAP_Host] = _(
194 "Please enter the host name or IP address of your LDAP server.\n");
196 setup_titles[eLDAP_Port] = _("LDAP port number:");
197 setup_text[eLDAP_Port] = _(
198 "Please enter the port number of the LDAP service (usually 389).\n");
200 setup_titles[eLDAP_Base_DN] = _("LDAP base DN:");
201 setup_text[eLDAP_Base_DN] = _(
202 "Please enter the Base DN to search for authentication\n"
203 "(for example: dc=example,dc=com)\n");
205 setup_titles[eLDAP_Bind_DN] = _("LDAP bind DN:");
206 setup_text[eLDAP_Bind_DN] = _(
207 "Please enter the DN of an account to use for binding to the LDAP server for "
208 "performing queries. The account does not require any other privileges. If "
209 "your LDAP server allows anonymous queries, you can leave this blank.\n");
211 setup_titles[eLDAP_Bind_PW] = _("LDAP bind password:");
212 setup_text[eLDAP_Bind_PW] = _(
213 "If you entered a Bind DN in the previous question, you must now enter\n"
214 "the password associated with that account. Otherwise, you can leave this\n"
218 // Debug loading of locales... Strace does a better job though.
219 printf("Message catalog directory: %s\n", bindtextdomain("citadel-setup", LOCALEDIR"/locale"));
220 printf("Text domain: %s\n", textdomain("citadel-setup"));
221 printf("Text domain Charset: %s\n", bind_textdomain_codeset("citadel-setup","UTF8"));
224 for (i = 0; i < eMaxQuestions; i++)
225 printf("%s - %s\n", setup_titles[i], _(setup_titles[i]));
232 void title(const char *text) {
233 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<%s>\n", text);
237 int yesno(const char *question, int default_value) {
242 printf("%s\n%s [%s] --> ", question, _("Yes/No"), ( default_value ? _("Yes") : _("No") ));
243 if (fgets(buf, sizeof buf, stdin)) {
244 answer = tolower(buf[0]);
245 if ((buf[0]==0) || (buf[0]==13) || (buf[0]==10)) {
246 answer = default_value;
248 else if (answer == 'y') {
251 else if (answer == 'n') {
255 } while ((answer < 0) || (answer > 1));
260 void important_message(const char *title, const char *msgtext) {
263 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
264 printf(" %s \n\n%s\n\n", title, msgtext);
265 printf("%s", _("Press return to continue..."));
266 if (fgets(buf, sizeof buf, stdin)) {
272 void important_msgnum(int msgnum) {
273 important_message(_("Important Message"), setup_text[msgnum]);
277 void display_error(char *error_message_format, ...) {
282 va_start(arg_ptr, error_message_format);
283 StrBufVAppendPrintf(Msg, error_message_format, arg_ptr);
286 important_message(_("Error"), ChrPtr(Msg));
291 void progress(char *text, long int curr, long int cmax) {
292 static long dots_printed = 0L;
296 printf("%s\n", text);
297 printf("....................................................");
298 printf("..........................\r");
300 } else if (curr == cmax) {
301 printf("\r%79s\n", "");
303 a = (curr * 100) / cmax;
306 while (dots_printed < a) {
315 int uds_connectsock(char *sockpath) {
317 struct sockaddr_un addr;
319 memset(&addr, 0, sizeof(addr));
320 addr.sun_family = AF_UNIX;
321 strcpy(addr.sun_path, sockpath);
323 s = socket(AF_UNIX, SOCK_STREAM, 0);
328 if (connect(s, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
338 * input binary data from socket
340 void serv_read(char *buf, int bytes) {
344 while (len < bytes) {
345 rlen = read(serv_sock, &buf[len], bytes - len);
355 * send binary to server
357 void serv_write(char *buf, int nbytes) {
358 int bytes_written = 0;
360 while (bytes_written < nbytes) {
361 retval = write(serv_sock, &buf[bytes_written], nbytes - bytes_written);
365 bytes_written = bytes_written + retval;
371 * input string from socket - implemented in terms of serv_read()
373 void serv_gets(char *buf) {
376 /* Read one character at a time.
379 serv_read(&buf[i], 1);
380 if (buf[i] == '\n' || i == (SIZ-1))
384 /* If we got a long line, discard characters until the newline.
387 while (buf[i] != '\n') {
388 serv_read(&buf[i], 1);
392 /* Strip all trailing nonprintables (crlf)
399 * send line to server - implemented in terms of serv_write()
401 void serv_puts(char *buf) {
402 serv_write(buf, strlen(buf));
408 * Convenience functions to get/set system configuration entries
410 void getconf_str(char *buf, char *key) {
414 sprintf(cmd, "CONF GETVAL|%s", key);
418 extract_token(buf, &ret[4], 0, '|', SIZ);
426 int getconf_int(char *key) {
428 getconf_str(buf, key);
433 void setconf_str(char *key, char *val) {
436 sprintf(buf, "CONF PUTVAL|%s|%s", key, val);
442 void setconf_int(char *key, int val) {
445 sprintf(buf, "CONF PUTVAL|%s|%d", key, val);
452 * On systems which use xinetd, see if we can offer to install Citadel as
453 * the default telnet target.
455 void check_xinetd_entry(void)
457 char *filename = "/etc/xinetd.d/telnet";
460 int already_citadel = 0;
463 fp = fopen(filename, "r+");
464 if (fp == NULL) return; /* Not there. Oh well... */
466 while (fgets(buf, sizeof buf, fp) != NULL) {
467 if (strstr(buf, "/citadel") != NULL) {
472 if (already_citadel) return; /* Already set up this way. */
474 /* Otherwise, prompt the user to create an entry. */
475 if (getenv("CREATE_XINETD_ENTRY") != NULL) {
476 if (strcasecmp(getenv("CREATE_XINETD_ENTRY"), "yes")) {
481 snprintf(buf, sizeof buf,
482 _("Setup can configure the \"xinetd\" service to automatically\n"
483 "connect incoming telnet sessions to Citadel, bypassing the\n"
484 "host system login: prompt. Would you like to do this?\n"
487 if (yesno(buf, 1) == 0) {
492 fp = fopen(filename, "w");
494 "# description: telnet service for Citadel users\n"
499 " socket_type = stream\n"
502 " server = /usr/sbin/in.telnetd\n"
503 " server_args = -h -L %s/citadel\n"
504 " log_on_failure += USERID\n"
510 /* Now try to restart the service. This will not have the intended effect on Solaris, but who uses Solaris anymore? */
511 rv = system("systemctl restart xinetd >/dev/null 2>&1");
513 rv = system("service xinetd restart >/dev/null 2>&1");
516 display_error(_("failed to restart xinetd.\n"));
521 void strprompt(const char *prompt_title, const char *prompt_text, char *Target, char *DefValue)
526 strcpy(setupmsg, "");
529 printf("\n%s\n", prompt_text);
530 printf("%s\n%s\n", _("This is currently set to:"), Target);
531 printf("%s\n", _("Enter new value or press return to leave unchanged:"));
532 if (fgets(buf, sizeof buf, stdin)) {
533 buf[strlen(buf) - 1] = 0;
535 if (!IsEmptyStr(buf)) {
541 void set_bool_val(int msgpos, int *ip, char *DefValue) {
542 title(setup_titles[msgpos]);
543 *ip = yesno(setup_text[msgpos], *ip);
547 void set_str_val(int msgpos, char *Target, char *DefValue)
549 strprompt(setup_titles[msgpos],
557 /* like set_str_val() but for numeric values */
558 void set_int_val(int msgpos, int *target, char *default_value)
561 sprintf(buf, "%d", *target);
563 set_str_val(msgpos, buf, default_value);
564 } while ( (strcmp(buf, "0")) && (atoi(buf) == 0) );
569 void edit_value(int curr)
571 struct passwd *pw = NULL;
572 char ctdluidname[256];
574 char *default_value = NULL;
580 if (default_value == NULL) {
587 getconf_str(admin_name, "c_sysadm");
588 set_str_val(curr, admin_name, default_value);
589 setconf_str("c_sysadm", admin_name);
593 set_str_val(curr, admin_pass, default_value);
597 ctdluid = getconf_int("c_ctdluid");
598 pw = getpwuid(ctdluid);
600 set_int_val(curr, &ctdluid, default_value);
603 strcpy(ctdluidname, pw->pw_name);
604 set_str_val(curr, ctdluidname, default_value);
605 pw = getpwnam(ctdluidname);
607 ctdluid = pw->pw_uid;
609 else if (atoi(ctdluidname) > 0) {
610 ctdluid = atoi(ctdluidname);
613 setconf_int("c_ctdluid", ctdluid);
617 getconf_str(buf, "c_ip_addr");
618 set_str_val(curr, buf, default_value);
619 setconf_str("c_ip_addr", buf);
623 portnum = getconf_int("c_port_number");
624 set_int_val(curr, &portnum, default_value);
625 setconf_int("c_port_number", portnum);
629 auth = getconf_int("c_auth_mode");
630 set_int_val(curr, &auth, default_value);
631 setconf_int("c_auth_mode", auth);
635 getconf_str(buf, "c_ldap_host");
636 if (IsEmptyStr(buf)) {
637 strcpy(buf, "localhost");
639 set_str_val(curr, buf, default_value);
640 setconf_str("c_ldap_host", buf);
644 lportnum = getconf_int("c_ldap_port");
648 set_int_val(curr, &lportnum, default_value);
649 setconf_int("c_ldap_port", lportnum);
653 getconf_str(buf, "c_ldap_base_dn");
654 set_str_val(curr, buf, default_value);
655 setconf_str("c_ldap_base_dn", buf);
659 getconf_str(buf, "c_ldap_bind_dn");
660 set_str_val(curr, buf, default_value);
661 setconf_str("c_ldap_bind_dn", buf);
665 getconf_str(buf, "c_ldap_bind_pw");
666 set_str_val(curr, buf, default_value);
667 setconf_str("c_ldap_bind_pw", buf);
674 * Messages that are no longer in use.
675 * We keep them here so we don't lose the translations if we need them later.
678 important_message(_("Setup finished"),
679 _("Setup of the Citadel server is complete.\n"
680 "If you will be using WebCit, please run its\n"
681 "setup program now; otherwise, run './citadel'\n"
683 important_message(_("Setup failed"),
684 _("Setup is finished, but the Citadel server failed to start.\n"
685 "Go back and check your configuration.\n");
686 important_message(_("Setup finished"),
687 _("Setup is finished. You may now start the server."));
691 int main(int argc, char *argv[])
697 char ctdldir[PATH_MAX]=CTDLDIR;
700 char *activity = NULL;
702 /* Keep a mild groove on */
703 program_title = _("Citadel setup program");
705 /* set an invalid setup type */
708 /* parse command line args */
709 for (a = 0; a < argc; ++a) {
710 if (!strncmp(argv[a], "-u", 2)) {
711 strcpy(aaa, argv[a]);
712 strcpy(aaa, &aaa[2]);
713 setup_type = atoi(aaa);
715 else if (!strncmp(argv[a], "-h", 2)) {
716 safestrncpy(ctdldir, &argv[a][2], sizeof ctdldir);
720 if (chdir(ctdldir) != 0) {
721 fprintf(stderr, "sendcommand: %s: %s\n", ctdldir, strerror(errno));
728 * Connect to the running Citadel server.
730 char *connectingmsg = _("Connecting to Citadel server");
731 for (i=0; ((i<30) && (serv_sock < 0)) ; ++i) { /* wait for server to start up */
732 progress(connectingmsg, i, 30);
733 serv_sock = uds_connectsock(file_citadel_admin_socket);
736 progress(connectingmsg, 30, 30);
741 _("Setup could not connect to a running Citadel server."),
742 strerror(errno), file_citadel_admin_socket
748 * read the server greeting
752 display_error("%s\n", buf);
757 * Are we connected to the correct Citadel server?
762 display_error("%s\n", buf);
766 while (serv_gets(buf), strcmp(buf, "000")) {
768 if (atoi(buf) != REV_LEVEL) {
769 display_error("%s\n",
770 _("Your setup program and Citadel server are from different versions.")
778 printf("\n\n\n *** %s ***\n\n", program_title);
780 /* Go through a series of dialogs prompting for config info */
781 for (curr = 1; curr < eMaxQuestions; ++curr) {
784 if ( (curr == eAuthType)
785 && (getconf_int("c_auth_mode") != AUTHMODE_LDAP)
786 && (getconf_int("c_auth_mode") != AUTHMODE_LDAP_AD)
788 curr += 5; /* skip LDAP questions if we're not authenticating against LDAP */
791 if (curr == eSysAdminName) {
792 if (getconf_int("c_auth_mode") == AUTHMODE_NATIVE) {
793 /* for native auth mode, fetch the admin's existing pw */
794 snprintf(buf, sizeof buf, "AGUP %s", admin_name);
798 extract_token(admin_pass, &buf[4], 1, '|', sizeof admin_pass);
802 ++curr; /* skip the password question for non-native auth modes */
807 if ((pw = getpwuid( getconf_int("c_ctdluid") )) == NULL) {
813 if (create_run_directories(getconf_int("c_ctdluid"), gid) != 0) {
814 display_error("%s\n", _("failed to create directories"));
817 activity = _("Reconfiguring Citadel server");
818 progress(activity, 0, 5);
819 sleep(1); /* Let the message appear briefly */
822 * Create the administrator account. It's ok if the command fails if this user already exists.
824 if (getconf_int("c_auth_mode") == AUTHMODE_NATIVE) {
825 progress(activity, 1, 5);
826 snprintf(buf, sizeof buf, "CREU %s|%s", admin_name, admin_pass);
828 progress(activity, 2, 5);
831 progress(activity, 3, 5);
834 * Assign the desired password and access level to the administrator account.
836 if (getconf_int("c_auth_mode") == AUTHMODE_NATIVE) {
837 snprintf(buf, sizeof buf, "AGUP %s", admin_name);
839 progress(activity, 4, 5);
842 int admin_flags = extract_int(&buf[4], 2);
843 int admin_times_called = extract_int(&buf[4], 3);
844 int admin_msgs_posted = extract_int(&buf[4], 4);
845 snprintf(buf, sizeof buf, "ASUP %s|%s|%d|%d|%d|6",
846 admin_name, admin_pass, admin_flags, admin_times_called, admin_msgs_posted
852 progress(activity, 5, 5);
854 check_xinetd_entry(); /* Check /etc/xinetd.d/telnet */
859 activity = _("Restarting Citadel server to apply changes");
860 progress(activity, 0, 51);
864 long original_start_time = extract_long(&buf[4], 3);
866 progress(activity, 1, 51);
868 progress(activity, 2, 51);
871 display_error("%s\n", buf);
878 for (i=3; i<=6; ++i) { /* wait for server to shut down */
879 progress(activity, i, 51);
883 for (i=7; ((i<=48) && (serv_sock < 0)) ; ++i) { /* wait for server to start up */
884 progress(activity, i, 51);
885 serv_sock = uds_connectsock(file_citadel_admin_socket);
889 progress(activity, 49, 51);
892 progress(activity, 50, 51);
895 long new_start_time = extract_long(&buf[4], 3);
898 progress(activity, 51, 51);
900 if ((original_start_time == new_start_time) || (new_start_time <= 0)) {
901 display_error("%s\n", _("Setup failed to restart Citadel server. Please restart it manually."));