chrome/common/extensions/permissions/socket_permission.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 CHROME_COMMON_EXTENSIONS_PERMISSIONS_SOCKET_PERMISSION_H_
   6 #define CHROME_COMMON_EXTENSIONS_PERMISSIONS_SOCKET_PERMISSION_H_
   7
   8 #include <set>
   9 #include <string>
  10
  11 #include "chrome/common/extensions/permissions/api_permission.h"
  12 #include "chrome/common/extensions/permissions/socket_permission_data.h"
  13
  14 namespace base {
  15 class Value;
  16 }
  17
  18 namespace IPC {
  19 class Message;
  20 }
  21
  22 namespace extensions {
  23
  24 // There's room to share code with related classes, see http://crbug.com/147531
  25
  26 class SocketPermission : public APIPermission {
  27  public:
  28   struct CheckParam : APIPermission::CheckParam {
  29     CheckParam(content::SocketPermissionRequest::OperationType type,
  30         const std::string& host,
  31         int port)
  32       : request(type, host, port) { }
  33     content::SocketPermissionRequest request;
  34   };
  35
  36   explicit SocketPermission(const APIPermissionInfo* info);
  37
  38   virtual ~SocketPermission();
  39
  40   // Returns true if this permission has PermissionMessages.
  41   virtual bool HasMessages() const OVERRIDE;
  42
  43   // Returns the localized permission messages of this permission.
  44   virtual PermissionMessages GetMessages() const OVERRIDE;
  45
  46   // Returns true if the given permission in param is allowed.
  47   virtual bool Check(
  48       const APIPermission::CheckParam* param) const OVERRIDE;
  49
  50   // Returns true if |rhs| is a subset of this.
  51   virtual bool Contains(const APIPermission* rhs) const OVERRIDE;
  52
  53   // Returns true if |rhs| is equal to this.
  54   virtual bool Equal(const APIPermission* rhs) const OVERRIDE;
  55
  56   // Parses the rhs from |value|. Returns false if error happens.
  57   virtual bool FromValue(const base::Value* value) OVERRIDE;
  58
  59   // Stores this into a new created |value|.
  60   virtual void ToValue(base::Value** value) const OVERRIDE;
  61
  62   // Clones this.
  63   virtual APIPermission* Clone() const OVERRIDE;
  64
  65   // Returns a new API permission rhs which equals this - |rhs|.
  66   virtual APIPermission* Diff(const APIPermission* rhs) const OVERRIDE;
  67
  68   // Returns a new API permission rhs which equals the union of this and
  69   // |rhs|.
  70   virtual APIPermission* Union(const APIPermission* rhs) const OVERRIDE;
  71
  72   // Returns a new API permission rhs which equals the intersect of this and
  73   // |rhs|.
  74   virtual APIPermission* Intersect(const APIPermission* rhs) const OVERRIDE;
  75
  76   // IPC functions
  77   // Writes this into the given IPC message |m|.
  78   virtual void Write(IPC::Message* m) const OVERRIDE;
  79
  80   // Reads from the given IPC message |m|.
  81   virtual bool Read(const IPC::Message* m, PickleIterator* iter) OVERRIDE;
  82
  83   // Logs this rhs.
  84   virtual void Log(std::string* log) const OVERRIDE;
  85
  86  private:
  87   bool AddAnyHostMessage(PermissionMessages& messages) const;
  88   void AddSubdomainHostMessage(PermissionMessages& messages) const;
  89   void AddSpecificHostMessage(PermissionMessages& messages) const;
  90
  91   std::set<SocketPermissionData> data_set_;
  92 };
  93
  94 }  // namespace extensions
  95
  96 #endif  // CHROME_COMMON_EXTENSIONS_PERMISSIONS_SOCKET_PERMISSION_H_