michael@0: /* michael@0: * xfm.h michael@0: * michael@0: * interface for abstract crypto transform michael@0: * michael@0: * David A. McGrew michael@0: * Cisco Systems, Inc. michael@0: */ michael@0: /* michael@0: * michael@0: * Copyright (c) 2001-2006, Cisco Systems, Inc. michael@0: * All rights reserved. michael@0: * michael@0: * Redistribution and use in source and binary forms, with or without michael@0: * modification, are permitted provided that the following conditions michael@0: * are met: michael@0: * michael@0: * Redistributions of source code must retain the above copyright michael@0: * notice, this list of conditions and the following disclaimer. michael@0: * michael@0: * Redistributions in binary form must reproduce the above michael@0: * copyright notice, this list of conditions and the following michael@0: * disclaimer in the documentation and/or other materials provided michael@0: * with the distribution. michael@0: * michael@0: * Neither the name of the Cisco Systems, Inc. nor the names of its michael@0: * contributors may be used to endorse or promote products derived michael@0: * from this software without specific prior written permission. michael@0: * michael@0: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS michael@0: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT michael@0: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS michael@0: * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE michael@0: * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, michael@0: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES michael@0: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR michael@0: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) michael@0: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, michael@0: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) michael@0: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED michael@0: * OF THE POSSIBILITY OF SUCH DAMAGE. michael@0: * michael@0: */ michael@0: michael@0: #ifndef XFM_H michael@0: #define XFM_H michael@0: michael@0: #include "crypto_kernel.h" michael@0: #include "err.h" michael@0: michael@0: /** michael@0: * @defgroup Crypto Cryptography michael@0: * michael@0: * A simple interface to an abstract cryptographic transform that michael@0: * provides both confidentiality and message authentication. michael@0: * michael@0: * @{ michael@0: */ michael@0: michael@0: /** michael@0: * @brief applies a crypto transform michael@0: * michael@0: * The function pointer xfm_func_t points to a function that michael@0: * implements a crypto transform, and provides a uniform API for michael@0: * accessing crypto mechanisms. michael@0: * michael@0: * @param key location of secret key michael@0: * michael@0: * @param clear data to be authenticated only michael@0: * michael@0: * @param clear_len length of data to be authenticated only michael@0: * michael@0: * @param iv location to write the Initialization Vector (IV) michael@0: * michael@0: * @param protect location of the data to be encrypted and michael@0: * authenticated (before the function call), and the ciphertext michael@0: * and authentication tag (after the call) michael@0: * michael@0: * @param protected_len location of the length of the data to be michael@0: * encrypted and authenticated (before the function call), and the michael@0: * length of the ciphertext (after the call) michael@0: * michael@0: * @param auth_tag location to write auth tag michael@0: */ michael@0: michael@0: typedef err_status_t (*xfm_func_t) michael@0: (void *key, michael@0: void *clear, michael@0: unsigned clear_len, michael@0: void *iv, michael@0: void *protect, michael@0: unsigned *protected_len, michael@0: void *auth_tag michael@0: ); michael@0: michael@0: typedef michael@0: err_status_t (*xfm_inv_t) michael@0: (void *key, /* location of secret key */ michael@0: void *clear, /* data to be authenticated only */ michael@0: unsigned clear_len, /* length of data to be authenticated only */ michael@0: void *iv, /* location of iv */ michael@0: void *opaque, /* data to be decrypted and authenticated */ michael@0: unsigned *opaque_len, /* location of the length of data to be michael@0: * decrypted and authd (before and after) michael@0: */ michael@0: void *auth_tag /* location of auth tag */ michael@0: ); michael@0: michael@0: typedef struct xfm_ctx_t { michael@0: xfm_func_t func; michael@0: xfm_inv_t inv; michael@0: unsigned key_len; michael@0: unsigned iv_len; michael@0: unsigned auth_tag_len; michael@0: } xfm_ctx_t; michael@0: michael@0: typedef xfm_ctx_t *xfm_t; michael@0: michael@0: #define xfm_get_key_len(xfm) ((xfm)->key_len) michael@0: michael@0: #define xfm_get_iv_len(xfm) ((xfm)->iv_len) michael@0: michael@0: #define xfm_get_auth_tag_len(xfm) ((xfm)->auth_tag_len) michael@0: michael@0: michael@0: /* cryptoalgo - 5/28 */ michael@0: michael@0: typedef err_status_t (*cryptoalg_func_t) michael@0: (void *key, michael@0: void *clear, michael@0: unsigned clear_len, michael@0: void *iv, michael@0: void *opaque, michael@0: unsigned *opaque_len michael@0: ); michael@0: michael@0: typedef michael@0: err_status_t (*cryptoalg_inv_t) michael@0: (void *key, /* location of secret key */ michael@0: void *clear, /* data to be authenticated only */ michael@0: unsigned clear_len, /* length of data to be authenticated only */ michael@0: void *iv, /* location of iv */ michael@0: void *opaque, /* data to be decrypted and authenticated */ michael@0: unsigned *opaque_len /* location of the length of data to be michael@0: * decrypted and authd (before and after) michael@0: */ michael@0: ); michael@0: michael@0: typedef struct cryptoalg_ctx_t { michael@0: cryptoalg_func_t enc; michael@0: cryptoalg_inv_t dec; michael@0: unsigned key_len; michael@0: unsigned iv_len; michael@0: unsigned auth_tag_len; michael@0: unsigned max_expansion; michael@0: } cryptoalg_ctx_t; michael@0: michael@0: typedef cryptoalg_ctx_t *cryptoalg_t; michael@0: michael@0: #define cryptoalg_get_key_len(cryptoalg) ((cryptoalg)->key_len) michael@0: michael@0: #define cryptoalg_get_iv_len(cryptoalg) ((cryptoalg)->iv_len) michael@0: michael@0: #define cryptoalg_get_auth_tag_len(cryptoalg) ((cryptoalg)->auth_tag_len) michael@0: michael@0: michael@0: michael@0: /** michael@0: * @} michael@0: */ michael@0: michael@0: #endif /* XFM_H */ michael@0: michael@0: