File Explorer

1/*2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.3 *4 * Licensed under the Apache License 2.0 (the "License").  You may not use5 * this file except in compliance with the License.  You can obtain a copy6 * in the file LICENSE in the source distribution or at7 * https://www.openssl.org/source/license.html8 */9 10#ifndef OPENSSL_ENCODER_H11#define OPENSSL_ENCODER_H12#pragma once13 14#include <openssl/opensslconf.h>15 16#ifndef OPENSSL_NO_STDIO17#include <stdio.h>18#endif19#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 __cplusplus26extern "C" {27#endif28 29OSSL_ENCODER *OSSL_ENCODER_fetch(OSSL_LIB_CTX *libctx, const char *name,30    const char *properties);31int OSSL_ENCODER_up_ref(OSSL_ENCODER *encoder);32void OSSL_ENCODER_free(OSSL_ENCODER *encoder);33 34const OSSL_PROVIDER *OSSL_ENCODER_get0_provider(const OSSL_ENCODER *encoder);35const char *OSSL_ENCODER_get0_properties(const OSSL_ENCODER *encoder);36const char *OSSL_ENCODER_get0_name(const OSSL_ENCODER *kdf);37const char *OSSL_ENCODER_get0_description(const OSSL_ENCODER *kdf);38int OSSL_ENCODER_is_a(const OSSL_ENCODER *encoder, const char *name);39 40void OSSL_ENCODER_do_all_provided(OSSL_LIB_CTX *libctx,41    void (*fn)(OSSL_ENCODER *encoder, void *arg),42    void *arg);43int OSSL_ENCODER_names_do_all(const OSSL_ENCODER *encoder,44    void (*fn)(const char *name, void *data),45    void *data);46const OSSL_PARAM *OSSL_ENCODER_gettable_params(OSSL_ENCODER *encoder);47int OSSL_ENCODER_get_params(OSSL_ENCODER *encoder, OSSL_PARAM params[]);48 49const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder);50OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(void);51int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX *ctx,52    const OSSL_PARAM params[]);53void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX *ctx);54 55/* Utilities that help set specific parameters */56int OSSL_ENCODER_CTX_set_passphrase(OSSL_ENCODER_CTX *ctx,57    const unsigned char *kstr, size_t klen);58int OSSL_ENCODER_CTX_set_pem_password_cb(OSSL_ENCODER_CTX *ctx,59    pem_password_cb *cb, void *cbarg);60int OSSL_ENCODER_CTX_set_passphrase_cb(OSSL_ENCODER_CTX *ctx,61    OSSL_PASSPHRASE_CALLBACK *cb,62    void *cbarg);63int OSSL_ENCODER_CTX_set_passphrase_ui(OSSL_ENCODER_CTX *ctx,64    const UI_METHOD *ui_method,65    void *ui_data);66int OSSL_ENCODER_CTX_set_cipher(OSSL_ENCODER_CTX *ctx,67    const char *cipher_name,68    const char *propquery);69int OSSL_ENCODER_CTX_set_selection(OSSL_ENCODER_CTX *ctx, int selection);70int OSSL_ENCODER_CTX_set_output_type(OSSL_ENCODER_CTX *ctx,71    const char *output_type);72int OSSL_ENCODER_CTX_set_output_structure(OSSL_ENCODER_CTX *ctx,73    const char *output_structure);74 75/* Utilities to add encoders */76int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder);77int OSSL_ENCODER_CTX_add_extra(OSSL_ENCODER_CTX *ctx,78    OSSL_LIB_CTX *libctx, const char *propq);79int OSSL_ENCODER_CTX_get_num_encoders(OSSL_ENCODER_CTX *ctx);80 81typedef struct ossl_encoder_instance_st OSSL_ENCODER_INSTANCE;82OSSL_ENCODER *83OSSL_ENCODER_INSTANCE_get_encoder(OSSL_ENCODER_INSTANCE *encoder_inst);84void *85OSSL_ENCODER_INSTANCE_get_encoder_ctx(OSSL_ENCODER_INSTANCE *encoder_inst);86const char *87OSSL_ENCODER_INSTANCE_get_output_type(OSSL_ENCODER_INSTANCE *encoder_inst);88const char *89OSSL_ENCODER_INSTANCE_get_output_structure(OSSL_ENCODER_INSTANCE *encoder_inst);90 91typedef const void *OSSL_ENCODER_CONSTRUCT(OSSL_ENCODER_INSTANCE *encoder_inst,92    void *construct_data);93typedef void OSSL_ENCODER_CLEANUP(void *construct_data);94 95int OSSL_ENCODER_CTX_set_construct(OSSL_ENCODER_CTX *ctx,96    OSSL_ENCODER_CONSTRUCT *construct);97int OSSL_ENCODER_CTX_set_construct_data(OSSL_ENCODER_CTX *ctx,98    void *construct_data);99int OSSL_ENCODER_CTX_set_cleanup(OSSL_ENCODER_CTX *ctx,100    OSSL_ENCODER_CLEANUP *cleanup);101 102/* Utilities to output the object to encode */103int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out);104#ifndef OPENSSL_NO_STDIO105int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp);106#endif107int OSSL_ENCODER_to_data(OSSL_ENCODER_CTX *ctx, unsigned char **pdata,108    size_t *pdata_len);109 110/*111 * Create the OSSL_ENCODER_CTX with an associated type.  This will perform112 * an implicit OSSL_ENCODER_fetch(), suitable for the object of that type.113 * This is more useful than calling OSSL_ENCODER_CTX_new().114 */115OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new_for_pkey(const EVP_PKEY *pkey,116    int selection,117    const char *output_type,118    const char *output_struct,119    const char *propquery);120 121#ifdef __cplusplus122}123#endif124#endif125