2 * Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
11 * CRMF implementation by Martin Peylo, Miikka Viljanen, and David von Oheimb.
17 #include <openssl/rand.h>
18 #include <openssl/evp.h>
22 /* explicit #includes not strictly needed since implied by the above: */
23 #include <openssl/asn1t.h>
24 #include <openssl/crmf.h>
25 #include <openssl/err.h>
26 #include <openssl/evp.h>
27 #include <openssl/params.h>
28 #include <openssl/core_names.h>
31 * creates and initializes OSSL_CRMF_PBMPARAMETER (section 4.4)
32 * |slen| SHOULD be > 8 (16 is common)
33 * |owfnid| e.g., NID_sha256
34 * |itercnt| MUST be > 100 (500 is common)
35 * |macnid| e.g., NID_hmac_sha1
36 * returns pointer to OSSL_CRMF_PBMPARAMETER on success, NULL on error
38 OSSL_CRMF_PBMPARAMETER
*OSSL_CRMF_pbmp_new(size_t slen
, int owfnid
,
39 int itercnt
, int macnid
)
41 OSSL_CRMF_PBMPARAMETER
*pbm
= NULL
;
42 unsigned char *salt
= NULL
;
44 if ((pbm
= OSSL_CRMF_PBMPARAMETER_new()) == NULL
) {
45 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, ERR_R_MALLOC_FAILURE
);
50 * salt contains a randomly generated value used in computing the key
51 * of the MAC process. The salt SHOULD be at least 8 octets (64
54 if ((salt
= OPENSSL_malloc(slen
)) == NULL
) {
55 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, ERR_R_MALLOC_FAILURE
);
58 if (RAND_bytes(salt
, (int)slen
) <= 0) {
59 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, CRMF_R_FAILURE_OBTAINING_RANDOM
);
62 if (!ASN1_OCTET_STRING_set(pbm
->salt
, salt
, (int)slen
))
66 * owf identifies the hash algorithm and associated parameters used to
67 * compute the key used in the MAC process. All implementations MUST
70 if (!X509_ALGOR_set0(pbm
->owf
, OBJ_nid2obj(owfnid
), V_ASN1_UNDEF
, NULL
)) {
71 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, CRMF_R_SETTING_OWF_ALGOR_FAILURE
);
76 * iterationCount identifies the number of times the hash is applied
77 * during the key computation process. The iterationCount MUST be a
78 * minimum of 100. Many people suggest using values as high as 1000
79 * iterations as the minimum value. The trade off here is between
80 * protection of the password from attacks and the time spent by the
81 * server processing all of the different iterations in deriving
82 * passwords. Hashing is generally considered a cheap operation but
83 * this may not be true with all hash functions in the future.
86 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, CRMF_R_ITERATIONCOUNT_BELOW_100
);
90 if (!ASN1_INTEGER_set(pbm
->iterationCount
, itercnt
)) {
91 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, CRMF_R_CRMFERROR
);
96 * mac identifies the algorithm and associated parameters of the MAC
97 * function to be used. All implementations MUST support HMAC-SHA1 [HMAC].
98 * All implementations SHOULD support DES-MAC and Triple-DES-MAC [PKCS11].
100 if (!X509_ALGOR_set0(pbm
->mac
, OBJ_nid2obj(macnid
), V_ASN1_UNDEF
, NULL
)) {
101 CRMFerr(CRMF_F_OSSL_CRMF_PBMP_NEW
, CRMF_R_SETTING_MAC_ALGOR_FAILURE
);
109 OSSL_CRMF_PBMPARAMETER_free(pbm
);
114 * calculates the PBM based on the settings of the given OSSL_CRMF_PBMPARAMETER
115 * |pbmp| identifies the algorithms, salt to use
116 * |msg| message to apply the PBM for
117 * |msglen| length of the message
119 * |seclen| length of the key
120 * |mac| pointer to the computed mac, will be set on success
121 * |maclen| if not NULL, will set variable to the length of the mac on success
122 * returns 1 on success, 0 on error
124 int OSSL_CRMF_pbm_new(const OSSL_CRMF_PBMPARAMETER
*pbmp
,
125 const unsigned char *msg
, size_t msglen
,
126 const unsigned char *sec
, size_t seclen
,
127 unsigned char **out
, size_t *outlen
)
129 int mac_nid
, hmac_md_nid
= NID_undef
;
130 const char *mdname
= NULL
;
131 const EVP_MD
*m
= NULL
;
132 EVP_MD_CTX
*ctx
= NULL
;
133 unsigned char basekey
[EVP_MAX_MD_SIZE
];
134 unsigned int bklen
= EVP_MAX_MD_SIZE
;
136 unsigned char *mac_res
= 0;
139 EVP_MAC_CTX
*mctx
= NULL
;
140 OSSL_PARAM macparams
[3] =
141 { OSSL_PARAM_END
, OSSL_PARAM_END
, OSSL_PARAM_END
};
143 if (out
== NULL
|| pbmp
== NULL
|| pbmp
->mac
== NULL
144 || pbmp
->mac
->algorithm
== NULL
|| msg
== NULL
|| sec
== NULL
) {
145 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, CRMF_R_NULL_ARGUMENT
);
148 if ((mac_res
= OPENSSL_malloc(EVP_MAX_MD_SIZE
)) == NULL
) {
149 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, ERR_R_MALLOC_FAILURE
);
154 * owf identifies the hash algorithm and associated parameters used to
155 * compute the key used in the MAC process. All implementations MUST
158 if ((m
= EVP_get_digestbyobj(pbmp
->owf
->algorithm
)) == NULL
) {
159 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, CRMF_R_UNSUPPORTED_ALGORITHM
);
163 if ((ctx
= EVP_MD_CTX_new()) == NULL
) {
164 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, ERR_R_MALLOC_FAILURE
);
168 /* compute the basekey of the salted secret */
169 if (!EVP_DigestInit_ex(ctx
, m
, NULL
))
171 /* first the secret */
172 if (!EVP_DigestUpdate(ctx
, sec
, seclen
))
175 if (!EVP_DigestUpdate(ctx
, pbmp
->salt
->data
, pbmp
->salt
->length
))
177 if (!EVP_DigestFinal_ex(ctx
, basekey
, &bklen
))
179 if (!ASN1_INTEGER_get_int64(&iterations
, pbmp
->iterationCount
)
180 || iterations
< 100 /* min from RFC */
181 || iterations
> OSSL_CRMF_PBM_MAX_ITERATION_COUNT
) {
182 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, CRMF_R_BAD_PBM_ITERATIONCOUNT
);
186 /* the first iteration was already done above */
187 while (--iterations
> 0) {
188 if (!EVP_DigestInit_ex(ctx
, m
, NULL
))
190 if (!EVP_DigestUpdate(ctx
, basekey
, bklen
))
192 if (!EVP_DigestFinal_ex(ctx
, basekey
, &bklen
))
197 * mac identifies the algorithm and associated parameters of the MAC
198 * function to be used. All implementations MUST support HMAC-SHA1 [HMAC].
199 * All implementations SHOULD support DES-MAC and Triple-DES-MAC [PKCS11].
201 mac_nid
= OBJ_obj2nid(pbmp
->mac
->algorithm
);
203 if (!EVP_PBE_find(EVP_PBE_TYPE_PRF
, mac_nid
, NULL
, &hmac_md_nid
, NULL
)
204 || ((mdname
= OBJ_nid2sn(hmac_md_nid
)) == NULL
)) {
205 CRMFerr(CRMF_F_OSSL_CRMF_PBM_NEW
, CRMF_R_UNSUPPORTED_ALGORITHM
);
210 OSSL_PARAM_construct_utf8_string(OSSL_MAC_PARAM_DIGEST
,
213 OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY
, basekey
, bklen
);
214 if ((mac
= EVP_MAC_fetch(NULL
, "HMAC", NULL
)) == NULL
215 || (mctx
= EVP_MAC_CTX_new(mac
)) == NULL
216 || !EVP_MAC_CTX_set_params(mctx
, macparams
)
217 || !EVP_MAC_init(mctx
)
218 || !EVP_MAC_update(mctx
, msg
, msglen
)
219 || !EVP_MAC_final(mctx
, mac_res
, outlen
, EVP_MAX_MD_SIZE
))
226 OPENSSL_cleanse(basekey
, bklen
);
227 EVP_MAC_CTX_free(mctx
);
229 EVP_MD_CTX_free(ctx
);
236 OPENSSL_free(mac_res
);
238 if (pbmp
!= NULL
&& pbmp
->mac
!= NULL
) {
241 if (OBJ_obj2txt(buf
, sizeof(buf
), pbmp
->mac
->algorithm
, 0))
242 ERR_add_error_data(1, buf
);