diff --git a/usr.bin/bintrans/bintrans.1 b/usr.bin/bintrans/bintrans.1 index e3ad5813f4cd..cdc819aa7a18 100644 --- a/usr.bin/bintrans/bintrans.1 +++ b/usr.bin/bintrans/bintrans.1 @@ -1,229 +1,239 @@ .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" From: @(#)uuencode.1 8.1 (Berkeley) 6/6/93 .\" $FreeBSD$ .\" .Dd April 18, 2022 .Dt BINTRANS 1 .Os .Sh NAME .Nm bintrans , .Nm uuencode , .Nm uudecode , .Nm b64encode , .Nm b64decode .Nd encode/decode a binary file .Sh SYNOPSIS .Nm .Op algorithm .Op ... .Nm uuencode .Op Fl m .Op Fl r .Op Fl o Ar output_file .Op Ar file .Ar name .Nm uudecode .Op Fl cimprs .Op Ar .Nm uudecode .Op Fl i .Fl o Ar output_file .Nm b64encode .Op Fl r +.Op Fl w Ar column .Op Fl o Ar output_file .Op Ar file .Ar name .Nm b64decode .Op Fl cimprs .Op Ar .Nm b64decode .Op Fl i .Fl o Ar output_file .Op Ar file .Sh DESCRIPTION The .Nm uuencode and .Nm uudecode utilities are used to transmit binary files over transmission mediums that do not support other than simple .Tn ASCII data. The .Nm b64encode utility is synonymous with .Nm uuencode with the .Fl m flag specified. The .Nm b64decode utility is synonymous with .Nm uudecode with the .Fl m flag specified. .Pp The .Nm uuencode utility reads .Ar file (or by default the standard input) and writes an encoded version to the standard output, or .Ar output_file if one has been specified. The encoding uses only printing .Tn ASCII characters and includes the mode of the file and the operand .Ar name for use by .Nm uudecode . .Pp The .Nm uudecode utility transforms .Em uuencoded files (or by default, the standard input) into the original form. The resulting file is named either .Ar name or (depending on options passed to .Nm uudecode ) .Ar output_file and will have the mode of the original file except that setuid and execute bits are not retained. The .Nm uudecode utility ignores any leading and trailing lines. .Pp The following options are available for .Nm uuencode : .Bl -tag -width ident .It Fl m Use the Base64 method of encoding, rather than the traditional .Nm uuencode algorithm. .It Fl r Produce raw output by excluding the initial and final framing lines. .It Fl o Ar output_file Output to .Ar output_file instead of standard output. .El .Pp The following options are available for .Nm uudecode : .Bl -tag -width ident .It Fl c Decode more than one uuencoded file from .Ar file if possible. .It Fl i Do not overwrite files. .It Fl m When used with the .Fl r flag, decode Base64 input instead of traditional .Nm uuencode input. Without .Fl r it has no effect. .It Fl o Ar output_file Output to .Ar output_file instead of any pathname contained in the input data. .It Fl p Decode .Ar file and write output to standard output. .It Fl r Decode raw (or broken) input, which is missing the initial and possibly the final framing lines. The input is assumed to be in the traditional .Nm uuencode encoding, but if the .Fl m flag is used, or if the utility is invoked as .Nm b64decode , then the input is assumed to be in Base64 format. .It Fl s Do not strip output pathname to base filename. By default .Nm uudecode deletes any prefix ending with the last slash '/' for security reasons. .El .Pp +Additionally, +.Nm b64encode +accepts the following option: +.Bl -tag -width ident +.It Fl w Ar column +Wrap encoded output after +.Ar column . +.El +.Pp .Nm is a generic utility that can run any of the aforementioned encoders and decoders. .Sh EXAMPLES The following example packages up a source tree, compresses it, uuencodes it and mails it to a user on another system. When .Nm uudecode is run on the target system, the file ``src_tree.tar.Z'' will be created which may then be uncompressed and extracted into the original tree. .Pp .Bd -literal -offset indent -compact tar cf \- src_tree \&| compress \&| uuencode src_tree.tar.Z \&| mail user@example.com .Ed .Pp The following example unpacks all uuencoded files from your mailbox into your current working directory. .Pp .Bd -literal -offset indent -compact uudecode -c < $MAIL .Ed .Pp The following example extracts a compressed tar archive from your mailbox .Pp .Bd -literal -offset indent -compact uudecode -o /dev/stdout < $MAIL | zcat | tar xfv - .Ed .Sh SEE ALSO .Xr basename 1 , .Xr compress 1 , .Xr mail 1 , .Xr uucp 1 Pq Pa ports/net/freebsd-uucp , .Xr uuencode 5 .Sh HISTORY The .Nm uudecode and .Nm uuencode utilities appeared in .Bx 4.0 . .Sh BUGS Files encoded using the traditional algorithm are expanded by 35% (3 bytes become 4 plus control information). diff --git a/usr.bin/bintrans/uuencode.c b/usr.bin/bintrans/uuencode.c index f2d4b5b2b498..4837d3310578 100644 --- a/usr.bin/bintrans/uuencode.c +++ b/usr.bin/bintrans/uuencode.c @@ -1,235 +1,273 @@ /*- * SPDX-License-Identifier: BSD-3-Clause * * Copyright (c) 1983, 1993 * The Regents of the University of California. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #if 0 #ifndef lint static const char copyright[] = "@(#) Copyright (c) 1983, 1993\n\ The Regents of the University of California. All rights reserved.\n"; #endif /* not lint */ #ifndef lint static char sccsid[] = "@(#)uuencode.c 8.2 (Berkeley) 4/2/94"; #endif /* not lint */ #endif #include __FBSDID("$FreeBSD$"); /* * uuencode [input] output * * Encode a file so it can be mailed to a remote system. */ #include #include #include #include #include +#include #include #include #include #include #include #include #include extern int main_encode(int, char *[]); static void encode(void); static void base64_encode(void); +static int arg_to_col(const char *); static void usage(void); static FILE *output; static int mode; static bool raw; static char **av; +static int columns = 76; int main_encode(int argc, char *argv[]) { struct stat sb; bool base64; int ch; const char *outfile; base64 = false; outfile = NULL; if (strcmp(basename(argv[0]), "b64encode") == 0) base64 = 1; - while ((ch = getopt(argc, argv, "mo:r")) != -1) { + while ((ch = getopt(argc, argv, "mo:rw:")) != -1) { switch (ch) { case 'm': base64 = true; break; case 'o': outfile = optarg; break; case 'r': raw = true; break; + case 'w': + columns = arg_to_col(optarg); + break; case '?': default: usage(); } } argv += optind; argc -= optind; switch (argc) { case 2: /* optional first argument is input file */ if (!freopen(*argv, "r", stdin) || fstat(fileno(stdin), &sb)) err(1, "%s", *argv); #define RWX (S_IRWXU|S_IRWXG|S_IRWXO) mode = sb.st_mode & RWX; ++argv; break; case 1: #define RW (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH) mode = RW & ~umask(RW); break; case 0: default: usage(); } av = argv; if (outfile != NULL) { output = fopen(outfile, "w+"); if (output == NULL) err(1, "unable to open %s for output", outfile); } else output = stdout; if (base64) base64_encode(); else encode(); if (ferror(output)) errx(1, "write error"); exit(0); } /* ENC is the basic 1 character encoding function to make a char printing */ #define ENC(c) ((c) ? ((c) & 077) + ' ': '`') /* * Copy from in to out, encoding in base64 as you go along. */ static void base64_encode(void) { /* - * Output must fit into 80 columns, chunks come in 4, leave 1. + * This buffer's length should be a multiple of 24 bits to avoid "=" + * padding. Once it reached ~1 KB, further expansion didn't improve + * performance for me. */ -#define GROUPS ((80 / 4) - 1) - unsigned char buf[3]; + unsigned char buf[1023]; char buf2[sizeof(buf) * 2 + 1]; size_t n; - int rv, sequence; - - sequence = 0; + unsigned carry = 0; + int rv, written; if (!raw) fprintf(output, "begin-base64 %o %s\n", mode, *av); while ((n = fread(buf, 1, sizeof(buf), stdin))) { - ++sequence; rv = b64_ntop(buf, n, buf2, nitems(buf2)); if (rv == -1) errx(1, "b64_ntop: error encoding base64"); - fprintf(output, "%s%s", buf2, (sequence % GROUPS) ? "" : "\n"); + if (columns == 0) { + fputs(buf2, output); + continue; + } + for (int i = 0; i < rv; i += written) { + written = fprintf(output, "%.*s", columns - carry, + &buf2[i]); + + carry = (carry + written) % columns; + if (carry == 0) + fputc('\n', output); + } } - if (sequence % GROUPS) - fprintf(output, "\n"); + if (columns == 0 || carry != 0) + fputc('\n', output); if (!raw) fprintf(output, "====\n"); } /* * Copy from in to out, encoding as you go along. */ static void encode(void) { int ch, n; char *p; char buf[80]; if (!raw) (void)fprintf(output, "begin %o %s\n", mode, *av); while ((n = fread(buf, 1, 45, stdin))) { ch = ENC(n); if (fputc(ch, output) == EOF) break; for (p = buf; n > 0; n -= 3, p += 3) { /* Pad with nulls if not a multiple of 3. */ if (n < 3) { p[2] = '\0'; if (n < 2) p[1] = '\0'; } ch = *p >> 2; ch = ENC(ch); if (fputc(ch, output) == EOF) break; ch = ((*p << 4) & 060) | ((p[1] >> 4) & 017); ch = ENC(ch); if (fputc(ch, output) == EOF) break; ch = ((p[1] << 2) & 074) | ((p[2] >> 6) & 03); ch = ENC(ch); if (fputc(ch, output) == EOF) break; ch = p[2] & 077; ch = ENC(ch); if (fputc(ch, output) == EOF) break; } if (fputc('\n', output) == EOF) break; } if (ferror(stdin)) errx(1, "read error"); if (!raw) (void)fprintf(output, "%c\nend\n", ENC('\0')); } +static int +arg_to_col(const char *w) +{ + char *ep; + long option; + + errno = 0; + option = strtol(w, &ep, 10); + if (option > INT_MAX) + errno = ERANGE; + else if (ep[0] != '\0') + errno = EINVAL; + if (errno != 0) + err(2, NULL); + + if (option < 0) { + errno = EINVAL; + err(2, "columns argument must be non-negative"); + } + return (option); +} + static void usage(void) { (void)fprintf(stderr, "usage: uuencode [-m] [-o outfile] [infile] remotefile\n" " b64encode [-o outfile] [infile] remotefile\n"); exit(1); }