include/openssl/encoder.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 #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
  29 OSSL_ENCODER *OSSL_ENCODER_fetch(OPENSSL_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);
  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
  39 void OSSL_ENCODER_do_all_provided(OPENSSL_CTX *libctx,
  40                                   void (*fn)(OSSL_ENCODER *encoder, void *arg),
  41                                   void *arg);
  42 void OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,
  43                                void (*fn)(const char *name, void *data),
  44                                void *data);
  45 const OSSL_PARAM *OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder);
  46 int OSSL_ENCODER_get_params(OSSL_ENCODER *encoder, OSSL_PARAM params[]);
  47
  48 const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder);
  49 OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(void);
  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 */
  55 int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx,
  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);
  59 int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx,
  60                                        OSSL_PASSPHRASE_CALLBACK *cb,
  61                                        void *cbarg);
  62 int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx,
  63                                        const UI_METHOD *ui_method,
  64                                        void *ui_data);
  65 int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx,
  66                                 const char *cipher_name,
  67                                 const char *propquery);
  68 int OSSL_ENCODER_CTX_set_output_type(OSSL_ENCODER_CTX *ctx,
  69                                      const char *output_type);
  70 int OSSL_ENCODER_CTX_set_selection(OSSL_ENCODER_CTX *ctx, int selection);
  71
  72 /* Utilities to add encoders */
  73 int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder);
  74 int OSSL_ENCODER_CTX_add_extra(OSSL_ENCODER_CTX *ctx,
  75                                OPENSSL_CTX *libctx, const char *propq);
  76 int OSSL_ENCODER_CTX_get_num_encoders(OSSL_ENCODER_CTX *ctx);
  77
  78 typedef struct ossl_encoder_instance_st OSSL_ENCODER_INSTANCE;
  79 OSSL_ENCODER *
  80 OSSL_ENCODER_INSTANCE_get_encoder(OSSL_ENCODER_INSTANCE *encoder_inst);
  81 void *
  82 OSSL_ENCODER_INSTANCE_get_encoder_ctx(OSSL_ENCODER_INSTANCE *encoder_inst);
  83 const char *
  84 OSSL_ENCODER_INSTANCE_get_input_type(OSSL_ENCODER_INSTANCE *encoder_inst);
  85 const char *
  86 OSSL_ENCODER_INSTANCE_get_output_type(OSSL_ENCODER_INSTANCE *encoder_inst);
  87
  88 typedef const void *OSSL_ENCODER_CONSTRUCT(OSSL_ENCODER_INSTANCE *encoder_inst,
  89                                            void *construct_data);
  90 typedef void OSSL_ENCODER_CLEANUP(void *construct_data);
  91
  92 int OSSL_ENCODER_CTX_set_construct(OSSL_ENCODER_CTX *ctx,
  93                                    OSSL_ENCODER_CONSTRUCT *construct);
  94 int OSSL_ENCODER_CTX_set_construct_data(OSSL_ENCODER_CTX *ctx,
  95                                         void *construct_data);
  96 int OSSL_ENCODER_CTX_set_cleanup(OSSL_ENCODER_CTX *ctx,
  97                                  OSSL_ENCODER_CLEANUP *cleanup);
  98
  99 /* Utilities to output the object to encode */
 100 int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out);
 101 #ifndef OPENSSL_NO_STDIO
 102 int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp);
 103 #endif
 104
 105 /*
 106  * Create the OSSL_ENCODER_CTX with an associated type.  This will perform
 107  * an implicit OSSL_ENCODER_fetch(), suitable for the object of that type.
 108  * This is more useful than calling OSSL_ENCODER_CTX_new().
 109  */
 110 OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_by_EVP_PKEY(const EVP_PKEY *pkey,
 111                                                    const char *output_type,
 112                                                    int selection,
 113                                                    OPENSSL_CTX *libctx,
 114                                                    const char *propquery);
 115
 116 # ifdef __cplusplus
 117 }
 118 # endif
 119 #endif