1 // -*- mode: cpp; mode: fold -*-
3 /* ######################################################################
7 CopyFile - Buffered copy of a single file
8 GetLock - dpkg compatible lock file manipulation (fcntl)
10 Most of this source is placed in the Public Domain, do with it what
12 It was originally written by Jason Gunthorpe <jgg@debian.org>.
13 FileFd gzip support added by Martin Pitt <martin.pitt@canonical.com>
15 The exception is RunScripts() it is under the GPLv2
17 ##################################################################### */
19 // Include Files /*{{{*/
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>
33 #include <sys/select.h>
70 #include <sys/prctl.h>
78 // RunScripts - Run a set of scripts from a configuration subtree /*{{{*/
79 // ---------------------------------------------------------------------
81 bool RunScripts(const char *Cnf
)
83 Configuration::Item
const *Opts
= _config
->Tree(Cnf
);
84 if (Opts
== 0 || Opts
->Child
== 0)
88 // Fork for running the system calls
89 pid_t Child
= ExecFork();
94 if (_config
->FindDir("DPkg::Chroot-Directory","/") != "/")
96 std::cerr
<< "Chrooting into "
97 << _config
->FindDir("DPkg::Chroot-Directory")
99 if (chroot(_config
->FindDir("DPkg::Chroot-Directory","/").c_str()) != 0)
103 if (chdir("/tmp/") != 0)
106 unsigned int Count
= 1;
107 for (; Opts
!= 0; Opts
= Opts
->Next
, Count
++)
109 if (Opts
->Value
.empty() == true)
112 if(_config
->FindB("Debug::RunScripts", false) == true)
113 std::clog
<< "Running external script: '"
114 << Opts
->Value
<< "'" << std::endl
;
116 if (system(Opts
->Value
.c_str()) != 0)
122 // Wait for the child
124 while (waitpid(Child
,&Status
,0) != Child
)
128 return _error
->Errno("waitpid","Couldn't wait for subprocess");
131 // Restore sig int/quit
132 signal(SIGQUIT
,SIG_DFL
);
133 signal(SIGINT
,SIG_DFL
);
135 // Check for an error code.
136 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
138 unsigned int Count
= WEXITSTATUS(Status
);
142 for (; Opts
!= 0 && Count
!= 1; Opts
= Opts
->Next
, Count
--);
143 _error
->Error("Problem executing scripts %s '%s'",Cnf
,Opts
->Value
.c_str());
146 return _error
->Error("Sub-process returned an error code");
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
)
158 if (From
.IsOpen() == false || To
.IsOpen() == false ||
159 From
.Failed() == true || To
.Failed() == true)
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;
167 if (From
.Read(Buf
.get(),BufSize
, &ToRead
) == false ||
168 To
.Write(Buf
.get(),ToRead
) == false)
170 } while (ToRead
!= 0);
175 bool RemoveFile(char const * const Function
, std::string
const &FileName
)/*{{{*/
177 if (FileName
== "/dev/null")
180 if (unlink(FileName
.c_str()) != 0)
185 return _error
->WarningE(Function
,_("Problem unlinking the file %s"), FileName
.c_str());
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
)
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);
203 // Read only .. can't have locking problems there.
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
211 _error
->Errno("open",_("Could not open lock file %s"),File
.c_str());
213 // Feh.. We do this to distinguish the lock vs open case..
217 SetCloseExec(FD
,true);
219 // Acquire a write lock
222 fl
.l_whence
= SEEK_SET
;
225 if (fcntl(FD
,F_SETLK
,&fl
) == -1)
227 // always close to not leak resources
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
239 _error
->Errno("open",_("Could not get lock %s"),File
.c_str());
247 // FileExists - Check if a file exists /*{{{*/
248 // ---------------------------------------------------------------------
249 /* Beware: Directories are also files! */
250 bool FileExists(string File
)
253 if (stat(File
.c_str(),&Buf
) != 0)
258 // RealFileExists - Check if a file exists and if it is really a file /*{{{*/
259 // ---------------------------------------------------------------------
261 bool RealFileExists(string File
)
264 if (stat(File
.c_str(),&Buf
) != 0)
266 return ((Buf
.st_mode
& S_IFREG
) != 0);
269 // DirectoryExists - Check if a directory exists and is really one /*{{{*/
270 // ---------------------------------------------------------------------
272 bool DirectoryExists(string
const &Path
)
275 if (stat(Path
.c_str(),&Buf
) != 0)
277 return ((Buf
.st_mode
& S_IFDIR
) != 0);
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
)
290 if (Parent
.empty() == true || Path
.empty() == true)
293 if (DirectoryExists(Path
) == true)
296 if (DirectoryExists(Parent
) == false)
299 // we are not going to create directories "into the blue"
300 if (Path
.compare(0, Parent
.length(), Parent
) != 0)
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
)
307 if (d
->empty() == true)
310 progress
.append("/").append(*d
);
311 if (DirectoryExists(progress
) == true)
314 if (mkdir(progress
.c_str(), 0755) != 0)
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
)
326 if (DirectoryExists(Path
) == true)
329 size_t const len
= Parent
.size();
330 if (len
> 5 && Parent
.find("/apt/", len
- 6, 5) == len
- 5)
332 if (CreateDirectory(Parent
.substr(0,len
-5), Path
) == true)
335 else if (CreateDirectory(Parent
, Path
) == true)
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
)
348 std::vector
<string
> ext
;
350 if (Ext
.empty() == false)
352 if (AllowNoExt
== true && ext
.empty() == false)
354 return GetListOfFilesInDir(Dir
, ext
, SortList
);
356 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, std::vector
<string
> const &Ext
,
357 bool const &SortList
)
359 // Attention debuggers: need to be set with the environment config file!
360 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
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
;
367 for (std::vector
<string
>::const_iterator e
= Ext
.begin();
369 std::clog
<< '\t' << (e
->empty() == true ? "NO" : *e
) << " extension" << std::endl
;
372 std::vector
<string
> List
;
374 if (DirectoryExists(Dir
) == false)
376 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
380 Configuration::MatchAgainstConfig
SilentIgnore("Dir::Ignore-Files-Silently");
381 DIR *D
= opendir(Dir
.c_str());
384 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
388 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
390 // skip "hidden" files
391 if (Ent
->d_name
[0] == '.')
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
)
400 if (RealFileExists(File
) == false)
402 // do not show ignoration warnings for directories
404 #ifdef _DIRENT_HAVE_D_TYPE
405 Ent
->d_type
== DT_DIR
||
407 DirectoryExists(File
) == true)
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());
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)
420 string d_ext
= flExtension(Ent
->d_name
);
421 if (d_ext
== Ent
->d_name
) // no extension
423 if (std::find(Ext
.begin(), Ext
.end(), "") == Ext
.end())
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());
432 else if (std::find(Ext
.begin(), Ext
.end(), d_ext
) == Ext
.end())
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());
442 // Skip bad filenames ala run-parts
443 const char *C
= Ent
->d_name
;
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)
453 // we don't reach the end of the name -> bad character included
457 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »"
458 << *C
<< "« in filename (period allowed: " << (Ext
.empty() ? "no" : "yes") << ")" << std::endl
;
462 // skip filenames which end with a period. These are never valid
466 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
471 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
472 List
.push_back(File
);
476 if (SortList
== true)
477 std::sort(List
.begin(),List
.end());
480 std::vector
<string
> GetListOfFilesInDir(string
const &Dir
, bool SortList
)
482 bool const Debug
= _config
->FindB("Debug::GetListOfFilesInDir", false);
484 std::clog
<< "Accept in " << Dir
<< " all regular files" << std::endl
;
486 std::vector
<string
> List
;
488 if (DirectoryExists(Dir
) == false)
490 _error
->Error(_("List of files can't be created as '%s' is not a directory"), Dir
.c_str());
494 DIR *D
= opendir(Dir
.c_str());
497 _error
->Errno("opendir",_("Unable to read %s"),Dir
.c_str());
501 for (struct dirent
*Ent
= readdir(D
); Ent
!= 0; Ent
= readdir(D
))
503 // skip "hidden" files
504 if (Ent
->d_name
[0] == '.')
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
)
513 if (RealFileExists(File
) == false)
516 std::clog
<< "Bad file: " << Ent
->d_name
<< " → it is not a real file" << std::endl
;
521 // Skip bad filenames ala run-parts
522 const char *C
= Ent
->d_name
;
524 if (isalpha(*C
) == 0 && isdigit(*C
) == 0
525 && *C
!= '_' && *C
!= '-' && *C
!= '.')
528 // we don't reach the end of the name -> bad character included
532 std::clog
<< "Bad file: " << Ent
->d_name
<< " → bad character »" << *C
<< "« in filename" << std::endl
;
536 // skip filenames which end with a period. These are never valid
540 std::clog
<< "Bad file: " << Ent
->d_name
<< " → Period as last character" << std::endl
;
545 std::clog
<< "Accept file: " << Ent
->d_name
<< " in " << Dir
<< std::endl
;
546 List
.push_back(File
);
550 if (SortList
== true)
551 std::sort(List
.begin(),List
.end());
555 // SafeGetCWD - This is a safer getcwd that returns a dynamic string /*{{{*/
556 // ---------------------------------------------------------------------
557 /* We return / on failure. */
560 // Stash the current dir.
563 if (getcwd(S
,sizeof(S
)-2) == 0)
565 unsigned int Len
= strlen(S
);
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
)
577 if (stat(Path
.c_str(), &St
) < 0)
582 // flNotDir - Strip the directory from the filename /*{{{*/
583 // ---------------------------------------------------------------------
585 string
flNotDir(string File
)
587 string::size_type Res
= File
.rfind('/');
588 if (Res
== string::npos
)
591 return string(File
,Res
,Res
- File
.length());
594 // flNotFile - Strip the file from the directory name /*{{{*/
595 // ---------------------------------------------------------------------
596 /* Result ends in a / */
597 string
flNotFile(string File
)
599 string::size_type Res
= File
.rfind('/');
600 if (Res
== string::npos
)
603 return string(File
,0,Res
);
606 // flExtension - Return the extension for the file /*{{{*/
607 // ---------------------------------------------------------------------
609 string
flExtension(string File
)
611 string::size_type Res
= File
.rfind('.');
612 if (Res
== string::npos
)
615 return string(File
,Res
,Res
- File
.length());
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
)
624 if (lstat(File
.c_str(),&St
) != 0 || S_ISLNK(St
.st_mode
) == 0)
626 if (stat(File
.c_str(),&St
) != 0)
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
638 if ((Res
= readlink(NFile
.c_str(),Buffer
,sizeof(Buffer
))) <= 0 ||
639 (size_t)Res
>= sizeof(Buffer
))
642 // Append or replace the previous path
644 if (Buffer
[0] == '/')
647 NFile
= flNotFile(NFile
) + Buffer
;
649 // See if we are done
650 if (lstat(NFile
.c_str(),&St
) != 0)
652 if (S_ISLNK(St
.st_mode
) == 0)
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
)
663 if (File
.empty() == true)
666 if (File
[0] == '/' || Dir
.empty() == true)
668 if (File
.length() >= 2 && File
[0] == '.' && File
[1] == '/')
670 if (Dir
[Dir
.length()-1] == '/')
672 return Dir
+ '/' + File
;
675 // flAbsPath - Return the absolute path of the filename /*{{{*/
676 // ---------------------------------------------------------------------
678 string
flAbsPath(string File
)
680 char *p
= realpath(File
.c_str(), NULL
);
683 _error
->Errno("realpath", "flAbsPath on %s failed", File
.c_str());
686 std::string
AbsPath(p
);
691 // SetCloseExec - Set the close on exec flag /*{{{*/
692 // ---------------------------------------------------------------------
694 void SetCloseExec(int Fd
,bool Close
)
696 if (fcntl(Fd
,F_SETFD
,(Close
== false)?0:FD_CLOEXEC
) != 0)
698 cerr
<< "FATAL -> Could not set close on exec " << strerror(errno
) << endl
;
703 // SetNonBlock - Set the nonblocking flag /*{{{*/
704 // ---------------------------------------------------------------------
706 void SetNonBlock(int Fd
,bool Block
)
708 int Flags
= fcntl(Fd
,F_GETFL
) & (~O_NONBLOCK
);
709 if (fcntl(Fd
,F_SETFL
,Flags
| ((Block
== false)?0:O_NONBLOCK
)) != 0)
711 cerr
<< "FATAL -> Could not set non-blocking flag " << strerror(errno
) << endl
;
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
721 bool WaitFd(int Fd
,bool write
,unsigned long timeout
)
734 Res
= select(Fd
+1,0,&Set
,0,(timeout
!= 0?&tv
:0));
736 while (Res
< 0 && errno
== EINTR
);
746 Res
= select(Fd
+1,&Set
,0,0,(timeout
!= 0?&tv
:0));
748 while (Res
< 0 && errno
== EINTR
);
757 // MergeKeepFdsFromConfiguration - Merge APT::Keep-Fds configuration /*{{{*/
758 // ---------------------------------------------------------------------
759 /* This is used to merge the APT::Keep-Fds with the provided KeepFDs
762 void MergeKeepFdsFromConfiguration(std::set
<int> &KeepFDs
)
764 Configuration::Item
const *Opts
= _config
->Tree("APT::Keep-Fds");
765 if (Opts
!= 0 && Opts
->Child
!= 0)
768 for (; Opts
!= 0; Opts
= Opts
->Next
)
770 if (Opts
->Value
.empty() == true)
772 int fd
= atoi(Opts
->Value
.c_str());
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. */
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
);
792 pid_t
ExecFork(std::set
<int> KeepFDs
)
794 // Fork off the process
795 pid_t Process
= fork();
798 cerr
<< "FATAL -> Failed to fork." << endl
;
802 // Spawn the subprocess
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
);
813 DIR *dir
= opendir("/proc/self/fd");
817 while ((ent
= readdir(dir
)))
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
);
826 long ScOpenMax
= sysconf(_SC_OPEN_MAX
);
827 // Close all of our FDs - just in case
828 for (int K
= 3; K
!= ScOpenMax
; K
++)
830 if(KeepFDs
.find(K
) == KeepFDs
.end())
831 fcntl(K
,F_SETFD
,FD_CLOEXEC
);
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
844 bool ExecWait(pid_t Pid
,const char *Name
,bool Reap
)
849 // Wait and collect the error code
851 while (waitpid(Pid
,&Status
,0) != Pid
)
859 return _error
->Error(_("Waited for %s but it wasn't there"),Name
);
863 // Check for an error code.
864 if (WIFEXITED(Status
) == 0 || WEXITSTATUS(Status
) != 0)
868 if (WIFSIGNALED(Status
) != 0)
870 if( WTERMSIG(Status
) == SIGSEGV
)
871 return _error
->Error(_("Sub-process %s received a segmentation fault."),Name
);
873 return _error
->Error(_("Sub-process %s received signal %u."),Name
, WTERMSIG(Status
));
876 if (WIFEXITED(Status
) != 0)
877 return _error
->Error(_("Sub-process %s returned an error code (%u)"),Name
,WEXITSTATUS(Status
));
879 return _error
->Error(_("Sub-process %s exited unexpectedly"),Name
);
885 // StartsWithGPGClearTextSignature - Check if a file is Pgp/GPG clearsigned /*{{{*/
886 bool StartsWithGPGClearTextSignature(string
const &FileName
)
888 static const char* SIGMSG
= "-----BEGIN PGP SIGNED MESSAGE-----\n";
889 char buffer
[strlen(SIGMSG
)+1];
890 FILE* gpg
= fopen(FileName
.c_str(), "r");
894 char const * const test
= fgets(buffer
, sizeof(buffer
), gpg
);
896 if (test
== NULL
|| strcmp(buffer
, SIGMSG
) != 0)
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
)
905 if (strcmp(file
, "/dev/null") == 0)
908 if (getuid() == 0 && strlen(user
) != 0 && strlen(group
) != 0) // if we aren't root, we can't chown, so don't try it
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
);
916 if (chmod(file
, mode
) != 0)
917 Res
&= _error
->WarningE(requester
, "chmod 0%o of file %s failed", mode
, file
);
922 struct APT_HIDDEN simple_buffer
{ /*{{{*/
923 static constexpr size_t buffersize_max
= 4096;
924 unsigned long long bufferstart
= 0;
925 unsigned long long bufferend
= 0;
926 char buffer
[buffersize_max
];
928 const char *get() const { return buffer
+ bufferstart
; }
929 char *get() { return buffer
+ bufferstart
; }
930 bool empty() const { return bufferend
<= bufferstart
; }
931 bool full() const { return bufferend
== buffersize_max
; }
932 unsigned long long size() const { return bufferend
-bufferstart
; }
933 void reset() { bufferend
= bufferstart
= 0; }
934 ssize_t
read(void *to
, unsigned long long requested_size
) APT_MUSTCHECK
936 if (size() < requested_size
)
937 requested_size
= size();
938 memcpy(to
, buffer
+ bufferstart
, requested_size
);
939 bufferstart
+= requested_size
;
940 if (bufferstart
== bufferend
)
941 bufferstart
= bufferend
= 0;
942 return requested_size
;
944 ssize_t
write(const void *from
, unsigned long long requested_size
) APT_MUSTCHECK
946 if (buffersize_max
- size() < requested_size
)
947 requested_size
= buffersize_max
- size();
948 memcpy(buffer
+ bufferend
, from
, requested_size
);
949 bufferend
+= requested_size
;
950 if (bufferstart
== bufferend
)
951 bufferstart
= bufferend
= 0;
952 return requested_size
;
957 class APT_HIDDEN FileFdPrivate
{ /*{{{*/
959 FileFd
* const filefd
;
960 simple_buffer buffer
;
962 pid_t compressor_pid
;
964 APT::Configuration::Compressor compressor
;
965 unsigned int openmode
;
966 unsigned long long seekpos
;
969 explicit FileFdPrivate(FileFd
* const pfilefd
) : filefd(pfilefd
),
970 compressed_fd(-1), compressor_pid(-1), is_pipe(false),
971 openmode(0), seekpos(0) {};
972 virtual APT::Configuration::Compressor
get_compressor() const
976 virtual void set_compressor(APT::Configuration::Compressor
const &compressor
)
978 this->compressor
= compressor
;
980 virtual unsigned int get_openmode() const
984 virtual void set_openmode(unsigned int openmode
)
986 this->openmode
= openmode
;
988 virtual bool get_is_pipe() const
992 virtual void set_is_pipe(bool is_pipe
)
994 this->is_pipe
= is_pipe
;
996 virtual unsigned long long get_seekpos() const
1000 virtual void set_seekpos(unsigned long long seekpos
)
1002 this->seekpos
= seekpos
;
1005 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) = 0;
1006 ssize_t
InternalRead(void * To
, unsigned long long Size
)
1008 // Drain the buffer if needed.
1009 if (buffer
.empty() == false)
1011 return buffer
.read(To
, Size
);
1013 return InternalUnbufferedRead(To
, Size
);
1015 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) = 0;
1016 virtual bool InternalReadError() { return filefd
->FileFdErrno("read",_("Read error")); }
1017 virtual char * InternalReadLine(char * To
, unsigned long long Size
)
1019 if (unlikely(Size
== 0))
1021 // Read one byte less than buffer size to have space for trailing 0.
1024 char * const InitialTo
= To
;
1027 if (buffer
.empty() == true)
1030 unsigned long long actualread
= 0;
1031 if (filefd
->Read(buffer
.get(), buffer
.buffersize_max
, &actualread
) == false)
1033 buffer
.bufferend
= actualread
;
1034 if (buffer
.size() == 0)
1036 if (To
== InitialTo
)
1040 filefd
->Flags
&= ~FileFd::HitEof
;
1043 unsigned long long const OutputSize
= std::min(Size
, buffer
.size());
1044 char const * const newline
= static_cast<char const * const>(memchr(buffer
.get(), '\n', OutputSize
));
1045 // Read until end of line or up to Size bytes from the buffer.
1046 unsigned long long actualread
= buffer
.read(To
,
1047 (newline
!= nullptr)
1048 ? (newline
- buffer
.get()) + 1
1052 if (newline
!= nullptr)
1058 virtual bool InternalFlush()
1062 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) = 0;
1063 virtual bool InternalWriteError() { return filefd
->FileFdErrno("write",_("Write error")); }
1064 virtual bool InternalSeek(unsigned long long const To
)
1066 // Our poor man seeking is costly, so try to avoid it
1067 unsigned long long const iseekpos
= filefd
->Tell();
1070 else if (iseekpos
< To
)
1071 return filefd
->Skip(To
- iseekpos
);
1073 if ((openmode
& FileFd::ReadOnly
) != FileFd::ReadOnly
)
1074 return filefd
->FileFdError("Reopen is only implemented for read-only files!");
1075 InternalClose(filefd
->FileName
);
1076 if (filefd
->iFd
!= -1)
1079 if (filefd
->TemporaryFileName
.empty() == false)
1080 filefd
->iFd
= open(filefd
->TemporaryFileName
.c_str(), O_RDONLY
);
1081 else if (filefd
->FileName
.empty() == false)
1082 filefd
->iFd
= open(filefd
->FileName
.c_str(), O_RDONLY
);
1085 if (compressed_fd
> 0)
1086 if (lseek(compressed_fd
, 0, SEEK_SET
) != 0)
1087 filefd
->iFd
= compressed_fd
;
1088 if (filefd
->iFd
< 0)
1089 return filefd
->FileFdError("Reopen is not implemented for pipes opened with FileFd::OpenDescriptor()!");
1092 if (filefd
->OpenInternDescriptor(openmode
, compressor
) == false)
1093 return filefd
->FileFdError("Seek on file %s because it couldn't be reopened", filefd
->FileName
.c_str());
1097 return filefd
->Skip(To
);
1102 virtual bool InternalSkip(unsigned long long Over
)
1104 unsigned long long constexpr buffersize
= 1024;
1105 char buffer
[buffersize
];
1108 unsigned long long toread
= std::min(buffersize
, Over
);
1109 if (filefd
->Read(buffer
, toread
) == false)
1110 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1115 virtual bool InternalTruncate(unsigned long long const)
1117 return filefd
->FileFdError("Truncating compressed files is not implemented (%s)", filefd
->FileName
.c_str());
1119 virtual unsigned long long InternalTell()
1121 // In theory, we could just return seekpos here always instead of
1122 // seeking around, but not all users of FileFd use always Seek() and co
1123 // so d->seekpos isn't always true and we can just use it as a hint if
1124 // we have nothing else, but not always as an authority…
1125 return seekpos
- buffer
.size();
1127 virtual unsigned long long InternalSize()
1129 unsigned long long size
= 0;
1130 unsigned long long const oldSeek
= filefd
->Tell();
1131 unsigned long long constexpr ignoresize
= 1024;
1132 char ignore
[ignoresize
];
1133 unsigned long long read
= 0;
1135 if (filefd
->Read(ignore
, ignoresize
, &read
) == false)
1137 filefd
->Seek(oldSeek
);
1141 size
= filefd
->Tell();
1142 filefd
->Seek(oldSeek
);
1145 virtual bool InternalClose(std::string
const &FileName
) = 0;
1146 virtual bool InternalStream() const { return false; }
1147 virtual bool InternalAlwaysAutoClose() const { return true; }
1149 virtual ~FileFdPrivate() {}
1152 class APT_HIDDEN GzipFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1156 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1158 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1159 gz
= gzdopen(iFd
, "r+");
1160 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1161 gz
= gzdopen(iFd
, "w");
1163 gz
= gzdopen(iFd
, "r");
1164 filefd
->Flags
|= FileFd::Compressed
;
1165 return gz
!= nullptr;
1167 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1169 return gzread(gz
, To
, Size
);
1171 virtual bool InternalReadError() override
1174 char const * const errmsg
= gzerror(gz
, &err
);
1176 return filefd
->FileFdError("gzread: %s (%d: %s)", _("Read error"), err
, errmsg
);
1177 return FileFdPrivate::InternalReadError();
1179 virtual char * InternalReadLine(char * To
, unsigned long long Size
) override
1181 return gzgets(gz
, To
, Size
);
1183 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1185 return gzwrite(gz
,From
,Size
);
1187 virtual bool InternalWriteError() override
1190 char const * const errmsg
= gzerror(gz
, &err
);
1192 return filefd
->FileFdError("gzwrite: %s (%d: %s)", _("Write error"), err
, errmsg
);
1193 return FileFdPrivate::InternalWriteError();
1195 virtual bool InternalSeek(unsigned long long const To
) override
1197 off_t
const res
= gzseek(gz
, To
, SEEK_SET
);
1198 if (res
!= (off_t
)To
)
1199 return filefd
->FileFdError("Unable to seek to %llu", To
);
1204 virtual bool InternalSkip(unsigned long long Over
) override
1206 if (Over
>= buffer
.size())
1208 Over
-= buffer
.size();
1213 buffer
.bufferstart
+= Over
;
1218 off_t
const res
= gzseek(gz
, Over
, SEEK_CUR
);
1220 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1224 virtual unsigned long long InternalTell() override
1226 return gztell(gz
) - buffer
.size();
1228 virtual unsigned long long InternalSize() override
1230 unsigned long long filesize
= FileFdPrivate::InternalSize();
1231 // only check gzsize if we are actually a gzip file, just checking for
1232 // "gz" is not sufficient as uncompressed files could be opened with
1233 // gzopen in "direct" mode as well
1234 if (filesize
== 0 || gzdirect(gz
))
1237 off_t
const oldPos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1238 /* unfortunately zlib.h doesn't provide a gzsize(), so we have to do
1239 * this ourselves; the original (uncompressed) file size is the last 32
1240 * bits of the file */
1241 // FIXME: Size for gz-files is limited by 32bit… no largefile support
1242 if (lseek(filefd
->iFd
, -4, SEEK_END
) < 0)
1244 filefd
->FileFdErrno("lseek","Unable to seek to end of gzipped file");
1248 if (read(filefd
->iFd
, &size
, 4) != 4)
1250 filefd
->FileFdErrno("read","Unable to read original size of gzipped file");
1253 size
= le32toh(size
);
1255 if (lseek(filefd
->iFd
, oldPos
, SEEK_SET
) < 0)
1257 filefd
->FileFdErrno("lseek","Unable to seek in gzipped file");
1262 virtual bool InternalClose(std::string
const &FileName
) override
1266 int const e
= gzclose(gz
);
1268 // gzdclose() on empty files always fails with "buffer error" here, ignore that
1269 if (e
!= 0 && e
!= Z_BUF_ERROR
)
1270 return _error
->Errno("close",_("Problem closing the gzip file %s"), FileName
.c_str());
1274 explicit GzipFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), gz(nullptr) {}
1275 virtual ~GzipFileFdPrivate() { InternalClose(""); }
1279 class APT_HIDDEN Bz2FileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1283 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1285 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1286 bz2
= BZ2_bzdopen(iFd
, "r+");
1287 else if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1288 bz2
= BZ2_bzdopen(iFd
, "w");
1290 bz2
= BZ2_bzdopen(iFd
, "r");
1291 filefd
->Flags
|= FileFd::Compressed
;
1292 return bz2
!= nullptr;
1294 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1296 return BZ2_bzread(bz2
, To
, Size
);
1298 virtual bool InternalReadError() override
1301 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1302 if (err
!= BZ_IO_ERROR
)
1303 return filefd
->FileFdError("BZ2_bzread: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Read error"), err
, errmsg
);
1304 return FileFdPrivate::InternalReadError();
1306 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1308 return BZ2_bzwrite(bz2
, (void*)From
, Size
);
1310 virtual bool InternalWriteError() override
1313 char const * const errmsg
= BZ2_bzerror(bz2
, &err
);
1314 if (err
!= BZ_IO_ERROR
)
1315 return filefd
->FileFdError("BZ2_bzwrite: %s %s (%d: %s)", filefd
->FileName
.c_str(), _("Write error"), err
, errmsg
);
1316 return FileFdPrivate::InternalWriteError();
1318 virtual bool InternalStream() const override
{ return true; }
1319 virtual bool InternalClose(std::string
const &) override
1328 explicit Bz2FileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), bz2(nullptr) {}
1329 virtual ~Bz2FileFdPrivate() { InternalClose(""); }
1333 class APT_HIDDEN LzmaFileFdPrivate
: public FileFdPrivate
{ /*{{{*/
1337 uint8_t buffer
[4096];
1343 LZMAFILE() : file(nullptr), eof(false), compressing(false) { buffer
[0] = '\0'; }
1346 if (compressing
== true)
1348 size_t constexpr buffersize
= sizeof(buffer
)/sizeof(buffer
[0]);
1351 stream
.avail_out
= buffersize
;
1352 stream
.next_out
= buffer
;
1353 err
= lzma_code(&stream
, LZMA_FINISH
);
1354 if (err
!= LZMA_OK
&& err
!= LZMA_STREAM_END
)
1356 _error
->Error("~LZMAFILE: Compress finalisation failed");
1359 size_t const n
= buffersize
- stream
.avail_out
;
1360 if (n
&& fwrite(buffer
, 1, n
, file
) != n
)
1362 _error
->Errno("~LZMAFILE",_("Write error"));
1365 if (err
== LZMA_STREAM_END
)
1374 static uint32_t findXZlevel(std::vector
<std::string
> const &Args
)
1376 for (auto a
= Args
.rbegin(); a
!= Args
.rend(); ++a
)
1377 if (a
->empty() == false && (*a
)[0] == '-' && (*a
)[1] != '-')
1379 auto const number
= a
->find_last_of("0123456789");
1380 if (number
== std::string::npos
)
1382 auto const extreme
= a
->find("e", number
);
1383 uint32_t level
= (extreme
!= std::string::npos
) ? LZMA_PRESET_EXTREME
: 0;
1384 switch ((*a
)[number
])
1386 case '0': return level
| 0;
1387 case '1': return level
| 1;
1388 case '2': return level
| 2;
1389 case '3': return level
| 3;
1390 case '4': return level
| 4;
1391 case '5': return level
| 5;
1392 case '6': return level
| 6;
1393 case '7': return level
| 7;
1394 case '8': return level
| 8;
1395 case '9': return level
| 9;
1401 virtual bool InternalOpen(int const iFd
, unsigned int const Mode
) override
1403 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1404 return filefd
->FileFdError("ReadWrite mode is not supported for lzma/xz files %s", filefd
->FileName
.c_str());
1406 if (lzma
== nullptr)
1407 lzma
= new LzmaFileFdPrivate::LZMAFILE
;
1408 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1409 lzma
->file
= fdopen(iFd
, "w");
1411 lzma
->file
= fdopen(iFd
, "r");
1412 filefd
->Flags
|= FileFd::Compressed
;
1413 if (lzma
->file
== nullptr)
1416 lzma_stream tmp_stream
= LZMA_STREAM_INIT
;
1417 lzma
->stream
= tmp_stream
;
1419 if ((Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
)
1421 uint32_t const xzlevel
= findXZlevel(compressor
.CompressArgs
);
1422 if (compressor
.Name
== "xz")
1424 if (lzma_easy_encoder(&lzma
->stream
, xzlevel
, LZMA_CHECK_CRC64
) != LZMA_OK
)
1429 lzma_options_lzma options
;
1430 lzma_lzma_preset(&options
, xzlevel
);
1431 if (lzma_alone_encoder(&lzma
->stream
, &options
) != LZMA_OK
)
1434 lzma
->compressing
= true;
1438 uint64_t const memlimit
= UINT64_MAX
;
1439 if (compressor
.Name
== "xz")
1441 if (lzma_auto_decoder(&lzma
->stream
, memlimit
, 0) != LZMA_OK
)
1446 if (lzma_alone_decoder(&lzma
->stream
, memlimit
) != LZMA_OK
)
1449 lzma
->compressing
= false;
1453 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1456 if (lzma
->eof
== true)
1459 lzma
->stream
.next_out
= (uint8_t *) To
;
1460 lzma
->stream
.avail_out
= Size
;
1461 if (lzma
->stream
.avail_in
== 0)
1463 lzma
->stream
.next_in
= lzma
->buffer
;
1464 lzma
->stream
.avail_in
= fread(lzma
->buffer
, 1, sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]), lzma
->file
);
1466 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1467 if (lzma
->err
== LZMA_STREAM_END
)
1470 Res
= Size
- lzma
->stream
.avail_out
;
1472 else if (lzma
->err
!= LZMA_OK
)
1479 Res
= Size
- lzma
->stream
.avail_out
;
1482 // lzma run was okay, but produced no output…
1489 virtual bool InternalReadError() override
1491 return filefd
->FileFdError("lzma_read: %s (%d)", _("Read error"), lzma
->err
);
1493 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1495 lzma
->stream
.next_in
= (uint8_t *)From
;
1496 lzma
->stream
.avail_in
= Size
;
1497 lzma
->stream
.next_out
= lzma
->buffer
;
1498 lzma
->stream
.avail_out
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]);
1499 lzma
->err
= lzma_code(&lzma
->stream
, LZMA_RUN
);
1500 if (lzma
->err
!= LZMA_OK
)
1502 size_t const n
= sizeof(lzma
->buffer
)/sizeof(lzma
->buffer
[0]) - lzma
->stream
.avail_out
;
1503 size_t const m
= (n
== 0) ? 0 : fwrite(lzma
->buffer
, 1, n
, lzma
->file
);
1507 return Size
- lzma
->stream
.avail_in
;
1509 virtual bool InternalWriteError() override
1511 return filefd
->FileFdError("lzma_write: %s (%d)", _("Write error"), lzma
->err
);
1513 virtual bool InternalStream() const override
{ return true; }
1514 virtual bool InternalClose(std::string
const &) override
1521 explicit LzmaFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
), lzma(nullptr) {}
1522 virtual ~LzmaFileFdPrivate() { InternalClose(""); }
1526 class APT_HIDDEN PipedFileFdPrivate
: public FileFdPrivate
/*{{{*/
1527 /* if we don't have a specific class dealing with library calls, we (un)compress
1528 by executing a specified binary and pipe in/out what we need */
1531 virtual bool InternalOpen(int const, unsigned int const Mode
) override
1533 // collect zombies here in case we reopen
1534 if (compressor_pid
> 0)
1535 ExecWait(compressor_pid
, "FileFdCompressor", true);
1537 if ((Mode
& FileFd::ReadWrite
) == FileFd::ReadWrite
)
1538 return filefd
->FileFdError("ReadWrite mode is not supported for file %s", filefd
->FileName
.c_str());
1540 bool const Comp
= (Mode
& FileFd::WriteOnly
) == FileFd::WriteOnly
;
1543 // Handle 'decompression' of empty files
1545 fstat(filefd
->iFd
, &Buf
);
1546 if (Buf
.st_size
== 0 && S_ISFIFO(Buf
.st_mode
) == false)
1549 // We don't need the file open - instead let the compressor open it
1550 // as he properly knows better how to efficiently read from 'his' file
1551 if (filefd
->FileName
.empty() == false)
1558 // Create a data pipe
1559 int Pipe
[2] = {-1,-1};
1560 if (pipe(Pipe
) != 0)
1561 return filefd
->FileFdErrno("pipe",_("Failed to create subprocess IPC"));
1562 for (int J
= 0; J
!= 2; J
++)
1563 SetCloseExec(Pipe
[J
],true);
1565 compressed_fd
= filefd
->iFd
;
1569 filefd
->iFd
= Pipe
[1];
1571 filefd
->iFd
= Pipe
[0];
1574 compressor_pid
= ExecFork();
1575 if (compressor_pid
== 0)
1579 dup2(compressed_fd
,STDOUT_FILENO
);
1580 dup2(Pipe
[0],STDIN_FILENO
);
1584 if (compressed_fd
!= -1)
1585 dup2(compressed_fd
,STDIN_FILENO
);
1586 dup2(Pipe
[1],STDOUT_FILENO
);
1588 int const nullfd
= open("/dev/null", O_WRONLY
);
1591 dup2(nullfd
,STDERR_FILENO
);
1595 SetCloseExec(STDOUT_FILENO
,false);
1596 SetCloseExec(STDIN_FILENO
,false);
1598 std::vector
<char const*> Args
;
1599 Args
.push_back(compressor
.Binary
.c_str());
1600 std::vector
<std::string
> const * const addArgs
=
1601 (Comp
== true) ? &(compressor
.CompressArgs
) : &(compressor
.UncompressArgs
);
1602 for (std::vector
<std::string
>::const_iterator a
= addArgs
->begin();
1603 a
!= addArgs
->end(); ++a
)
1604 Args
.push_back(a
->c_str());
1605 if (Comp
== false && filefd
->FileName
.empty() == false)
1607 // commands not needing arguments, do not need to be told about using standard output
1608 // in reality, only testcases with tools like cat, rev, rot13, … are able to trigger this
1609 if (compressor
.CompressArgs
.empty() == false && compressor
.UncompressArgs
.empty() == false)
1610 Args
.push_back("--stdout");
1611 if (filefd
->TemporaryFileName
.empty() == false)
1612 Args
.push_back(filefd
->TemporaryFileName
.c_str());
1614 Args
.push_back(filefd
->FileName
.c_str());
1616 Args
.push_back(NULL
);
1618 execvp(Args
[0],(char **)&Args
[0]);
1619 cerr
<< _("Failed to exec compressor ") << Args
[0] << endl
;
1629 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1631 return read(filefd
->iFd
, To
, Size
);
1633 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1635 return write(filefd
->iFd
, From
, Size
);
1637 virtual bool InternalClose(std::string
const &) override
1640 if (compressor_pid
> 0)
1641 Ret
&= ExecWait(compressor_pid
, "FileFdCompressor", true);
1642 compressor_pid
= -1;
1645 explicit PipedFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1646 virtual ~PipedFileFdPrivate() { InternalClose(""); }
1649 class APT_HIDDEN DirectFileFdPrivate
: public FileFdPrivate
/*{{{*/
1652 virtual bool InternalOpen(int const, unsigned int const) override
{ return true; }
1653 virtual ssize_t
InternalUnbufferedRead(void * const To
, unsigned long long const Size
) override
1655 return read(filefd
->iFd
, To
, Size
);
1657 virtual ssize_t
InternalWrite(void const * const From
, unsigned long long const Size
) override
1659 // files opened read+write are strange and only really "supported" for direct files
1660 if (buffer
.size() != 0)
1662 lseek(filefd
->iFd
, -buffer
.size(), SEEK_CUR
);
1665 return write(filefd
->iFd
, From
, Size
);
1667 virtual bool InternalSeek(unsigned long long const To
) override
1669 off_t
const res
= lseek(filefd
->iFd
, To
, SEEK_SET
);
1670 if (res
!= (off_t
)To
)
1671 return filefd
->FileFdError("Unable to seek to %llu", To
);
1676 virtual bool InternalSkip(unsigned long long Over
) override
1678 if (Over
>= buffer
.size())
1680 Over
-= buffer
.size();
1685 buffer
.bufferstart
+= Over
;
1690 off_t
const res
= lseek(filefd
->iFd
, Over
, SEEK_CUR
);
1692 return filefd
->FileFdError("Unable to seek ahead %llu",Over
);
1696 virtual bool InternalTruncate(unsigned long long const To
) override
1698 if (buffer
.size() != 0)
1700 unsigned long long const seekpos
= lseek(filefd
->iFd
, 0, SEEK_CUR
);
1701 if ((seekpos
- buffer
.size()) >= To
)
1703 else if (seekpos
>= To
)
1704 buffer
.bufferend
= (To
- seekpos
) + buffer
.bufferstart
;
1708 if (ftruncate(filefd
->iFd
, To
) != 0)
1709 return filefd
->FileFdError("Unable to truncate to %llu",To
);
1712 virtual unsigned long long InternalTell() override
1714 return lseek(filefd
->iFd
,0,SEEK_CUR
) - buffer
.size();
1716 virtual unsigned long long InternalSize() override
1718 return filefd
->FileSize();
1720 virtual bool InternalClose(std::string
const &) override
{ return true; }
1721 virtual bool InternalAlwaysAutoClose() const override
{ return false; }
1723 explicit DirectFileFdPrivate(FileFd
* const filefd
) : FileFdPrivate(filefd
) {}
1724 virtual ~DirectFileFdPrivate() { InternalClose(""); }
1727 // FileFd Constructors /*{{{*/
1728 FileFd::FileFd(std::string FileName
,unsigned int const Mode
,unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1730 Open(FileName
,Mode
, None
, AccessMode
);
1732 FileFd::FileFd(std::string FileName
,unsigned int const Mode
, CompressMode Compress
, unsigned long AccessMode
) : iFd(-1), Flags(0), d(NULL
)
1734 Open(FileName
,Mode
, Compress
, AccessMode
);
1736 FileFd::FileFd() : iFd(-1), Flags(AutoClose
), d(NULL
) {}
1737 FileFd::FileFd(int const Fd
, unsigned int const Mode
, CompressMode Compress
) : iFd(-1), Flags(0), d(NULL
)
1739 OpenDescriptor(Fd
, Mode
, Compress
);
1741 FileFd::FileFd(int const Fd
, bool const AutoClose
) : iFd(-1), Flags(0), d(NULL
)
1743 OpenDescriptor(Fd
, ReadWrite
, None
, AutoClose
);
1746 // FileFd::Open - Open a file /*{{{*/
1747 // ---------------------------------------------------------------------
1748 /* The most commonly used open mode combinations are given with Mode */
1749 bool FileFd::Open(string FileName
,unsigned int const Mode
,CompressMode Compress
, unsigned long const AccessMode
)
1751 if (Mode
== ReadOnlyGzip
)
1752 return Open(FileName
, ReadOnly
, Gzip
, AccessMode
);
1754 if (Compress
== Auto
&& (Mode
& WriteOnly
) == WriteOnly
)
1755 return FileFdError("Autodetection on %s only works in ReadOnly openmode!", FileName
.c_str());
1757 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1758 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1759 if (Compress
== Auto
)
1761 for (; compressor
!= compressors
.end(); ++compressor
)
1763 std::string file
= FileName
+ compressor
->Extension
;
1764 if (FileExists(file
) == false)
1770 else if (Compress
== Extension
)
1772 std::string::size_type
const found
= FileName
.find_last_of('.');
1774 if (found
!= std::string::npos
)
1776 ext
= FileName
.substr(found
);
1777 if (ext
== ".new" || ext
== ".bak")
1779 std::string::size_type
const found2
= FileName
.find_last_of('.', found
- 1);
1780 if (found2
!= std::string::npos
)
1781 ext
= FileName
.substr(found2
, found
- found2
);
1786 for (; compressor
!= compressors
.end(); ++compressor
)
1787 if (ext
== compressor
->Extension
)
1789 // no matching extension - assume uncompressed (imagine files like 'example.org_Packages')
1790 if (compressor
== compressors
.end())
1791 for (compressor
= compressors
.begin(); compressor
!= compressors
.end(); ++compressor
)
1792 if (compressor
->Name
== ".")
1800 case None
: name
= "."; break;
1801 case Gzip
: name
= "gzip"; break;
1802 case Bzip2
: name
= "bzip2"; break;
1803 case Lzma
: name
= "lzma"; break;
1804 case Xz
: name
= "xz"; break;
1808 return FileFdError("Opening File %s in None, Auto or Extension should be already handled?!?", FileName
.c_str());
1810 for (; compressor
!= compressors
.end(); ++compressor
)
1811 if (compressor
->Name
== name
)
1813 if (compressor
== compressors
.end())
1814 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1817 if (compressor
== compressors
.end())
1818 return FileFdError("Can't find a match for specified compressor mode for file %s", FileName
.c_str());
1819 return Open(FileName
, Mode
, *compressor
, AccessMode
);
1821 bool FileFd::Open(string FileName
,unsigned int const Mode
,APT::Configuration::Compressor
const &compressor
, unsigned long const AccessMode
)
1826 if ((Mode
& WriteOnly
) != WriteOnly
&& (Mode
& (Atomic
| Create
| Empty
| Exclusive
)) != 0)
1827 return FileFdError("ReadOnly mode for %s doesn't accept additional flags!", FileName
.c_str());
1828 if ((Mode
& ReadWrite
) == 0)
1829 return FileFdError("No openmode provided in FileFd::Open for %s", FileName
.c_str());
1831 unsigned int OpenMode
= Mode
;
1832 if (FileName
== "/dev/null")
1833 OpenMode
= OpenMode
& ~(Atomic
| Exclusive
| Create
| Empty
);
1835 if ((OpenMode
& Atomic
) == Atomic
)
1839 else if ((OpenMode
& (Exclusive
| Create
)) == (Exclusive
| Create
))
1841 // for atomic, this will be done by rename in Close()
1842 RemoveFile("FileFd::Open", FileName
);
1844 if ((OpenMode
& Empty
) == Empty
)
1847 if (lstat(FileName
.c_str(),&Buf
) == 0 && S_ISLNK(Buf
.st_mode
))
1848 RemoveFile("FileFd::Open", FileName
);
1852 #define if_FLAGGED_SET(FLAG, MODE) if ((OpenMode & FLAG) == FLAG) fileflags |= MODE
1853 if_FLAGGED_SET(ReadWrite
, O_RDWR
);
1854 else if_FLAGGED_SET(ReadOnly
, O_RDONLY
);
1855 else if_FLAGGED_SET(WriteOnly
, O_WRONLY
);
1857 if_FLAGGED_SET(Create
, O_CREAT
);
1858 if_FLAGGED_SET(Empty
, O_TRUNC
);
1859 if_FLAGGED_SET(Exclusive
, O_EXCL
);
1860 #undef if_FLAGGED_SET
1862 if ((OpenMode
& Atomic
) == Atomic
)
1864 char *name
= strdup((FileName
+ ".XXXXXX").c_str());
1866 if((iFd
= mkstemp(name
)) == -1)
1869 return FileFdErrno("mkstemp", "Could not create temporary file for %s", FileName
.c_str());
1872 TemporaryFileName
= string(name
);
1875 // umask() will always set the umask and return the previous value, so
1876 // we first set the umask and then reset it to the old value
1877 mode_t
const CurrentUmask
= umask(0);
1878 umask(CurrentUmask
);
1879 // calculate the actual file permissions (just like open/creat)
1880 mode_t
const FilePermissions
= (AccessMode
& ~CurrentUmask
);
1882 if(fchmod(iFd
, FilePermissions
) == -1)
1883 return FileFdErrno("fchmod", "Could not change permissions for temporary file %s", TemporaryFileName
.c_str());
1886 iFd
= open(FileName
.c_str(), fileflags
, AccessMode
);
1888 this->FileName
= FileName
;
1889 if (iFd
== -1 || OpenInternDescriptor(OpenMode
, compressor
) == false)
1896 return FileFdErrno("open",_("Could not open file %s"), FileName
.c_str());
1899 SetCloseExec(iFd
,true);
1903 // FileFd::OpenDescriptor - Open a filedescriptor /*{{{*/
1904 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, CompressMode Compress
, bool AutoClose
)
1906 std::vector
<APT::Configuration::Compressor
> const compressors
= APT::Configuration::getCompressors();
1907 std::vector
<APT::Configuration::Compressor
>::const_iterator compressor
= compressors
.begin();
1910 // compat with the old API
1911 if (Mode
== ReadOnlyGzip
&& Compress
== None
)
1916 case None
: name
= "."; break;
1917 case Gzip
: name
= "gzip"; break;
1918 case Bzip2
: name
= "bzip2"; break;
1919 case Lzma
: name
= "lzma"; break;
1920 case Xz
: name
= "xz"; break;
1923 if (AutoClose
== true && Fd
!= -1)
1925 return FileFdError("Opening Fd %d in Auto or Extension compression mode is not supported", Fd
);
1927 for (; compressor
!= compressors
.end(); ++compressor
)
1928 if (compressor
->Name
== name
)
1930 if (compressor
== compressors
.end())
1932 if (AutoClose
== true && Fd
!= -1)
1934 return FileFdError("Can't find a configured compressor %s for file %s", name
.c_str(), FileName
.c_str());
1936 return OpenDescriptor(Fd
, Mode
, *compressor
, AutoClose
);
1938 bool FileFd::OpenDescriptor(int Fd
, unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
, bool AutoClose
)
1941 Flags
= (AutoClose
) ? FileFd::AutoClose
: 0;
1943 this->FileName
= "";
1944 if (OpenInternDescriptor(Mode
, compressor
) == false)
1947 (Flags
& Compressed
) == Compressed
||
1953 return FileFdError(_("Could not open file descriptor %d"), Fd
);
1957 bool FileFd::OpenInternDescriptor(unsigned int const Mode
, APT::Configuration::Compressor
const &compressor
)
1963 d
->InternalClose(FileName
);
1968 /* dummy so that the rest can be 'else if's */;
1969 #define APT_COMPRESS_INIT(NAME, CONSTRUCTOR) \
1970 else if (compressor.Name == NAME) \
1971 d = new CONSTRUCTOR(this)
1973 APT_COMPRESS_INIT("gzip", GzipFileFdPrivate
);
1976 APT_COMPRESS_INIT("bzip2", Bz2FileFdPrivate
);
1979 APT_COMPRESS_INIT("xz", LzmaFileFdPrivate
);
1980 APT_COMPRESS_INIT("lzma", LzmaFileFdPrivate
);
1982 #undef APT_COMPRESS_INIT
1983 else if (compressor
.Name
== "." || compressor
.Binary
.empty() == true)
1984 d
= new DirectFileFdPrivate(this);
1986 d
= new PipedFileFdPrivate(this);
1988 d
->set_openmode(Mode
);
1989 d
->set_compressor(compressor
);
1990 if ((Flags
& AutoClose
) != AutoClose
&& d
->InternalAlwaysAutoClose())
1992 // Need to duplicate fd here or gz/bz2 close for cleanup will close the fd as well
1993 int const internFd
= dup(iFd
);
1995 return FileFdErrno("OpenInternDescriptor", _("Could not open file descriptor %d"), iFd
);
1999 return d
->InternalOpen(iFd
, Mode
);
2002 // FileFd::~File - Closes the file /*{{{*/
2003 // ---------------------------------------------------------------------
2004 /* If the proper modes are selected then we close the Fd and possibly
2005 unlink the file on error. */
2010 d
->InternalClose(FileName
);
2015 // FileFd::Read - Read a bit of the file /*{{{*/
2016 // ---------------------------------------------------------------------
2017 /* We are careful to handle interruption by a signal while reading
2019 bool FileFd::Read(void *To
,unsigned long long Size
,unsigned long long *Actual
)
2027 *((char *)To
) = '\0';
2028 while (Res
> 0 && Size
> 0)
2030 Res
= d
->InternalRead(To
, Size
);
2036 // trick the while-loop into running again
2041 return d
->InternalReadError();
2044 To
= (char *)To
+ Res
;
2047 d
->set_seekpos(d
->get_seekpos() + Res
);
2062 return FileFdError(_("read, still have %llu to read but none left"), Size
);
2065 // FileFd::ReadLine - Read a complete line from the file /*{{{*/
2066 // ---------------------------------------------------------------------
2067 /* Beware: This method can be quite slow for big buffers on UNcompressed
2068 files because of the naive implementation! */
2069 char* FileFd::ReadLine(char *To
, unsigned long long const Size
)
2074 return d
->InternalReadLine(To
, Size
);
2077 // FileFd::Flush - Flush the file /*{{{*/
2078 bool FileFd::Flush()
2083 return d
->InternalFlush();
2086 // FileFd::Write - Write to the file /*{{{*/
2087 bool FileFd::Write(const void *From
,unsigned long long Size
)
2093 while (Res
> 0 && Size
> 0)
2095 Res
= d
->InternalWrite(From
, Size
);
2096 if (Res
< 0 && errno
== EINTR
)
2099 return d
->InternalWriteError();
2101 From
= (char const *)From
+ Res
;
2104 d
->set_seekpos(d
->get_seekpos() + Res
);
2110 return FileFdError(_("write, still have %llu to write but couldn't"), Size
);
2112 bool FileFd::Write(int Fd
, const void *From
, unsigned long long Size
)
2116 while (Res
> 0 && Size
> 0)
2118 Res
= write(Fd
,From
,Size
);
2119 if (Res
< 0 && errno
== EINTR
)
2122 return _error
->Errno("write",_("Write error"));
2124 From
= (char const *)From
+ Res
;
2131 return _error
->Error(_("write, still have %llu to write but couldn't"), Size
);
2134 // FileFd::Seek - Seek in the file /*{{{*/
2135 bool FileFd::Seek(unsigned long long To
)
2140 return d
->InternalSeek(To
);
2143 // FileFd::Skip - Skip over data in the file /*{{{*/
2144 bool FileFd::Skip(unsigned long long Over
)
2148 return d
->InternalSkip(Over
);
2151 // FileFd::Truncate - Truncate the file /*{{{*/
2152 bool FileFd::Truncate(unsigned long long To
)
2156 // truncating /dev/null is always successful - as we get an error otherwise
2157 if (To
== 0 && FileName
== "/dev/null")
2159 return d
->InternalTruncate(To
);
2162 // FileFd::Tell - Current seek position /*{{{*/
2163 // ---------------------------------------------------------------------
2165 unsigned long long FileFd::Tell()
2169 off_t
const Res
= d
->InternalTell();
2170 if (Res
== (off_t
)-1)
2171 FileFdErrno("lseek","Failed to determine the current file position");
2172 d
->set_seekpos(Res
);
2176 static bool StatFileFd(char const * const msg
, int const iFd
, std::string
const &FileName
, struct stat
&Buf
, FileFdPrivate
* const d
) /*{{{*/
2178 bool ispipe
= (d
!= NULL
&& d
->get_is_pipe() == true);
2179 if (ispipe
== false)
2181 if (fstat(iFd
,&Buf
) != 0)
2182 // higher-level code will generate more meaningful messages,
2183 // even translated this would be meaningless for users
2184 return _error
->Errno("fstat", "Unable to determine %s for fd %i", msg
, iFd
);
2185 if (FileName
.empty() == false)
2186 ispipe
= S_ISFIFO(Buf
.st_mode
);
2189 // for compressor pipes st_size is undefined and at 'best' zero
2192 // we set it here, too, as we get the info here for free
2193 // in theory the Open-methods should take care of it already
2195 d
->set_is_pipe(true);
2196 if (stat(FileName
.c_str(), &Buf
) != 0)
2197 return _error
->Errno("fstat", "Unable to determine %s for file %s", msg
, FileName
.c_str());
2202 // FileFd::FileSize - Return the size of the file /*{{{*/
2203 unsigned long long FileFd::FileSize()
2206 if (StatFileFd("file size", iFd
, FileName
, Buf
, d
) == false)
2214 // FileFd::ModificationTime - Return the time of last touch /*{{{*/
2215 time_t FileFd::ModificationTime()
2218 if (StatFileFd("modification time", iFd
, FileName
, Buf
, d
) == false)
2223 return Buf
.st_mtime
;
2226 // FileFd::Size - Return the size of the content in the file /*{{{*/
2227 unsigned long long FileFd::Size()
2231 return d
->InternalSize();
2234 // FileFd::Close - Close the file if the close flag is set /*{{{*/
2235 // ---------------------------------------------------------------------
2237 bool FileFd::Close()
2239 if (Flush() == false)
2245 if ((Flags
& AutoClose
) == AutoClose
)
2247 if ((Flags
& Compressed
) != Compressed
&& iFd
> 0 && close(iFd
) != 0)
2248 Res
&= _error
->Errno("close",_("Problem closing the file %s"), FileName
.c_str());
2253 Res
&= d
->InternalClose(FileName
);
2258 if ((Flags
& Replace
) == Replace
) {
2259 if (rename(TemporaryFileName
.c_str(), FileName
.c_str()) != 0)
2260 Res
&= _error
->Errno("rename",_("Problem renaming the file %s to %s"), TemporaryFileName
.c_str(), FileName
.c_str());
2262 FileName
= TemporaryFileName
; // for the unlink() below.
2263 TemporaryFileName
.clear();
2268 if ((Flags
& Fail
) == Fail
&& (Flags
& DelOnFail
) == DelOnFail
&&
2269 FileName
.empty() == false)
2270 Res
&= RemoveFile("FileFd::Close", FileName
);
2277 // FileFd::Sync - Sync the file /*{{{*/
2278 // ---------------------------------------------------------------------
2282 if (fsync(iFd
) != 0)
2283 return FileFdErrno("sync",_("Problem syncing the file"));
2287 // FileFd::FileFdErrno - set Fail and call _error->Errno *{{{*/
2288 bool FileFd::FileFdErrno(const char *Function
, const char *Description
,...)
2292 size_t msgSize
= 400;
2293 int const errsv
= errno
;
2296 va_start(args
,Description
);
2297 if (_error
->InsertErrno(GlobalError::ERROR
, Function
, Description
, args
, errsv
, msgSize
) == false)
2304 // FileFd::FileFdError - set Fail and call _error->Error *{{{*/
2305 bool FileFd::FileFdError(const char *Description
,...) {
2308 size_t msgSize
= 400;
2311 va_start(args
,Description
);
2312 if (_error
->Insert(GlobalError::ERROR
, Description
, args
, msgSize
) == false)
2319 gzFile
FileFd::gzFd() { /*{{{*/
2321 GzipFileFdPrivate
* const gzipd
= dynamic_cast<GzipFileFdPrivate
*>(d
);
2322 if (gzipd
== nullptr)
2332 // Glob - wrapper around "glob()" /*{{{*/
2333 std::vector
<std::string
> Glob(std::string
const &pattern
, int flags
)
2335 std::vector
<std::string
> result
;
2340 glob_res
= glob(pattern
.c_str(), flags
, NULL
, &globbuf
);
2344 if(glob_res
!= GLOB_NOMATCH
) {
2345 _error
->Errno("glob", "Problem with glob");
2351 for(i
=0;i
<globbuf
.gl_pathc
;i
++)
2352 result
.push_back(string(globbuf
.gl_pathv
[i
]));
2358 std::string
GetTempDir() /*{{{*/
2360 const char *tmpdir
= getenv("TMPDIR");
2368 if (!tmpdir
|| strlen(tmpdir
) == 0 || // tmpdir is set
2369 stat(tmpdir
, &st
) != 0 || (st
.st_mode
& S_IFDIR
) == 0) // exists and is directory
2371 else if (geteuid() != 0 && // root can do everything anyway
2372 faccessat(-1, tmpdir
, R_OK
| W_OK
| X_OK
, AT_EACCESS
| AT_SYMLINK_NOFOLLOW
) != 0) // current user has rwx access to directory
2375 return string(tmpdir
);
2377 std::string
GetTempDir(std::string
const &User
)
2379 // no need/possibility to drop privs
2380 if(getuid() != 0 || User
.empty() || User
== "root")
2381 return GetTempDir();
2383 struct passwd
const * const pw
= getpwnam(User
.c_str());
2385 return GetTempDir();
2387 gid_t
const old_euid
= geteuid();
2388 gid_t
const old_egid
= getegid();
2389 if (setegid(pw
->pw_gid
) != 0)
2390 _error
->Errno("setegid", "setegid %u failed", pw
->pw_gid
);
2391 if (seteuid(pw
->pw_uid
) != 0)
2392 _error
->Errno("seteuid", "seteuid %u failed", pw
->pw_uid
);
2394 std::string
const tmp
= GetTempDir();
2396 if (seteuid(old_euid
) != 0)
2397 _error
->Errno("seteuid", "seteuid %u failed", old_euid
);
2398 if (setegid(old_egid
) != 0)
2399 _error
->Errno("setegid", "setegid %u failed", old_egid
);
2404 FileFd
* GetTempFile(std::string
const &Prefix
, bool ImmediateUnlink
, FileFd
* const TmpFd
) /*{{{*/
2407 FileFd
* const Fd
= TmpFd
== NULL
? new FileFd() : TmpFd
;
2409 std::string
const tempdir
= GetTempDir();
2410 snprintf(fn
, sizeof(fn
), "%s/%s.XXXXXX",
2411 tempdir
.c_str(), Prefix
.c_str());
2412 int const fd
= mkstemp(fn
);
2417 _error
->Errno("GetTempFile",_("Unable to mkstemp %s"), fn
);
2420 if (!Fd
->OpenDescriptor(fd
, FileFd::ReadWrite
, FileFd::None
, true))
2422 _error
->Errno("GetTempFile",_("Unable to write to %s"),fn
);
2428 bool Rename(std::string From
, std::string To
) /*{{{*/
2430 if (rename(From
.c_str(),To
.c_str()) != 0)
2432 _error
->Error(_("rename failed, %s (%s -> %s)."),strerror(errno
),
2433 From
.c_str(),To
.c_str());
2439 bool Popen(const char* Args
[], FileFd
&Fd
, pid_t
&Child
, FileFd::OpenMode Mode
)/*{{{*/
2442 if (Mode
!= FileFd::ReadOnly
&& Mode
!= FileFd::WriteOnly
)
2443 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2445 int Pipe
[2] = {-1, -1};
2447 return _error
->Errno("pipe", _("Failed to create subprocess IPC"));
2449 std::set
<int> keep_fds
;
2450 keep_fds
.insert(Pipe
[0]);
2451 keep_fds
.insert(Pipe
[1]);
2452 Child
= ExecFork(keep_fds
);
2454 return _error
->Errno("fork", "Failed to fork");
2457 if(Mode
== FileFd::ReadOnly
)
2462 else if(Mode
== FileFd::WriteOnly
)
2468 if(Mode
== FileFd::ReadOnly
)
2472 } else if(Mode
== FileFd::WriteOnly
)
2475 execv(Args
[0], (char**)Args
);
2478 if(Mode
== FileFd::ReadOnly
)
2483 else if(Mode
== FileFd::WriteOnly
)
2489 return _error
->Error("Popen supports ReadOnly (x)or WriteOnly mode only");
2490 Fd
.OpenDescriptor(fd
, Mode
, FileFd::None
, true);
2495 bool DropPrivileges() /*{{{*/
2497 if(_config
->FindB("Debug::NoDropPrivs", false) == true)
2501 #if defined(PR_SET_NO_NEW_PRIVS) && ( PR_SET_NO_NEW_PRIVS != 38 )
2502 #error "PR_SET_NO_NEW_PRIVS is defined, but with a different value than expected!"
2504 // see prctl(2), needs linux3.5 at runtime - magic constant to avoid it at buildtime
2505 int ret
= prctl(38, 1, 0, 0, 0);
2506 // ignore EINVAL - kernel is too old to understand the option
2507 if(ret
< 0 && errno
!= EINVAL
)
2508 _error
->Warning("PR_SET_NO_NEW_PRIVS failed with %i", ret
);
2511 // empty setting disables privilege dropping - this also ensures
2512 // backward compatibility, see bug #764506
2513 const std::string toUser
= _config
->Find("APT::Sandbox::User");
2514 if (toUser
.empty() || toUser
== "root")
2517 // a lot can go wrong trying to drop privileges completely,
2518 // so ideally we would like to verify that we have done it –
2519 // but the verify asks for too much in case of fakeroot (and alike)
2520 // [Specific checks can be overridden with dedicated options]
2521 bool const VerifySandboxing
= _config
->FindB("APT::Sandbox::Verify", false);
2523 // uid will be 0 in the end, but gid might be different anyway
2524 uid_t
const old_uid
= getuid();
2525 gid_t
const old_gid
= getgid();
2530 struct passwd
*pw
= getpwnam(toUser
.c_str());
2532 return _error
->Error("No user %s, can not drop rights", toUser
.c_str());
2534 // Do not change the order here, it might break things
2535 // Get rid of all our supplementary groups first
2536 if (setgroups(1, &pw
->pw_gid
))
2537 return _error
->Errno("setgroups", "Failed to setgroups");
2539 // Now change the group ids to the new user
2540 #ifdef HAVE_SETRESGID
2541 if (setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) != 0)
2542 return _error
->Errno("setresgid", "Failed to set new group ids");
2544 if (setegid(pw
->pw_gid
) != 0)
2545 return _error
->Errno("setegid", "Failed to setegid");
2547 if (setgid(pw
->pw_gid
) != 0)
2548 return _error
->Errno("setgid", "Failed to setgid");
2551 // Change the user ids to the new user
2552 #ifdef HAVE_SETRESUID
2553 if (setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
) != 0)
2554 return _error
->Errno("setresuid", "Failed to set new user ids");
2556 if (setuid(pw
->pw_uid
) != 0)
2557 return _error
->Errno("setuid", "Failed to setuid");
2558 if (seteuid(pw
->pw_uid
) != 0)
2559 return _error
->Errno("seteuid", "Failed to seteuid");
2562 // disabled by default as fakeroot doesn't implement getgroups currently (#806521)
2563 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Groups", false) == true)
2565 // Verify that the user isn't still in any supplementary groups
2566 long const ngroups_max
= sysconf(_SC_NGROUPS_MAX
);
2567 std::unique_ptr
<gid_t
[]> gidlist(new gid_t
[ngroups_max
]);
2568 if (unlikely(gidlist
== NULL
))
2569 return _error
->Error("Allocation of a list of size %lu for getgroups failed", ngroups_max
);
2571 if ((gidlist_nr
= getgroups(ngroups_max
, gidlist
.get())) < 0)
2572 return _error
->Errno("getgroups", "Could not get new groups (%lu)", ngroups_max
);
2573 for (ssize_t i
= 0; i
< gidlist_nr
; ++i
)
2574 if (gidlist
[i
] != pw
->pw_gid
)
2575 return _error
->Error("Could not switch group, user %s is still in group %d", toUser
.c_str(), gidlist
[i
]);
2578 // enabled by default as all fakeroot-lookalikes should fake that accordingly
2579 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::IDs", true) == true)
2581 // Verify that gid, egid, uid, and euid changed
2582 if (getgid() != pw
->pw_gid
)
2583 return _error
->Error("Could not switch group");
2584 if (getegid() != pw
->pw_gid
)
2585 return _error
->Error("Could not switch effective group");
2586 if (getuid() != pw
->pw_uid
)
2587 return _error
->Error("Could not switch user");
2588 if (geteuid() != pw
->pw_uid
)
2589 return _error
->Error("Could not switch effective user");
2591 #ifdef HAVE_GETRESUID
2592 // verify that the saved set-user-id was changed as well
2596 if (getresuid(&ruid
, &euid
, &suid
))
2597 return _error
->Errno("getresuid", "Could not get saved set-user-ID");
2598 if (suid
!= pw
->pw_uid
)
2599 return _error
->Error("Could not switch saved set-user-ID");
2602 #ifdef HAVE_GETRESGID
2603 // verify that the saved set-group-id was changed as well
2607 if (getresgid(&rgid
, &egid
, &sgid
))
2608 return _error
->Errno("getresuid", "Could not get saved set-group-ID");
2609 if (sgid
!= pw
->pw_gid
)
2610 return _error
->Error("Could not switch saved set-group-ID");
2614 // disabled as fakeroot doesn't forbid (by design) (re)gaining root from unprivileged
2615 if (VerifySandboxing
== true || _config
->FindB("APT::Sandbox::Verify::Regain", false) == true)
2617 // Check that uid and gid changes do not work anymore
2618 if (pw
->pw_gid
!= old_gid
&& (setgid(old_gid
) != -1 || setegid(old_gid
) != -1))
2619 return _error
->Error("Could restore a gid to root, privilege dropping did not work");
2621 if (pw
->pw_uid
!= old_uid
&& (setuid(old_uid
) != -1 || seteuid(old_uid
) != -1))
2622 return _error
->Error("Could restore a uid to root, privilege dropping did not work");