2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
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
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"
19 struct ossl_endecode_base_st
{
23 const char *description
;
25 CRYPTO_REF_COUNT refcnt
;
29 struct ossl_encoder_st
{
30 struct ossl_endecode_base_st base
;
31 OSSL_FUNC_encoder_newctx_fn
*newctx
;
32 OSSL_FUNC_encoder_freectx_fn
*freectx
;
33 OSSL_FUNC_encoder_get_params_fn
*get_params
;
34 OSSL_FUNC_encoder_gettable_params_fn
*gettable_params
;
35 OSSL_FUNC_encoder_set_ctx_params_fn
*set_ctx_params
;
36 OSSL_FUNC_encoder_settable_ctx_params_fn
*settable_ctx_params
;
37 OSSL_FUNC_encoder_does_selection_fn
*does_selection
;
38 OSSL_FUNC_encoder_encode_fn
*encode
;
39 OSSL_FUNC_encoder_import_object_fn
*import_object
;
40 OSSL_FUNC_encoder_free_object_fn
*free_object
;
43 struct ossl_decoder_st
{
44 struct ossl_endecode_base_st base
;
45 OSSL_FUNC_decoder_newctx_fn
*newctx
;
46 OSSL_FUNC_decoder_freectx_fn
*freectx
;
47 OSSL_FUNC_decoder_get_params_fn
*get_params
;
48 OSSL_FUNC_decoder_gettable_params_fn
*gettable_params
;
49 OSSL_FUNC_decoder_set_ctx_params_fn
*set_ctx_params
;
50 OSSL_FUNC_decoder_settable_ctx_params_fn
*settable_ctx_params
;
51 OSSL_FUNC_decoder_does_selection_fn
*does_selection
;
52 OSSL_FUNC_decoder_decode_fn
*decode
;
53 OSSL_FUNC_decoder_export_object_fn
*export_object
;
56 struct ossl_encoder_instance_st
{
57 OSSL_ENCODER
*encoder
; /* Never NULL */
58 void *encoderctx
; /* Never NULL */
59 const char *input_type
; /* May be NULL */
60 const char *output_type
; /* Never NULL */
61 const char *output_structure
; /* May be NULL */
64 DEFINE_STACK_OF(OSSL_ENCODER_INSTANCE
)
66 void ossl_encoder_instance_free(OSSL_ENCODER_INSTANCE
*encoder_inst
);
68 struct ossl_encoder_ctx_st
{
70 * Select what parts of an object will be encoded. This selection is
71 * bit encoded, and the bits correspond to selection bits available with
72 * the provider side operation. For example, when encoding an EVP_PKEY,
73 * the OSSL_KEYMGMT_SELECT_ macros are used for this.
77 * The desired output type. The encoder implementation must have a
78 * gettable "output-type" parameter that this will match against.
80 const char *output_type
;
82 * The desired output structure, if that's relevant for the type of
83 * object being encoded. It may be used for selection of the starting
84 * encoder implementations in a chain.
86 const char *output_structure
;
89 * Decoders that are components of any current decoding path.
91 STACK_OF(OSSL_ENCODER_INSTANCE
) *encoder_insts
;
94 * The constructor and destructor of an object to pass to the first
97 OSSL_ENCODER_CONSTRUCT
*construct
;
98 OSSL_ENCODER_CLEANUP
*cleanup
;
101 /* For any function that needs a passphrase reader */
102 struct ossl_passphrase_data_st pwdata
;
105 struct ossl_decoder_instance_st
{
106 OSSL_DECODER
*decoder
; /* Never NULL */
107 void *decoderctx
; /* Never NULL */
108 const char *input_type
; /* Never NULL */
109 const char *input_structure
; /* May be NULL */
111 unsigned int flag_input_structure_was_set
: 1;
114 DEFINE_STACK_OF(OSSL_DECODER_INSTANCE
)
116 struct ossl_decoder_ctx_st
{
118 * The caller may know the input type of the data they pass. If not,
119 * this will remain NULL and the decoding functionality will start
120 * with trying to decode with any desencoder in |decoder_insts|,
121 * regardless of their respective input type.
123 const char *start_input_type
;
125 * The desired input structure, if that's relevant for the type of
126 * object being encoded. It may be used for selection of the ending
127 * decoder implementations in a chain, i.e. those chosen using the
128 * expected output data type.
130 const char *input_structure
;
132 * Select what parts of an object are expected. This may affect what
133 * decoder implementations are selected, because there are structures
134 * that look different depending on this selection; for example, EVP_PKEY
135 * objects often have different encoding structures for private keys,
136 * public keys and key parameters.
137 * This selection is bit encoded, and the bits correspond to selection
138 * bits available with the provider side operation. For example, when
139 * encoding an EVP_PKEY, the OSSL_KEYMGMT_SELECT_ macros are used for
145 * Decoders that are components of any current decoding path.
147 STACK_OF(OSSL_DECODER_INSTANCE
) *decoder_insts
;
150 * The constructors of a decoding, and its caller argument.
152 OSSL_DECODER_CONSTRUCT
*construct
;
153 OSSL_DECODER_CLEANUP
*cleanup
;
154 void *construct_data
;
156 /* For any function that needs a passphrase reader */
157 struct ossl_passphrase_data_st pwdata
;