doc/man3/OSSL_ENCODER.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_ENCODER,
   6 OSSL_ENCODER_fetch,
   7 OSSL_ENCODER_up_ref,
   8 OSSL_ENCODER_free,
   9 OSSL_ENCODER_provider,
  10 OSSL_ENCODER_properties,
  11 OSSL_ENCODER_is_a,
  12 OSSL_ENCODER_number,
  13 OSSL_ENCODER_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
  19
  20 =head1 SYNOPSIS
  21
  22  #include <openssl/encoder.h>
  23
  24  typedef struct ossl_encoder_st OSSL_ENCODER;
  25
  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_provider(const OSSL_ENCODER *encoder);
  31  const char *OSSL_ENCODER_properties(const OSSL_ENCODER *encoder);
  32  int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name);
  33  int OSSL_ENCODER_number(const OSSL_ENCODER *encoder);
  34  const char *OSSL_ENCODER_description(const OSSL_ENCODER *encoder);
  35  void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx,
  36                                    void (*fn)(OSSL_ENCODER *encoder, void *arg),
  37                                    void *arg);
  38  int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,
  39                                void (*fn)(const char *name, void *data),
  40                                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[]);
  43
  44 =head1 DESCRIPTION
  45
  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.
  49
  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>.
  58
  59 OSSL_ENCODER_up_ref() increments the reference count for the given
  60 I<encoder>.
  61
  62 OSSL_ENCODER_free() decrements the reference count for the given
  63 I<encoder>, and when the count reaches zero, frees it.
  64
  65 OSSL_ENCODER_provider() returns the provider of the given
  66 I<encoder>.
  67
  68 OSSL_ENCODER_properties() returns the property definition associated
  69 with the given I<encoder>.
  70
  71 OSSL_ENCODER_is_a() checks if I<encoder> is an implementation of an
  72 algorithm that's identifiable with I<name>.
  73
  74 OSSL_ENCODER_number() returns the internal dynamic number assigned to
  75 the given I<encoder>.
  76
  77 OSSL_ENCODER_description() returns a description of the I<loader>, meant
  78 for display and human consumption.  The description is at the discretion of the
  79 I<loader> implementation.
  80
  81 OSSL_ENCODER_names_do_all() traverses all names for the given
  82 I<encoder>, and calls I<fn> with each name and I<data> as arguments.
  83
  84 OSSL_ENCODER_do_all_provided() traverses all encoder
  85 implementations by all activated providers in the library context
  86 I<libctx>, and for each of the implementations, calls I<fn> with the
  87 implementation method and I<arg> as arguments.
  88
  89 OSSL_ENCODER_gettable_params() returns an L<OSSL_PARAM(3)>
  90 array of parameter descriptors.
  91
  92 OSSL_ENCODER_get_params() attempts to get parameters specified
  93 with an L<OSSL_PARAM(3)> array I<params>.  Parameters that the
  94 implementation doesn't recognise should be ignored.
  95
  96 =head1 RETURN VALUES
  97
  98 OSSL_ENCODER_fetch() returns a pointer to the key management
  99 implementation represented by an OSSL_ENCODER object, or NULL on
 100 error.
 101
 102 OSSL_ENCODER_up_ref() returns 1 on success, or 0 on error.
 103
 104 OSSL_ENCODER_free() doesn't return any value.
 105
 106 OSSL_ENCODER_provider() returns a pointer to a provider object, or
 107 NULL on error.
 108
 109 OSSL_ENCODER_properties() returns a pointer to a property
 110 definition string, or NULL on error.
 111
 112 OSSL_ENCODER_is_a() returns 1 of I<encoder> was identifiable,
 113 otherwise 0.
 114
 115 OSSL_ENCODER_number() returns an integer.
 116
 117 OSSL_ENCODER_description() returns a pointer to a decription, or NULL if
 118 there isn't one.
 119
 120 OSSL_ENCODER_names_do_all() returns 1 if the callback was called for all
 121 names. A return value of 0 means that the callback was not called for any names.
 122
 123 =head1 SEE ALSO
 124
 125 L<provider(7)>, L<OSSL_ENCODER_CTX(3)>, L<OSSL_ENCODER_to_bio(3)>,
 126 L<OSSL_ENCODER_CTX_new_for_pkey(3)>, L<OSSL_LIB_CTX(3)>
 127
 128 =head1 HISTORY
 129
 130 The functions described here were added in OpenSSL 3.0.
 131
 132 =head1 COPYRIGHT
 133
 134 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 135
 136 Licensed under the Apache License 2.0 (the "License").  You may not use
 137 this file except in compliance with the License.  You can obtain a copy
 138 in the file LICENSE in the source distribution or at
 139 L<https://www.openssl.org/source/license.html>.
 140
 141 =cut