2 * Copyright 2020 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_DECODER_H
11 # define OPENSSL_DECODER_H
14 # include <openssl/opensslconf.h>
16 # ifndef OPENSSL_NO_STDIO
21 # include <openssl/decodererr.h>
22 # include <openssl/types.h>
23 # include <openssl/core.h>
29 OSSL_DECODER
*OSSL_DECODER_fetch(OPENSSL_CTX
*libctx
, const char *name
,
30 const char *properties
);
31 int OSSL_DECODER_up_ref(OSSL_DECODER
*encoder
);
32 void OSSL_DECODER_free(OSSL_DECODER
*encoder
);
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
);
37 int OSSL_DECODER_is_a(const OSSL_DECODER
*encoder
, const char *name
);
39 void OSSL_DECODER_do_all_provided(OPENSSL_CTX
*libctx
,
40 void (*fn
)(OSSL_DECODER
*encoder
, void *arg
),
42 void OSSL_DECODER_names_do_all(const OSSL_DECODER
*encoder
,
43 void (*fn
)(const char *name
, void *data
),
45 const OSSL_PARAM
*OSSL_DECODER_gettable_params(OSSL_DECODER
*decoder
);
46 int OSSL_DECODER_get_params(OSSL_DECODER
*decoder
, OSSL_PARAM params
[]);
48 const OSSL_PARAM
*OSSL_DECODER_settable_ctx_params(OSSL_DECODER
*encoder
);
49 OSSL_DECODER_CTX
*OSSL_DECODER_CTX_new(void);
50 int OSSL_DECODER_CTX_set_params(OSSL_DECODER_CTX
*ctx
,
51 const OSSL_PARAM params
[]);
52 void OSSL_DECODER_CTX_free(OSSL_DECODER_CTX
*ctx
);
54 /* Utilities that help set specific parameters */
55 int OSSL_DECODER_CTX_set_passphrase(OSSL_DECODER_CTX
*ctx
,
56 const unsigned char *kstr
, size_t klen
);
57 int OSSL_DECODER_CTX_set_pem_password_cb(OSSL_DECODER_CTX
*ctx
,
58 pem_password_cb
*cb
, void *cbarg
);
59 int OSSL_DECODER_CTX_set_passphrase_cb(OSSL_DECODER_CTX
*ctx
,
60 OSSL_PASSPHRASE_CALLBACK
*cb
,
62 int OSSL_DECODER_CTX_set_passphrase_ui(OSSL_DECODER_CTX
*ctx
,
63 const UI_METHOD
*ui_method
,
67 * Utilities to read the object to decode, with the result sent to cb.
68 * These will discover all provided methods
71 int OSSL_DECODER_CTX_set_input_type(OSSL_DECODER_CTX
*ctx
,
72 const char *input_type
);
73 int OSSL_DECODER_CTX_add_decoder(OSSL_DECODER_CTX
*ctx
, OSSL_DECODER
*decoder
);
74 int OSSL_DECODER_CTX_add_extra(OSSL_DECODER_CTX
*ctx
,
75 OPENSSL_CTX
*libctx
, const char *propq
);
76 int OSSL_DECODER_CTX_get_num_decoders(OSSL_DECODER_CTX
*ctx
);
78 typedef struct ossl_decoder_instance_st OSSL_DECODER_INSTANCE
;
80 OSSL_DECODER_INSTANCE_get_decoder(OSSL_DECODER_INSTANCE
*decoder_inst
);
82 OSSL_DECODER_INSTANCE_get_decoder_ctx(OSSL_DECODER_INSTANCE
*decoder_inst
);
84 OSSL_DECODER_INSTANCE_get_input_type(OSSL_DECODER_INSTANCE
*decoder_inst
);
86 typedef int OSSL_DECODER_CONSTRUCT(OSSL_DECODER_INSTANCE
*decoder_inst
,
87 const OSSL_PARAM
*params
,
88 void *construct_data
);
89 typedef void OSSL_DECODER_CLEANUP(void *construct_data
);
91 int OSSL_DECODER_CTX_set_construct(OSSL_DECODER_CTX
*ctx
,
92 OSSL_DECODER_CONSTRUCT
*construct
);
93 int OSSL_DECODER_CTX_set_construct_data(OSSL_DECODER_CTX
*ctx
,
94 void *construct_data
);
95 int OSSL_DECODER_CTX_set_cleanup(OSSL_DECODER_CTX
*ctx
,
96 OSSL_DECODER_CLEANUP
*cleanup
);
97 OSSL_DECODER_CONSTRUCT
*OSSL_DECODER_CTX_get_construct(OSSL_DECODER_CTX
*ctx
);
98 void *OSSL_DECODER_CTX_get_construct_data(OSSL_DECODER_CTX
*ctx
);
99 OSSL_DECODER_CLEANUP
*OSSL_DECODER_CTX_get_cleanup(OSSL_DECODER_CTX
*ctx
);
101 int OSSL_DECODER_export(OSSL_DECODER_INSTANCE
*decoder_inst
,
102 void *reference
, size_t reference_sz
,
103 OSSL_CALLBACK
*export_cb
, void *export_cbarg
);
105 int OSSL_DECODER_from_bio(OSSL_DECODER_CTX
*ctx
, BIO
*in
);
106 #ifndef OPENSSL_NO_STDIO
107 int OSSL_DECODER_from_fp(OSSL_DECODER_CTX
*ctx
, FILE *in
);
109 int OSSL_DECODER_from_data(OSSL_DECODER_CTX
*ctx
, const unsigned char **pdata
,
113 * Create the OSSL_DECODER_CTX with an associated type. This will perform
114 * an implicit OSSL_DECODER_fetch(), suitable for the object of that type.
117 OSSL_DECODER_CTX_new_by_EVP_PKEY(EVP_PKEY
**pkey
,
118 const char *input_type
, const char *keytype
,
119 OPENSSL_CTX
*libctx
, const char *propquery
);