9 OSSL_ENCODER_get0_provider,
10 OSSL_ENCODER_get0_properties,
12 OSSL_ENCODER_get0_name,
13 OSSL_ENCODER_get0_description,
14 OSSL_ENCODER_do_all_provided,
15 OSSL_ENCODER_names_do_all,
16 OSSL_ENCODER_gettable_params,
17 OSSL_ENCODER_get_params
18 - Encoder method routines
22 #include <openssl/encoder.h>
24 typedef struct ossl_encoder_st OSSL_ENCODER;
26 OSSL_ENCODER *OSSL_ENCODER_fetch(OSSL_LIB_CTX *ctx, const char *name,
27 const char *properties);
28 int OSSL_ENCODER_up_ref(OSSL_ENCODER *encoder);
29 void OSSL_ENCODER_free(OSSL_ENCODER *encoder);
30 const OSSL_PROVIDER *OSSL_ENCODER_get0_provider(const OSSL_ENCODER *encoder);
31 const char *OSSL_ENCODER_get0_properties(const OSSL_ENCODER *encoder);
32 int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name);
33 const char *OSSL_ENCODER_get0_name(const OSSL_ENCODER *encoder);
34 const char *OSSL_ENCODER_get0_description(const OSSL_ENCODER *encoder);
35 void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx,
36 void (*fn)(OSSL_ENCODER *encoder, void *arg),
38 int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,
39 void (*fn)(const char *name, void *data),
41 const OSSL_PARAM *OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder);
42 int OSSL_ENCODER_get_params(OSSL_ENCODER_CTX *ctx, const OSSL_PARAM params[]);
46 B<OSSL_ENCODER> is a method for encoders, which know how to
47 encode an object of some kind to a encoded form, such as PEM,
48 DER, or even human readable text.
50 OSSL_ENCODER_fetch() looks for an algorithm within the provider that
51 has been loaded into the B<OSSL_LIB_CTX> given by I<ctx>, having the
52 name given by I<name> and the properties given by I<properties>.
53 The I<name> determines what type of object the fetched encoder
54 method is expected to be able to encode, and the properties are
55 used to determine the expected output type.
56 For known properties and the values they may have, please have a look
57 in L<provider-encoder(7)/Names and properties>.
59 OSSL_ENCODER_up_ref() increments the reference count for the given
62 OSSL_ENCODER_free() decrements the reference count for the given
63 I<encoder>, and when the count reaches zero, frees it.
65 OSSL_ENCODER_get0_provider() returns the provider of the given
68 OSSL_ENCODER_get0_properties() returns the property definition associated
69 with the given I<encoder>.
71 OSSL_ENCODER_is_a() checks if I<encoder> is an implementation of an
72 algorithm that's identifiable with I<name>.
74 ossl_encoder_get_number() returns the name used to fetch the given I<encoder>.
76 OSSL_ENCODER_get0_description() returns a description of the I<loader>, meant
77 for display and human consumption. The description is at the discretion of the
78 I<loader> implementation.
80 OSSL_ENCODER_names_do_all() traverses all names for the given
81 I<encoder>, and calls I<fn> with each name and I<data> as arguments.
83 OSSL_ENCODER_do_all_provided() traverses all encoder
84 implementations by all activated providers in the library context
85 I<libctx>, and for each of the implementations, calls I<fn> with the
86 implementation method and I<arg> as arguments.
88 OSSL_ENCODER_gettable_params() returns an L<OSSL_PARAM(3)>
89 array of parameter descriptors.
91 OSSL_ENCODER_get_params() attempts to get parameters specified
92 with an L<OSSL_PARAM(3)> array I<params>. Parameters that the
93 implementation doesn't recognise should be ignored.
97 OSSL_ENCODER_fetch() returns a pointer to the key management
98 implementation represented by an OSSL_ENCODER object, or NULL on
101 OSSL_ENCODER_up_ref() returns 1 on success, or 0 on error.
103 OSSL_ENCODER_free() doesn't return any value.
105 OSSL_ENCODER_get0_provider() returns a pointer to a provider object, or
108 OSSL_ENCODER_get0_properties() returns a pointer to a property
109 definition string, or NULL on error.
111 OSSL_ENCODER_is_a() returns 1 of I<encoder> was identifiable,
114 OSSL_ENCODER_get0_name() returns the algorithm name from the provided
115 implementation for the given I<encoder>. Note that the I<encoder> may have
116 multiple synonyms associated with it. In this case the first name from the
117 algorithm definition is returned. Ownership of the returned string is retained
118 by the I<encoder> object and should not be freed by the caller.
120 OSSL_ENCODER_get0_description() returns a pointer to a decription, or NULL if
123 OSSL_ENCODER_names_do_all() returns 1 if the callback was called for all
124 names. A return value of 0 means that the callback was not called for any names.
128 L<provider(7)>, L<OSSL_ENCODER_CTX(3)>, L<OSSL_ENCODER_to_bio(3)>,
129 L<OSSL_ENCODER_CTX_new_for_pkey(3)>, L<OSSL_LIB_CTX(3)>
133 The functions described here were added in OpenSSL 3.0.
137 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 L<https://www.openssl.org/source/license.html>.