xref: /freebsd/sys/contrib/openzfs/module/icp/api/kcf_ctxops.c (revision 094517119c62c23369d545a7475ae982d86330a3)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #include <sys/zfs_context.h>
27 #include <sys/crypto/common.h>
28 #include <sys/crypto/impl.h>
29 #include <sys/crypto/api.h>
30 #include <sys/crypto/spi.h>
31 #include <sys/crypto/sched_impl.h>
32 
33 /*
34  * Crypto contexts manipulation routines
35  */
36 
37 /*
38  * crypto_create_ctx_template()
39  *
40  * Arguments:
41  *
42  *	mech:	crypto_mechanism_t pointer.
43  *		mech_type is a valid value previously returned by
44  *		crypto_mech2id();
45  *		When the mech's parameter is not NULL, its definition depends
46  *		on the standard definition of the mechanism.
47  *	key:	pointer to a crypto_key_t structure.
48  *	ptmpl:	a storage for the opaque crypto_ctx_template_t, allocated and
49  *		initialized by the software provider this routine is
50  *		dispatched to.
51  *
52  * Description:
53  *	Redirects the call to the software provider of the specified
54  *	mechanism. That provider will allocate and pre-compute/pre-expand
55  *	the context template, reusable by later calls to crypto_xxx_init().
56  *	The size and address of that provider context template are stored
57  *	in an internal structure, kcf_ctx_template_t. The address of that
58  *	structure is given back to the caller in *ptmpl.
59  *
60  * Context:
61  *	Process or interrupt.
62  *
63  * Returns:
64  *	CRYPTO_SUCCESS when the context template is successfully created.
65  *	CRYPTO_HOST_MEMORY: mem alloc failure
66  *	CRYPTO_ARGUMENTS_BAD: NULL storage for the ctx template.
67  *	RYPTO_MECHANISM_INVALID: invalid mechanism 'mech'.
68  */
69 int
70 crypto_create_ctx_template(crypto_mechanism_t *mech, crypto_key_t *key,
71     crypto_ctx_template_t *ptmpl)
72 {
73 	int error;
74 	kcf_mech_entry_t *me;
75 	kcf_provider_desc_t *pd;
76 	kcf_ctx_template_t *ctx_tmpl;
77 	crypto_mechanism_t prov_mech;
78 
79 	/* A few args validation */
80 
81 	if (ptmpl == NULL)
82 		return (CRYPTO_ARGUMENTS_BAD);
83 
84 	if (mech == NULL)
85 		return (CRYPTO_MECHANISM_INVALID);
86 
87 	error = kcf_get_sw_prov(mech->cm_type, &pd, &me, B_TRUE);
88 	if (error != CRYPTO_SUCCESS)
89 		return (error);
90 
91 	if ((ctx_tmpl = (kcf_ctx_template_t *)kmem_alloc(
92 	    sizeof (kcf_ctx_template_t), KM_SLEEP)) == NULL) {
93 		KCF_PROV_REFRELE(pd);
94 		return (CRYPTO_HOST_MEMORY);
95 	}
96 
97 	/* Pass a mechtype that the provider understands */
98 	prov_mech.cm_type = KCF_TO_PROV_MECHNUM(pd, mech->cm_type);
99 	prov_mech.cm_param = mech->cm_param;
100 	prov_mech.cm_param_len = mech->cm_param_len;
101 
102 	error = KCF_PROV_CREATE_CTX_TEMPLATE(pd, &prov_mech, key,
103 	    &(ctx_tmpl->ct_prov_tmpl), &(ctx_tmpl->ct_size));
104 
105 	if (error == CRYPTO_SUCCESS) {
106 		*ptmpl = ctx_tmpl;
107 	} else {
108 		kmem_free(ctx_tmpl, sizeof (kcf_ctx_template_t));
109 	}
110 	KCF_PROV_REFRELE(pd);
111 
112 	return (error);
113 }
114 
115 /*
116  * crypto_destroy_ctx_template()
117  *
118  * Arguments:
119  *
120  *	tmpl:	an opaque crypto_ctx_template_t previously created by
121  *		crypto_create_ctx_template()
122  *
123  * Description:
124  *	Frees the embedded crypto_spi_ctx_template_t, then the
125  *	kcf_ctx_template_t.
126  *
127  * Context:
128  *	Process or interrupt.
129  *
130  */
131 void
132 crypto_destroy_ctx_template(crypto_ctx_template_t tmpl)
133 {
134 	kcf_ctx_template_t *ctx_tmpl = (kcf_ctx_template_t *)tmpl;
135 
136 	if (ctx_tmpl == NULL)
137 		return;
138 
139 	ASSERT(ctx_tmpl->ct_prov_tmpl != NULL);
140 
141 	memset(ctx_tmpl->ct_prov_tmpl, 0, ctx_tmpl->ct_size);
142 	kmem_free(ctx_tmpl->ct_prov_tmpl, ctx_tmpl->ct_size);
143 	kmem_free(ctx_tmpl, sizeof (kcf_ctx_template_t));
144 }
145 
146 #if defined(_KERNEL)
147 EXPORT_SYMBOL(crypto_create_ctx_template);
148 EXPORT_SYMBOL(crypto_destroy_ctx_template);
149 #endif
150