Source/WebKit2/Shared/SandboxExtension.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef SandboxExtension_h
  27 #define SandboxExtension_h
  28
  29 #include <wtf/Forward.h>
  30 #include <wtf/Noncopyable.h>
  31 #include <wtf/PassRefPtr.h>
  32 #include <wtf/RefCounted.h>
  33 #include <wtf/text/WTFString.h>
  34
  35 #if ENABLE(WEB_PROCESS_SANDBOX)
  36 typedef struct __WKSandboxExtension* WKSandboxExtensionRef;
  37 #endif
  38
  39 namespace CoreIPC {
  40     class ArgumentEncoder;
  41     class ArgumentDecoder;
  42 }
  43
  44 namespace WebKit {
  45
  46 class SandboxExtension : public RefCounted<SandboxExtension> {
  47 public:
  48     enum Type {
  49         ReadOnly,
  50         WriteOnly,
  51         ReadWrite,
  52     };
  53
  54     class Handle {
  55         WTF_MAKE_NONCOPYABLE(Handle);
  56
  57     public:
  58         Handle();
  59         ~Handle();
  60
  61         void encode(CoreIPC::ArgumentEncoder*) const;
  62         static bool decode(CoreIPC::ArgumentDecoder*, Handle&);
  63
  64     private:
  65         friend class SandboxExtension;
  66 #if ENABLE(WEB_PROCESS_SANDBOX)
  67         mutable WKSandboxExtensionRef m_sandboxExtension;
  68 #endif
  69     };
  70
  71     class HandleArray {
  72         WTF_MAKE_NONCOPYABLE(HandleArray);
  73
  74     public:
  75         HandleArray();
  76         ~HandleArray();
  77         void allocate(size_t);
  78         Handle& operator[](size_t i);
  79         const Handle& operator[](size_t i) const;
  80         size_t size() const;
  81         void encode(CoreIPC::ArgumentEncoder*) const;
  82         static bool decode(CoreIPC::ArgumentDecoder*, HandleArray&);
  83
  84     private:
  85 #if ENABLE(WEB_PROCESS_SANDBOX)
  86         Handle* m_data;
  87 #else
  88         Handle m_emptyHandle;
  89 #endif
  90         size_t m_size;
  91     };
  92
  93     static PassRefPtr<SandboxExtension> create(const Handle&);
  94     static void createHandle(const String& path, Type type, Handle&);
  95     static String createHandleForTemporaryFile(const String& prefix, Type type, Handle&);
  96     ~SandboxExtension();
  97
  98     bool invalidate();
  99     bool consume();
 100     bool consumePermanently();
 101
 102 private:
 103     explicit SandboxExtension(const Handle&);
 104
 105 #if ENABLE(WEB_PROCESS_SANDBOX)
 106     mutable WKSandboxExtensionRef m_sandboxExtension;
 107 #endif
 108 };
 109
 110
 111 #if !ENABLE(WEB_PROCESS_SANDBOX)
 112 inline SandboxExtension::Handle::Handle() { }
 113 inline SandboxExtension::Handle::~Handle() { }
 114 inline void SandboxExtension::Handle::encode(CoreIPC::ArgumentEncoder*) const { }
 115 inline bool SandboxExtension::Handle::decode(CoreIPC::ArgumentDecoder*, Handle&) { return true; }
 116 inline SandboxExtension::HandleArray::HandleArray() { }
 117 inline SandboxExtension::HandleArray::~HandleArray() { }
 118 inline void SandboxExtension::HandleArray::allocate(size_t) { }
 119 inline size_t SandboxExtension::HandleArray::size() const { return 0; }
 120 inline const SandboxExtension::Handle& SandboxExtension::HandleArray::operator[](size_t) const { return m_emptyHandle; }
 121 inline SandboxExtension::Handle& SandboxExtension::HandleArray::operator[](size_t) { return m_emptyHandle; }
 122 inline void SandboxExtension::HandleArray::encode(CoreIPC::ArgumentEncoder*) const { }
 123 inline bool SandboxExtension::HandleArray::decode(CoreIPC::ArgumentDecoder*, HandleArray&) { return true; }
 124 inline PassRefPtr<SandboxExtension> SandboxExtension::create(const Handle&) { return 0; }
 125 inline void SandboxExtension::createHandle(const String& path, Type type, Handle&) { }
 126 inline String SandboxExtension::createHandleForTemporaryFile(const String& prefix, Type type, Handle&) {return String();}
 127 inline SandboxExtension::~SandboxExtension() { }
 128 inline bool SandboxExtension::invalidate() { return true; }
 129 inline bool SandboxExtension::consume() { return true; }
 130 inline bool SandboxExtension::consumePermanently() { return true; }
 131 #endif
 132
 133 } // namespace WebKit
 134
 135
 136 #endif // SandboxExtension_h