David Benjamin
b402cff383
They're internal for now; I'm thinking we'll just have the public versions of these at the EVP layer for now and try to move past this mess where there's two versions of every API. The API is mildly annoying in that both this caller and the one added next will want to distinguish UNKNOWN_GROUP from other errors, but the recent helper function makes checking the error queue not tooooo bad. Bug: 42290364 Change-Id: Ibb5e3e643a9180459cc09b4559ee40696cea2688 Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/81650 Reviewed-by: Adam Langley <agl@google.com> Commit-Queue: David Benjamin <davidben@google.com>
106 lines
4.4 KiB
C
106 lines
4.4 KiB
C
// Copyright 2020 The BoringSSL Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef OPENSSL_HEADER_CRYPTO_EC_INTERNAL_H
|
|
#define OPENSSL_HEADER_CRYPTO_EC_INTERNAL_H
|
|
|
|
#include <openssl/ec.h>
|
|
|
|
#include <openssl/span.h>
|
|
|
|
#include "../fipsmodule/ec/internal.h"
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
// Parsing functions.
|
|
|
|
// ec_key_parse_curve_name behaves like |EC_KEY_parse_curve_name| but only
|
|
// supports the groups in |allowed_groups|. If no syntax errors were found but
|
|
// the group is unknown, it will fail with an error of |EC_R_UNKNOWN_GROUP|.
|
|
const EC_GROUP *ec_key_parse_curve_name(
|
|
CBS *cbs, bssl::Span<const EC_GROUP *const> allowed_groups);
|
|
|
|
// ec_key_parse_parameters behaves like |EC_KEY_parse_parameters| but only
|
|
// supports the groups in |allowed_groups|. If no syntax errors were found but
|
|
// the group is unknown, it will fail with an error of |EC_R_UNKNOWN_GROUP|.
|
|
const EC_GROUP *ec_key_parse_parameters(
|
|
CBS *cbs, bssl::Span<const EC_GROUP *const> allowed_groups);
|
|
|
|
// ec_key_parse_private_key behaves like |EC_KEY_parse_private_key| but only
|
|
// supports the groups in |allowed_groups|. If |group| is non-NULL,
|
|
// |allowed_groups| is ignored and instead only |group| is supported.
|
|
//
|
|
// TODO(crbug.com/boringssl/414361735): This should return a bssl::UniquePtr,
|
|
// but cannot until it is made C++ linkage.
|
|
EC_KEY *ec_key_parse_private_key(
|
|
CBS *cbs, const EC_GROUP *group,
|
|
bssl::Span<const EC_GROUP *const> allowed_groups);
|
|
|
|
|
|
// Hash-to-curve.
|
|
//
|
|
// Internal |EC_JACOBIAN| versions of the corresponding public APIs.
|
|
|
|
// ec_hash_to_curve_p256_xmd_sha256_sswu hashes |msg| to a point on |group| and
|
|
// writes the result to |out|, implementing the P256_XMD:SHA-256_SSWU_RO_ suite
|
|
// from RFC 9380. It returns one on success and zero on error.
|
|
OPENSSL_EXPORT int ec_hash_to_curve_p256_xmd_sha256_sswu(
|
|
const EC_GROUP *group, EC_JACOBIAN *out, const uint8_t *dst, size_t dst_len,
|
|
const uint8_t *msg, size_t msg_len);
|
|
|
|
// ec_hash_to_curve_p384_xmd_sha384_sswu hashes |msg| to a point on |group| and
|
|
// writes the result to |out|, implementing the P384_XMD:SHA-384_SSWU_RO_ suite
|
|
// from RFC 9380. It returns one on success and zero on error.
|
|
OPENSSL_EXPORT int ec_hash_to_curve_p384_xmd_sha384_sswu(
|
|
const EC_GROUP *group, EC_JACOBIAN *out, const uint8_t *dst, size_t dst_len,
|
|
const uint8_t *msg, size_t msg_len);
|
|
|
|
// ec_hash_to_scalar_p384_xmd_sha384 hashes |msg| to a scalar on |group|
|
|
// and writes the result to |out|, using the hash_to_field operation from the
|
|
// P384_XMD:SHA-384_SSWU_RO_ suite from RFC 9380, but generating a value modulo
|
|
// the group order rather than a field element.
|
|
OPENSSL_EXPORT int ec_hash_to_scalar_p384_xmd_sha384(
|
|
const EC_GROUP *group, EC_SCALAR *out, const uint8_t *dst, size_t dst_len,
|
|
const uint8_t *msg, size_t msg_len);
|
|
|
|
// ec_hash_to_curve_p384_xmd_sha512_sswu_draft07 hashes |msg| to a point on
|
|
// |group| and writes the result to |out|, implementing the
|
|
// P384_XMD:SHA-512_SSWU_RO_ suite from draft-irtf-cfrg-hash-to-curve-07. It
|
|
// returns one on success and zero on error.
|
|
//
|
|
// TODO(https://crbug.com/1414562): Migrate this to the final version.
|
|
OPENSSL_EXPORT int ec_hash_to_curve_p384_xmd_sha512_sswu_draft07(
|
|
const EC_GROUP *group, EC_JACOBIAN *out, const uint8_t *dst, size_t dst_len,
|
|
const uint8_t *msg, size_t msg_len);
|
|
|
|
// ec_hash_to_scalar_p384_xmd_sha512_draft07 hashes |msg| to a scalar on |group|
|
|
// and writes the result to |out|, using the hash_to_field operation from the
|
|
// P384_XMD:SHA-512_SSWU_RO_ suite from draft-irtf-cfrg-hash-to-curve-07, but
|
|
// generating a value modulo the group order rather than a field element.
|
|
//
|
|
// TODO(https://crbug.com/1414562): Migrate this to the final version.
|
|
OPENSSL_EXPORT int ec_hash_to_scalar_p384_xmd_sha512_draft07(
|
|
const EC_GROUP *group, EC_SCALAR *out, const uint8_t *dst, size_t dst_len,
|
|
const uint8_t *msg, size_t msg_len);
|
|
|
|
|
|
#if defined(__cplusplus)
|
|
} // extern C
|
|
#endif
|
|
|
|
#endif // OPENSSL_HEADER_CRYPTO_EC_INTERNAL_H
|