sys/dev/pci/n8/include_private/n8_daemon_sks.h

   1 /*-
   2  * Copyright (C) 2001-2003 by NBMK Encryption Technologies.
   3  * All rights reserved.
   4  *
   5  * NBMK Encryption Technologies provides no support of any kind for
   6  * this software.  Questions or concerns about it may be addressed to
   7  * the members of the relevant open-source community at
   8  * <tech-crypto@netbsd.org>.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are
  12  * met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  17  * 2. Redistributions in binary form must reproduce the above
  18  *    copyright notice, this list of conditions and the following
  19  *    disclaimer in the documentation and/or other materials provided
  20  *    with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*****************************************************************************
  36  * @(#) n8_daemon_sks.h 1.8@(#)
  37  *****************************************************************************/
  38
  39 /*****************************************************************************/
  40 /** @file n8_daemon_sks.h
  41  *  @brief N8 daemon SKS interface include file
  42  *
  43  * This header exports an interface that allows the n8_sks module to
  44  * accomplish filesystem related tasks through the use of the N8
  45  * daemon.
  46  *
  47  *----------------------------------------------------------------------------
  48  * N8 Daemon Functional Interfaces
  49  *----------------------------------------------------------------------------
  50  *
  51  * n8_daemon_sks_init - Initializes SKS allocation mapping for a single
  52  *                      execution unit using the key handle files found
  53  *                      on the host file system.
  54  *
  55  * n8_daemon_sks_read - Reads data from the specified key handle file into
  56  *                      a key handle structure.
  57  *
  58  * n8_daemon_sks_write - Write data in key handle specified into a key
  59  *                       handle file with specified name.
  60  *
  61  * n8_daemon_sks_delete - Deletes specified key handle file from the host
  62  *                        file system.
  63  *
  64  * n8_dameon_sks_reset - Deletes all key handle files from host
  65  *                       file system.
  66  *
  67  *****************************************************************************/
  68
  69 /*****************************************************************************
  70  * Revision history:
  71  * 02/22/02 spm   Changed keyEntryName_p type class to const in sks_write.
  72  * 02/05/02 spm   Removed const typing.
  73  * 01/19/02 spm   Original version.
  74  ****************************************************************************/
  75
  76 #ifndef _N8_DAEMON_SKS_H
  77 #define _N8_DAEMON_SKS_H
  78
  79 /*****************************************************************************
  80  * Function prototypes
  81  *****************************************************************************/
  82
  83 /* Functional interfaces provided to kernel tasks that need to use the
  84  * N8 daemon
  85  */
  86 N8_Status_t n8_daemon_sks_init(N8_Unit_t numberSKS,
  87                                N8_Buffer_t *alloc_map);
  88 N8_Status_t n8_daemon_sks_read(N8_SKSKeyHandle_t* keyHandle_p,
  89                        char *keyEntryPath_p);
  90 N8_Status_t n8_daemon_sks_write(N8_SKSKeyHandle_t *sks_key_p,
  91                        const char *keyEntryName_p);
  92 N8_Status_t n8_daemon_sks_delete(char *keyEntryPath_p);
  93 N8_Status_t n8_daemon_sks_reset(N8_Unit_t targetSKS);
  94
  95
  96 #endif /* _N8_DAEMON_SKS_H */
  97