mirror of
https://github.com/openssl/openssl.git
synced 2024-12-27 06:21:43 +08:00
c3e4c1f325
This adds a method OSSL_DESERIALIZER, a deserializer context and basic support to use a set of serializers to get a desired type of data, as well as deserializer chains. The idea is that the caller can call OSSL_DESERIALIZER_CTX_add_serializer() to set up the set of desired results, and to add possible chains, call OSSL_DESERIALIZER_CTX_add_extra(). All these deserializers are pushed on an internal stack. The actual deserialization is then performed using functions like OSSL_DESERIALIZER_from_bio(). When performing deserialization, the inernal stack is walked backwards, keeping track of the deserialized data and its type along the way, until the data kan be processed into the desired type of data. Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/12410)
147 lines
5.1 KiB
Plaintext
147 lines
5.1 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
OSSL_DESERIALIZER,
|
|
OSSL_DESERIALIZER_fetch,
|
|
OSSL_DESERIALIZER_up_ref,
|
|
OSSL_DESERIALIZER_free,
|
|
OSSL_DESERIALIZER_provider,
|
|
OSSL_DESERIALIZER_properties,
|
|
OSSL_DESERIALIZER_is_a,
|
|
OSSL_DESERIALIZER_number,
|
|
OSSL_DESERIALIZER_do_all_provided,
|
|
OSSL_DESERIALIZER_names_do_all,
|
|
OSSL_DESERIALIZER_gettable_params,
|
|
OSSL_DESERIALIZER_get_params
|
|
- Deserializer method routines
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/deserializer.h>
|
|
|
|
typedef struct ossl_deserializer_st OSSL_DESERIALIZER;
|
|
|
|
OSSL_DESERIALIZER *OSSL_DESERIALIZER_fetch(OPENSSL_CTX *ctx, const char *name,
|
|
const char *properties);
|
|
int OSSL_DESERIALIZER_up_ref(OSSL_DESERIALIZER *deserializer);
|
|
void OSSL_DESERIALIZER_free(OSSL_DESERIALIZER *deserializer);
|
|
const OSSL_PROVIDER *OSSL_DESERIALIZER_provider(const OSSL_DESERIALIZER
|
|
*deserializer);
|
|
const char *OSSL_DESERIALIZER_properties(const OSSL_DESERIALIZER *deser);
|
|
int OSSL_DESERIALIZER_is_a(const OSSL_DESERIALIZER *deserializer,
|
|
const char *name);
|
|
int OSSL_DESERIALIZER_number(const OSSL_DESERIALIZER *deserializer);
|
|
void OSSL_DESERIALIZER_do_all_provided(OPENSSL_CTX *libctx,
|
|
void (*fn)(OSSL_DESERIALIZER *deserializer,
|
|
void *arg),
|
|
void *arg);
|
|
void OSSL_DESERIALIZER_names_do_all(const OSSL_DESERIALIZER *deserializer,
|
|
void (*fn)(const char *name, void *data),
|
|
void *data);
|
|
const OSSL_PARAM *OSSL_DESERIALIZER_gettable_params(OSSL_DESERIALIZER *deser);
|
|
int OSSL_DESERIALIZER_get_params(OSSL_DESERIALIZER_CTX *ctx,
|
|
const OSSL_PARAM params[]);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
B<OSSL_DESERIALIZER> is a method for deserializers, which know how to
|
|
deserialize serialized data into an object of some type that the rest
|
|
of OpenSSL knows how to handle.
|
|
|
|
OSSL_DESERIALIZER_fetch() looks for an algorithm within the provider that
|
|
has been loaded into the B<OPENSSL_CTX> given by I<ctx>, having the
|
|
name given by I<name> and the properties given by I<properties>.
|
|
The I<name> determines what type of object the fetched deserializer
|
|
method is expected to be able to deserialize, and the properties are
|
|
used to determine the expected output type.
|
|
For known properties and the values they may have, please have a look
|
|
in L<provider-serializer(7)/Names and properties>.
|
|
|
|
OSSL_DESERIALIZER_up_ref() increments the reference count for the given
|
|
I<deserializer>.
|
|
|
|
OSSL_DESERIALIZER_free() decrements the reference count for the given
|
|
I<deserializer>, and when the count reaches zero, frees it.
|
|
|
|
OSSL_DESERIALIZER_provider() returns the provider of the given
|
|
I<deserializer>.
|
|
|
|
OSSL_DESERIALIZER_properties() returns the property definition associated
|
|
with the given I<deserializer>.
|
|
|
|
OSSL_DESERIALIZER_is_a() checks if I<deserializer> is an implementation
|
|
of an algorithm that's identifiable with I<name>.
|
|
|
|
OSSL_DESERIALIZER_number() returns the internal dynamic number assigned
|
|
to the given I<deserializer>.
|
|
|
|
OSSL_DESERIALIZER_names_do_all() traverses all names for the given
|
|
I<deserializer>, and calls I<fn> with each name and I<data>.
|
|
|
|
OSSL_DESERIALIZER_do_all_provided() traverses all serializer
|
|
implementations by all activated providers in the library context
|
|
I<libctx>, and for each of the implementations, calls I<fn> with the
|
|
implementation method and I<data> as arguments.
|
|
|
|
OSSL_DESERIALIZER_gettable_params() returns an L<OSSL_PARAM(3)>
|
|
array of parameter descriptors.
|
|
|
|
OSSL_DESERIALIZER_get_params() attempts to get parameters specified
|
|
with an L<OSSL_PARAM(3)> array I<params>. Parameters that the
|
|
implementation doesn't recognise should be ignored.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
OSSL_DESERIALIZER_fetch() returns a pointer to an OSSL_DESERIALIZER object,
|
|
or NULL on error.
|
|
|
|
OSSL_DESERIALIZER_up_ref() returns 1 on success, or 0 on error.
|
|
|
|
OSSL_DESERIALIZER_free() doesn't return any value.
|
|
|
|
OSSL_DESERIALIZER_provider() returns a pointer to a provider object, or
|
|
NULL on error.
|
|
|
|
OSSL_DESERIALIZER_properties() returns a pointer to a property
|
|
definition string, or NULL on error.
|
|
|
|
OSSL_DESERIALIZER_is_a() returns 1 if I<deserializer> was identifiable,
|
|
otherwise 0.
|
|
|
|
OSSL_DESERIALIZER_number() returns an integer.
|
|
|
|
=head1 NOTES
|
|
|
|
OSSL_DESERIALIZER_fetch() may be called implicitly by other fetching
|
|
functions, using the same library context and properties.
|
|
Any other API that uses keys will typically do this.
|
|
|
|
=begin comment TODO(3.0) Add examples!
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Text, because pod2xxx doesn't like empty sections
|
|
|
|
=end comment
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<provider(7)>, L<OSSL_DESERIALIZER_CTX(3)>, L<OSSL_DESERIALIZER_from_bio(3)>,
|
|
L<OSSL_DESERIALIZER_CTX_new_by_EVP_PKEY(3)>, L<OPENSSL_CTX(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The functions described here were added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2020 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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|