1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
|
/*
* Copyright (C) 2023 Apple 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
*/
#include "config.h"
#include "CryptoKeyOKP.h"
#include "CryptoAlgorithmRegistry.h"
#include "JsonWebKey.h"
#include <wtf/text/Base64.h>
namespace WebCore {
static const ASCIILiteral X25519 { "X25519"_s };
static const ASCIILiteral Ed25519 { "Ed25519"_s };
static constexpr size_t keySizeInBytesFromNamedCurve(CryptoKeyOKP::NamedCurve curve)
{
switch (curve) {
case CryptoKeyOKP::NamedCurve::X25519:
case CryptoKeyOKP::NamedCurve::Ed25519:
return 32;
}
return 32;
}
RefPtr<CryptoKeyOKP> CryptoKeyOKP::create(CryptoAlgorithmIdentifier identifier, NamedCurve curve, CryptoKeyType type, KeyMaterial&& platformKey, bool extractable, CryptoKeyUsageBitmap usages)
{
if (platformKey.size() != keySizeInBytesFromNamedCurve(curve))
return nullptr;
return adoptRef(*new CryptoKeyOKP(identifier, curve, type, WTFMove(platformKey), extractable, usages));
}
CryptoKeyOKP::CryptoKeyOKP(CryptoAlgorithmIdentifier identifier, NamedCurve curve, CryptoKeyType type, KeyMaterial&& data, bool extractable, CryptoKeyUsageBitmap usages)
: CryptoKey(identifier, type, extractable, usages)
, m_curve(curve)
, m_data(WTFMove(data))
{
}
ExceptionOr<CryptoKeyPair> CryptoKeyOKP::generatePair(CryptoAlgorithmIdentifier identifier, NamedCurve namedCurve, bool extractable, CryptoKeyUsageBitmap usages)
{
if (!supportsNamedCurve())
return Exception { ExceptionCode::NotSupportedError };
auto result = platformGeneratePair(identifier, namedCurve, extractable, usages);
if (!result)
return Exception { ExceptionCode::OperationError };
return WTFMove(*result);
}
RefPtr<CryptoKeyOKP> CryptoKeyOKP::importRaw(CryptoAlgorithmIdentifier identifier, NamedCurve namedCurve, Vector<uint8_t>&& keyData, bool extractable, CryptoKeyUsageBitmap usages)
{
if (!supportsNamedCurve())
return nullptr;
// FIXME: The Ed25519 spec states that import in raw format must be used only for Verify.
return create(identifier, namedCurve, usages & CryptoKeyUsageSign ? CryptoKeyType::Private : CryptoKeyType::Public, WTFMove(keyData), extractable, usages);
}
RefPtr<CryptoKeyOKP> CryptoKeyOKP::importJwk(CryptoAlgorithmIdentifier identifier, NamedCurve namedCurve, JsonWebKey&& keyData, bool extractable, CryptoKeyUsageBitmap usages)
{
if (!supportsNamedCurve())
return nullptr;
switch (namedCurve) {
case NamedCurve::Ed25519:
// FIXME: this is already done in the Algorithm's importKey method for each format, so it seems we can remoev this duplicated code.
if (!keyData.d.isEmpty()) {
if (usages & (CryptoKeyUsageEncrypt | CryptoKeyUsageDecrypt | CryptoKeyUsageVerify | CryptoKeyUsageDeriveKey | CryptoKeyUsageDeriveBits | CryptoKeyUsageWrapKey | CryptoKeyUsageUnwrapKey))
return nullptr;
} else {
if (usages & (CryptoKeyUsageEncrypt | CryptoKeyUsageDecrypt | CryptoKeyUsageSign | CryptoKeyUsageDeriveKey | CryptoKeyUsageDeriveBits | CryptoKeyUsageWrapKey | CryptoKeyUsageUnwrapKey))
return nullptr;
}
if (keyData.crv != "Ed25519"_s)
return nullptr;
// FIXME: Do we have tests for these checks ?
if (!keyData.alg.isEmpty() && keyData.alg != "EdDSA"_s)
return nullptr;
if (usages && !keyData.use.isEmpty() && keyData.use != "sign"_s)
return nullptr;
if (keyData.key_ops && ((keyData.usages & usages) != usages))
return nullptr;
if (keyData.ext && !keyData.ext.value() && extractable)
return nullptr;
break;
case NamedCurve::X25519:
if (keyData.crv != "X25519"_s)
return nullptr;
if (keyData.key_ops && ((keyData.usages & usages) != usages))
return nullptr;
if (keyData.ext && !keyData.ext.value() && extractable)
return nullptr;
break;
}
if (keyData.kty != "OKP"_s)
return nullptr;
if (keyData.x.isNull())
return nullptr;
auto x = base64URLDecode(keyData.x);
if (!x)
return nullptr;
if (!keyData.d.isNull()) {
auto d = base64URLDecode(keyData.d);
if (!d || !platformCheckPairedKeys(identifier, namedCurve, *d, *x))
return nullptr;
return create(identifier, namedCurve, CryptoKeyType::Private, WTFMove(*d), extractable, usages);
}
return create(identifier, namedCurve, CryptoKeyType::Public, WTFMove(*x), extractable, usages);
}
ExceptionOr<Vector<uint8_t>> CryptoKeyOKP::exportRaw() const
{
if (type() != CryptoKey::Type::Public)
return Exception { ExceptionCode::InvalidAccessError };
auto result = platformExportRaw();
if (result.isEmpty())
return Exception { ExceptionCode::OperationError };
return result;
}
ExceptionOr<JsonWebKey> CryptoKeyOKP::exportJwk() const
{
JsonWebKey result;
result.kty = "OKP"_s;
switch (m_curve) {
case NamedCurve::X25519:
result.crv = X25519;
break;
case NamedCurve::Ed25519:
result.crv = Ed25519;
break;
}
result.key_ops = usages();
result.usages = usagesBitmap();
result.ext = extractable();
switch (type()) {
case CryptoKeyType::Private:
result.d = generateJwkD();
result.x = generateJwkX();
break;
case CryptoKeyType::Public:
result.x = generateJwkX();
break;
case CryptoKeyType::Secret:
return Exception { ExceptionCode::OperationError };
}
return result;
}
std::optional<CryptoKeyOKP::NamedCurve> CryptoKeyOKP::namedCurveFromString(const String& curveString)
{
if (curveString == X25519)
return NamedCurve::X25519;
if (curveString == Ed25519)
return NamedCurve::Ed25519;
return std::nullopt;
}
String CryptoKeyOKP::namedCurveString() const
{
switch (m_curve) {
case NamedCurve::X25519:
return X25519;
case NamedCurve::Ed25519:
return Ed25519;
}
ASSERT_NOT_REACHED();
return emptyString();
}
bool CryptoKeyOKP::isValidOKPAlgorithm(CryptoAlgorithmIdentifier algorithm)
{
return algorithm == CryptoAlgorithmIdentifier::Ed25519;
}
auto CryptoKeyOKP::algorithm() const -> KeyAlgorithm
{
return CryptoKeyAlgorithm { CryptoAlgorithmRegistry::singleton().name(algorithmIdentifier()) };
}
CryptoKey::Data CryptoKeyOKP::data() const
{
auto key = platformKey();
return CryptoKey::Data {
CryptoKeyClass::OKP,
algorithmIdentifier(),
extractable(),
usagesBitmap(),
WTFMove(key),
std::nullopt,
std::nullopt,
namedCurveString(),
std::nullopt,
type()
};
}
#if !PLATFORM(COCOA) && !USE(GCRYPT)
bool CryptoKeyOKP::supportsNamedCurve()
{
return false;
}
std::optional<CryptoKeyPair> CryptoKeyOKP::platformGeneratePair(CryptoAlgorithmIdentifier, NamedCurve, bool, CryptoKeyUsageBitmap)
{
return { };
}
bool CryptoKeyOKP::platformCheckPairedKeys(CryptoAlgorithmIdentifier, NamedCurve, const Vector<uint8_t>&, const Vector<uint8_t>&)
{
return true;
}
RefPtr<CryptoKeyOKP> CryptoKeyOKP::importSpki(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&&, bool, CryptoKeyUsageBitmap)
{
// FIXME: Implement it.
return nullptr;
}
ExceptionOr<Vector<uint8_t>> CryptoKeyOKP::exportSpki() const
{
return Exception { ExceptionCode::NotSupportedError };
}
RefPtr<CryptoKeyOKP> CryptoKeyOKP::importPkcs8(CryptoAlgorithmIdentifier, NamedCurve, Vector<uint8_t>&&, bool, CryptoKeyUsageBitmap)
{
// FIXME: Implement it.
return nullptr;
}
ExceptionOr<Vector<uint8_t>> CryptoKeyOKP::exportPkcs8() const
{
return Exception { ExceptionCode::NotSupportedError };
}
String CryptoKeyOKP::generateJwkD() const
{
return { };
}
String CryptoKeyOKP::generateJwkX() const
{
return { };
}
Vector<uint8_t> CryptoKeyOKP::platformExportRaw() const
{
return { };
}
#endif
} // namespace WebCore
|