]> git.saurik.com Git - apt.git/blob - apt-pkg/contrib/fileutl.cc
38ae0246ead05a1498c20f225a4f1b2cd6da636f
[apt.git] / apt-pkg / contrib / fileutl.cc
1 // -*- mode: cpp; mode: fold -*-
2 // Description /*{{{*/
3 /* ######################################################################
4
5 File Utilities
6
7 CopyFile - Buffered copy of a single file
8 GetLock - dpkg compatible lock file manipulation (fcntl)
9
10 Most of this source is placed in the Public Domain, do with it what
11 you will
12 It was originally written by Jason Gunthorpe <jgg@debian.org>.
13 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
14
15 The exception is RunScripts() it is under the GPLv2
16
17 ##################################################################### */
18 /*}}}*/
19 // Include Files /*{{{*/
20 #include <config.h>
21
22 #include <apt-pkg/fileutl.h>
23 #include <apt-pkg/strutl.h>
24 #include <apt-pkg/error.h>
25 #include <apt-pkg/sptr.h>
26 #include <apt-pkg/aptconfiguration.h>
27 #include <apt-pkg/configuration.h>
28 #include <apt-pkg/macros.h>
29
30 #include <ctype.h>
31 #include <stdarg.h>
32 #include <stddef.h>
33 #include <sys/select.h>
34 #include <time.h>
35 #include <string>
36 #include <vector>
37 #include <cstdlib>
38 #include <cstring>
39 #include <cstdio>
40 #include <iostream>
41 #include <unistd.h>
42 #include <fcntl.h>
43 #include <sys/stat.h>
44 #include <sys/time.h>
45 #include <sys/wait.h>
46 #include <dirent.h>
47 #include <signal.h>
48 #include <errno.h>
49 #include <glob.h>
50 #include <pwd.h>
51 #include <grp.h>
52
53 #include <set>
54 #include <algorithm>
55 #include <memory>
56
57 #ifdef HAVE_ZLIB
58 #include <zlib.h>
59 #endif
60 #ifdef HAVE_BZ2
61 #include <bzlib.h>
62 #endif
63 #ifdef HAVE_LZMA
64 #include <lzma.h>
65 #endif
66 #include <endian.h>
67 #include <stdint.h>
68
69 #if __gnu_linux__
70 #include <sys/prctl.h>
71 #endif
72
73 #include <apti18n.h>
74 /*}}}*/
75
76 using namespace std;
77
78 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
79 // ---------------------------------------------------------------------
80 /* */
81 bool RunScripts(const char *Cnf)
82 {
83 Configuration::Item const *Opts = _config->Tree(Cnf);
84 if (Opts == 0 || Opts->Child == 0)
85 return true;
86 Opts = Opts->Child;
87
88 // Fork for running the system calls
89 pid_t Child = ExecFork();
90
91 // This is the child
92 if (Child == 0)
93 {
94 if (_config->FindDir("DPkg::Chroot-Directory","/") != "/")
95 {
96 std::cerr << "Chrooting into "
97 << _config->FindDir("DPkg::Chroot-Directory")
98 << std::endl;
99 if (chroot(_config->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
100 _exit(100);
101 }
102
103 if (chdir("/tmp/") != 0)
104 _exit(100);
105
106 unsigned int Count = 1;
107 for (; Opts != 0; Opts = Opts->Next, Count++)
108 {
109 if (Opts->Value.empty() == true)
110 continue;
111
112 if(_config->FindB("Debug::RunScripts", false) == true)
113 std::clog << "Running external script: '"
114 << Opts->Value << "'" << std::endl;
115
116 if (system(Opts->Value.c_str()) != 0)
117 _exit(100+Count);
118 }
119 _exit(0);
120 }
121
122 // Wait for the child
123 int Status = 0;
124 while (waitpid(Child,&Status,0) != Child)
125 {
126 if (errno == EINTR)
127 continue;
128 return _error->Errno("waitpid","Couldn't wait for subprocess");
129 }
130
131 // Restore sig int/quit
132 signal(SIGQUIT,SIG_DFL);
133 signal(SIGINT,SIG_DFL);
134
135 // Check for an error code.
136 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
137 {
138 unsigned int Count = WEXITSTATUS(Status);
139 if (Count > 100)
140 {
141 Count -= 100;
142 for (; Opts != 0 && Count != 1; Opts = Opts->Next, Count--);
143 _error->Error("Problem executing scripts %s '%s'",Cnf,Opts->Value.c_str());
144 }
145
146 return _error->Error("Sub-process returned an error code");
147 }
148
149 return true;
150 }
151 /*}}}*/
152
153 // CopyFile - Buffered copy of a file /*{{{*/
154 // ---------------------------------------------------------------------
155 /* The caller is expected to set things so that failure causes erasure */
156 bool CopyFile(FileFd &From,FileFd &To)
157 {
158 if (From.IsOpen() == false || To.IsOpen() == false ||
159 From.Failed() == true || To.Failed() == true)
160 return false;
161
162 // Buffered copy between fds
163 constexpr size_t BufSize = 64000;
164 std::unique_ptr<unsigned char[]> Buf(new unsigned char[BufSize]);
165 unsigned long long ToRead = 0;
166 do {
167 if (From.Read(Buf.get(),BufSize, &ToRead) == false ||
168 To.Write(Buf.get(),ToRead) == false)
169 return false;
170 } while (ToRead != 0);
171
172 return true;
173 }
174 /*}}}*/
175 bool RemoveFile(char const * const Function, std::string const &FileName)/*{{{*/
176 {
177 if (FileName == "/dev/null")
178 return true;
179 errno = 0;
180 if (unlink(FileName.c_str()) != 0)
181 {
182 if (errno == ENOENT)
183 return true;
184
185 return _error->WarningE(Function,_("Problem unlinking the file %s"), FileName.c_str());
186 }
187 return true;
188 }
189 /*}}}*/
190 // GetLock - Gets a lock file /*{{{*/
191 // ---------------------------------------------------------------------
192 /* This will create an empty file of the given name and lock it. Once this
193 is done all other calls to GetLock in any other process will fail with
194 -1. The return result is the fd of the file, the call should call
195 close at some time. */
196 int GetLock(string File,bool Errors)
197 {
198 // GetLock() is used in aptitude on directories with public-write access
199 // Use O_NOFOLLOW here to prevent symlink traversal attacks
200 int FD = open(File.c_str(),O_RDWR | O_CREAT | O_NOFOLLOW,0640);
201 if (FD < 0)
202 {
203 // Read only .. can't have locking problems there.
204 if (errno == EROFS)
205 {
206 _error->Warning(_("Not using locking for read only lock file %s"),File.c_str());
207 return dup(0); // Need something for the caller to close
208 }
209
210 if (Errors == true)
211 _error->Errno("open",_("Could not open lock file %s"),File.c_str());
212
213 // Feh.. We do this to distinguish the lock vs open case..
214 errno = EPERM;
215 return -1;
216 }
217 SetCloseExec(FD,true);
218
219 // Acquire a write lock
220 struct flock fl;
221 fl.l_type = F_WRLCK;
222 fl.l_whence = SEEK_SET;
223 fl.l_start = 0;
224 fl.l_len = 0;
225 if (fcntl(FD,F_SETLK,&fl) == -1)
226 {
227 // always close to not leak resources
228 int Tmp = errno;
229 close(FD);
230 errno = Tmp;
231
232 if (errno == ENOLCK)
233 {
234 _error->Warning(_("Not using locking for nfs mounted lock file %s"),File.c_str());
235 return dup(0); // Need something for the caller to close
236 }
237
238 if (Errors == true)
239 _error->Errno("open",_("Could not get lock %s"),File.c_str());
240
241 return -1;
242 }
243
244 return FD;
245 }
246 /*}}}*/
247 // FileExists - Check if a file exists /*{{{*/
248 // ---------------------------------------------------------------------
249 /* Beware: Directories are also files! */
250 bool FileExists(string File)
251 {
252 struct stat Buf;
253 if (stat(File.c_str(),&Buf) != 0)
254 return false;
255 return true;
256 }
257 /*}}}*/
258 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
259 // ---------------------------------------------------------------------
260 /* */
261 bool RealFileExists(string File)
262 {
263 struct stat Buf;
264 if (stat(File.c_str(),&Buf) != 0)
265 return false;
266 return ((Buf.st_mode & S_IFREG) != 0);
267 }
268 /*}}}*/
269 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
270 // ---------------------------------------------------------------------
271 /* */
272 bool DirectoryExists(string const &Path)
273 {
274 struct stat Buf;
275 if (stat(Path.c_str(),&Buf) != 0)
276 return false;
277 return ((Buf.st_mode & S_IFDIR) != 0);
278 }
279 /*}}}*/
280 // CreateDirectory - poor man's mkdir -p guarded by a parent directory /*{{{*/
281 // ---------------------------------------------------------------------
282 /* This method will create all directories needed for path in good old
283 mkdir -p style but refuses to do this if Parent is not a prefix of
284 this Path. Example: /var/cache/ and /var/cache/apt/archives are given,
285 so it will create apt/archives if /var/cache exists - on the other
286 hand if the parent is /var/lib the creation will fail as this path
287 is not a parent of the path to be generated. */
288 bool CreateDirectory(string const &Parent, string const &Path)
289 {
290 if (Parent.empty() == true || Path.empty() == true)
291 return false;
292
293 if (DirectoryExists(Path) == true)
294 return true;
295
296 if (DirectoryExists(Parent) == false)
297 return false;
298
299 // we are not going to create directories "into the blue"
300 if (Path.compare(0, Parent.length(), Parent) != 0)
301 return false;
302
303 vector<string> const dirs = VectorizeString(Path.substr(Parent.size()), '/');
304 string progress = Parent;
305 for (vector<string>::const_iterator d = dirs.begin(); d != dirs.end(); ++d)
306 {
307 if (d->empty() == true)
308 continue;
309
310 progress.append("/").append(*d);
311 if (DirectoryExists(progress) == true)
312 continue;
313
314 if (mkdir(progress.c_str(), 0755) != 0)
315 return false;
316 }
317 return true;
318 }
319 /*}}}*/
320 // CreateAPTDirectoryIfNeeded - ensure that the given directory exists /*{{{*/
321 // ---------------------------------------------------------------------
322 /* a small wrapper around CreateDirectory to check if it exists and to
323 remove the trailing "/apt/" from the parent directory if needed */
324 bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path)
325 {
326 if (DirectoryExists(Path) == true)
327 return true;
328
329 size_t const len = Parent.size();
330 if (len > 5 && Parent.find("/apt/", len - 6, 5) == len - 5)
331 {
332 if (CreateDirectory(Parent.substr(0,len-5), Path) == true)
333 return true;
334 }
335 else if (CreateDirectory(Parent, Path) == true)
336 return true;
337
338 return false;
339 }
340 /*}}}*/
341 // GetListOfFilesInDir - returns a vector of files in the given dir /*{{{*/
342 // ---------------------------------------------------------------------
343 /* If an extension is given only files with this extension are included
344 in the returned vector, otherwise every "normal" file is included. */
345 std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
346 bool const &SortList, bool const &AllowNoExt)
347 {
348 std::vector<string> ext;
349 ext.reserve(2);
350 if (Ext.empty() == false)
351 ext.push_back(Ext);
352 if (AllowNoExt == true && ext.empty() == false)
353 ext.push_back("");
354 return GetListOfFilesInDir(Dir, ext, SortList);
355 }
356 std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
357 bool const &SortList)
358 {
359 // Attention debuggers: need to be set with the environment config file!
360 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
361 if (Debug == true)
362 {
363 std::clog << "Accept in " << Dir << " only files with the following " << Ext.size() << " extensions:" << std::endl;
364 if (Ext.empty() == true)
365 std::clog << "\tNO extension" << std::endl;
366 else
367 for (std::vector<string>::const_iterator e = Ext.begin();
368 e != Ext.end(); ++e)
369 std::clog << '\t' << (e->empty() == true ? "NO" : *e) << " extension" << std::endl;
370 }
371
372 std::vector<string> List;
373
374 if (DirectoryExists(Dir) == false)
375 {
376 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
377 return List;
378 }
379
380 Configuration::MatchAgainstConfig SilentIgnore("Dir::Ignore-Files-Silently");
381 DIR *D = opendir(Dir.c_str());
382 if (D == 0)
383 {
384 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
385 return List;
386 }
387
388 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
389 {
390 // skip "hidden" files
391 if (Ent->d_name[0] == '.')
392 continue;
393
394 // Make sure it is a file and not something else
395 string const File = flCombine(Dir,Ent->d_name);
396 #ifdef _DIRENT_HAVE_D_TYPE
397 if (Ent->d_type != DT_REG)
398 #endif
399 {
400 if (RealFileExists(File) == false)
401 {
402 // do not show ignoration warnings for directories
403 if (
404 #ifdef _DIRENT_HAVE_D_TYPE
405 Ent->d_type == DT_DIR ||
406 #endif
407 DirectoryExists(File) == true)
408 continue;
409 if (SilentIgnore.Match(Ent->d_name) == false)
410 _error->Notice(_("Ignoring '%s' in directory '%s' as it is not a regular file"), Ent->d_name, Dir.c_str());
411 continue;
412 }
413 }
414
415 // check for accepted extension:
416 // no extension given -> periods are bad as hell!
417 // extensions given -> "" extension allows no extension
418 if (Ext.empty() == false)
419 {
420 string d_ext = flExtension(Ent->d_name);
421 if (d_ext == Ent->d_name) // no extension
422 {
423 if (std::find(Ext.begin(), Ext.end(), "") == Ext.end())
424 {
425 if (Debug == true)
426 std::clog << "Bad file: " << Ent->d_name << " → no extension" << std::endl;
427 if (SilentIgnore.Match(Ent->d_name) == false)
428 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has no filename extension"), Ent->d_name, Dir.c_str());
429 continue;
430 }
431 }
432 else if (std::find(Ext.begin(), Ext.end(), d_ext) == Ext.end())
433 {
434 if (Debug == true)
435 std::clog << "Bad file: " << Ent->d_name << " → bad extension »" << flExtension(Ent->d_name) << "«" << std::endl;
436 if (SilentIgnore.Match(Ent->d_name) == false)
437 _error->Notice(_("Ignoring file '%s' in directory '%s' as it has an invalid filename extension"), Ent->d_name, Dir.c_str());
438 continue;
439 }
440 }
441
442 // Skip bad filenames ala run-parts
443 const char *C = Ent->d_name;
444 for (; *C != 0; ++C)
445 if (isalpha(*C) == 0 && isdigit(*C) == 0
446 && *C != '_' && *C != '-' && *C != ':') {
447 // no required extension -> dot is a bad character
448 if (*C == '.' && Ext.empty() == false)
449 continue;
450 break;
451 }
452
453 // we don't reach the end of the name -> bad character included
454 if (*C != 0)
455 {
456 if (Debug == true)
457 std::clog << "Bad file: " << Ent->d_name << " → bad character »"
458 << *C << "« in filename (period allowed: " << (Ext.empty() ? "no" : "yes") << ")" << std::endl;
459 continue;
460 }
461
462 // skip filenames which end with a period. These are never valid
463 if (*(C - 1) == '.')
464 {
465 if (Debug == true)
466 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
467 continue;
468 }
469
470 if (Debug == true)
471 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
472 List.push_back(File);
473 }
474 closedir(D);
475
476 if (SortList == true)
477 std::sort(List.begin(),List.end());
478 return List;
479 }
480 std::vector<string> GetListOfFilesInDir(string const &Dir, bool SortList)
481 {
482 bool const Debug = _config->FindB("Debug::GetListOfFilesInDir", false);
483 if (Debug == true)
484 std::clog << "Accept in " << Dir << " all regular files" << std::endl;
485
486 std::vector<string> List;
487
488 if (DirectoryExists(Dir) == false)
489 {
490 _error->Error(_("List of files can't be created as '%s' is not a directory"), Dir.c_str());
491 return List;
492 }
493
494 DIR *D = opendir(Dir.c_str());
495 if (D == 0)
496 {
497 _error->Errno("opendir",_("Unable to read %s"),Dir.c_str());
498 return List;
499 }
500
501 for (struct dirent *Ent = readdir(D); Ent != 0; Ent = readdir(D))
502 {
503 // skip "hidden" files
504 if (Ent->d_name[0] == '.')
505 continue;
506
507 // Make sure it is a file and not something else
508 string const File = flCombine(Dir,Ent->d_name);
509 #ifdef _DIRENT_HAVE_D_TYPE
510 if (Ent->d_type != DT_REG)
511 #endif
512 {
513 if (RealFileExists(File) == false)
514 {
515 if (Debug == true)
516 std::clog << "Bad file: " << Ent->d_name << " → it is not a real file" << std::endl;
517 continue;
518 }
519 }
520
521 // Skip bad filenames ala run-parts
522 const char *C = Ent->d_name;
523 for (; *C != 0; ++C)
524 if (isalpha(*C) == 0 && isdigit(*C) == 0
525 && *C != '_' && *C != '-' && *C != '.')
526 break;
527
528 // we don't reach the end of the name -> bad character included
529 if (*C != 0)
530 {
531 if (Debug == true)
532 std::clog << "Bad file: " << Ent->d_name << " → bad character »" << *C << "« in filename" << std::endl;
533 continue;
534 }
535
536 // skip filenames which end with a period. These are never valid
537 if (*(C - 1) == '.')
538 {
539 if (Debug == true)
540 std::clog << "Bad file: " << Ent->d_name << " → Period as last character" << std::endl;
541 continue;
542 }
543
544 if (Debug == true)
545 std::clog << "Accept file: " << Ent->d_name << " in " << Dir << std::endl;
546 List.push_back(File);
547 }
548 closedir(D);
549
550 if (SortList == true)
551 std::sort(List.begin(),List.end());
552 return List;
553 }
554 /*}}}*/
555 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
556 // ---------------------------------------------------------------------
557 /* We return / on failure. */
558 string SafeGetCWD()
559 {
560 // Stash the current dir.
561 char S[300];
562 S[0] = 0;
563 if (getcwd(S,sizeof(S)-2) == 0)
564 return "/";
565 unsigned int Len = strlen(S);
566 S[Len] = '/';
567 S[Len+1] = 0;
568 return S;
569 }
570 /*}}}*/
571 // GetModificationTime - Get the mtime of the given file or -1 on error /*{{{*/
572 // ---------------------------------------------------------------------
573 /* We return / on failure. */
574 time_t GetModificationTime(string const &Path)
575 {
576 struct stat St;
577 if (stat(Path.c_str(), &St) < 0)
578 return -1;
579 return St.st_mtime;
580 }
581 /*}}}*/
582 // flNotDir - Strip the directory from the filename /*{{{*/
583 // ---------------------------------------------------------------------
584 /* */
585 string flNotDir(string File)
586 {
587 string::size_type Res = File.rfind('/');
588 if (Res == string::npos)
589 return File;
590 Res++;
591 return string(File,Res,Res - File.length());
592 }
593 /*}}}*/
594 // flNotFile - Strip the file from the directory name /*{{{*/
595 // ---------------------------------------------------------------------
596 /* Result ends in a / */
597 string flNotFile(string File)
598 {
599 string::size_type Res = File.rfind('/');
600 if (Res == string::npos)
601 return "./";
602 Res++;
603 return string(File,0,Res);
604 }
605 /*}}}*/
606 // flExtension - Return the extension for the file /*{{{*/
607 // ---------------------------------------------------------------------
608 /* */
609 string flExtension(string File)
610 {
611 string::size_type Res = File.rfind('.');
612 if (Res == string::npos)
613 return File;
614 Res++;
615 return string(File,Res,Res - File.length());
616 }
617 /*}}}*/
618 // flNoLink - If file is a symlink then deref it /*{{{*/
619 // ---------------------------------------------------------------------
620 /* If the name is not a link then the returned path is the input. */
621 string flNoLink(string File)
622 {
623 struct stat St;
624 if (lstat(File.c_str(),&St) != 0 || S_ISLNK(St.st_mode) == 0)
625 return File;
626 if (stat(File.c_str(),&St) != 0)
627 return File;
628
629 /* Loop resolving the link. There is no need to limit the number of
630 loops because the stat call above ensures that the symlink is not
631 circular */
632 char Buffer[1024];
633 string NFile = File;
634 while (1)
635 {
636 // Read the link
637 ssize_t Res;
638 if ((Res = readlink(NFile.c_str(),Buffer,sizeof(Buffer))) <= 0 ||
639 (size_t)Res >= sizeof(Buffer))
640 return File;
641
642 // Append or replace the previous path
643 Buffer[Res] = 0;
644 if (Buffer[0] == '/')
645 NFile = Buffer;
646 else
647 NFile = flNotFile(NFile) + Buffer;
648
649 // See if we are done
650 if (lstat(NFile.c_str(),&St) != 0)
651 return File;
652 if (S_ISLNK(St.st_mode) == 0)
653 return NFile;
654 }
655 }
656 /*}}}*/
657 // flCombine - Combine a file and a directory /*{{{*/
658 // ---------------------------------------------------------------------
659 /* If the file is an absolute path then it is just returned, otherwise
660 the directory is pre-pended to it. */
661 string flCombine(string Dir,string File)
662 {
663 if (File.empty() == true)
664 return string();
665
666 if (File[0] == '/' || Dir.empty() == true)
667 return File;
668 if (File.length() >= 2 && File[0] == '.' && File[1] == '/')
669 return File;
670 if (Dir[Dir.length()-1] == '/')
671 return Dir + File;
672 return Dir + '/' + File;
673 }
674 /*}}}*/
675 // flAbsPath - Return the absolute path of the filename /*{{{*/
676 // ---------------------------------------------------------------------
677 /* */
678 string flAbsPath(string File)
679 {
680 char *p = realpath(File.c_str(), NULL);
681 if (p == NULL)
682 {
683 _error->Errno("realpath", "flAbsPath on %s failed", File.c_str());
684 return "";
685 }
686 std::string AbsPath(p);
687 free(p);
688 return AbsPath;
689 }
690 /*}}}*/
691 // SetCloseExec - Set the close on exec flag /*{{{*/
692 // ---------------------------------------------------------------------
693 /* */
694 void SetCloseExec(int Fd,bool Close)
695 {
696 if (fcntl(Fd,F_SETFD,(Close == false)?0:FD_CLOEXEC) != 0)
697 {
698 cerr << "FATAL -> Could not set close on exec " << strerror(errno) << endl;
699 exit(100);
700 }
701 }
702 /*}}}*/
703 // SetNonBlock - Set the nonblocking flag /*{{{*/
704 // ---------------------------------------------------------------------
705 /* */
706 void SetNonBlock(int Fd,bool Block)
707 {
708 int Flags = fcntl(Fd,F_GETFL) & (~O_NONBLOCK);
709 if (fcntl(Fd,F_SETFL,Flags | ((Block == false)?0:O_NONBLOCK)) != 0)
710 {
711 cerr << "FATAL -> Could not set non-blocking flag " << strerror(errno) << endl;
712 exit(100);
713 }
714 }
715 /*}}}*/
716 // WaitFd - Wait for a FD to become readable /*{{{*/
717 // ---------------------------------------------------------------------
718 /* This waits for a FD to become readable using select. It is useful for
719 applications making use of non-blocking sockets. The timeout is
720 in seconds. */
721 bool WaitFd(int Fd,bool write,unsigned long timeout)
722 {
723 fd_set Set;
724 struct timeval tv;
725 FD_ZERO(&Set);
726 FD_SET(Fd,&Set);
727 tv.tv_sec = timeout;
728 tv.tv_usec = 0;
729 if (write == true)
730 {
731 int Res;
732 do
733 {
734 Res = select(Fd+1,0,&Set,0,(timeout != 0?&tv:0));
735 }
736 while (Res < 0 && errno == EINTR);
737
738 if (Res <= 0)
739 return false;
740 }
741 else
742 {
743 int Res;
744 do
745 {
746 Res = select(Fd+1,&Set,0,0,(timeout != 0?&tv:0));
747 }
748 while (Res < 0 && errno == EINTR);
749
750 if (Res <= 0)
751 return false;
752 }
753
754 return true;
755 }
756 /*}}}*/
757 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
758 // ---------------------------------------------------------------------
759 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
760 * set.
761 */
762 void MergeKeepFdsFromConfiguration(std::set<int> &KeepFDs)
763 {
764 Configuration::Item const *Opts = _config->Tree("APT::Keep-Fds");
765 if (Opts != 0 && Opts->Child != 0)
766 {
767 Opts = Opts->Child;
768 for (; Opts != 0; Opts = Opts->Next)
769 {
770 if (Opts->Value.empty() == true)
771 continue;
772 int fd = atoi(Opts->Value.c_str());
773 KeepFDs.insert(fd);
774 }
775 }
776 }
777 /*}}}*/
778 // ExecFork - Magical fork that sanitizes the context before execing /*{{{*/
779 // ---------------------------------------------------------------------
780 /* This is used if you want to cleanse the environment for the forked
781 child, it fixes up the important signals and nukes all of the fds,
782 otherwise acts like normal fork. */
783 pid_t ExecFork()
784 {
785 set<int> KeepFDs;
786 // we need to merge the Keep-Fds as external tools like
787 // debconf-apt-progress use it
788 MergeKeepFdsFromConfiguration(KeepFDs);
789 return ExecFork(KeepFDs);
790 }
791
792 pid_t ExecFork(std::set<int> KeepFDs)
793 {
794 // Fork off the process
795 pid_t Process = fork();
796 if (Process < 0)
797 {
798 cerr << "FATAL -> Failed to fork." << endl;
799 exit(100);
800 }
801
802 // Spawn the subprocess
803 if (Process == 0)
804 {
805 // Setup the signals
806 signal(SIGPIPE,SIG_DFL);
807 signal(SIGQUIT,SIG_DFL);
808 signal(SIGINT,SIG_DFL);
809 signal(SIGWINCH,SIG_DFL);
810 signal(SIGCONT,SIG_DFL);
811 signal(SIGTSTP,SIG_DFL);
812
813 DIR *dir = opendir("/proc/self/fd");
814 if (dir != NULL)
815 {
816 struct dirent *ent;
817 while ((ent = readdir(dir)))
818 {
819 int fd = atoi(ent->d_name);
820 // If fd > 0, it was a fd number and not . or ..
821 if (fd >= 3 && KeepFDs.find(fd) == KeepFDs.end())
822 fcntl(fd,F_SETFD,FD_CLOEXEC);
823 }
824 closedir(dir);
825 } else {
826 long ScOpenMax = sysconf(_SC_OPEN_MAX);
827 // Close all of our FDs - just in case
828 for (int K = 3; K != ScOpenMax; K++)
829 {
830 if(KeepFDs.find(K) == KeepFDs.end())
831 fcntl(K,F_SETFD,FD_CLOEXEC);
832 }
833 }
834 }
835
836 return Process;
837 }
838 /*}}}*/
839 // ExecWait - Fancy waitpid /*{{{*/
840 // ---------------------------------------------------------------------
841 /* Waits for the given sub process. If Reap is set then no errors are
842 generated. Otherwise a failed subprocess will generate a proper descriptive
843 message */
844 bool ExecWait(pid_t Pid,const char *Name,bool Reap)
845 {
846 if (Pid <= 1)
847 return true;
848
849 // Wait and collect the error code
850 int Status;
851 while (waitpid(Pid,&Status,0) != Pid)
852 {
853 if (errno == EINTR)
854 continue;
855
856 if (Reap == true)
857 return false;
858
859 return _error->Error(_("Waited for %s but it wasn't there"),Name);
860 }
861
862
863 // Check for an error code.
864 if (WIFEXITED(Status) == 0 || WEXITSTATUS(Status) != 0)
865 {
866 if (Reap == true)
867 return false;
868 if (WIFSIGNALED(Status) != 0)
869 {
870 if( WTERMSIG(Status) == SIGSEGV)
871 return _error->Error(_("Sub-process %s received a segmentation fault."),Name);
872 else
873 return _error->Error(_("Sub-process %s received signal %u."),Name, WTERMSIG(Status));
874 }
875
876 if (WIFEXITED(Status) != 0)
877 return _error->Error(_("Sub-process %s returned an error code (%u)"),Name,WEXITSTATUS(Status));
878
879 return _error->Error(_("Sub-process %s exited unexpectedly"),Name);
880 }
881
882 return true;
883 }
884 /*}}}*/
885 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
886 bool StartsWithGPGClearTextSignature(string const &FileName)
887 {
888 static const char* SIGMSG = "-----BEGIN PGP SIGNED MESSAGE-----\n";
889 char buffer[strlen(SIGMSG)+1];
890 FILE* gpg = fopen(FileName.c_str(), "r");
891 if (gpg == NULL)
892 return false;
893
894 char const * const test = fgets(buffer, sizeof(buffer), gpg);
895 fclose(gpg);
896 if (test == NULL || strcmp(buffer, SIGMSG) != 0)
897 return false;
898
899 return true;
900 }
901 /*}}}*/
902 // ChangeOwnerAndPermissionOfFile - set file attributes to requested values /*{{{*/
903 bool ChangeOwnerAndPermissionOfFile(char const * const requester, char const * const file, char const * const user, char const * const group, mode_t const mode)
904 {
905 if (strcmp(file, "/dev/null") == 0)
906 return true;
907 bool Res = true;
908 if (getuid() == 0 && strlen(user) != 0 && strlen(group) != 0) // if we aren't root, we can't chown, so don't try it
909 {
910 // ensure the file is owned by root and has good permissions
911 struct passwd const * const pw = getpwnam(user);
912 struct group const * const gr = getgrnam(group);
913 if (pw != NULL && gr != NULL && chown(file, pw->pw_uid, gr->gr_gid) != 0)
914 Res &= _error->WarningE(requester, "chown to %s:%s of file %s failed", user, group, file);
915 }
916 if (chmod(file, mode) != 0)
917 Res &= _error->WarningE(requester, "chmod 0%o of file %s failed", mode, file);
918 return Res;
919 }
920 /*}}}*/
921
922 struct APT_HIDDEN simple_buffer { /*{{{*/
923 static constexpr size_t buffersize_max = 4096;
924 unsigned long long bufferstart = 0;
925 unsigned long long bufferend = 0;
926 char buffer[buffersize_max];
927
928 const char *get() const { return buffer + bufferstart; }
929 char *get() { return buffer + bufferstart; }
930 bool empty() const { return bufferend <= bufferstart; }
931 unsigned long long size() const { return bufferend-bufferstart; }
932 void reset() { bufferend = bufferstart = 0; }
933 ssize_t read(void *to, unsigned long long requested_size) APT_MUSTCHECK
934 {
935 if (size() < requested_size)
936 requested_size = size();
937 memcpy(to, buffer + bufferstart, requested_size);
938 bufferstart += requested_size;
939 if (bufferstart == bufferend)
940 bufferstart = bufferend = 0;
941 return requested_size;
942 }
943 };
944 /*}}}*/
945
946 class APT_HIDDEN FileFdPrivate { /*{{{*/
947 protected:
948 FileFd * const filefd;
949 simple_buffer buffer;
950 public:
951 int compressed_fd;
952 pid_t compressor_pid;
953 bool is_pipe;
954 APT::Configuration::Compressor compressor;
955 unsigned int openmode;
956 unsigned long long seekpos;
957 explicit FileFdPrivate(FileFd * const pfilefd) : filefd(pfilefd),
958 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
959 openmode(0), seekpos(0) {};
960
961 virtual bool InternalOpen(int const iFd, unsigned int const Mode) = 0;
962 ssize_t InternalRead(void * To, unsigned long long Size)
963 {
964 // Drain the buffer if needed.
965 if (buffer.empty() == false)
966 {
967 return buffer.read(To, Size);
968 }
969 return InternalUnbufferedRead(To, Size);
970 }
971 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) = 0;
972 virtual bool InternalReadError() { return filefd->FileFdErrno("read",_("Read error")); }
973 virtual char * InternalReadLine(char * To, unsigned long long Size)
974 {
975 if (unlikely(Size == 0))
976 return nullptr;
977 // Read one byte less than buffer size to have space for trailing 0.
978 --Size;
979
980 char * const InitialTo = To;
981
982 while (Size > 0) {
983 if (buffer.empty() == true)
984 {
985 buffer.reset();
986 unsigned long long actualread = 0;
987 if (filefd->Read(buffer.get(), buffer.buffersize_max, &actualread) == false)
988 return nullptr;
989 buffer.bufferend = actualread;
990 if (buffer.size() == 0)
991 {
992 if (To == InitialTo)
993 return nullptr;
994 break;
995 }
996 filefd->Flags &= ~FileFd::HitEof;
997 }
998
999 unsigned long long const OutputSize = std::min(Size, buffer.size());
1000 char const * const newline = static_cast<char const * const>(memchr(buffer.get(), '\n', OutputSize));
1001 // Read until end of line or up to Size bytes from the buffer.
1002 unsigned long long actualread = buffer.read(To,
1003 (newline != nullptr)
1004 ? (newline - buffer.get()) + 1
1005 : OutputSize);
1006 To += actualread;
1007 Size -= actualread;
1008 if (newline != nullptr)
1009 break;
1010 }
1011 *To = '\0';
1012 return InitialTo;
1013 }
1014 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) = 0;
1015 virtual bool InternalWriteError() { return filefd->FileFdErrno("write",_("Write error")); }
1016 virtual bool InternalSeek(unsigned long long const To)
1017 {
1018 // Our poor man seeking is costly, so try to avoid it
1019 unsigned long long const iseekpos = filefd->Tell();
1020 if (iseekpos == To)
1021 return true;
1022 else if (iseekpos < To)
1023 return filefd->Skip(To - iseekpos);
1024
1025 if ((openmode & FileFd::ReadOnly) != FileFd::ReadOnly)
1026 return filefd->FileFdError("Reopen is only implemented for read-only files!");
1027 InternalClose(filefd->FileName);
1028 if (filefd->iFd != -1)
1029 close(filefd->iFd);
1030 filefd->iFd = -1;
1031 if (filefd->TemporaryFileName.empty() == false)
1032 filefd->iFd = open(filefd->TemporaryFileName.c_str(), O_RDONLY);
1033 else if (filefd->FileName.empty() == false)
1034 filefd->iFd = open(filefd->FileName.c_str(), O_RDONLY);
1035 else
1036 {
1037 if (compressed_fd > 0)
1038 if (lseek(compressed_fd, 0, SEEK_SET) != 0)
1039 filefd->iFd = compressed_fd;
1040 if (filefd->iFd < 0)
1041 return filefd->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1042 }
1043
1044 if (filefd->OpenInternDescriptor(openmode, compressor) == false)
1045 return filefd->FileFdError("Seek on file %s because it couldn't be reopened", filefd->FileName.c_str());
1046
1047 buffer.reset();
1048 if (To != 0)
1049 return filefd->Skip(To);
1050
1051 seekpos = To;
1052 return true;
1053 }
1054 virtual bool InternalSkip(unsigned long long Over)
1055 {
1056 unsigned long long constexpr buffersize = 1024;
1057 char buffer[buffersize];
1058 while (Over != 0)
1059 {
1060 unsigned long long toread = std::min(buffersize, Over);
1061 if (filefd->Read(buffer, toread) == false)
1062 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1063 Over -= toread;
1064 }
1065 return true;
1066 }
1067 virtual bool InternalTruncate(unsigned long long const)
1068 {
1069 return filefd->FileFdError("Truncating compressed files is not implemented (%s)", filefd->FileName.c_str());
1070 }
1071 virtual unsigned long long InternalTell()
1072 {
1073 // In theory, we could just return seekpos here always instead of
1074 // seeking around, but not all users of FileFd use always Seek() and co
1075 // so d->seekpos isn't always true and we can just use it as a hint if
1076 // we have nothing else, but not always as an authority…
1077 return seekpos - buffer.size();
1078 }
1079 virtual unsigned long long InternalSize()
1080 {
1081 unsigned long long size = 0;
1082 unsigned long long const oldSeek = filefd->Tell();
1083 unsigned long long constexpr ignoresize = 1024;
1084 char ignore[ignoresize];
1085 unsigned long long read = 0;
1086 do {
1087 if (filefd->Read(ignore, ignoresize, &read) == false)
1088 {
1089 filefd->Seek(oldSeek);
1090 return 0;
1091 }
1092 } while(read != 0);
1093 size = filefd->Tell();
1094 filefd->Seek(oldSeek);
1095 return size;
1096 }
1097 virtual bool InternalClose(std::string const &FileName) = 0;
1098 virtual bool InternalStream() const { return false; }
1099 virtual bool InternalAlwaysAutoClose() const { return true; }
1100
1101 virtual ~FileFdPrivate() {}
1102 };
1103 /*}}}*/
1104 class APT_HIDDEN GzipFileFdPrivate: public FileFdPrivate { /*{{{*/
1105 #ifdef HAVE_ZLIB
1106 public:
1107 gzFile gz;
1108 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1109 {
1110 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1111 gz = gzdopen(iFd, "r+");
1112 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1113 gz = gzdopen(iFd, "w");
1114 else
1115 gz = gzdopen(iFd, "r");
1116 filefd->Flags |= FileFd::Compressed;
1117 return gz != nullptr;
1118 }
1119 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1120 {
1121 return gzread(gz, To, Size);
1122 }
1123 virtual bool InternalReadError() override
1124 {
1125 int err;
1126 char const * const errmsg = gzerror(gz, &err);
1127 if (err != Z_ERRNO)
1128 return filefd->FileFdError("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1129 return FileFdPrivate::InternalReadError();
1130 }
1131 virtual char * InternalReadLine(char * To, unsigned long long Size) override
1132 {
1133 return gzgets(gz, To, Size);
1134 }
1135 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1136 {
1137 return gzwrite(gz,From,Size);
1138 }
1139 virtual bool InternalWriteError() override
1140 {
1141 int err;
1142 char const * const errmsg = gzerror(gz, &err);
1143 if (err != Z_ERRNO)
1144 return filefd->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1145 return FileFdPrivate::InternalWriteError();
1146 }
1147 virtual bool InternalSeek(unsigned long long const To) override
1148 {
1149 off_t const res = gzseek(gz, To, SEEK_SET);
1150 if (res != (off_t)To)
1151 return filefd->FileFdError("Unable to seek to %llu", To);
1152 seekpos = To;
1153 buffer.reset();
1154 return true;
1155 }
1156 virtual bool InternalSkip(unsigned long long Over) override
1157 {
1158 if (Over >= buffer.size())
1159 {
1160 Over -= buffer.size();
1161 buffer.reset();
1162 }
1163 else
1164 {
1165 buffer.bufferstart += Over;
1166 return true;
1167 }
1168 if (Over == 0)
1169 return true;
1170 off_t const res = gzseek(gz, Over, SEEK_CUR);
1171 if (res < 0)
1172 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1173 seekpos = res;
1174 return true;
1175 }
1176 virtual unsigned long long InternalTell() override
1177 {
1178 return gztell(gz) - buffer.size();
1179 }
1180 virtual unsigned long long InternalSize() override
1181 {
1182 unsigned long long filesize = FileFdPrivate::InternalSize();
1183 // only check gzsize if we are actually a gzip file, just checking for
1184 // "gz" is not sufficient as uncompressed files could be opened with
1185 // gzopen in "direct" mode as well
1186 if (filesize == 0 || gzdirect(gz))
1187 return filesize;
1188
1189 off_t const oldPos = lseek(filefd->iFd, 0, SEEK_CUR);
1190 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1191 * this ourselves; the original (uncompressed) file size is the last 32
1192 * bits of the file */
1193 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1194 if (lseek(filefd->iFd, -4, SEEK_END) < 0)
1195 {
1196 filefd->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1197 return 0;
1198 }
1199 uint32_t size = 0;
1200 if (read(filefd->iFd, &size, 4) != 4)
1201 {
1202 filefd->FileFdErrno("read","Unable to read original size of gzipped file");
1203 return 0;
1204 }
1205 size = le32toh(size);
1206
1207 if (lseek(filefd->iFd, oldPos, SEEK_SET) < 0)
1208 {
1209 filefd->FileFdErrno("lseek","Unable to seek in gzipped file");
1210 return 0;
1211 }
1212 return size;
1213 }
1214 virtual bool InternalClose(std::string const &FileName) override
1215 {
1216 if (gz == nullptr)
1217 return true;
1218 int const e = gzclose(gz);
1219 gz = nullptr;
1220 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1221 if (e != 0 && e != Z_BUF_ERROR)
1222 return _error->Errno("close",_("Problem closing the gzip file %s"), FileName.c_str());
1223 return true;
1224 }
1225
1226 explicit GzipFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), gz(nullptr) {}
1227 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1228 #endif
1229 };
1230 /*}}}*/
1231 class APT_HIDDEN Bz2FileFdPrivate: public FileFdPrivate { /*{{{*/
1232 #ifdef HAVE_BZ2
1233 BZFILE* bz2;
1234 public:
1235 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1236 {
1237 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1238 bz2 = BZ2_bzdopen(iFd, "r+");
1239 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1240 bz2 = BZ2_bzdopen(iFd, "w");
1241 else
1242 bz2 = BZ2_bzdopen(iFd, "r");
1243 filefd->Flags |= FileFd::Compressed;
1244 return bz2 != nullptr;
1245 }
1246 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1247 {
1248 return BZ2_bzread(bz2, To, Size);
1249 }
1250 virtual bool InternalReadError() override
1251 {
1252 int err;
1253 char const * const errmsg = BZ2_bzerror(bz2, &err);
1254 if (err != BZ_IO_ERROR)
1255 return filefd->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd->FileName.c_str(), _("Read error"), err, errmsg);
1256 return FileFdPrivate::InternalReadError();
1257 }
1258 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1259 {
1260 return BZ2_bzwrite(bz2, (void*)From, Size);
1261 }
1262 virtual bool InternalWriteError() override
1263 {
1264 int err;
1265 char const * const errmsg = BZ2_bzerror(bz2, &err);
1266 if (err != BZ_IO_ERROR)
1267 return filefd->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd->FileName.c_str(), _("Write error"), err, errmsg);
1268 return FileFdPrivate::InternalWriteError();
1269 }
1270 virtual bool InternalStream() const override { return true; }
1271 virtual bool InternalClose(std::string const &) override
1272 {
1273 if (bz2 == nullptr)
1274 return true;
1275 BZ2_bzclose(bz2);
1276 bz2 = nullptr;
1277 return true;
1278 }
1279
1280 explicit Bz2FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), bz2(nullptr) {}
1281 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1282 #endif
1283 };
1284 /*}}}*/
1285 class APT_HIDDEN LzmaFileFdPrivate: public FileFdPrivate { /*{{{*/
1286 #ifdef HAVE_LZMA
1287 struct LZMAFILE {
1288 FILE* file;
1289 uint8_t buffer[4096];
1290 lzma_stream stream;
1291 lzma_ret err;
1292 bool eof;
1293 bool compressing;
1294
1295 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer[0] = '\0'; }
1296 ~LZMAFILE()
1297 {
1298 if (compressing == true)
1299 {
1300 size_t constexpr buffersize = sizeof(buffer)/sizeof(buffer[0]);
1301 while(true)
1302 {
1303 stream.avail_out = buffersize;
1304 stream.next_out = buffer;
1305 err = lzma_code(&stream, LZMA_FINISH);
1306 if (err != LZMA_OK && err != LZMA_STREAM_END)
1307 {
1308 _error->Error("~LZMAFILE: Compress finalisation failed");
1309 break;
1310 }
1311 size_t const n = buffersize - stream.avail_out;
1312 if (n && fwrite(buffer, 1, n, file) != n)
1313 {
1314 _error->Errno("~LZMAFILE",_("Write error"));
1315 break;
1316 }
1317 if (err == LZMA_STREAM_END)
1318 break;
1319 }
1320 }
1321 lzma_end(&stream);
1322 fclose(file);
1323 }
1324 };
1325 LZMAFILE* lzma;
1326 static uint32_t findXZlevel(std::vector<std::string> const &Args)
1327 {
1328 for (auto a = Args.rbegin(); a != Args.rend(); ++a)
1329 if (a->empty() == false && (*a)[0] == '-' && (*a)[1] != '-')
1330 {
1331 auto const number = a->find_last_of("0123456789");
1332 if (number == std::string::npos)
1333 continue;
1334 auto const extreme = a->find("e", number);
1335 uint32_t level = (extreme != std::string::npos) ? LZMA_PRESET_EXTREME : 0;
1336 switch ((*a)[number])
1337 {
1338 case '0': return level | 0;
1339 case '1': return level | 1;
1340 case '2': return level | 2;
1341 case '3': return level | 3;
1342 case '4': return level | 4;
1343 case '5': return level | 5;
1344 case '6': return level | 6;
1345 case '7': return level | 7;
1346 case '8': return level | 8;
1347 case '9': return level | 9;
1348 }
1349 }
1350 return 6;
1351 }
1352 public:
1353 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1354 {
1355 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1356 return filefd->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd->FileName.c_str());
1357
1358 if (lzma == nullptr)
1359 lzma = new LzmaFileFdPrivate::LZMAFILE;
1360 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1361 lzma->file = fdopen(iFd, "w");
1362 else
1363 lzma->file = fdopen(iFd, "r");
1364 filefd->Flags |= FileFd::Compressed;
1365 if (lzma->file == nullptr)
1366 return false;
1367
1368 lzma_stream tmp_stream = LZMA_STREAM_INIT;
1369 lzma->stream = tmp_stream;
1370
1371 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1372 {
1373 uint32_t const xzlevel = findXZlevel(compressor.CompressArgs);
1374 if (compressor.Name == "xz")
1375 {
1376 if (lzma_easy_encoder(&lzma->stream, xzlevel, LZMA_CHECK_CRC64) != LZMA_OK)
1377 return false;
1378 }
1379 else
1380 {
1381 lzma_options_lzma options;
1382 lzma_lzma_preset(&options, xzlevel);
1383 if (lzma_alone_encoder(&lzma->stream, &options) != LZMA_OK)
1384 return false;
1385 }
1386 lzma->compressing = true;
1387 }
1388 else
1389 {
1390 uint64_t const memlimit = UINT64_MAX;
1391 if (compressor.Name == "xz")
1392 {
1393 if (lzma_auto_decoder(&lzma->stream, memlimit, 0) != LZMA_OK)
1394 return false;
1395 }
1396 else
1397 {
1398 if (lzma_alone_decoder(&lzma->stream, memlimit) != LZMA_OK)
1399 return false;
1400 }
1401 lzma->compressing = false;
1402 }
1403 return true;
1404 }
1405 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1406 {
1407 ssize_t Res;
1408 if (lzma->eof == true)
1409 return 0;
1410
1411 lzma->stream.next_out = (uint8_t *) To;
1412 lzma->stream.avail_out = Size;
1413 if (lzma->stream.avail_in == 0)
1414 {
1415 lzma->stream.next_in = lzma->buffer;
1416 lzma->stream.avail_in = fread(lzma->buffer, 1, sizeof(lzma->buffer)/sizeof(lzma->buffer[0]), lzma->file);
1417 }
1418 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1419 if (lzma->err == LZMA_STREAM_END)
1420 {
1421 lzma->eof = true;
1422 Res = Size - lzma->stream.avail_out;
1423 }
1424 else if (lzma->err != LZMA_OK)
1425 {
1426 Res = -1;
1427 errno = 0;
1428 }
1429 else
1430 {
1431 Res = Size - lzma->stream.avail_out;
1432 if (Res == 0)
1433 {
1434 // lzma run was okay, but produced no output…
1435 Res = -1;
1436 errno = EINTR;
1437 }
1438 }
1439 return Res;
1440 }
1441 virtual bool InternalReadError() override
1442 {
1443 return filefd->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma->err);
1444 }
1445 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1446 {
1447 lzma->stream.next_in = (uint8_t *)From;
1448 lzma->stream.avail_in = Size;
1449 lzma->stream.next_out = lzma->buffer;
1450 lzma->stream.avail_out = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]);
1451 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1452 if (lzma->err != LZMA_OK)
1453 return -1;
1454 size_t const n = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]) - lzma->stream.avail_out;
1455 size_t const m = (n == 0) ? 0 : fwrite(lzma->buffer, 1, n, lzma->file);
1456 if (m != n)
1457 return -1;
1458 else
1459 return Size - lzma->stream.avail_in;
1460 }
1461 virtual bool InternalWriteError() override
1462 {
1463 return filefd->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma->err);
1464 }
1465 virtual bool InternalStream() const override { return true; }
1466 virtual bool InternalClose(std::string const &) override
1467 {
1468 delete lzma;
1469 lzma = nullptr;
1470 return true;
1471 }
1472
1473 explicit LzmaFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), lzma(nullptr) {}
1474 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1475 #endif
1476 };
1477 /*}}}*/
1478 class APT_HIDDEN PipedFileFdPrivate: public FileFdPrivate /*{{{*/
1479 /* if we don't have a specific class dealing with library calls, we (un)compress
1480 by executing a specified binary and pipe in/out what we need */
1481 {
1482 public:
1483 virtual bool InternalOpen(int const, unsigned int const Mode) override
1484 {
1485 // collect zombies here in case we reopen
1486 if (compressor_pid > 0)
1487 ExecWait(compressor_pid, "FileFdCompressor", true);
1488
1489 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1490 return filefd->FileFdError("ReadWrite mode is not supported for file %s", filefd->FileName.c_str());
1491
1492 bool const Comp = (Mode & FileFd::WriteOnly) == FileFd::WriteOnly;
1493 if (Comp == false)
1494 {
1495 // Handle 'decompression' of empty files
1496 struct stat Buf;
1497 fstat(filefd->iFd, &Buf);
1498 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1499 return true;
1500
1501 // We don't need the file open - instead let the compressor open it
1502 // as he properly knows better how to efficiently read from 'his' file
1503 if (filefd->FileName.empty() == false)
1504 {
1505 close(filefd->iFd);
1506 filefd->iFd = -1;
1507 }
1508 }
1509
1510 // Create a data pipe
1511 int Pipe[2] = {-1,-1};
1512 if (pipe(Pipe) != 0)
1513 return filefd->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1514 for (int J = 0; J != 2; J++)
1515 SetCloseExec(Pipe[J],true);
1516
1517 compressed_fd = filefd->iFd;
1518 is_pipe = true;
1519
1520 if (Comp == true)
1521 filefd->iFd = Pipe[1];
1522 else
1523 filefd->iFd = Pipe[0];
1524
1525 // The child..
1526 compressor_pid = ExecFork();
1527 if (compressor_pid == 0)
1528 {
1529 if (Comp == true)
1530 {
1531 dup2(compressed_fd,STDOUT_FILENO);
1532 dup2(Pipe[0],STDIN_FILENO);
1533 }
1534 else
1535 {
1536 if (compressed_fd != -1)
1537 dup2(compressed_fd,STDIN_FILENO);
1538 dup2(Pipe[1],STDOUT_FILENO);
1539 }
1540 int const nullfd = open("/dev/null", O_WRONLY);
1541 if (nullfd != -1)
1542 {
1543 dup2(nullfd,STDERR_FILENO);
1544 close(nullfd);
1545 }
1546
1547 SetCloseExec(STDOUT_FILENO,false);
1548 SetCloseExec(STDIN_FILENO,false);
1549
1550 std::vector<char const*> Args;
1551 Args.push_back(compressor.Binary.c_str());
1552 std::vector<std::string> const * const addArgs =
1553 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1554 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1555 a != addArgs->end(); ++a)
1556 Args.push_back(a->c_str());
1557 if (Comp == false && filefd->FileName.empty() == false)
1558 {
1559 // commands not needing arguments, do not need to be told about using standard output
1560 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1561 if (compressor.CompressArgs.empty() == false && compressor.UncompressArgs.empty() == false)
1562 Args.push_back("--stdout");
1563 if (filefd->TemporaryFileName.empty() == false)
1564 Args.push_back(filefd->TemporaryFileName.c_str());
1565 else
1566 Args.push_back(filefd->FileName.c_str());
1567 }
1568 Args.push_back(NULL);
1569
1570 execvp(Args[0],(char **)&Args[0]);
1571 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1572 _exit(100);
1573 }
1574 if (Comp == true)
1575 close(Pipe[0]);
1576 else
1577 close(Pipe[1]);
1578
1579 return true;
1580 }
1581 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1582 {
1583 return read(filefd->iFd, To, Size);
1584 }
1585 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1586 {
1587 return write(filefd->iFd, From, Size);
1588 }
1589 virtual bool InternalClose(std::string const &) override
1590 {
1591 bool Ret = true;
1592 if (compressor_pid > 0)
1593 Ret &= ExecWait(compressor_pid, "FileFdCompressor", true);
1594 compressor_pid = -1;
1595 return Ret;
1596 }
1597 explicit PipedFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
1598 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1599 };
1600 /*}}}*/
1601 class APT_HIDDEN DirectFileFdPrivate: public FileFdPrivate /*{{{*/
1602 {
1603 public:
1604 virtual bool InternalOpen(int const, unsigned int const) override { return true; }
1605 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1606 {
1607 return read(filefd->iFd, To, Size);
1608 }
1609 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1610 {
1611 // files opened read+write are strange and only really "supported" for direct files
1612 if (buffer.size() != 0)
1613 {
1614 lseek(filefd->iFd, -buffer.size(), SEEK_CUR);
1615 buffer.reset();
1616 }
1617 return write(filefd->iFd, From, Size);
1618 }
1619 virtual bool InternalSeek(unsigned long long const To) override
1620 {
1621 off_t const res = lseek(filefd->iFd, To, SEEK_SET);
1622 if (res != (off_t)To)
1623 return filefd->FileFdError("Unable to seek to %llu", To);
1624 seekpos = To;
1625 buffer.reset();
1626 return true;
1627 }
1628 virtual bool InternalSkip(unsigned long long Over) override
1629 {
1630 if (Over >= buffer.size())
1631 {
1632 Over -= buffer.size();
1633 buffer.reset();
1634 }
1635 else
1636 {
1637 buffer.bufferstart += Over;
1638 return true;
1639 }
1640 if (Over == 0)
1641 return true;
1642 off_t const res = lseek(filefd->iFd, Over, SEEK_CUR);
1643 if (res < 0)
1644 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1645 seekpos = res;
1646 return true;
1647 }
1648 virtual bool InternalTruncate(unsigned long long const To) override
1649 {
1650 if (buffer.size() != 0)
1651 {
1652 unsigned long long const seekpos = lseek(filefd->iFd, 0, SEEK_CUR);
1653 if ((seekpos - buffer.size()) >= To)
1654 buffer.reset();
1655 else if (seekpos >= To)
1656 buffer.bufferend = (To - seekpos) + buffer.bufferstart;
1657 else
1658 buffer.reset();
1659 }
1660 if (ftruncate(filefd->iFd, To) != 0)
1661 return filefd->FileFdError("Unable to truncate to %llu",To);
1662 return true;
1663 }
1664 virtual unsigned long long InternalTell() override
1665 {
1666 return lseek(filefd->iFd,0,SEEK_CUR) - buffer.size();
1667 }
1668 virtual unsigned long long InternalSize() override
1669 {
1670 return filefd->FileSize();
1671 }
1672 virtual bool InternalClose(std::string const &) override { return true; }
1673 virtual bool InternalAlwaysAutoClose() const override { return false; }
1674
1675 explicit DirectFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
1676 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1677 };
1678 /*}}}*/
1679 // FileFd Constructors /*{{{*/
1680 FileFd::FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1681 {
1682 Open(FileName,Mode, None, AccessMode);
1683 }
1684 FileFd::FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1685 {
1686 Open(FileName,Mode, Compress, AccessMode);
1687 }
1688 FileFd::FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {}
1689 FileFd::FileFd(int const Fd, unsigned int const Mode, CompressMode Compress) : iFd(-1), Flags(0), d(NULL)
1690 {
1691 OpenDescriptor(Fd, Mode, Compress);
1692 }
1693 FileFd::FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
1694 {
1695 OpenDescriptor(Fd, ReadWrite, None, AutoClose);
1696 }
1697 /*}}}*/
1698 // FileFd::Open - Open a file /*{{{*/
1699 // ---------------------------------------------------------------------
1700 /* The most commonly used open mode combinations are given with Mode */
1701 bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const AccessMode)
1702 {
1703 if (Mode == ReadOnlyGzip)
1704 return Open(FileName, ReadOnly, Gzip, AccessMode);
1705
1706 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
1707 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
1708
1709 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
1710 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
1711 if (Compress == Auto)
1712 {
1713 for (; compressor != compressors.end(); ++compressor)
1714 {
1715 std::string file = FileName + compressor->Extension;
1716 if (FileExists(file) == false)
1717 continue;
1718 FileName = file;
1719 break;
1720 }
1721 }
1722 else if (Compress == Extension)
1723 {
1724 std::string::size_type const found = FileName.find_last_of('.');
1725 std::string ext;
1726 if (found != std::string::npos)
1727 {
1728 ext = FileName.substr(found);
1729 if (ext == ".new" || ext == ".bak")
1730 {
1731 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
1732 if (found2 != std::string::npos)
1733 ext = FileName.substr(found2, found - found2);
1734 else
1735 ext.clear();
1736 }
1737 }
1738 for (; compressor != compressors.end(); ++compressor)
1739 if (ext == compressor->Extension)
1740 break;
1741 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1742 if (compressor == compressors.end())
1743 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
1744 if (compressor->Name == ".")
1745 break;
1746 }
1747 else
1748 {
1749 std::string name;
1750 switch (Compress)
1751 {
1752 case None: name = "."; break;
1753 case Gzip: name = "gzip"; break;
1754 case Bzip2: name = "bzip2"; break;
1755 case Lzma: name = "lzma"; break;
1756 case Xz: name = "xz"; break;
1757 case Auto:
1758 case Extension:
1759 // Unreachable
1760 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
1761 }
1762 for (; compressor != compressors.end(); ++compressor)
1763 if (compressor->Name == name)
1764 break;
1765 if (compressor == compressors.end())
1766 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
1767 }
1768
1769 if (compressor == compressors.end())
1770 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName.c_str());
1771 return Open(FileName, Mode, *compressor, AccessMode);
1772 }
1773 bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const AccessMode)
1774 {
1775 Close();
1776 Flags = AutoClose;
1777
1778 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
1779 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
1780 if ((Mode & ReadWrite) == 0)
1781 return FileFdError("No openmode provided in FileFd::Open for %s", FileName.c_str());
1782
1783 unsigned int OpenMode = Mode;
1784 if (FileName == "/dev/null")
1785 OpenMode = OpenMode & ~(Atomic | Exclusive | Create | Empty);
1786
1787 if ((OpenMode & Atomic) == Atomic)
1788 {
1789 Flags |= Replace;
1790 }
1791 else if ((OpenMode & (Exclusive | Create)) == (Exclusive | Create))
1792 {
1793 // for atomic, this will be done by rename in Close()
1794 RemoveFile("FileFd::Open", FileName);
1795 }
1796 if ((OpenMode & Empty) == Empty)
1797 {
1798 struct stat Buf;
1799 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
1800 RemoveFile("FileFd::Open", FileName);
1801 }
1802
1803 int fileflags = 0;
1804 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
1805 if_FLAGGED_SET(ReadWrite, O_RDWR);
1806 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
1807 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
1808
1809 if_FLAGGED_SET(Create, O_CREAT);
1810 if_FLAGGED_SET(Empty, O_TRUNC);
1811 if_FLAGGED_SET(Exclusive, O_EXCL);
1812 #undef if_FLAGGED_SET
1813
1814 if ((OpenMode & Atomic) == Atomic)
1815 {
1816 char *name = strdup((FileName + ".XXXXXX").c_str());
1817
1818 if((iFd = mkstemp(name)) == -1)
1819 {
1820 free(name);
1821 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName.c_str());
1822 }
1823
1824 TemporaryFileName = string(name);
1825 free(name);
1826
1827 // umask() will always set the umask and return the previous value, so
1828 // we first set the umask and then reset it to the old value
1829 mode_t const CurrentUmask = umask(0);
1830 umask(CurrentUmask);
1831 // calculate the actual file permissions (just like open/creat)
1832 mode_t const FilePermissions = (AccessMode & ~CurrentUmask);
1833
1834 if(fchmod(iFd, FilePermissions) == -1)
1835 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName.c_str());
1836 }
1837 else
1838 iFd = open(FileName.c_str(), fileflags, AccessMode);
1839
1840 this->FileName = FileName;
1841 if (iFd == -1 || OpenInternDescriptor(OpenMode, compressor) == false)
1842 {
1843 if (iFd != -1)
1844 {
1845 close (iFd);
1846 iFd = -1;
1847 }
1848 return FileFdErrno("open",_("Could not open file %s"), FileName.c_str());
1849 }
1850
1851 SetCloseExec(iFd,true);
1852 return true;
1853 }
1854 /*}}}*/
1855 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1856 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
1857 {
1858 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
1859 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
1860 std::string name;
1861
1862 // compat with the old API
1863 if (Mode == ReadOnlyGzip && Compress == None)
1864 Compress = Gzip;
1865
1866 switch (Compress)
1867 {
1868 case None: name = "."; break;
1869 case Gzip: name = "gzip"; break;
1870 case Bzip2: name = "bzip2"; break;
1871 case Lzma: name = "lzma"; break;
1872 case Xz: name = "xz"; break;
1873 case Auto:
1874 case Extension:
1875 if (AutoClose == true && Fd != -1)
1876 close(Fd);
1877 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
1878 }
1879 for (; compressor != compressors.end(); ++compressor)
1880 if (compressor->Name == name)
1881 break;
1882 if (compressor == compressors.end())
1883 {
1884 if (AutoClose == true && Fd != -1)
1885 close(Fd);
1886 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
1887 }
1888 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
1889 }
1890 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
1891 {
1892 Close();
1893 Flags = (AutoClose) ? FileFd::AutoClose : 0;
1894 iFd = Fd;
1895 this->FileName = "";
1896 if (OpenInternDescriptor(Mode, compressor) == false)
1897 {
1898 if (iFd != -1 && (
1899 (Flags & Compressed) == Compressed ||
1900 AutoClose == true))
1901 {
1902 close (iFd);
1903 iFd = -1;
1904 }
1905 return FileFdError(_("Could not open file descriptor %d"), Fd);
1906 }
1907 return true;
1908 }
1909 bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
1910 {
1911 if (iFd == -1)
1912 return false;
1913
1914 if (d != nullptr)
1915 d->InternalClose(FileName);
1916
1917 if (d == nullptr)
1918 {
1919 if (false)
1920 /* dummy so that the rest can be 'else if's */;
1921 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
1922 else if (compressor.Name == NAME) \
1923 d = new CONSTRUCTOR(this)
1924 #ifdef HAVE_ZLIB
1925 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate);
1926 #endif
1927 #ifdef HAVE_BZ2
1928 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate);
1929 #endif
1930 #ifdef HAVE_LZMA
1931 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate);
1932 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate);
1933 #endif
1934 #undef APT_COMPRESS_INIT
1935 else if (compressor.Name == "." || compressor.Binary.empty() == true)
1936 d = new DirectFileFdPrivate(this);
1937 else
1938 d = new PipedFileFdPrivate(this);
1939
1940 d->openmode = Mode;
1941 d->compressor = compressor;
1942 if ((Flags & AutoClose) != AutoClose && d->InternalAlwaysAutoClose())
1943 {
1944 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1945 int const internFd = dup(iFd);
1946 if (internFd == -1)
1947 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd);
1948 iFd = internFd;
1949 }
1950 }
1951 return d->InternalOpen(iFd, Mode);
1952 }
1953 /*}}}*/
1954 // FileFd::~File - Closes the file /*{{{*/
1955 // ---------------------------------------------------------------------
1956 /* If the proper modes are selected then we close the Fd and possibly
1957 unlink the file on error. */
1958 FileFd::~FileFd()
1959 {
1960 Close();
1961 if (d != NULL)
1962 d->InternalClose(FileName);
1963 delete d;
1964 d = NULL;
1965 }
1966 /*}}}*/
1967 // FileFd::Read - Read a bit of the file /*{{{*/
1968 // ---------------------------------------------------------------------
1969 /* We are careful to handle interruption by a signal while reading
1970 gracefully. */
1971 bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
1972 {
1973 if (d == nullptr)
1974 return false;
1975 ssize_t Res = 1;
1976 errno = 0;
1977 if (Actual != 0)
1978 *Actual = 0;
1979 *((char *)To) = '\0';
1980 while (Res > 0 && Size > 0)
1981 {
1982 Res = d->InternalRead(To, Size);
1983
1984 if (Res < 0)
1985 {
1986 if (errno == EINTR)
1987 {
1988 // trick the while-loop into running again
1989 Res = 1;
1990 errno = 0;
1991 continue;
1992 }
1993 return d->InternalReadError();
1994 }
1995
1996 To = (char *)To + Res;
1997 Size -= Res;
1998 if (d != NULL)
1999 d->seekpos += Res;
2000 if (Actual != 0)
2001 *Actual += Res;
2002 }
2003
2004 if (Size == 0)
2005 return true;
2006
2007 // Eof handling
2008 if (Actual != 0)
2009 {
2010 Flags |= HitEof;
2011 return true;
2012 }
2013
2014 return FileFdError(_("read, still have %llu to read but none left"), Size);
2015 }
2016 /*}}}*/
2017 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2018 // ---------------------------------------------------------------------
2019 /* Beware: This method can be quite slow for big buffers on UNcompressed
2020 files because of the naive implementation! */
2021 char* FileFd::ReadLine(char *To, unsigned long long const Size)
2022 {
2023 *To = '\0';
2024 if (d == nullptr)
2025 return nullptr;
2026 return d->InternalReadLine(To, Size);
2027 }
2028 /*}}}*/
2029 // FileFd::Write - Write to the file /*{{{*/
2030 bool FileFd::Write(const void *From,unsigned long long Size)
2031 {
2032 if (d == nullptr)
2033 return false;
2034 ssize_t Res = 1;
2035 errno = 0;
2036 while (Res > 0 && Size > 0)
2037 {
2038 Res = d->InternalWrite(From, Size);
2039 if (Res < 0 && errno == EINTR)
2040 continue;
2041 if (Res < 0)
2042 return d->InternalWriteError();
2043
2044 From = (char const *)From + Res;
2045 Size -= Res;
2046 if (d != NULL)
2047 d->seekpos += Res;
2048 }
2049
2050 if (Size == 0)
2051 return true;
2052
2053 return FileFdError(_("write, still have %llu to write but couldn't"), Size);
2054 }
2055 bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
2056 {
2057 ssize_t Res = 1;
2058 errno = 0;
2059 while (Res > 0 && Size > 0)
2060 {
2061 Res = write(Fd,From,Size);
2062 if (Res < 0 && errno == EINTR)
2063 continue;
2064 if (Res < 0)
2065 return _error->Errno("write",_("Write error"));
2066
2067 From = (char const *)From + Res;
2068 Size -= Res;
2069 }
2070
2071 if (Size == 0)
2072 return true;
2073
2074 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
2075 }
2076 /*}}}*/
2077 // FileFd::Seek - Seek in the file /*{{{*/
2078 bool FileFd::Seek(unsigned long long To)
2079 {
2080 if (d == nullptr)
2081 return false;
2082 Flags &= ~HitEof;
2083 return d->InternalSeek(To);
2084 }
2085 /*}}}*/
2086 // FileFd::Skip - Skip over data in the file /*{{{*/
2087 bool FileFd::Skip(unsigned long long Over)
2088 {
2089 if (d == nullptr)
2090 return false;
2091 return d->InternalSkip(Over);
2092 }
2093 /*}}}*/
2094 // FileFd::Truncate - Truncate the file /*{{{*/
2095 bool FileFd::Truncate(unsigned long long To)
2096 {
2097 if (d == nullptr)
2098 return false;
2099 // truncating /dev/null is always successful - as we get an error otherwise
2100 if (To == 0 && FileName == "/dev/null")
2101 return true;
2102 return d->InternalTruncate(To);
2103 }
2104 /*}}}*/
2105 // FileFd::Tell - Current seek position /*{{{*/
2106 // ---------------------------------------------------------------------
2107 /* */
2108 unsigned long long FileFd::Tell()
2109 {
2110 if (d == nullptr)
2111 return false;
2112 off_t const Res = d->InternalTell();
2113 if (Res == (off_t)-1)
2114 FileFdErrno("lseek","Failed to determine the current file position");
2115 d->seekpos = Res;
2116 return Res;
2117 }
2118 /*}}}*/
2119 static bool StatFileFd(char const * const msg, int const iFd, std::string const &FileName, struct stat &Buf, FileFdPrivate * const d) /*{{{*/
2120 {
2121 bool ispipe = (d != NULL && d->is_pipe == true);
2122 if (ispipe == false)
2123 {
2124 if (fstat(iFd,&Buf) != 0)
2125 // higher-level code will generate more meaningful messages,
2126 // even translated this would be meaningless for users
2127 return _error->Errno("fstat", "Unable to determine %s for fd %i", msg, iFd);
2128 if (FileName.empty() == false)
2129 ispipe = S_ISFIFO(Buf.st_mode);
2130 }
2131
2132 // for compressor pipes st_size is undefined and at 'best' zero
2133 if (ispipe == true)
2134 {
2135 // we set it here, too, as we get the info here for free
2136 // in theory the Open-methods should take care of it already
2137 if (d != NULL)
2138 d->is_pipe = true;
2139 if (stat(FileName.c_str(), &Buf) != 0)
2140 return _error->Errno("fstat", "Unable to determine %s for file %s", msg, FileName.c_str());
2141 }
2142 return true;
2143 }
2144 /*}}}*/
2145 // FileFd::FileSize - Return the size of the file /*{{{*/
2146 unsigned long long FileFd::FileSize()
2147 {
2148 struct stat Buf;
2149 if (StatFileFd("file size", iFd, FileName, Buf, d) == false)
2150 {
2151 Flags |= Fail;
2152 return 0;
2153 }
2154 return Buf.st_size;
2155 }
2156 /*}}}*/
2157 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2158 time_t FileFd::ModificationTime()
2159 {
2160 struct stat Buf;
2161 if (StatFileFd("modification time", iFd, FileName, Buf, d) == false)
2162 {
2163 Flags |= Fail;
2164 return 0;
2165 }
2166 return Buf.st_mtime;
2167 }
2168 /*}}}*/
2169 // FileFd::Size - Return the size of the content in the file /*{{{*/
2170 unsigned long long FileFd::Size()
2171 {
2172 if (d == nullptr)
2173 return false;
2174 return d->InternalSize();
2175 }
2176 /*}}}*/
2177 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2178 // ---------------------------------------------------------------------
2179 /* */
2180 bool FileFd::Close()
2181 {
2182 if (iFd == -1)
2183 return true;
2184
2185 bool Res = true;
2186 if ((Flags & AutoClose) == AutoClose)
2187 {
2188 if ((Flags & Compressed) != Compressed && iFd > 0 && close(iFd) != 0)
2189 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
2190 }
2191
2192 if (d != NULL)
2193 {
2194 Res &= d->InternalClose(FileName);
2195 delete d;
2196 d = NULL;
2197 }
2198
2199 if ((Flags & Replace) == Replace) {
2200 if (rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
2201 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
2202
2203 FileName = TemporaryFileName; // for the unlink() below.
2204 TemporaryFileName.clear();
2205 }
2206
2207 iFd = -1;
2208
2209 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
2210 FileName.empty() == false)
2211 Res &= RemoveFile("FileFd::Close", FileName);
2212
2213 if (Res == false)
2214 Flags |= Fail;
2215 return Res;
2216 }
2217 /*}}}*/
2218 // FileFd::Sync - Sync the file /*{{{*/
2219 // ---------------------------------------------------------------------
2220 /* */
2221 bool FileFd::Sync()
2222 {
2223 if (fsync(iFd) != 0)
2224 return FileFdErrno("sync",_("Problem syncing the file"));
2225 return true;
2226 }
2227 /*}}}*/
2228 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2229 bool FileFd::FileFdErrno(const char *Function, const char *Description,...)
2230 {
2231 Flags |= Fail;
2232 va_list args;
2233 size_t msgSize = 400;
2234 int const errsv = errno;
2235 while (true)
2236 {
2237 va_start(args,Description);
2238 if (_error->InsertErrno(GlobalError::ERROR, Function, Description, args, errsv, msgSize) == false)
2239 break;
2240 va_end(args);
2241 }
2242 return false;
2243 }
2244 /*}}}*/
2245 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2246 bool FileFd::FileFdError(const char *Description,...) {
2247 Flags |= Fail;
2248 va_list args;
2249 size_t msgSize = 400;
2250 while (true)
2251 {
2252 va_start(args,Description);
2253 if (_error->Insert(GlobalError::ERROR, Description, args, msgSize) == false)
2254 break;
2255 va_end(args);
2256 }
2257 return false;
2258 }
2259 /*}}}*/
2260 gzFile FileFd::gzFd() { /*{{{*/
2261 #ifdef HAVE_ZLIB
2262 GzipFileFdPrivate * const gzipd = dynamic_cast<GzipFileFdPrivate*>(d);
2263 if (gzipd == nullptr)
2264 return nullptr;
2265 else
2266 return gzipd->gz;
2267 #else
2268 return nullptr;
2269 #endif
2270 }
2271 /*}}}*/
2272
2273 // Glob - wrapper around "glob()" /*{{{*/
2274 std::vector<std::string> Glob(std::string const &pattern, int flags)
2275 {
2276 std::vector<std::string> result;
2277 glob_t globbuf;
2278 int glob_res;
2279 unsigned int i;
2280
2281 glob_res = glob(pattern.c_str(), flags, NULL, &globbuf);
2282
2283 if (glob_res != 0)
2284 {
2285 if(glob_res != GLOB_NOMATCH) {
2286 _error->Errno("glob", "Problem with glob");
2287 return result;
2288 }
2289 }
2290
2291 // append results
2292 for(i=0;i<globbuf.gl_pathc;i++)
2293 result.push_back(string(globbuf.gl_pathv[i]));
2294
2295 globfree(&globbuf);
2296 return result;
2297 }
2298 /*}}}*/
2299 std::string GetTempDir() /*{{{*/
2300 {
2301 const char *tmpdir = getenv("TMPDIR");
2302
2303 #ifdef P_tmpdir
2304 if (!tmpdir)
2305 tmpdir = P_tmpdir;
2306 #endif
2307
2308 struct stat st;
2309 if (!tmpdir || strlen(tmpdir) == 0 || // tmpdir is set
2310 stat(tmpdir, &st) != 0 || (st.st_mode & S_IFDIR) == 0) // exists and is directory
2311 tmpdir = "/tmp";
2312 else if (geteuid() != 0 && // root can do everything anyway
2313 faccessat(-1, tmpdir, R_OK | W_OK | X_OK, AT_EACCESS | AT_SYMLINK_NOFOLLOW) != 0) // current user has rwx access to directory
2314 tmpdir = "/tmp";
2315
2316 return string(tmpdir);
2317 }
2318 std::string GetTempDir(std::string const &User)
2319 {
2320 // no need/possibility to drop privs
2321 if(getuid() != 0 || User.empty() || User == "root")
2322 return GetTempDir();
2323
2324 struct passwd const * const pw = getpwnam(User.c_str());
2325 if (pw == NULL)
2326 return GetTempDir();
2327
2328 gid_t const old_euid = geteuid();
2329 gid_t const old_egid = getegid();
2330 if (setegid(pw->pw_gid) != 0)
2331 _error->Errno("setegid", "setegid %u failed", pw->pw_gid);
2332 if (seteuid(pw->pw_uid) != 0)
2333 _error->Errno("seteuid", "seteuid %u failed", pw->pw_uid);
2334
2335 std::string const tmp = GetTempDir();
2336
2337 if (seteuid(old_euid) != 0)
2338 _error->Errno("seteuid", "seteuid %u failed", old_euid);
2339 if (setegid(old_egid) != 0)
2340 _error->Errno("setegid", "setegid %u failed", old_egid);
2341
2342 return tmp;
2343 }
2344 /*}}}*/
2345 FileFd* GetTempFile(std::string const &Prefix, bool ImmediateUnlink, FileFd * const TmpFd) /*{{{*/
2346 {
2347 char fn[512];
2348 FileFd * const Fd = TmpFd == NULL ? new FileFd() : TmpFd;
2349
2350 std::string const tempdir = GetTempDir();
2351 snprintf(fn, sizeof(fn), "%s/%s.XXXXXX",
2352 tempdir.c_str(), Prefix.c_str());
2353 int const fd = mkstemp(fn);
2354 if(ImmediateUnlink)
2355 unlink(fn);
2356 if (fd < 0)
2357 {
2358 _error->Errno("GetTempFile",_("Unable to mkstemp %s"), fn);
2359 return NULL;
2360 }
2361 if (!Fd->OpenDescriptor(fd, FileFd::ReadWrite, FileFd::None, true))
2362 {
2363 _error->Errno("GetTempFile",_("Unable to write to %s"),fn);
2364 return NULL;
2365 }
2366 return Fd;
2367 }
2368 /*}}}*/
2369 bool Rename(std::string From, std::string To) /*{{{*/
2370 {
2371 if (rename(From.c_str(),To.c_str()) != 0)
2372 {
2373 _error->Error(_("rename failed, %s (%s -> %s)."),strerror(errno),
2374 From.c_str(),To.c_str());
2375 return false;
2376 }
2377 return true;
2378 }
2379 /*}}}*/
2380 bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode)/*{{{*/
2381 {
2382 int fd;
2383 if (Mode != FileFd::ReadOnly && Mode != FileFd::WriteOnly)
2384 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2385
2386 int Pipe[2] = {-1, -1};
2387 if(pipe(Pipe) != 0)
2388 return _error->Errno("pipe", _("Failed to create subprocess IPC"));
2389
2390 std::set<int> keep_fds;
2391 keep_fds.insert(Pipe[0]);
2392 keep_fds.insert(Pipe[1]);
2393 Child = ExecFork(keep_fds);
2394 if(Child < 0)
2395 return _error->Errno("fork", "Failed to fork");
2396 if(Child == 0)
2397 {
2398 if(Mode == FileFd::ReadOnly)
2399 {
2400 close(Pipe[0]);
2401 fd = Pipe[1];
2402 }
2403 else if(Mode == FileFd::WriteOnly)
2404 {
2405 close(Pipe[1]);
2406 fd = Pipe[0];
2407 }
2408
2409 if(Mode == FileFd::ReadOnly)
2410 {
2411 dup2(fd, 1);
2412 dup2(fd, 2);
2413 } else if(Mode == FileFd::WriteOnly)
2414 dup2(fd, 0);
2415
2416 execv(Args[0], (char**)Args);
2417 _exit(100);
2418 }
2419 if(Mode == FileFd::ReadOnly)
2420 {
2421 close(Pipe[1]);
2422 fd = Pipe[0];
2423 }
2424 else if(Mode == FileFd::WriteOnly)
2425 {
2426 close(Pipe[0]);
2427 fd = Pipe[1];
2428 }
2429 else
2430 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2431 Fd.OpenDescriptor(fd, Mode, FileFd::None, true);
2432
2433 return true;
2434 }
2435 /*}}}*/
2436 bool DropPrivileges() /*{{{*/
2437 {
2438 if(_config->FindB("Debug::NoDropPrivs", false) == true)
2439 return true;
2440
2441 #if __gnu_linux__
2442 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2443 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2444 #endif
2445 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2446 int ret = prctl(38, 1, 0, 0, 0);
2447 // ignore EINVAL - kernel is too old to understand the option
2448 if(ret < 0 && errno != EINVAL)
2449 _error->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret);
2450 #endif
2451
2452 // empty setting disables privilege dropping - this also ensures
2453 // backward compatibility, see bug #764506
2454 const std::string toUser = _config->Find("APT::Sandbox::User");
2455 if (toUser.empty() || toUser == "root")
2456 return true;
2457
2458 // a lot can go wrong trying to drop privileges completely,
2459 // so ideally we would like to verify that we have done it –
2460 // but the verify asks for too much in case of fakeroot (and alike)
2461 // [Specific checks can be overridden with dedicated options]
2462 bool const VerifySandboxing = _config->FindB("APT::Sandbox::Verify", false);
2463
2464 // uid will be 0 in the end, but gid might be different anyway
2465 uid_t const old_uid = getuid();
2466 gid_t const old_gid = getgid();
2467
2468 if (old_uid != 0)
2469 return true;
2470
2471 struct passwd *pw = getpwnam(toUser.c_str());
2472 if (pw == NULL)
2473 return _error->Error("No user %s, can not drop rights", toUser.c_str());
2474
2475 // Do not change the order here, it might break things
2476 // Get rid of all our supplementary groups first
2477 if (setgroups(1, &pw->pw_gid))
2478 return _error->Errno("setgroups", "Failed to setgroups");
2479
2480 // Now change the group ids to the new user
2481 #ifdef HAVE_SETRESGID
2482 if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0)
2483 return _error->Errno("setresgid", "Failed to set new group ids");
2484 #else
2485 if (setegid(pw->pw_gid) != 0)
2486 return _error->Errno("setegid", "Failed to setegid");
2487
2488 if (setgid(pw->pw_gid) != 0)
2489 return _error->Errno("setgid", "Failed to setgid");
2490 #endif
2491
2492 // Change the user ids to the new user
2493 #ifdef HAVE_SETRESUID
2494 if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0)
2495 return _error->Errno("setresuid", "Failed to set new user ids");
2496 #else
2497 if (setuid(pw->pw_uid) != 0)
2498 return _error->Errno("setuid", "Failed to setuid");
2499 if (seteuid(pw->pw_uid) != 0)
2500 return _error->Errno("seteuid", "Failed to seteuid");
2501 #endif
2502
2503 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2504 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Groups", false) == true)
2505 {
2506 // Verify that the user isn't still in any supplementary groups
2507 long const ngroups_max = sysconf(_SC_NGROUPS_MAX);
2508 std::unique_ptr<gid_t[]> gidlist(new gid_t[ngroups_max]);
2509 if (unlikely(gidlist == NULL))
2510 return _error->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max);
2511 ssize_t gidlist_nr;
2512 if ((gidlist_nr = getgroups(ngroups_max, gidlist.get())) < 0)
2513 return _error->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max);
2514 for (ssize_t i = 0; i < gidlist_nr; ++i)
2515 if (gidlist[i] != pw->pw_gid)
2516 return _error->Error("Could not switch group, user %s is still in group %d", toUser.c_str(), gidlist[i]);
2517 }
2518
2519 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2520 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::IDs", true) == true)
2521 {
2522 // Verify that gid, egid, uid, and euid changed
2523 if (getgid() != pw->pw_gid)
2524 return _error->Error("Could not switch group");
2525 if (getegid() != pw->pw_gid)
2526 return _error->Error("Could not switch effective group");
2527 if (getuid() != pw->pw_uid)
2528 return _error->Error("Could not switch user");
2529 if (geteuid() != pw->pw_uid)
2530 return _error->Error("Could not switch effective user");
2531
2532 #ifdef HAVE_GETRESUID
2533 // verify that the saved set-user-id was changed as well
2534 uid_t ruid = 0;
2535 uid_t euid = 0;
2536 uid_t suid = 0;
2537 if (getresuid(&ruid, &euid, &suid))
2538 return _error->Errno("getresuid", "Could not get saved set-user-ID");
2539 if (suid != pw->pw_uid)
2540 return _error->Error("Could not switch saved set-user-ID");
2541 #endif
2542
2543 #ifdef HAVE_GETRESGID
2544 // verify that the saved set-group-id was changed as well
2545 gid_t rgid = 0;
2546 gid_t egid = 0;
2547 gid_t sgid = 0;
2548 if (getresgid(&rgid, &egid, &sgid))
2549 return _error->Errno("getresuid", "Could not get saved set-group-ID");
2550 if (sgid != pw->pw_gid)
2551 return _error->Error("Could not switch saved set-group-ID");
2552 #endif
2553 }
2554
2555 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2556 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Regain", false) == true)
2557 {
2558 // Check that uid and gid changes do not work anymore
2559 if (pw->pw_gid != old_gid && (setgid(old_gid) != -1 || setegid(old_gid) != -1))
2560 return _error->Error("Could restore a gid to root, privilege dropping did not work");
2561
2562 if (pw->pw_uid != old_uid && (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
2563 return _error->Error("Could restore a uid to root, privilege dropping did not work");
2564 }
2565
2566 return true;
2567 }
2568 /*}}}*/