Commit cd8d1456 authored by Andy Polyakov's avatar Andy Polyakov
Browse files

Add EVP_DigestFinalXOF, interface to extendable-output functions, XOFs. 



Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4137)
parent bbe9c3d5

crypto/err/openssl.txt

+2 −0
Original line number Diff line number Diff line
@@ -646,6 +646,7 @@ EVP_F_EVP_CIPHER_CTX_CTRL:124:EVP_CIPHER_CTX_ctrl 
EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH:122:EVP_CIPHER_CTX_set_key_length

EVP_F_EVP_DECRYPTFINAL_EX:101:EVP_DecryptFinal_ex

EVP_F_EVP_DECRYPTUPDATE:166:EVP_DecryptUpdate

EVP_F_EVP_DIGESTFINALXOF:174:EVP_DigestFinalXOF

EVP_F_EVP_DIGESTINIT_EX:128:EVP_DigestInit_ex

EVP_F_EVP_ENCRYPTFINAL_EX:127:EVP_EncryptFinal_ex

EVP_F_EVP_ENCRYPTUPDATE:167:EVP_EncryptUpdate
@@ -1939,6 +1940,7 @@ EVP_R_MEMORY_LIMIT_EXCEEDED:172:memory limit exceeded 
EVP_R_MESSAGE_DIGEST_IS_NULL:159:message digest is null

EVP_R_METHOD_NOT_SUPPORTED:144:method not supported

EVP_R_MISSING_PARAMETERS:103:missing parameters

EVP_R_NOT_XOF_OR_INVALID_LENGTH:178:not XOF or invalid length

EVP_R_NO_CIPHER_SET:131:no cipher set

EVP_R_NO_DEFAULT_DIGEST:158:no default digest

EVP_R_NO_DIGEST_SET:139:no digest set

crypto/evp/digest.c

+21 −0
Original line number Diff line number Diff line
@@ -174,6 +174,27 @@ int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *size) 
    return ret;

}



int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t size)

{

    int ret = 0;



    if (ctx->digest->flags & EVP_MD_FLAG_XOF

        && size <= INT_MAX

        && ctx->digest->md_ctrl(ctx, EVP_MD_CTRL_XOF_LEN, (int)size, NULL)) {

        ret = ctx->digest->final(ctx, md);



        if (ctx->digest->cleanup != NULL) {

            ctx->digest->cleanup(ctx);

            EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_CLEANED);

        }

        OPENSSL_cleanse(ctx->md_data, ctx->digest->ctx_size);

    } else {

        EVPerr(EVP_F_EVP_DIGESTFINALXOF, EVP_R_NOT_XOF_OR_INVALID_LENGTH);

    }



    return ret;

}



int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in)

{

    EVP_MD_CTX_reset(out);

crypto/evp/evp_err.c

+3 −0
Original line number Diff line number Diff line
@@ -38,6 +38,7 @@ static const ERR_STRING_DATA EVP_str_functs[] = { 
    {ERR_PACK(ERR_LIB_EVP, EVP_F_EVP_DECRYPTFINAL_EX, 0),

     "EVP_DecryptFinal_ex"},

    {ERR_PACK(ERR_LIB_EVP, EVP_F_EVP_DECRYPTUPDATE, 0), "EVP_DecryptUpdate"},

    {ERR_PACK(ERR_LIB_EVP, EVP_F_EVP_DIGESTFINALXOF, 0), "EVP_DigestFinalXOF"},

    {ERR_PACK(ERR_LIB_EVP, EVP_F_EVP_DIGESTINIT_EX, 0), "EVP_DigestInit_ex"},

    {ERR_PACK(ERR_LIB_EVP, EVP_F_EVP_ENCRYPTFINAL_EX, 0),

     "EVP_EncryptFinal_ex"},
@@ -179,6 +180,8 @@ static const ERR_STRING_DATA EVP_str_reasons[] = { 
    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_METHOD_NOT_SUPPORTED),

    "method not supported"},

    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_MISSING_PARAMETERS), "missing parameters"},

    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_NOT_XOF_OR_INVALID_LENGTH),

    "not XOF or invalid length"},

    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_NO_CIPHER_SET), "no cipher set"},

    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_NO_DEFAULT_DIGEST), "no default digest"},

    {ERR_PACK(ERR_LIB_EVP, 0, EVP_R_NO_DIGEST_SET), "no digest set"},

doc/man3/EVP_DigestInit.pod

+11 −3
Original line number Diff line number Diff line
@@ -3,9 +3,10 @@ 
=head1 NAME



EVP_MD_CTX_new, EVP_MD_CTX_reset, EVP_MD_CTX_free, EVP_MD_CTX_copy_ex,

EVP_MD_CTX_ctrl, EVP_DigestInit_ex, EVP_DigestUpdate, EVP_DigestFinal_ex,

EVP_DigestInit, EVP_DigestFinal, EVP_MD_CTX_copy, EVP_MD_type,

EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size,

EVP_MD_CTX_ctrl, EVP_DigestInit_ex, EVP_DigestInit, EVP_DigestUpdate,

EVP_DigestFinal_ex, EVP_DigestFinalXOF, EVP_DigestFinal,

EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size,

EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size,

EVP_MD_CTX_block_size, EVP_MD_CTX_type, EVP_md_null, EVP_md2, EVP_md5, EVP_sha1,

EVP_sha224, EVP_sha256, EVP_sha384, EVP_sha512, EVP_sha3_224, EVP_sha3_256,

EVP_sha3_384, EVP_sha3_512, EVP_mdc2, EVP_ripemd160, EVP_blake2b512,
@@ -24,6 +25,7 @@ EVP_get_digestbyobj - EVP digest routines 
 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);

 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);

 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);

 int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t len);



 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
@@ -97,6 +99,12 @@ After calling EVP_DigestFinal_ex() no additional calls to EVP_DigestUpdate() 
can be made, but EVP_DigestInit_ex() can be called to initialize a new

digest operation.



EVP_DigestFinalXOF() interfaces to extendable-output functions, XOFs,

such as SHAKE128 and SHAKE256. It retrieves the digest value from

B<ctx> and places it in B<len>-sized <B>md. After calling this function

no additional calls to EVP_DigestUpdate() can be made, but

EVP_DigestInit_ex() can be called to initialize a new operation.



EVP_MD_CTX_copy_ex() can be used to copy the message digest state from

B<in> to B<out>. This is useful if large amounts of data are to be

hashed which only differ in the last few bytes. B<out> must be initialized

include/openssl/evp.h

+6 −0
Original line number Diff line number Diff line
@@ -109,6 +109,9 @@ int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd, 
/* digest can only handle a single block */

#  define EVP_MD_FLAG_ONESHOT     0x0001



/* digest is extensible-output function, XOF */

#  define EVP_MD_FLAG_XOF         0x0002



/* DigestAlgorithmIdentifier flags... */



#  define EVP_MD_FLAG_DIGALGID_MASK               0x0018
@@ -132,6 +135,7 @@ int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd, 


#  define EVP_MD_CTRL_DIGALGID                    0x1

#  define EVP_MD_CTRL_MICALG                      0x2

#  define EVP_MD_CTRL_XOF_LEN                     0x3



/* Minimum Algorithm specific ctrl value */
@@ -546,6 +550,8 @@ __owur int EVP_MD_CTX_copy(EVP_MD_CTX *out, const EVP_MD_CTX *in); 
__owur int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);

__owur int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,

                           unsigned int *s);

__owur int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md,

                              size_t len);



int EVP_read_pw_string(char *buf, int length, const char *prompt, int verify);

int EVP_read_pw_string_min(char *buf, int minlen, int maxlen,