Merge from vendor branch LIBARCHIVE:
[dragonfly.git] / contrib / libarchive-2 / libarchive / archive_write_set_format_pax.c
1 /*-
2  * Copyright (c) 2003-2007 Tim Kientzle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD: src/lib/libarchive/archive_write_set_format_pax.c,v 1.42 2007/12/30 04:58:22 kientzle Exp $");
28
29 #ifdef HAVE_ERRNO_H
30 #include <errno.h>
31 #endif
32 #ifdef HAVE_STDLIB_H
33 #include <stdlib.h>
34 #endif
35 #ifdef HAVE_STRING_H
36 #include <string.h>
37 #endif
38
39 #include "archive.h"
40 #include "archive_entry.h"
41 #include "archive_private.h"
42 #include "archive_write_private.h"
43
44 struct pax {
45         uint64_t        entry_bytes_remaining;
46         uint64_t        entry_padding;
47         struct archive_string   pax_header;
48 };
49
50 static void              add_pax_attr(struct archive_string *, const char *key,
51                              const char *value);
52 static void              add_pax_attr_int(struct archive_string *,
53                              const char *key, int64_t value);
54 static void              add_pax_attr_time(struct archive_string *,
55                              const char *key, int64_t sec,
56                              unsigned long nanos);
57 static void              add_pax_attr_w(struct archive_string *,
58                              const char *key, const wchar_t *wvalue);
59 static ssize_t           archive_write_pax_data(struct archive_write *,
60                              const void *, size_t);
61 static int               archive_write_pax_finish(struct archive_write *);
62 static int               archive_write_pax_destroy(struct archive_write *);
63 static int               archive_write_pax_finish_entry(struct archive_write *);
64 static int               archive_write_pax_header(struct archive_write *,
65                              struct archive_entry *);
66 static char             *base64_encode(const char *src, size_t len);
67 static char             *build_pax_attribute_name(char *dest, const char *src);
68 static char             *build_ustar_entry_name(char *dest, const char *src,
69                              size_t src_length, const char *insert);
70 static char             *format_int(char *dest, int64_t);
71 static int               has_non_ASCII(const wchar_t *);
72 static char             *url_encode(const char *in);
73 static int               write_nulls(struct archive_write *, size_t);
74
75 /*
76  * Set output format to 'restricted pax' format.
77  *
78  * This is the same as normal 'pax', but tries to suppress
79  * the pax header whenever possible.  This is the default for
80  * bsdtar, for instance.
81  */
82 int
83 archive_write_set_format_pax_restricted(struct archive *_a)
84 {
85         struct archive_write *a = (struct archive_write *)_a;
86         int r;
87         r = archive_write_set_format_pax(&a->archive);
88         a->archive_format = ARCHIVE_FORMAT_TAR_PAX_RESTRICTED;
89         a->archive_format_name = "restricted POSIX pax interchange";
90         return (r);
91 }
92
93 /*
94  * Set output format to 'pax' format.
95  */
96 int
97 archive_write_set_format_pax(struct archive *_a)
98 {
99         struct archive_write *a = (struct archive_write *)_a;
100         struct pax *pax;
101
102         if (a->format_destroy != NULL)
103                 (a->format_destroy)(a);
104
105         pax = (struct pax *)malloc(sizeof(*pax));
106         if (pax == NULL) {
107                 archive_set_error(&a->archive, ENOMEM, "Can't allocate pax data");
108                 return (ARCHIVE_FATAL);
109         }
110         memset(pax, 0, sizeof(*pax));
111         a->format_data = pax;
112
113         a->pad_uncompressed = 1;
114         a->format_write_header = archive_write_pax_header;
115         a->format_write_data = archive_write_pax_data;
116         a->format_finish = archive_write_pax_finish;
117         a->format_destroy = archive_write_pax_destroy;
118         a->format_finish_entry = archive_write_pax_finish_entry;
119         a->archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
120         a->archive_format_name = "POSIX pax interchange";
121         return (ARCHIVE_OK);
122 }
123
124 /*
125  * Note: This code assumes that 'nanos' has the same sign as 'sec',
126  * which implies that sec=-1, nanos=200000000 represents -1.2 seconds
127  * and not -0.8 seconds.  This is a pretty pedantic point, as we're
128  * unlikely to encounter many real files created before Jan 1, 1970,
129  * much less ones with timestamps recorded to sub-second resolution.
130  */
131 static void
132 add_pax_attr_time(struct archive_string *as, const char *key,
133     int64_t sec, unsigned long nanos)
134 {
135         int digit, i;
136         char *t;
137         /*
138          * Note that each byte contributes fewer than 3 base-10
139          * digits, so this will always be big enough.
140          */
141         char tmp[1 + 3*sizeof(sec) + 1 + 3*sizeof(nanos)];
142
143         tmp[sizeof(tmp) - 1] = 0;
144         t = tmp + sizeof(tmp) - 1;
145
146         /* Skip trailing zeros in the fractional part. */
147         for (digit = 0, i = 10; i > 0 && digit == 0; i--) {
148                 digit = nanos % 10;
149                 nanos /= 10;
150         }
151
152         /* Only format the fraction if it's non-zero. */
153         if (i > 0) {
154                 while (i > 0) {
155                         *--t = "0123456789"[digit];
156                         digit = nanos % 10;
157                         nanos /= 10;
158                         i--;
159                 }
160                 *--t = '.';
161         }
162         t = format_int(t, sec);
163
164         add_pax_attr(as, key, t);
165 }
166
167 static char *
168 format_int(char *t, int64_t i)
169 {
170         int sign;
171
172         if (i < 0) {
173                 sign = -1;
174                 i = -i;
175         } else
176                 sign = 1;
177
178         do {
179                 *--t = "0123456789"[i % 10];
180         } while (i /= 10);
181         if (sign < 0)
182                 *--t = '-';
183         return (t);
184 }
185
186 static void
187 add_pax_attr_int(struct archive_string *as, const char *key, int64_t value)
188 {
189         char tmp[1 + 3 * sizeof(value)];
190
191         tmp[sizeof(tmp) - 1] = 0;
192         add_pax_attr(as, key, format_int(tmp + sizeof(tmp) - 1, value));
193 }
194
195 static char *
196 utf8_encode(const wchar_t *wval)
197 {
198         int utf8len;
199         const wchar_t *wp;
200         unsigned long wc;
201         char *utf8_value, *p;
202
203         utf8len = 0;
204         for (wp = wval; *wp != L'\0'; ) {
205                 wc = *wp++;
206                 if (wc <= 0x7f)
207                         utf8len++;
208                 else if (wc <= 0x7ff)
209                         utf8len += 2;
210                 else if (wc <= 0xffff)
211                         utf8len += 3;
212                 else if (wc <= 0x1fffff)
213                         utf8len += 4;
214                 else if (wc <= 0x3ffffff)
215                         utf8len += 5;
216                 else if (wc <= 0x7fffffff)
217                         utf8len += 6;
218                 /* Ignore larger values; UTF-8 can't encode them. */
219         }
220
221         utf8_value = (char *)malloc(utf8len + 1);
222         if (utf8_value == NULL) {
223                 __archive_errx(1, "Not enough memory for attributes");
224                 return (NULL);
225         }
226
227         for (wp = wval, p = utf8_value; *wp != L'\0'; ) {
228                 wc = *wp++;
229                 if (wc <= 0x7f) {
230                         *p++ = (char)wc;
231                 } else if (wc <= 0x7ff) {
232                         p[0] = 0xc0 | ((wc >> 6) & 0x1f);
233                         p[1] = 0x80 | (wc & 0x3f);
234                         p += 2;
235                 } else if (wc <= 0xffff) {
236                         p[0] = 0xe0 | ((wc >> 12) & 0x0f);
237                         p[1] = 0x80 | ((wc >> 6) & 0x3f);
238                         p[2] = 0x80 | (wc & 0x3f);
239                         p += 3;
240                 } else if (wc <= 0x1fffff) {
241                         p[0] = 0xf0 | ((wc >> 18) & 0x07);
242                         p[1] = 0x80 | ((wc >> 12) & 0x3f);
243                         p[2] = 0x80 | ((wc >> 6) & 0x3f);
244                         p[3] = 0x80 | (wc & 0x3f);
245                         p += 4;
246                 } else if (wc <= 0x3ffffff) {
247                         p[0] = 0xf8 | ((wc >> 24) & 0x03);
248                         p[1] = 0x80 | ((wc >> 18) & 0x3f);
249                         p[2] = 0x80 | ((wc >> 12) & 0x3f);
250                         p[3] = 0x80 | ((wc >> 6) & 0x3f);
251                         p[4] = 0x80 | (wc & 0x3f);
252                         p += 5;
253                 } else if (wc <= 0x7fffffff) {
254                         p[0] = 0xfc | ((wc >> 30) & 0x01);
255                         p[1] = 0x80 | ((wc >> 24) & 0x3f);
256                         p[1] = 0x80 | ((wc >> 18) & 0x3f);
257                         p[2] = 0x80 | ((wc >> 12) & 0x3f);
258                         p[3] = 0x80 | ((wc >> 6) & 0x3f);
259                         p[4] = 0x80 | (wc & 0x3f);
260                         p += 6;
261                 }
262                 /* Ignore larger values; UTF-8 can't encode them. */
263         }
264         *p = '\0';
265
266         return (utf8_value);
267 }
268
269 static void
270 add_pax_attr_w(struct archive_string *as, const char *key, const wchar_t *wval)
271 {
272         char *utf8_value = utf8_encode(wval);
273         if (utf8_value == NULL)
274                 return;
275         add_pax_attr(as, key, utf8_value);
276         free(utf8_value);
277 }
278
279 /*
280  * Add a key/value attribute to the pax header.  This function handles
281  * the length field and various other syntactic requirements.
282  */
283 static void
284 add_pax_attr(struct archive_string *as, const char *key, const char *value)
285 {
286         int digits, i, len, next_ten;
287         char tmp[1 + 3 * sizeof(int)];  /* < 3 base-10 digits per byte */
288
289         /*-
290          * PAX attributes have the following layout:
291          *     <len> <space> <key> <=> <value> <nl>
292          */
293         len = 1 + strlen(key) + 1 + strlen(value) + 1;
294
295         /*
296          * The <len> field includes the length of the <len> field, so
297          * computing the correct length is tricky.  I start by
298          * counting the number of base-10 digits in 'len' and
299          * computing the next higher power of 10.
300          */
301         next_ten = 1;
302         digits = 0;
303         i = len;
304         while (i > 0) {
305                 i = i / 10;
306                 digits++;
307                 next_ten = next_ten * 10;
308         }
309         /*
310          * For example, if string without the length field is 99
311          * chars, then adding the 2 digit length "99" will force the
312          * total length past 100, requiring an extra digit.  The next
313          * statement adjusts for this effect.
314          */
315         if (len + digits >= next_ten)
316                 digits++;
317
318         /* Now, we have the right length so we can build the line. */
319         tmp[sizeof(tmp) - 1] = 0;       /* Null-terminate the work area. */
320         archive_strcat(as, format_int(tmp + sizeof(tmp) - 1, len + digits));
321         archive_strappend_char(as, ' ');
322         archive_strcat(as, key);
323         archive_strappend_char(as, '=');
324         archive_strcat(as, value);
325         archive_strappend_char(as, '\n');
326 }
327
328 static void
329 archive_write_pax_header_xattrs(struct pax *pax, struct archive_entry *entry)
330 {
331         struct archive_string s;
332         int i = archive_entry_xattr_reset(entry);
333
334         while (i--) {
335                 const char *name;
336                 const void *value;
337                 char *encoded_value;
338                 char *url_encoded_name = NULL, *encoded_name = NULL;
339                 wchar_t *wcs_name = NULL;
340                 size_t size;
341
342                 archive_entry_xattr_next(entry, &name, &value, &size);
343                 /* Name is URL-encoded, then converted to wchar_t,
344                  * then UTF-8 encoded. */
345                 url_encoded_name = url_encode(name);
346                 if (url_encoded_name != NULL) {
347                         /* Convert narrow-character to wide-character. */
348                         int wcs_length = strlen(url_encoded_name);
349                         wcs_name = (wchar_t *)malloc((wcs_length + 1) * sizeof(wchar_t));
350                         if (wcs_name == NULL)
351                                 __archive_errx(1, "No memory for xattr conversion");
352                         mbstowcs(wcs_name, url_encoded_name, wcs_length);
353                         wcs_name[wcs_length] = 0;
354                         free(url_encoded_name); /* Done with this. */
355                 }
356                 if (wcs_name != NULL) {
357                         encoded_name = utf8_encode(wcs_name);
358                         free(wcs_name); /* Done with wchar_t name. */
359                 }
360
361                 encoded_value = base64_encode((const char *)value, size);
362
363                 if (encoded_name != NULL && encoded_value != NULL) {
364                         archive_string_init(&s);
365                         archive_strcpy(&s, "LIBARCHIVE.xattr.");
366                         archive_strcat(&s, encoded_name);
367                         add_pax_attr(&(pax->pax_header), s.s, encoded_value);
368                         archive_string_free(&s);
369                 }
370                 free(encoded_name);
371                 free(encoded_value);
372         }
373 }
374
375 /*
376  * TODO: Consider adding 'comment' and 'charset' fields to
377  * archive_entry so that clients can specify them.  Also, consider
378  * adding generic key/value tags so clients can add arbitrary
379  * key/value data.
380  */
381 static int
382 archive_write_pax_header(struct archive_write *a,
383     struct archive_entry *entry_original)
384 {
385         struct archive_entry *entry_main;
386         const char *p;
387         char *t;
388         const wchar_t *wp;
389         const char *suffix_start;
390         int need_extension, r, ret;
391         struct pax *pax;
392         const char *hdrcharset = NULL;
393         const char *hardlink;
394         const char *path = NULL, *linkpath = NULL;
395         const char *uname = NULL, *gname = NULL;
396         const wchar_t *path_w = NULL, *linkpath_w = NULL;
397         const wchar_t *uname_w = NULL, *gname_w = NULL;
398
399         char paxbuff[512];
400         char ustarbuff[512];
401         char ustar_entry_name[256];
402         char pax_entry_name[256];
403
404         ret = ARCHIVE_OK;
405         need_extension = 0;
406         pax = (struct pax *)a->format_data;
407
408         hardlink = archive_entry_hardlink(entry_original);
409
410         /* Make sure this is a type of entry that we can handle here */
411         if (hardlink == NULL) {
412                 switch (archive_entry_filetype(entry_original)) {
413                 case AE_IFBLK:
414                 case AE_IFCHR:
415                 case AE_IFIFO:
416                 case AE_IFLNK:
417                 case AE_IFREG:
418                         break;
419                 case AE_IFDIR:
420                         /*
421                          * Ensure a trailing '/'.  Modify the original
422                          * entry so the client sees the change.
423                          */
424                         p = archive_entry_pathname(entry_original);
425                         if (p[strlen(p) - 1] != '/') {
426                                 t = (char *)malloc(strlen(p) + 2);
427                                 if (t == NULL) {
428                                         archive_set_error(&a->archive, ENOMEM,
429                                         "Can't allocate pax data");
430                                         return(ARCHIVE_FATAL);
431                                 }
432                                 strcpy(t, p);
433                                 strcat(t, "/");
434                                 archive_entry_copy_pathname(entry_original, t);
435                                 free(t);
436                         }
437                         break;
438                 default:
439                         archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
440                             "tar format cannot archive this (type=0%lo)",
441                             (unsigned long)archive_entry_filetype(entry_original));
442                         return (ARCHIVE_WARN);
443                 }
444         }
445
446         /* Copy entry so we can modify it as needed. */
447         entry_main = archive_entry_clone(entry_original);
448         archive_string_empty(&(pax->pax_header)); /* Blank our work area. */
449
450         /*
451          * First, check the name fields and see if any of them
452          * require binary coding.  If any of them does, then all of
453          * them do.
454          */
455         hdrcharset = NULL;
456         path = archive_entry_pathname(entry_main);
457         path_w = archive_entry_pathname_w(entry_main);
458         if (path != NULL && path_w == NULL) {
459                 archive_set_error(&a->archive, EILSEQ,
460                     "Can't translate pathname '%s' to UTF-8", path);
461                 ret = ARCHIVE_WARN;
462                 hdrcharset = "BINARY";
463         }
464         uname = archive_entry_uname(entry_main);
465         uname_w = archive_entry_uname_w(entry_main);
466         if (uname != NULL && uname_w == NULL) {
467                 archive_set_error(&a->archive, EILSEQ,
468                     "Can't translate uname '%s' to UTF-8", uname);
469                 ret = ARCHIVE_WARN;
470                 hdrcharset = "BINARY";
471         }
472         gname = archive_entry_gname(entry_main);
473         gname_w = archive_entry_gname_w(entry_main);
474         if (gname != NULL && gname_w == NULL) {
475                 archive_set_error(&a->archive, EILSEQ,
476                     "Can't translate gname '%s' to UTF-8", gname);
477                 ret = ARCHIVE_WARN;
478                 hdrcharset = "BINARY";
479         }
480         linkpath = hardlink;
481         if (linkpath != NULL) {
482                 linkpath_w = archive_entry_hardlink_w(entry_main);
483         } else {
484                 linkpath = archive_entry_symlink(entry_main);
485                 if (linkpath != NULL)
486                         linkpath_w = archive_entry_symlink_w(entry_main);
487         }
488         if (linkpath != NULL && linkpath_w == NULL) {
489                 archive_set_error(&a->archive, EILSEQ,
490                     "Can't translate linkpath '%s' to UTF-8", linkpath);
491                 ret = ARCHIVE_WARN;
492                 hdrcharset = "BINARY";
493         }
494
495         /* Store the header encoding first, to be nice to readers. */
496         if (hdrcharset != NULL)
497                 add_pax_attr(&(pax->pax_header), "hdrcharset", hdrcharset);
498
499         /*
500          * Determining whether or not the name is too big is ugly
501          * because of the rules for dividing names between 'name' and
502          * 'prefix' fields.  Here, I pick out the longest possible
503          * suffix, then test whether the remaining prefix is too long.
504          */
505         if (strlen(path) <= 100)    /* Short enough for just 'name' field */
506                 suffix_start = path;    /* Record a zero-length prefix */
507         else
508                 /* Find the largest suffix that fits in 'name' field. */
509                 suffix_start = strchr(path + strlen(path) - 100 - 1, '/');
510
511         /*
512          * If name is too long, or has non-ASCII characters, add
513          * 'path' to pax extended attrs.  (Note that an unconvertible
514          * name must have non-ASCII characters.)
515          */
516         if (suffix_start == NULL || suffix_start - path > 155
517             || path_w == NULL || has_non_ASCII(path_w)) {
518                 if (path_w == NULL || hdrcharset != NULL)
519                         /* Can't do UTF-8, so store it raw. */
520                         add_pax_attr(&(pax->pax_header), "path", path);
521                 else
522                         add_pax_attr_w(&(pax->pax_header), "path", path_w);
523                 archive_entry_set_pathname(entry_main,
524                     build_ustar_entry_name(ustar_entry_name,
525                         path, strlen(path), NULL));
526                 need_extension = 1;
527         }
528
529         if (linkpath != NULL) {
530                 /* If link name is too long or has non-ASCII characters, add
531                  * 'linkpath' to pax extended attrs. */
532                 if (strlen(linkpath) > 100 || linkpath_w == NULL
533                     || linkpath_w == NULL || has_non_ASCII(linkpath_w)) {
534                         if (linkpath_w == NULL || hdrcharset != NULL)
535                                 /* If the linkpath is not convertible
536                                  * to wide, or we're encoding in
537                                  * binary anyway, store it raw. */
538                                 add_pax_attr(&(pax->pax_header),
539                                     "linkpath", linkpath);
540                         else
541                                 /* If the link is long or has a
542                                  * non-ASCII character, store it as a
543                                  * pax extended attribute. */
544                                 add_pax_attr_w(&(pax->pax_header),
545                                     "linkpath", linkpath_w);
546                         if (strlen(linkpath) > 100) {
547                                 if (hardlink != NULL)
548                                         archive_entry_set_hardlink(entry_main,
549                                             "././@LongHardLink");
550                                 else
551                                         archive_entry_set_symlink(entry_main,
552                                             "././@LongSymLink");
553                         }
554                         need_extension = 1;
555                 }
556         }
557
558         /* If file size is too large, add 'size' to pax extended attrs. */
559         if (archive_entry_size(entry_main) >= (((int64_t)1) << 33)) {
560                 add_pax_attr_int(&(pax->pax_header), "size",
561                     archive_entry_size(entry_main));
562                 need_extension = 1;
563         }
564
565         /* If numeric GID is too large, add 'gid' to pax extended attrs. */
566         if (archive_entry_gid(entry_main) >= (1 << 18)) {
567                 add_pax_attr_int(&(pax->pax_header), "gid",
568                     archive_entry_gid(entry_main));
569                 need_extension = 1;
570         }
571
572         /* If group name is too large or has non-ASCII characters, add
573          * 'gname' to pax extended attrs. */
574         if (gname != NULL) {
575                 if (strlen(gname) > 31
576                     || gname_w == NULL
577                     || has_non_ASCII(gname_w))
578                 {
579                         if (gname_w == NULL || hdrcharset != NULL) {
580                                 add_pax_attr(&(pax->pax_header),
581                                     "gname", gname);
582                         } else  {
583                                 add_pax_attr_w(&(pax->pax_header),
584                                     "gname", gname_w);
585                         }
586                         need_extension = 1;
587                 }
588         }
589
590         /* If numeric UID is too large, add 'uid' to pax extended attrs. */
591         if (archive_entry_uid(entry_main) >= (1 << 18)) {
592                 add_pax_attr_int(&(pax->pax_header), "uid",
593                     archive_entry_uid(entry_main));
594                 need_extension = 1;
595         }
596
597         /* Add 'uname' to pax extended attrs if necessary. */
598         if (uname != NULL) {
599                 if (strlen(uname) > 31
600                     || uname_w == NULL
601                     || has_non_ASCII(uname_w))
602                 {
603                         if (uname_w == NULL || hdrcharset != NULL) {
604                                 add_pax_attr(&(pax->pax_header),
605                                     "uname", uname);
606                         } else {
607                                 add_pax_attr_w(&(pax->pax_header),
608                                     "uname", uname_w);
609                         }
610                         need_extension = 1;
611                 }
612         }
613
614         /*
615          * POSIX/SUSv3 doesn't provide a standard key for large device
616          * numbers.  I use the same keys here that Joerg Schilling
617          * used for 'star.'  (Which, somewhat confusingly, are called
618          * "devXXX" even though they code "rdev" values.)  No doubt,
619          * other implementations use other keys.  Note that there's no
620          * reason we can't write the same information into a number of
621          * different keys.
622          *
623          * Of course, this is only needed for block or char device entries.
624          */
625         if (archive_entry_filetype(entry_main) == AE_IFBLK
626             || archive_entry_filetype(entry_main) == AE_IFCHR) {
627                 /*
628                  * If rdevmajor is too large, add 'SCHILY.devmajor' to
629                  * extended attributes.
630                  */
631                 dev_t rdevmajor, rdevminor;
632                 rdevmajor = archive_entry_rdevmajor(entry_main);
633                 rdevminor = archive_entry_rdevminor(entry_main);
634                 if (rdevmajor >= (1 << 18)) {
635                         add_pax_attr_int(&(pax->pax_header), "SCHILY.devmajor",
636                             rdevmajor);
637                         /*
638                          * Non-strict formatting below means we don't
639                          * have to truncate here.  Not truncating improves
640                          * the chance that some more modern tar archivers
641                          * (such as GNU tar 1.13) can restore the full
642                          * value even if they don't understand the pax
643                          * extended attributes.  See my rant below about
644                          * file size fields for additional details.
645                          */
646                         /* archive_entry_set_rdevmajor(entry_main,
647                            rdevmajor & ((1 << 18) - 1)); */
648                         need_extension = 1;
649                 }
650
651                 /*
652                  * If devminor is too large, add 'SCHILY.devminor' to
653                  * extended attributes.
654                  */
655                 if (rdevminor >= (1 << 18)) {
656                         add_pax_attr_int(&(pax->pax_header), "SCHILY.devminor",
657                             rdevminor);
658                         /* Truncation is not necessary here, either. */
659                         /* archive_entry_set_rdevminor(entry_main,
660                            rdevminor & ((1 << 18) - 1)); */
661                         need_extension = 1;
662                 }
663         }
664
665         /*
666          * Technically, the mtime field in the ustar header can
667          * support 33 bits, but many platforms use signed 32-bit time
668          * values.  The cutoff of 0x7fffffff here is a compromise.
669          * Yes, this check is duplicated just below; this helps to
670          * avoid writing an mtime attribute just to handle a
671          * high-resolution timestamp in "restricted pax" mode.
672          */
673         if (!need_extension &&
674             ((archive_entry_mtime(entry_main) < 0)
675                 || (archive_entry_mtime(entry_main) >= 0x7fffffff)))
676                 need_extension = 1;
677
678         /* I use a star-compatible file flag attribute. */
679         p = archive_entry_fflags_text(entry_main);
680         if (!need_extension && p != NULL  &&  *p != '\0')
681                 need_extension = 1;
682
683         /* If there are non-trivial ACL entries, we need an extension. */
684         if (!need_extension && archive_entry_acl_count(entry_original,
685                 ARCHIVE_ENTRY_ACL_TYPE_ACCESS) > 0)
686                 need_extension = 1;
687
688         /* If there are non-trivial ACL entries, we need an extension. */
689         if (!need_extension && archive_entry_acl_count(entry_original,
690                 ARCHIVE_ENTRY_ACL_TYPE_DEFAULT) > 0)
691                 need_extension = 1;
692
693         /* If there are extended attributes, we need an extension */
694         if (!need_extension && archive_entry_xattr_count(entry_original) > 0)
695                 need_extension = 1;
696
697         /*
698          * The following items are handled differently in "pax
699          * restricted" format.  In particular, in "pax restricted"
700          * format they won't be added unless need_extension is
701          * already set (we're already generating an extended header, so
702          * may as well include these).
703          */
704         if (a->archive_format != ARCHIVE_FORMAT_TAR_PAX_RESTRICTED ||
705             need_extension) {
706
707                 if (archive_entry_mtime(entry_main) < 0  ||
708                     archive_entry_mtime(entry_main) >= 0x7fffffff  ||
709                     archive_entry_mtime_nsec(entry_main) != 0)
710                         add_pax_attr_time(&(pax->pax_header), "mtime",
711                             archive_entry_mtime(entry_main),
712                             archive_entry_mtime_nsec(entry_main));
713
714                 if (archive_entry_ctime(entry_main) != 0  ||
715                     archive_entry_ctime_nsec(entry_main) != 0)
716                         add_pax_attr_time(&(pax->pax_header), "ctime",
717                             archive_entry_ctime(entry_main),
718                             archive_entry_ctime_nsec(entry_main));
719
720                 if (archive_entry_atime(entry_main) != 0 ||
721                     archive_entry_atime_nsec(entry_main) != 0)
722                         add_pax_attr_time(&(pax->pax_header), "atime",
723                             archive_entry_atime(entry_main),
724                             archive_entry_atime_nsec(entry_main));
725
726                 /* I use a star-compatible file flag attribute. */
727                 p = archive_entry_fflags_text(entry_main);
728                 if (p != NULL  &&  *p != '\0')
729                         add_pax_attr(&(pax->pax_header), "SCHILY.fflags", p);
730
731                 /* I use star-compatible ACL attributes. */
732                 wp = archive_entry_acl_text_w(entry_original,
733                     ARCHIVE_ENTRY_ACL_TYPE_ACCESS |
734                     ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID);
735                 if (wp != NULL && *wp != L'\0')
736                         add_pax_attr_w(&(pax->pax_header),
737                             "SCHILY.acl.access", wp);
738                 wp = archive_entry_acl_text_w(entry_original,
739                     ARCHIVE_ENTRY_ACL_TYPE_DEFAULT |
740                     ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID);
741                 if (wp != NULL && *wp != L'\0')
742                         add_pax_attr_w(&(pax->pax_header),
743                             "SCHILY.acl.default", wp);
744
745                 /* Include star-compatible metadata info. */
746                 /* Note: "SCHILY.dev{major,minor}" are NOT the
747                  * major/minor portions of "SCHILY.dev". */
748                 add_pax_attr_int(&(pax->pax_header), "SCHILY.dev",
749                     archive_entry_dev(entry_main));
750                 add_pax_attr_int(&(pax->pax_header), "SCHILY.ino",
751                     archive_entry_ino(entry_main));
752                 add_pax_attr_int(&(pax->pax_header), "SCHILY.nlink",
753                     archive_entry_nlink(entry_main));
754
755                 /* Store extended attributes */
756                 archive_write_pax_header_xattrs(pax, entry_original);
757         }
758
759         /* Only regular files have data. */
760         if (archive_entry_filetype(entry_main) != AE_IFREG)
761                 archive_entry_set_size(entry_main, 0);
762
763         /*
764          * Pax-restricted does not store data for hardlinks, in order
765          * to improve compatibility with ustar.
766          */
767         if (a->archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE &&
768             hardlink != NULL)
769                 archive_entry_set_size(entry_main, 0);
770
771         /*
772          * XXX Full pax interchange format does permit a hardlink
773          * entry to have data associated with it.  I'm not supporting
774          * that here because the client expects me to tell them whether
775          * or not this format expects data for hardlinks.  If I
776          * don't check here, then every pax archive will end up with
777          * duplicated data for hardlinks.  Someday, there may be
778          * need to select this behavior, in which case the following
779          * will need to be revisited. XXX
780          */
781         if (hardlink != NULL)
782                 archive_entry_set_size(entry_main, 0);
783
784         /* Format 'ustar' header for main entry.
785          *
786          * The trouble with file size: If the reader can't understand
787          * the file size, they may not be able to locate the next
788          * entry and the rest of the archive is toast.  Pax-compliant
789          * readers are supposed to ignore the file size in the main
790          * header, so the question becomes how to maximize portability
791          * for readers that don't support pax attribute extensions.
792          * For maximum compatibility, I permit numeric extensions in
793          * the main header so that the file size stored will always be
794          * correct, even if it's in a format that only some
795          * implementations understand.  The technique used here is:
796          *
797          *  a) If possible, follow the standard exactly.  This handles
798          *  files up to 8 gigabytes minus 1.
799          *
800          *  b) If that fails, try octal but omit the field terminator.
801          *  That handles files up to 64 gigabytes minus 1.
802          *
803          *  c) Otherwise, use base-256 extensions.  That handles files
804          *  up to 2^63 in this implementation, with the potential to
805          *  go up to 2^94.  That should hold us for a while. ;-)
806          *
807          * The non-strict formatter uses similar logic for other
808          * numeric fields, though they're less critical.
809          */
810         __archive_write_format_header_ustar(a, ustarbuff, entry_main, -1, 0);
811
812         /* If we built any extended attributes, write that entry first. */
813         if (archive_strlen(&(pax->pax_header)) > 0) {
814                 struct archive_entry *pax_attr_entry;
815                 time_t s;
816                 uid_t uid;
817                 gid_t gid;
818                 mode_t mode;
819                 long ns;
820
821                 pax_attr_entry = archive_entry_new();
822                 p = archive_entry_pathname(entry_main);
823                 archive_entry_set_pathname(pax_attr_entry,
824                     build_pax_attribute_name(pax_entry_name, p));
825                 archive_entry_set_size(pax_attr_entry,
826                     archive_strlen(&(pax->pax_header)));
827                 /* Copy uid/gid (but clip to ustar limits). */
828                 uid = archive_entry_uid(entry_main);
829                 if (uid >= 1 << 18)
830                         uid = (1 << 18) - 1;
831                 archive_entry_set_uid(pax_attr_entry, uid);
832                 gid = archive_entry_gid(entry_main);
833                 if (gid >= 1 << 18)
834                         gid = (1 << 18) - 1;
835                 archive_entry_set_gid(pax_attr_entry, gid);
836                 /* Copy mode over (but not setuid/setgid bits) */
837                 mode = archive_entry_mode(entry_main);
838 #ifdef S_ISUID
839                 mode &= ~S_ISUID;
840 #endif
841 #ifdef S_ISGID
842                 mode &= ~S_ISGID;
843 #endif
844 #ifdef S_ISVTX
845                 mode &= ~S_ISVTX;
846 #endif
847                 archive_entry_set_mode(pax_attr_entry, mode);
848
849                 /* Copy uname/gname. */
850                 archive_entry_set_uname(pax_attr_entry,
851                     archive_entry_uname(entry_main));
852                 archive_entry_set_gname(pax_attr_entry,
853                     archive_entry_gname(entry_main));
854
855                 /* Copy mtime, but clip to ustar limits. */
856                 s = archive_entry_mtime(entry_main);
857                 ns = archive_entry_mtime_nsec(entry_main);
858                 if (s < 0) { s = 0; ns = 0; }
859                 if (s > 0x7fffffff) { s = 0x7fffffff; ns = 0; }
860                 archive_entry_set_mtime(pax_attr_entry, s, ns);
861
862                 /* Ditto for atime. */
863                 s = archive_entry_atime(entry_main);
864                 ns = archive_entry_atime_nsec(entry_main);
865                 if (s < 0) { s = 0; ns = 0; }
866                 if (s > 0x7fffffff) { s = 0x7fffffff; ns = 0; }
867                 archive_entry_set_atime(pax_attr_entry, s, ns);
868
869                 /* Standard ustar doesn't support ctime. */
870                 archive_entry_set_ctime(pax_attr_entry, 0, 0);
871
872                 r = __archive_write_format_header_ustar(a, paxbuff,
873                     pax_attr_entry, 'x', 1);
874
875                 archive_entry_free(pax_attr_entry);
876
877                 /* Note that the 'x' header shouldn't ever fail to format */
878                 if (r != 0) {
879                         const char *msg = "archive_write_pax_header: "
880                             "'x' header failed?!  This can't happen.\n";
881                         write(2, msg, strlen(msg));
882                         exit(1);
883                 }
884                 r = (a->compressor.write)(a, paxbuff, 512);
885                 if (r != ARCHIVE_OK) {
886                         pax->entry_bytes_remaining = 0;
887                         pax->entry_padding = 0;
888                         return (ARCHIVE_FATAL);
889                 }
890
891                 pax->entry_bytes_remaining = archive_strlen(&(pax->pax_header));
892                 pax->entry_padding = 0x1ff & (-(int64_t)pax->entry_bytes_remaining);
893
894                 r = (a->compressor.write)(a, pax->pax_header.s,
895                     archive_strlen(&(pax->pax_header)));
896                 if (r != ARCHIVE_OK) {
897                         /* If a write fails, we're pretty much toast. */
898                         return (ARCHIVE_FATAL);
899                 }
900                 /* Pad out the end of the entry. */
901                 r = write_nulls(a, pax->entry_padding);
902                 if (r != ARCHIVE_OK) {
903                         /* If a write fails, we're pretty much toast. */
904                         return (ARCHIVE_FATAL);
905                 }
906                 pax->entry_bytes_remaining = pax->entry_padding = 0;
907         }
908
909         /* Write the header for main entry. */
910         r = (a->compressor.write)(a, ustarbuff, 512);
911         if (r != ARCHIVE_OK)
912                 return (r);
913
914         /*
915          * Inform the client of the on-disk size we're using, so
916          * they can avoid unnecessarily writing a body for something
917          * that we're just going to ignore.
918          */
919         archive_entry_set_size(entry_original, archive_entry_size(entry_main));
920         pax->entry_bytes_remaining = archive_entry_size(entry_main);
921         pax->entry_padding = 0x1ff & (-(int64_t)pax->entry_bytes_remaining);
922         archive_entry_free(entry_main);
923
924         return (ret);
925 }
926
927 /*
928  * We need a valid name for the regular 'ustar' entry.  This routine
929  * tries to hack something more-or-less reasonable.
930  *
931  * The approach here tries to preserve leading dir names.  We do so by
932  * working with four sections:
933  *   1) "prefix" directory names,
934  *   2) "suffix" directory names,
935  *   3) inserted dir name (optional),
936  *   4) filename.
937  *
938  * These sections must satisfy the following requirements:
939  *   * Parts 1 & 2 together form an initial portion of the dir name.
940  *   * Part 3 is specified by the caller.  (It should not contain a leading
941  *     or trailing '/'.)
942  *   * Part 4 forms an initial portion of the base filename.
943  *   * The filename must be <= 99 chars to fit the ustar 'name' field.
944  *   * Parts 2, 3, 4 together must be <= 99 chars to fit the ustar 'name' fld.
945  *   * Part 1 must be <= 155 chars to fit the ustar 'prefix' field.
946  *   * If the original name ends in a '/', the new name must also end in a '/'
947  *   * Trailing '/.' sequences may be stripped.
948  *
949  * Note: Recall that the ustar format does not store the '/' separating
950  * parts 1 & 2, but does store the '/' separating parts 2 & 3.
951  */
952 static char *
953 build_ustar_entry_name(char *dest, const char *src, size_t src_length,
954     const char *insert)
955 {
956         const char *prefix, *prefix_end;
957         const char *suffix, *suffix_end;
958         const char *filename, *filename_end;
959         char *p;
960         int need_slash = 0; /* Was there a trailing slash? */
961         size_t suffix_length = 99;
962         int insert_length;
963
964         /* Length of additional dir element to be added. */
965         if (insert == NULL)
966                 insert_length = 0;
967         else
968                 /* +2 here allows for '/' before and after the insert. */
969                 insert_length = strlen(insert) + 2;
970
971         /* Step 0: Quick bailout in a common case. */
972         if (src_length < 100 && insert == NULL) {
973                 strncpy(dest, src, src_length);
974                 dest[src_length] = '\0';
975                 return (dest);
976         }
977
978         /* Step 1: Locate filename and enforce the length restriction. */
979         filename_end = src + src_length;
980         /* Remove trailing '/' chars and '/.' pairs. */
981         for (;;) {
982                 if (filename_end > src && filename_end[-1] == '/') {
983                         filename_end --;
984                         need_slash = 1; /* Remember to restore trailing '/'. */
985                         continue;
986                 }
987                 if (filename_end > src + 1 && filename_end[-1] == '.'
988                     && filename_end[-2] == '/') {
989                         filename_end -= 2;
990                         need_slash = 1; /* "foo/." will become "foo/" */
991                         continue;
992                 }
993                 break;
994         }
995         if (need_slash)
996                 suffix_length--;
997         /* Find start of filename. */
998         filename = filename_end - 1;
999         while ((filename > src) && (*filename != '/'))
1000                 filename --;
1001         if ((*filename == '/') && (filename < filename_end - 1))
1002                 filename ++;
1003         /* Adjust filename_end so that filename + insert fits in 99 chars. */
1004         suffix_length -= insert_length;
1005         if (filename_end > filename + suffix_length)
1006                 filename_end = filename + suffix_length;
1007         /* Calculate max size for "suffix" section (#3 above). */
1008         suffix_length -= filename_end - filename;
1009
1010         /* Step 2: Locate the "prefix" section of the dirname, including
1011          * trailing '/'. */
1012         prefix = src;
1013         prefix_end = prefix + 155;
1014         if (prefix_end > filename)
1015                 prefix_end = filename;
1016         while (prefix_end > prefix && *prefix_end != '/')
1017                 prefix_end--;
1018         if ((prefix_end < filename) && (*prefix_end == '/'))
1019                 prefix_end++;
1020
1021         /* Step 3: Locate the "suffix" section of the dirname,
1022          * including trailing '/'. */
1023         suffix = prefix_end;
1024         suffix_end = suffix + suffix_length; /* Enforce limit. */
1025         if (suffix_end > filename)
1026                 suffix_end = filename;
1027         if (suffix_end < suffix)
1028                 suffix_end = suffix;
1029         while (suffix_end > suffix && *suffix_end != '/')
1030                 suffix_end--;
1031         if ((suffix_end < filename) && (*suffix_end == '/'))
1032                 suffix_end++;
1033
1034         /* Step 4: Build the new name. */
1035         /* The OpenBSD strlcpy function is safer, but less portable. */
1036         /* Rather than maintain two versions, just use the strncpy version. */
1037         p = dest;
1038         if (prefix_end > prefix) {
1039                 strncpy(p, prefix, prefix_end - prefix);
1040                 p += prefix_end - prefix;
1041         }
1042         if (suffix_end > suffix) {
1043                 strncpy(p, suffix, suffix_end - suffix);
1044                 p += suffix_end - suffix;
1045         }
1046         if (insert != NULL) {
1047                 /* Note: assume insert does not have leading or trailing '/' */
1048                 strcpy(p, insert);
1049                 p += strlen(insert);
1050                 *p++ = '/';
1051         }
1052         strncpy(p, filename, filename_end - filename);
1053         p += filename_end - filename;
1054         if (need_slash)
1055                 *p++ = '/';
1056         *p++ = '\0';
1057
1058         return (dest);
1059 }
1060
1061 /*
1062  * The ustar header for the pax extended attributes must have a
1063  * reasonable name:  SUSv3 suggests 'dirname'/PaxHeader/'filename'
1064  *
1065  * Joerg Schilling has argued that this is unnecessary because, in
1066  * practice, if the pax extended attributes get extracted as regular
1067  * files, noone is going to bother reading those attributes to
1068  * manually restore them.  Based on this, 'star' uses
1069  * /tmp/PaxHeader/'basename' as the ustar header name.  This is a
1070  * tempting argument, in part because it's simpler than the SUSv3
1071  * recommendation, but I'm not entirely convinced.  I'm also
1072  * uncomfortable with the fact that "/tmp" is a Unix-ism.
1073  *
1074  * GNU tar uses 'dirname'/PaxHeader.<pid>/'filename', where the PID is
1075  * the PID of the archiving process.  This seems unnecessarily complex
1076  * to me, as I don't see much value to separating the headers from
1077  * extracting multiple versions of an archive.
1078  *
1079  * The following routine implements the SUSv3 recommendation, and is
1080  * much simpler because build_ustar_entry_name() above already does
1081  * most of the work (we just need to give it an extra path element to
1082  * insert and handle a few pathological cases).
1083  */
1084 static char *
1085 build_pax_attribute_name(char *dest, const char *src)
1086 {
1087         const char *p;
1088
1089         /* Handle the null filename case. */
1090         if (src == NULL || *src == '\0') {
1091                 strcpy(dest, "PaxHeader/blank");
1092                 return (dest);
1093         }
1094
1095         /* Prune final '/' and other unwanted final elements. */
1096         p = src + strlen(src);
1097         for (;;) {
1098                 /* Ends in "/", remove the '/' */
1099                 if (p > src && p[-1] == '/') {
1100                         --p;
1101                         continue;
1102                 }
1103                 /* Ends in "/.", remove the '.' */
1104                 if (p > src + 1 && p[-1] == '.'
1105                     && p[-2] == '/') {
1106                         --p;
1107                         continue;
1108                 }
1109                 break;
1110         }
1111
1112         /* Pathological case: After above, there was nothing left.
1113          * This includes "/." "/./." "/.//./." etc. */
1114         if (p == src) {
1115                 strcpy(dest, "/PaxHeader/rootdir");
1116                 return (dest);
1117         }
1118
1119         /* Convert unadorned "." into a suitable filename. */
1120         if (*src == '.' && p == src + 1) {
1121                 strcpy(dest, "PaxHeader/currentdir");
1122                 return (dest);
1123         }
1124
1125         /* General case: build a ustar-compatible name adding "/PaxHeader/". */
1126         build_ustar_entry_name(dest, src, p - src, "PaxHeader");
1127
1128         return (dest);
1129 }
1130
1131 /* Write two null blocks for the end of archive */
1132 static int
1133 archive_write_pax_finish(struct archive_write *a)
1134 {
1135         struct pax *pax;
1136         int r;
1137
1138         if (a->compressor.write == NULL)
1139                 return (ARCHIVE_OK);
1140
1141         pax = (struct pax *)a->format_data;
1142         r = write_nulls(a, 512 * 2);
1143         return (r);
1144 }
1145
1146 static int
1147 archive_write_pax_destroy(struct archive_write *a)
1148 {
1149         struct pax *pax;
1150
1151         pax = (struct pax *)a->format_data;
1152         archive_string_free(&pax->pax_header);
1153         free(pax);
1154         a->format_data = NULL;
1155         return (ARCHIVE_OK);
1156 }
1157
1158 static int
1159 archive_write_pax_finish_entry(struct archive_write *a)
1160 {
1161         struct pax *pax;
1162         int ret;
1163
1164         pax = (struct pax *)a->format_data;
1165         ret = write_nulls(a, pax->entry_bytes_remaining + pax->entry_padding);
1166         pax->entry_bytes_remaining = pax->entry_padding = 0;
1167         return (ret);
1168 }
1169
1170 static int
1171 write_nulls(struct archive_write *a, size_t padding)
1172 {
1173         int ret, to_write;
1174
1175         while (padding > 0) {
1176                 to_write = padding < a->null_length ? padding : a->null_length;
1177                 ret = (a->compressor.write)(a, a->nulls, to_write);
1178                 if (ret != ARCHIVE_OK)
1179                         return (ret);
1180                 padding -= to_write;
1181         }
1182         return (ARCHIVE_OK);
1183 }
1184
1185 static ssize_t
1186 archive_write_pax_data(struct archive_write *a, const void *buff, size_t s)
1187 {
1188         struct pax *pax;
1189         int ret;
1190
1191         pax = (struct pax *)a->format_data;
1192         if (s > pax->entry_bytes_remaining)
1193                 s = pax->entry_bytes_remaining;
1194
1195         ret = (a->compressor.write)(a, buff, s);
1196         pax->entry_bytes_remaining -= s;
1197         if (ret == ARCHIVE_OK)
1198                 return (s);
1199         else
1200                 return (ret);
1201 }
1202
1203 static int
1204 has_non_ASCII(const wchar_t *wp)
1205 {
1206         while (*wp != L'\0' && *wp < 128)
1207                 wp++;
1208         return (*wp != L'\0');
1209 }
1210
1211 /*
1212  * Used by extended attribute support; encodes the name
1213  * so that there will be no '=' characters in the result.
1214  */
1215 static char *
1216 url_encode(const char *in)
1217 {
1218         const char *s;
1219         char *d;
1220         int out_len = 0;
1221         char *out;
1222
1223         for (s = in; *s != '\0'; s++) {
1224                 if (*s < 33 || *s > 126 || *s == '%' || *s == '=')
1225                         out_len += 3;
1226                 else
1227                         out_len++;
1228         }
1229
1230         out = (char *)malloc(out_len + 1);
1231         if (out == NULL)
1232                 return (NULL);
1233
1234         for (s = in, d = out; *s != '\0'; s++) {
1235                 /* encode any non-printable ASCII character or '%' or '=' */
1236                 if (*s < 33 || *s > 126 || *s == '%' || *s == '=') {
1237                         /* URL encoding is '%' followed by two hex digits */
1238                         *d++ = '%';
1239                         *d++ = "0123456789ABCDEF"[0x0f & (*s >> 4)];
1240                         *d++ = "0123456789ABCDEF"[0x0f & *s];
1241                 } else {
1242                         *d++ = *s;
1243                 }
1244         }
1245         *d = '\0';
1246         return (out);
1247 }
1248
1249 /*
1250  * Encode a sequence of bytes into a C string using base-64 encoding.
1251  *
1252  * Returns a null-terminated C string allocated with malloc(); caller
1253  * is responsible for freeing the result.
1254  */
1255 static char *
1256 base64_encode(const char *s, size_t len)
1257 {
1258         static const char digits[64] =
1259             { 'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O',
1260               'P','Q','R','S','T','U','V','W','X','Y','Z','a','b','c','d',
1261               'e','f','g','h','i','j','k','l','m','n','o','p','q','r','s',
1262               't','u','v','w','x','y','z','0','1','2','3','4','5','6','7',
1263               '8','9','+','/' };
1264         int v;
1265         char *d, *out;
1266
1267         /* 3 bytes becomes 4 chars, but round up and allow for trailing NUL */
1268         out = (char *)malloc((len * 4 + 2) / 3 + 1);
1269         if (out == NULL)
1270                 return (NULL);
1271         d = out;
1272
1273         /* Convert each group of 3 bytes into 4 characters. */
1274         while (len >= 3) {
1275                 v = (((int)s[0] << 16) & 0xff0000)
1276                     | (((int)s[1] << 8) & 0xff00)
1277                     | (((int)s[2]) & 0x00ff);
1278                 s += 3;
1279                 len -= 3;
1280                 *d++ = digits[(v >> 18) & 0x3f];
1281                 *d++ = digits[(v >> 12) & 0x3f];
1282                 *d++ = digits[(v >> 6) & 0x3f];
1283                 *d++ = digits[(v) & 0x3f];
1284         }
1285         /* Handle final group of 1 byte (2 chars) or 2 bytes (3 chars). */
1286         switch (len) {
1287         case 0: break;
1288         case 1:
1289                 v = (((int)s[0] << 16) & 0xff0000);
1290                 *d++ = digits[(v >> 18) & 0x3f];
1291                 *d++ = digits[(v >> 12) & 0x3f];
1292                 break;
1293         case 2:
1294                 v = (((int)s[0] << 16) & 0xff0000)
1295                     | (((int)s[1] << 8) & 0xff00);
1296                 *d++ = digits[(v >> 18) & 0x3f];
1297                 *d++ = digits[(v >> 12) & 0x3f];
1298                 *d++ = digits[(v >> 6) & 0x3f];
1299                 break;
1300         }
1301         /* Add trailing NUL character so output is a valid C string. */
1302         *d++ = '\0';
1303         return (out);
1304 }