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