1386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* 2386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * auth.h 3386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 4386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * common interface to authentication functions 5386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 6386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * David A. McGrew 7386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Cisco Systems, Inc. 8386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari */ 9386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 10386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* 11386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 12386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Copyright (c) 2001-2006, Cisco Systems, Inc. 13386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * All rights reserved. 14386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 15386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Redistribution and use in source and binary forms, with or without 16386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * modification, are permitted provided that the following conditions 17386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * are met: 18386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 19386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Redistributions of source code must retain the above copyright 20386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * notice, this list of conditions and the following disclaimer. 21386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 22386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Redistributions in binary form must reproduce the above 23386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * copyright notice, this list of conditions and the following 24386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * disclaimer in the documentation and/or other materials provided 25386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * with the distribution. 26386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 27386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * Neither the name of the Cisco Systems, Inc. nor the names of its 28386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * contributors may be used to endorse or promote products derived 29386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * from this software without specific prior written permission. 30386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 31386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 34386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 35386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 36386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 37386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 38386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 39386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 40386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 41386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 42386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * OF THE POSSIBILITY OF SUCH DAMAGE. 43386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * 44386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari */ 45386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 46386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#ifndef AUTH_H 47386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define AUTH_H 48386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 49386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#include "datatypes.h" 50386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#include "err.h" /* error codes */ 51386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 52386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef struct auth_type_t *auth_type_pointer; 53386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef struct auth_t *auth_pointer_t; 54386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 55386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_alloc_func) 56386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (auth_pointer_t *ap, int key_len, int out_len); 57386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 58386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_init_func) 59386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (void *state, const uint8_t *key, int key_len); 60386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 61386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_dealloc_func)(auth_pointer_t ap); 62386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 63386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_compute_func) 64386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (void *state, uint8_t *buffer, int octets_to_auth, 65386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int tag_len, uint8_t *tag); 66386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 67386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_update_func) 68386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (void *state, uint8_t *buffer, int octets_to_auth); 69386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 70386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef err_status_t (*auth_start_func)(void *state); 71386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 72386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* some syntactic sugar on these function types */ 73386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 74386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_type_alloc(at, a, klen, outlen) \ 75386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari ((at)->alloc((a), (klen), (outlen))) 76386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 77386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_init(a, key) \ 78386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (((a)->type)->init((a)->state, (key), ((a)->key_len))) 79386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 80386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_compute(a, buf, len, res) \ 81386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (((a)->type)->compute((a)->state, (buf), (len), (a)->out_len, (res))) 82386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 83386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_update(a, buf, len) \ 84386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari (((a)->type)->update((a)->state, (buf), (len))) 85386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 86386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_start(a)(((a)->type)->start((a)->state)) 87386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 88386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#define auth_dealloc(c) (((c)->type)->dealloc(c)) 89386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 90386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* functions to get information about a particular auth_t */ 91386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 92386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariint 93386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariauth_get_key_length(const struct auth_t *a); 94386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 95386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariint 96386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariauth_get_tag_length(const struct auth_t *a); 97386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 98386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariint 99386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariauth_get_prefix_length(const struct auth_t *a); 100386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 101386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* 102386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * auth_test_case_t is a (list of) key/message/tag values that are 103386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * known to be correct for a particular cipher. this data can be used 104386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * to test an implementation in an on-the-fly self test of the 105386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * correcness of the implementation. (see the auth_type_self_test() 106386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * function below) 107386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari */ 108386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 109386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef struct auth_test_case_t { 110386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int key_length_octets; /* octets in key */ 111386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari uint8_t *key; /* key */ 112386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int data_length_octets; /* octets in data */ 113386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari uint8_t *data; /* data */ 114386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int tag_length_octets; /* octets in tag */ 115386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari uint8_t *tag; /* tag */ 116386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari struct auth_test_case_t *next_test_case; /* pointer to next testcase */ 117386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari} auth_test_case_t; 118386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 119386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* auth_type_t */ 120386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 121386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef struct auth_type_t { 122386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_alloc_func alloc; 123386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_dealloc_func dealloc; 124386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_init_func init; 125386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_compute_func compute; 126386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_update_func update; 127386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_start_func start; 128386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari char *description; 129386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int ref_count; 130386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_test_case_t *test_data; 131386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari debug_module_t *debug; 132386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari} auth_type_t; 133386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 134386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagaritypedef struct auth_t { 135386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari auth_type_t *type; 136386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari void *state; 137386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int out_len; /* length of output tag in octets */ 138386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int key_len; /* length of key in octets */ 139386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari int prefix_len; /* length of keystream prefix */ 140386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari} auth_t; 141386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 142386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* 143386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * auth_type_self_test() tests an auth_type against test cases 144386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * provided in an array of values of key/message/tag that is known to 145386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * be good 146386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari */ 147386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 148386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagarierr_status_t 149386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariauth_type_self_test(const auth_type_t *at); 150386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 151386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari/* 152386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * auth_type_get_ref_count(at) returns the reference count (the number 153386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari * of instantiations) of the auth_type_t at 154386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari */ 155386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 156386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariint 157386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagariauth_type_get_ref_count(const auth_type_t *at); 158386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari 159386ce4d9144fc190797f4e43a31aeaf76ca2e373Param Reddappagari#endif /* AUTH_H */ 160