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 #ifndef _TCPLAY_API_H
  31 #define _TCPLAY_API_H
  32
  33 #include <stddef.h>
  34
  35 #define TC_OK           0
  36 #define TC_ERR          -1
  37 #define TC_ERR_UNIMPL   -255
  38
  39 #define TC_STATE_ENTER  1
  40 #define TC_STATE_EXIT   0
  41
  42 struct _tc_api_task;
  43
  44 typedef struct _tc_api_task *tc_api_task;
  45
  46 typedef int (*tc_api_cipher_iterator_fn)(void *, const char *, int /* klen */, int /* length */);
  47 typedef int (*tc_api_prf_iterator_fn)(void *, const char *);
  48 typedef int (*tc_api_state_change_fn)(void *, const char *, int);
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 int tc_api_init(int verbose);
  55 int tc_api_uninit(void);
  56
  57 int tc_api_has(const char *feature);
  58
  59 int tc_api_cipher_iterate(tc_api_cipher_iterator_fn fn, void *priv);
  60 int tc_api_prf_iterate(tc_api_prf_iterator_fn fn, void *priv);
  61
  62
  63 tc_api_task tc_api_task_init(const char *op);
  64 int tc_api_task_uninit(tc_api_task task);
  65 int tc_api_task_set(tc_api_task task, const char *key, ...);
  66 int tc_api_task_do(tc_api_task task);
  67
  68 int tc_api_task_info_get(tc_api_task task, const char *key, ...);
  69 const char *tc_api_task_get_error(tc_api_task task);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif