blob: e90e98d466b11a6cea941a4d5b57e185cca118fa [file] [log] [blame]
/*
* 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
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* 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 WebCryptoAlgorithmParams_h
#define WebCryptoAlgorithmParams_h
#include "WebCommon.h"
#include "WebCryptoAlgorithm.h"
#include "WebCryptoKey.h"
#include "WebVector.h"
namespace blink {
// NOTE: For documentation on the meaning of each of the parameters see the
// Web crypto spec:
//
// http://www.w3.org/TR/WebCryptoAPI
//
// For the most part, the parameters in the spec have the same name,
// except that in the blink code:
//
// - Structure names are prefixed by "WebCrypto"
// - Optional fields are prefixed by "optional"
// - Data length properties are suffixed by either "Bits" or "Bytes"
class WebCryptoAlgorithmParams {
public:
WebCryptoAlgorithmParams() { }
virtual ~WebCryptoAlgorithmParams() { }
virtual WebCryptoAlgorithmParamsType type() const = 0;
};
class WebCryptoAesCbcParams : public WebCryptoAlgorithmParams {
public:
WebCryptoAesCbcParams(const unsigned char* iv, unsigned ivSize)
: m_iv(iv, ivSize)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeAesCbcParams; }
const WebVector<unsigned char>& iv() const { return m_iv; }
private:
const WebVector<unsigned char> m_iv;
};
class WebCryptoAlgorithmParamsWithHash : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoAlgorithmParamsWithHash(const WebCryptoAlgorithm& hash)
: m_hash(hash)
{
BLINK_ASSERT(!hash.isNull());
}
const WebCryptoAlgorithm& hash() const { return m_hash; }
private:
const WebCryptoAlgorithm m_hash;
};
class WebCryptoAesCtrParams : public WebCryptoAlgorithmParams {
public:
WebCryptoAesCtrParams(unsigned char lengthBits, const unsigned char* counter, unsigned counterSize)
: WebCryptoAlgorithmParams()
, m_counter(counter, counterSize)
, m_lengthBits(lengthBits)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeAesCtrParams; }
const WebVector<unsigned char>& counter() const { return m_counter; }
unsigned char lengthBits() const { return m_lengthBits; }
private:
const WebVector<unsigned char> m_counter;
const unsigned char m_lengthBits;
};
class WebCryptoAesKeyGenParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoAesKeyGenParams(unsigned short lengthBits)
: m_lengthBits(lengthBits)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeAesKeyGenParams; }
unsigned short lengthBits() const { return m_lengthBits; }
private:
const unsigned short m_lengthBits;
};
class WebCryptoHmacImportParams : public WebCryptoAlgorithmParamsWithHash {
public:
// FIXME: Remove this constructor once it is no longer used by Chromium. http://crbug.com/431085
explicit WebCryptoHmacImportParams(const WebCryptoAlgorithm& hash)
: WebCryptoAlgorithmParamsWithHash(hash)
, m_hasLengthBits(false)
, m_optionalLengthBits(0)
{
}
WebCryptoHmacImportParams(const WebCryptoAlgorithm& hash, bool hasLengthBits, unsigned lengthBits)
: WebCryptoAlgorithmParamsWithHash(hash)
, m_hasLengthBits(hasLengthBits)
, m_optionalLengthBits(lengthBits)
{
BLINK_ASSERT(hasLengthBits || !lengthBits);
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeHmacImportParams; }
bool hasLengthBits() const { return m_hasLengthBits; }
unsigned optionalLengthBits() const { return m_optionalLengthBits; }
private:
const bool m_hasLengthBits;
const unsigned m_optionalLengthBits;
};
class WebCryptoHmacKeyGenParams : public WebCryptoAlgorithmParamsWithHash {
public:
WebCryptoHmacKeyGenParams(const WebCryptoAlgorithm& hash, bool hasLengthBits, unsigned lengthBits)
: WebCryptoAlgorithmParamsWithHash(hash)
, m_hasLengthBits(hasLengthBits)
, m_optionalLengthBits(lengthBits)
{
BLINK_ASSERT(hasLengthBits || !lengthBits);
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeHmacKeyGenParams; }
bool hasLengthBits() const { return m_hasLengthBits; }
unsigned optionalLengthBits() const { return m_optionalLengthBits; }
private:
const bool m_hasLengthBits;
const unsigned m_optionalLengthBits;
};
class WebCryptoAesGcmParams : public WebCryptoAlgorithmParams {
public:
WebCryptoAesGcmParams(const unsigned char* iv, unsigned ivSize, bool hasAdditionalData, const unsigned char* additionalData, unsigned additionalDataSize, bool hasTagLengthBits, unsigned char tagLengthBits)
: m_iv(iv, ivSize)
, m_hasAdditionalData(hasAdditionalData)
, m_optionalAdditionalData(additionalData, additionalDataSize)
, m_hasTagLengthBits(hasTagLengthBits)
, m_optionalTagLengthBits(tagLengthBits)
{
BLINK_ASSERT(hasAdditionalData || !additionalDataSize);
BLINK_ASSERT(hasTagLengthBits || !tagLengthBits);
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeAesGcmParams; }
const WebVector<unsigned char>& iv() const { return m_iv; }
bool hasAdditionalData() const { return m_hasAdditionalData; }
const WebVector<unsigned char>& optionalAdditionalData() const { return m_optionalAdditionalData; }
bool hasTagLengthBits() const { return m_hasTagLengthBits; }
unsigned optionalTagLengthBits() const { return m_optionalTagLengthBits; }
private:
const WebVector<unsigned char> m_iv;
const bool m_hasAdditionalData;
const WebVector<unsigned char> m_optionalAdditionalData;
const bool m_hasTagLengthBits;
const unsigned char m_optionalTagLengthBits;
};
class WebCryptoRsaHashedImportParams : public WebCryptoAlgorithmParamsWithHash {
public:
explicit WebCryptoRsaHashedImportParams(const WebCryptoAlgorithm& hash)
: WebCryptoAlgorithmParamsWithHash(hash)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeRsaHashedImportParams; }
};
class WebCryptoRsaHashedKeyGenParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoRsaHashedKeyGenParams(const WebCryptoAlgorithm& hash, unsigned modulusLengthBits, const unsigned char* publicExponent, unsigned publicExponentSize)
: m_modulusLengthBits(modulusLengthBits)
, m_publicExponent(publicExponent, publicExponentSize)
, m_hash(hash)
{
BLINK_ASSERT(!hash.isNull());
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeRsaHashedKeyGenParams; }
unsigned modulusLengthBits() const { return m_modulusLengthBits; }
const WebVector<unsigned char>& publicExponent() const { return m_publicExponent; }
const WebCryptoAlgorithm& hash() const { return m_hash; }
private:
const unsigned m_modulusLengthBits;
const WebVector<unsigned char> m_publicExponent;
const WebCryptoAlgorithm m_hash;
};
class WebCryptoRsaOaepParams : public WebCryptoAlgorithmParams {
public:
WebCryptoRsaOaepParams(bool hasLabel, const unsigned char* label, unsigned labelSize)
: m_hasLabel(hasLabel)
, m_optionalLabel(label, labelSize)
{
BLINK_ASSERT(hasLabel || !labelSize);
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeRsaOaepParams; }
bool hasLabel() const { return m_hasLabel; }
const WebVector<unsigned char>& optionalLabel() const { return m_optionalLabel; }
private:
const bool m_hasLabel;
const WebVector<unsigned char> m_optionalLabel;
};
class WebCryptoRsaPssParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoRsaPssParams(unsigned saltLengthBytes)
: m_saltLengthBytes(saltLengthBytes)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeRsaPssParams; }
unsigned saltLengthBytes() const { return m_saltLengthBytes; }
private:
const unsigned m_saltLengthBytes;
};
class WebCryptoEcdsaParams : public WebCryptoAlgorithmParamsWithHash {
public:
explicit WebCryptoEcdsaParams(const WebCryptoAlgorithm& hash)
: WebCryptoAlgorithmParamsWithHash(hash)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeEcdsaParams; }
};
class WebCryptoEcKeyGenParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoEcKeyGenParams(WebCryptoNamedCurve namedCurve)
: m_namedCurve(namedCurve)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeEcKeyGenParams; }
WebCryptoNamedCurve namedCurve() const { return m_namedCurve; }
private:
const WebCryptoNamedCurve m_namedCurve;
};
class WebCryptoEcKeyImportParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoEcKeyImportParams(WebCryptoNamedCurve namedCurve)
: m_namedCurve(namedCurve)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeEcKeyImportParams; }
WebCryptoNamedCurve namedCurve() const { return m_namedCurve; }
private:
const WebCryptoNamedCurve m_namedCurve;
};
class WebCryptoEcdhKeyDeriveParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoEcdhKeyDeriveParams(const WebCryptoKey& publicKey)
: m_publicKey(publicKey)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypeEcdhKeyDeriveParams; }
const WebCryptoKey& publicKey() const { return m_publicKey; }
private:
const WebCryptoKey m_publicKey;
};
class WebCryptoAesDerivedKeyParams : public WebCryptoAlgorithmParams {
public:
explicit WebCryptoAesDerivedKeyParams(unsigned short lengthBits)
: m_lengthBits(lengthBits)
{
}
virtual WebCryptoAlgorithmParamsType type() const override { return WebCryptoAlgorithmParamsTypeAesDerivedKeyParams; }
unsigned short lengthBits() const { return m_lengthBits; }
private:
const unsigned short m_lengthBits;
};
class WebCryptoHkdfParams : public WebCryptoAlgorithmParamsWithHash {
public:
WebCryptoHkdfParams(const WebCryptoAlgorithm& hash, const unsigned char* salt, unsigned saltSize, const unsigned char* info, unsigned infoSize)
: WebCryptoAlgorithmParamsWithHash(hash)
, m_salt(salt, saltSize)
, m_info(info, infoSize)
{
}
const WebVector<unsigned char>& salt() const { return m_salt; }
const WebVector<unsigned char>& info() const { return m_info; }
virtual WebCryptoAlgorithmParamsType type() const
{
return WebCryptoAlgorithmParamsTypeHkdfParams;
}
private:
const WebVector<unsigned char> m_salt;
const WebVector<unsigned char> m_info;
};
class WebCryptoPbkdf2Params : public WebCryptoAlgorithmParamsWithHash {
public:
WebCryptoPbkdf2Params(const WebCryptoAlgorithm& hash, const unsigned char* salt, unsigned saltLength, unsigned iterations)
: WebCryptoAlgorithmParamsWithHash(hash)
, m_salt(salt, saltLength)
, m_iterations(iterations)
{
}
virtual WebCryptoAlgorithmParamsType type() const { return WebCryptoAlgorithmParamsTypePbkdf2Params; }
const WebVector<unsigned char>& salt() const { return m_salt; }
unsigned iterations() const { return m_iterations; }
private:
const WebVector<unsigned char> m_salt;
const unsigned m_iterations;
};
} // namespace blink
#endif