lib/libtcplay/tcplay_api.h

   1 /*
   2  * Copyright (c) 2011 Alex Hornung <alex@alexhornung.com>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  19  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  20  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #define TC_OK   0
  31 #define TC_ERR  -1
  32
  33 typedef struct tc_api_opts {
  34         /* Common fields */
  35         char            *tc_device;
  36         char            *tc_passphrase;
  37         const char      **tc_keyfiles;
  38
  39         /* Fields for mapping */
  40         char            *tc_map_name;
  41         int             tc_password_retries;
  42         int             tc_interactive_prompt;
  43         unsigned long   tc_prompt_timeout;
  44
  45         /* Fields for creation */
  46         char            *tc_cipher;
  47         char            *tc_prf_hash;
  48         char            *tc_cipher_hidden;
  49         char            *tc_prf_hash_hidden;
  50         size_t          tc_size_hidden_in_bytes;
  51         char            *tc_passphrase_hidden;
  52         const char      **tc_keyfiles_hidden;
  53 } tc_api_opts;
  54
  55 int tc_api_init(int verbose);
  56 int tc_api_uninit(void);
  57 int tc_api_create_volume(tc_api_opts *api_opts);
  58 int tc_api_map_volume(tc_api_opts *api_opts);
  59 int tc_api_unmap_volume(tc_api_opts *api_opts);
  60 int tc_api_check_cipher(tc_api_opts *api_opts);
  61 int tc_api_check_prf_hash(tc_api_opts *api_opts);
  62 const char *tc_api_get_error_msg(void);
  63 const char *tc_api_get_summary(void);
  64