crypto/encode_decode/encoder_local.h

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/core_dispatch.h>
  11 #include <openssl/types.h>
  12 #include <openssl/safestack.h>
  13 #include <openssl/encoder.h>
  14 #include <openssl/decoder.h>
  15 #include "internal/cryptlib.h"
  16 #include "internal/passphrase.h"
  17 #include "internal/refcount.h"
  18
  19 struct ossl_endecode_base_st {
  20     OSSL_PROVIDER *prov;
  21     int id;
  22     const char *propdef;
  23
  24     CRYPTO_REF_COUNT refcnt;
  25     CRYPTO_RWLOCK *lock;
  26 };
  27
  28 struct ossl_encoder_st {
  29     struct ossl_endecode_base_st base;
  30     OSSL_FUNC_encoder_newctx_fn *newctx;
  31     OSSL_FUNC_encoder_freectx_fn *freectx;
  32     OSSL_FUNC_encoder_get_params_fn *get_params;
  33     OSSL_FUNC_encoder_gettable_params_fn *gettable_params;
  34     OSSL_FUNC_encoder_set_ctx_params_fn *set_ctx_params;
  35     OSSL_FUNC_encoder_settable_ctx_params_fn *settable_ctx_params;
  36     OSSL_FUNC_encoder_encode_fn *encode;
  37     OSSL_FUNC_encoder_import_object_fn *import_object;
  38     OSSL_FUNC_encoder_free_object_fn *free_object;
  39 };
  40
  41 struct ossl_decoder_st {
  42     struct ossl_endecode_base_st base;
  43     OSSL_FUNC_decoder_newctx_fn *newctx;
  44     OSSL_FUNC_decoder_freectx_fn *freectx;
  45     OSSL_FUNC_decoder_get_params_fn *get_params;
  46     OSSL_FUNC_decoder_gettable_params_fn *gettable_params;
  47     OSSL_FUNC_decoder_set_ctx_params_fn *set_ctx_params;
  48     OSSL_FUNC_decoder_settable_ctx_params_fn *settable_ctx_params;
  49     OSSL_FUNC_decoder_does_selection_fn *does_selection;
  50     OSSL_FUNC_decoder_decode_fn *decode;
  51     OSSL_FUNC_decoder_export_object_fn *export_object;
  52 };
  53
  54 struct ossl_encoder_instance_st {
  55     OSSL_ENCODER *encoder;       /* Never NULL */
  56     void *encoderctx;            /* Never NULL */
  57     const char *input_type;      /* May be NULL */
  58     const char *output_type;     /* Never NULL */
  59 };
  60
  61 DEFINE_STACK_OF(OSSL_ENCODER_INSTANCE)
  62
  63 void ossl_encoder_instance_free(OSSL_ENCODER_INSTANCE *encoder_inst);
  64
  65 struct ossl_encoder_ctx_st {
  66     /*
  67      * The desired output type.  The encoder implementation have a gettable
  68      * "output-type" parameter that this will match against.
  69      */
  70     const char *output_type;
  71     /*
  72      * Select what parts of an object will be encoded.  This selection is
  73      * bit encoded, and the bits correspond to selection bits available with
  74      * the provider side operation.  For example, when encoding an EVP_PKEY,
  75      * the OSSL_KEYMGMT_SELECT_ macros are used for this.
  76      */
  77     int selection;
  78
  79     /*
  80      * Decoders that are components of any current decoding path.
  81      */
  82     STACK_OF(OSSL_ENCODER_INSTANCE) *encoder_insts;
  83
  84     /*
  85      * The constructor and destructor of an object to pass to the first
  86      * encoder in a chain.
  87      */
  88     OSSL_ENCODER_CONSTRUCT *construct;
  89     OSSL_ENCODER_CLEANUP *cleanup;
  90     void *construct_data;
  91
  92     /* For any function that needs a passphrase reader */
  93     struct ossl_passphrase_data_st pwdata;
  94 };
  95
  96 struct ossl_decoder_instance_st {
  97     OSSL_DECODER *decoder;       /* Never NULL */
  98     void *decoderctx;            /* Never NULL */
  99     const char *input_type;      /* Never NULL */
 100     const char *input_structure; /* May be NULL */
 101
 102     unsigned int flag_input_structure_was_set : 1;
 103 };
 104
 105 DEFINE_STACK_OF(OSSL_DECODER_INSTANCE)
 106
 107 struct ossl_decoder_ctx_st {
 108     /*
 109      * The caller may know the input type of the data they pass.  If not,
 110      * this will remain NULL and the decoding functionality will start
 111      * with trying to decode with any desencoder in |decoder_insts|,
 112      * regardless of their respective input type.
 113      */
 114     const char *start_input_type;
 115     /*
 116      * The desired input structure, if that's relevant for the type of
 117      * object being encoded.  It may be used for selection of the ending
 118      * decoder implementations in a chain, i.e. those chosen using the
 119      * expected output data type.
 120      */
 121     const char *input_structure;
 122     /*
 123      * Select what parts of an object are expected.  This may affect what
 124      * decoder implementations are selected, because there are structures
 125      * that look different depending on this selection; for example, EVP_PKEY
 126      * objects often have different encoding structures for private keys,
 127      * public keys and key parameters.
 128      * This selection is bit encoded, and the bits correspond to selection
 129      * bits available with the provider side operation.  For example, when
 130      * encoding an EVP_PKEY, the OSSL_KEYMGMT_SELECT_ macros are used for
 131      * this.
 132      */
 133     int selection;
 134
 135     /*
 136      * Decoders that are components of any current decoding path.
 137      */
 138     STACK_OF(OSSL_DECODER_INSTANCE) *decoder_insts;
 139
 140     /*
 141      * The constructors of a decoding, and its caller argument.
 142      */
 143     OSSL_DECODER_CONSTRUCT *construct;
 144     OSSL_DECODER_CLEANUP *cleanup;
 145     void *construct_data;
 146
 147     /* For any function that needs a passphrase reader */
 148     struct ossl_passphrase_data_st pwdata;
 149 };