David Benjamin
30b7a01dd4
This reflects some assumptions we have on our headers: - <openssl/foo.h> pulls in <openssl/base.h>. In particular, the canonical FOO typedefs for foo_st all live forward declared in <opessl/base.h>, but including <openssl/foo.h> is sufficient to use FOO. - <openssl/base.h> pulls in <stdint.h> and <stddef.h> so we don't have to keep including it. Add IWYU exports to reflect this so that clang's include cleaner gets less upset. It's a bit of a blunt instrument because it also means that <openssl/foo.h> lets you use the forward-declared BAR typedef, and downstream projects might still prefer to explicit include <stdint.h> when they use it (we use it so much that it would be too much), but I think this is fine. NB: By adding these, we're essentially promising we won't include those transitive includes because downstream code might accidentally start relying on it. Change-Id: I705fe6d1026fbd302ed0f070a0cf7658a70af8ef Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/77687 Reviewed-by: Bob Beck <bbe@google.com> Commit-Queue: David Benjamin <davidben@google.com>
69 lines
2.7 KiB
C
69 lines
2.7 KiB
C
// Copyright 2014 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_HKDF_H
|
|
#define OPENSSL_HEADER_HKDF_H
|
|
|
|
#include <openssl/base.h> // IWYU pragma: export
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
// HKDF.
|
|
|
|
|
|
// HKDF computes HKDF (as specified by RFC 5869) of initial keying material
|
|
// |secret| with |salt| and |info| using |digest|, and outputs |out_len| bytes
|
|
// to |out_key|. It returns one on success and zero on error.
|
|
//
|
|
// HKDF is an Extract-and-Expand algorithm. It does not do any key stretching,
|
|
// and as such, is not suited to be used alone to generate a key from a
|
|
// password.
|
|
OPENSSL_EXPORT int HKDF(uint8_t *out_key, size_t out_len, const EVP_MD *digest,
|
|
const uint8_t *secret, size_t secret_len,
|
|
const uint8_t *salt, size_t salt_len,
|
|
const uint8_t *info, size_t info_len);
|
|
|
|
// HKDF_extract computes a HKDF PRK (as specified by RFC 5869) from initial
|
|
// keying material |secret| and salt |salt| using |digest|, and outputs
|
|
// |out_len| bytes to |out_key|. The maximum output size is |EVP_MAX_MD_SIZE|.
|
|
// It returns one on success and zero on error.
|
|
//
|
|
// WARNING: This function orders the inputs differently from RFC 5869
|
|
// specification. Double-check which parameter is the secret/IKM and which is
|
|
// the salt when using.
|
|
OPENSSL_EXPORT int HKDF_extract(uint8_t *out_key, size_t *out_len,
|
|
const EVP_MD *digest, const uint8_t *secret,
|
|
size_t secret_len, const uint8_t *salt,
|
|
size_t salt_len);
|
|
|
|
// HKDF_expand computes a HKDF OKM (as specified by RFC 5869) of length
|
|
// |out_len| from the PRK |prk| and info |info| using |digest|, and outputs
|
|
// the result to |out_key|. It returns one on success and zero on error.
|
|
OPENSSL_EXPORT int HKDF_expand(uint8_t *out_key, size_t out_len,
|
|
const EVP_MD *digest, const uint8_t *prk,
|
|
size_t prk_len, const uint8_t *info,
|
|
size_t info_len);
|
|
|
|
|
|
#if defined(__cplusplus)
|
|
} // extern C
|
|
#endif
|
|
|
|
#define HKDF_R_OUTPUT_TOO_LARGE 100
|
|
|
|
#endif // OPENSSL_HEADER_HKDF_H
|