2 * CGI form variable and array functions for CUPS.
4 * Copyright 2007-2015 by Apple Inc.
5 * Copyright 1997-2005 by Easy Software Products.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * which should have been included with this file. If this file is
11 * missing or damaged, see the license at "http://www.cups.org/".
15 * Include necessary headers...
19 #include "cgi-private.h"
20 #include <cups/http.h>
27 #define CUPS_SID "org.cups.sid"
31 * Data structure to hold all the CGI form variables and arrays...
34 typedef struct /**** Form variable structure ****/
36 const char *name; /* Name of variable */
37 int nvalues, /* Number of values */
38 avalues; /* Number of values allocated */
39 const char **values; /* Value(s) of variable */
47 static int num_cookies = 0;/* Number of cookies */
48 static cups_option_t *cookies = NULL;/* Cookies */
49 static int form_count = 0, /* Form variable count */
50 form_alloc = 0; /* Number of variables allocated */
51 static _cgi_var_t *form_vars = NULL;
53 static cgi_file_t *form_file = NULL;
61 static void cgi_add_variable(const char *name, int element,
63 static int cgi_compare_variables(const _cgi_var_t *v1,
64 const _cgi_var_t *v2);
65 static _cgi_var_t *cgi_find_variable(const char *name);
66 static void cgi_initialize_cookies(void);
67 static int cgi_initialize_get(void);
68 static int cgi_initialize_multipart(const char *boundary);
69 static int cgi_initialize_post(void);
70 static int cgi_initialize_string(const char *data);
71 static const char *cgi_passwd(const char *prompt);
72 static const char *cgi_set_sid(void);
73 static void cgi_sort_variables(void);
74 static void cgi_unlink_file(void);
78 * 'cgiCheckVariables()' - Check for the presence of "required" variables.
80 * Names may be separated by spaces and/or commas.
83 int /* O - 1 if all variables present, 0 otherwise */
84 cgiCheckVariables(const char *names) /* I - Variables to look for */
86 char name[255], /* Current variable name */
87 *s; /* Pointer in string */
88 const char *val; /* Value of variable */
89 int element; /* Array element number */
95 while (*names != '\0')
97 while (*names == ' ' || *names == ',')
100 for (s = name; *names != '\0' && *names != ' ' && *names != ','; s ++, names ++)
107 if ((s = strrchr(name, '-')) != NULL)
110 element = atoi(s + 1) - 1;
111 val = cgiGetArray(name, element);
114 val = cgiGetVariable(name);
120 return (0); /* Can't be blank, either! */
128 * 'cgiClearVariables()' - Clear all form variables.
132 cgiClearVariables(void)
134 int i, j; /* Looping vars */
135 _cgi_var_t *v; /* Current variable */
138 fputs("DEBUG: cgiClearVariables called.\n", stderr);
140 for (v = form_vars, i = form_count; i > 0; v ++, i --)
142 _cupsStrFree(v->name);
143 for (j = 0; j < v->nvalues; j ++)
145 _cupsStrFree(v->values[j]);
155 * 'cgiGetArray()' - Get an element from a form array.
158 const char * /* O - Element value or NULL */
159 cgiGetArray(const char *name, /* I - Name of array variable */
160 int element) /* I - Element number (0 to N) */
162 _cgi_var_t *var; /* Pointer to variable */
165 if ((var = cgi_find_variable(name)) == NULL)
168 if (element < 0 || element >= var->nvalues)
171 return (_cupsStrRetain(var->values[element]));
176 * 'cgiGetCookie()' - Get a cookie value.
179 const char * /* O - Value or NULL */
180 cgiGetCookie(const char *name) /* I - Name of cookie */
182 return (cupsGetOption(name, num_cookies, cookies));
187 * 'cgiGetFile()' - Get the file (if any) that was submitted in the form.
190 const cgi_file_t * /* O - Attached file or NULL */
198 * 'cgiGetSize()' - Get the size of a form array value.
201 int /* O - Number of elements */
202 cgiGetSize(const char *name) /* I - Name of variable */
204 _cgi_var_t *var; /* Pointer to variable */
207 if ((var = cgi_find_variable(name)) == NULL)
210 return (var->nvalues);
215 * 'cgiGetVariable()' - Get a CGI variable from the database.
217 * Returns NULL if the variable doesn't exist. If the variable is an
218 * array of values, returns the last element.
221 const char * /* O - Value of variable */
222 cgiGetVariable(const char *name) /* I - Name of variable */
224 const _cgi_var_t *var; /* Returned variable */
227 var = cgi_find_variable(name);
231 DEBUG_printf(("cgiGetVariable(\"%s\") is returning NULL...\n", name));
233 DEBUG_printf(("cgiGetVariable(\"%s\") is returning \"%s\"...\n", name,
234 var->values[var->nvalues - 1]));
237 return ((var == NULL) ? NULL : _cupsStrRetain(var->values[var->nvalues - 1]));
242 * 'cgiInitialize()' - Initialize the CGI variable "database".
245 int /* O - Non-zero if there was form data */
248 const char *method, /* Form posting method */
249 *content_type, /* Content-Type of post data */
250 *cups_sid_cookie, /* SID cookie */
251 *cups_sid_form; /* SID form variable */
255 * Setup a password callback for authentication...
258 cupsSetPasswordCB(cgi_passwd);
261 * Set the locale so that times, etc. are formatted properly...
264 setlocale(LC_ALL, "");
268 * Disable output buffering to find bugs...
271 setbuf(stdout, NULL);
278 cgi_initialize_cookies();
280 if ((cups_sid_cookie = cgiGetCookie(CUPS_SID)) == NULL)
282 fputs("DEBUG: " CUPS_SID " cookie not found, initializing!\n", stderr);
283 cups_sid_cookie = cgi_set_sid();
286 fprintf(stderr, "DEBUG: " CUPS_SID " cookie is \"%s\"\n", cups_sid_cookie);
289 * Get the request method (GET or POST)...
292 method = getenv("REQUEST_METHOD");
293 content_type = getenv("CONTENT_TYPE");
298 * Grab form data from the corresponding location...
301 if (!_cups_strcasecmp(method, "GET"))
302 return (cgi_initialize_get());
303 else if (!_cups_strcasecmp(method, "POST") && content_type)
305 const char *boundary = strstr(content_type, "boundary=");
310 if (content_type && !strncmp(content_type, "multipart/form-data; ", 21))
312 if (!cgi_initialize_multipart(boundary))
315 else if (!cgi_initialize_post())
318 if ((cups_sid_form = cgiGetVariable(CUPS_SID)) == NULL ||
319 strcmp(cups_sid_cookie, cups_sid_form))
322 fprintf(stderr, "DEBUG: " CUPS_SID " form variable is \"%s\"\n",
325 fputs("DEBUG: " CUPS_SID " form variable is not present.\n", stderr);
339 * 'cgiIsPOST()' - Determine whether this page was POSTed.
342 int /* O - 1 if POST, 0 if GET */
345 const char *method; /* REQUEST_METHOD environment variable */
348 if ((method = getenv("REQUEST_METHOD")) == NULL)
351 return (!strcmp(method, "POST"));
356 * 'cgiSetArray()' - Set array element N to the specified string.
358 * If the variable array is smaller than (element + 1), the intervening
359 * elements are set to NULL.
363 cgiSetArray(const char *name, /* I - Name of variable */
364 int element, /* I - Element number (0 to N) */
365 const char *value) /* I - Value of variable */
367 int i; /* Looping var */
368 _cgi_var_t *var; /* Returned variable */
371 if (name == NULL || value == NULL || element < 0 || element > 100000)
374 fprintf(stderr, "DEBUG: cgiSetArray: %s[%d]=\"%s\"\n", name, element, value);
376 if ((var = cgi_find_variable(name)) == NULL)
378 cgi_add_variable(name, element, value);
379 cgi_sort_variables();
383 if (element >= var->avalues)
385 const char **temp; /* Temporary pointer */
387 temp = (const char **)realloc((void *)(var->values),
388 sizeof(char *) * (size_t)(element + 16));
392 var->avalues = element + 16;
396 if (element >= var->nvalues)
398 for (i = var->nvalues; i < element; i ++)
399 var->values[i] = NULL;
401 var->nvalues = element + 1;
403 else if (var->values[element])
404 _cupsStrFree((char *)var->values[element]);
406 var->values[element] = _cupsStrAlloc(value);
412 * 'cgiSetCookie()' - Set a cookie value.
416 cgiSetCookie(const char *name, /* I - Name */
417 const char *value, /* I - Value */
418 const char *path, /* I - Path (typically "/") */
419 const char *domain, /* I - Domain name */
420 time_t expires, /* I - Expiration date (0 for session) */
421 int secure) /* I - Require SSL */
423 num_cookies = cupsAddOption(name, value, num_cookies, &cookies);
425 printf("Set-Cookie: %s=%s;", name, value);
427 printf(" path=%s;", path);
429 printf(" domain=%s;", domain);
432 char date[256]; /* Date string */
434 printf(" expires=%s;", httpGetDateString2(expires, date, sizeof(date)));
437 puts(" httponly; secure;");
444 * 'cgiSetSize()' - Set the array size.
448 cgiSetSize(const char *name, /* I - Name of variable */
449 int size) /* I - Number of elements (0 to N) */
451 int i; /* Looping var */
452 _cgi_var_t *var; /* Returned variable */
455 if (name == NULL || size < 0 || size > 100000)
458 if ((var = cgi_find_variable(name)) == NULL)
461 if (size >= var->avalues)
463 const char **temp; /* Temporary pointer */
465 temp = (const char **)realloc((void *)(var->values),
466 sizeof(char *) * (size_t)(size + 16));
470 var->avalues = size + 16;
474 if (size > var->nvalues)
476 for (i = var->nvalues; i < size; i ++)
477 var->values[i] = NULL;
479 else if (size < var->nvalues)
481 for (i = size; i < var->nvalues; i ++)
483 _cupsStrFree((void *)(var->values[i]));
491 * 'cgiSetVariable()' - Set a CGI variable in the database.
493 * If the variable is an array, this truncates the array to a single element.
497 cgiSetVariable(const char *name, /* I - Name of variable */
498 const char *value) /* I - Value of variable */
500 int i; /* Looping var */
501 _cgi_var_t *var; /* Returned variable */
504 if (name == NULL || value == NULL)
507 fprintf(stderr, "cgiSetVariable: %s=\"%s\"\n", name, value);
509 if ((var = cgi_find_variable(name)) == NULL)
511 cgi_add_variable(name, 0, value);
512 cgi_sort_variables();
516 for (i = 0; i < var->nvalues; i ++)
518 _cupsStrFree((char *)var->values[i]);
520 var->values[0] = _cupsStrAlloc(value);
527 * 'cgi_add_variable()' - Add a form variable.
531 cgi_add_variable(const char *name, /* I - Variable name */
532 int element, /* I - Array element number */
533 const char *value) /* I - Variable value */
535 _cgi_var_t *var; /* New variable */
538 if (name == NULL || value == NULL || element < 0 || element > 100000)
541 DEBUG_printf(("cgi_add_variable: Adding variable \'%s\' with value "
542 "\'%s\'...\n", name, value));
544 if (form_count >= form_alloc)
546 _cgi_var_t *temp_vars; /* Temporary form pointer */
550 temp_vars = malloc(sizeof(_cgi_var_t) * 16);
552 temp_vars = realloc(form_vars, (size_t)(form_alloc + 16) * sizeof(_cgi_var_t));
557 form_vars = temp_vars;
561 var = form_vars + form_count;
563 if ((var->values = calloc((size_t)element + 1, sizeof(char *))) == NULL)
566 var->name = _cupsStrAlloc(name);
567 var->nvalues = element + 1;
568 var->avalues = element + 1;
569 var->values[element] = _cupsStrAlloc(value);
576 * 'cgi_compare_variables()' - Compare two variables.
579 static int /* O - Result of comparison */
580 cgi_compare_variables(
581 const _cgi_var_t *v1, /* I - First variable */
582 const _cgi_var_t *v2) /* I - Second variable */
584 return (_cups_strcasecmp(v1->name, v2->name));
589 * 'cgi_find_variable()' - Find a variable.
592 static _cgi_var_t * /* O - Variable pointer or NULL */
593 cgi_find_variable(const char *name) /* I - Name of variable */
595 _cgi_var_t key; /* Search key */
598 if (form_count < 1 || name == NULL)
603 return ((_cgi_var_t *)bsearch(&key, form_vars, (size_t)form_count, sizeof(_cgi_var_t),
604 (int (*)(const void *, const void *))cgi_compare_variables));
609 * 'cgi_initialize_cookies()' - Initialize cookies.
613 cgi_initialize_cookies(void)
615 const char *cookie; /* HTTP_COOKIE environment variable */
616 char name[128], /* Name string */
617 value[512], /* Value string */
618 *ptr; /* Pointer into name/value */
621 if ((cookie = getenv("HTTP_COOKIE")) == NULL)
626 int skip = 0; /* Skip this cookie? */
629 * Skip leading whitespace...
632 while (isspace(*cookie & 255))
641 for (ptr = name; *cookie && *cookie != '=';)
642 if (ptr < (name + sizeof(name) - 1))
664 for (cookie ++, ptr = value; *cookie && *cookie != '\"';)
665 if (ptr < (value + sizeof(value) - 1))
682 for (ptr = value; *cookie && *cookie != ';';)
683 if (ptr < (value + sizeof(value) - 1))
702 * Then add the cookie to an array as long as the name doesn't start with
706 if (name[0] != '$' && !skip)
707 num_cookies = cupsAddOption(name, value, num_cookies, &cookies);
713 * 'cgi_initialize_get()' - Initialize form variables using the GET method.
716 static int /* O - 1 if form data read */
717 cgi_initialize_get(void)
719 char *data; /* Pointer to form data string */
722 DEBUG_puts("cgi_initialize_get: Initializing variables using GET method...");
725 * Check to see if there is anything for us to read...
728 data = getenv("QUERY_STRING");
729 if (data == NULL || strlen(data) == 0)
733 * Parse it out and return...
736 return (cgi_initialize_string(data));
741 * 'cgi_initialize_multipart()' - Initialize variables and file using the POST
744 * TODO: Update to support files > 2GB.
747 static int /* O - 1 if form data was read */
748 cgi_initialize_multipart(
749 const char *boundary) /* I - Boundary string */
751 char line[10240], /* MIME header line */
752 name[1024], /* Form variable name */
753 filename[1024], /* Form filename */
754 mimetype[1024], /* MIME media type */
755 bstring[256], /* Boundary string to look for */
756 *ptr, /* Pointer into name/filename */
757 *end; /* End of buffer */
758 int ch, /* Character from file */
759 fd; /* Temporary file descriptor */
760 size_t blen; /* Length of boundary string */
763 DEBUG_printf(("cgi_initialize_multipart(boundary=\"%s\")\n", boundary));
766 * Read multipart form data until we run out...
773 snprintf(bstring, sizeof(bstring), "\r\n--%s", boundary);
774 blen = strlen(bstring);
776 while (fgets(line, sizeof(line), stdin))
778 if (!strcmp(line, "\r\n"))
781 * End of headers, grab value...
787 * Read an embedded file...
793 * Remove previous file...
800 * Allocate memory for the new file...
803 if ((form_file = calloc(1, sizeof(cgi_file_t))) == NULL)
806 form_file->name = strdup(name);
807 form_file->filename = strdup(filename);
808 form_file->mimetype = strdup(mimetype);
810 fd = cupsTempFd(form_file->tempfile, sizeof(form_file->tempfile));
815 atexit(cgi_unlink_file);
818 * Copy file data to the temp file...
823 while ((ch = getchar()) != EOF)
827 if ((size_t)(ptr - line) >= blen && !memcmp(ptr - blen, bstring, blen))
833 if ((ptr - line - (int)blen) >= 8192)
836 * Write out the first 8k of the buffer...
839 write(fd, line, 8192);
840 memmove(line, line + 8192, (size_t)(ptr - line - 8192));
846 * Write the rest of the data and close the temp file...
850 write(fd, line, (size_t)(ptr - line));
857 * Just get a form variable; the current code only handles
858 * form values up to 10k in size...
862 end = line + sizeof(line) - 1;
864 while ((ch = getchar()) != EOF)
869 if ((size_t)(ptr - line) >= blen && !memcmp(ptr - blen, bstring, blen))
879 * Set the form variable...
882 if ((ptr = strrchr(name, '-')) != NULL && isdigit(ptr[1] & 255))
885 * Set a specific index in the array...
890 cgiSetArray(name, atoi(ptr) - 1, line);
892 else if (cgiGetVariable(name))
895 * Add another element in the array...
898 cgiSetArray(name, cgiGetSize(name), line);
903 * Just set the line...
906 cgiSetVariable(name, line);
911 * Read the rest of the current line...
914 fgets(line, sizeof(line), stdin);
917 * Clear the state vars...
924 else if (!_cups_strncasecmp(line, "Content-Disposition:", 20))
926 if ((ptr = strstr(line + 20, " name=\"")) != NULL)
928 strlcpy(name, ptr + 7, sizeof(name));
930 if ((ptr = strchr(name, '\"')) != NULL)
934 if ((ptr = strstr(line + 20, " filename=\"")) != NULL)
936 strlcpy(filename, ptr + 11, sizeof(filename));
938 if ((ptr = strchr(filename, '\"')) != NULL)
942 else if (!_cups_strncasecmp(line, "Content-Type:", 13))
944 for (ptr = line + 13; isspace(*ptr & 255); ptr ++);
946 strlcpy(mimetype, ptr, sizeof(mimetype));
948 for (ptr = mimetype + strlen(mimetype) - 1;
949 ptr > mimetype && isspace(*ptr & 255);
955 * Return 1 for "form data found"...
963 * 'cgi_initialize_post()' - Initialize variables using the POST method.
966 static int /* O - 1 if form data was read */
967 cgi_initialize_post(void)
969 char *content_length, /* Length of input data (string) */
970 *data; /* Pointer to form data string */
971 size_t length, /* Length of input data */
972 tbytes; /* Total number of bytes read */
973 ssize_t nbytes; /* Number of bytes read this read() */
974 int status; /* Return status */
977 DEBUG_puts("cgi_initialize_post: Initializing variables using POST method...");
980 * Check to see if there is anything for us to read...
983 content_length = getenv("CONTENT_LENGTH");
984 if (content_length == NULL || atoi(content_length) <= 0)
988 * Get the length of the input stream and allocate a buffer for it...
991 length = (size_t)strtol(content_length, NULL, 10);
992 data = malloc(length + 1);
998 * Read the data into the buffer...
1001 for (tbytes = 0; tbytes < length; tbytes += (size_t)nbytes)
1002 if ((nbytes = read(0, data + tbytes, (size_t)(length - tbytes))) < 0)
1004 if (errno != EAGAIN)
1012 else if (nbytes == 0)
1015 * CUPS STR #3176: OpenBSD: Early end-of-file on POST data causes 100% CPU
1017 * This should never happen, but does on OpenBSD. If we see early end-of-
1018 * file, treat this as an error and process no data.
1025 data[length] = '\0';
1031 status = cgi_initialize_string(data);
1034 * Free the data and return...
1044 * 'cgi_initialize_string()' - Initialize form variables from a string.
1047 static int /* O - 1 if form data was processed */
1048 cgi_initialize_string(const char *data) /* I - Form data string */
1050 int done; /* True if we're done reading a form variable */
1051 char *s, /* Pointer to current form string */
1052 ch, /* Temporary character */
1053 name[255], /* Name of form variable */
1054 value[65536]; /* Variable value */
1065 * Loop until we've read all the form data...
1068 while (*data != '\0')
1071 * Get the variable name...
1074 for (s = name; *data != '\0'; data ++)
1077 else if (*data >= ' ' && s < (name + sizeof(name) - 1))
1087 * Read the variable value...
1090 for (s = value, done = 0; !done && *data != '\0'; data ++)
1093 case '&' : /* End of data... */
1097 case '+' : /* Escaped space character */
1098 if (s < (value + sizeof(value) - 1))
1102 case '%' : /* Escaped control character */
1104 * Read the hex code...
1107 if (!isxdigit(data[1] & 255) || !isxdigit(data[2] & 255))
1110 if (s < (value + sizeof(value) - 1))
1116 *s = (char)(ch << 4);
1128 default : /* Other characters come straight through */
1129 if (*data >= ' ' && s < (value + sizeof(value) - 1))
1134 *s = '\0'; /* nul terminate the string */
1137 * Remove trailing whitespace...
1143 while (s >= value && isspace(*s & 255))
1147 * Add the string to the variable "database"...
1150 if ((s = strrchr(name, '-')) != NULL && isdigit(s[1] & 255))
1154 cgiSetArray(name, atoi(s) - 1, value);
1156 else if (cgiGetVariable(name) != NULL)
1157 cgiSetArray(name, cgiGetSize(name), value);
1159 cgiSetVariable(name, value);
1167 * 'cgi_passwd()' - Catch authentication requests and notify the server.
1169 * This function sends a Status header and exits, forcing authentication
1173 static const char * /* O - NULL (no return) */
1174 cgi_passwd(const char *prompt) /* I - Prompt (not used) */
1178 fprintf(stderr, "DEBUG: cgi_passwd(prompt=\"%s\") called!\n",
1179 prompt ? prompt : "(null)");
1182 * Send a 401 (unauthorized) status to the server, so it can notify
1183 * the client that authentication is required.
1186 puts("Status: 401\n");
1190 * This code is never executed, but is present to satisfy the compiler.
1198 * 'cgi_set_sid()' - Set the CUPS session ID.
1201 static const char * /* O - New session ID */
1204 char buffer[512], /* SID data */
1205 sid[33]; /* SID string */
1206 unsigned char sum[16]; /* MD5 sum */
1207 const char *remote_addr, /* REMOTE_ADDR */
1208 *server_name, /* SERVER_NAME */
1209 *server_port; /* SERVER_PORT */
1212 if ((remote_addr = getenv("REMOTE_ADDR")) == NULL)
1213 remote_addr = "REMOTE_ADDR";
1214 if ((server_name = getenv("SERVER_NAME")) == NULL)
1215 server_name = "SERVER_NAME";
1216 if ((server_port = getenv("SERVER_PORT")) == NULL)
1217 server_port = "SERVER_PORT";
1219 CUPS_SRAND(time(NULL));
1220 snprintf(buffer, sizeof(buffer), "%s:%s:%s:%02X%02X%02X%02X%02X%02X%02X%02X",
1221 remote_addr, server_name, server_port,
1222 (unsigned)CUPS_RAND() & 255, (unsigned)CUPS_RAND() & 255,
1223 (unsigned)CUPS_RAND() & 255, (unsigned)CUPS_RAND() & 255,
1224 (unsigned)CUPS_RAND() & 255, (unsigned)CUPS_RAND() & 255,
1225 (unsigned)CUPS_RAND() & 255, (unsigned)CUPS_RAND() & 255);
1226 cupsHashData("md5", (unsigned char *)buffer, strlen(buffer), sum, sizeof(sum));
1228 cgiSetCookie(CUPS_SID, cupsHashString(sum, sizeof(sum), sid, sizeof(sid)), "/", NULL, 0, 0);
1230 return (cupsGetOption(CUPS_SID, num_cookies, cookies));
1235 * 'cgi_sort_variables()' - Sort all form variables for faster lookup.
1239 cgi_sort_variables(void)
1245 DEBUG_puts("cgi_sort_variables: Sorting variables...");
1251 qsort(form_vars, (size_t)form_count, sizeof(_cgi_var_t),
1252 (int (*)(const void *, const void *))cgi_compare_variables);
1255 DEBUG_puts("cgi_sort_variables: Sorted variable list is:");
1256 for (i = 0; i < form_count; i ++)
1257 DEBUG_printf(("cgi_sort_variables: %d: %s (%d) = \"%s\" ...\n", i,
1258 form_vars[i].name, form_vars[i].nvalues,
1259 form_vars[i].values[0]));
1265 * 'cgi_unlink_file()' - Remove the uploaded form.
1269 cgi_unlink_file(void)
1274 * Remove the temporary file...
1277 unlink(form_file->tempfile);
1280 * Free memory used...
1283 free(form_file->name);
1284 free(form_file->filename);
1285 free(form_file->mimetype);