WebCrypto: Add interfaces for importKey().

public/platform/WebCrypto.h

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 14 matching lines @@
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef WebCrypto_h
 #define WebCrypto_h
 
 #include "WebCommon.h"
+#include "WebCryptoKey.h"
+#include "WebPrivatePtr.h"
 
 namespace WebKit {
 
 class WebArrayBuffer;
-class WebCryptoAlgorithm;
-class WebCryptoKey;
+class WebCryptoKeyOperation;
+class WebCryptoKeyOperationResult;
 class WebCryptoOperation;
 class WebCryptoOperationResult;
 
 class WebCrypto {
 public:
     // FIXME: Deprecated, delete once chromium side is updated.
     virtual WebCryptoOperation* digest(const WebCryptoAlgorithm&) { return 0; }
 
     // The following methods begin an asynchronous multi-part cryptographic
     // operation.
     //
-    // Let the WebCryptoOperationResult* be called "result".
+    // Let the WebCryptoOperationResult& be called "result".
     //
-    // Implementations can either:
+    // Before returning, implementations can either:
     //
     // * Synchronously fail initialization by calling:
-    //   result->initializationFailed(errorDetails)
+    //   result.initializationFailed(errorDetails)
     //
     // OR
     //
     // * Create a new WebCryptoOperation* and return it by calling:
-    //   result->initializationSucceeded(cryptoOperation)
+    //   result.initializationSucceeded(cryptoOperation)
     //
     // If initialization succeeds, then Blink will subsequently call
     // methods on cryptoOperation:
     //
     //   - cryptoOperation->process() to feed it data
     //   - cryptoOperation->finish() to indicate there is no more data
     //   - cryptoOperation->abort() to cancel.
     //
-    // The embedder may call result->completeWithXXX() at any time while the
-    // cryptoOperation is "in progress". Typically completion is set once
-    // cryptoOperation->finish() is called, however it can also be called
-    // during cryptoOperation->process() (for instance to set an error).
+    // The embedder may call result.completeWithXXX() at any time while the
+    // cryptoOperation is "in progress" (can copy the initial "result" object).
+    // Typically completion is set once cryptoOperation->finish() is called,
+    // however it can also be called during cryptoOperation->process() (for
+    // instance to set an error).
     //
     // The cryptoOperation pointer MUST remain valid while it is "in progress".
     // The cryptoOperation is said to be "in progress" from the time after
     // result->initializationSucceded() has been called, up until either:
     //
     //   - Blink calls cryptoOperation->abort()
     //   OR
-    //   - Embedder calls result->completeWithXXX()
+    //   - Embedder calls result.completeWithXXX()
     //
-    // Once the cryptoOperation is no longer "in progress" the "result" pointer
-    // is no longer valid. At this time the embedder is responsible for freeing
-    // the cryptoOperation.
-    virtual void digest(const WebCryptoAlgorithm&, WebCryptoOperationResult*) { }
+    // Once the cryptoOperation is no longer "in progress" the embedder is
+    // responsible for freeing the cryptoOperation.
+    virtual void digest(const WebCryptoAlgorithm&, WebCryptoOperationResult&) { }
+
+    // The following methods begin an asynchronous single-part key operation.
+    //
+    // Let the WebCryptoKeyOperationResult& be called "result".
+    //
+    // Before returning, implementations can either:
+    //
+    // (a) Synchronously fail initialization by calling:
+    //     result.initializationFailed(errorDetails)
+    //     (this results in throwing a Javascript exception)
+    //
+    // (b) Synchronously complete the request (success or error) by calling:
+    //     result.completeWithXXX()
+    //
+    // (c) Defer completion by calling
+    //     result.initializationSucceeded(keyOperation)
+    //
+    // If asynchronous completion (c) was chosen, then the embedder can notify
+    // completion after returning by calling result.completeWithXXX() (can make
+    // a copy of "result").
+    //
+    // The keyOperation pointer MUST remain valid while it is "in progress".
+    // The keyOperation is said to be "in progress" from the time after
+    // result->initializationSucceded() has been called, up until either:
+    //
+    //   - Blink calls keyOperation->abort()
+    //   OR
+    //   - Embedder calls result.completeWithXXX()
+    //
+    // Once the keyOperation is no longer "in progress" the embedder is
+    // responsible for freeing the cryptoOperation.
+    virtual void importKey(WebCryptoKeyFormat, const unsigned char* keyData, size_t keyDataSize, const WebCryptoAlgorithm&, bool extractable, WebCryptoKeyUsageMask, WebCryptoKeyOperationResult&) { }
 
 protected:
     virtual ~WebCrypto() { }
 };
 
 class WebCryptoOperation {
 public:
     // Feeds data (bytes, size) to the operation.
     //   - |bytes| may be 0 if |size| is 0
     //   - |bytes| is valid only until process() returns
     //   - process() will not be called after abort() or finish()
     virtual void process(const unsigned char*, size_t) = 0;
 
     // Cancels the in-progress operation.
     //   * Implementations should delete |this| after aborting.
     virtual void abort() = 0;
 
     // Indicates that there is no more data to receive.
     virtual void finish() = 0;
 
 protected:
     virtual ~WebCryptoOperation() { }
 };
 
+// Can be implemented by embedder for unit-testing.
+class WebCryptoOperationResultPrivate {
+public:
+    virtual ~WebCryptoOperationResultPrivate() { }
+
+    virtual void initializationFailed() = 0;
+    virtual void initializationSucceeded(WebCryptoOperation*) = 0;
+    virtual void completeWithError() = 0;
+    virtual void completeWithArrayBuffer(const WebArrayBuffer&) = 0;
+
+    virtual void ref() = 0;
+    virtual void deref() = 0;
+};
+
 // FIXME: Add error types.
 class WebCryptoOperationResult {
 public:
-    // Only one of these should be called.
-    virtual void initializationFailed() = 0;
-    virtual void initializationSucceded(WebCryptoOperation*) = 0;
+    explicit WebCryptoOperationResult(WebCryptoOperationResultPrivate* impl)
+    {
+        assign(impl);
+    }
 
-    // Only one of these should be called to set the result.
-    virtual void completeWithError() = 0;
-    virtual void completeWithArrayBuffer(const WebArrayBuffer&) = 0;
+    ~WebCryptoOperationResult() { reset(); }
+
+    WebCryptoOperationResult(const WebCryptoOperationResult& o)
+    {
+        assign(o);
+    }
+
+    WebCryptoOperationResult& operator=(const WebCryptoOperationResult& o)
+    {
+        assign(o);
+        return *this;
+    }
+
+    WEBKIT_EXPORT void initializationFailed();
+    WEBKIT_EXPORT void initializationSucceeded(WebCryptoOperation*);
+    WEBKIT_EXPORT void completeWithError();
+    WEBKIT_EXPORT void completeWithArrayBuffer(const WebArrayBuffer&);
+
+private:
+    WEBKIT_EXPORT void reset();
+    WEBKIT_EXPORT void assign(const WebCryptoOperationResult&);
+    WEBKIT_EXPORT void assign(WebCryptoOperationResultPrivate*);
+
+    WebPrivatePtr<WebCryptoOperationResultPrivate> m_impl;
+};
+
+class WebCryptoKeyOperation {
+public:
+    // Cancels the in-progress operation.
+    //   * Implementations should delete |this| after aborting.
+    virtual void abort() = 0;
 
 protected:
-    virtual ~WebCryptoOperationResult() { }
+    virtual ~WebCryptoKeyOperation() { }
+};
+
+// Can be implemented by embedder for unit-testing.
+class WebCryptoKeyOperationResultPrivate {
+public:
+    virtual ~WebCryptoKeyOperationResultPrivate() { }
+
+    virtual void initializationFailed() = 0;
+    virtual void initializationSucceeded(WebCryptoKeyOperation*) = 0;
+    virtual void completeWithError() = 0;
+    virtual void completeWithKey(const WebCryptoKey&) = 0;
+
+    virtual void ref() = 0;
+    virtual void deref() = 0;
+};
+
+class WebCryptoKeyOperationResult {
+public:
+    explicit WebCryptoKeyOperationResult(WebCryptoKeyOperationResultPrivate* impl)
+    {
+        assign(impl);
+    }
+
+    ~WebCryptoKeyOperationResult() { reset(); }
+
+    WebCryptoKeyOperationResult(const WebCryptoKeyOperationResult& o)
+    {
+        assign(o);
+    }
+
+    WebCryptoKeyOperationResult& operator=(const WebCryptoKeyOperationResult& o)
+    {
+        assign(o);
+        return *this;
+    }
+
+    WEBKIT_EXPORT void initializationFailed();
+    WEBKIT_EXPORT void initializationSucceeded(WebCryptoKeyOperation*);
+
+    WEBKIT_EXPORT void completeWithError();
+    WEBKIT_EXPORT void completeWithKey(const WebCryptoKey&);
+
+private:
+    WEBKIT_EXPORT void reset();
+    WEBKIT_EXPORT void assign(const WebCryptoKeyOperationResult&);
+    WEBKIT_EXPORT void assign(WebCryptoKeyOperationResultPrivate*);
+
+    WebPrivatePtr<WebCryptoKeyOperationResultPrivate> m_impl;
 };
 
 } // namespace WebKit
 
 #endif