aboutsummaryrefslogtreecommitdiff
path: root/printutils
diff options
context:
space:
mode:
authorBjørn Mork <bjorn@mork.no>2015-05-15 10:20:47 +0200
committerBjørn Mork <bjorn@mork.no>2015-05-15 10:20:47 +0200
commit73b16af8feec390afbabd9356d6e5e83c0390838 (patch)
tree3730020ba2f9caeb9d7815a975af51830b51ce11 /printutils
busybox: imported from http://www.busybox.net/downloads/busybox-1.13.3.tar.bz2busybox-1.13.3
Signed-off-by: Bjørn Mork <bjorn@mork.no>
Diffstat (limited to 'printutils')
-rw-r--r--printutils/Config.in26
-rw-r--r--printutils/Kbuild9
-rw-r--r--printutils/lpd.c282
-rw-r--r--printutils/lpr.c256
4 files changed, 573 insertions, 0 deletions
diff --git a/printutils/Config.in b/printutils/Config.in
new file mode 100644
index 0000000..6912ece
--- /dev/null
+++ b/printutils/Config.in
@@ -0,0 +1,26 @@
+#
+# For a description of the syntax of this configuration file,
+# see scripts/kbuild/config-language.txt.
+#
+
+menu "Print Utilities"
+
+config LPD
+ bool "lpd"
+ default n
+ help
+ lpd is a print spooling daemon.
+
+config LPR
+ bool "lpr"
+ default n
+ help
+ lpr sends files (or standard input) to a print spooling daemon.
+
+config LPQ
+ bool "lpq"
+ default n
+ help
+ lpq is a print spool queue examination and manipulation program.
+
+endmenu
diff --git a/printutils/Kbuild b/printutils/Kbuild
new file mode 100644
index 0000000..008290e
--- /dev/null
+++ b/printutils/Kbuild
@@ -0,0 +1,9 @@
+# Makefile for busybox
+#
+# Licensed under the GPL v2, see the file LICENSE in this tarball.
+
+lib-y :=
+
+lib-$(CONFIG_LPD) += lpd.o
+lib-$(CONFIG_LPR) += lpr.o
+lib-$(CONFIG_LPQ) += lpr.o
diff --git a/printutils/lpd.c b/printutils/lpd.c
new file mode 100644
index 0000000..43c2294
--- /dev/null
+++ b/printutils/lpd.c
@@ -0,0 +1,282 @@
+/* vi: set sw=4 ts=4: */
+/*
+ * micro lpd
+ *
+ * Copyright (C) 2008 by Vladimir Dronnikov <dronnikov@gmail.com>
+ *
+ * Licensed under GPLv2, see file LICENSE in this tarball for details.
+ */
+
+/*
+ * A typical usage of BB lpd looks as follows:
+ * # tcpsvd -E 0 515 lpd [SPOOLDIR] [HELPER-PROG [ARGS...]]
+ *
+ * This starts TCP listener on port 515 (default for LP protocol).
+ * When a client connection is made (via lpr) lpd first changes its
+ * working directory to SPOOLDIR (current dir is the default).
+ *
+ * SPOOLDIR is the spool directory which contains printing queues
+ * and should have the following structure:
+ *
+ * SPOOLDIR/
+ * <queue1>
+ * ...
+ * <queueN>
+ *
+ * <queueX> can be of two types:
+ * A. a printer character device, an ordinary file or a link to such;
+ * B. a directory.
+ *
+ * In case A lpd just dumps the data it receives from client (lpr) to the
+ * end of queue file/device. This is non-spooling mode.
+ *
+ * In case B lpd enters spooling mode. It reliably saves client data along
+ * with control info in two unique files under the queue directory. These
+ * files are named dfAXXXHHHH and cfAXXXHHHH, where XXX is the job number
+ * and HHHH is the client hostname. Unless a printing helper application
+ * is specified lpd is done at this point.
+ *
+ * NB: file names are produced by peer! They actually may be anything at all.
+ * lpd only sanitizes them (by removing most non-alphanumerics).
+ *
+ * If HELPER-PROG (with optional arguments) is specified then lpd continues
+ * to process client data:
+ * 1. it reads and parses control file (cfA...). The parse process
+ * results in setting environment variables whose values were passed
+ * in control file; when parsing is complete, lpd deletes control file.
+ * 2. it spawns specified helper application. It is then
+ * the helper application who is responsible for both actual printing
+ * and deleting of processed data file.
+ *
+ * A good lpr passes control files which when parsed provides the following
+ * variables:
+ * $H = host which issues the job
+ * $P = user who prints
+ * $C = class of printing (what is printed on banner page)
+ * $J = the name of the job
+ * $L = print banner page
+ * $M = the user to whom a mail should be sent if a problem occurs
+ *
+ * We specifically filter out and NOT provide:
+ * $l = name of datafile ("dfAxxx") - file whose content are to be printed
+ *
+ * lpd provides $DATAFILE instead - the ACTUAL name
+ * of the datafile under which it was saved.
+ * $l would be not reliable (you would be at mercy of remote peer).
+ *
+ * Thus, a typical helper can be something like this:
+ * #!/bin/sh
+ * cat ./"$DATAFILE" >/dev/lp0
+ * mv -f ./"$DATAFILE" save/
+ */
+
+#include "libbb.h"
+
+// strip argument of bad chars
+static char *sane(char *str)
+{
+ char *s = str;
+ char *p = s;
+ while (*s) {
+ if (isalnum(*s) || '-' == *s || '_' == *s) {
+ *p++ = *s;
+ }
+ s++;
+ }
+ *p = '\0';
+ return str;
+}
+
+static char *xmalloc_read_stdin(void)
+{
+ // SECURITY:
+ size_t max = 4 * 1024; // more than enough for commands!
+ return xmalloc_reads(STDIN_FILENO, NULL, &max);
+}
+
+int lpd_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
+int lpd_main(int argc UNUSED_PARAM, char *argv[])
+{
+ int spooling = spooling; // for compiler
+ char *s, *queue;
+ char *filenames[2];
+
+ // goto spool directory
+ if (*++argv)
+ xchdir(*argv++);
+
+ // error messages of xfuncs will be sent over network
+ xdup2(STDOUT_FILENO, STDERR_FILENO);
+
+ // nullify ctrl/data filenames
+ memset(filenames, 0, sizeof(filenames));
+
+ // read command
+ s = queue = xmalloc_read_stdin();
+ // we understand only "receive job" command
+ if (2 != *queue) {
+ unsupported_cmd:
+ printf("Command %02x %s\n",
+ (unsigned char)s[0], "is not supported");
+ goto err_exit;
+ }
+
+ // parse command: "2 | QUEUE_NAME | '\n'"
+ queue++;
+ // protect against "/../" attacks
+ // *strchrnul(queue, '\n') = '\0'; - redundant, sane() will do
+ if (!*sane(queue))
+ return EXIT_FAILURE;
+
+ // queue is a directory -> chdir to it and enter spooling mode
+ spooling = chdir(queue) + 1; // 0: cannot chdir, 1: done
+ // we don't free(s), we might need "queue" var later
+
+ while (1) {
+ char *fname;
+ int fd;
+ // int is easier than ssize_t: can use xatoi_u,
+ // and can correctly display error returns (-1)
+ int expected_len, real_len;
+
+ // signal OK
+ safe_write(STDOUT_FILENO, "", 1);
+
+ // get subcommand
+ // valid s must be of form: "SUBCMD | LEN | space | FNAME"
+ // N.B. we bail out on any error
+ s = xmalloc_read_stdin();
+ if (!s) { // (probably) EOF
+ char *p, *q, var[2];
+
+ // non-spooling mode or no spool helper specified
+ if (!spooling || !*argv)
+ return EXIT_SUCCESS; // the only non-error exit
+ // spooling mode but we didn't see both ctrlfile & datafile
+ if (spooling != 7)
+ goto err_exit; // reject job
+
+ // spooling mode and spool helper specified -> exec spool helper
+ // (we exit 127 if helper cannot be executed)
+ var[1] = '\0';
+ // read and delete ctrlfile
+ q = xmalloc_xopen_read_close(filenames[0], NULL);
+ unlink(filenames[0]);
+ // provide datafile name
+ // we can use leaky setenv since we are about to exec or exit
+ xsetenv("DATAFILE", filenames[1]);
+ // parse control file by "\n"
+ while ((p = strchr(q, '\n')) != NULL && isalpha(*q)) {
+ *p++ = '\0';
+ // q is a line of <SYM><VALUE>,
+ // we are setting environment string <SYM>=<VALUE>.
+ // Ignoring "l<datafile>", exporting others:
+ if (*q != 'l') {
+ var[0] = *q++;
+ xsetenv(var, q);
+ }
+ q = p; // next line
+ }
+ // helper should not talk over network.
+ // this call reopens stdio fds to "/dev/null"
+ // (no daemonization is done)
+ bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO | DAEMON_ONLY_SANITIZE, NULL);
+ BB_EXECVP(*argv, argv);
+ exit(127);
+ }
+
+ // validate input.
+ // we understand only "control file" or "data file" cmds
+ if (2 != s[0] && 3 != s[0])
+ goto unsupported_cmd;
+ if (spooling & (1 << (s[0]-1))) {
+ printf("Duplicated subcommand\n");
+ goto err_exit;
+ }
+ // get filename
+ *strchrnul(s, '\n') = '\0';
+ fname = strchr(s, ' ');
+ if (!fname) {
+// bad_fname:
+ printf("No or bad filename\n");
+ goto err_exit;
+ }
+ *fname++ = '\0';
+// // s[0]==2: ctrlfile, must start with 'c'
+// // s[0]==3: datafile, must start with 'd'
+// if (fname[0] != s[0] + ('c'-2))
+// goto bad_fname;
+ // get length
+ expected_len = bb_strtou(s + 1, NULL, 10);
+ if (errno || expected_len < 0) {
+ printf("Bad length\n");
+ goto err_exit;
+ }
+ if (2 == s[0] && expected_len > 16 * 1024) {
+ // SECURITY:
+ // ctrlfile can't be big (we want to read it back later!)
+ printf("File is too big\n");
+ goto err_exit;
+ }
+
+ // open the file
+ if (spooling) {
+ // spooling mode: dump both files
+ // job in flight has mode 0200 "only writable"
+ sane(fname);
+ fd = open3_or_warn(fname, O_CREAT | O_WRONLY | O_TRUNC | O_EXCL, 0200);
+ if (fd < 0)
+ goto err_exit;
+ filenames[s[0] - 2] = xstrdup(fname);
+ } else {
+ // non-spooling mode:
+ // 2: control file (ignoring), 3: data file
+ fd = -1;
+ if (3 == s[0])
+ fd = xopen(queue, O_RDWR | O_APPEND);
+ }
+
+ // signal OK
+ safe_write(STDOUT_FILENO, "", 1);
+
+ // copy the file
+ real_len = bb_copyfd_size(STDIN_FILENO, fd, expected_len);
+ if (real_len != expected_len) {
+ printf("Expected %d but got %d bytes\n",
+ expected_len, real_len);
+ goto err_exit;
+ }
+ // get EOF indicator, see whether it is NUL (ok)
+ // (and don't trash s[0]!)
+ if (safe_read(STDIN_FILENO, &s[1], 1) != 1 || s[1] != 0) {
+ // don't send error msg to peer - it obviously
+ // doesn't follow the protocol, so probably
+ // it can't understand us either
+ goto err_exit;
+ }
+
+ if (spooling) {
+ // chmod completely downloaded file as "readable+writable"
+ fchmod(fd, 0600);
+ // accumulate dump state
+ // N.B. after all files are dumped spooling should be 1+2+4==7
+ spooling |= (1 << (s[0]-1)); // bit 1: ctrlfile; bit 2: datafile
+ }
+
+ free(s);
+ close(fd); // NB: can do close(-1). Who cares?
+
+ // NB: don't do "signal OK" write here, it will be done
+ // at the top of the loop
+ } // while (1)
+
+ err_exit:
+ // don't keep corrupted files
+ if (spooling) {
+#define i spooling
+ for (i = 2; --i >= 0; )
+ if (filenames[i])
+ unlink(filenames[i]);
+ }
+ return EXIT_FAILURE;
+}
diff --git a/printutils/lpr.c b/printutils/lpr.c
new file mode 100644
index 0000000..25cbcbc
--- /dev/null
+++ b/printutils/lpr.c
@@ -0,0 +1,256 @@
+/* vi: set sw=4 ts=4: */
+/*
+ * bare bones version of lpr & lpq: BSD printing utilities
+ *
+ * Copyright (C) 2008 by Vladimir Dronnikov <dronnikov@gmail.com>
+ *
+ * Original idea and code:
+ * Walter Harms <WHarms@bfs.de>
+ *
+ * Licensed under GPLv2, see file LICENSE in this tarball for details.
+ *
+ * See RFC 1179 for protocol description.
+ */
+#include "libbb.h"
+
+/*
+ * LPD returns binary 0 on success.
+ * Otherwise it returns error message.
+ */
+static void get_response_or_say_and_die(int fd, const char *errmsg)
+{
+ ssize_t sz;
+ char buf[128];
+
+ buf[0] = ' ';
+ sz = safe_read(fd, buf, 1);
+ if ('\0' != buf[0]) {
+ // request has failed
+ // try to make sure last char is '\n', but do not add
+ // superfluous one
+ sz = full_read(fd, buf + 1, 126);
+ bb_error_msg("error while %s%s", errmsg,
+ (sz > 0 ? ". Server said:" : ""));
+ if (sz > 0) {
+ // sz = (bytes in buf) - 1
+ if (buf[sz] != '\n')
+ buf[++sz] = '\n';
+ safe_write(STDERR_FILENO, buf, sz + 1);
+ }
+ xfunc_die();
+ }
+}
+
+int lpqr_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
+int lpqr_main(int argc UNUSED_PARAM, char *argv[])
+{
+ enum {
+ OPT_P = 1 << 0, // -P queue[@host[:port]]. If no -P is given use $PRINTER, then "lp@localhost:515"
+ OPT_U = 1 << 1, // -U username
+
+ LPR_V = 1 << 2, // -V: be verbose
+ LPR_h = 1 << 3, // -h: want banner printed
+ LPR_C = 1 << 4, // -C class: job "class" (? supposedly printed on banner)
+ LPR_J = 1 << 5, // -J title: the job title for the banner page
+ LPR_m = 1 << 6, // -m: send mail back to user
+
+ LPQ_SHORT_FMT = 1 << 2, // -s: short listing format
+ LPQ_DELETE = 1 << 3, // -d: delete job(s)
+ LPQ_FORCE = 1 << 4, // -f: force waiting job(s) to be printed
+ };
+ char tempfile[sizeof("/tmp/lprXXXXXX")];
+ const char *job_title;
+ const char *printer_class = ""; // printer class, max 32 char
+ const char *queue; // name of printer queue
+ const char *server = "localhost"; // server[:port] of printer queue
+ char *hostname;
+ // N.B. IMHO getenv("USER") can be way easily spoofed!
+ const char *user = bb_getpwuid(NULL, -1, getuid());
+ unsigned job;
+ unsigned opts;
+ int fd;
+
+ // parse options
+ // TODO: set opt_complementary: s,d,f are mutually exclusive
+ opts = getopt32(argv,
+ (/*lp*/'r' == applet_name[2]) ? "P:U:VhC:J:m" : "P:U:sdf"
+ , &queue, &user
+ , &printer_class, &job_title
+ );
+ argv += optind;
+
+ // if queue is not specified -> use $PRINTER
+ if (!(opts & OPT_P))
+ queue = getenv("PRINTER");
+ // if queue is still not specified ->
+ if (!queue) {
+ // ... queue defaults to "lp"
+ // server defaults to "localhost"
+ queue = "lp";
+ // if queue is specified ->
+ } else {
+ // queue name is to the left of '@'
+ char *s = strchr(queue, '@');
+ if (s) {
+ // server name is to the right of '@'
+ *s = '\0';
+ server = s + 1;
+ }
+ }
+
+ // do connect
+ fd = create_and_connect_stream_or_die(server, 515);
+
+ //
+ // LPQ ------------------------
+ //
+ if (/*lp*/'q' == applet_name[2]) {
+ char cmd;
+ // force printing of every job still in queue
+ if (opts & LPQ_FORCE) {
+ cmd = 1;
+ goto command;
+ // delete job(s)
+ } else if (opts & LPQ_DELETE) {
+ fdprintf(fd, "\x5" "%s %s", queue, user);
+ while (*argv) {
+ fdprintf(fd, " %s", *argv++);
+ }
+ bb_putchar('\n');
+ // dump current jobs status
+ // N.B. periodical polling should be achieved
+ // via "watch -n delay lpq"
+ // They say it's the UNIX-way :)
+ } else {
+ cmd = (opts & LPQ_SHORT_FMT) ? 3 : 4;
+ command:
+ fdprintf(fd, "%c" "%s\n", cmd, queue);
+ bb_copyfd_eof(fd, STDOUT_FILENO);
+ }
+
+ return EXIT_SUCCESS;
+ }
+
+ //
+ // LPR ------------------------
+ //
+ if (opts & LPR_V)
+ bb_error_msg("connected to server");
+
+ job = getpid() % 1000;
+ hostname = safe_gethostname();
+
+ // no files given on command line? -> use stdin
+ if (!*argv)
+ *--argv = (char *)"-";
+
+ fdprintf(fd, "\x2" "%s\n", queue);
+ get_response_or_say_and_die(fd, "setting queue");
+
+ // process files
+ do {
+ unsigned cflen;
+ int dfd;
+ struct stat st;
+ char *c;
+ char *remote_filename;
+ char *controlfile;
+
+ // if data file is stdin, we need to dump it first
+ if (LONE_DASH(*argv)) {
+ strcpy(tempfile, "/tmp/lprXXXXXX");
+ dfd = mkstemp(tempfile);
+ if (dfd < 0)
+ bb_perror_msg_and_die("mkstemp");
+ bb_copyfd_eof(STDIN_FILENO, dfd);
+ xlseek(dfd, 0, SEEK_SET);
+ *argv = (char*)bb_msg_standard_input;
+ } else {
+ dfd = xopen(*argv, O_RDONLY);
+ }
+
+ /* "The name ... should start with ASCII "cfA",
+ * followed by a three digit job number, followed
+ * by the host name which has constructed the file."
+ * We supply 'c' or 'd' as needed for control/data file. */
+ remote_filename = xasprintf("fA%03u%s", job, hostname);
+
+ // create control file
+ // TODO: all lines but 2 last are constants! How we can use this fact?
+ controlfile = xasprintf(
+ "H" "%.32s\n" "P" "%.32s\n" /* H HOST, P USER */
+ "C" "%.32s\n" /* C CLASS - printed on banner page (if L cmd is also given) */
+ "J" "%.99s\n" /* J JOBNAME */
+ /* "class name for banner page and job name
+ * for banner page commands must precede L command" */
+ "L" "%.32s\n" /* L USER - print banner page, with given user's name */
+ "M" "%.32s\n" /* M WHOM_TO_MAIL */
+ "l" "d%.31s\n" /* l DATA_FILE_NAME ("dfAxxx") */
+ , hostname, user
+ , printer_class /* can be "" */
+ , ((opts & LPR_J) ? job_title : *argv)
+ , (opts & LPR_h) ? user : ""
+ , (opts & LPR_m) ? user : ""
+ , remote_filename
+ );
+ // delete possible "\nX\n" patterns
+ c = controlfile;
+ cflen = (unsigned)strlen(controlfile);
+ while ((c = strchr(c, '\n')) != NULL) {
+ if (c[1] && c[2] == '\n') {
+ /* can't use strcpy, results are undefined */
+ memmove(c, c+2, cflen - (c-controlfile) - 1);
+ cflen -= 2;
+ } else {
+ c++;
+ }
+ }
+
+ // send control file
+ if (opts & LPR_V)
+ bb_error_msg("sending control file");
+ /* "Acknowledgement processing must occur as usual
+ * after the command is sent." */
+ fdprintf(fd, "\x2" "%u c%s\n", cflen, remote_filename);
+ get_response_or_say_and_die(fd, "sending control file");
+ /* "Once all of the contents have
+ * been delivered, an octet of zero bits is sent as
+ * an indication that the file being sent is complete.
+ * A second level of acknowledgement processing
+ * must occur at this point." */
+ full_write(fd, controlfile, cflen + 1); /* writes NUL byte too */
+ get_response_or_say_and_die(fd, "sending control file");
+
+ // send data file, with name "dfaXXX"
+ if (opts & LPR_V)
+ bb_error_msg("sending data file");
+ st.st_size = 0; /* paranoia: fstat may theoretically fail */
+ fstat(dfd, &st);
+ fdprintf(fd, "\x3" "%"OFF_FMT"u d%s\n", st.st_size, remote_filename);
+ get_response_or_say_and_die(fd, "sending data file");
+ if (bb_copyfd_size(dfd, fd, st.st_size) != st.st_size) {
+ // We're screwed. We sent less bytes than we advertised.
+ bb_error_msg_and_die("local file changed size?!");
+ }
+ write(fd, "", 1); // send ACK
+ get_response_or_say_and_die(fd, "sending data file");
+
+ // delete temporary file if we dumped stdin
+ if (*argv == (char*)bb_msg_standard_input)
+ unlink(tempfile);
+
+ // cleanup
+ close(fd);
+ free(remote_filename);
+ free(controlfile);
+
+ // say job accepted
+ if (opts & LPR_V)
+ bb_error_msg("job accepted");
+
+ // next, please!
+ job = (job + 1) % 1000;
+ } while (*++argv);
+
+ return EXIT_SUCCESS;
+}