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"
24 #define MAX_VARIABLES 10000
26 /* set the expiry on fixed pages */
27 #define EXPIRY_TIME (60*60*24*7)
30 extern void print_title(char *fmt
, ...);
38 static struct cgi_var variables
[MAX_VARIABLES
];
39 static int num_variables
;
40 static int content_length
;
41 static int request_post
;
42 static char *query_string
;
43 static const char *baseurl
;
44 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;
89 URL encoded strings can have a '+', which should be replaced with a space
91 (This was in rfc1738_unescape(), but that broke the squid helper)
94 static void plus_to_space_unescape(char *buf
)
98 while ((p
=strchr_m(p
,'+')))
102 /***************************************************************************
103 load all the variables passed to the CGI program. May have multiple variables
104 with the same name and the same or different values. Takes a file parameter
105 for simulating CGI invocation eg loading saved preferences.
106 ***************************************************************************/
107 void cgi_load_variables(void)
114 #ifdef DEBUG_COMMENTS
117 d_printf("<!== Start dump in cgi_load_variables() %s ==>\n",__FILE__
);
120 if (!content_length
) {
121 p
= getenv("CONTENT_LENGTH");
124 len
= content_length
;
130 ((s
=getenv("REQUEST_METHOD")) &&
131 strequal(s
,"POST")))) {
132 while (len
&& (line
=grab_line(f
, &len
))) {
133 p
= strchr_m(line
,'=');
138 variables
[num_variables
].name
= SMB_STRDUP(line
);
139 variables
[num_variables
].value
= SMB_STRDUP(p
+1);
143 if (!variables
[num_variables
].name
||
144 !variables
[num_variables
].value
)
147 plus_to_space_unescape(variables
[num_variables
].value
);
148 rfc1738_unescape(variables
[num_variables
].value
);
149 plus_to_space_unescape(variables
[num_variables
].name
);
150 rfc1738_unescape(variables
[num_variables
].name
);
152 #ifdef DEBUG_COMMENTS
153 printf("<!== POST var %s has value \"%s\" ==>\n",
154 variables
[num_variables
].name
,
155 variables
[num_variables
].value
);
159 if (num_variables
== MAX_VARIABLES
) break;
164 open("/dev/null", O_RDWR
);
166 if ((s
=query_string
) || (s
=getenv("QUERY_STRING"))) {
167 for (tok
=strtok(s
,"&;");tok
;tok
=strtok(NULL
,"&;")) {
168 p
= strchr_m(tok
,'=');
173 variables
[num_variables
].name
= SMB_STRDUP(tok
);
174 variables
[num_variables
].value
= SMB_STRDUP(p
+1);
176 if (!variables
[num_variables
].name
||
177 !variables
[num_variables
].value
)
180 plus_to_space_unescape(variables
[num_variables
].value
);
181 rfc1738_unescape(variables
[num_variables
].value
);
182 plus_to_space_unescape(variables
[num_variables
].name
);
183 rfc1738_unescape(variables
[num_variables
].name
);
185 #ifdef DEBUG_COMMENTS
186 printf("<!== Commandline var %s has value \"%s\" ==>\n",
187 variables
[num_variables
].name
,
188 variables
[num_variables
].value
);
191 if (num_variables
== MAX_VARIABLES
) break;
195 #ifdef DEBUG_COMMENTS
196 printf("<!== End dump in cgi_load_variables() ==>\n");
199 /* variables from the client are in UTF-8 - convert them
200 to our internal unix charset before use */
201 for (i
=0;i
<num_variables
;i
++) {
204 convert_string(CH_UTF8
, CH_UNIX
,
205 variables
[i
].name
, -1,
206 dest
, sizeof(dest
), True
);
207 free(variables
[i
].name
);
208 variables
[i
].name
= SMB_STRDUP(dest
);
210 convert_string(CH_UTF8
, CH_UNIX
,
211 variables
[i
].value
, -1,
212 dest
, sizeof(dest
), True
);
213 free(variables
[i
].value
);
214 variables
[i
].value
= SMB_STRDUP(dest
);
219 /***************************************************************************
220 find a variable passed via CGI
221 Doesn't quite do what you think in the case of POST text variables, because
222 if they exist they might have a value of "" or even " ", depending on the
223 browser. Also doesn't allow for variables[] containing multiple variables
224 with the same name and the same or different values.
225 ***************************************************************************/
227 const char *cgi_variable(const char *name
)
231 for (i
=0;i
<num_variables
;i
++)
232 if (strcmp(variables
[i
].name
, name
) == 0)
233 return variables
[i
].value
;
237 /***************************************************************************
238 Version of the above that can't return a NULL pointer.
239 ***************************************************************************/
241 const char *cgi_variable_nonull(const char *name
)
243 const char *var
= cgi_variable(name
);
251 /***************************************************************************
252 tell a browser about a fatal error in the http processing
253 ***************************************************************************/
254 static void cgi_setup_error(const char *err
, const char *header
, const char *info
)
257 /* damn browsers don't like getting cut off before they give a request */
259 while (fgets(line
, sizeof(line
)-1, stdin
)) {
260 if (strnequal(line
,"GET ", 4) ||
261 strnequal(line
,"POST ", 5) ||
262 strnequal(line
,"PUT ", 4)) {
268 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
);
275 /***************************************************************************
276 tell a browser about a fatal authentication error
277 ***************************************************************************/
278 static void cgi_auth_error(void)
281 cgi_setup_error("401 Authorization Required",
282 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
283 "You must be authenticated to use this service");
285 printf("Content-Type: text/html\r\n");
287 printf("\r\n<HTML><HEAD><TITLE>SWAT</TITLE></HEAD>\n");
288 printf("<BODY><H1>Installation Error</H1>\n");
289 printf("SWAT must be installed via inetd. It cannot be run as a CGI script<p>\n");
290 printf("</BODY></HTML>\r\n");
295 /***************************************************************************
296 authenticate when we are running as a CGI
297 ***************************************************************************/
298 static void cgi_web_auth(void)
300 const char *user
= getenv("REMOTE_USER");
302 const char *head
= "Content-Type: text/html\r\n\r\n<HTML><BODY><H1>SWAT installation Error</H1>\n";
303 const char *tail
= "</BODY></HTML>\r\n";
306 printf("%sREMOTE_USER not set. Not authenticated by web server.<br>%s\n",
311 pwd
= getpwnam_alloc(NULL
, user
);
313 printf("%sCannot find user %s<br>%s\n", head
, user
, tail
);
319 if (geteuid() != pwd
->pw_uid
|| getuid() != pwd
->pw_uid
) {
320 printf("%sFailed to become user %s - uid=%d/%d<br>%s\n",
321 head
, user
, (int)geteuid(), (int)getuid(), tail
);
328 /***************************************************************************
329 handle a http authentication line
330 ***************************************************************************/
331 static BOOL
cgi_handle_authorization(char *line
)
334 fstring user
, user_pass
;
335 struct passwd
*pass
= NULL
;
337 if (!strnequal(line
,"Basic ", 6)) {
341 while (line
[0] == ' ') line
++;
342 base64_decode_inplace(line
);
343 if (!(p
=strchr_m(line
,':'))) {
345 * Always give the same error so a cracker
346 * cannot tell why we fail.
352 convert_string(CH_UTF8
, CH_UNIX
,
354 user
, sizeof(user
), True
);
356 convert_string(CH_UTF8
, CH_UNIX
,
358 user_pass
, sizeof(user_pass
), True
);
361 * Try and get the user from the UNIX password file.
364 pass
= getpwnam_alloc(NULL
, user
);
367 * Validate the password they have given.
370 if NT_STATUS_IS_OK(pass_check(pass
, user
, user_pass
,
371 strlen(user_pass
), NULL
, False
)) {
378 if ( initgroups(pass
->pw_name
, pass
->pw_gid
) != 0 )
381 become_user_permanently(pass
->pw_uid
, pass
->pw_gid
);
383 /* Save the users name */
384 C_user
= SMB_STRDUP(user
);
391 cgi_setup_error("401 Bad Authorization",
392 "WWW-Authenticate: Basic realm=\"SWAT\"\r\n",
393 "username or password incorrect");
399 /***************************************************************************
401 ***************************************************************************/
404 if (geteuid() == 0) {
411 /***************************************************************************
412 return a ptr to the users name
413 ***************************************************************************/
414 char *cgi_user_name(void)
420 /***************************************************************************
421 handle a file download
422 ***************************************************************************/
423 static void cgi_download(char *file
)
431 /* sanitise the filename */
432 for (i
=0;file
[i
];i
++) {
433 if (!isalnum((int)file
[i
]) && !strchr_m("/.-_", file
[i
])) {
434 cgi_setup_error("404 File Not Found","",
435 "Illegal character in filename");
439 if (sys_stat(file
, &st
) != 0)
441 cgi_setup_error("404 File Not Found","",
442 "The requested file was not found");
445 if (S_ISDIR(st
.st_mode
))
447 snprintf(buf
, sizeof(buf
), "%s/index.html", file
);
448 if (!file_exist(buf
, &st
) || !S_ISREG(st
.st_mode
))
450 cgi_setup_error("404 File Not Found","",
451 "The requested file was not found");
454 else if (S_ISREG(st
.st_mode
))
456 snprintf(buf
, sizeof(buf
), "%s", file
);
460 cgi_setup_error("404 File Not Found","",
461 "The requested file was not found");
464 fd
= web_open(buf
,O_RDONLY
,0);
466 cgi_setup_error("404 File Not Found","",
467 "The requested file was not found");
469 printf("HTTP/1.0 200 OK\r\n");
470 if ((p
=strrchr_m(buf
, '.'))) {
471 if (strcmp(p
,".gif")==0) {
472 printf("Content-Type: image/gif\r\n");
473 } else if (strcmp(p
,".jpg")==0) {
474 printf("Content-Type: image/jpeg\r\n");
475 } else if (strcmp(p
,".png")==0) {
476 printf("Content-Type: image/png\r\n");
477 } else if (strcmp(p
,".css")==0) {
478 printf("Content-Type: text/css\r\n");
479 } else if (strcmp(p
,".txt")==0) {
480 printf("Content-Type: text/plain\r\n");
482 printf("Content-Type: text/html\r\n");
485 printf("Expires: %s\r\n", http_timestring(time(NULL
)+EXPIRY_TIME
));
487 lang
= lang_tdb_current();
489 printf("Content-Language: %s\r\n", lang
);
492 printf("Content-Length: %d\r\n\r\n", (int)st
.st_size
);
493 while ((l
=read(fd
,buf
,sizeof(buf
)))>0) {
494 fwrite(buf
, 1, l
, stdout
);
504 * @brief Setup the CGI framework.
506 * Setup the cgi framework, handling the possibility that this program
507 * is either run as a true CGI program with a gateway to a web server, or
508 * is itself a mini web server.
510 void cgi_setup(const char *rootdir
, int auth_required
)
512 BOOL authenticated
= False
;
518 if (chdir(rootdir
)) {
519 cgi_setup_error("500 Server Error", "",
520 "chdir failed - the server is not configured correctly");
523 /* Handle the possibility we might be running as non-root */
526 if ((lang
=getenv("HTTP_ACCEPT_LANGUAGE"))) {
527 /* if running as a cgi program */
531 /* maybe we are running under a web server */
532 if (getenv("CONTENT_LENGTH") || getenv("REQUEST_METHOD")) {
541 if (!check_access(1, lp_hostsallow(-1), lp_hostsdeny(-1))) {
542 cgi_setup_error("403 Forbidden", "",
543 "Samba is configured to deny access from this client\n<br>Check your \"hosts allow\" and \"hosts deny\" options in smb.conf ");
546 /* we are a mini-web server. We need to read the request from stdin
547 and handle authentication etc */
548 while (fgets(line
, sizeof(line
)-1, stdin
)) {
549 if (line
[0] == '\r' || line
[0] == '\n') break;
550 if (strnequal(line
,"GET ", 4)) {
552 url
= SMB_STRDUP(&line
[4]);
553 } else if (strnequal(line
,"POST ", 5)) {
556 url
= SMB_STRDUP(&line
[5]);
557 } else if (strnequal(line
,"PUT ", 4)) {
559 cgi_setup_error("400 Bad Request", "",
560 "This server does not accept PUT requests");
561 } else if (strnequal(line
,"Authorization: ", 15)) {
562 authenticated
= cgi_handle_authorization(&line
[15]);
563 } else if (strnequal(line
,"Content-Length: ", 16)) {
564 content_length
= atoi(&line
[16]);
565 } else if (strnequal(line
,"Accept-Language: ", 17)) {
566 web_set_lang(&line
[17]);
568 /* ignore all other requests! */
571 if (auth_required
&& !authenticated
) {
576 cgi_setup_error("400 Bad Request", "",
577 "You must specify a GET or POST request");
581 if ((p
= strchr_m(url
,' ')) || (p
=strchr_m(url
,'\t'))) {
584 while (*url
&& strchr_m("\r\n",url
[strlen(url
)-1])) {
585 url
[strlen(url
)-1] = 0;
588 /* anything following a ? in the URL is part of the query string */
589 if ((p
=strchr_m(url
,'?'))) {
594 string_sub(url
, "/swat/", "", 0);
596 if (url
[0] != '/' && strstr(url
,"..")==0) {
600 printf("HTTP/1.0 200 OK\r\nConnection: close\r\n");
601 printf("Date: %s\r\n", http_timestring(time(NULL
)));
607 /***************************************************************************
608 return the current pages URL
609 ***************************************************************************/
610 const char *cgi_baseurl(void)
615 return getenv("SCRIPT_NAME");
618 /***************************************************************************
619 return the current pages path info
620 ***************************************************************************/
621 const char *cgi_pathinfo(void)
627 r
= getenv("PATH_INFO");
633 /***************************************************************************
634 return the hostname of the client
635 ***************************************************************************/
636 char *cgi_remote_host(void)
639 return get_peer_name(1,False
);
641 return getenv("REMOTE_HOST");
644 /***************************************************************************
645 return the hostname of the client
646 ***************************************************************************/
647 char *cgi_remote_addr(void)
650 return get_peer_addr(1);
652 return getenv("REMOTE_ADDR");
656 /***************************************************************************
657 return True if the request was a POST
658 ***************************************************************************/
659 BOOL
cgi_waspost(void)
664 return strequal(getenv("REQUEST_METHOD"), "POST");