]>
Commit | Line | Data |
---|---|---|
ece9304c | 1 | /* |
a28d06f3 | 2 | * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved. |
ece9304c RL |
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 | #ifndef OPENSSL_ENCODER_H | |
11 | # define OPENSSL_ENCODER_H | |
12 | # pragma once | |
13 | ||
14 | # include <openssl/opensslconf.h> | |
15 | ||
16 | # ifndef OPENSSL_NO_STDIO | |
17 | # include <stdio.h> | |
18 | # endif | |
19 | # include <stdarg.h> | |
20 | # include <stddef.h> | |
21 | # include <openssl/encodererr.h> | |
22 | # include <openssl/types.h> | |
23 | # include <openssl/core.h> | |
24 | ||
25 | # ifdef __cplusplus | |
26 | extern "C" { | |
27 | # endif | |
28 | ||
b4250010 | 29 | OSSL_ENCODER *OSSL_ENCODER_fetch(OSSL_LIB_CTX *libctx, const char *name, |
ece9304c RL |
30 | const char *properties); |
31 | int OSSL_ENCODER_up_ref(OSSL_ENCODER *encoder); | |
32 | void OSSL_ENCODER_free(OSSL_ENCODER *encoder); | |
33 | ||
34 | const OSSL_PROVIDER *OSSL_ENCODER_provider(const OSSL_ENCODER *encoder); | |
35 | const char *OSSL_ENCODER_properties(const OSSL_ENCODER *encoder); | |
36 | int OSSL_ENCODER_number(const OSSL_ENCODER *encoder); | |
37 | int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name); | |
38 | ||
b4250010 | 39 | void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx, |
ece9304c RL |
40 | void (*fn)(OSSL_ENCODER *encoder, void *arg), |
41 | void *arg); | |
d84f5515 MC |
42 | int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder, |
43 | void (*fn)(const char *name, void *data), | |
44 | void *data); | |
b8975c68 RL |
45 | const OSSL_PARAM *OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder); |
46 | int OSSL_ENCODER_get_params(OSSL_ENCODER *encoder, OSSL_PARAM params[]); | |
ece9304c RL |
47 | |
48 | const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder); | |
b8975c68 | 49 | OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(void); |
ece9304c RL |
50 | int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX *ctx, |
51 | const OSSL_PARAM params[]); | |
52 | void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX *ctx); | |
53 | ||
54 | /* Utilities that help set specific parameters */ | |
ece9304c | 55 | int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx, |
b8975c68 RL |
56 | const unsigned char *kstr, size_t klen); |
57 | int OSSL_ENCODER_CTX_set_pem_password_cb(OSSL_ENCODER_CTX *ctx, | |
58 | pem_password_cb *cb, void *cbarg); | |
ece9304c | 59 | int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx, |
b8975c68 RL |
60 | OSSL_PASSPHRASE_CALLBACK *cb, |
61 | void *cbarg); | |
ece9304c RL |
62 | int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx, |
63 | const UI_METHOD *ui_method, | |
64 | void *ui_data); | |
b8975c68 RL |
65 | int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx, |
66 | const char *cipher_name, | |
67 | const char *propquery); | |
8a98a507 | 68 | int OSSL_ENCODER_CTX_set_selection(OSSL_ENCODER_CTX *ctx, int selection); |
b8975c68 RL |
69 | int OSSL_ENCODER_CTX_set_output_type(OSSL_ENCODER_CTX *ctx, |
70 | const char *output_type); | |
8a98a507 RL |
71 | int OSSL_ENCODER_CTX_set_output_structure(OSSL_ENCODER_CTX *ctx, |
72 | const char *output_structure); | |
b8975c68 RL |
73 | |
74 | /* Utilities to add encoders */ | |
75 | int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder); | |
76 | int OSSL_ENCODER_CTX_add_extra(OSSL_ENCODER_CTX *ctx, | |
b4250010 | 77 | OSSL_LIB_CTX *libctx, const char *propq); |
b8975c68 RL |
78 | int OSSL_ENCODER_CTX_get_num_encoders(OSSL_ENCODER_CTX *ctx); |
79 | ||
80 | typedef struct ossl_encoder_instance_st OSSL_ENCODER_INSTANCE; | |
81 | OSSL_ENCODER * | |
82 | OSSL_ENCODER_INSTANCE_get_encoder(OSSL_ENCODER_INSTANCE *encoder_inst); | |
83 | void * | |
84 | OSSL_ENCODER_INSTANCE_get_encoder_ctx(OSSL_ENCODER_INSTANCE *encoder_inst); | |
85 | const char * | |
86 | OSSL_ENCODER_INSTANCE_get_input_type(OSSL_ENCODER_INSTANCE *encoder_inst); | |
87 | const char * | |
88 | OSSL_ENCODER_INSTANCE_get_output_type(OSSL_ENCODER_INSTANCE *encoder_inst); | |
8a98a507 RL |
89 | const char * |
90 | OSSL_ENCODER_INSTANCE_get_output_structure(OSSL_ENCODER_INSTANCE *encoder_inst); | |
b8975c68 RL |
91 | |
92 | typedef const void *OSSL_ENCODER_CONSTRUCT(OSSL_ENCODER_INSTANCE *encoder_inst, | |
93 | void *construct_data); | |
94 | typedef void OSSL_ENCODER_CLEANUP(void *construct_data); | |
95 | ||
96 | int OSSL_ENCODER_CTX_set_construct(OSSL_ENCODER_CTX *ctx, | |
97 | OSSL_ENCODER_CONSTRUCT *construct); | |
98 | int OSSL_ENCODER_CTX_set_construct_data(OSSL_ENCODER_CTX *ctx, | |
99 | void *construct_data); | |
100 | int OSSL_ENCODER_CTX_set_cleanup(OSSL_ENCODER_CTX *ctx, | |
101 | OSSL_ENCODER_CLEANUP *cleanup); | |
ece9304c RL |
102 | |
103 | /* Utilities to output the object to encode */ | |
104 | int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out); | |
105 | #ifndef OPENSSL_NO_STDIO | |
106 | int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp); | |
107 | #endif | |
25cf949f RL |
108 | int OSSL_ENCODER_to_data(OSSL_ENCODER_CTX *ctx, unsigned char **pdata, |
109 | size_t *pdata_len); | |
ece9304c RL |
110 | |
111 | /* | |
112 | * Create the OSSL_ENCODER_CTX with an associated type. This will perform | |
113 | * an implicit OSSL_ENCODER_fetch(), suitable for the object of that type. | |
114 | * This is more useful than calling OSSL_ENCODER_CTX_new(). | |
115 | */ | |
fe75766c TM |
116 | OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_for_pkey(const EVP_PKEY *pkey, |
117 | int selection, | |
118 | const char *output_type, | |
119 | const char *output_struct, | |
120 | const char *propquery); | |
ece9304c | 121 | |
ece9304c RL |
122 | # ifdef __cplusplus |
123 | } | |
124 | # endif | |
125 | #endif |