1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/netwerk/srtp/src/crypto/include/cryptoalg.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,133 @@
1.4 +/*
1.5 + * cryptoalg.h
1.6 + *
1.7 + * API for authenticated encryption crypto algorithms
1.8 + *
1.9 + * David A. McGrew
1.10 + * Cisco Systems, Inc.
1.11 + */
1.12 +/*
1.13 + *
1.14 + * Copyright (c) 2001-2006 Cisco Systems, Inc.
1.15 + * All rights reserved.
1.16 + *
1.17 + * Redistribution and use in source and binary forms, with or without
1.18 + * modification, are permitted provided that the following conditions
1.19 + * are met:
1.20 + *
1.21 + * Redistributions of source code must retain the above copyright
1.22 + * notice, this list of conditions and the following disclaimer.
1.23 + *
1.24 + * Redistributions in binary form must reproduce the above
1.25 + * copyright notice, this list of conditions and the following
1.26 + * disclaimer in the documentation and/or other materials provided
1.27 + * with the distribution.
1.28 + *
1.29 + * Neither the name of the Cisco Systems, Inc. nor the names of its
1.30 + * contributors may be used to endorse or promote products derived
1.31 + * from this software without specific prior written permission.
1.32 + *
1.33 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.34 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.35 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
1.36 + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
1.37 + * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
1.38 + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1.39 + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1.40 + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1.41 + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1.42 + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.43 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
1.44 + * OF THE POSSIBILITY OF SUCH DAMAGE.
1.45 + *
1.46 + */
1.47 +
1.48 +#ifndef CRYPTOALG_H
1.49 +#define CRYPTOALG_H
1.50 +
1.51 +#include "err.h"
1.52 +
1.53 +/**
1.54 + * @defgroup Crypto Cryptography
1.55 + *
1.56 + * Zed uses a simple interface to a cryptographic transform.
1.57 + *
1.58 + * @{
1.59 + */
1.60 +
1.61 +/**
1.62 + * @brief applies a crypto algorithm
1.63 + *
1.64 + * The function pointer cryptoalg_func_t points to a function that
1.65 + * implements a crypto transform, and provides a uniform API for
1.66 + * accessing crypto mechanisms.
1.67 + *
1.68 + * @param key location of secret key
1.69 + *
1.70 + * @param clear data to be authenticated but not encrypted
1.71 + *
1.72 + * @param clear_len length of data to be authenticated but not encrypted
1.73 + *
1.74 + * @param iv location to write the Initialization Vector (IV)
1.75 + *
1.76 + * @param protect location of the data to be encrypted and
1.77 + * authenticated (before the function call), and the ciphertext
1.78 + * and authentication tag (after the call)
1.79 + *
1.80 + * @param protected_len location of the length of the data to be
1.81 + * encrypted and authenticated (before the function call), and the
1.82 + * length of the ciphertext (after the call)
1.83 + *
1.84 + */
1.85 +
1.86 +typedef err_status_t (*cryptoalg_func_t)
1.87 + (void *key,
1.88 + const void *clear,
1.89 + unsigned clear_len,
1.90 + void *iv,
1.91 + void *protect,
1.92 + unsigned *protected_len);
1.93 +
1.94 +typedef
1.95 +err_status_t (*cryptoalg_inv_t)
1.96 + (void *key, /* location of secret key */
1.97 + const void *clear, /* data to be authenticated only */
1.98 + unsigned clear_len, /* length of data to be authenticated only */
1.99 + void *iv, /* location of iv */
1.100 + void *opaque, /* data to be decrypted and authenticated */
1.101 + unsigned *opaque_len /* location of the length of data to be
1.102 + * decrypted and authd (before and after)
1.103 + */
1.104 + );
1.105 +
1.106 +typedef struct cryptoalg_ctx_t {
1.107 + cryptoalg_func_t enc;
1.108 + cryptoalg_inv_t dec;
1.109 + unsigned key_len;
1.110 + unsigned iv_len;
1.111 + unsigned auth_tag_len;
1.112 + unsigned max_expansion;
1.113 +} cryptoalg_ctx_t;
1.114 +
1.115 +typedef cryptoalg_ctx_t *cryptoalg_t;
1.116 +
1.117 +#define cryptoalg_get_key_len(cryptoalg) ((cryptoalg)->key_len)
1.118 +
1.119 +#define cryptoalg_get_iv_len(cryptoalg) ((cryptoalg)->iv_len)
1.120 +
1.121 +#define cryptoalg_get_auth_tag_len(cryptoalg) ((cryptoalg)->auth_tag_len)
1.122 +
1.123 +int
1.124 +cryptoalg_get_id(cryptoalg_t c);
1.125 +
1.126 +cryptoalg_t
1.127 +cryptoalg_find_by_id(int id);
1.128 +
1.129 +
1.130 +/**
1.131 + * @}
1.132 + */
1.133 +
1.134 +#endif /* CRYPTOALG_H */
1.135 +
1.136 +
