src/third_party/WebKit/Source/modules/crypto/NormalizeAlgorithm.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 NormalizeAlgorithm_h
  32 #define NormalizeAlgorithm_h
  33
  34 #include "public/platform/WebCrypto.h"
  35 #include "public/platform/WebCryptoAlgorithm.h"
  36 #include "public/platform/WebString.h"
  37 #include "wtf/Assertions.h"
  38 #include "wtf/Forward.h"
  39
  40 namespace blink {
  41
  42 class Dictionary;
  43
  44 struct AlgorithmError {
  45     WebCryptoErrorType errorType;
  46     WebString errorDetails;
  47 };
  48
  49 // Converts a javascript Dictionary to a WebCryptoAlgorithm object.
  50 //
  51 // This corresponds with "normalizing" [1] the algorithm, and then validating
  52 // the expected parameters for the algorithm/operation combination.
  53 //
  54 // On success returns true and sets the WebCryptoAlgorithm.
  55 //
  56 // On failure normalizeAlgorithm returns false and sets the AlgorithmError with
  57 // a error type and a (non-localized) debug string.
  58 //
  59 // [1] http://www.w3.org/TR/WebCryptoAPI/#algorithm-normalizing-rules
  60 bool normalizeAlgorithm(const Dictionary&, WebCryptoOperation, WebCryptoAlgorithm&, AlgorithmError*) WARN_UNUSED_RETURN;
  61
  62 } // namespace blink
  63
  64 #endif