projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 71a5516d | 1 | /* |
| 6738bf14 | 2 | * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. |
| 71a5516d RL |
3 | * |
| 4 | * Licensed under the OpenSSL license (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 HEADER_OSSL_STORE_H | |
| 11 | # define HEADER_OSSL_STORE_H | |
| 12 | ||
| 13 | # include <stdarg.h> | |
| 14 | # include <openssl/ossl_typ.h> | |
| 15 | # include <openssl/pem.h> | |
| 16 | # include <openssl/storeerr.h> | |
| 17 | ||
| 18 | # ifdef __cplusplus | |
| 19 | extern "C" { | |
| 20 | # endif | |
| 21 | ||
| 22 | /*- | |
| 23 | * The main OSSL_STORE functions. | |
| 24 | * ------------------------------ | |
| 25 | * | |
| 26 | * These allow applications to open a channel to a resource with supported | |
| 27 | * data (keys, certs, crls, ...), read the data a piece at a time and decide | |
| 28 | * what to do with it, and finally close. | |
| 29 | */ | |
| 30 | ||
| 31 | typedef struct ossl_store_ctx_st OSSL_STORE_CTX; | |
| 32 | ||
| 33 | /* | |
| 34 | * Typedef for the OSSL_STORE_INFO post processing callback. This can be used | |
| 35 | * to massage the given OSSL_STORE_INFO, or to drop it entirely (by returning | |
| 36 | * NULL). | |
| 37 | */ | |
| 38 | typedef OSSL_STORE_INFO *(*OSSL_STORE_post_process_info_fn)(OSSL_STORE_INFO *, | |
| 39 | void *); | |
| 40 | ||
| 41 | /* | |
| 42 | * Open a channel given a URI. The given UI method will be used any time the | |
| 43 | * loader needs extra input, for example when a password or pin is needed, and | |
| 44 | * will be passed the same user data every time it's needed in this context. | |
| 45 | * | |
| 46 | * Returns a context reference which represents the channel to communicate | |
| 47 | * through. | |
| 48 | */ | |
| 49 | OSSL_STORE_CTX *OSSL_STORE_open(const char *uri, const UI_METHOD *ui_method, | |
| 50 | void *ui_data, | |
| 51 | OSSL_STORE_post_process_info_fn post_process, | |
| 52 | void *post_process_data); | |
| 53 | ||
| 54 | /* | |
| 55 | * Control / fine tune the OSSL_STORE channel. |cmd| determines what is to be | |
| 56 | * done, and depends on the underlying loader (use OSSL_STORE_get0_scheme to | |
| 57 | * determine which loader is used), except for common commands (see below). | |
| 58 | * Each command takes different arguments. | |
| 59 | */ | |
| 60 | int OSSL_STORE_ctrl(OSSL_STORE_CTX *ctx, int cmd, ... /* args */); | |
| 61 | ||
| 62 | /* | |
| 63 | * Common ctrl commands that different loaders may choose to support. | |
| 64 | */ | |
| 7852f588 RL |
65 | /* int on = 0 or 1; STORE_ctrl(ctx, STORE_C_USE_SECMEM, &on); */ |
| 66 | # define OSSL_STORE_C_USE_SECMEM 1 | |
| 71a5516d RL |
67 | /* Where custom commands start */ |
| 68 | # define OSSL_STORE_C_CUSTOM_START 100 | |
| 69 | ||
| 70 | /* | |
| 71 | * Read one data item (a key, a cert, a CRL) that is supported by the OSSL_STORE | |
| 72 | * functionality, given a context. | |
| 73 | * Returns a OSSL_STORE_INFO pointer, from which OpenSSL typed data can be | |
| 74 | * extracted with OSSL_STORE_INFO_get0_PKEY(), OSSL_STORE_INFO_get0_CERT(), ... | |
| 75 | * NULL is returned on error, which may include that the data found at the URI | |
| 76 | * can't be figured out for certain or is ambiguous. | |
| 77 | */ | |
| 78 | OSSL_STORE_INFO *OSSL_STORE_load(OSSL_STORE_CTX *ctx); | |
| 79 | ||
| 80 | /* | |
| 81 | * Check if end of data (end of file) is reached | |
| 82 | * Returns 1 on end, 0 otherwise. | |
| 83 | */ | |
| 84 | int OSSL_STORE_eof(OSSL_STORE_CTX *ctx); | |
| 85 | ||
| 86 | /* | |
| 87 | * Check if an error occured | |
| 88 | * Returns 1 if it did, 0 otherwise. | |
| 89 | */ | |
| 90 | int OSSL_STORE_error(OSSL_STORE_CTX *ctx); | |
| 91 | ||
| 92 | /* | |
| 93 | * Close the channel | |
| 94 | * Returns 1 on success, 0 on error. | |
| 95 | */ | |
| 96 | int OSSL_STORE_close(OSSL_STORE_CTX *ctx); | |
| 97 | ||
| 98 | ||
| 99 | /*- | |
| 100 | * Extracting OpenSSL types from and creating new OSSL_STORE_INFOs | |
| 101 | * --------------------------------------------------------------- | |
| 102 | */ | |
| 103 | ||
| 104 | /* | |
| 105 | * Types of data that can be ossl_stored in a OSSL_STORE_INFO. | |
| 106 | * OSSL_STORE_INFO_NAME is typically found when getting a listing of | |
| 107 | * available "files" / "tokens" / what have you. | |
| 108 | */ | |
| 109 | # define OSSL_STORE_INFO_NAME 1 /* char * */ | |
| 110 | # define OSSL_STORE_INFO_PARAMS 2 /* EVP_PKEY * */ | |
| 111 | # define OSSL_STORE_INFO_PKEY 3 /* EVP_PKEY * */ | |
| 112 | # define OSSL_STORE_INFO_CERT 4 /* X509 * */ | |
| 113 | # define OSSL_STORE_INFO_CRL 5 /* X509_CRL * */ | |
| 114 | ||
| 115 | /* | |
| 116 | * Functions to generate OSSL_STORE_INFOs, one function for each type we | |
| 1fb2993d | 117 | * support having in them, as well as a generic constructor. |
| 71a5516d RL |
118 | * |
| 119 | * In all cases, ownership of the object is transfered to the OSSL_STORE_INFO | |
| 120 | * and will therefore be freed when the OSSL_STORE_INFO is freed. | |
| 121 | */ | |
| 122 | OSSL_STORE_INFO *OSSL_STORE_INFO_new_NAME(char *name); | |
| 123 | int OSSL_STORE_INFO_set0_NAME_description(OSSL_STORE_INFO *info, char *desc); | |
| 124 | OSSL_STORE_INFO *OSSL_STORE_INFO_new_PARAMS(EVP_PKEY *params); | |
| 125 | OSSL_STORE_INFO *OSSL_STORE_INFO_new_PKEY(EVP_PKEY *pkey); | |
| 126 | OSSL_STORE_INFO *OSSL_STORE_INFO_new_CERT(X509 *x509); | |
| 127 | OSSL_STORE_INFO *OSSL_STORE_INFO_new_CRL(X509_CRL *crl); | |
| 128 | ||
| 129 | /* | |
| 130 | * Functions to try to extract data from a OSSL_STORE_INFO. | |
| 131 | */ | |
| 132 | int OSSL_STORE_INFO_get_type(const OSSL_STORE_INFO *info); | |
| 133 | const char *OSSL_STORE_INFO_get0_NAME(const OSSL_STORE_INFO *info); | |
| 134 | char *OSSL_STORE_INFO_get1_NAME(const OSSL_STORE_INFO *info); | |
| 135 | const char *OSSL_STORE_INFO_get0_NAME_description(const OSSL_STORE_INFO *info); | |
| 136 | char *OSSL_STORE_INFO_get1_NAME_description(const OSSL_STORE_INFO *info); | |
| 137 | EVP_PKEY *OSSL_STORE_INFO_get0_PARAMS(const OSSL_STORE_INFO *info); | |
| 138 | EVP_PKEY *OSSL_STORE_INFO_get1_PARAMS(const OSSL_STORE_INFO *info); | |
| 139 | EVP_PKEY *OSSL_STORE_INFO_get0_PKEY(const OSSL_STORE_INFO *info); | |
| 140 | EVP_PKEY *OSSL_STORE_INFO_get1_PKEY(const OSSL_STORE_INFO *info); | |
| 141 | X509 *OSSL_STORE_INFO_get0_CERT(const OSSL_STORE_INFO *info); | |
| 142 | X509 *OSSL_STORE_INFO_get1_CERT(const OSSL_STORE_INFO *info); | |
| 143 | X509_CRL *OSSL_STORE_INFO_get0_CRL(const OSSL_STORE_INFO *info); | |
| 144 | X509_CRL *OSSL_STORE_INFO_get1_CRL(const OSSL_STORE_INFO *info); | |
| 145 | ||
| 146 | const char *OSSL_STORE_INFO_type_string(int type); | |
| 147 | ||
| 148 | /* | |
| 149 | * Free the OSSL_STORE_INFO | |
| 150 | */ | |
| 151 | void OSSL_STORE_INFO_free(OSSL_STORE_INFO *info); | |
| 152 | ||
| 153 | ||
| 154 | /*- | |
| 155 | * Function to register a loader for the given URI scheme. | |
| 156 | * ------------------------------------------------------- | |
| 157 | * | |
| 158 | * The loader receives all the main components of an URI except for the | |
| 159 | * scheme. | |
| 160 | */ | |
| 161 | ||
| 162 | typedef struct ossl_store_loader_st OSSL_STORE_LOADER; | |
| f91ded1f RL |
163 | OSSL_STORE_LOADER *OSSL_STORE_LOADER_new(ENGINE *e, const char *scheme); |
| 164 | const ENGINE *OSSL_STORE_LOADER_get0_engine(const OSSL_STORE_LOADER *loader); | |
| 71a5516d RL |
165 | const char *OSSL_STORE_LOADER_get0_scheme(const OSSL_STORE_LOADER *loader); |
| 166 | /* struct ossl_store_loader_ctx_st is defined differently by each loader */ | |
| 167 | typedef struct ossl_store_loader_ctx_st OSSL_STORE_LOADER_CTX; | |
| 168 | typedef OSSL_STORE_LOADER_CTX *(*OSSL_STORE_open_fn)(const OSSL_STORE_LOADER | |
| 169 | *loader, | |
| 170 | const char *uri, | |
| 171 | const UI_METHOD *ui_method, | |
| 172 | void *ui_data); | |
| 173 | int OSSL_STORE_LOADER_set_open(OSSL_STORE_LOADER *loader, | |
| 174 | OSSL_STORE_open_fn open_function); | |
| 175 | typedef int (*OSSL_STORE_ctrl_fn)(OSSL_STORE_LOADER_CTX *ctx, int cmd, | |
| 176 | va_list args); | |
| 177 | int OSSL_STORE_LOADER_set_ctrl(OSSL_STORE_LOADER *loader, | |
| 178 | OSSL_STORE_ctrl_fn ctrl_function); | |
| 179 | typedef OSSL_STORE_INFO *(*OSSL_STORE_load_fn)(OSSL_STORE_LOADER_CTX *ctx, | |
| 180 | const UI_METHOD *ui_method, | |
| 181 | void *ui_data); | |
| 182 | int OSSL_STORE_LOADER_set_load(OSSL_STORE_LOADER *loader, | |
| 183 | OSSL_STORE_load_fn load_function); | |
| 184 | typedef int (*OSSL_STORE_eof_fn)(OSSL_STORE_LOADER_CTX *ctx); | |
| 185 | int OSSL_STORE_LOADER_set_eof(OSSL_STORE_LOADER *loader, | |
| 186 | OSSL_STORE_eof_fn eof_function); | |
| 187 | typedef int (*OSSL_STORE_error_fn)(OSSL_STORE_LOADER_CTX *ctx); | |
| 188 | int OSSL_STORE_LOADER_set_error(OSSL_STORE_LOADER *loader, | |
| 189 | OSSL_STORE_error_fn error_function); | |
| 190 | typedef int (*OSSL_STORE_close_fn)(OSSL_STORE_LOADER_CTX *ctx); | |
| 191 | int OSSL_STORE_LOADER_set_close(OSSL_STORE_LOADER *loader, | |
| 192 | OSSL_STORE_close_fn close_function); | |
| 193 | void OSSL_STORE_LOADER_free(OSSL_STORE_LOADER *loader); | |
| 194 | ||
| 195 | int OSSL_STORE_register_loader(OSSL_STORE_LOADER *loader); | |
| 196 | OSSL_STORE_LOADER *OSSL_STORE_unregister_loader(const char *scheme); | |
| 197 | ||
| f91ded1f RL |
198 | /*- |
| 199 | * Functions to list STORE loaders | |
| 200 | * ------------------------------- | |
| 201 | */ | |
| 202 | int OSSL_STORE_do_all_loaders(void (*do_function) (const OSSL_STORE_LOADER | |
| 203 | *loader, void *do_arg), | |
| 204 | void *do_arg); | |
| 205 | ||
| 71a5516d RL |
206 | # ifdef __cplusplus |
| 207 | } | |
| 208 | # endif | |
| 209 | #endif |