content/browser/safe_util_win.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_COMMON_SAFE_UTIL_WIN_H_
   6 #define CONTENT_COMMON_SAFE_UTIL_WIN_H_
   7
   8 #include <string>
   9 #include <windows.h>
  10
  11 class GURL;
  12
  13 namespace base {
  14 class FilePath;
  15 }
  16
  17 namespace content {
  18
  19 // Open or run a downloaded file via the Windows shell, possibly showing first
  20 // a consent dialog if the the file is deemed dangerous. This function is an
  21 // enhancement over the OpenItemViaShell() function of win_util.h.
  22 //
  23 // The user consent dialog will be shown or not according to the windows
  24 // execution policy defined in the registry which can be overridden per user.
  25 // The mechanics of the policy are explained in the Microsoft Knowledge base
  26 // number 883260: http://support.microsoft.com/kb/883260
  27 //
  28 // The 'hwnd' is the handle to the parent window. In case a dialog is displayed
  29 // the parent window will be disabled since the dialog is meant to be modal.
  30 // The 'window_title' is the text displayed on the title bar of the dialog. If
  31 // you pass an empty string the dialog will have a generic 'windows security'
  32 // name on the title bar.
  33 //
  34 // You must provide a valid 'full_path' to the file to be opened and a well
  35 // formed url in 'source_url'. The url should identify the source of the file
  36 // but does not have to be network-reachable. If the url is malformed a
  37 // dialog will be shown telling the user that the file will be blocked.
  38 //
  39 // In the event that there is no default application registered for the file
  40 // specified by 'full_path' it ask the user, via the Windows "Open With"
  41 // dialog.
  42 // Returns 'true' on successful open, 'false' otherwise.
  43 bool SaferOpenItemViaShell(HWND hwnd, const std::wstring& window_title,
  44                            const base::FilePath& full_path,
  45                            const std::wstring& source_url);
  46
  47 // Invokes IAttachmentExecute::Save to validate the downloaded file. The call
  48 // may scan the file for viruses and if necessary, annotate it with evidence. As
  49 // a result of the validation, the file may be deleted.  See:
  50 // http://msdn.microsoft.com/en-us/bb776299
  51 //
  52 // If Attachment Execution Services is unavailable, then this function will
  53 // attempt to manually annotate the file with security zone information. A
  54 // failure code will be returned in this case even if the file is sucessfully
  55 // annotated.
  56 //
  57 // IAE::Save() will delete the file if it was found to be blocked by local
  58 // security policy or if it was found to be infected. The call may also delete
  59 // the file due to other failures (http://crbug.com/153212). A failure code will
  60 // be returned in these cases.
  61 //
  62 // Typical return values:
  63 //   S_OK   : The file was okay. If any viruses were found, they were cleaned.
  64 //   E_FAIL : Virus infected.
  65 //   INET_E_SECURITY_PROBLEM : The file was blocked due to security policy.
  66 //
  67 // Any other return value indicates an unexpected error during the scan.
  68 //
  69 // |full_path| : is the path to the downloaded file. This should be the final
  70 //               path of the download.
  71 // |source_url|: the source URL for the download.
  72 HRESULT ScanAndSaveDownloadedFile(const base::FilePath& full_path,
  73                                   const GURL& source_url);
  74 }  // namespace content
  75
  76 #endif  // CONTENT_COMMON_SAFE_UTIL_WIN_H_