crypto/asn1/p5_scrypt.c - third_party/openssl - Git at Google

 /*
  * Copyright 2015-2021 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 <stdio.h>
 #include "internal/cryptlib.h"
 #include <openssl/asn1t.h>
 #include <openssl/core_names.h>
 #include <openssl/err.h>
 #include <openssl/evp.h>
 #include <openssl/x509.h>
 #include <openssl/rand.h>
 #include "crypto/evp.h"

 #ifndef OPENSSL_NO_SCRYPT
 /* PKCS#5 scrypt password based encryption structures */

 ASN1_SEQUENCE(SCRYPT_PARAMS) = {
         ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING),
         ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER),
         ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER),
         ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER),
         ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER),
 } ASN1_SEQUENCE_END(SCRYPT_PARAMS)

 IMPLEMENT_ASN1_FUNCTIONS(SCRYPT_PARAMS)

 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
                                     size_t keylen, uint64_t N, uint64_t r,
                                     uint64_t p);

 /*
  * Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt
  */

 X509_ALGOR *PKCS5_pbe2_set_scrypt(const EVP_CIPHER *cipher,
                                   const unsigned char *salt, int saltlen,
                                   unsigned char *aiv, uint64_t N, uint64_t r,
                                   uint64_t p)
 {
     X509_ALGOR *scheme = NULL, *ret = NULL;
     int alg_nid;
     size_t keylen = 0;
     EVP_CIPHER_CTX *ctx = NULL;
     unsigned char iv[EVP_MAX_IV_LENGTH];
     PBE2PARAM *pbe2 = NULL;

     if (!cipher) {
         ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER);
         goto err;
     }

     if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
         ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_SCRYPT_PARAMETERS);
         goto err;
     }

     alg_nid = EVP_CIPHER_get_type(cipher);
     if (alg_nid == NID_undef) {
         ERR_raise(ERR_LIB_ASN1, ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
         goto err;
     }

     pbe2 = PBE2PARAM_new();
     if (pbe2 == NULL)
         goto merr;

     /* Setup the AlgorithmIdentifier for the encryption scheme */
     scheme = pbe2->encryption;

     scheme->algorithm = OBJ_nid2obj(alg_nid);
     scheme->parameter = ASN1_TYPE_new();
     if (scheme->parameter == NULL)
         goto merr;

     /* Create random IV */
     if (EVP_CIPHER_get_iv_length(cipher)) {
         if (aiv)
             memcpy(iv, aiv, EVP_CIPHER_get_iv_length(cipher));
         else if (RAND_bytes(iv, EVP_CIPHER_get_iv_length(cipher)) <= 0)
             goto err;
     }

     ctx = EVP_CIPHER_CTX_new();
     if (ctx == NULL)
         goto merr;

     /* Dummy cipherinit to just setup the IV */
     if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0) == 0)
         goto err;
     if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) {
         ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
         goto err;
     }
     EVP_CIPHER_CTX_free(ctx);
     ctx = NULL;

     /* If its RC2 then we'd better setup the key length */

     if (alg_nid == NID_rc2_cbc)
         keylen = EVP_CIPHER_get_key_length(cipher);

     /* Setup keyfunc */

     X509_ALGOR_free(pbe2->keyfunc);

     pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);

     if (pbe2->keyfunc == NULL)
         goto merr;

     /* Now set up top level AlgorithmIdentifier */

     ret = X509_ALGOR_new();
     if (ret == NULL)
         goto merr;

     ret->algorithm = OBJ_nid2obj(NID_pbes2);

     /* Encode PBE2PARAM into parameter */

     if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
                                 &ret->parameter) == NULL)
         goto merr;

     PBE2PARAM_free(pbe2);
     pbe2 = NULL;

     return ret;

  merr:
     ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);

  err:
     PBE2PARAM_free(pbe2);
     X509_ALGOR_free(ret);
     EVP_CIPHER_CTX_free(ctx);

     return NULL;
 }

 static X509_ALGOR *pkcs5_scrypt_set(const unsigned char *salt, size_t saltlen,
                                     size_t keylen, uint64_t N, uint64_t r,
                                     uint64_t p)
 {
     X509_ALGOR *keyfunc = NULL;
     SCRYPT_PARAMS *sparam = SCRYPT_PARAMS_new();

     if (sparam == NULL)
         goto merr;

     if (!saltlen)
         saltlen = PKCS5_SALT_LEN;

     /* This will either copy salt or grow the buffer */
     if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0)
         goto merr;

     if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
         goto err;

     if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0)
         goto merr;

     if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0)
         goto merr;

     if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0)
         goto merr;

     /* If have a key len set it up */

     if (keylen > 0) {
         sparam->keyLength = ASN1_INTEGER_new();
         if (sparam->keyLength == NULL)
             goto merr;
         if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0)
             goto merr;
     }

     /* Finally setup the keyfunc structure */

     keyfunc = X509_ALGOR_new();
     if (keyfunc == NULL)
         goto merr;

     keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);

     /* Encode SCRYPT_PARAMS into parameter of pbe2 */

     if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
                                 &keyfunc->parameter) == NULL)
         goto merr;

     SCRYPT_PARAMS_free(sparam);
     return keyfunc;

  merr:
     ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
  err:
     SCRYPT_PARAMS_free(sparam);
     X509_ALGOR_free(keyfunc);
     return NULL;
 }

 int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX *ctx, const char *pass,
                                 int passlen, ASN1_TYPE *param,
                                 const EVP_CIPHER *c, const EVP_MD *md, int en_de,
                                 OSSL_LIB_CTX *libctx, const char *propq)
 {
     unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
     uint64_t p, r, N;
     size_t saltlen;
     size_t keylen = 0;
     int t, rv = 0;
     SCRYPT_PARAMS *sparam = NULL;

     if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) {
         ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
         goto err;
     }

     /* Decode parameter */

     sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);

     if (sparam == NULL) {
         ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR);
         goto err;
     }

     t = EVP_CIPHER_CTX_get_key_length(ctx);
     if (t < 0) {
         ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH);
         goto err;
     }
     keylen = t;

     /* Now check the parameters of sparam */

     if (sparam->keyLength) {
         uint64_t spkeylen;
         if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
             || (spkeylen != keylen)) {
             ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH);
             goto err;
         }
     }
     /* Check all parameters fit in uint64_t and are acceptable to scrypt */
     if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
         || ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
         || ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
         || EVP_PBE_scrypt_ex(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0,
                              libctx, propq) == 0) {
         ERR_raise(ERR_LIB_EVP, EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
         goto err;
     }

     /* it seems that its all OK */

     salt = sparam->salt->data;
     saltlen = sparam->salt->length;
     if (EVP_PBE_scrypt_ex(pass, passlen, salt, saltlen, N, r, p, 0, key,
                           keylen, libctx, propq) == 0)
         goto err;
     rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
  err:
     if (keylen)
         OPENSSL_cleanse(key, keylen);
     SCRYPT_PARAMS_free(sparam);
     return rv;
 }

 int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass,
                              int passlen, ASN1_TYPE *param,
                              const EVP_CIPHER *c, const EVP_MD *md, int en_de)
 {
     return PKCS5_v2_scrypt_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL);
 }

 #endif /* OPENSSL_NO_SCRYPT */
	/*
	* Copyright 2015-2021 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 <stdio.h>
	#include "internal/cryptlib.h"
	#include <openssl/asn1t.h>
	#include <openssl/core_names.h>
	#include <openssl/err.h>
	#include <openssl/evp.h>
	#include <openssl/x509.h>
	#include <openssl/rand.h>
	#include "crypto/evp.h"

	#ifndef OPENSSL_NO_SCRYPT
	/* PKCS#5 scrypt password based encryption structures */

	ASN1_SEQUENCE(SCRYPT_PARAMS) = {
	ASN1_SIMPLE(SCRYPT_PARAMS, salt, ASN1_OCTET_STRING),
	ASN1_SIMPLE(SCRYPT_PARAMS, costParameter, ASN1_INTEGER),
	ASN1_SIMPLE(SCRYPT_PARAMS, blockSize, ASN1_INTEGER),
	ASN1_SIMPLE(SCRYPT_PARAMS, parallelizationParameter, ASN1_INTEGER),
	ASN1_OPT(SCRYPT_PARAMS, keyLength, ASN1_INTEGER),
	} ASN1_SEQUENCE_END(SCRYPT_PARAMS)

	IMPLEMENT_ASN1_FUNCTIONS(SCRYPT_PARAMS)

	static X509_ALGOR pkcs5_scrypt_set(const unsigned char salt, size_t saltlen,
	size_t keylen, uint64_t N, uint64_t r,
	uint64_t p);

	/*
	* Return an algorithm identifier for a PKCS#5 v2.0 PBE algorithm using scrypt
	*/

	X509_ALGOR PKCS5_pbe2_set_scrypt(const EVP_CIPHER cipher,
	const unsigned char *salt, int saltlen,
	unsigned char *aiv, uint64_t N, uint64_t r,
	uint64_t p)
	{
	X509_ALGOR scheme = NULL, ret = NULL;
	int alg_nid;
	size_t keylen = 0;
	EVP_CIPHER_CTX *ctx = NULL;
	unsigned char iv[EVP_MAX_IV_LENGTH];
	PBE2PARAM *pbe2 = NULL;

	if (!cipher) {
	ERR_raise(ERR_LIB_ASN1, ERR_R_PASSED_NULL_PARAMETER);
	goto err;
	}

	if (EVP_PBE_scrypt(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0) == 0) {
	ERR_raise(ERR_LIB_ASN1, ASN1_R_INVALID_SCRYPT_PARAMETERS);
	goto err;
	}

	alg_nid = EVP_CIPHER_get_type(cipher);
	if (alg_nid == NID_undef) {
	ERR_raise(ERR_LIB_ASN1, ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER);
	goto err;
	}

	pbe2 = PBE2PARAM_new();
	if (pbe2 == NULL)
	goto merr;

	/* Setup the AlgorithmIdentifier for the encryption scheme */
	scheme = pbe2->encryption;

	scheme->algorithm = OBJ_nid2obj(alg_nid);
	scheme->parameter = ASN1_TYPE_new();
	if (scheme->parameter == NULL)
	goto merr;

	/* Create random IV */
	if (EVP_CIPHER_get_iv_length(cipher)) {
	if (aiv)
	memcpy(iv, aiv, EVP_CIPHER_get_iv_length(cipher));
	else if (RAND_bytes(iv, EVP_CIPHER_get_iv_length(cipher)) <= 0)
	goto err;
	}

	ctx = EVP_CIPHER_CTX_new();
	if (ctx == NULL)
	goto merr;

	/* Dummy cipherinit to just setup the IV */
	if (EVP_CipherInit_ex(ctx, cipher, NULL, NULL, iv, 0) == 0)
	goto err;
	if (EVP_CIPHER_param_to_asn1(ctx, scheme->parameter) <= 0) {
	ERR_raise(ERR_LIB_ASN1, ASN1_R_ERROR_SETTING_CIPHER_PARAMS);
	goto err;
	}
	EVP_CIPHER_CTX_free(ctx);
	ctx = NULL;

	/* If its RC2 then we'd better setup the key length */

	if (alg_nid == NID_rc2_cbc)
	keylen = EVP_CIPHER_get_key_length(cipher);

	/* Setup keyfunc */

	X509_ALGOR_free(pbe2->keyfunc);

	pbe2->keyfunc = pkcs5_scrypt_set(salt, saltlen, keylen, N, r, p);

	if (pbe2->keyfunc == NULL)
	goto merr;

	/* Now set up top level AlgorithmIdentifier */

	ret = X509_ALGOR_new();
	if (ret == NULL)
	goto merr;

	ret->algorithm = OBJ_nid2obj(NID_pbes2);

	/* Encode PBE2PARAM into parameter */

	if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(PBE2PARAM), pbe2,
	&ret->parameter) == NULL)
	goto merr;

	PBE2PARAM_free(pbe2);
	pbe2 = NULL;

	return ret;

	merr:
	ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);

	err:
	PBE2PARAM_free(pbe2);
	X509_ALGOR_free(ret);
	EVP_CIPHER_CTX_free(ctx);

	return NULL;
	}

	static X509_ALGOR pkcs5_scrypt_set(const unsigned char salt, size_t saltlen,
	size_t keylen, uint64_t N, uint64_t r,
	uint64_t p)
	{
	X509_ALGOR *keyfunc = NULL;
	SCRYPT_PARAMS *sparam = SCRYPT_PARAMS_new();

	if (sparam == NULL)
	goto merr;

	if (!saltlen)
	saltlen = PKCS5_SALT_LEN;

	/* This will either copy salt or grow the buffer */
	if (ASN1_STRING_set(sparam->salt, salt, saltlen) == 0)
	goto merr;

	if (salt == NULL && RAND_bytes(sparam->salt->data, saltlen) <= 0)
	goto err;

	if (ASN1_INTEGER_set_uint64(sparam->costParameter, N) == 0)
	goto merr;

	if (ASN1_INTEGER_set_uint64(sparam->blockSize, r) == 0)
	goto merr;

	if (ASN1_INTEGER_set_uint64(sparam->parallelizationParameter, p) == 0)
	goto merr;

	/* If have a key len set it up */

	if (keylen > 0) {
	sparam->keyLength = ASN1_INTEGER_new();
	if (sparam->keyLength == NULL)
	goto merr;
	if (ASN1_INTEGER_set_int64(sparam->keyLength, keylen) == 0)
	goto merr;
	}

	/* Finally setup the keyfunc structure */

	keyfunc = X509_ALGOR_new();
	if (keyfunc == NULL)
	goto merr;

	keyfunc->algorithm = OBJ_nid2obj(NID_id_scrypt);

	/* Encode SCRYPT_PARAMS into parameter of pbe2 */

	if (ASN1_TYPE_pack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), sparam,
	&keyfunc->parameter) == NULL)
	goto merr;

	SCRYPT_PARAMS_free(sparam);
	return keyfunc;

	merr:
	ERR_raise(ERR_LIB_ASN1, ERR_R_MALLOC_FAILURE);
	err:
	SCRYPT_PARAMS_free(sparam);
	X509_ALGOR_free(keyfunc);
	return NULL;
	}

	int PKCS5_v2_scrypt_keyivgen_ex(EVP_CIPHER_CTX ctx, const char pass,
	int passlen, ASN1_TYPE *param,
	const EVP_CIPHER c, const EVP_MD md, int en_de,
	OSSL_LIB_CTX libctx, const char propq)
	{
	unsigned char *salt, key[EVP_MAX_KEY_LENGTH];
	uint64_t p, r, N;
	size_t saltlen;
	size_t keylen = 0;
	int t, rv = 0;
	SCRYPT_PARAMS *sparam = NULL;

	if (EVP_CIPHER_CTX_get0_cipher(ctx) == NULL) {
	ERR_raise(ERR_LIB_EVP, EVP_R_NO_CIPHER_SET);
	goto err;
	}

	/* Decode parameter */

	sparam = ASN1_TYPE_unpack_sequence(ASN1_ITEM_rptr(SCRYPT_PARAMS), param);

	if (sparam == NULL) {
	ERR_raise(ERR_LIB_EVP, EVP_R_DECODE_ERROR);
	goto err;
	}

	t = EVP_CIPHER_CTX_get_key_length(ctx);
	if (t < 0) {
	ERR_raise(ERR_LIB_EVP, EVP_R_INVALID_KEY_LENGTH);
	goto err;
	}
	keylen = t;

	/* Now check the parameters of sparam */

	if (sparam->keyLength) {
	uint64_t spkeylen;
	if ((ASN1_INTEGER_get_uint64(&spkeylen, sparam->keyLength) == 0)
	\|\| (spkeylen != keylen)) {
	ERR_raise(ERR_LIB_EVP, EVP_R_UNSUPPORTED_KEYLENGTH);
	goto err;
	}
	}
	/* Check all parameters fit in uint64_t and are acceptable to scrypt */
	if (ASN1_INTEGER_get_uint64(&N, sparam->costParameter) == 0
	\|\| ASN1_INTEGER_get_uint64(&r, sparam->blockSize) == 0
	\|\| ASN1_INTEGER_get_uint64(&p, sparam->parallelizationParameter) == 0
	\|\| EVP_PBE_scrypt_ex(NULL, 0, NULL, 0, N, r, p, 0, NULL, 0,
	libctx, propq) == 0) {
	ERR_raise(ERR_LIB_EVP, EVP_R_ILLEGAL_SCRYPT_PARAMETERS);
	goto err;
	}

	/* it seems that its all OK */

	salt = sparam->salt->data;
	saltlen = sparam->salt->length;
	if (EVP_PBE_scrypt_ex(pass, passlen, salt, saltlen, N, r, p, 0, key,
	keylen, libctx, propq) == 0)
	goto err;
	rv = EVP_CipherInit_ex(ctx, NULL, NULL, key, NULL, en_de);
	err:
	if (keylen)
	OPENSSL_cleanse(key, keylen);
	SCRYPT_PARAMS_free(sparam);
	return rv;
	}

	int PKCS5_v2_scrypt_keyivgen(EVP_CIPHER_CTX ctx, const char pass,
	int passlen, ASN1_TYPE *param,
	const EVP_CIPHER c, const EVP_MD md, int en_de)
	{
	return PKCS5_v2_scrypt_keyivgen_ex(ctx, pass, passlen, param, c, md, en_de, NULL, NULL);
	}

	#endif /* OPENSSL_NO_SCRYPT */