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