1
/* crypto/store/str_locl.h -*- mode:C; c-file-style: "eay" -*- */
2
/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
5
/* ====================================================================
6
* Copyright (c) 2003 The OpenSSL Project. All rights reserved.
8
* Redistribution and use in source and binary forms, with or without
9
* modification, are permitted provided that the following conditions
12
* 1. Redistributions of source code must retain the above copyright
13
* notice, this list of conditions and the following disclaimer.
15
* 2. Redistributions in binary form must reproduce the above copyright
16
* notice, this list of conditions and the following disclaimer in
17
* the documentation and/or other materials provided with the
20
* 3. All advertising materials mentioning features or use of this
21
* software must display the following acknowledgment:
22
* "This product includes software developed by the OpenSSL Project
23
* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26
* endorse or promote products derived from this software without
27
* prior written permission. For written permission, please contact
28
* openssl-core@openssl.org.
30
* 5. Products derived from this software may not be called "OpenSSL"
31
* nor may "OpenSSL" appear in their names without prior written
32
* permission of the OpenSSL Project.
34
* 6. Redistributions of any form whatsoever must retain the following
36
* "This product includes software developed by the OpenSSL Project
37
* for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50
* OF THE POSSIBILITY OF SUCH DAMAGE.
51
* ====================================================================
53
* This product includes cryptographic software written by Eric Young
54
* (eay@cryptsoft.com). This product includes software written by Tim
55
* Hudson (tjh@cryptsoft.com).
59
#ifndef HEADER_STORE_LOCL_H
60
#define HEADER_STORE_LOCL_H
62
#include <openssl/crypto.h>
63
#include <openssl/store.h>
69
struct store_method_st
73
/* All the functions return a positive integer or non-NULL for success
74
and 0, a negative integer or NULL for failure */
76
/* Initialise the STORE with private data */
77
STORE_INITIALISE_FUNC_PTR init;
78
/* Initialise the STORE with private data */
79
STORE_CLEANUP_FUNC_PTR clean;
80
/* Generate an object of a given type */
81
STORE_GENERATE_OBJECT_FUNC_PTR generate_object;
82
/* Get an object of a given type. This function isn't really very
83
useful since the listing functions (below) can be used for the
84
same purpose and are much more general. */
85
STORE_GET_OBJECT_FUNC_PTR get_object;
86
/* Store an object of a given type. */
87
STORE_STORE_OBJECT_FUNC_PTR store_object;
88
/* Modify the attributes bound to an object of a given type. */
89
STORE_MODIFY_OBJECT_FUNC_PTR modify_object;
90
/* Revoke an object of a given type. */
91
STORE_HANDLE_OBJECT_FUNC_PTR revoke_object;
92
/* Delete an object of a given type. */
93
STORE_HANDLE_OBJECT_FUNC_PTR delete_object;
94
/* List a bunch of objects of a given type and with the associated
96
STORE_START_OBJECT_FUNC_PTR list_object_start;
97
STORE_NEXT_OBJECT_FUNC_PTR list_object_next;
98
STORE_END_OBJECT_FUNC_PTR list_object_end;
99
STORE_END_OBJECT_FUNC_PTR list_object_endp;
100
/* Store-level function to make any necessary update operations. */
101
STORE_GENERIC_FUNC_PTR update_store;
102
/* Store-level function to get exclusive access to the store. */
103
STORE_GENERIC_FUNC_PTR lock_store;
104
/* Store-level function to release exclusive access to the store. */
105
STORE_GENERIC_FUNC_PTR unlock_store;
107
/* Generic control function */
108
STORE_CTRL_FUNC_PTR ctrl;
113
const STORE_METHOD *meth;
114
/* functional reference if 'meth' is ENGINE-provided */
117
CRYPTO_EX_DATA ex_data;