QuasarApp/openssl
4
0
Fork 0
mirror of https://github.com/QuasarApp/openssl.git synced 2025-04-28 18:54:36 +00:00
Code Issues Projects Releases Wiki Activity

Change the provider implementation of X942kdf to use wpacket to do der encoding of sharedInfo

Browse Source 
Added der_writer functions for writing octet string primitives.
Generate OID's for key wrapping algorithms used by X942 KDF.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12554)
This commit is contained in:
Shane Lontis 2020-08-04 12:18:51 +10:00
parent 37d898df34
commit e5b2cd5899
12 changed files with 252 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -34,10 +34,12 @@ providers/common/der/der_digests_gen.c
providers/common/der/der_dsa_gen.c
providers/common/der/der_ec_gen.c
providers/common/der/der_rsa_gen.c
providers/common/der/der_wrap_gen.c
providers/common/include/prov/der_dsa.h
providers/common/include/prov/der_ec.h
providers/common/include/prov/der_rsa.h
providers/common/include/prov/der_digests.h
providers/common/include/prov/der_wrap.h
# error code files
/crypto/err/openssl.txt.old

23
crypto/der_writer.c
View File

@ -66,6 +66,29 @@ int DER_w_boolean(WPACKET *pkt, int tag, int b)
&& int_end_context(pkt, tag);
}
int DER_w_octet_string(WPACKET *pkt, int tag,
const unsigned char *data, size_t data_n)
{
return int_start_context(pkt, tag)
&& WPACKET_start_sub_packet(pkt)
&& WPACKET_memcpy(pkt, data, data_n)
&& WPACKET_close(pkt)
&& WPACKET_put_bytes_u8(pkt, DER_P_OCTET_STRING)
&& int_end_context(pkt, tag);
}
int DER_w_octet_string_uint32(WPACKET *pkt, int tag, uint32_t value)
{
unsigned char tmp[4] = { 0, 0, 0, 0 };
unsigned char *pbuf = tmp + (sizeof(tmp) - 1);
while (value > 0) {
*pbuf-- = (value & 0xFF);
value >>= 8;
}
return DER_w_octet_string(pkt, tag, tmp, sizeof(tmp));
}
static int int_der_w_integer(WPACKET *pkt, int tag,
int (*put_bytes)(WPACKET *pkt, const void *v,
unsigned int *top_byte),

12
doc/internal/man3/DER_w_bn.pod
View File

@ -2,7 +2,8 @@
=head1 NAME
DER_w_boolean, DER_w_ulong, DER_w_bn, DER_w_null
DER_w_boolean, DER_w_ulong, DER_w_bn, DER_w_null,
DER_w_octet_string, DER_w_octet_string_uint32
- internal DER writers for DER primitives
=head1 SYNOPSIS
@ -13,6 +14,9 @@ DER_w_boolean, DER_w_ulong, DER_w_bn, DER_w_null
int DER_w_ulong(WPACKET *pkt, int tag, unsigned long v);
int DER_w_bn(WPACKET *pkt, int tag, const BIGNUM *v);
int DER_w_null(WPACKET *pkt, int tag);
int DER_w_octet_string(WPACKET *pkt, int tag,
const unsigned char *data, size_t data_n);
int DER_w_octet_string_uint32(WPACKET *pkt, int tag, uint32_t value);
=head1 DESCRIPTION
@ -33,6 +37,12 @@ added.
DER_w_null() writes the primitive NULL.
DER_w_octet_string() writes the primitive OCTET STRING using the bytes from
I<data> with a length of I<data_n>.
DER_w_octet_string_uint32() writes the primitive OCTET STRING using a 32 bit
value in I<value>.
=head1 RETURN VALUES
All the functions return 1 on success and 0 on failure. Failure may

3
include/internal/der.h
View File

@ -76,6 +76,9 @@ int DER_w_boolean(WPACKET *pkt, int tag, int b);
int DER_w_ulong(WPACKET *pkt, int tag, unsigned long v);
int DER_w_bn(WPACKET *pkt, int tag, const BIGNUM *v);
int DER_w_null(WPACKET *pkt, int tag);
int DER_w_octet_string(WPACKET *pkt, int tag,
const unsigned char *data, size_t data_n);
int DER_w_octet_string_uint32(WPACKET *pkt, int tag, uint32_t value);
/*
* All constructors for constructed elements have a begin and a end function

15
providers/common/der/build.info
View File

@ -50,6 +50,17 @@ DEPEND[${DER_EC_GEN/.c/.o}]=$DER_EC_H
GENERATE[$DER_EC_H]=der_ec.h.in
DEPEND[$DER_EC_H]=oids_to_c.pm
#----- KEY WRAP
$DER_WRAP_H=../include/prov/der_wrap.h
$DER_WRAP_GEN=der_wrap_gen.c
GENERATE[$DER_WRAP_GEN]=der_wrap_gen.c.in
DEPEND[$DER_WRAP_GEN]=oids_to_c.pm
DEPEND[${DER_WRAP_GEN/.c/.o}]=$DER_WRAP_H
GENERATE[$DER_WRAP_H]=der_wrap.h.in
DEPEND[$DER_WRAP_H]=oids_to_c.pm
#----- Conclusion
# TODO(3.0) $COMMON should go to libcommon.a, but this currently leads
@ -59,6 +70,8 @@ $COMMON=\
$DER_RSA_COMMON \
$DER_DSA_GEN $DER_DSA_AUX \
$DER_EC_GEN $DER_EC_AUX \
$DER_DIGESTS_GEN
$DER_DIGESTS_GEN \
$DER_WRAP_GEN
SOURCE[../../libfips.a]=$COMMON $DER_RSA_FIPSABLE
SOURCE[../../libnonfips.a]=$COMMON $DER_RSA_FIPSABLE

17
providers/common/der/der_wrap.h.in Normal file
View File

@ -0,0 +1,17 @@
/*
* Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* in the file LICENSE in the source distribution or at
* https://www.openssl.org/source/license.html
*/
#include "internal/der.h"
/* Well known OIDs precompiled */
{-
$OUT = oids_to_c::process_leaves('providers/common/der/wrap.asn1',
{ dir => $config{sourcedir},
filter => \&oids_to_c::filter_to_H });
-}

17
providers/common/der/der_wrap_gen.c.in Normal file
View File

@ -0,0 +1,17 @@
/*
* Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
*
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* in the file LICENSE in the source distribution or at
* https://www.openssl.org/source/license.html
*/
#include "prov/der_wrap.h"
/* Well known OIDs precompiled */
{-
$OUT = oids_to_c::process_leaves('providers/common/der/wrap.asn1',
{ dir => $config{sourcedir},
filter => \&oids_to_c::filter_to_C });
-}

19
providers/common/der/wrap.asn1 Normal file
View File

@ -0,0 +1,19 @@
-- -------------------------------------------------------------------
-- Taken from RFC 3370, Section 4.3.1 Triple-DES Key Wrap
-- (https://tools.ietf.org/html/rfc3370)
id-alg-CMS3DESwrap OBJECT IDENTIFIER ::= {
iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) pkcs-9(9) smime(16) alg(3) 6
}
-- -------------------------------------------------------------------
-- Taken from RFC 3394, Section 3. Object Identifiers
-- (https://tools.ietf.org/html/rfc3565)
aes OBJECT IDENTIFIER ::= {
joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithm(4) 1
}
id-aes128-wrap OBJECT IDENTIFIER ::= { aes 5 }
id-aes192-wrap OBJECT IDENTIFIER ::= { aes 25 }
id-aes256-wrap OBJECT IDENTIFIER ::= { aes 45 }

2
providers/implementations/exchange/ecdh_exch.c
View File

@ -521,8 +521,6 @@ int ecdh_derive(void *vpecdhctx, unsigned char *secret,
return 0;
}
const OSSL_DISPATCH ecdh_keyexch_functions[] = {
{ OSSL_FUNC_KEYEXCH_NEWCTX, (void (*)(void))ecdh_newctx },
{ OSSL_FUNC_KEYEXCH_INIT, (void (*)(void))ecdh_init },

1
providers/implementations/kdfs/build.info
View File

@ -30,3 +30,4 @@ SOURCE[$SSKDF_GOAL]=sskdf.c
SOURCE[$SCRYPT_GOAL]=scrypt.c
SOURCE[$SSHKDF_GOAL]=sshkdf.c
SOURCE[$X942KDF_GOAL]=x942kdf.c
DEPEND[x942kdf.o]=../../common/include/prov/der_wrap.h

248
providers/implementations/kdfs/x942kdf.c
View File

@ -9,28 +9,20 @@
*/
#include "e_os.h"
#include <openssl/core_names.h>
#include <openssl/core_dispatch.h>
#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/params.h>
#include "internal/packet.h"
#include "internal/der.h"
#include "prov/provider_ctx.h"
#include "prov/providercommonerr.h"
#include "prov/implementations.h"
#include "prov/provider_util.h"
#include "prov/der_wrap.h"
#ifndef OPENSSL_NO_CMS
# include <stdlib.h>
# include <stdarg.h>
# include <string.h>
# include <openssl/hmac.h>
# include <openssl/cms.h>
# include <openssl/evp.h>
# include <openssl/kdf.h>
# include <openssl/x509.h>
# include <openssl/obj_mac.h>
# include <openssl/core_names.h>
# include "internal/cryptlib.h"
# include "internal/numbers.h"
# include "crypto/evp.h"
# include "prov/provider_ctx.h"
# include "prov/providercommonerr.h"
# include "prov/implementations.h"
# include "prov/provider_util.h"
# define X942KDF_MAX_INLEN (1 << 30)
#define X942KDF_MAX_INLEN (1 << 30)
static OSSL_FUNC_kdf_newctx_fn x942kdf_new;
static OSSL_FUNC_kdf_freectx_fn x942kdf_free;
@ -46,42 +38,83 @@ typedef struct {
PROV_DIGEST digest;
unsigned char *secret;
size_t secret_len;
int cek_nid;
unsigned char *ukm;
size_t ukm_len;
size_t dkm_len;
const unsigned char *cek_oid;
size_t cek_oid_len;
} KDF_X942;
/* A table of allowed wrapping algorithms and the associated output lengths */
/*
* A table of allowed wrapping algorithms, oids and the associated output
* lengths.
* NOTE: RC2wrap and camellia128_wrap have been removed as there are no
* corresponding ciphers for these operations.
*/
static const struct {
int nid;
const char *name;
const unsigned char *oid;
size_t oid_len;
size_t keklen; /* size in bytes */
} kek_algs[] = {
{ NID_id_smime_alg_CMS3DESwrap, 24 },
{ NID_id_smime_alg_CMSRC2wrap, 16 },
{ NID_id_aes128_wrap, 16 },
{ NID_id_aes192_wrap, 24 },
{ NID_id_aes256_wrap, 32 },
{ NID_id_camellia128_wrap, 16 },
{ NID_id_camellia192_wrap, 24 },
{ NID_id_camellia256_wrap, 32 }
{ "AES-128-WRAP", der_oid_id_aes128_wrap, DER_OID_SZ_id_aes128_wrap, 16 },
{ "AES-192-WRAP", der_oid_id_aes192_wrap, DER_OID_SZ_id_aes192_wrap, 24 },
{ "AES-256-WRAP", der_oid_id_aes256_wrap, DER_OID_SZ_id_aes256_wrap, 32 },
#ifndef FIPS_MODULE
{ "DES3-WRAP", der_oid_id_alg_CMS3DESwrap, DER_OID_SZ_id_alg_CMS3DESwrap,
24 },
#endif
};
/* Skip past an ASN1 structure: for OBJECT skip content octets too */
static int skip_asn1(unsigned char **pp, long *plen, int exptag)
static int find_alg_id(OPENSSL_CTX *libctx, const char *algname, size_t *id)
{
int i, tag, xclass;
long tmplen;
const unsigned char *q = *pp;
int ret = 1;
size_t i;
EVP_CIPHER *cipher;
i = ASN1_get_object(&q, &tmplen, &tag, &xclass, *plen);
if ((i & 0x80) != 0 || tag != exptag || xclass != V_ASN1_UNIVERSAL)
return 0;
if (tag == V_ASN1_OBJECT)
q += tmplen;
*pp = (unsigned char *)q;
*plen -= q - *pp;
return 1;
cipher = EVP_CIPHER_fetch(libctx, algname, NULL);
if (cipher != NULL) {
for (i = 0; i < OSSL_NELEM(kek_algs); i++) {
if (EVP_CIPHER_is_a(cipher, kek_algs[i].name)) {
*id = i;
goto end;
}
}
}
ret = 0;
ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_CEK_ALG);
end:
EVP_CIPHER_free(cipher);
return ret;
}
static int DER_w_keyinfo(WPACKET *pkt,
const unsigned char *der_oid, size_t der_oidlen,
unsigned char **pcounter)
{
return DER_w_begin_sequence(pkt, -1)
/* Store the initial value of 1 into the counter */
&& DER_w_octet_string_uint32(pkt, -1, 1)
/* Remember where we stored the counter in the buffer */
&& (pcounter == NULL
|| (*pcounter = WPACKET_get_curr(pkt)) != NULL)
&& DER_w_precompiled(pkt, -1, der_oid, der_oidlen)
&& DER_w_end_sequence(pkt, -1);
}
static int der_encode_sharedinfo(WPACKET *pkt, unsigned char *buf, size_t buflen,
const unsigned char *der_oid, size_t der_oidlen,
const unsigned char *ukm, size_t ukmlen,
uint32_t keylen_bits, unsigned char **pcounter)
{
return (buf != NULL ? WPACKET_init_der(pkt, buf, buflen) :
WPACKET_init_null_der(pkt))
&& DER_w_begin_sequence(pkt, -1)
&& DER_w_octet_string_uint32(pkt, 2, keylen_bits)
&& (ukm == NULL || DER_w_octet_string(pkt, 0, ukm, ukmlen))
&& DER_w_keyinfo(pkt, der_oid, der_oidlen, pcounter)
&& DER_w_end_sequence(pkt, -1)
&& WPACKET_finish(pkt);
}
/*
@ -94,15 +127,18 @@ static int skip_asn1(unsigned char **pp, long *plen, int exptag)
* partyAInfo [0] OCTET STRING OPTIONAL,
* suppPubInfo [2] OCTET STRING
* }
* Note suppPubInfo is the key length (in bits) (stored into 4 bytes)
*
*
* KeySpecificInfo ::= SEQUENCE {
* algorithm OBJECT IDENTIFIER,
* counter OCTET STRING SIZE (4..4)
* }
*
* |nid| is the algorithm object identifier.
* |keylen| is the length (in bytes) of the generated KEK. It is stored into
* suppPubInfo (in bits).
* |cek_oid| The oid of the key wrapping algorithm.
* |cek_oidlen| The length (in bytes) of the key wrapping algorithm oid,
* |ukm| is the optional user keying material that is stored into partyAInfo. It
* can be NULL.
* |ukmlen| is the user keying material length (in bytes).
@ -114,66 +150,60 @@ static int skip_asn1(unsigned char **pp, long *plen, int exptag)
* Returns: 1 if successfully encoded, or 0 otherwise.
* Assumptions: |der|, |der_len| & |out_ctr| are not NULL.
*/
static int x942_encode_otherinfo(int nid, size_t keylen,
static int x942_encode_otherinfo(size_t keylen,
const unsigned char *cek_oid, size_t cek_oidlen,
const unsigned char *ukm, size_t ukmlen,
unsigned char **der, size_t *der_len,
unsigned char **out_ctr)
{
unsigned char *p, *encoded = NULL;
int ret = 0, encoded_len;
long tlen;
/* "magic" value to check offset is sane */
static unsigned char ctr[4] = { 0x00, 0x00, 0x00, 0x01 };
X509_ALGOR *ksi = NULL;
ASN1_OBJECT *alg_oid = NULL;
ASN1_OCTET_STRING *ctr_oct = NULL, *ukm_oct = NULL;
int ret = 0;
unsigned char *pcounter = NULL, *der_buf = NULL;
size_t der_buflen = 0;
WPACKET pkt;
uint32_t keylen_bits;
/* set the KeySpecificInfo - which contains an algorithm oid and counter */
ksi = X509_ALGOR_new();
alg_oid = OBJ_dup(OBJ_nid2obj(nid));
ctr_oct = ASN1_OCTET_STRING_new();
if (ksi == NULL
|| alg_oid == NULL
|| ctr_oct == NULL
|| !ASN1_OCTET_STRING_set(ctr_oct, ctr, sizeof(ctr))
|| !X509_ALGOR_set0(ksi, alg_oid, V_ASN1_OCTET_STRING, ctr_oct))
/* keylenbits must fit into 4 bytes */
if (keylen > 0xFFFFFF)
goto err;
/* NULL these as they now belong to ksi */
alg_oid = NULL;
ctr_oct = NULL;
keylen_bits = 8 * keylen;
/* Set the optional partyAInfo */
if (ukm != NULL) {
ukm_oct = ASN1_OCTET_STRING_new();
if (ukm_oct == NULL)
goto err;
ASN1_OCTET_STRING_set(ukm_oct, (unsigned char *)ukm, ukmlen);
}
/* Generate the OtherInfo DER data */
encoded_len = CMS_SharedInfo_encode(&encoded, ksi, ukm_oct, keylen);
if (encoded_len <= 0)
/* Calculate the size of the buffer */
if (!der_encode_sharedinfo(&pkt, NULL, 0, cek_oid, cek_oidlen, ukm, ukmlen,
keylen_bits, NULL)
|| !WPACKET_get_total_written(&pkt, &der_buflen))
goto err;
WPACKET_cleanup(&pkt);
/* Alloc the buffer */
der_buf = OPENSSL_zalloc(der_buflen);
if (der_buf == NULL)
goto err;
/* Encode into the buffer */
if (!der_encode_sharedinfo(&pkt, der_buf, der_buflen, cek_oid, cek_oidlen,
ukm, ukmlen, keylen_bits, &pcounter))
goto err;
/*
* Since we allocated the exact size required, the buffer should point to the
* start of the alllocated buffer at this point.
*/
if (WPACKET_get_curr(&pkt) != der_buf)
goto err;
/* Parse the encoded data to find the offset of the counter data */
p = encoded;
tlen = (long)encoded_len;
if (skip_asn1(&p, &tlen, V_ASN1_SEQUENCE)
&& skip_asn1(&p, &tlen, V_ASN1_SEQUENCE)
&& skip_asn1(&p, &tlen, V_ASN1_OBJECT)
&& skip_asn1(&p, &tlen, V_ASN1_OCTET_STRING)
&& CRYPTO_memcmp(p, ctr, 4) == 0) {
*out_ctr = p;
*der = encoded;
*der_len = (size_t)encoded_len;
ret = 1;
}
/*
* The data for the DER encoded octet string of a 32 bit counter = 1
* should be 04 04 00 00 00 01
* So just check the header is correct and skip over it.
* This counter will be incremented in the kdf update loop.
*/
if (pcounter == NULL
|| pcounter[0] != 0x04
|| pcounter[1] != 0x04)
goto err;
*out_ctr = (pcounter + 2);
*der = der_buf;
*der_len = der_buflen;
ret = 1;
err:
if (ret != 1)
OPENSSL_free(encoded);
ASN1_OCTET_STRING_free(ctr_oct);
ASN1_OCTET_STRING_free(ukm_oct);
ASN1_OBJECT_free(alg_oid);
X509_ALGOR_free(ksi);
WPACKET_cleanup(&pkt);
return ret;
}
@ -315,7 +345,7 @@ static int x942kdf_derive(void *vctx, unsigned char *key, size_t keylen)
ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
return 0;
}
if (ctx->cek_nid == NID_undef) {
if (ctx->cek_oid == NULL || ctx->cek_oid_len == 0) {
ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CEK_ALG);
return 0;
}
@ -327,12 +357,9 @@ static int x942kdf_derive(void *vctx, unsigned char *key, size_t keylen)
ERR_raise(ERR_LIB_PROV, PROV_R_INAVLID_UKM_LENGTH);
return 0;
}
if (keylen != ctx->dkm_len) {
ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CEK_ALG);
return 0;
}
/* generate the otherinfo der */
if (!x942_encode_otherinfo(ctx->cek_nid, ctx->dkm_len,
if (!x942_encode_otherinfo(ctx->dkm_len,
ctx->cek_oid, ctx->cek_oid_len,
ctx->ukm, ctx->ukm_len,
&der, &der_len, &ctr)) {
ERR_raise(ERR_LIB_PROV, PROV_R_BAD_ENCODING);
@ -349,7 +376,7 @@ static int x942kdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
const OSSL_PARAM *p;
KDF_X942 *ctx = vctx;
OPENSSL_CTX *provctx = PROV_LIBRARY_CONTEXT_OF(ctx->provctx);
size_t i;
size_t id;
if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
return 0;
@ -366,14 +393,11 @@ static int x942kdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_CEK_ALG)) != NULL) {
if (p->data_type != OSSL_PARAM_UTF8_STRING)
return 0;
ctx->cek_nid = OBJ_sn2nid(p->data);
for (i = 0; i < OSSL_NELEM(kek_algs); i++)
if (kek_algs[i].nid == ctx->cek_nid)
goto cek_found;
ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_CEK_ALG);
return 0;
cek_found:
ctx->dkm_len = kek_algs[i].keklen;
if (find_alg_id(provctx, p->data, &id) == 0)
return 0;
ctx->cek_oid = kek_algs[id].oid;
ctx->cek_oid_len = kek_algs[id].oid_len;
ctx->dkm_len = kek_algs[id].keklen;
}
return 1;
}
@ -424,5 +448,3 @@ const OSSL_DISPATCH kdf_x942_kdf_functions[] = {
{ OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))x942kdf_get_ctx_params },
{ 0, NULL }
};
#endif /* OPENSSL_NO_CMS */

12
test/recipes/30-test_evp_data/evpkdf.txt
View File

@ -6517,12 +6517,20 @@ Ctrl.hexsecret = hexsecret:000102030405060708090a0b0c0d0e0f10111213
Ctrl.cekalg = cekalg:id-smime-alg-CMS3DESwrap
Output = a09661392376f7044d9052a397883246b67f5f1ef63eb5fb
Title = X9.42 KDF tests (RFC3565 2.3.2 Examples)
KDF = X942KDF
Ctrl.digest = digest:SHA1
Ctrl.hexsecret = hexsecret:000102030405060708090a0b0c0d0e0f10111213
Ctrl.cekalg = cekalg:id-smime-alg-CMSRC2wrap
Ctrl.cekalg = cekalg:id-aes128-wrap
Output = d6d6b094c1027a7de6e3117294a35364
KDF = X942KDF
Ctrl.digest = digest:SHA1
Ctrl.hexsecret = hexsecret:000102030405060708090a0b0c0d0e0f10111213
Ctrl.cekalg = cekalg:id-aes256-wrap
Ctrl.hexukm = hexukm:0123456789abcdeffedcba98765432010123456789abcdeffedcba98765432010123456789abcdeffedcba98765432010123456789abcdeffedcba9876543201
Output = 48950c46e0530075403cce72889604e0
Output = 8890585C4E281A5C1167CAA530BED59B3230D893CBA8F922BD1B56A0
Title = KRB5KDF tests (from RFC 3961 test vectors and krb5 sources)