2 * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* Dispatch functions for RC4_HMAC_MD5 cipher */
13 * MD5 and RC4 low level APIs are deprecated for public use, but still ok for
16 #include "internal/deprecated.h"
18 #include "cipher_rc4_hmac_md5.h"
19 #include "prov/implementations.h"
20 #include "prov/providercommon.h"
21 #include "prov/providercommonerr.h"
23 /* TODO(3.0) Figure out what flags are required */
24 #define RC4_HMAC_MD5_FLAGS (EVP_CIPH_STREAM_CIPHER | EVP_CIPH_VARIABLE_LENGTH \
25 | EVP_CIPH_FLAG_AEAD_CIPHER)
27 #define RC4_HMAC_MD5_KEY_BITS (16 * 8)
28 #define RC4_HMAC_MD5_BLOCK_BITS (1 * 8)
29 #define RC4_HMAC_MD5_IV_BITS 0
30 #define RC4_HMAC_MD5_MODE 0
32 #define GET_HW(ctx) ((PROV_CIPHER_HW_RC4_HMAC_MD5 *)ctx->base.hw)
34 static OSSL_FUNC_cipher_newctx_fn rc4_hmac_md5_newctx;
35 static OSSL_FUNC_cipher_freectx_fn rc4_hmac_md5_freectx;
36 static OSSL_FUNC_cipher_get_ctx_params_fn rc4_hmac_md5_get_ctx_params;
37 static OSSL_FUNC_cipher_gettable_ctx_params_fn rc4_hmac_md5_gettable_ctx_params;
38 static OSSL_FUNC_cipher_set_ctx_params_fn rc4_hmac_md5_set_ctx_params;
39 static OSSL_FUNC_cipher_settable_ctx_params_fn rc4_hmac_md5_settable_ctx_params;
40 static OSSL_FUNC_cipher_get_params_fn rc4_hmac_md5_get_params;
41 #define rc4_hmac_md5_gettable_params cipher_generic_gettable_params
42 #define rc4_hmac_md5_einit cipher_generic_einit
43 #define rc4_hmac_md5_dinit cipher_generic_dinit
44 #define rc4_hmac_md5_update cipher_generic_stream_update
45 #define rc4_hmac_md5_final cipher_generic_stream_final
46 #define rc4_hmac_md5_cipher cipher_generic_cipher
48 static void *rc4_hmac_md5_newctx(void *provctx)
50 PROV_RC4_HMAC_MD5_CTX *ctx;
52 if (!ossl_prov_is_running())
55 ctx = OPENSSL_zalloc(sizeof(*ctx));
57 cipher_generic_initkey(ctx, RC4_HMAC_MD5_KEY_BITS,
58 RC4_HMAC_MD5_BLOCK_BITS,
60 RC4_HMAC_MD5_MODE, RC4_HMAC_MD5_FLAGS,
61 PROV_CIPHER_HW_rc4_hmac_md5(RC4_HMAC_MD5_KEY_BITS),
66 static void rc4_hmac_md5_freectx(void *vctx)
68 PROV_RC4_HMAC_MD5_CTX *ctx = (PROV_RC4_HMAC_MD5_CTX *)vctx;
70 cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
71 OPENSSL_clear_free(ctx, sizeof(*ctx));
74 static const OSSL_PARAM rc4_hmac_md5_known_gettable_ctx_params[] = {
75 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
76 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
77 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
80 const OSSL_PARAM *rc4_hmac_md5_gettable_ctx_params(ossl_unused void *provctx)
82 return rc4_hmac_md5_known_gettable_ctx_params;
85 static int rc4_hmac_md5_get_ctx_params(void *vctx, OSSL_PARAM params[])
87 PROV_RC4_HMAC_MD5_CTX *ctx = (PROV_RC4_HMAC_MD5_CTX *)vctx;
90 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
91 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.keylen)) {
92 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
96 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
97 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->base.ivlen)) {
98 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
101 p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD);
102 if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) {
103 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
109 static const OSSL_PARAM rc4_hmac_md5_known_settable_ctx_params[] = {
110 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
111 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
112 OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
115 const OSSL_PARAM *rc4_hmac_md5_settable_ctx_params(ossl_unused void *provctx)
117 return rc4_hmac_md5_known_settable_ctx_params;
120 static int rc4_hmac_md5_set_ctx_params(void *vctx, const OSSL_PARAM params[])
122 PROV_RC4_HMAC_MD5_CTX *ctx = (PROV_RC4_HMAC_MD5_CTX *)vctx;
126 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
128 if (!OSSL_PARAM_get_size_t(p, &sz)) {
129 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
132 if (ctx->base.keylen != sz) {
133 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
138 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_IVLEN);
140 if (!OSSL_PARAM_get_size_t(p, &sz)) {
141 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
144 if (ctx->base.ivlen != sz) {
145 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
150 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
152 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
153 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
156 sz = GET_HW(ctx)->tls_init(&ctx->base, p->data, p->data_size);
158 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
161 ctx->tls_aad_pad_sz = sz;
163 p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
165 if (p->data_type != OSSL_PARAM_OCTET_STRING) {
166 ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
169 GET_HW(ctx)->init_mackey(&ctx->base, p->data, p->data_size);
174 static int rc4_hmac_md5_get_params(OSSL_PARAM params[])
176 return cipher_generic_get_params(params, RC4_HMAC_MD5_MODE,
178 RC4_HMAC_MD5_KEY_BITS,
179 RC4_HMAC_MD5_BLOCK_BITS,
180 RC4_HMAC_MD5_IV_BITS);
183 const OSSL_DISPATCH ossl_rc4_hmac_ossl_md5_functions[] = {
184 { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))rc4_hmac_md5_newctx },
185 { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))rc4_hmac_md5_freectx },
186 { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))rc4_hmac_md5_einit },
187 { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))rc4_hmac_md5_dinit },
188 { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))rc4_hmac_md5_update },
189 { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))rc4_hmac_md5_final },
190 { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))rc4_hmac_md5_cipher },
191 { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void))rc4_hmac_md5_get_params },
192 { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
193 (void (*)(void))rc4_hmac_md5_gettable_params },
194 { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,
195 (void (*)(void))rc4_hmac_md5_get_ctx_params },
196 { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
197 (void (*)(void))rc4_hmac_md5_gettable_ctx_params },
198 { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,
199 (void (*)(void))rc4_hmac_md5_set_ctx_params },
200 { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
201 (void (*)(void))rc4_hmac_md5_settable_ctx_params },