ar: hopefully fix out-of-bounds read in get_header_ar()
[oweals/busybox.git] / archival / ar.c
index 27dfadd1db62cb3a6bf426957c0e41297556d86f..f4edeb087c2cf7aa8661d06687e58aadb4170b07 100644 (file)
 /* vi: set sw=4 ts=4: */
 /*
- * Mini ar implementation for busybox 
+ * Mini ar implementation for busybox
  *
  * Copyright (C) 2000 by Glenn McGrath
- * Written by Glenn McGrath <bug1@netconnect.com.au> 1 June 2000
  *
  * Based in part on BusyBox tar, Debian dpkg-deb and GNU ar.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
+ * Archive creation support:
+ * Copyright (C) 2010 Nokia Corporation. All rights reserved.
+ * Written by Alexander Shishkin.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- * Last modified 10 June 2000
+ * There is no single standard to adhere to so ar may not portable
+ * between different systems
+ * http://www.unix-systems.org/single_unix_specification_v2/xcu/ar.html
  */
+//config:config AR
+//config:      bool "ar (9.5 kb)"
+//config:      default n  # needs to be improved to be able to replace binutils ar
+//config:      help
+//config:      ar is an archival utility program used to create, modify, and
+//config:      extract contents from archives. In practice, it is used exclusively
+//config:      for object module archives used by compilers.
+//config:
+//config:      Unless you have a specific application which requires ar, you should
+//config:      probably say N here: most compilers come with their own ar utility.
+//config:
+//config:config FEATURE_AR_LONG_FILENAMES
+//config:      bool "Support long filenames (not needed for debs)"
+//config:      default y
+//config:      depends on AR
+//config:      help
+//config:      By default the ar format can only store the first 15 characters
+//config:      of the filename, this option removes that limitation.
+//config:      It supports the GNU ar long filename method which moves multiple long
+//config:      filenames into a the data section of a new ar entry.
+//config:
+//config:config FEATURE_AR_CREATE
+//config:      bool "Support archive creation"
+//config:      default y
+//config:      depends on AR
+//config:      help
+//config:      This enables archive creation (-c and -r) with busybox ar.
 
+//applet:IF_AR(APPLET(ar, BB_DIR_USR_BIN, BB_SUID_DROP))
 
-#include <stdio.h>
-#include <fcntl.h>
-#include <errno.h>
-#include <ctype.h>
-#include <time.h>
-#include <utime.h>
-#include <sys/types.h>
-#include "internal.h"
-
-#define AR_BLOCK_SIZE 60
-#define AR_PRESERVE_DATE 1     /* preserve original dates */
-#define AR_VERBOSE       2     /* be verbose */
-#define AR_DISPLAY       4     /* display contents */
-#define AR_EXT_TO_FILE   8     /* extract contents of archive */
-#define AR_EXT_TO_STDOUT 16    /* extract to stdout */
-
-#define BB_DECLARE_EXTERN
-#define bb_need_io_error
-#include "messages.c"
-
-struct ArHeader {                              /* Byte Offset */
-       char ar_name[16];                       /*  0-15 */
-       char ar_date[12];                       /* 16-27 */
-       char ar_uid[6], ar_gid[6];      /* 28-39 */
-       char ar_mode[8];                        /* 40-47 */
-       char ar_size[10];                       /* 48-57 */
-       char ar_fmag[2];                        /* 58-59 */
-};
-typedef struct ArHeader ArHeader;
-
-struct ArInfo {
-       char name[17];                          /* File name */
-       time_t date;                            /* long int, No of seconds since epoch */
-       uid_t uid;                                      /* unsigned int, Numeric UID */
-       gid_t gid;                                      /* unsigned int, Numeric GID */
-       mode_t mode;                            /* unsigned int, Unix mode */
-       size_t size;                            /* int, Size of the file */
-};
-typedef struct ArInfo ArInfo;
-
-static const char ar_usage[] = "ar [optxvV] archive [filenames] \n"
-#ifndef BB_FEATURE_TRIVIAL_HELP
-       "\nExtract or list files from an ar archive.\n\n"
-       "Options:\n"
-       "\to\t\tpreserve original dates\n"
-       "\tp\t\textract to stdout\n"
-       "\tt\t\tlist\n"
-       "\tx\t\textract\n"
-       "\tv\t\tverbosely list files processed\n"
-#endif
-       ;
+//kbuild:lib-$(CONFIG_AR) += ar.o
 
-/*
- * Display details of a file, verbosly if funct=2   
- */
-static void displayEntry(struct ArInfo *entry, int funct)
-{
-       /* TODO convert mode to string */
-       if ((funct & AR_VERBOSE) == AR_VERBOSE)
-               printf("%i %i/%i %8i %s ", entry->mode, entry->uid, entry->gid,
-                          entry->size, timeString(entry->date));
-       printf("%s\n", entry->name);
-}
+//usage:#define ar_trivial_usage
+//usage:       "[-o] [-v] [-p] [-t] [-x] ARCHIVE FILES"
+//usage:#define ar_full_usage "\n\n"
+//usage:       "Extract or list FILES from an ar archive\n"
+//usage:     "\n       -o      Preserve original dates"
+//usage:     "\n       -p      Extract to stdout"
+//usage:     "\n       -t      List"
+//usage:     "\n       -x      Extract"
+//usage:     "\n       -v      Verbose"
 
-/* this is from tar.c remove later*/
-static long getOctal(const char *cp, int size)
+#include "libbb.h"
+#include "bb_archive.h"
+#include "ar.h"
+
+#if ENABLE_FEATURE_AR_CREATE
+/* filter out entries with same names as specified on the command line */
+static char FAST_FUNC filter_replaceable(archive_handle_t *handle)
 {
-        long val = 0;
-
-        for(;(size > 0) && (*cp == ' '); cp++, size--);
-        if ((size == 0) || !isOctal(*cp))
-                return -1;
-        for(; (size > 0) && isOctal(*cp); size--) {
-                val = val * 8 + *cp++ - '0';
-        }
-        for (;(size > 0) && (*cp == ' '); cp++, size--);
-        if ((size > 0) && *cp)
-                return -1;
-        return val;
+       if (find_list_entry(handle->accept, handle->file_header->name))
+               return EXIT_FAILURE;
+
+       return EXIT_SUCCESS;
 }
 
-/*
- * Converts from the char based struct to a new struct with stricter types
- */
-static int processArHeader(struct ArHeader *rawHeader, struct ArInfo *header)
+static void output_ar_header(archive_handle_t *handle)
 {
-       int count2;
-       int count;
-       
-       /* check end of header marker is valid */
-       if ((rawHeader->ar_fmag[0]!='`') || (rawHeader->ar_fmag[1]!='\n')) 
-               return(FALSE); 
-
-       /* convert filename */ 
-       for (count = 0; count < 16; count++) {
-               /* allow spaces in filename except at the end */
-               if (rawHeader->ar_name[count] == ' ') {
-                       for (count2 = count; count2 < 16; count2++)
-                               if (!isspace(rawHeader->ar_name[count2]))
-                                       break;
-                       if (count2 >= 16)
-                               break;
-               }
-               /* GNU ar uses '/' as an end of filename marker */
-               if (rawHeader->ar_name[count] == '/')
-                       break;
-               header->name[count] = rawHeader->ar_name[count];
+       /* GNU ar 2.19.51.0.14 creates malformed archives
+        * if input files are >10G. It also truncates files >4GB
+        * (uses "size mod 4G"). We abort in this case:
+        * We could add support for up to 10G files, but this is unlikely to be useful.
+        * Note that unpacking side limits all fields to "unsigned int" data type,
+        * and treats "all ones" as an error indicator. Thus max we allow here is UINT_MAX-1.
+        */
+       enum {
+               /* for 2nd field: mtime */
+               MAX11CHARS = UINT_MAX > 0xffffffff ? (unsigned)99999999999 : UINT_MAX-1,
+               /* for last field: filesize */
+               MAX10CHARS = UINT_MAX > 0xffffffff ? (unsigned)9999999999 : UINT_MAX-1,
+       };
+
+       struct file_header_t *fh = handle->file_header;
+
+       if (handle->offset & 1) {
+               xwrite(handle->src_fd, "\n", 1);
+               handle->offset++;
        }
-       header->name[count] = '\0';
-       header->date = atoi(rawHeader->ar_date);
-       header->uid = atoi(rawHeader->ar_uid);
-       header->gid = atoi(rawHeader->ar_gid);
-       header->mode = getOctal(rawHeader->ar_mode, sizeof(rawHeader->ar_mode));
-       header->size = atoi(rawHeader->ar_size);
-       return (TRUE);
+
+       /* Careful! The widths should be exact. Fields must be separated */
+       if (sizeof(off_t) > 4 && fh->size > (off_t)MAX10CHARS) {
+               bb_error_msg_and_die("'%s' is bigger than ar can handle", fh->name);
+       }
+       fdprintf(handle->src_fd, "%-16.16s%-12lu%-6u%-6u%-8o%-10"OFF_FMT"u`\n",
+                       fh->name,
+                       (sizeof(time_t) > 4 && fh->mtime > MAX11CHARS) ? (long)0 : (long)fh->mtime,
+                       fh->uid > 99999 ? 0 : (int)fh->uid,
+                       fh->gid > 99999 ? 0 : (int)fh->gid,
+                       (int)fh->mode & 07777777,
+                       fh->size
+       );
+
+       handle->offset += AR_HEADER_LEN;
 }
 
 /*
- * Copy size bytes from current position if srcFd to current position in dstFd
- * taken from tarExtractRegularFile in tar.c, remove later
+ * when replacing files in an existing archive, copy from the
+ * original archive those files that are to be left intact
  */
-static int copySubFile(int srcFd, int dstFd, int copySize)
+static void FAST_FUNC copy_data(archive_handle_t *handle)
 {
-       int readSize, writeSize, doneSize;
-       char buffer[BUFSIZ];
-
-       while (copySize > 0) {
-               if (copySize > BUFSIZ)
-                       readSize = BUFSIZ;
-               else
-                       readSize = copySize;
-               writeSize = fullRead(srcFd, buffer, readSize);
-               if (writeSize <= 0) {
-                       errorMsg(io_error, "copySubFile :", strerror(errno));
-                       return (FALSE);
-               }
-               doneSize = fullWrite(dstFd, buffer, writeSize);
-               if (doneSize <= 0) {
-                       errorMsg(io_error, "copySubFile :", strerror(errno));
-                       return (FALSE);
-               }
-               copySize -= doneSize;
-       }
-       return (TRUE);
+       archive_handle_t *out_handle = handle->ar__out;
+       struct file_header_t *fh = handle->file_header;
+
+       out_handle->file_header = fh;
+       output_ar_header(out_handle);
+
+       bb_copyfd_exact_size(handle->src_fd, out_handle->src_fd, fh->size);
+       out_handle->offset += fh->size;
 }
 
-/*
- * Extract the file described in ArInfo to the specified path 
- * set the new files uid, gid and mode 
- */
-static int extractToFile(struct ArInfo *file, int funct, int srcFd, const char *path)
+static int write_ar_header(archive_handle_t *handle)
 {
-       int dstFd, temp;
-       struct stat tmpStat;
-       char *pathname = NULL;
-       struct utimbuf newtime;
-       
-       if ((temp = isDirectory(path, TRUE, &tmpStat)) != TRUE) {
-               if (!createPath(path, 0777)) {
-                       fatalError("Cannot extract to specified path");
-                       return (FALSE);
-               }
-       }
-       temp = (strlen(path) + 16);
-       pathname = (char *) xmalloc(temp);
-       pathname = strcpy(pathname, path);
-       pathname = strcat(pathname, file->name);
-       dstFd = device_open(pathname, O_WRONLY | O_CREAT);
-       temp = copySubFile(srcFd, dstFd, file->size);
-       fchown(dstFd, file->uid, file->gid);
-       fchmod(dstFd, file->mode);
-       close(dstFd);
-       if ((funct&AR_PRESERVE_DATE)==AR_PRESERVE_DATE) 
-               newtime.modtime=file->date;
-       else
-               newtime.modtime=time(0);
-       newtime.actime=time(0);
-       temp = utime(pathname, &newtime);
-       return (TRUE);
+       char *fn;
+       char fn_h[17]; /* 15 + "/" + NUL */
+       struct stat st;
+       int fd;
+
+       fn = llist_pop(&handle->accept);
+       if (!fn)
+               return -1;
+
+       xstat(fn, &st);
+
+       handle->file_header->mtime = st.st_mtime;
+       handle->file_header->uid = st.st_uid;
+       handle->file_header->gid = st.st_gid;
+       handle->file_header->mode = st.st_mode;
+       handle->file_header->size = st.st_size;
+       handle->file_header->name = fn_h;
+//TODO: if ENABLE_FEATURE_AR_LONG_FILENAMES...
+       sprintf(fn_h, "%.15s/", bb_basename(fn));
+
+       output_ar_header(handle);
+
+       fd = xopen(fn, O_RDONLY);
+       bb_copyfd_exact_size(fd, handle->src_fd, st.st_size);
+       close(fd);
+       handle->offset += st.st_size;
+
+       return 0;
 }
 
-/*
- * Return a file descriptor for the specified file and do error checks
- */
-static int getArFd(char *filename)
+static int write_ar_archive(archive_handle_t *handle)
 {
-        int arFd;
-        char arVersion[8];
+       struct stat st;
+       archive_handle_t *out_handle;
 
-        arFd = open(filename, O_RDONLY);
-        if (arFd < 0) { 
-                errorMsg("Error opening '%s': %s\n", filename, strerror(errno));
-               return (FALSE);
+       xfstat(handle->src_fd, &st, handle->ar__name);
+
+       /* if archive exists, create a new handle for output.
+        * we create it in place of the old one.
+        */
+       if (st.st_size != 0) {
+               out_handle = init_handle();
+               xunlink(handle->ar__name);
+               out_handle->src_fd = xopen(handle->ar__name, O_WRONLY | O_CREAT | O_TRUNC);
+               out_handle->accept = handle->accept;
+       } else {
+               out_handle = handle;
+       }
+
+       handle->ar__out = out_handle;
+
+       xwrite(out_handle->src_fd, AR_MAGIC "\n", AR_MAGIC_LEN + 1);
+       out_handle->offset += AR_MAGIC_LEN + 1;
+
+       /* skip to the end of the archive if we have to append stuff */
+       if (st.st_size != 0) {
+               handle->filter = filter_replaceable;
+               handle->action_data = copy_data;
+               unpack_ar_archive(handle);
+       }
+
+       while (write_ar_header(out_handle) == 0)
+               continue;
+
+       /* optional, since we exit right after we return */
+       if (ENABLE_FEATURE_CLEAN_UP) {
+               close(handle->src_fd);
+               if (out_handle->src_fd != handle->src_fd)
+                       close(out_handle->src_fd);
        }
-        if (fullRead(arFd, arVersion, 8) <= 0) {
-                errorMsg( "ar: Unexpected EOF in archive\n");
-                return (FALSE);
-        }
-        if (strncmp(arVersion,"!<arch>",7) != 0) {
-                errorMsg("ar header fails check ");
-                return(FALSE);
-        }
-        return arFd;
+
+       return EXIT_SUCCESS;
 }
+#endif /* FEATURE_AR_CREATE */
 
-/*
- * Step through the ar file and process it one entry at a time
- * fileList[0] is the name of the ar archive
- * fileList[1] and up are filenames to extract from the archive
- * funct contains flags to specify the actions to be performed 
- */
-static int readArFile(char *fileList[16], int fileListSize, int funct)
+static void FAST_FUNC header_verbose_list_ar(const file_header_t *file_header)
 {
-       int arFd, status, extFileFlag, i, lastOffset=0;
-       ArHeader rawArHeader;
-       ArInfo arEntry;
-
-       /* open the ar archive */
-       arFd=getArFd(fileList[0]);
-
-       /* read the first header, then loop until ono more headers */ 
-       while ((status = fullRead(arFd, (char *) &rawArHeader, AR_BLOCK_SIZE))
-                  == AR_BLOCK_SIZE) {
-
-               /* check the header is valid, if not try reading the header
-                  agian with an offset of 1, needed as some ar archive end
-                   with a '\n' which isnt counted in specified file size */
-               if ((status=processArHeader(&rawArHeader, &arEntry))==FALSE ) {
-                       if ((i=lseek(arFd, 0, SEEK_CUR))==(lastOffset+60)) 
-                               lseek(arFd, lastOffset+1, SEEK_SET);
-                       else 
-                               return(FALSE);
-                       }
-               else {  
-                       extFileFlag=0;
-                       
-                       if (funct&AR_DISPLAY) 
-                               displayEntry(&arEntry, funct);
-
-                       /* check file was specified to be extracted only if 
-                          some file were specified */
-                       if ((funct&AR_EXT_TO_FILE) || (funct&AR_EXT_TO_STDOUT)){
-                               if (fileListSize==1)
-                                       extFileFlag=1;
-                               else {
-                                       for( i=1; i<=fileListSize; i++)
-                                               if ((status=(strcmp(fileList[i],arEntry.name)))==0)
-                                                       extFileFlag=1;
-                               }
-                       }
-                       if (extFileFlag==1) { 
-                               if (funct&AR_EXT_TO_FILE)
-                                               extractToFile(&arEntry, funct, arFd, "./");
-                               else    
-                                               copySubFile(arFd,fileno(stdout),arEntry.size);
-                       }
-                       else
-                               lseek(arFd, arEntry.size, SEEK_CUR);
-                       lastOffset=lseek(arFd, 0, SEEK_CUR);
-               } /* if processArHeader */
-       }  /* while */
-       return (TRUE);
+       const char *mode = bb_mode_string(file_header->mode);
+       char *mtime;
+
+       mtime = ctime(&file_header->mtime);
+       mtime[16] = ' ';
+       memmove(&mtime[17], &mtime[20], 4);
+       mtime[21] = '\0';
+       printf("%s %u/%u%7"OFF_FMT"u %s %s\n", &mode[1],
+                       (int)file_header->uid, (int)file_header->gid,
+                       file_header->size,
+                       &mtime[4], file_header->name
+       );
 }
 
-extern int ar_main(int argc, char **argv)
+#define AR_OPT_VERBOSE          (1 << 0)
+#define AR_OPT_PRESERVE_DATE    (1 << 1)
+/* "ar r" implies create, but warns about it. c suppresses warning.
+ * bbox accepts but ignores it: */
+#define AR_OPT_CREATE           (1 << 2)
+
+#define AR_CMD_PRINT            (1 << 3)
+#define FIRST_CMD               AR_CMD_PRINT
+#define AR_CMD_LIST             (1 << 4)
+#define AR_CMD_EXTRACT          (1 << 5)
+#define AR_CMD_INSERT           (1 << 6)
+
+int ar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int ar_main(int argc UNUSED_PARAM, char **argv)
 {
-        int funct = 0, ret=0, i=0;
-        char *fileList[16], c, *opt_ptr;
-
-       if (argc < 2)
-               usage(ar_usage);
-
-       opt_ptr = argv[1];
-       if (*opt_ptr == '-')
-               ++opt_ptr;
-       while ((c = *opt_ptr++) != '\0') {
-               switch (c) {
-               case 'o':
-                       funct = funct | AR_PRESERVE_DATE;
-                       break;
-               case 'v':
-                       funct = funct | AR_VERBOSE;
-                       break;
-               case 't':
-                       funct = funct | AR_DISPLAY;
-                       break;
-               case 'x':
-                       funct = funct | AR_EXT_TO_FILE;
-                       break;
-               case 'p':
-                       funct = funct | AR_EXT_TO_STDOUT;
-                       break;
-               default:
-                       usage(ar_usage);
-               }
+       archive_handle_t *archive_handle;
+       unsigned opt, t;
+
+       archive_handle = init_handle();
+
+       /* prepend '-' to the first argument if required */
+       if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0')
+               argv[1] = xasprintf("-%s", argv[1]);
+       opt = getopt32(argv, "^"
+               "voc""ptx"IF_FEATURE_AR_CREATE("r")
+               "\0"
+               /* -1: at least one arg is reqd */
+               /* one of p,t,x[,r] is required */
+               "-1:p:t:x"IF_FEATURE_AR_CREATE(":r")
+       );
+       argv += optind;
+
+       t = opt / FIRST_CMD;
+       if (t & (t-1)) /* more than one of p,t,x[,r] are specified */
+               bb_show_usage();
+
+       if (opt & AR_CMD_PRINT) {
+               archive_handle->action_data = data_extract_to_stdout;
+       }
+       if (opt & AR_CMD_LIST) {
+               archive_handle->action_header = header_list;
+       }
+       if (opt & AR_CMD_EXTRACT) {
+               archive_handle->action_data = data_extract_all;
+       }
+       if (opt & AR_OPT_PRESERVE_DATE) {
+               archive_handle->ah_flags |= ARCHIVE_RESTORE_DATE;
        }
+       if (opt & AR_OPT_VERBOSE) {
+               archive_handle->action_header = header_verbose_list_ar;
+       }
+#if ENABLE_FEATURE_AR_CREATE
+       archive_handle->ar__name = *argv;
+#endif
+       archive_handle->src_fd = xopen(*argv++,
+                       (opt & AR_CMD_INSERT)
+                               ? O_RDWR | O_CREAT
+                               : O_RDONLY
+       );
+
+       if (*argv)
+               archive_handle->filter = filter_accept_list;
+       while (*argv) {
+               llist_add_to_end(&archive_handle->accept, *argv++);
+       }
+
+#if ENABLE_FEATURE_AR_CREATE
+       if (opt & AR_CMD_INSERT)
+               return write_ar_archive(archive_handle);
+#endif
+
+       unpack_ar_archive(archive_handle);
 
-        for(i=0; i<(argc-2); i++) 
-                fileList[i]=argv[i+2];
-       
-       if (funct > 3)
-               ret = readArFile(fileList, (argc-2), funct);
-       
-       return (ret);
+       return EXIT_SUCCESS;
 }