]> git.saurik.com Git - apt.git/blobdiff - apt-pkg/contrib/gpgv.h
Merge branch 'debian/sid' into debian/experimental
[apt.git] / apt-pkg / contrib / gpgv.h
index 1f877fc2dd0a3e003a0721f12c7dc443eba2fe7c..45f06905831bd86e9494a7e90e77323272f66e90 100644 (file)
 /** \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)
@@ -51,9 +60,6 @@ inline void ExecGPGV(std::string const &File, std::string const &FileSig,
  *  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 code doesn't support dash-encoded lines as these are not
- *  expected to be present in files we have to deal with.
- *
  *  The content of the split files is undefined if the splitting was
  *  unsuccessful.
  *