chrome/common/chrome_utility_messages.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 // Multiply-included message file, so no include guard.
   6
   7 #if defined(OS_WIN)
   8 #include <Windows.h>
   9 #endif  // defined(OS_WIN)
  10
  11 #include <string>
  12 #include <vector>
  13
  14 #include "base/files/file_path.h"
  15 #include "base/strings/string16.h"
  16 #include "base/tuple.h"
  17 #include "base/values.h"
  18 #include "chrome/common/safe_browsing/zip_analyzer_results.h"
  19 #include "ipc/ipc_message_macros.h"
  20 #include "ipc/ipc_platform_file.h"
  21 #include "third_party/skia/include/core/SkBitmap.h"
  22 #include "ui/gfx/ipc/gfx_param_traits.h"
  23
  24 #if defined(FULL_SAFE_BROWSING)
  25 #include "chrome/common/safe_browsing/ipc_protobuf_message_macros.h"
  26 #include "chrome/common/safe_browsing/protobuf_message_param_traits.h"
  27 #endif
  28
  29 // Singly-included section for typedefs.
  30 #ifndef CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
  31 #define CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
  32
  33 #if defined(OS_WIN)
  34 // A vector of filters, each being a Tuple containing a display string (i.e.
  35 // "Text Files") and a filter pattern (i.e. "*.txt").
  36 typedef std::vector<base::Tuple<base::string16, base::string16>>
  37     GetOpenFileNameFilter;
  38 #endif  // OS_WIN
  39
  40 #endif  // CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
  41
  42 #define IPC_MESSAGE_START ChromeUtilityMsgStart
  43
  44 #if defined(FULL_SAFE_BROWSING)
  45 IPC_ENUM_TRAITS_VALIDATE(
  46     safe_browsing::ClientDownloadRequest_DownloadType,
  47     safe_browsing::ClientDownloadRequest_DownloadType_IsValid(value))
  48
  49 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(safe_browsing::ClientDownloadRequest_Digests)
  50   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(sha256)
  51   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(sha1)
  52   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(md5)
  53 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  54
  55 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  56     safe_browsing::ClientDownloadRequest_CertificateChain_Element)
  57   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(certificate)
  58 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  59
  60 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  61     safe_browsing::ClientDownloadRequest_CertificateChain)
  62   IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(element)
  63 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  64
  65 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  66     safe_browsing::ClientDownloadRequest_SignatureInfo)
  67   IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(certificate_chain)
  68   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(trusted)
  69   IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(signed_data)
  70 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  71
  72 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  73     safe_browsing::ClientDownloadRequest_PEImageHeaders_DebugData)
  74   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(directory_entry)
  75   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(raw_data)
  76 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  77
  78 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  79     safe_browsing::ClientDownloadRequest_PEImageHeaders)
  80   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(dos_header)
  81   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(file_header)
  82   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(optional_headers32)
  83   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(optional_headers64)
  84   IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(section_header)
  85   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(export_section_data)
  86   IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(debug_data)
  87 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  88
  89 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  90     safe_browsing::ClientDownloadRequest_ImageHeaders)
  91   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(pe_headers)
  92 IPC_PROTOBUF_MESSAGE_TRAITS_END()
  93
  94 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
  95     safe_browsing::ClientDownloadRequest_ArchivedBinary)
  96   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(file_basename)
  97   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(download_type)
  98   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(digests)
  99   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(length)
 100   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(signature)
 101   IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(image_headers)
 102 IPC_PROTOBUF_MESSAGE_TRAITS_END()
 103
 104 IPC_STRUCT_TRAITS_BEGIN(safe_browsing::zip_analyzer::Results)
 105   IPC_STRUCT_TRAITS_MEMBER(success)
 106   IPC_STRUCT_TRAITS_MEMBER(has_executable)
 107   IPC_STRUCT_TRAITS_MEMBER(has_archive)
 108   IPC_STRUCT_TRAITS_MEMBER(archived_binary)
 109 IPC_STRUCT_TRAITS_END()
 110 #endif  // FULL_SAFE_BROWSING
 111
 112 #if defined(OS_WIN)
 113 IPC_STRUCT_BEGIN(ChromeUtilityMsg_GetSaveFileName_Params)
 114   IPC_STRUCT_MEMBER(HWND, owner)
 115   IPC_STRUCT_MEMBER(DWORD, flags)
 116   IPC_STRUCT_MEMBER(GetOpenFileNameFilter, filters)
 117   IPC_STRUCT_MEMBER(int, one_based_filter_index)
 118   IPC_STRUCT_MEMBER(base::FilePath, suggested_filename)
 119   IPC_STRUCT_MEMBER(base::FilePath, initial_directory)
 120   IPC_STRUCT_MEMBER(base::string16, default_extension)
 121 IPC_STRUCT_END()
 122 #endif  // OS_WIN
 123
 124 //------------------------------------------------------------------------------
 125 // Utility process messages:
 126 // These are messages from the browser to the utility process.
 127
 128 // Tell the utility process to parse a JSON string into a Value object.
 129 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_ParseJSON,
 130                      std::string /* JSON to parse */)
 131
 132 // Tell the utility process to decode the given image data.
 133 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_DecodeImage,
 134                      std::vector<unsigned char> /* encoded image contents */,
 135                      bool /* shrink image if needed for IPC msg limit */,
 136                      int /* delegate id */)
 137
 138 #if defined(OS_CHROMEOS)
 139 // Tell the utility process to decode the given JPEG image data with a robust
 140 // libjpeg codec.
 141 IPC_MESSAGE_CONTROL2(ChromeUtilityMsg_RobustJPEGDecodeImage,
 142                      std::vector<unsigned char> /* encoded image contents*/,
 143                      int /* delegate id */)
 144 #endif  // defined(OS_CHROMEOS)
 145
 146 // Tell the utility process to patch the given |input_file| using |patch_file|
 147 // and place the output in |output_file|. The patch should use the bsdiff
 148 // algorithm (Courgette's version).
 149 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_PatchFileBsdiff,
 150                      base::FilePath /* input_file */,
 151                      base::FilePath /* patch_file */,
 152                      base::FilePath /* output_file */)
 153
 154 // Tell the utility process to patch the given |input_file| using |patch_file|
 155 // and place the output in |output_file|. The patch should use the Courgette
 156 // algorithm.
 157 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_PatchFileCourgette,
 158                      base::FilePath /* input_file */,
 159                      base::FilePath /* patch_file */,
 160                      base::FilePath /* output_file */)
 161
 162 #if defined(OS_CHROMEOS)
 163 // Tell the utility process to create a zip file on the given list of files.
 164 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_CreateZipFile,
 165                      base::FilePath /* src_dir */,
 166                      std::vector<base::FilePath> /* src_relative_paths */,
 167                      base::FileDescriptor /* dest_fd */)
 168 #endif  // defined(OS_CHROMEOS)
 169
 170 // Requests the utility process to respond with a
 171 // ChromeUtilityHostMsg_ProcessStarted message once it has started.  This may
 172 // be used if the host process needs a handle to the running utility process.
 173 IPC_MESSAGE_CONTROL0(ChromeUtilityMsg_StartupPing)
 174
 175 #if defined(FULL_SAFE_BROWSING)
 176 // Tells the utility process to analyze a zip file for malicious download
 177 // protection, providing a file that can be used temporarily to analyze binaries
 178 // contained therein.
 179 IPC_MESSAGE_CONTROL2(ChromeUtilityMsg_AnalyzeZipFileForDownloadProtection,
 180                      IPC::PlatformFileForTransit /* zip_file */,
 181                      IPC::PlatformFileForTransit /* temp_file */)
 182 #endif
 183
 184 #if defined(OS_WIN)
 185 // Invokes ui::base::win::OpenFileViaShell from the utility process.
 186 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_OpenFileViaShell,
 187                      base::FilePath /* full_path */)
 188
 189 // Invokes ui::base::win::OpenFolderViaShell from the utility process.
 190 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_OpenFolderViaShell,
 191                      base::FilePath /* full_path */)
 192
 193 // Instructs the utility process to invoke GetOpenFileName. |owner| is the
 194 // parent of the modal dialog, |flags| are OFN_* flags. |filter| constrains the
 195 // user's file choices. |initial_directory| and |filename| select the directory
 196 // to be displayed and the file to be initially selected.
 197 //
 198 // Either ChromeUtilityHostMsg_GetOpenFileName_Failed or
 199 // ChromeUtilityHostMsg_GetOpenFileName_Result will be returned when the
 200 // operation completes whether due to error or user action.
 201 IPC_MESSAGE_CONTROL5(ChromeUtilityMsg_GetOpenFileName,
 202                      HWND /* owner */,
 203                      DWORD /* flags */,
 204                      GetOpenFileNameFilter /* filter */,
 205                      base::FilePath /* initial_directory */,
 206                      base::FilePath /* filename */)
 207 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_GetSaveFileName,
 208                      ChromeUtilityMsg_GetSaveFileName_Params /* params */)
 209 #endif  // defined(OS_WIN)
 210
 211 #if defined(OS_ANDROID)
 212 // Instructs the utility process to detect support for seccomp-bpf,
 213 // and the result is reported through
 214 // ChromeUtilityHostMsg_DetectSeccompSupport_Result.
 215 IPC_MESSAGE_CONTROL0(ChromeUtilityMsg_DetectSeccompSupport)
 216 #endif
 217
 218 //------------------------------------------------------------------------------
 219 // Utility process host messages:
 220 // These are messages from the utility process to the browser.
 221
 222 // Reply when the utility process successfully parsed a JSON string.
 223 //
 224 // WARNING: The result can be of any Value subclass type, but we can't easily
 225 // pass indeterminate value types by const object reference with our IPC macros,
 226 // so we put the result Value into a ListValue. Handlers should examine the
 227 // first (and only) element of the ListValue for the actual result.
 228 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_ParseJSON_Succeeded,
 229                      base::ListValue)
 230
 231 // Reply when the utility process failed in parsing a JSON string.
 232 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_ParseJSON_Failed,
 233                      std::string /* error message, if any*/)
 234
 235 // Reply when the utility process has failed while unpacking and parsing a
 236 // web resource.  |error_message| is a user-readable explanation of what
 237 // went wrong.
 238 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_UnpackWebResource_Failed,
 239                      std::string /* error_message, if any */)
 240
 241 // Reply when the utility process has succeeded in decoding the image.
 242 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_DecodeImage_Succeeded,
 243                      SkBitmap /* decoded image */,
 244                      int /* delegate id */)
 245
 246 // Reply when an error occurred decoding the image.
 247 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_DecodeImage_Failed,
 248                      int /* delegate id */)
 249
 250 // Reply when a file has been patched.
 251 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_PatchFile_Finished, int /* result */)
 252
 253 #if defined(OS_CHROMEOS)
 254 // Reply when the utility process has succeeded in creating the zip file.
 255 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_CreateZipFile_Succeeded)
 256
 257 // Reply when an error occured in creating the zip file.
 258 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_CreateZipFile_Failed)
 259 #endif  // defined(OS_CHROMEOS)
 260
 261 // Reply when the utility process has started.
 262 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_ProcessStarted)
 263
 264 #if defined(FULL_SAFE_BROWSING)
 265 // Reply when a zip file has been analyzed for malicious download protection.
 266 IPC_MESSAGE_CONTROL1(
 267     ChromeUtilityHostMsg_AnalyzeZipFileForDownloadProtection_Finished,
 268     safe_browsing::zip_analyzer::Results)
 269 #endif
 270
 271 #if defined(OS_WIN)
 272 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_GetOpenFileName_Failed)
 273 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_GetOpenFileName_Result,
 274                      base::FilePath /* directory */,
 275                      std::vector<base::FilePath> /* filenames */)
 276 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_GetSaveFileName_Failed)
 277 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_GetSaveFileName_Result,
 278                      base::FilePath /* path */,
 279                      int /* one_based_filter_index  */)
 280 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_BuildDirectWriteFontCache,
 281                      base::FilePath /* cache file path */)
 282 #endif  // defined(OS_WIN)
 283
 284 #if defined(OS_ANDROID)
 285 // Reply to ChromeUtilityMsg_DetectSeccompSupport to report the level
 286 // of kernel support for seccomp-bpf.
 287 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_DetectSeccompSupport_ResultPrctl,
 288                      bool /* seccomp prctl supported */)
 289 #endif