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 2 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, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include "web/swat_proto.h"
25 #define MAX_VARIABLES 10000
27 /* set the expiry on fixed pages */
28 #define EXPIRY_TIME (60*60*24*7)
31 extern void print_title(char *fmt
, ...);
39 static struct cgi_var variables
[MAX_VARIABLES
];
40 static int num_variables
;
41 static int content_length
;
42 static int request_post
;
43 static char *query_string
;
44 static const char *baseurl
;
45 static char *pathinfo
;
48 static BOOL inetd_server
;
49 static BOOL got_request
;
51 static char *grab_line(FILE *f
, int *cl
)
62 if (len
== 0) len
= 1024;
64 ret2
= (char *)SMB_REALLOC_KEEP_OLD_ON_ERROR(ret
, len
);
65 if (!ret2
) return ret
;
77 if (c
== '\r') continue;
79 if (strchr_m("\n&", c
)) break;
92 URL encoded strings can have a '+', which should be replaced with a space
94 (This was in rfc1738_unescape(), but that broke the squid helper)
97 static void plus_to_space_unescape(char *buf
)
101 while ((p
=strchr_m(p
,'+')))
105 /***************************************************************************
106 load all the variables passed to the CGI program. May have multiple variables
107 with the same name and the same or different values. Takes a file parameter
108 for simulating CGI invocation eg loading saved preferences.
109 ***************************************************************************/
110 void cgi_load_variables(void)
117 #ifdef DEBUG_COMMENTS
120 d_printf("<!== Start dump in cgi_load_variables() %s ==>\n",__FILE__
);
123 if (!content_length
) {
124 p
= getenv("CONTENT_LENGTH");
127 len
= content_length
;
133 ((s
=getenv("REQUEST_METHOD")) &&
134 strequal(s
,"POST")))) {
135 while (len
&& (line
=grab_line(f
, &len
))) {
136 p
= strchr_m(line
,'=');
141 variables
[num_variables
].name
= SMB_STRDUP(line
);
142 variables
[num_variables
].value
= SMB_STRDUP(p
+1);
146 if (!variables
[num_variables
].name
||
147 !variables
[num_variables
].value
)
150 plus_to_space_unescape(variables
[num_variables
].value
);
151 rfc1738_unescape(variables
[num_variables
].value
);
152 plus_to_space_unescape(variables
[num_variables
].name
);
153 rfc1738_unescape(variables
[num_variables
].name
);
155 #ifdef DEBUG_COMMENTS
156 printf("<!== POST var %s has value \"%s\" ==>\n",
157 variables
[num_variables
].name
,
158 variables
[num_variables
].value
);
162 if (num_variables
== MAX_VARIABLES
) break;
167 open("/dev/null", O_RDWR
);
169 if ((s
=query_string
) || (s
=getenv("QUERY_STRING"))) {
170 for (tok
=strtok(s
,"&;");tok
;tok
=strtok(NULL
,"&;")) {
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
++) {
207 convert_string(CH_UTF8
, CH_UNIX
,
208 variables
[i
].name
, -1,
209 dest
, sizeof(dest
), True
);
210 free(variables
[i
].name
);
211 variables
[i
].name
= SMB_STRDUP(dest
);
213 convert_string(CH_UTF8
, CH_UNIX
,
214 variables
[i
].value
, -1,
215 dest
, sizeof(dest
), True
);
216 free(variables
[i
].value
);
217 variables
[i
].value
= SMB_STRDUP(dest
);
222 /***************************************************************************
223 find a variable passed via CGI
224 Doesn't quite do what you think in the case of POST text variables, because
225 if they exist they might have a value of "" or even " ", depending on the
226 browser. Also doesn't allow for variables[] containing multiple variables
227 with the same name and the same or different values.
228 ***************************************************************************/
230 const char *cgi_variable(const char *name
)
234 for (i
=0;i
<num_variables
;i
++)
235 if (strcmp(variables
[i
].name
, name
) == 0)
236 return variables
[i
].value
;
240 /***************************************************************************
241 Version of the above that can't return a NULL pointer.
242 ***************************************************************************/
244 const char *cgi_variable_nonull(const char *name
)
246 const char *var
= cgi_variable(name
);
254 /***************************************************************************
255 tell a browser about a fatal error in the http processing
256 ***************************************************************************/
257 static void cgi_setup_error(const char *err
, const char *header
, const char *info
)
260 /* damn browsers don't like getting cut off before they give a request */
262 while (fgets(line
, sizeof(line
)-1, stdin
)) {
263 if (strnequal(line
,"GET ", 4) ||
264 strnequal(line
,"POST ", 5) ||
265 strnequal(line
,"PUT ", 4)) {
271 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
);
278 /***************************************************************************
279 tell a browser about a fatal authentication error
280 ***************************************************************************/
281 static void cgi_auth_error(void)
284 cgi_setup_error("401 Authorization Required",
285 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
286 "You must be authenticated to use this service");
288 printf("Content-Type: text/html\r\n");
290 printf("\r\n<HTML><HEAD><TITLE>SWAT</TITLE></HEAD>\n");
291 printf("<BODY><H1>Installation Error</H1>\n");
292 printf("SWAT must be installed via inetd. It cannot be run as a CGI script<p>\n");
293 printf("</BODY></HTML>\r\n");
298 /***************************************************************************
299 authenticate when we are running as a CGI
300 ***************************************************************************/
301 static void cgi_web_auth(void)
303 const char *user
= getenv("REMOTE_USER");
305 const char *head
= "Content-Type: text/html\r\n\r\n<HTML><BODY><H1>SWAT installation Error</H1>\n";
306 const char *tail
= "</BODY></HTML>\r\n";
309 printf("%sREMOTE_USER not set. Not authenticated by web server.<br>%s\n",
314 pwd
= getpwnam_alloc(NULL
, user
);
316 printf("%sCannot find user %s<br>%s\n", head
, user
, tail
);
320 C_user
= SMB_STRDUP(user
);
323 C_pass
= secrets_fetch_generic("root", "SWAT");
324 if (C_pass
== NULL
) {
325 char *tmp_pass
= NULL
;
326 tmp_pass
= generate_random_str(16);
327 if (tmp_pass
== NULL
) {
328 printf("%sFailed to create random nonce for "
329 "SWAT session\n<br>%s\n", head
, tail
);
332 secrets_store_generic("root", "SWAT", tmp_pass
);
333 C_pass
= SMB_STRDUP(tmp_pass
);
337 if (geteuid() != pwd
->pw_uid
|| getuid() != pwd
->pw_uid
) {
338 printf("%sFailed to become user %s - uid=%d/%d<br>%s\n",
339 head
, user
, (int)geteuid(), (int)getuid(), tail
);
346 /***************************************************************************
347 handle a http authentication line
348 ***************************************************************************/
349 static BOOL
cgi_handle_authorization(char *line
)
352 fstring user
, user_pass
;
353 struct passwd
*pass
= NULL
;
355 if (!strnequal(line
,"Basic ", 6)) {
359 while (line
[0] == ' ') line
++;
360 base64_decode_inplace(line
);
361 if (!(p
=strchr_m(line
,':'))) {
363 * Always give the same error so a cracker
364 * cannot tell why we fail.
370 convert_string(CH_UTF8
, CH_UNIX
,
372 user
, sizeof(user
), True
);
374 convert_string(CH_UTF8
, CH_UNIX
,
376 user_pass
, sizeof(user_pass
), True
);
379 * Try and get the user from the UNIX password file.
382 pass
= getpwnam_alloc(NULL
, user
);
385 * Validate the password they have given.
388 if NT_STATUS_IS_OK(pass_check(pass
, user
, user_pass
,
389 strlen(user_pass
), NULL
, False
)) {
396 if ( initgroups(pass
->pw_name
, pass
->pw_gid
) != 0 )
399 become_user_permanently(pass
->pw_uid
, pass
->pw_gid
);
401 /* Save the users name */
402 C_user
= SMB_STRDUP(user
);
403 C_pass
= SMB_STRDUP(user_pass
);
410 cgi_setup_error("401 Bad Authorization",
411 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
412 "username or password incorrect");
418 /***************************************************************************
420 ***************************************************************************/
423 if (geteuid() == 0) {
430 /***************************************************************************
431 return a ptr to the users name
432 ***************************************************************************/
433 char *cgi_user_name(void)
438 /***************************************************************************
439 return a ptr to the users password
440 ***************************************************************************/
441 char *cgi_user_pass(void)
446 /***************************************************************************
447 handle a file download
448 ***************************************************************************/
449 static void cgi_download(char *file
)
457 /* sanitise the filename */
458 for (i
=0;file
[i
];i
++) {
459 if (!isalnum((int)file
[i
]) && !strchr_m("/.-_", file
[i
])) {
460 cgi_setup_error("404 File Not Found","",
461 "Illegal character in filename");
465 if (sys_stat(file
, &st
) != 0)
467 cgi_setup_error("404 File Not Found","",
468 "The requested file was not found");
471 if (S_ISDIR(st
.st_mode
))
473 snprintf(buf
, sizeof(buf
), "%s/index.html", file
);
474 if (!file_exist(buf
, &st
) || !S_ISREG(st
.st_mode
))
476 cgi_setup_error("404 File Not Found","",
477 "The requested file was not found");
480 else if (S_ISREG(st
.st_mode
))
482 snprintf(buf
, sizeof(buf
), "%s", file
);
486 cgi_setup_error("404 File Not Found","",
487 "The requested file was not found");
490 fd
= web_open(buf
,O_RDONLY
,0);
492 cgi_setup_error("404 File Not Found","",
493 "The requested file was not found");
495 printf("HTTP/1.0 200 OK\r\n");
496 if ((p
=strrchr_m(buf
, '.'))) {
497 if (strcmp(p
,".gif")==0) {
498 printf("Content-Type: image/gif\r\n");
499 } else if (strcmp(p
,".jpg")==0) {
500 printf("Content-Type: image/jpeg\r\n");
501 } else if (strcmp(p
,".png")==0) {
502 printf("Content-Type: image/png\r\n");
503 } else if (strcmp(p
,".css")==0) {
504 printf("Content-Type: text/css\r\n");
505 } else if (strcmp(p
,".txt")==0) {
506 printf("Content-Type: text/plain\r\n");
508 printf("Content-Type: text/html\r\n");
511 printf("Expires: %s\r\n", http_timestring(time(NULL
)+EXPIRY_TIME
));
513 lang
= lang_tdb_current();
515 printf("Content-Language: %s\r\n", lang
);
518 printf("Content-Length: %d\r\n\r\n", (int)st
.st_size
);
519 while ((l
=read(fd
,buf
,sizeof(buf
)))>0) {
520 fwrite(buf
, 1, l
, stdout
);
530 * @brief Setup the CGI framework.
532 * Setup the cgi framework, handling the possibility that this program
533 * is either run as a true CGI program with a gateway to a web server, or
534 * is itself a mini web server.
536 void cgi_setup(const char *rootdir
, int auth_required
)
538 BOOL authenticated
= False
;
544 if (chdir(rootdir
)) {
545 cgi_setup_error("500 Server Error", "",
546 "chdir failed - the server is not configured correctly");
549 /* Handle the possibility we might be running as non-root */
552 if ((lang
=getenv("HTTP_ACCEPT_LANGUAGE"))) {
553 /* if running as a cgi program */
557 /* maybe we are running under a web server */
558 if (getenv("CONTENT_LENGTH") || getenv("REQUEST_METHOD")) {
567 if (!check_access(1, lp_hostsallow(-1), lp_hostsdeny(-1))) {
568 cgi_setup_error("403 Forbidden", "",
569 "Samba is configured to deny access from this client\n<br>Check your \"hosts allow\" and \"hosts deny\" options in smb.conf ");
572 /* we are a mini-web server. We need to read the request from stdin
573 and handle authentication etc */
574 while (fgets(line
, sizeof(line
)-1, stdin
)) {
575 if (line
[0] == '\r' || line
[0] == '\n') break;
576 if (strnequal(line
,"GET ", 4)) {
578 url
= SMB_STRDUP(&line
[4]);
579 } else if (strnequal(line
,"POST ", 5)) {
582 url
= SMB_STRDUP(&line
[5]);
583 } else if (strnequal(line
,"PUT ", 4)) {
585 cgi_setup_error("400 Bad Request", "",
586 "This server does not accept PUT requests");
587 } else if (strnequal(line
,"Authorization: ", 15)) {
588 authenticated
= cgi_handle_authorization(&line
[15]);
589 } else if (strnequal(line
,"Content-Length: ", 16)) {
590 content_length
= atoi(&line
[16]);
591 } else if (strnequal(line
,"Accept-Language: ", 17)) {
592 web_set_lang(&line
[17]);
594 /* ignore all other requests! */
597 if (auth_required
&& !authenticated
) {
602 cgi_setup_error("400 Bad Request", "",
603 "You must specify a GET or POST request");
607 if ((p
= strchr_m(url
,' ')) || (p
=strchr_m(url
,'\t'))) {
610 while (*url
&& strchr_m("\r\n",url
[strlen(url
)-1])) {
611 url
[strlen(url
)-1] = 0;
614 /* anything following a ? in the URL is part of the query string */
615 if ((p
=strchr_m(url
,'?'))) {
620 string_sub(url
, "/swat/", "", 0);
622 if (url
[0] != '/' && strstr(url
,"..")==0) {
626 printf("HTTP/1.0 200 OK\r\nConnection: close\r\n");
627 printf("Date: %s\r\n", http_timestring(time(NULL
)));
633 /***************************************************************************
634 return the current pages URL
635 ***************************************************************************/
636 const char *cgi_baseurl(void)
641 return getenv("SCRIPT_NAME");
644 /***************************************************************************
645 return the current pages path info
646 ***************************************************************************/
647 const char *cgi_pathinfo(void)
653 r
= getenv("PATH_INFO");
659 /***************************************************************************
660 return the hostname of the client
661 ***************************************************************************/
662 char *cgi_remote_host(void)
665 return get_peer_name(1,False
);
667 return getenv("REMOTE_HOST");
670 /***************************************************************************
671 return the hostname of the client
672 ***************************************************************************/
673 char *cgi_remote_addr(void)
676 return get_peer_addr(1);
678 return getenv("REMOTE_ADDR");
682 /***************************************************************************
683 return True if the request was a POST
684 ***************************************************************************/
685 BOOL
cgi_waspost(void)
690 return strequal(getenv("REQUEST_METHOD"), "POST");