2 some simple CGI helper routines
3 Copyright (C) Andrew Tridgell 1997-1998
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "web/swat_proto.h"
23 #define MAX_VARIABLES 10000
25 /* set the expiry on fixed pages */
26 #define EXPIRY_TIME (60*60*24*7)
29 extern void print_title(char *fmt, ...);
37 static struct cgi_var variables[MAX_VARIABLES];
38 static int num_variables;
39 static int content_length;
40 static int request_post;
41 static char *query_string;
42 static const char *baseurl;
43 static char *pathinfo;
46 static bool inetd_server;
47 static bool got_request;
49 static char *grab_line(FILE *f, int *cl)
60 if (len == 0) len = 1024;
62 ret2 = (char *)SMB_REALLOC_KEEP_OLD_ON_ERROR(ret, len);
63 if (!ret2) return ret;
75 if (c == '\r') continue;
77 if (strchr_m("\n&", c)) break;
90 URL encoded strings can have a '+', which should be replaced with a space
92 (This was in rfc1738_unescape(), but that broke the squid helper)
95 static void plus_to_space_unescape(char *buf)
99 while ((p=strchr_m(p,'+')))
103 /***************************************************************************
104 load all the variables passed to the CGI program. May have multiple variables
105 with the same name and the same or different values. Takes a file parameter
106 for simulating CGI invocation eg loading saved preferences.
107 ***************************************************************************/
108 void cgi_load_variables(void)
115 #ifdef DEBUG_COMMENTS
118 d_printf("<!== Start dump in cgi_load_variables() %s ==>\n",__FILE__);
121 if (!content_length) {
122 p = getenv("CONTENT_LENGTH");
125 len = content_length;
131 ((s=getenv("REQUEST_METHOD")) &&
132 strequal(s,"POST")))) {
133 while (len && (line=grab_line(f, &len))) {
134 p = strchr_m(line,'=');
139 variables[num_variables].name = SMB_STRDUP(line);
140 variables[num_variables].value = SMB_STRDUP(p+1);
144 if (!variables[num_variables].name ||
145 !variables[num_variables].value)
148 plus_to_space_unescape(variables[num_variables].value);
149 rfc1738_unescape(variables[num_variables].value);
150 plus_to_space_unescape(variables[num_variables].name);
151 rfc1738_unescape(variables[num_variables].name);
153 #ifdef DEBUG_COMMENTS
154 printf("<!== POST var %s has value \"%s\" ==>\n",
155 variables[num_variables].name,
156 variables[num_variables].value);
160 if (num_variables == MAX_VARIABLES) break;
165 open("/dev/null", O_RDWR);
167 if ((s=query_string) || (s=getenv("QUERY_STRING"))) {
169 for (tok=strtok_r(s, "&;", &saveptr); tok;
170 tok=strtok_r(NULL, "&;", &saveptr)) {
171 p = strchr_m(tok,'=');
176 variables[num_variables].name = SMB_STRDUP(tok);
177 variables[num_variables].value = SMB_STRDUP(p+1);
179 if (!variables[num_variables].name ||
180 !variables[num_variables].value)
183 plus_to_space_unescape(variables[num_variables].value);
184 rfc1738_unescape(variables[num_variables].value);
185 plus_to_space_unescape(variables[num_variables].name);
186 rfc1738_unescape(variables[num_variables].name);
188 #ifdef DEBUG_COMMENTS
189 printf("<!== Commandline var %s has value \"%s\" ==>\n",
190 variables[num_variables].name,
191 variables[num_variables].value);
194 if (num_variables == MAX_VARIABLES) break;
198 #ifdef DEBUG_COMMENTS
199 printf("<!== End dump in cgi_load_variables() ==>\n");
202 /* variables from the client are in UTF-8 - convert them
203 to our internal unix charset before use */
204 for (i=0;i<num_variables;i++) {
205 TALLOC_CTX *frame = talloc_stackframe();
209 convert_string_allocate(frame, CH_UTF8, CH_UNIX,
210 variables[i].name, strlen(variables[i].name),
211 &dest, &dest_len, True);
212 SAFE_FREE(variables[i].name);
213 variables[i].name = SMB_STRDUP(dest ? dest : "");
216 convert_string_allocate(frame, CH_UTF8, CH_UNIX,
217 variables[i].value, strlen(variables[i].value),
218 &dest, &dest_len, True);
219 SAFE_FREE(variables[i].value);
220 variables[i].value = SMB_STRDUP(dest ? dest : "");
226 /***************************************************************************
227 find a variable passed via CGI
228 Doesn't quite do what you think in the case of POST text variables, because
229 if they exist they might have a value of "" or even " ", depending on the
230 browser. Also doesn't allow for variables[] containing multiple variables
231 with the same name and the same or different values.
232 ***************************************************************************/
234 const char *cgi_variable(const char *name)
238 for (i=0;i<num_variables;i++)
239 if (strcmp(variables[i].name, name) == 0)
240 return variables[i].value;
244 /***************************************************************************
245 Version of the above that can't return a NULL pointer.
246 ***************************************************************************/
248 const char *cgi_variable_nonull(const char *name)
250 const char *var = cgi_variable(name);
258 /***************************************************************************
259 tell a browser about a fatal error in the http processing
260 ***************************************************************************/
261 static void cgi_setup_error(const char *err, const char *header, const char *info)
264 /* damn browsers don't like getting cut off before they give a request */
266 while (fgets(line, sizeof(line)-1, stdin)) {
267 if (strnequal(line,"GET ", 4) ||
268 strnequal(line,"POST ", 5) ||
269 strnequal(line,"PUT ", 4)) {
275 d_printf("HTTP/1.0 %s\r\n%sConnection: close\r\nContent-Type: text/html\r\n\r\n<HTML><HEAD><TITLE>%s</TITLE></HEAD><BODY><H1>%s</H1>%s<p></BODY></HTML>\r\n\r\n", err, header, err, err, info);
282 /***************************************************************************
283 tell a browser about a fatal authentication error
284 ***************************************************************************/
285 static void cgi_auth_error(void)
288 cgi_setup_error("401 Authorization Required",
289 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
290 "You must be authenticated to use this service");
292 printf("Content-Type: text/html\r\n");
294 printf("\r\n<HTML><HEAD><TITLE>SWAT</TITLE></HEAD>\n");
295 printf("<BODY><H1>Installation Error</H1>\n");
296 printf("SWAT must be installed via inetd. It cannot be run as a CGI script<p>\n");
297 printf("</BODY></HTML>\r\n");
302 /***************************************************************************
303 authenticate when we are running as a CGI
304 ***************************************************************************/
305 static void cgi_web_auth(void)
307 const char *user = getenv("REMOTE_USER");
309 const char *head = "Content-Type: text/html\r\n\r\n<HTML><BODY><H1>SWAT installation Error</H1>\n";
310 const char *tail = "</BODY></HTML>\r\n";
313 printf("%sREMOTE_USER not set. Not authenticated by web server.<br>%s\n",
318 pwd = getpwnam_alloc(talloc_autofree_context(), user);
320 printf("%sCannot find user %s<br>%s\n", head, user, tail);
326 if (geteuid() != pwd->pw_uid || getuid() != pwd->pw_uid) {
327 printf("%sFailed to become user %s - uid=%d/%d<br>%s\n",
328 head, user, (int)geteuid(), (int)getuid(), tail);
335 /***************************************************************************
336 handle a http authentication line
337 ***************************************************************************/
338 static bool cgi_handle_authorization(char *line)
341 fstring user, user_pass;
342 struct passwd *pass = NULL;
344 if (!strnequal(line,"Basic ", 6)) {
348 while (line[0] == ' ') line++;
349 base64_decode_inplace(line);
350 if (!(p=strchr_m(line,':'))) {
352 * Always give the same error so a cracker
353 * cannot tell why we fail.
359 convert_string(CH_UTF8, CH_UNIX,
361 user, sizeof(user), True);
363 convert_string(CH_UTF8, CH_UNIX,
365 user_pass, sizeof(user_pass), True);
368 * Try and get the user from the UNIX password file.
371 pass = getpwnam_alloc(talloc_autofree_context(), user);
374 * Validate the password they have given.
377 if NT_STATUS_IS_OK(pass_check(pass, user, user_pass,
378 strlen(user_pass), NULL, False)) {
385 if ( initgroups(pass->pw_name, pass->pw_gid) != 0 )
388 become_user_permanently(pass->pw_uid, pass->pw_gid);
390 /* Save the users name */
391 C_user = SMB_STRDUP(user);
392 C_pass = SMB_STRDUP(user_pass);
399 cgi_setup_error("401 Bad Authorization",
400 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
401 "username or password incorrect");
407 /***************************************************************************
409 ***************************************************************************/
412 if (geteuid() == 0) {
419 /***************************************************************************
420 return a ptr to the users name
421 ***************************************************************************/
422 char *cgi_user_name(void)
427 /***************************************************************************
428 return a ptr to the users password
429 ***************************************************************************/
430 char *cgi_user_pass(void)
435 /***************************************************************************
436 handle a file download
437 ***************************************************************************/
438 static void cgi_download(char *file)
446 /* sanitise the filename */
447 for (i=0;file[i];i++) {
448 if (!isalnum((int)file[i]) && !strchr_m("/.-_", file[i])) {
449 cgi_setup_error("404 File Not Found","",
450 "Illegal character in filename");
454 if (sys_stat(file, &st) != 0)
456 cgi_setup_error("404 File Not Found","",
457 "The requested file was not found");
460 if (S_ISDIR(st.st_mode))
462 snprintf(buf, sizeof(buf), "%s/index.html", file);
463 if (!file_exist_stat(buf, &st) || !S_ISREG(st.st_mode))
465 cgi_setup_error("404 File Not Found","",
466 "The requested file was not found");
469 else if (S_ISREG(st.st_mode))
471 snprintf(buf, sizeof(buf), "%s", file);
475 cgi_setup_error("404 File Not Found","",
476 "The requested file was not found");
479 fd = web_open(buf,O_RDONLY,0);
481 cgi_setup_error("404 File Not Found","",
482 "The requested file was not found");
484 printf("HTTP/1.0 200 OK\r\n");
485 if ((p=strrchr_m(buf, '.'))) {
486 if (strcmp(p,".gif")==0) {
487 printf("Content-Type: image/gif\r\n");
488 } else if (strcmp(p,".jpg")==0) {
489 printf("Content-Type: image/jpeg\r\n");
490 } else if (strcmp(p,".png")==0) {
491 printf("Content-Type: image/png\r\n");
492 } else if (strcmp(p,".css")==0) {
493 printf("Content-Type: text/css\r\n");
494 } else if (strcmp(p,".txt")==0) {
495 printf("Content-Type: text/plain\r\n");
497 printf("Content-Type: text/html\r\n");
500 printf("Expires: %s\r\n",
501 http_timestring(talloc_tos(), time(NULL)+EXPIRY_TIME));
503 lang = lang_tdb_current();
505 printf("Content-Language: %s\r\n", lang);
508 printf("Content-Length: %d\r\n\r\n", (int)st.st_size);
509 while ((l=read(fd,buf,sizeof(buf)))>0) {
510 if (fwrite(buf, 1, l, stdout) != l) {
522 * @brief Setup the CGI framework.
524 * Setup the cgi framework, handling the possibility that this program
525 * is either run as a true CGI program with a gateway to a web server, or
526 * is itself a mini web server.
528 void cgi_setup(const char *rootdir, int auth_required)
530 bool authenticated = False;
536 if (chdir(rootdir)) {
537 cgi_setup_error("500 Server Error", "",
538 "chdir failed - the server is not configured correctly");
541 /* Handle the possibility we might be running as non-root */
544 if ((lang=getenv("HTTP_ACCEPT_LANGUAGE"))) {
545 /* if running as a cgi program */
549 /* maybe we are running under a web server */
550 if (getenv("CONTENT_LENGTH") || getenv("REQUEST_METHOD")) {
559 if (!check_access(1, lp_hostsallow(-1), lp_hostsdeny(-1))) {
560 cgi_setup_error("403 Forbidden", "",
561 "Samba is configured to deny access from this client\n<br>Check your \"hosts allow\" and \"hosts deny\" options in smb.conf ");
564 /* we are a mini-web server. We need to read the request from stdin
565 and handle authentication etc */
566 while (fgets(line, sizeof(line)-1, stdin)) {
567 if (line[0] == '\r' || line[0] == '\n') break;
568 if (strnequal(line,"GET ", 4)) {
570 url = SMB_STRDUP(&line[4]);
571 } else if (strnequal(line,"POST ", 5)) {
574 url = SMB_STRDUP(&line[5]);
575 } else if (strnequal(line,"PUT ", 4)) {
577 cgi_setup_error("400 Bad Request", "",
578 "This server does not accept PUT requests");
579 } else if (strnequal(line,"Authorization: ", 15)) {
580 authenticated = cgi_handle_authorization(&line[15]);
581 } else if (strnequal(line,"Content-Length: ", 16)) {
582 content_length = atoi(&line[16]);
583 } else if (strnequal(line,"Accept-Language: ", 17)) {
584 web_set_lang(&line[17]);
586 /* ignore all other requests! */
589 if (auth_required && !authenticated) {
594 cgi_setup_error("400 Bad Request", "",
595 "You must specify a GET or POST request");
599 if ((p = strchr_m(url,' ')) || (p=strchr_m(url,'\t'))) {
602 while (*url && strchr_m("\r\n",url[strlen(url)-1])) {
603 url[strlen(url)-1] = 0;
606 /* anything following a ? in the URL is part of the query string */
607 if ((p=strchr_m(url,'?'))) {
612 string_sub(url, "/swat/", "", 0);
614 if (url[0] != '/' && strstr(url,"..")==0) {
618 printf("HTTP/1.0 200 OK\r\nConnection: close\r\n");
619 printf("Date: %s\r\n", http_timestring(talloc_tos(), time(NULL)));
625 /***************************************************************************
626 return the current pages URL
627 ***************************************************************************/
628 const char *cgi_baseurl(void)
633 return getenv("SCRIPT_NAME");
636 /***************************************************************************
637 return the current pages path info
638 ***************************************************************************/
639 const char *cgi_pathinfo(void)
645 r = getenv("PATH_INFO");
651 /***************************************************************************
652 return the hostname of the client
653 ***************************************************************************/
654 const char *cgi_remote_host(void)
657 return get_peer_name(1,False);
659 return getenv("REMOTE_HOST");
662 /***************************************************************************
663 return the hostname of the client
664 ***************************************************************************/
665 const char *cgi_remote_addr(void)
668 char addr[INET6_ADDRSTRLEN];
669 get_peer_addr(1,addr,sizeof(addr));
670 return talloc_strdup(talloc_tos(), addr);
672 return getenv("REMOTE_ADDR");
676 /***************************************************************************
677 return True if the request was a POST
678 ***************************************************************************/
679 bool cgi_waspost(void)
684 return strequal(getenv("REQUEST_METHOD"), "POST");