rdb.h (3571B)
1 /* 2 * replay-database.h 3 * 4 * interface for a replay database for packet security 5 * 6 * David A. McGrew 7 * Cisco Systems, Inc. 8 */ 9 10 /* 11 * 12 * Copyright (c) 2001-2017, Cisco Systems, Inc. 13 * All rights reserved. 14 * 15 * Redistribution and use in source and binary forms, with or without 16 * modification, are permitted provided that the following conditions 17 * are met: 18 * 19 * Redistributions of source code must retain the above copyright 20 * notice, this list of conditions and the following disclaimer. 21 * 22 * Redistributions in binary form must reproduce the above 23 * copyright notice, this list of conditions and the following 24 * disclaimer in the documentation and/or other materials provided 25 * with the distribution. 26 * 27 * Neither the name of the Cisco Systems, Inc. nor the names of its 28 * contributors may be used to endorse or promote products derived 29 * from this software without specific prior written permission. 30 * 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 34 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 35 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 36 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 37 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 38 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 42 * OF THE POSSIBILITY OF SUCH DAMAGE. 43 * 44 */ 45 46 #ifndef REPLAY_DB_H 47 #define REPLAY_DB_H 48 49 #include "integers.h" /* for uint32_t */ 50 #include "datatypes.h" /* for v128_t */ 51 #include "err.h" /* for srtp_err_status_t */ 52 53 #ifdef __cplusplus 54 extern "C" { 55 #endif 56 57 /* 58 * if the ith least significant bit is one, then the packet index 59 * window_end-i is in the database 60 */ 61 62 typedef struct { 63 uint32_t window_start; /* packet index of the first bit in bitmask */ 64 v128_t bitmask; 65 } srtp_rdb_t; 66 67 /* 68 * srtp_rdb_init 69 * 70 * initalizes rdb 71 * 72 * returns srtp_err_status_ok on success, srtp_err_status_t_fail otherwise 73 */ 74 srtp_err_status_t srtp_rdb_init(srtp_rdb_t *rdb); 75 76 /* 77 * srtp_rdb_check 78 * 79 * checks to see if index appears in rdb 80 * 81 * returns srtp_err_status_fail if the index already appears in rdb, 82 * returns srtp_err_status_ok otherwise 83 */ 84 srtp_err_status_t srtp_rdb_check(const srtp_rdb_t *rdb, uint32_t rdb_index); 85 86 /* 87 * srtp_rdb_add_index 88 * 89 * adds index to srtp_rdb_t (and does *not* check if index appears in db) 90 * 91 * returns srtp_err_status_ok on success, srtp_err_status_fail otherwise 92 * 93 */ 94 srtp_err_status_t srtp_rdb_add_index(srtp_rdb_t *rdb, uint32_t rdb_index); 95 96 /* 97 * the functions srtp_rdb_increment() and srtp_rdb_get_value() are for use by 98 * senders, not receivers - DO NOT use these functions on the same 99 * srtp_rdb_t upon which srtp_rdb_add_index is used! 100 */ 101 102 /* 103 * srtp_rdb_increment(db) increments the sequence number in db, if it is 104 * not too high 105 * 106 * return values: 107 * 108 * srtp_err_status_ok no problem 109 * srtp_err_status_key_expired sequence number too high 110 * 111 */ 112 srtp_err_status_t srtp_rdb_increment(srtp_rdb_t *rdb); 113 114 /* 115 * srtp_rdb_get_value(db) returns the current sequence number of db 116 */ 117 uint32_t srtp_rdb_get_value(const srtp_rdb_t *rdb); 118 119 #ifdef __cplusplus 120 } 121 #endif 122 123 #endif /* REPLAY_DB_H */