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