]> git.saurik.com Git - apt.git/blob - apt-pkg/contrib/fileutl.cc
9b361808289d2ad65f6dbdf0f9b424f049290d8b
[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 class FileFdPrivate { /*{{{*/
923 protected:
924 FileFd * const filefd;
925 size_t buffersize_max = 0;
926 std::unique_ptr<char> buffer;
927 unsigned long long buffersize = 0;
928 public:
929 int compressed_fd;
930 pid_t compressor_pid;
931 bool is_pipe;
932 APT::Configuration::Compressor compressor;
933 unsigned int openmode;
934 unsigned long long seekpos;
935 FileFdPrivate(FileFd * const pfilefd) : filefd(pfilefd), buffer(nullptr),
936 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
937 openmode(0), seekpos(0) {};
938
939 virtual bool InternalOpen(int const iFd, unsigned int const Mode) = 0;
940 ssize_t InternalRead(void * To, unsigned long long Size)
941 {
942 unsigned long long tmp = 0;
943 if (buffersize != 0)
944 {
945 if (buffersize >= Size)
946 {
947 memcpy(To, buffer.get(), Size);
948 if (buffersize == Size)
949 {
950 buffersize = 0;
951 }
952 else
953 {
954 buffersize -= Size;
955 memmove(buffer.get(), buffer.get() + Size, buffersize);
956 }
957 return Size;
958 }
959 else
960 {
961 memcpy(To, buffer.get(), buffersize);
962 Size -= buffersize;
963 To = static_cast<char *>(To) + buffersize;
964 tmp = buffersize;
965 buffersize = 0;
966 }
967 }
968 return InternalUnbufferedRead(To, Size) + tmp;
969 }
970 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) = 0;
971 virtual bool InternalReadError() { return filefd->FileFdErrno("read",_("Read error")); }
972 virtual char * InternalReadLine(char * To, unsigned long long Size)
973 {
974 if (unlikely(Size == 0))
975 return nullptr;
976 --Size;
977 To[0] = '\0';
978 if (unlikely(Size == 0))
979 return To;
980 char * const InitialTo = To;
981
982 do {
983 if (buffersize == 0)
984 {
985 if (buffer.get() == nullptr)
986 {
987 buffer.reset(new char[Size]);
988 buffersize_max = Size;
989 }
990 unsigned long long actualread = 0;
991 if (filefd->Read(buffer.get(), buffersize_max, &actualread) == false)
992 return nullptr;
993 buffersize = actualread;
994 if (buffersize == 0)
995 {
996 buffer.reset(nullptr);
997 buffersize_max = 0;
998 if (To == InitialTo)
999 return nullptr;
1000 break;
1001 }
1002 filefd->Flags &= ~FileFd::HitEof;
1003 }
1004
1005 unsigned long long const OutputSize = std::min(Size, buffersize);
1006 char const * const newline = static_cast<char const * const>(memchr(buffer.get(), '\n', OutputSize));
1007 if (newline != nullptr)
1008 {
1009 size_t length = (newline - buffer.get());
1010 ++length;
1011 memcpy(To, buffer.get(), length);
1012 To += length;
1013 if (length < buffersize)
1014 {
1015 buffersize -= length;
1016 memmove(buffer.get(), buffer.get() + length, buffersize);
1017 }
1018 else
1019 buffersize = 0;
1020 break;
1021 }
1022 else
1023 {
1024 memcpy(To, buffer.get(), OutputSize);
1025 To += OutputSize;
1026 Size -= OutputSize;
1027 buffersize -= OutputSize;
1028 memmove(buffer.get(), buffer.get() + OutputSize, buffersize);
1029 }
1030 } while (Size > 0);
1031 *To = '\0';
1032 return InitialTo;
1033 }
1034 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) = 0;
1035 virtual bool InternalWriteError() { return filefd->FileFdErrno("write",_("Write error")); }
1036 virtual bool InternalSeek(unsigned long long const To)
1037 {
1038 // Our poor man seeking is costly, so try to avoid it
1039 unsigned long long const iseekpos = filefd->Tell();
1040 if (iseekpos == To)
1041 return true;
1042 else if (iseekpos < To)
1043 return filefd->Skip(To - iseekpos);
1044
1045 if ((openmode & FileFd::ReadOnly) != FileFd::ReadOnly)
1046 return filefd->FileFdError("Reopen is only implemented for read-only files!");
1047 InternalClose(filefd->FileName);
1048 if (filefd->iFd != -1)
1049 close(filefd->iFd);
1050 filefd->iFd = -1;
1051 if (filefd->TemporaryFileName.empty() == false)
1052 filefd->iFd = open(filefd->TemporaryFileName.c_str(), O_RDONLY);
1053 else if (filefd->FileName.empty() == false)
1054 filefd->iFd = open(filefd->FileName.c_str(), O_RDONLY);
1055 else
1056 {
1057 if (compressed_fd > 0)
1058 if (lseek(compressed_fd, 0, SEEK_SET) != 0)
1059 filefd->iFd = compressed_fd;
1060 if (filefd->iFd < 0)
1061 return filefd->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1062 }
1063
1064 if (filefd->OpenInternDescriptor(openmode, compressor) == false)
1065 return filefd->FileFdError("Seek on file %s because it couldn't be reopened", filefd->FileName.c_str());
1066
1067 buffersize = 0;
1068 if (To != 0)
1069 return filefd->Skip(To);
1070
1071 seekpos = To;
1072 return true;
1073 }
1074 virtual bool InternalSkip(unsigned long long Over)
1075 {
1076 unsigned long long constexpr buffersize = 1024;
1077 char buffer[buffersize];
1078 while (Over != 0)
1079 {
1080 unsigned long long toread = std::min(buffersize, Over);
1081 if (filefd->Read(buffer, toread) == false)
1082 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1083 Over -= toread;
1084 }
1085 return true;
1086 }
1087 virtual bool InternalTruncate(unsigned long long const)
1088 {
1089 return filefd->FileFdError("Truncating compressed files is not implemented (%s)", filefd->FileName.c_str());
1090 }
1091 virtual unsigned long long InternalTell()
1092 {
1093 // In theory, we could just return seekpos here always instead of
1094 // seeking around, but not all users of FileFd use always Seek() and co
1095 // so d->seekpos isn't always true and we can just use it as a hint if
1096 // we have nothing else, but not always as an authority…
1097 return seekpos - buffersize;
1098 }
1099 virtual unsigned long long InternalSize()
1100 {
1101 unsigned long long size = 0;
1102 unsigned long long const oldSeek = filefd->Tell();
1103 unsigned long long constexpr ignoresize = 1024;
1104 char ignore[ignoresize];
1105 unsigned long long read = 0;
1106 do {
1107 if (filefd->Read(ignore, ignoresize, &read) == false)
1108 {
1109 filefd->Seek(oldSeek);
1110 return 0;
1111 }
1112 } while(read != 0);
1113 size = filefd->Tell();
1114 filefd->Seek(oldSeek);
1115 return size;
1116 }
1117 virtual bool InternalClose(std::string const &FileName) = 0;
1118 virtual bool InternalStream() const { return false; }
1119 virtual bool InternalAlwaysAutoClose() const { return true; }
1120
1121 virtual ~FileFdPrivate() {}
1122 };
1123 /*}}}*/
1124 class GzipFileFdPrivate: public FileFdPrivate { /*{{{*/
1125 #ifdef HAVE_ZLIB
1126 public:
1127 gzFile gz;
1128 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1129 {
1130 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1131 gz = gzdopen(iFd, "r+");
1132 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1133 gz = gzdopen(iFd, "w");
1134 else
1135 gz = gzdopen(iFd, "r");
1136 filefd->Flags |= FileFd::Compressed;
1137 return gz != nullptr;
1138 }
1139 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1140 {
1141 return gzread(gz, To, Size);
1142 }
1143 virtual bool InternalReadError() override
1144 {
1145 int err;
1146 char const * const errmsg = gzerror(gz, &err);
1147 if (err != Z_ERRNO)
1148 return filefd->FileFdError("gzread: %s (%d: %s)", _("Read error"), err, errmsg);
1149 return FileFdPrivate::InternalReadError();
1150 }
1151 virtual char * InternalReadLine(char * To, unsigned long long Size) override
1152 {
1153 return gzgets(gz, To, Size);
1154 }
1155 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1156 {
1157 return gzwrite(gz,From,Size);
1158 }
1159 virtual bool InternalWriteError() override
1160 {
1161 int err;
1162 char const * const errmsg = gzerror(gz, &err);
1163 if (err != Z_ERRNO)
1164 return filefd->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err, errmsg);
1165 return FileFdPrivate::InternalWriteError();
1166 }
1167 virtual bool InternalSeek(unsigned long long const To) override
1168 {
1169 off_t const res = gzseek(gz, To, SEEK_SET);
1170 if (res != (off_t)To)
1171 return filefd->FileFdError("Unable to seek to %llu", To);
1172 seekpos = To;
1173 buffersize = 0;
1174 return true;
1175 }
1176 virtual bool InternalSkip(unsigned long long Over) override
1177 {
1178 if (Over >= buffersize)
1179 {
1180 Over -= buffersize;
1181 buffersize = 0;
1182 }
1183 else
1184 {
1185 buffersize -= Over;
1186 memmove(buffer.get(), buffer.get() + Over, buffersize);
1187 return true;
1188 }
1189 if (Over == 0)
1190 return true;
1191 off_t const res = gzseek(gz, Over, SEEK_CUR);
1192 if (res < 0)
1193 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1194 seekpos = res;
1195 return true;
1196 }
1197 virtual unsigned long long InternalTell() override
1198 {
1199 return gztell(gz) - buffersize;
1200 }
1201 virtual unsigned long long InternalSize() override
1202 {
1203 unsigned long long filesize = FileFdPrivate::InternalSize();
1204 // only check gzsize if we are actually a gzip file, just checking for
1205 // "gz" is not sufficient as uncompressed files could be opened with
1206 // gzopen in "direct" mode as well
1207 if (filesize == 0 || gzdirect(gz))
1208 return filesize;
1209
1210 off_t const oldPos = lseek(filefd->iFd, 0, SEEK_CUR);
1211 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1212 * this ourselves; the original (uncompressed) file size is the last 32
1213 * bits of the file */
1214 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1215 if (lseek(filefd->iFd, -4, SEEK_END) < 0)
1216 {
1217 filefd->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1218 return 0;
1219 }
1220 uint32_t size = 0;
1221 if (read(filefd->iFd, &size, 4) != 4)
1222 {
1223 filefd->FileFdErrno("read","Unable to read original size of gzipped file");
1224 return 0;
1225 }
1226 size = le32toh(size);
1227
1228 if (lseek(filefd->iFd, oldPos, SEEK_SET) < 0)
1229 {
1230 filefd->FileFdErrno("lseek","Unable to seek in gzipped file");
1231 return 0;
1232 }
1233 return size;
1234 }
1235 virtual bool InternalClose(std::string const &FileName) override
1236 {
1237 if (gz == nullptr)
1238 return true;
1239 int const e = gzclose(gz);
1240 gz = nullptr;
1241 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1242 if (e != 0 && e != Z_BUF_ERROR)
1243 return _error->Errno("close",_("Problem closing the gzip file %s"), FileName.c_str());
1244 return true;
1245 }
1246
1247 GzipFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), gz(nullptr) {}
1248 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1249 #endif
1250 };
1251 /*}}}*/
1252 class Bz2FileFdPrivate: public FileFdPrivate { /*{{{*/
1253 #ifdef HAVE_BZ2
1254 BZFILE* bz2;
1255 public:
1256 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1257 {
1258 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1259 bz2 = BZ2_bzdopen(iFd, "r+");
1260 else if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1261 bz2 = BZ2_bzdopen(iFd, "w");
1262 else
1263 bz2 = BZ2_bzdopen(iFd, "r");
1264 filefd->Flags |= FileFd::Compressed;
1265 return bz2 != nullptr;
1266 }
1267 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1268 {
1269 return BZ2_bzread(bz2, To, Size);
1270 }
1271 virtual bool InternalReadError() override
1272 {
1273 int err;
1274 char const * const errmsg = BZ2_bzerror(bz2, &err);
1275 if (err != BZ_IO_ERROR)
1276 return filefd->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd->FileName.c_str(), _("Read error"), err, errmsg);
1277 return FileFdPrivate::InternalReadError();
1278 }
1279 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1280 {
1281 return BZ2_bzwrite(bz2, (void*)From, Size);
1282 }
1283 virtual bool InternalWriteError() override
1284 {
1285 int err;
1286 char const * const errmsg = BZ2_bzerror(bz2, &err);
1287 if (err != BZ_IO_ERROR)
1288 return filefd->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd->FileName.c_str(), _("Write error"), err, errmsg);
1289 return FileFdPrivate::InternalWriteError();
1290 }
1291 virtual bool InternalStream() const override { return true; }
1292 virtual bool InternalClose(std::string const &) override
1293 {
1294 if (bz2 == nullptr)
1295 return true;
1296 BZ2_bzclose(bz2);
1297 bz2 = nullptr;
1298 return true;
1299 }
1300
1301 Bz2FileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), bz2(nullptr) {}
1302 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1303 #endif
1304 };
1305 /*}}}*/
1306 class LzmaFileFdPrivate: public FileFdPrivate { /*{{{*/
1307 #ifdef HAVE_LZMA
1308 struct LZMAFILE {
1309 FILE* file;
1310 uint8_t buffer[4096];
1311 lzma_stream stream;
1312 lzma_ret err;
1313 bool eof;
1314 bool compressing;
1315
1316 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer[0] = '\0'; }
1317 ~LZMAFILE()
1318 {
1319 if (compressing == true)
1320 {
1321 size_t constexpr buffersize = sizeof(buffer)/sizeof(buffer[0]);
1322 while(true)
1323 {
1324 stream.avail_out = buffersize;
1325 stream.next_out = buffer;
1326 err = lzma_code(&stream, LZMA_FINISH);
1327 if (err != LZMA_OK && err != LZMA_STREAM_END)
1328 {
1329 _error->Error("~LZMAFILE: Compress finalisation failed");
1330 break;
1331 }
1332 size_t const n = buffersize - stream.avail_out;
1333 if (n && fwrite(buffer, 1, n, file) != n)
1334 {
1335 _error->Errno("~LZMAFILE",_("Write error"));
1336 break;
1337 }
1338 if (err == LZMA_STREAM_END)
1339 break;
1340 }
1341 }
1342 lzma_end(&stream);
1343 fclose(file);
1344 }
1345 };
1346 LZMAFILE* lzma;
1347 static uint32_t findXZlevel(std::vector<std::string> const &Args)
1348 {
1349 for (auto a = Args.rbegin(); a != Args.rend(); ++a)
1350 if (a->empty() == false && (*a)[0] == '-' && (*a)[1] != '-')
1351 {
1352 auto const number = a->find_last_of("0123456789");
1353 if (number == std::string::npos)
1354 continue;
1355 auto const extreme = a->find("e", number);
1356 uint32_t level = (extreme != std::string::npos) ? LZMA_PRESET_EXTREME : 0;
1357 switch ((*a)[number])
1358 {
1359 case '0': return level | 0;
1360 case '1': return level | 1;
1361 case '2': return level | 2;
1362 case '3': return level | 3;
1363 case '4': return level | 4;
1364 case '5': return level | 5;
1365 case '6': return level | 6;
1366 case '7': return level | 7;
1367 case '8': return level | 8;
1368 case '9': return level | 9;
1369 }
1370 }
1371 return 6;
1372 }
1373 public:
1374 virtual bool InternalOpen(int const iFd, unsigned int const Mode) override
1375 {
1376 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1377 return filefd->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd->FileName.c_str());
1378
1379 if (lzma == nullptr)
1380 lzma = new LzmaFileFdPrivate::LZMAFILE;
1381 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1382 lzma->file = fdopen(iFd, "w");
1383 else
1384 lzma->file = fdopen(iFd, "r");
1385 filefd->Flags |= FileFd::Compressed;
1386 if (lzma->file == nullptr)
1387 return false;
1388
1389 lzma_stream tmp_stream = LZMA_STREAM_INIT;
1390 lzma->stream = tmp_stream;
1391
1392 if ((Mode & FileFd::WriteOnly) == FileFd::WriteOnly)
1393 {
1394 uint32_t const xzlevel = findXZlevel(compressor.CompressArgs);
1395 if (compressor.Name == "xz")
1396 {
1397 if (lzma_easy_encoder(&lzma->stream, xzlevel, LZMA_CHECK_CRC64) != LZMA_OK)
1398 return false;
1399 }
1400 else
1401 {
1402 lzma_options_lzma options;
1403 lzma_lzma_preset(&options, xzlevel);
1404 if (lzma_alone_encoder(&lzma->stream, &options) != LZMA_OK)
1405 return false;
1406 }
1407 lzma->compressing = true;
1408 }
1409 else
1410 {
1411 uint64_t const memlimit = UINT64_MAX;
1412 if (compressor.Name == "xz")
1413 {
1414 if (lzma_auto_decoder(&lzma->stream, memlimit, 0) != LZMA_OK)
1415 return false;
1416 }
1417 else
1418 {
1419 if (lzma_alone_decoder(&lzma->stream, memlimit) != LZMA_OK)
1420 return false;
1421 }
1422 lzma->compressing = false;
1423 }
1424 return true;
1425 }
1426 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1427 {
1428 ssize_t Res;
1429 if (lzma->eof == true)
1430 return 0;
1431
1432 lzma->stream.next_out = (uint8_t *) To;
1433 lzma->stream.avail_out = Size;
1434 if (lzma->stream.avail_in == 0)
1435 {
1436 lzma->stream.next_in = lzma->buffer;
1437 lzma->stream.avail_in = fread(lzma->buffer, 1, sizeof(lzma->buffer)/sizeof(lzma->buffer[0]), lzma->file);
1438 }
1439 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1440 if (lzma->err == LZMA_STREAM_END)
1441 {
1442 lzma->eof = true;
1443 Res = Size - lzma->stream.avail_out;
1444 }
1445 else if (lzma->err != LZMA_OK)
1446 {
1447 Res = -1;
1448 errno = 0;
1449 }
1450 else
1451 {
1452 Res = Size - lzma->stream.avail_out;
1453 if (Res == 0)
1454 {
1455 // lzma run was okay, but produced no output…
1456 Res = -1;
1457 errno = EINTR;
1458 }
1459 }
1460 return Res;
1461 }
1462 virtual bool InternalReadError() override
1463 {
1464 return filefd->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma->err);
1465 }
1466 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1467 {
1468 lzma->stream.next_in = (uint8_t *)From;
1469 lzma->stream.avail_in = Size;
1470 lzma->stream.next_out = lzma->buffer;
1471 lzma->stream.avail_out = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]);
1472 lzma->err = lzma_code(&lzma->stream, LZMA_RUN);
1473 if (lzma->err != LZMA_OK)
1474 return -1;
1475 size_t const n = sizeof(lzma->buffer)/sizeof(lzma->buffer[0]) - lzma->stream.avail_out;
1476 size_t const m = (n == 0) ? 0 : fwrite(lzma->buffer, 1, n, lzma->file);
1477 if (m != n)
1478 return -1;
1479 else
1480 return Size - lzma->stream.avail_in;
1481 }
1482 virtual bool InternalWriteError() override
1483 {
1484 return filefd->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma->err);
1485 }
1486 virtual bool InternalStream() const override { return true; }
1487 virtual bool InternalClose(std::string const &) override
1488 {
1489 delete lzma;
1490 lzma = nullptr;
1491 return true;
1492 }
1493
1494 LzmaFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd), lzma(nullptr) {}
1495 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1496 #endif
1497 };
1498 /*}}}*/
1499 class PipedFileFdPrivate: public FileFdPrivate /*{{{*/
1500 /* if we don't have a specific class dealing with library calls, we (un)compress
1501 by executing a specified binary and pipe in/out what we need */
1502 {
1503 public:
1504 virtual bool InternalOpen(int const, unsigned int const Mode) override
1505 {
1506 // collect zombies here in case we reopen
1507 if (compressor_pid > 0)
1508 ExecWait(compressor_pid, "FileFdCompressor", true);
1509
1510 if ((Mode & FileFd::ReadWrite) == FileFd::ReadWrite)
1511 return filefd->FileFdError("ReadWrite mode is not supported for file %s", filefd->FileName.c_str());
1512
1513 bool const Comp = (Mode & FileFd::WriteOnly) == FileFd::WriteOnly;
1514 if (Comp == false)
1515 {
1516 // Handle 'decompression' of empty files
1517 struct stat Buf;
1518 fstat(filefd->iFd, &Buf);
1519 if (Buf.st_size == 0 && S_ISFIFO(Buf.st_mode) == false)
1520 return true;
1521
1522 // We don't need the file open - instead let the compressor open it
1523 // as he properly knows better how to efficiently read from 'his' file
1524 if (filefd->FileName.empty() == false)
1525 {
1526 close(filefd->iFd);
1527 filefd->iFd = -1;
1528 }
1529 }
1530
1531 // Create a data pipe
1532 int Pipe[2] = {-1,-1};
1533 if (pipe(Pipe) != 0)
1534 return filefd->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1535 for (int J = 0; J != 2; J++)
1536 SetCloseExec(Pipe[J],true);
1537
1538 compressed_fd = filefd->iFd;
1539 is_pipe = true;
1540
1541 if (Comp == true)
1542 filefd->iFd = Pipe[1];
1543 else
1544 filefd->iFd = Pipe[0];
1545
1546 // The child..
1547 compressor_pid = ExecFork();
1548 if (compressor_pid == 0)
1549 {
1550 if (Comp == true)
1551 {
1552 dup2(compressed_fd,STDOUT_FILENO);
1553 dup2(Pipe[0],STDIN_FILENO);
1554 }
1555 else
1556 {
1557 if (compressed_fd != -1)
1558 dup2(compressed_fd,STDIN_FILENO);
1559 dup2(Pipe[1],STDOUT_FILENO);
1560 }
1561 int const nullfd = open("/dev/null", O_WRONLY);
1562 if (nullfd != -1)
1563 {
1564 dup2(nullfd,STDERR_FILENO);
1565 close(nullfd);
1566 }
1567
1568 SetCloseExec(STDOUT_FILENO,false);
1569 SetCloseExec(STDIN_FILENO,false);
1570
1571 std::vector<char const*> Args;
1572 Args.push_back(compressor.Binary.c_str());
1573 std::vector<std::string> const * const addArgs =
1574 (Comp == true) ? &(compressor.CompressArgs) : &(compressor.UncompressArgs);
1575 for (std::vector<std::string>::const_iterator a = addArgs->begin();
1576 a != addArgs->end(); ++a)
1577 Args.push_back(a->c_str());
1578 if (Comp == false && filefd->FileName.empty() == false)
1579 {
1580 // commands not needing arguments, do not need to be told about using standard output
1581 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1582 if (compressor.CompressArgs.empty() == false && compressor.UncompressArgs.empty() == false)
1583 Args.push_back("--stdout");
1584 if (filefd->TemporaryFileName.empty() == false)
1585 Args.push_back(filefd->TemporaryFileName.c_str());
1586 else
1587 Args.push_back(filefd->FileName.c_str());
1588 }
1589 Args.push_back(NULL);
1590
1591 execvp(Args[0],(char **)&Args[0]);
1592 cerr << _("Failed to exec compressor ") << Args[0] << endl;
1593 _exit(100);
1594 }
1595 if (Comp == true)
1596 close(Pipe[0]);
1597 else
1598 close(Pipe[1]);
1599
1600 return true;
1601 }
1602 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1603 {
1604 return read(filefd->iFd, To, Size);
1605 }
1606 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1607 {
1608 return write(filefd->iFd, From, Size);
1609 }
1610 virtual bool InternalClose(std::string const &) override
1611 {
1612 bool Ret = true;
1613 if (compressor_pid > 0)
1614 Ret &= ExecWait(compressor_pid, "FileFdCompressor", true);
1615 compressor_pid = -1;
1616 return Ret;
1617 }
1618 PipedFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
1619 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1620 };
1621 /*}}}*/
1622 class DirectFileFdPrivate: public FileFdPrivate /*{{{*/
1623 {
1624 public:
1625 virtual bool InternalOpen(int const, unsigned int const) override { return true; }
1626 virtual ssize_t InternalUnbufferedRead(void * const To, unsigned long long const Size) override
1627 {
1628 return read(filefd->iFd, To, Size);
1629 }
1630 virtual ssize_t InternalWrite(void const * const From, unsigned long long const Size) override
1631 {
1632 // files opened read+write are strange and only really "supported" for direct files
1633 if (buffersize != 0)
1634 {
1635 lseek(filefd->iFd, -buffersize, SEEK_CUR);
1636 buffersize = 0;
1637 }
1638 return write(filefd->iFd, From, Size);
1639 }
1640 virtual bool InternalSeek(unsigned long long const To) override
1641 {
1642 off_t const res = lseek(filefd->iFd, To, SEEK_SET);
1643 if (res != (off_t)To)
1644 return filefd->FileFdError("Unable to seek to %llu", To);
1645 seekpos = To;
1646 buffersize = 0;
1647 return true;
1648 }
1649 virtual bool InternalSkip(unsigned long long Over) override
1650 {
1651 if (Over >= buffersize)
1652 {
1653 Over -= buffersize;
1654 buffersize = 0;
1655 }
1656 else
1657 {
1658 buffersize -= Over;
1659 memmove(buffer.get(), buffer.get() + Over, buffersize);
1660 return true;
1661 }
1662 if (Over == 0)
1663 return true;
1664 off_t const res = lseek(filefd->iFd, Over, SEEK_CUR);
1665 if (res < 0)
1666 return filefd->FileFdError("Unable to seek ahead %llu",Over);
1667 seekpos = res;
1668 return true;
1669 }
1670 virtual bool InternalTruncate(unsigned long long const To) override
1671 {
1672 if (buffersize != 0)
1673 {
1674 unsigned long long const seekpos = lseek(filefd->iFd, 0, SEEK_CUR);
1675 if ((seekpos - buffersize) >= To)
1676 buffersize = 0;
1677 else if (seekpos >= To)
1678 buffersize = (To - seekpos);
1679 else
1680 buffersize = 0;
1681 }
1682 if (ftruncate(filefd->iFd, To) != 0)
1683 return filefd->FileFdError("Unable to truncate to %llu",To);
1684 return true;
1685 }
1686 virtual unsigned long long InternalTell() override
1687 {
1688 return lseek(filefd->iFd,0,SEEK_CUR) - buffersize;
1689 }
1690 virtual unsigned long long InternalSize() override
1691 {
1692 return filefd->FileSize();
1693 }
1694 virtual bool InternalClose(std::string const &) override { return true; }
1695 virtual bool InternalAlwaysAutoClose() const override { return false; }
1696
1697 DirectFileFdPrivate(FileFd * const filefd) : FileFdPrivate(filefd) {}
1698 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1699 };
1700 /*}}}*/
1701 // FileFd Constructors /*{{{*/
1702 FileFd::FileFd(std::string FileName,unsigned int const Mode,unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1703 {
1704 Open(FileName,Mode, None, AccessMode);
1705 }
1706 FileFd::FileFd(std::string FileName,unsigned int const Mode, CompressMode Compress, unsigned long AccessMode) : iFd(-1), Flags(0), d(NULL)
1707 {
1708 Open(FileName,Mode, Compress, AccessMode);
1709 }
1710 FileFd::FileFd() : iFd(-1), Flags(AutoClose), d(NULL) {}
1711 FileFd::FileFd(int const Fd, unsigned int const Mode, CompressMode Compress) : iFd(-1), Flags(0), d(NULL)
1712 {
1713 OpenDescriptor(Fd, Mode, Compress);
1714 }
1715 FileFd::FileFd(int const Fd, bool const AutoClose) : iFd(-1), Flags(0), d(NULL)
1716 {
1717 OpenDescriptor(Fd, ReadWrite, None, AutoClose);
1718 }
1719 /*}}}*/
1720 // FileFd::Open - Open a file /*{{{*/
1721 // ---------------------------------------------------------------------
1722 /* The most commonly used open mode combinations are given with Mode */
1723 bool FileFd::Open(string FileName,unsigned int const Mode,CompressMode Compress, unsigned long const AccessMode)
1724 {
1725 if (Mode == ReadOnlyGzip)
1726 return Open(FileName, ReadOnly, Gzip, AccessMode);
1727
1728 if (Compress == Auto && (Mode & WriteOnly) == WriteOnly)
1729 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName.c_str());
1730
1731 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
1732 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
1733 if (Compress == Auto)
1734 {
1735 for (; compressor != compressors.end(); ++compressor)
1736 {
1737 std::string file = FileName + compressor->Extension;
1738 if (FileExists(file) == false)
1739 continue;
1740 FileName = file;
1741 break;
1742 }
1743 }
1744 else if (Compress == Extension)
1745 {
1746 std::string::size_type const found = FileName.find_last_of('.');
1747 std::string ext;
1748 if (found != std::string::npos)
1749 {
1750 ext = FileName.substr(found);
1751 if (ext == ".new" || ext == ".bak")
1752 {
1753 std::string::size_type const found2 = FileName.find_last_of('.', found - 1);
1754 if (found2 != std::string::npos)
1755 ext = FileName.substr(found2, found - found2);
1756 else
1757 ext.clear();
1758 }
1759 }
1760 for (; compressor != compressors.end(); ++compressor)
1761 if (ext == compressor->Extension)
1762 break;
1763 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1764 if (compressor == compressors.end())
1765 for (compressor = compressors.begin(); compressor != compressors.end(); ++compressor)
1766 if (compressor->Name == ".")
1767 break;
1768 }
1769 else
1770 {
1771 std::string name;
1772 switch (Compress)
1773 {
1774 case None: name = "."; break;
1775 case Gzip: name = "gzip"; break;
1776 case Bzip2: name = "bzip2"; break;
1777 case Lzma: name = "lzma"; break;
1778 case Xz: name = "xz"; break;
1779 case Auto:
1780 case Extension:
1781 // Unreachable
1782 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName.c_str());
1783 }
1784 for (; compressor != compressors.end(); ++compressor)
1785 if (compressor->Name == name)
1786 break;
1787 if (compressor == compressors.end())
1788 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
1789 }
1790
1791 if (compressor == compressors.end())
1792 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName.c_str());
1793 return Open(FileName, Mode, *compressor, AccessMode);
1794 }
1795 bool FileFd::Open(string FileName,unsigned int const Mode,APT::Configuration::Compressor const &compressor, unsigned long const AccessMode)
1796 {
1797 Close();
1798 Flags = AutoClose;
1799
1800 if ((Mode & WriteOnly) != WriteOnly && (Mode & (Atomic | Create | Empty | Exclusive)) != 0)
1801 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName.c_str());
1802 if ((Mode & ReadWrite) == 0)
1803 return FileFdError("No openmode provided in FileFd::Open for %s", FileName.c_str());
1804
1805 unsigned int OpenMode = Mode;
1806 if (FileName == "/dev/null")
1807 OpenMode = OpenMode & ~(Atomic | Exclusive | Create | Empty);
1808
1809 if ((OpenMode & Atomic) == Atomic)
1810 {
1811 Flags |= Replace;
1812 }
1813 else if ((OpenMode & (Exclusive | Create)) == (Exclusive | Create))
1814 {
1815 // for atomic, this will be done by rename in Close()
1816 RemoveFile("FileFd::Open", FileName);
1817 }
1818 if ((OpenMode & Empty) == Empty)
1819 {
1820 struct stat Buf;
1821 if (lstat(FileName.c_str(),&Buf) == 0 && S_ISLNK(Buf.st_mode))
1822 RemoveFile("FileFd::Open", FileName);
1823 }
1824
1825 int fileflags = 0;
1826 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
1827 if_FLAGGED_SET(ReadWrite, O_RDWR);
1828 else if_FLAGGED_SET(ReadOnly, O_RDONLY);
1829 else if_FLAGGED_SET(WriteOnly, O_WRONLY);
1830
1831 if_FLAGGED_SET(Create, O_CREAT);
1832 if_FLAGGED_SET(Empty, O_TRUNC);
1833 if_FLAGGED_SET(Exclusive, O_EXCL);
1834 #undef if_FLAGGED_SET
1835
1836 if ((OpenMode & Atomic) == Atomic)
1837 {
1838 char *name = strdup((FileName + ".XXXXXX").c_str());
1839
1840 if((iFd = mkstemp(name)) == -1)
1841 {
1842 free(name);
1843 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName.c_str());
1844 }
1845
1846 TemporaryFileName = string(name);
1847 free(name);
1848
1849 // umask() will always set the umask and return the previous value, so
1850 // we first set the umask and then reset it to the old value
1851 mode_t const CurrentUmask = umask(0);
1852 umask(CurrentUmask);
1853 // calculate the actual file permissions (just like open/creat)
1854 mode_t const FilePermissions = (AccessMode & ~CurrentUmask);
1855
1856 if(fchmod(iFd, FilePermissions) == -1)
1857 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName.c_str());
1858 }
1859 else
1860 iFd = open(FileName.c_str(), fileflags, AccessMode);
1861
1862 this->FileName = FileName;
1863 if (iFd == -1 || OpenInternDescriptor(OpenMode, compressor) == false)
1864 {
1865 if (iFd != -1)
1866 {
1867 close (iFd);
1868 iFd = -1;
1869 }
1870 return FileFdErrno("open",_("Could not open file %s"), FileName.c_str());
1871 }
1872
1873 SetCloseExec(iFd,true);
1874 return true;
1875 }
1876 /*}}}*/
1877 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1878 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, CompressMode Compress, bool AutoClose)
1879 {
1880 std::vector<APT::Configuration::Compressor> const compressors = APT::Configuration::getCompressors();
1881 std::vector<APT::Configuration::Compressor>::const_iterator compressor = compressors.begin();
1882 std::string name;
1883
1884 // compat with the old API
1885 if (Mode == ReadOnlyGzip && Compress == None)
1886 Compress = Gzip;
1887
1888 switch (Compress)
1889 {
1890 case None: name = "."; break;
1891 case Gzip: name = "gzip"; break;
1892 case Bzip2: name = "bzip2"; break;
1893 case Lzma: name = "lzma"; break;
1894 case Xz: name = "xz"; break;
1895 case Auto:
1896 case Extension:
1897 if (AutoClose == true && Fd != -1)
1898 close(Fd);
1899 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd);
1900 }
1901 for (; compressor != compressors.end(); ++compressor)
1902 if (compressor->Name == name)
1903 break;
1904 if (compressor == compressors.end())
1905 {
1906 if (AutoClose == true && Fd != -1)
1907 close(Fd);
1908 return FileFdError("Can't find a configured compressor %s for file %s", name.c_str(), FileName.c_str());
1909 }
1910 return OpenDescriptor(Fd, Mode, *compressor, AutoClose);
1911 }
1912 bool FileFd::OpenDescriptor(int Fd, unsigned int const Mode, APT::Configuration::Compressor const &compressor, bool AutoClose)
1913 {
1914 Close();
1915 Flags = (AutoClose) ? FileFd::AutoClose : 0;
1916 iFd = Fd;
1917 this->FileName = "";
1918 if (OpenInternDescriptor(Mode, compressor) == false)
1919 {
1920 if (iFd != -1 && (
1921 (Flags & Compressed) == Compressed ||
1922 AutoClose == true))
1923 {
1924 close (iFd);
1925 iFd = -1;
1926 }
1927 return FileFdError(_("Could not open file descriptor %d"), Fd);
1928 }
1929 return true;
1930 }
1931 bool FileFd::OpenInternDescriptor(unsigned int const Mode, APT::Configuration::Compressor const &compressor)
1932 {
1933 if (iFd == -1)
1934 return false;
1935
1936 if (d != nullptr)
1937 d->InternalClose(FileName);
1938
1939 if (d == nullptr)
1940 {
1941 if (false)
1942 /* dummy so that the rest can be 'else if's */;
1943 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
1944 else if (compressor.Name == NAME) \
1945 d = new CONSTRUCTOR(this)
1946 #ifdef HAVE_ZLIB
1947 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate);
1948 #endif
1949 #ifdef HAVE_BZ2
1950 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate);
1951 #endif
1952 #ifdef HAVE_LZMA
1953 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate);
1954 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate);
1955 #endif
1956 #undef APT_COMPRESS_INIT
1957 else if (compressor.Name == "." || compressor.Binary.empty() == true)
1958 d = new DirectFileFdPrivate(this);
1959 else
1960 d = new PipedFileFdPrivate(this);
1961
1962 d->openmode = Mode;
1963 d->compressor = compressor;
1964 if ((Flags & AutoClose) != AutoClose && d->InternalAlwaysAutoClose())
1965 {
1966 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1967 int const internFd = dup(iFd);
1968 if (internFd == -1)
1969 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd);
1970 iFd = internFd;
1971 }
1972 }
1973 return d->InternalOpen(iFd, Mode);
1974 }
1975 /*}}}*/
1976 // FileFd::~File - Closes the file /*{{{*/
1977 // ---------------------------------------------------------------------
1978 /* If the proper modes are selected then we close the Fd and possibly
1979 unlink the file on error. */
1980 FileFd::~FileFd()
1981 {
1982 Close();
1983 if (d != NULL)
1984 d->InternalClose(FileName);
1985 delete d;
1986 d = NULL;
1987 }
1988 /*}}}*/
1989 // FileFd::Read - Read a bit of the file /*{{{*/
1990 // ---------------------------------------------------------------------
1991 /* We are careful to handle interruption by a signal while reading
1992 gracefully. */
1993 bool FileFd::Read(void *To,unsigned long long Size,unsigned long long *Actual)
1994 {
1995 if (d == nullptr)
1996 return false;
1997 ssize_t Res = 1;
1998 errno = 0;
1999 if (Actual != 0)
2000 *Actual = 0;
2001 *((char *)To) = '\0';
2002 while (Res > 0 && Size > 0)
2003 {
2004 Res = d->InternalRead(To, Size);
2005
2006 if (Res < 0)
2007 {
2008 if (errno == EINTR)
2009 {
2010 // trick the while-loop into running again
2011 Res = 1;
2012 errno = 0;
2013 continue;
2014 }
2015 return d->InternalReadError();
2016 }
2017
2018 To = (char *)To + Res;
2019 Size -= Res;
2020 if (d != NULL)
2021 d->seekpos += Res;
2022 if (Actual != 0)
2023 *Actual += Res;
2024 }
2025
2026 if (Size == 0)
2027 return true;
2028
2029 // Eof handling
2030 if (Actual != 0)
2031 {
2032 Flags |= HitEof;
2033 return true;
2034 }
2035
2036 return FileFdError(_("read, still have %llu to read but none left"), Size);
2037 }
2038 /*}}}*/
2039 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2040 // ---------------------------------------------------------------------
2041 /* Beware: This method can be quite slow for big buffers on UNcompressed
2042 files because of the naive implementation! */
2043 char* FileFd::ReadLine(char *To, unsigned long long const Size)
2044 {
2045 *To = '\0';
2046 if (d == nullptr)
2047 return nullptr;
2048 return d->InternalReadLine(To, Size);
2049 }
2050 /*}}}*/
2051 // FileFd::Write - Write to the file /*{{{*/
2052 bool FileFd::Write(const void *From,unsigned long long Size)
2053 {
2054 if (d == nullptr)
2055 return false;
2056 ssize_t Res = 1;
2057 errno = 0;
2058 while (Res > 0 && Size > 0)
2059 {
2060 Res = d->InternalWrite(From, Size);
2061 if (Res < 0 && errno == EINTR)
2062 continue;
2063 if (Res < 0)
2064 return d->InternalWriteError();
2065
2066 From = (char const *)From + Res;
2067 Size -= Res;
2068 if (d != NULL)
2069 d->seekpos += Res;
2070 }
2071
2072 if (Size == 0)
2073 return true;
2074
2075 return FileFdError(_("write, still have %llu to write but couldn't"), Size);
2076 }
2077 bool FileFd::Write(int Fd, const void *From, unsigned long long Size)
2078 {
2079 ssize_t Res = 1;
2080 errno = 0;
2081 while (Res > 0 && Size > 0)
2082 {
2083 Res = write(Fd,From,Size);
2084 if (Res < 0 && errno == EINTR)
2085 continue;
2086 if (Res < 0)
2087 return _error->Errno("write",_("Write error"));
2088
2089 From = (char const *)From + Res;
2090 Size -= Res;
2091 }
2092
2093 if (Size == 0)
2094 return true;
2095
2096 return _error->Error(_("write, still have %llu to write but couldn't"), Size);
2097 }
2098 /*}}}*/
2099 // FileFd::Seek - Seek in the file /*{{{*/
2100 bool FileFd::Seek(unsigned long long To)
2101 {
2102 if (d == nullptr)
2103 return false;
2104 Flags &= ~HitEof;
2105 return d->InternalSeek(To);
2106 }
2107 /*}}}*/
2108 // FileFd::Skip - Skip over data in the file /*{{{*/
2109 bool FileFd::Skip(unsigned long long Over)
2110 {
2111 if (d == nullptr)
2112 return false;
2113 return d->InternalSkip(Over);
2114 }
2115 /*}}}*/
2116 // FileFd::Truncate - Truncate the file /*{{{*/
2117 bool FileFd::Truncate(unsigned long long To)
2118 {
2119 if (d == nullptr)
2120 return false;
2121 // truncating /dev/null is always successful - as we get an error otherwise
2122 if (To == 0 && FileName == "/dev/null")
2123 return true;
2124 return d->InternalTruncate(To);
2125 }
2126 /*}}}*/
2127 // FileFd::Tell - Current seek position /*{{{*/
2128 // ---------------------------------------------------------------------
2129 /* */
2130 unsigned long long FileFd::Tell()
2131 {
2132 if (d == nullptr)
2133 return false;
2134 off_t const Res = d->InternalTell();
2135 if (Res == (off_t)-1)
2136 FileFdErrno("lseek","Failed to determine the current file position");
2137 d->seekpos = Res;
2138 return Res;
2139 }
2140 /*}}}*/
2141 static bool StatFileFd(char const * const msg, int const iFd, std::string const &FileName, struct stat &Buf, FileFdPrivate * const d) /*{{{*/
2142 {
2143 bool ispipe = (d != NULL && d->is_pipe == true);
2144 if (ispipe == false)
2145 {
2146 if (fstat(iFd,&Buf) != 0)
2147 // higher-level code will generate more meaningful messages,
2148 // even translated this would be meaningless for users
2149 return _error->Errno("fstat", "Unable to determine %s for fd %i", msg, iFd);
2150 if (FileName.empty() == false)
2151 ispipe = S_ISFIFO(Buf.st_mode);
2152 }
2153
2154 // for compressor pipes st_size is undefined and at 'best' zero
2155 if (ispipe == true)
2156 {
2157 // we set it here, too, as we get the info here for free
2158 // in theory the Open-methods should take care of it already
2159 if (d != NULL)
2160 d->is_pipe = true;
2161 if (stat(FileName.c_str(), &Buf) != 0)
2162 return _error->Errno("fstat", "Unable to determine %s for file %s", msg, FileName.c_str());
2163 }
2164 return true;
2165 }
2166 /*}}}*/
2167 // FileFd::FileSize - Return the size of the file /*{{{*/
2168 unsigned long long FileFd::FileSize()
2169 {
2170 struct stat Buf;
2171 if (StatFileFd("file size", iFd, FileName, Buf, d) == false)
2172 {
2173 Flags |= Fail;
2174 return 0;
2175 }
2176 return Buf.st_size;
2177 }
2178 /*}}}*/
2179 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2180 time_t FileFd::ModificationTime()
2181 {
2182 struct stat Buf;
2183 if (StatFileFd("modification time", iFd, FileName, Buf, d) == false)
2184 {
2185 Flags |= Fail;
2186 return 0;
2187 }
2188 return Buf.st_mtime;
2189 }
2190 /*}}}*/
2191 // FileFd::Size - Return the size of the content in the file /*{{{*/
2192 unsigned long long FileFd::Size()
2193 {
2194 if (d == nullptr)
2195 return false;
2196 return d->InternalSize();
2197 }
2198 /*}}}*/
2199 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2200 // ---------------------------------------------------------------------
2201 /* */
2202 bool FileFd::Close()
2203 {
2204 if (iFd == -1)
2205 return true;
2206
2207 bool Res = true;
2208 if ((Flags & AutoClose) == AutoClose)
2209 {
2210 if ((Flags & Compressed) != Compressed && iFd > 0 && close(iFd) != 0)
2211 Res &= _error->Errno("close",_("Problem closing the file %s"), FileName.c_str());
2212 }
2213
2214 if (d != NULL)
2215 {
2216 Res &= d->InternalClose(FileName);
2217 delete d;
2218 d = NULL;
2219 }
2220
2221 if ((Flags & Replace) == Replace) {
2222 if (rename(TemporaryFileName.c_str(), FileName.c_str()) != 0)
2223 Res &= _error->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName.c_str(), FileName.c_str());
2224
2225 FileName = TemporaryFileName; // for the unlink() below.
2226 TemporaryFileName.clear();
2227 }
2228
2229 iFd = -1;
2230
2231 if ((Flags & Fail) == Fail && (Flags & DelOnFail) == DelOnFail &&
2232 FileName.empty() == false)
2233 Res &= RemoveFile("FileFd::Close", FileName);
2234
2235 if (Res == false)
2236 Flags |= Fail;
2237 return Res;
2238 }
2239 /*}}}*/
2240 // FileFd::Sync - Sync the file /*{{{*/
2241 // ---------------------------------------------------------------------
2242 /* */
2243 bool FileFd::Sync()
2244 {
2245 if (fsync(iFd) != 0)
2246 return FileFdErrno("sync",_("Problem syncing the file"));
2247 return true;
2248 }
2249 /*}}}*/
2250 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2251 bool FileFd::FileFdErrno(const char *Function, const char *Description,...)
2252 {
2253 Flags |= Fail;
2254 va_list args;
2255 size_t msgSize = 400;
2256 int const errsv = errno;
2257 while (true)
2258 {
2259 va_start(args,Description);
2260 if (_error->InsertErrno(GlobalError::ERROR, Function, Description, args, errsv, msgSize) == false)
2261 break;
2262 va_end(args);
2263 }
2264 return false;
2265 }
2266 /*}}}*/
2267 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2268 bool FileFd::FileFdError(const char *Description,...) {
2269 Flags |= Fail;
2270 va_list args;
2271 size_t msgSize = 400;
2272 while (true)
2273 {
2274 va_start(args,Description);
2275 if (_error->Insert(GlobalError::ERROR, Description, args, msgSize) == false)
2276 break;
2277 va_end(args);
2278 }
2279 return false;
2280 }
2281 /*}}}*/
2282 gzFile FileFd::gzFd() { /*{{{*/
2283 #ifdef HAVE_ZLIB
2284 GzipFileFdPrivate * const gzipd = dynamic_cast<GzipFileFdPrivate*>(d);
2285 if (gzipd == nullptr)
2286 return nullptr;
2287 else
2288 return gzipd->gz;
2289 #else
2290 return nullptr;
2291 #endif
2292 }
2293 /*}}}*/
2294
2295 // Glob - wrapper around "glob()" /*{{{*/
2296 std::vector<std::string> Glob(std::string const &pattern, int flags)
2297 {
2298 std::vector<std::string> result;
2299 glob_t globbuf;
2300 int glob_res;
2301 unsigned int i;
2302
2303 glob_res = glob(pattern.c_str(), flags, NULL, &globbuf);
2304
2305 if (glob_res != 0)
2306 {
2307 if(glob_res != GLOB_NOMATCH) {
2308 _error->Errno("glob", "Problem with glob");
2309 return result;
2310 }
2311 }
2312
2313 // append results
2314 for(i=0;i<globbuf.gl_pathc;i++)
2315 result.push_back(string(globbuf.gl_pathv[i]));
2316
2317 globfree(&globbuf);
2318 return result;
2319 }
2320 /*}}}*/
2321 std::string GetTempDir() /*{{{*/
2322 {
2323 const char *tmpdir = getenv("TMPDIR");
2324
2325 #ifdef P_tmpdir
2326 if (!tmpdir)
2327 tmpdir = P_tmpdir;
2328 #endif
2329
2330 struct stat st;
2331 if (!tmpdir || strlen(tmpdir) == 0 || // tmpdir is set
2332 stat(tmpdir, &st) != 0 || (st.st_mode & S_IFDIR) == 0) // exists and is directory
2333 tmpdir = "/tmp";
2334 else if (geteuid() != 0 && // root can do everything anyway
2335 faccessat(-1, tmpdir, R_OK | W_OK | X_OK, AT_EACCESS | AT_SYMLINK_NOFOLLOW) != 0) // current user has rwx access to directory
2336 tmpdir = "/tmp";
2337
2338 return string(tmpdir);
2339 }
2340 std::string GetTempDir(std::string const &User)
2341 {
2342 // no need/possibility to drop privs
2343 if(getuid() != 0 || User.empty() || User == "root")
2344 return GetTempDir();
2345
2346 struct passwd const * const pw = getpwnam(User.c_str());
2347 if (pw == NULL)
2348 return GetTempDir();
2349
2350 gid_t const old_euid = geteuid();
2351 gid_t const old_egid = getegid();
2352 if (setegid(pw->pw_gid) != 0)
2353 _error->Errno("setegid", "setegid %u failed", pw->pw_gid);
2354 if (seteuid(pw->pw_uid) != 0)
2355 _error->Errno("seteuid", "seteuid %u failed", pw->pw_uid);
2356
2357 std::string const tmp = GetTempDir();
2358
2359 if (seteuid(old_euid) != 0)
2360 _error->Errno("seteuid", "seteuid %u failed", old_euid);
2361 if (setegid(old_egid) != 0)
2362 _error->Errno("setegid", "setegid %u failed", old_egid);
2363
2364 return tmp;
2365 }
2366 /*}}}*/
2367 FileFd* GetTempFile(std::string const &Prefix, bool ImmediateUnlink, FileFd * const TmpFd) /*{{{*/
2368 {
2369 char fn[512];
2370 FileFd * const Fd = TmpFd == NULL ? new FileFd() : TmpFd;
2371
2372 std::string const tempdir = GetTempDir();
2373 snprintf(fn, sizeof(fn), "%s/%s.XXXXXX",
2374 tempdir.c_str(), Prefix.c_str());
2375 int const fd = mkstemp(fn);
2376 if(ImmediateUnlink)
2377 unlink(fn);
2378 if (fd < 0)
2379 {
2380 _error->Errno("GetTempFile",_("Unable to mkstemp %s"), fn);
2381 return NULL;
2382 }
2383 if (!Fd->OpenDescriptor(fd, FileFd::ReadWrite, FileFd::None, true))
2384 {
2385 _error->Errno("GetTempFile",_("Unable to write to %s"),fn);
2386 return NULL;
2387 }
2388 return Fd;
2389 }
2390 /*}}}*/
2391 bool Rename(std::string From, std::string To) /*{{{*/
2392 {
2393 if (rename(From.c_str(),To.c_str()) != 0)
2394 {
2395 _error->Error(_("rename failed, %s (%s -> %s)."),strerror(errno),
2396 From.c_str(),To.c_str());
2397 return false;
2398 }
2399 return true;
2400 }
2401 /*}}}*/
2402 bool Popen(const char* Args[], FileFd &Fd, pid_t &Child, FileFd::OpenMode Mode)/*{{{*/
2403 {
2404 int fd;
2405 if (Mode != FileFd::ReadOnly && Mode != FileFd::WriteOnly)
2406 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2407
2408 int Pipe[2] = {-1, -1};
2409 if(pipe(Pipe) != 0)
2410 return _error->Errno("pipe", _("Failed to create subprocess IPC"));
2411
2412 std::set<int> keep_fds;
2413 keep_fds.insert(Pipe[0]);
2414 keep_fds.insert(Pipe[1]);
2415 Child = ExecFork(keep_fds);
2416 if(Child < 0)
2417 return _error->Errno("fork", "Failed to fork");
2418 if(Child == 0)
2419 {
2420 if(Mode == FileFd::ReadOnly)
2421 {
2422 close(Pipe[0]);
2423 fd = Pipe[1];
2424 }
2425 else if(Mode == FileFd::WriteOnly)
2426 {
2427 close(Pipe[1]);
2428 fd = Pipe[0];
2429 }
2430
2431 if(Mode == FileFd::ReadOnly)
2432 {
2433 dup2(fd, 1);
2434 dup2(fd, 2);
2435 } else if(Mode == FileFd::WriteOnly)
2436 dup2(fd, 0);
2437
2438 execv(Args[0], (char**)Args);
2439 _exit(100);
2440 }
2441 if(Mode == FileFd::ReadOnly)
2442 {
2443 close(Pipe[1]);
2444 fd = Pipe[0];
2445 }
2446 else if(Mode == FileFd::WriteOnly)
2447 {
2448 close(Pipe[0]);
2449 fd = Pipe[1];
2450 }
2451 else
2452 return _error->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2453 Fd.OpenDescriptor(fd, Mode, FileFd::None, true);
2454
2455 return true;
2456 }
2457 /*}}}*/
2458 bool DropPrivileges() /*{{{*/
2459 {
2460 if(_config->FindB("Debug::NoDropPrivs", false) == true)
2461 return true;
2462
2463 #if __gnu_linux__
2464 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2465 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2466 #endif
2467 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2468 int ret = prctl(38, 1, 0, 0, 0);
2469 // ignore EINVAL - kernel is too old to understand the option
2470 if(ret < 0 && errno != EINVAL)
2471 _error->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret);
2472 #endif
2473
2474 // empty setting disables privilege dropping - this also ensures
2475 // backward compatibility, see bug #764506
2476 const std::string toUser = _config->Find("APT::Sandbox::User");
2477 if (toUser.empty() || toUser == "root")
2478 return true;
2479
2480 // a lot can go wrong trying to drop privileges completely,
2481 // so ideally we would like to verify that we have done it –
2482 // but the verify asks for too much in case of fakeroot (and alike)
2483 // [Specific checks can be overridden with dedicated options]
2484 bool const VerifySandboxing = _config->FindB("APT::Sandbox::Verify", false);
2485
2486 // uid will be 0 in the end, but gid might be different anyway
2487 uid_t const old_uid = getuid();
2488 gid_t const old_gid = getgid();
2489
2490 if (old_uid != 0)
2491 return true;
2492
2493 struct passwd *pw = getpwnam(toUser.c_str());
2494 if (pw == NULL)
2495 return _error->Error("No user %s, can not drop rights", toUser.c_str());
2496
2497 // Do not change the order here, it might break things
2498 // Get rid of all our supplementary groups first
2499 if (setgroups(1, &pw->pw_gid))
2500 return _error->Errno("setgroups", "Failed to setgroups");
2501
2502 // Now change the group ids to the new user
2503 #ifdef HAVE_SETRESGID
2504 if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) != 0)
2505 return _error->Errno("setresgid", "Failed to set new group ids");
2506 #else
2507 if (setegid(pw->pw_gid) != 0)
2508 return _error->Errno("setegid", "Failed to setegid");
2509
2510 if (setgid(pw->pw_gid) != 0)
2511 return _error->Errno("setgid", "Failed to setgid");
2512 #endif
2513
2514 // Change the user ids to the new user
2515 #ifdef HAVE_SETRESUID
2516 if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) != 0)
2517 return _error->Errno("setresuid", "Failed to set new user ids");
2518 #else
2519 if (setuid(pw->pw_uid) != 0)
2520 return _error->Errno("setuid", "Failed to setuid");
2521 if (seteuid(pw->pw_uid) != 0)
2522 return _error->Errno("seteuid", "Failed to seteuid");
2523 #endif
2524
2525 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2526 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Groups", false) == true)
2527 {
2528 // Verify that the user isn't still in any supplementary groups
2529 long const ngroups_max = sysconf(_SC_NGROUPS_MAX);
2530 std::unique_ptr<gid_t[]> gidlist(new gid_t[ngroups_max]);
2531 if (unlikely(gidlist == NULL))
2532 return _error->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max);
2533 ssize_t gidlist_nr;
2534 if ((gidlist_nr = getgroups(ngroups_max, gidlist.get())) < 0)
2535 return _error->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max);
2536 for (ssize_t i = 0; i < gidlist_nr; ++i)
2537 if (gidlist[i] != pw->pw_gid)
2538 return _error->Error("Could not switch group, user %s is still in group %d", toUser.c_str(), gidlist[i]);
2539 }
2540
2541 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2542 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::IDs", true) == true)
2543 {
2544 // Verify that gid, egid, uid, and euid changed
2545 if (getgid() != pw->pw_gid)
2546 return _error->Error("Could not switch group");
2547 if (getegid() != pw->pw_gid)
2548 return _error->Error("Could not switch effective group");
2549 if (getuid() != pw->pw_uid)
2550 return _error->Error("Could not switch user");
2551 if (geteuid() != pw->pw_uid)
2552 return _error->Error("Could not switch effective user");
2553
2554 #ifdef HAVE_GETRESUID
2555 // verify that the saved set-user-id was changed as well
2556 uid_t ruid = 0;
2557 uid_t euid = 0;
2558 uid_t suid = 0;
2559 if (getresuid(&ruid, &euid, &suid))
2560 return _error->Errno("getresuid", "Could not get saved set-user-ID");
2561 if (suid != pw->pw_uid)
2562 return _error->Error("Could not switch saved set-user-ID");
2563 #endif
2564
2565 #ifdef HAVE_GETRESGID
2566 // verify that the saved set-group-id was changed as well
2567 gid_t rgid = 0;
2568 gid_t egid = 0;
2569 gid_t sgid = 0;
2570 if (getresgid(&rgid, &egid, &sgid))
2571 return _error->Errno("getresuid", "Could not get saved set-group-ID");
2572 if (sgid != pw->pw_gid)
2573 return _error->Error("Could not switch saved set-group-ID");
2574 #endif
2575 }
2576
2577 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2578 if (VerifySandboxing == true || _config->FindB("APT::Sandbox::Verify::Regain", false) == true)
2579 {
2580 // Check that uid and gid changes do not work anymore
2581 if (pw->pw_gid != old_gid && (setgid(old_gid) != -1 || setegid(old_gid) != -1))
2582 return _error->Error("Could restore a gid to root, privilege dropping did not work");
2583
2584 if (pw->pw_uid != old_uid && (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
2585 return _error->Error("Could restore a uid to root, privilege dropping did not work");
2586 }
2587
2588 return true;
2589 }
2590 /*}}}*/