crypto/store/str_locl.h

   1 /* crypto/store/str_locl.h -*- mode:C; c-file-style: "eay" -*- */
   2 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
   3  * project 2003.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  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
  18  *    distribution.
  19  *
  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/)"
  24  *
  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.
  29  *
  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.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38  *
  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  * ====================================================================
  52  *
  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).
  56  *
  57  */
  58
  59 #ifndef HEADER_STORE_LOCL_H
  60 #define HEADER_STORE_LOCL_H
  61
  62 #include <openssl/store.h>
  63
  64 #ifdef  __cplusplus
  65 extern "C" {
  66 #endif
  67
  68 struct store_method_st
  69         {
  70         char *name;
  71
  72         /* All the functions return a positive integer or non-NULL for success
  73            and 0, a negative integer or NULL for failure */
  74
  75         /* Initialise the STORE with private data */
  76         STORE_INITIALISE_FUNC_PTR init;
  77         /* Initialise the STORE with private data */
  78         STORE_CLEANUP_FUNC_PTR clean;
  79         /* Generate an object of a given type */
  80         STORE_GENERATE_OBJECT_FUNC_PTR generate_object;
  81         /* Get an object of a given type.  This function isn't really very
  82            useful since the listing functions (below) can be used for the
  83            same purpose and are much more general. */
  84         STORE_GET_OBJECT_FUNC_PTR get_object;
  85         /* Store an object of a given type. */
  86         STORE_STORE_OBJECT_FUNC_PTR store_object;
  87         /* Modify the attributes bound to an object of a given type. */
  88         STORE_MODIFY_OBJECT_FUNC_PTR modify_object;
  89         /* Revoke an object of a given type. */
  90         STORE_HANDLE_OBJECT_FUNC_PTR revoke_object;
  91         /* Delete an object of a given type. */
  92         STORE_HANDLE_OBJECT_FUNC_PTR delete_object;
  93         /* List a bunch of objects of a given type and with the associated
  94            attributes. */
  95         STORE_START_OBJECT_FUNC_PTR list_object_start;
  96         STORE_NEXT_OBJECT_FUNC_PTR list_object_next;
  97         STORE_END_OBJECT_FUNC_PTR list_object_end;
  98         STORE_END_OBJECT_FUNC_PTR list_object_endp;
  99         /* Store-level function to make any necessary update operations. */
 100         STORE_GENERIC_FUNC_PTR update_store;
 101         /* Store-level function to get exclusive access to the store. */
 102         STORE_GENERIC_FUNC_PTR lock_store;
 103         /* Store-level function to release exclusive access to the store. */
 104         STORE_GENERIC_FUNC_PTR unlock_store;
 105
 106         /* Generic control function */
 107         STORE_CTRL_FUNC_PTR ctrl;
 108         };
 109
 110 struct store_st
 111         {
 112         const STORE_METHOD *meth;
 113         /* functional reference if 'meth' is ENGINE-provided */
 114         ENGINE *engine;
 115
 116         CRYPTO_EX_DATA ex_data;
 117         int references;
 118         };
 119 #ifdef  __cplusplus
 120 }
 121 #endif
 122
 123 #endif