src/third_party/WebKit/Source/modules/crypto/CryptoResultImpl.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 CryptoResultImpl_h
  32 #define CryptoResultImpl_h
  33
  34 #include "bindings/core/v8/ScriptPromise.h"
  35 #include "core/dom/ExceptionCode.h"
  36 #include "platform/CryptoResult.h"
  37 #include "public/platform/WebCrypto.h"
  38 #include "wtf/Forward.h"
  39 #include "wtf/WeakPtr.h"
  40
  41 namespace blink {
  42
  43 class ScriptPromiseResolver;
  44 ExceptionCode webCryptoErrorToExceptionCode(WebCryptoErrorType);
  45
  46 // Wrapper around a Promise to notify completion of the crypto operation.
  47 //
  48 // The thread on which CryptoResultImpl was created on is referred to as the
  49 // "origin thread".
  50 //
  51 //  * At creation time there must be an active ExecutionContext.
  52 //  * The CryptoResult interface must only be called from the origin thread.
  53 //  * ref(), deref(), cancelled() and cancel() can be called from any thread.
  54 //  * One of the completeWith***() functions must be called, or the
  55 //    m_resolver will be leaked until the ExecutionContext is destroyed.
  56 class CryptoResultImpl final : public CryptoResult {
  57 public:
  58     ~CryptoResultImpl();
  59
  60     static PassRefPtr<CryptoResultImpl> create(ScriptState*);
  61
  62     virtual void completeWithError(WebCryptoErrorType, const WebString&) override;
  63     virtual void completeWithBuffer(const WebArrayBuffer&) override;
  64     virtual void completeWithJson(const char* utf8Data, unsigned length) override;
  65     virtual void completeWithBoolean(bool) override;
  66     virtual void completeWithKey(const WebCryptoKey&) override;
  67     virtual void completeWithKeyPair(const WebCryptoKey& publicKey, const WebCryptoKey& privateKey) override;
  68     virtual bool cancelled() const override;
  69
  70     // If called after completion (including cancellation) will return an empty
  71     // ScriptPromise.
  72     ScriptPromise promise();
  73
  74 private:
  75     class WeakResolver;
  76     explicit CryptoResultImpl(ScriptState*);
  77
  78     void cancel();
  79
  80     WeakPtr<ScriptPromiseResolver> m_resolver;
  81     volatile int m_cancelled;
  82 };
  83
  84 } // namespace blink
  85
  86 #endif