third_party/WebKit/public/platform/WebCryptoKey.h

   1 /*
   2  * Copyright (C) 2013 Google 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebCryptoKey_h
  32 #define WebCryptoKey_h
  33
  34 #include "WebCommon.h"
  35 #include "WebPrivatePtr.h"
  36
  37 namespace blink {
  38
  39 enum WebCryptoKeyType {
  40     WebCryptoKeyTypeSecret,
  41     WebCryptoKeyTypePublic,
  42     WebCryptoKeyTypePrivate,
  43 };
  44
  45 enum WebCryptoKeyUsage {
  46     WebCryptoKeyUsageEncrypt = 1 << 0,
  47     WebCryptoKeyUsageDecrypt = 1 << 1,
  48     WebCryptoKeyUsageSign = 1 << 2,
  49     WebCryptoKeyUsageVerify = 1 << 3,
  50     WebCryptoKeyUsageDeriveKey = 1 << 4,
  51     WebCryptoKeyUsageWrapKey = 1 << 5,
  52     WebCryptoKeyUsageUnwrapKey = 1 << 6,
  53     WebCryptoKeyUsageDeriveBits = 1 << 7,
  54 #if INSIDE_BLINK
  55     EndOfWebCryptoKeyUsage,
  56 #endif
  57 };
  58
  59 // A bitfield of WebCryptoKeyUsage
  60 typedef int WebCryptoKeyUsageMask;
  61
  62 enum WebCryptoKeyFormat {
  63     WebCryptoKeyFormatRaw,
  64     WebCryptoKeyFormatPkcs8,
  65     WebCryptoKeyFormatSpki,
  66     WebCryptoKeyFormatJwk,
  67 };
  68
  69 class WebCryptoKeyAlgorithm;
  70 class WebCryptoKeyPrivate;
  71 class WebCryptoKeyHandle;
  72
  73 // The WebCryptoKey represents a key from the Web Crypto API:
  74 //
  75 // https://dvcs.w3.org/hg/webcrypto-api/raw-file/tip/spec/Overview.html#key-interface
  76 //
  77 // WebCryptoKey is just a reference-counted wrapper that manages the lifetime of
  78 // a "WebCryptoKeyHandle*".
  79 //
  80 // WebCryptoKey is:
  81 //   * Copiable (cheaply)
  82 //   * Threadsafe if the embedder's WebCryptoKeyHandle is also threadsafe.
  83 //
  84 // The embedder is responsible for creating all WebCryptoKeys, and therefore can
  85 // safely assume any details regarding the type of the wrapped
  86 // WebCryptoKeyHandle*.
  87 //
  88 // If WebCryptoKey "isNull()" then it is invalid to call any of the other
  89 // methods on it (other than destruction, assignment, or isNull()).
  90 class WebCryptoKey {
  91 public:
  92     // Constructs a "null" key (One for which isNull() returns true).
  93     WebCryptoKey() { }
  94     ~WebCryptoKey() { reset(); }
  95
  96     WebCryptoKey(const WebCryptoKey& other) { assign(other); }
  97     WebCryptoKey& operator=(const WebCryptoKey& other)
  98     {
  99         assign(other);
 100         return *this;
 101     }
 102
 103     // For an explanation of these parameters see:
 104     // https://dvcs.w3.org/hg/webcrypto-api/raw-file/tip/spec/Overview.html#key-interface-members
 105     //
 106     // Note that the caller is passing ownership of the WebCryptoKeyHandle*.
 107     BLINK_PLATFORM_EXPORT static WebCryptoKey create(WebCryptoKeyHandle*, WebCryptoKeyType, bool extractable, const WebCryptoKeyAlgorithm&, WebCryptoKeyUsageMask);
 108
 109     BLINK_PLATFORM_EXPORT static WebCryptoKey createNull();
 110
 111     // Returns the opaque key handle that was set by the embedder.
 112     //   * Safe to downcast to known type (since embedder creates all the keys)
 113     //   * Returned pointer's lifetime is bound to |this|
 114     BLINK_PLATFORM_EXPORT WebCryptoKeyHandle* handle() const;
 115
 116     BLINK_PLATFORM_EXPORT WebCryptoKeyType type() const;
 117     BLINK_PLATFORM_EXPORT bool extractable() const;
 118     BLINK_PLATFORM_EXPORT const WebCryptoKeyAlgorithm& algorithm() const;
 119     BLINK_PLATFORM_EXPORT WebCryptoKeyUsageMask usages() const;
 120
 121     BLINK_PLATFORM_EXPORT bool isNull() const;
 122
 123     BLINK_PLATFORM_EXPORT bool keyUsageAllows(const blink::WebCryptoKeyUsage) const;
 124
 125 private:
 126     BLINK_PLATFORM_EXPORT void assign(const WebCryptoKey& other);
 127     BLINK_PLATFORM_EXPORT void reset();
 128
 129     WebPrivatePtr<WebCryptoKeyPrivate> m_private;
 130 };
 131
 132 // Base class for the embedder to define its own opaque key handle. The lifetime
 133 // of this object is controlled by WebCryptoKey using reference counting.
 134 class WebCryptoKeyHandle {
 135 public:
 136     virtual ~WebCryptoKeyHandle() { }
 137 };
 138
 139 } // namespace blink
 140
 141 #endif