X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/f1828b6977972b4ef6da6401602b7938f6570c32..e6645b9fb9ba3a7ff7b6663af3f5e1bcb6f23d78:/apt-pkg/contrib/gpgv.h diff --git a/apt-pkg/contrib/gpgv.h b/apt-pkg/contrib/gpgv.h index ab7d35ab1..45f069058 100644 --- a/apt-pkg/contrib/gpgv.h +++ b/apt-pkg/contrib/gpgv.h @@ -23,9 +23,18 @@ /** \brief generates and run the command to verify a file with gpgv * * If File and FileSig specify the same file it is assumed that we - * deal with a clear-signed message. In that case the file will be - * rewritten to be in a good-known format without uneeded whitespaces - * and additional messages (unsigned or signed). + * deal with a clear-signed message. Note that the method will accept + * and validate files which include additional (unsigned) messages + * without complaining. Do NOT open files accepted by this method + * for reading. Use #OpenMaybeClearSignedFile to access the message + * instead to ensure you are only reading signed data. + * + * The method does not return, but has some noteable exit-codes: + * 111 signals an internal error like the inability to execute gpgv, + * 112 indicates a clear-signed file which doesn't include a message, + * which can happen if APT is run while on a network requiring + * authentication before usage (e.g. in hotels) + * All other exit-codes are passed-through from gpgv. * * @param File is the message (unsigned or clear-signed) * @param FileSig is the signature (detached or clear-signed) @@ -48,11 +57,8 @@ inline void ExecGPGV(std::string const &File, std::string const &FileSig, * whitespaces are discarded. The resulting files are suitable to * be checked with gpgv. * - * If one or all Fds are -1 they will not be used and the content - * which would have been written to them is discarded. - * - * The code doesn't support dash-encoded lines as these are not - * expected to be present in files we have to deal with. + * If a FileFd pointers is NULL it will not be used and the content + * which would have been written to it is silently discarded. * * The content of the split files is undefined if the splitting was * unsuccessful. @@ -61,27 +67,13 @@ inline void ExecGPGV(std::string const &File, std::string const &FileSig, * not generate an error message. * * @param InFile is the clear-signed file - * @param ContentFile is the Fd the message will be written to + * @param ContentFile is the FileFd the message will be written to * @param ContentHeader is a list of all required Amored Headers for the message - * @param SignatureFile is the Fd all signatures will be written to + * @param SignatureFile is the FileFd all signatures will be written to * @return true if the splitting was successful, false otherwise */ -bool SplitClearSignedFile(std::string const &InFile, int const ContentFile, - std::vector * const ContentHeader, int const SignatureFile); - -/** \brief recombines message and signature to an inline signature - * - * Reverses the splitting down by #SplitClearSignedFile by writing - * a well-formed clear-signed message without unsigned messages, - * additional signed messages or just trailing whitespaces - * - * @param OutFile will be clear-signed file - * @param ContentFile is the Fd the message will be read from - * @param ContentHeader is a list of all required Amored Headers for the message - * @param SignatureFile is the Fd all signatures will be read from - */ -bool RecombineToClearSignedFile(std::string const &OutFile, int const ContentFile, - std::vector const &ContentHeader, int const SignatureFile); +bool SplitClearSignedFile(std::string const &InFile, FileFd * const ContentFile, + std::vector * const ContentHeader, FileFd * const SignatureFile); /** \brief open a file which might be clear-signed *