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 #ifndef OPENSSL_ENCODER_H
11 # define OPENSSL_ENCODER_H
14 # include <openssl/opensslconf.h>
16 # ifndef OPENSSL_NO_STDIO
21 # include <openssl/encodererr.h>
22 # include <openssl/types.h>
23 # include <openssl/core.h>
29 OSSL_ENCODER *OSSL_ENCODER_fetch(OSSL_LIB_CTX *libctx, const char *name,
30 const char *properties);
31 int OSSL_ENCODER_up_ref(OSSL_ENCODER *encoder);
32 void OSSL_ENCODER_free(OSSL_ENCODER *encoder);
34 const OSSL_PROVIDER *OSSL_ENCODER_get0_provider(const OSSL_ENCODER *encoder);
35 const char *OSSL_ENCODER_get0_properties(const OSSL_ENCODER *encoder);
36 const char *OSSL_ENCODER_get0_name(const OSSL_ENCODER *kdf);
37 const char *OSSL_ENCODER_get0_description(const OSSL_ENCODER *kdf);
38 int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name);
40 void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx,
41 void (*fn)(OSSL_ENCODER *encoder, void *arg),
43 int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,
44 void (*fn)(const char *name, void *data),
46 const OSSL_PARAM *OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder);
47 int OSSL_ENCODER_get_params(OSSL_ENCODER *encoder, OSSL_PARAM params[]);
49 const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder);
50 OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(void);
51 int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX *ctx,
52 const OSSL_PARAM params[]);
53 void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX *ctx);
55 /* Utilities that help set specific parameters */
56 int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx,
57 const unsigned char *kstr, size_t klen);
58 int OSSL_ENCODER_CTX_set_pem_password_cb(OSSL_ENCODER_CTX *ctx,
59 pem_password_cb *cb, void *cbarg);
60 int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx,
61 OSSL_PASSPHRASE_CALLBACK *cb,
63 int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx,
64 const UI_METHOD *ui_method,
66 int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx,
67 const char *cipher_name,
68 const char *propquery);
69 int OSSL_ENCODER_CTX_set_selection(OSSL_ENCODER_CTX *ctx, int selection);
70 int OSSL_ENCODER_CTX_set_output_type(OSSL_ENCODER_CTX *ctx,
71 const char *output_type);
72 int OSSL_ENCODER_CTX_set_output_structure(OSSL_ENCODER_CTX *ctx,
73 const char *output_structure);
75 /* Utilities to add encoders */
76 int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder);
77 int OSSL_ENCODER_CTX_add_extra(OSSL_ENCODER_CTX *ctx,
78 OSSL_LIB_CTX *libctx, const char *propq);
79 int OSSL_ENCODER_CTX_get_num_encoders(OSSL_ENCODER_CTX *ctx);
81 typedef struct ossl_encoder_instance_st OSSL_ENCODER_INSTANCE;
83 OSSL_ENCODER_INSTANCE_get_encoder(OSSL_ENCODER_INSTANCE *encoder_inst);
85 OSSL_ENCODER_INSTANCE_get_encoder_ctx(OSSL_ENCODER_INSTANCE *encoder_inst);
87 OSSL_ENCODER_INSTANCE_get_output_type(OSSL_ENCODER_INSTANCE *encoder_inst);
89 OSSL_ENCODER_INSTANCE_get_output_structure(OSSL_ENCODER_INSTANCE *encoder_inst);
91 typedef const void *OSSL_ENCODER_CONSTRUCT(OSSL_ENCODER_INSTANCE *encoder_inst,
92 void *construct_data);
93 typedef void OSSL_ENCODER_CLEANUP(void *construct_data);
95 int OSSL_ENCODER_CTX_set_construct(OSSL_ENCODER_CTX *ctx,
96 OSSL_ENCODER_CONSTRUCT *construct);
97 int OSSL_ENCODER_CTX_set_construct_data(OSSL_ENCODER_CTX *ctx,
98 void *construct_data);
99 int OSSL_ENCODER_CTX_set_cleanup(OSSL_ENCODER_CTX *ctx,
100 OSSL_ENCODER_CLEANUP *cleanup);
102 /* Utilities to output the object to encode */
103 int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out);
104 #ifndef OPENSSL_NO_STDIO
105 int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp);
107 int OSSL_ENCODER_to_data(OSSL_ENCODER_CTX *ctx, unsigned char **pdata,
111 * Create the OSSL_ENCODER_CTX with an associated type. This will perform
112 * an implicit OSSL_ENCODER_fetch(), suitable for the object of that type.
113 * This is more useful than calling OSSL_ENCODER_CTX_new().
115 OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_for_pkey(const EVP_PKEY *pkey,
117 const char *output_type,
118 const char *output_struct,
119 const char *propquery);