1160814Ssimon/* crypto/store/str_locl.h -*- mode:C; c-file-style: "eay" -*- */ 2296341Sdelphij/* 3296341Sdelphij * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project 4296341Sdelphij * 2003. 5160814Ssimon */ 6160814Ssimon/* ==================================================================== 7160814Ssimon * Copyright (c) 2003 The OpenSSL Project. All rights reserved. 8160814Ssimon * 9160814Ssimon * Redistribution and use in source and binary forms, with or without 10160814Ssimon * modification, are permitted provided that the following conditions 11160814Ssimon * are met: 12160814Ssimon * 13160814Ssimon * 1. Redistributions of source code must retain the above copyright 14296341Sdelphij * notice, this list of conditions and the following disclaimer. 15160814Ssimon * 16160814Ssimon * 2. Redistributions in binary form must reproduce the above copyright 17160814Ssimon * notice, this list of conditions and the following disclaimer in 18160814Ssimon * the documentation and/or other materials provided with the 19160814Ssimon * distribution. 20160814Ssimon * 21160814Ssimon * 3. All advertising materials mentioning features or use of this 22160814Ssimon * software must display the following acknowledgment: 23160814Ssimon * "This product includes software developed by the OpenSSL Project 24160814Ssimon * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 25160814Ssimon * 26160814Ssimon * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 27160814Ssimon * endorse or promote products derived from this software without 28160814Ssimon * prior written permission. For written permission, please contact 29160814Ssimon * openssl-core@openssl.org. 30160814Ssimon * 31160814Ssimon * 5. Products derived from this software may not be called "OpenSSL" 32160814Ssimon * nor may "OpenSSL" appear in their names without prior written 33160814Ssimon * permission of the OpenSSL Project. 34160814Ssimon * 35160814Ssimon * 6. Redistributions of any form whatsoever must retain the following 36160814Ssimon * acknowledgment: 37160814Ssimon * "This product includes software developed by the OpenSSL Project 38160814Ssimon * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 39160814Ssimon * 40160814Ssimon * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 41160814Ssimon * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42160814Ssimon * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 43160814Ssimon * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 44160814Ssimon * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45160814Ssimon * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 46160814Ssimon * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 47160814Ssimon * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48160814Ssimon * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 49160814Ssimon * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 50160814Ssimon * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 51160814Ssimon * OF THE POSSIBILITY OF SUCH DAMAGE. 52160814Ssimon * ==================================================================== 53160814Ssimon * 54160814Ssimon * This product includes cryptographic software written by Eric Young 55160814Ssimon * (eay@cryptsoft.com). This product includes software written by Tim 56160814Ssimon * Hudson (tjh@cryptsoft.com). 57160814Ssimon * 58160814Ssimon */ 59160814Ssimon 60160814Ssimon#ifndef HEADER_STORE_LOCL_H 61296341Sdelphij# define HEADER_STORE_LOCL_H 62160814Ssimon 63296341Sdelphij# include <openssl/crypto.h> 64296341Sdelphij# include <openssl/store.h> 65160814Ssimon 66160814Ssimon#ifdef __cplusplus 67160814Ssimonextern "C" { 68160814Ssimon#endif 69160814Ssimon 70296341Sdelphijstruct store_method_st { 71296341Sdelphij char *name; 72296341Sdelphij /* 73296341Sdelphij * All the functions return a positive integer or non-NULL for success 74296341Sdelphij * and 0, a negative integer or NULL for failure 75296341Sdelphij */ 76296341Sdelphij /* Initialise the STORE with private data */ 77296341Sdelphij STORE_INITIALISE_FUNC_PTR init; 78296341Sdelphij /* Initialise the STORE with private data */ 79296341Sdelphij STORE_CLEANUP_FUNC_PTR clean; 80296341Sdelphij /* Generate an object of a given type */ 81296341Sdelphij STORE_GENERATE_OBJECT_FUNC_PTR generate_object; 82296341Sdelphij /* 83296341Sdelphij * Get an object of a given type. This function isn't really very useful 84296341Sdelphij * since the listing functions (below) can be used for the same purpose 85296341Sdelphij * and are much more general. 86296341Sdelphij */ 87296341Sdelphij STORE_GET_OBJECT_FUNC_PTR get_object; 88296341Sdelphij /* Store an object of a given type. */ 89296341Sdelphij STORE_STORE_OBJECT_FUNC_PTR store_object; 90296341Sdelphij /* Modify the attributes bound to an object of a given type. */ 91296341Sdelphij STORE_MODIFY_OBJECT_FUNC_PTR modify_object; 92296341Sdelphij /* Revoke an object of a given type. */ 93296341Sdelphij STORE_HANDLE_OBJECT_FUNC_PTR revoke_object; 94296341Sdelphij /* Delete an object of a given type. */ 95296341Sdelphij STORE_HANDLE_OBJECT_FUNC_PTR delete_object; 96296341Sdelphij /* 97296341Sdelphij * List a bunch of objects of a given type and with the associated 98296341Sdelphij * attributes. 99296341Sdelphij */ 100296341Sdelphij STORE_START_OBJECT_FUNC_PTR list_object_start; 101296341Sdelphij STORE_NEXT_OBJECT_FUNC_PTR list_object_next; 102296341Sdelphij STORE_END_OBJECT_FUNC_PTR list_object_end; 103296341Sdelphij STORE_END_OBJECT_FUNC_PTR list_object_endp; 104296341Sdelphij /* Store-level function to make any necessary update operations. */ 105296341Sdelphij STORE_GENERIC_FUNC_PTR update_store; 106296341Sdelphij /* Store-level function to get exclusive access to the store. */ 107296341Sdelphij STORE_GENERIC_FUNC_PTR lock_store; 108296341Sdelphij /* Store-level function to release exclusive access to the store. */ 109296341Sdelphij STORE_GENERIC_FUNC_PTR unlock_store; 110296341Sdelphij /* Generic control function */ 111296341Sdelphij STORE_CTRL_FUNC_PTR ctrl; 112296341Sdelphij}; 113160814Ssimon 114296341Sdelphijstruct store_st { 115296341Sdelphij const STORE_METHOD *meth; 116296341Sdelphij /* functional reference if 'meth' is ENGINE-provided */ 117296341Sdelphij ENGINE *engine; 118296341Sdelphij CRYPTO_EX_DATA ex_data; 119296341Sdelphij int references; 120296341Sdelphij}; 121160814Ssimon#ifdef __cplusplus 122160814Ssimon} 123160814Ssimon#endif 124160814Ssimon 125160814Ssimon#endif 126