diff --git a/usr.bin/bintrans/Makefile b/usr.bin/bintrans/Makefile index 49acec470d76..a83c820bd660 100644 --- a/usr.bin/bintrans/Makefile +++ b/usr.bin/bintrans/Makefile @@ -1,24 +1,24 @@ # @(#)Makefile 8.1 (Berkeley) 6/6/93 # $FreeBSD$ .include PROG= bintrans -SRCS= bintrans.c uuencode.c uudecode.c +SRCS= bintrans.c uuencode.c uudecode.c quoted-printable.c MAN= bintrans.1 uuencode.format.5 LINKS+= ${BINDIR}/bintrans ${BINDIR}/uuencode LINKS+= ${BINDIR}/bintrans ${BINDIR}/b64encode LINKS+= ${BINDIR}/bintrans ${BINDIR}/uudecode LINKS+= ${BINDIR}/bintrans ${BINDIR}/b64decode LINKS+= ${BINDIR}/bintrans ${BINDIR}/base64 MLINKS= bintrans.1 uudecode.1 \ bintrans.1 uuencode.1 \ uuencode.format.5 uuencode.5 \ bintrans.1 b64encode.1 \ b64encode.1 b64decode.1 \ b64encode.1 base64.1 HAS_TESTS= SUBDIR.${MK_TESTS}+= tests .include diff --git a/usr.bin/bintrans/bintrans.1 b/usr.bin/bintrans/bintrans.1 index f489eb6fc258..24ce553d94e7 100644 --- a/usr.bin/bintrans/bintrans.1 +++ b/usr.bin/bintrans/bintrans.1 @@ -1,270 +1,283 @@ .\" 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 .Nm base64 .Op Fl d .Op Fl w Ar column .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 base64 utility acts as a base64 decoder when passed the .Fl -decode .Po or .Fl d .Pc flag and as a base64 encoder otherwise. As a decoder it only accepts raw base64 input and as an encoder it does not produce the framing lines. .Nm base64 reads standard input or .Ar file if it is provided and writes to standard output. Options .Fl -wrap .Po or .Fl w .Pc and .Fl -ignore-garbage .Po or .Fl i .Pc are accepted for compatibility with GNU base64, but the latter is unimplemented and silently ignored. .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. +It can also run algorithms that are not available +through a dedicated program: +.Pp +.Nm qp +is a quoted-printable converter +and accepts the following options: +.Bl -tag -width ident +.It Fl u +Decode. +.It Fl o Ar output_file +Output to +.Ar output_file +instead of standard output. .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/bintrans.c b/usr.bin/bintrans/bintrans.c index 435f982ac520..04b3b10d84c8 100644 --- a/usr.bin/bintrans/bintrans.c +++ b/usr.bin/bintrans/bintrans.c @@ -1,155 +1,161 @@ /*- * SPDX-License-Identifier: BSD-2-Clause * * Copyright (c) 2022 The FreeBSD Foundation * * 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. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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. */ #include #include #include #include #include #include #include #include extern int main_decode(int, char *[]); extern int main_encode(int, char *[]); extern int main_base64_decode(const char *); extern int main_base64_encode(const char *, const char *); +extern int main_quotedprintable(int, char*[]); static int search(const char *const); static void usage_base64(bool); static void version_base64(void); static void base64_encode_or_decode(int, char *[]); enum coders { - uuencode, uudecode, b64encode, b64decode, base64 + uuencode, uudecode, b64encode, b64decode, base64, qp }; int main(int argc, char *argv[]) { const char *const progname = getprogname(); int coder = search(progname); if (coder == -1 && argc > 1) { argc--; argv++; coder = search(argv[0]); } switch (coder) { case uuencode: case b64encode: main_encode(argc, argv); break; case uudecode: case b64decode: main_decode(argc, argv); break; case base64: base64_encode_or_decode(argc, argv); break; + case qp: + main_quotedprintable(argc, argv); + break; default: (void)fprintf(stderr, "usage: %1$s ...\n" " %1$s ...\n" - " %1$s ...\n", + " %1$s ...\n" + " %1$s ...\n", progname); exit(EX_USAGE); } } static int search(const char *const progname) { #define DESIGNATE(item) [item] = #item const char *const known[] = { DESIGNATE(uuencode), DESIGNATE(uudecode), DESIGNATE(b64encode), DESIGNATE(b64decode), - DESIGNATE(base64) + DESIGNATE(base64), + DESIGNATE(qp) }; for (size_t i = 0; i < nitems(known); i++) if (strcmp(progname, known[i]) == 0) return ((int)i); return (-1); } static void usage_base64(bool failure) { (void)fputs("usage: base64 [-w col | --wrap=col] " "[-d | --decode] [FILE]\n" " base64 --help\n" " base64 --version\n", stderr); exit(failure ? EXIT_FAILURE : EXIT_SUCCESS); } static void version_base64(void) { (void)fputs("FreeBSD base64\n", stderr); exit(EXIT_SUCCESS); } static void base64_encode_or_decode(int argc, char *argv[]) { int ch; bool decode = false; const char *w = NULL; enum { HELP, VERSION }; static const struct option opts[] = { {"decode", no_argument, NULL, 'd'}, {"ignore-garbage",no_argument, NULL, 'i'}, {"wrap", required_argument, NULL, 'w'}, {"help", no_argument, NULL, HELP}, {"version", no_argument, NULL, VERSION}, {NULL, no_argument, NULL, 0} }; while ((ch = getopt_long(argc, argv, "diw:", opts, NULL)) != -1) switch (ch) { case 'd': decode = true; break; case 'w': w = optarg; break; case VERSION: version_base64(); case HELP: default: usage_base64(ch == '?'); } if (decode) main_base64_decode(argv[optind]); else main_base64_encode(argv[optind], w); } diff --git a/usr.bin/bintrans/mmencode.c b/usr.bin/bintrans/quoted-printable.c similarity index 95% rename from usr.bin/bintrans/mmencode.c rename to usr.bin/bintrans/quoted-printable.c index a391f4d7e1d4..b0e35509a2d9 100644 --- a/usr.bin/bintrans/mmencode.c +++ b/usr.bin/bintrans/quoted-printable.c @@ -1,257 +1,265 @@ /* Copyright (c) 1991 Bell Communications Research, Inc. (Bellcore) Permission to use, copy, modify, and distribute this material for any purpose and without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies, and that the name of Bellcore not be used in advertising or publicity pertaining to this material without the specific, prior written permission of an authorized representative of Bellcore. BELLCORE MAKES NO REPRESENTATIONS ABOUT THE ACCURACY OR SUITABILITY OF THIS MATERIAL FOR ANY PURPOSE. IT IS PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. */ #include #include #include #include #include +extern int main_quotedprintable(int, char *[]); + static int PendingBoundary(char *s, char **Boundaries, int *BoundaryCt) { int i; size_t len; if (s[0] != '-' || s[1] != '-') return (0); for (i = 0; i < *BoundaryCt; ++i) { len = strlen(Boundaries[i]); if (strncmp(s, Boundaries[i], len) == 0) { if (s[len] == '-' && s[len + 1] == '-') *BoundaryCt = i; return (1); } } return (0); } #define basis_hex "0123456789ABCDEF" static const char index_hex[128] = { -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,-1,-1, -1,-1,-1,-1, -1,10,11,12, 13,14,15,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,10,11,12, 13,14,15,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1, -1,-1,-1,-1 }; /* The following version generated complaints on Solaris. */ /* #define hexchar(c) (((c) < 0 || (c) > 127) ? -1 : index_hex[(c)]) */ /* Since we're no longer ever calling it with anything signed, this should work: */ #define hexchar(c) (((c) > 127) ? -1 : index_hex[(c)]) static void toqp(FILE *infile, FILE *outfile) { int c, ct = 0, prevc = 255; while ((c = getc(infile)) != EOF) { if ((c < 32 && (c != '\n' && c != '\t')) || (c == '=') || (c >= 127) /* Following line is to avoid single periods alone on lines, which messes up some dumb smtp implementations, sigh... */ || (ct == 0 && c == '.')) { putc('=', outfile); putc(basis_hex[c >> 4], outfile); putc(basis_hex[c & 0xF], outfile); ct += 3; prevc = 'A'; /* close enough */ } else if (c == '\n') { if (prevc == ' ' || prevc == '\t') { putc('=', outfile); /* soft & hard lines */ putc(c, outfile); } putc(c, outfile); ct = 0; prevc = c; } else { if (c == 'F' && prevc == '\n') { /* HORRIBLE but clever hack suggested by MTR for sendmail-avoidance */ c = getc(infile); if (c == 'r') { c = getc(infile); if (c == 'o') { c = getc(infile); if (c == 'm') { c = getc(infile); if (c == ' ') { /* This is the case we are looking for */ fputs("=46rom", outfile); ct += 6; } else { fputs("From", outfile); ct += 4; } } else { fputs("Fro", outfile); ct += 3; } } else { fputs("Fr", outfile); ct += 2; } } else { putc('F', outfile); ++ct; } ungetc(c, infile); prevc = 'x'; /* close enough -- printable */ } else { /* END horrible hack */ putc(c, outfile); ++ct; prevc = c; } } if (ct > 72) { putc('=', outfile); putc('\n', outfile); ct = 0; prevc = '\n'; } } if (ct) { putc('=', outfile); putc('\n', outfile); } } static void fromqp(FILE *infile, FILE *outfile, char **boundaries, int *boundaryct) { int c1, c2; bool sawnewline = true, neednewline = false; /* The neednewline hack is necessary because the newline leading into a multipart boundary is part of the boundary, not the data */ while ((c1 = getc(infile)) != EOF) { if (sawnewline && boundaries && c1 == '-') { char Buf[200]; unsigned char *s; ungetc(c1, infile); fgets(Buf, sizeof(Buf), infile); if (boundaries && Buf[0] == '-' && Buf[1] == '-' && PendingBoundary(Buf, boundaries, boundaryct)) { return; } /* Not a boundary, now we must treat THIS line as q-p, sigh */ if (neednewline) { putc('\n', outfile); neednewline = false; } for (s = (unsigned char *)Buf; *s; ++s) { if (*s == '=') { if (*++s == 0) break; if (*s == '\n') { /* ignore it */ sawnewline = true; } else { c1 = hexchar(*s); if (*++s == 0) break; c2 = hexchar(*s); putc(c1 << 4 | c2, outfile); } } else { putc(*s, outfile); } } } else { if (neednewline) { putc('\n', outfile); neednewline = false; } if (c1 == '=') { sawnewline = false; c1 = getc(infile); if (c1 == '\n') { /* ignore it */ sawnewline = true; } else { c2 = getc(infile); c1 = hexchar(c1); c2 = hexchar(c2); putc(c1 << 4 | c2, outfile); if (c2 == '\n') sawnewline = true; } } else { if (c1 == '\n') { sawnewline = true; neednewline = true; } else { sawnewline = false; putc(c1, outfile); } } } } if (neednewline) { putc('\n', outfile); neednewline = false; } } +static void +usage(void) +{ + fprintf(stderr, + "usage: bintrans qp [-u] [-o outputfile] [file name]\n"); +} + int -main(int argc, char *argv[]) +main_quotedprintable(int argc, char *argv[]) { int i; bool encode = true; FILE *fp = stdin; FILE *fpo = stdout; for (i = 1; i < argc; ++i) { if (argv[i][0] == '-') { switch (argv[i][1]) { case 'o': if (++i >= argc) { - fprintf(stderr, "mimencode: -o requires a file name.\n"); + fprintf(stderr, "qp: -o requires a file name.\n"); exit(EXIT_FAILURE); } fpo = fopen(argv[i], "w"); if (fpo == NULL) { perror(argv[i]); exit(EXIT_FAILURE); } break; case 'u': encode = false; break; default: - fprintf(stderr, - "Usage: mmencode [-u] [-o outputfile] [file name]\n"); + usage(); exit(EXIT_FAILURE); } } else { fp = fopen(argv[i], "r"); if (fp == NULL) { perror(argv[i]); exit(EXIT_FAILURE); } } } if (encode) toqp(fp, fpo); else fromqp(fp, fpo, NULL, 0); return (0); }