]>
Commit | Line | Data |
---|---|---|
ece9304c | 1 | /* |
a28d06f3 | 2 | * Copyright 2020-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_DECODER_H | |
11 | # define OPENSSL_DECODER_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/decodererr.h> | |
22 | # include <openssl/types.h> | |
23 | # include <openssl/core.h> | |
24 | ||
25 | # ifdef __cplusplus | |
26 | extern "C" { | |
27 | # endif | |
28 | ||
b4250010 | 29 | OSSL_DECODER *OSSL_DECODER_fetch(OSSL_LIB_CTX *libctx, const char *name, |
ece9304c RL |
30 | const char *properties); |
31 | int OSSL_DECODER_up_ref(OSSL_DECODER *encoder); | |
32 | void OSSL_DECODER_free(OSSL_DECODER *encoder); | |
33 | ||
34 | const OSSL_PROVIDER *OSSL_DECODER_provider(const OSSL_DECODER *encoder); | |
35 | const char *OSSL_DECODER_properties(const OSSL_DECODER *encoder); | |
36 | int OSSL_DECODER_number(const OSSL_DECODER *encoder); | |
49664117 | 37 | const char *OSSL_DECODER_name(const OSSL_DECODER *decoder); |
1010884e | 38 | const char *OSSL_DECODER_description(const OSSL_DECODER *decoder); |
ece9304c RL |
39 | int OSSL_DECODER_is_a(const OSSL_DECODER *encoder, const char *name); |
40 | ||
b4250010 | 41 | void OSSL_DECODER_do_all_provided(OSSL_LIB_CTX *libctx, |
ece9304c RL |
42 | void (*fn)(OSSL_DECODER *encoder, void *arg), |
43 | void *arg); | |
d84f5515 MC |
44 | int OSSL_DECODER_names_do_all(const OSSL_DECODER *encoder, |
45 | void (*fn)(const char *name, void *data), | |
46 | void *data); | |
ece9304c RL |
47 | const OSSL_PARAM *OSSL_DECODER_gettable_params(OSSL_DECODER *decoder); |
48 | int OSSL_DECODER_get_params(OSSL_DECODER *decoder, OSSL_PARAM params[]); | |
49 | ||
50 | const OSSL_PARAM *OSSL_DECODER_settable_ctx_params(OSSL_DECODER *encoder); | |
51 | OSSL_DECODER_CTX *OSSL_DECODER_CTX_new(void); | |
52 | int OSSL_DECODER_CTX_set_params(OSSL_DECODER_CTX *ctx, | |
53 | const OSSL_PARAM params[]); | |
54 | void OSSL_DECODER_CTX_free(OSSL_DECODER_CTX *ctx); | |
55 | ||
56 | /* Utilities that help set specific parameters */ | |
57 | int OSSL_DECODER_CTX_set_passphrase(OSSL_DECODER_CTX *ctx, | |
48b62fb3 | 58 | const unsigned char *kstr, size_t klen); |
ece9304c | 59 | int OSSL_DECODER_CTX_set_pem_password_cb(OSSL_DECODER_CTX *ctx, |
48b62fb3 | 60 | pem_password_cb *cb, void *cbarg); |
4fd39782 RL |
61 | int OSSL_DECODER_CTX_set_passphrase_cb(OSSL_DECODER_CTX *ctx, |
62 | OSSL_PASSPHRASE_CALLBACK *cb, | |
63 | void *cbarg); | |
ece9304c RL |
64 | int OSSL_DECODER_CTX_set_passphrase_ui(OSSL_DECODER_CTX *ctx, |
65 | const UI_METHOD *ui_method, | |
66 | void *ui_data); | |
67 | ||
68 | /* | |
69 | * Utilities to read the object to decode, with the result sent to cb. | |
70 | * These will discover all provided methods | |
71 | */ | |
72 | ||
ebfdb63d | 73 | int OSSL_DECODER_CTX_set_selection(OSSL_DECODER_CTX *ctx, int selection); |
ece9304c RL |
74 | int OSSL_DECODER_CTX_set_input_type(OSSL_DECODER_CTX *ctx, |
75 | const char *input_type); | |
ebfdb63d RL |
76 | int OSSL_DECODER_CTX_set_input_structure(OSSL_DECODER_CTX *ctx, |
77 | const char *input_structure); | |
ece9304c RL |
78 | int OSSL_DECODER_CTX_add_decoder(OSSL_DECODER_CTX *ctx, OSSL_DECODER *decoder); |
79 | int OSSL_DECODER_CTX_add_extra(OSSL_DECODER_CTX *ctx, | |
b4250010 | 80 | OSSL_LIB_CTX *libctx, const char *propq); |
48b62fb3 | 81 | int OSSL_DECODER_CTX_get_num_decoders(OSSL_DECODER_CTX *ctx); |
ece9304c RL |
82 | |
83 | typedef struct ossl_decoder_instance_st OSSL_DECODER_INSTANCE; | |
84 | OSSL_DECODER * | |
48b62fb3 RL |
85 | OSSL_DECODER_INSTANCE_get_decoder(OSSL_DECODER_INSTANCE *decoder_inst); |
86 | void * | |
87 | OSSL_DECODER_INSTANCE_get_decoder_ctx(OSSL_DECODER_INSTANCE *decoder_inst); | |
88 | const char * | |
89 | OSSL_DECODER_INSTANCE_get_input_type(OSSL_DECODER_INSTANCE *decoder_inst); | |
ebfdb63d RL |
90 | const char * |
91 | OSSL_DECODER_INSTANCE_get_input_structure(OSSL_DECODER_INSTANCE *decoder_inst, | |
92 | int *was_set); | |
ece9304c | 93 | |
48b62fb3 RL |
94 | typedef int OSSL_DECODER_CONSTRUCT(OSSL_DECODER_INSTANCE *decoder_inst, |
95 | const OSSL_PARAM *params, | |
96 | void *construct_data); | |
97 | typedef void OSSL_DECODER_CLEANUP(void *construct_data); | |
ece9304c RL |
98 | |
99 | int OSSL_DECODER_CTX_set_construct(OSSL_DECODER_CTX *ctx, | |
100 | OSSL_DECODER_CONSTRUCT *construct); | |
101 | int OSSL_DECODER_CTX_set_construct_data(OSSL_DECODER_CTX *ctx, | |
102 | void *construct_data); | |
103 | int OSSL_DECODER_CTX_set_cleanup(OSSL_DECODER_CTX *ctx, | |
104 | OSSL_DECODER_CLEANUP *cleanup); | |
105 | OSSL_DECODER_CONSTRUCT *OSSL_DECODER_CTX_get_construct(OSSL_DECODER_CTX *ctx); | |
106 | void *OSSL_DECODER_CTX_get_construct_data(OSSL_DECODER_CTX *ctx); | |
107 | OSSL_DECODER_CLEANUP *OSSL_DECODER_CTX_get_cleanup(OSSL_DECODER_CTX *ctx); | |
108 | ||
109 | int OSSL_DECODER_export(OSSL_DECODER_INSTANCE *decoder_inst, | |
110 | void *reference, size_t reference_sz, | |
111 | OSSL_CALLBACK *export_cb, void *export_cbarg); | |
112 | ||
113 | int OSSL_DECODER_from_bio(OSSL_DECODER_CTX *ctx, BIO *in); | |
114 | #ifndef OPENSSL_NO_STDIO | |
115 | int OSSL_DECODER_from_fp(OSSL_DECODER_CTX *ctx, FILE *in); | |
116 | #endif | |
25cf949f RL |
117 | int OSSL_DECODER_from_data(OSSL_DECODER_CTX *ctx, const unsigned char **pdata, |
118 | size_t *pdata_len); | |
ece9304c RL |
119 | |
120 | /* | |
121 | * Create the OSSL_DECODER_CTX with an associated type. This will perform | |
122 | * an implicit OSSL_DECODER_fetch(), suitable for the object of that type. | |
123 | */ | |
124 | OSSL_DECODER_CTX * | |
fe75766c TM |
125 | OSSL_DECODER_CTX_new_for_pkey(EVP_PKEY **pkey, |
126 | const char *input_type, | |
127 | const char *input_struct, | |
128 | const char *keytype, int selection, | |
129 | OSSL_LIB_CTX *libctx, const char *propquery); | |
ece9304c RL |
130 | |
131 | # ifdef __cplusplus | |
132 | } | |
133 | # endif | |
134 | #endif |