summaryrefslogtreecommitdiffstats
path: root/doc/internal/man3/ossl_method_construct.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-06-07 11:44:08 +0200
committerRichard Levitte <levitte@openssl.org>2019-06-10 08:01:19 +0200
commit2ccb1b4ecab2c3ac1dc2ff81a48869a79afa7839 (patch)
tree6099885735867271e674fb4108203b084280dbc1 /doc/internal/man3/ossl_method_construct.pod
parenta08714e18131b1998faa0113e5bd4024044654ac (diff)
EVP fetching: make operation_id part of the method identity
Because the operation identity wasn't integrated with the created methods, the following code would give unexpected results: EVP_MD *md = EVP_MD_fetch(NULL, "MD5", NULL); EVP_CIPHER *cipher = EVP_CIPHER_fetch(NULL, "MD5", NULL); if (md != NULL) printf("MD5 is a digest\n"); if (cipher != NULL) printf("MD5 is a cipher\n"); The message is that MD5 is both a digest and a cipher. Partially fixes #9106 Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/9109)
Diffstat (limited to 'doc/internal/man3/ossl_method_construct.pod')
-rw-r--r--doc/internal/man3/ossl_method_construct.pod37
1 files changed, 26 insertions, 11 deletions
diff --git a/doc/internal/man3/ossl_method_construct.pod b/doc/internal/man3/ossl_method_construct.pod
index 60de260e4a..02ccc17574 100644
--- a/doc/internal/man3/ossl_method_construct.pod
+++ b/doc/internal/man3/ossl_method_construct.pod
@@ -15,11 +15,13 @@ OSSL_METHOD_CONSTRUCT_METHOD, ossl_method_construct
/* Remove a store */
void (*dealloc_tmp_store)(void *store);
/* Get an already existing method from a store */
- void *(*get)(OPENSSL_CTX *libctx, void *store, const char *name,
- const char *propquery, void *data);
+ void *(*get)(OPENSSL_CTX *libctx, void *store,
+ int operation_id, const char *name, const char *propquery,
+ void *data);
/* Store a method in a store */
int (*put)(OPENSSL_CTX *libctx, void *store, void *method,
- const char *name, const char *propdef, void *data);
+ int operation_id, const char *name, const char *propdef,
+ void *data);
/* Construct a new method */
void *(*construct)(const char *name, const OSSL_DISPATCH *fns,
OSSL_PROVIDER *prov, void *data);
@@ -41,11 +43,23 @@ on provider dispatch tables need to do so in exactly the same way.
ossl_method_construct() does this while leaving it to the sub-systems
to define more precisely how the methods are created, stored, etc.
+It's important to keep in mind that a method is identified by three things:
+
+=over 4
+
+=item The operation identity
+
+=item The name of the algorithm
+
+=item The properties associated with the algorithm implementation
+
+=back
+
=head2 Functions
ossl_method_construct() creates a method by asking all available
providers for a dispatch table given an C<operation_id>, an algorithm
-C<name> and a set of C<properties>, and then calling appropriate
+C<name> and a set of C<properties>, and then calling the appropriate
functions given by the sub-system specific method creator through
C<mcm> and the data in C<mcm_data> (which is passed by
ossl_method_construct()).
@@ -84,10 +98,10 @@ B<NULL> is a valid value and means that a sub-system default store
must be used.
This default store should be stored in the library context C<libctx>.
-The method to be looked up should be identified with the given C<name> and
-data from C<data>
-(which is the C<mcm_data> that was passed to ossl_construct_method())
-and the provided property query C<propquery>.
+The method to be looked up should be identified with the given
+C<operation_id>, C<name>, the provided property query C<propquery>
+and data from C<data> (which is the C<mcm_data> that was passed to
+ossl_construct_method()).
This function is expected to increment the method's reference count.
@@ -101,9 +115,10 @@ B<NULL> is a valid value and means that a sub-system default store
must be used.
This default store should be stored in the library context C<libctx>.
-The method should be associated with the given C<name> and property definition
-C<propdef> as well as any identification data given through C<data> (which is
-the C<mcm_data> that was passed to ossl_construct_method()).
+The method should be associated with the given C<operation_id>,
+C<name> and property definition C<propdef> as well as any
+identification data given through C<data> (which is the C<mcm_data>
+that was passed to ossl_construct_method()).
This function is expected to increment the C<method>'s reference count.