Rename OSSL_SERIALIZER / OSSL_DESERIALIZER to OSSL_ENCODE / OSSL_DECODE
[openssl.git] / providers / implementations / encode_decode / encoder_local.h
1 /*
2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
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 #include <openssl/core.h>
11 #include <openssl/core_dispatch.h>
12 #include <openssl/bn.h>
13 #include <openssl/asn1.h>        /* i2d_of_void */
14 #include <openssl/x509.h>        /* X509_SIG */
15 #include <openssl/types.h>
16 #include <crypto/ecx.h>
17 #include "internal/ffc.h"
18
19 struct pkcs8_encrypt_ctx_st {
20     /* Set to 1 if intending to encrypt/decrypt, otherwise 0 */
21     int cipher_intent;
22
23     EVP_CIPHER *cipher;
24     int pbe_nid;                 /* For future variation */
25
26     /* Passphrase that was passed by the caller */
27     void *cipher_pass;
28     size_t cipher_pass_length;
29
30     /* This callback is only used of |cipher_pass| is NULL */
31     OSSL_PASSPHRASE_CALLBACK *cb;
32     void *cbarg;
33 };
34
35 OSSL_FUNC_keymgmt_new_fn *ossl_prov_get_keymgmt_new(const OSSL_DISPATCH *fns);
36 OSSL_FUNC_keymgmt_free_fn *ossl_prov_get_keymgmt_free(const OSSL_DISPATCH *fns);
37 OSSL_FUNC_keymgmt_import_fn *ossl_prov_get_keymgmt_import(const OSSL_DISPATCH *fns);
38 OSSL_FUNC_keymgmt_export_fn *ossl_prov_get_keymgmt_export(const OSSL_DISPATCH *fns);
39
40 OSSL_FUNC_keymgmt_new_fn *ossl_prov_get_keymgmt_rsa_new(void);
41 OSSL_FUNC_keymgmt_new_fn *ossl_prov_get_keymgmt_rsapss_new(void);
42 OSSL_FUNC_keymgmt_free_fn *ossl_prov_get_keymgmt_rsa_free(void);
43 OSSL_FUNC_keymgmt_import_fn *ossl_prov_get_keymgmt_rsa_import(void);
44 OSSL_FUNC_keymgmt_export_fn *ossl_prov_get_keymgmt_rsa_export(void);
45 OSSL_FUNC_keymgmt_export_fn *ossl_prov_get_keymgmt_rsapss_export(void);
46 OSSL_FUNC_keymgmt_new_fn *ossl_prov_get_keymgmt_dh_new(void);
47 OSSL_FUNC_keymgmt_free_fn *ossl_prov_get_keymgmt_dh_free(void);
48 OSSL_FUNC_keymgmt_import_fn *ossl_prov_get_keymgmt_dh_import(void);
49 OSSL_FUNC_keymgmt_new_fn *ossl_prov_get_keymgmt_dsa_new(void);
50 OSSL_FUNC_keymgmt_free_fn *ossl_prov_get_keymgmt_dsa_free(void);
51 OSSL_FUNC_keymgmt_import_fn *ossl_prov_get_keymgmt_dsa_import(void);
52
53 void ec_get_new_free_import(OSSL_FUNC_keymgmt_new_fn **ec_new,
54                             OSSL_FUNC_keymgmt_free_fn **ec_free,
55                             OSSL_FUNC_keymgmt_import_fn **ec_import);
56
57 int ossl_prov_prepare_ec_params(const void *eckey, int nid,
58                                 void **pstr, int *pstrtype);
59 int ossl_prov_ec_pub_to_der(const void *eckey, unsigned char **pder);
60 int ossl_prov_ec_priv_to_der(const void *eckey, unsigned char **pder);
61
62 int ffc_params_prov_print(BIO *out, const FFC_PARAMS *ffc);
63 int ossl_prov_prepare_dh_params(const void *dh, int nid,
64                                 void **pstr, int *pstrtype);
65 int ossl_prov_dh_pub_to_der(const void *dh, unsigned char **pder);
66 int ossl_prov_dh_priv_to_der(const void *dh, unsigned char **pder);
67 int ossl_prov_dh_type_to_evp(const DH *dh);
68
69 #ifndef OPENSSL_NO_EC
70 void ecx_get_new_free_import(ECX_KEY_TYPE type,
71                              OSSL_FUNC_keymgmt_new_fn **ecx_new,
72                              OSSL_FUNC_keymgmt_free_fn **ecx_free,
73                              OSSL_FUNC_keymgmt_import_fn **ecx_import);
74 int ossl_prov_ecx_pub_to_der(const void *ecxkey, unsigned char **pder);
75 int ossl_prov_ecx_priv_to_der(const void *ecxkey, unsigned char **pder);
76 #endif
77
78 int ossl_prov_prepare_dsa_params(const void *dsa, int nid,
79                                 void **pstr, int *pstrtype);
80 /*
81  * Special variant of ossl_prov_prepare_dsa_params() that requires all
82  * three parameters (P, Q and G) to be set.  This is used when encoding
83  * the public key.
84  */
85 int ossl_prov_prepare_all_dsa_params(const void *dsa, int nid,
86                                      void **pstr, int *pstrtype);
87 int ossl_prov_dsa_pub_to_der(const void *dsa, unsigned char **pder);
88 int ossl_prov_dsa_priv_to_der(const void *dsa, unsigned char **pder);
89
90 /*
91  * ossl_prov_prepare_rsa_params() is designed to work with the ossl_prov_write_
92  * functions, hence 'void *rsa' rather than 'RSA *rsa'.
93  */
94 int ossl_prov_prepare_rsa_params(const void *rsa, int nid,
95                                  void **pstr, int *pstrtype);
96 int ossl_prov_rsa_type_to_evp(const RSA *rsa);
97
98 int ossl_prov_print_labeled_bignum(BIO *out, const char *label,
99                                    const BIGNUM *bn);
100 int ossl_prov_print_labeled_buf(BIO *out, const char *label,
101                                 const unsigned char *buf, size_t buflen);
102 int ossl_prov_print_rsa(BIO *out, RSA *rsa, int priv);
103
104 enum dh_print_type {
105     dh_print_priv,
106     dh_print_pub,
107     dh_print_params
108 };
109
110 int ossl_prov_print_dh(BIO *out, DH *dh, enum dh_print_type type);
111
112 #ifndef OPENSSL_NO_EC
113 enum ec_print_type {
114     ec_print_priv,
115     ec_print_pub,
116     ec_print_params
117 };
118
119 int ossl_prov_print_eckey(BIO *out, EC_KEY *eckey, enum ec_print_type type);
120 #endif /*  OPENSSL_NO_EC */
121
122 enum dsa_print_type {
123     dsa_print_priv,
124     dsa_print_pub,
125     dsa_print_params
126 };
127
128 int ossl_prov_print_dsa(BIO *out, DSA *dsa, enum dsa_print_type type);
129
130 enum ecx_print_type {
131     ecx_print_priv,
132     ecx_print_pub
133 };
134
135 #ifndef OPENSSL_NO_EC
136 int ossl_prov_print_ecx(BIO *out, ECX_KEY *ecxkey, enum ecx_print_type type);
137 #endif
138
139 int ossl_prov_write_priv_der_from_obj(BIO *out, const void *obj, int obj_nid,
140                                       int (*p2s)(const void *obj, int nid,
141                                                  void **str,
142                                                  int *strtype),
143                                       int (*k2d)(const void *obj,
144                                                  unsigned char **pder),
145                                       struct pkcs8_encrypt_ctx_st *ctx);
146 int ossl_prov_write_priv_pem_from_obj(BIO *out, const void *obj, int obj_nid,
147                                       int (*p2s)(const void *obj, int nid,
148                                                  void **str,
149                                                  int *strtype),
150                                       int (*k2d)(const void *obj,
151                                                  unsigned char **pder),
152                                       struct pkcs8_encrypt_ctx_st *ctx);
153 int ossl_prov_write_pub_der_from_obj(BIO *out, const void *obj, int obj_nid,
154                                      int (*p2s)(const void *obj, int nid,
155                                                 void **str,
156                                                 int *strtype),
157                                      int (*k2d)(const void *obj,
158                                                 unsigned char **pder));
159 int ossl_prov_write_pub_pem_from_obj(BIO *out, const void *obj, int obj_nid,
160                                      int (*p2s)(const void *obj, int nid,
161                                                 void **str,
162                                                 int *strtype),
163                                      int (*k2d)(const void *obj,
164                                                 unsigned char **pder));
165
166 int ossl_prov_read_der(PROV_CTX *provctx, OSSL_CORE_BIO *cin,
167                        unsigned char **data, long *len);
168 int ossl_prov_read_pem(PROV_CTX *provctx, OSSL_CORE_BIO *cin,
169                        char **pem_name, char **pem_header,
170                        unsigned char **data, long *len);
171 #ifndef OPENSSL_NO_DSA
172 EVP_PKEY *ossl_prov_read_msblob(PROV_CTX *provctx, OSSL_CORE_BIO *cin,
173                                 int *ispub);
174 # ifndef OPENSSL_NO_RC4
175 EVP_PKEY *ossl_prov_read_pvk(PROV_CTX *provctx, OSSL_CORE_BIO *cin,
176                              OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg);
177 # endif
178 #endif
179
180 int ossl_prov_der_from_p8(unsigned char **new_der, long *new_der_len,
181                           unsigned char *input_der, long input_der_len,
182                           OSSL_PASSPHRASE_CALLBACK *pw_cb, void *pw_cbarg);
183