test_srtp.c 5.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/*
 * test_srtp.c
 *
 * Unit tests for internal srtp functions
 *
 * Cisco Systems, Inc.
 *
 */

/*
 *
Geir Istad's avatar
Geir Istad committed
12
 * Copyright (c) 2017, Cisco Systems, Inc.
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 *   Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 *   Neither the name of the Cisco Systems, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

46
/*
47
 * Test specific.
48 49 50 51 52 53 54 55 56
 */
#include "cutest.h"

/*
 * libSRTP specific.
 */
#include "../srtp/srtp.c" // Get access to static functions

/*
57
 * Standard library.
58 59 60
 */

/*
61
 * Forward declarations for all tests.
62 63
 */

64
void srtp_calc_aead_iv_srtcp_all_zero_input_yield_zero_output();
65
void srtp_calc_aead_iv_srtcp_seq_num_over_0x7FFFFFFF_bad_param();
66
void srtp_calc_aead_iv_srtcp_distinct_iv_per_sequence_number();
67 68 69

/*
 * NULL terminated array of tests.
70 71 72
 * The first item in the array is a char[] which give some information about
 * what is being tested and is displayed to the user during runtime, the second
 * item is the test function.
73 74
 */

75 76
TEST_LIST = {{"srtp_calc_aead_iv_srtcp_all_zero_input_yield_zero_output()",
              srtp_calc_aead_iv_srtcp_all_zero_input_yield_zero_output},
77 78
             {"srtp_calc_aead_iv_srtcp_seq_num_over_0x7FFFFFFF_bad_param()",
              srtp_calc_aead_iv_srtcp_seq_num_over_0x7FFFFFFF_bad_param},
79 80
             {"srtp_calc_aead_iv_srtcp_distinct_iv_per_sequence_number()",
              srtp_calc_aead_iv_srtcp_distinct_iv_per_sequence_number},
81 82 83
             {NULL} /* End of tests */};

/*
84
 * Implementation.
85 86
 */

87
void srtp_calc_aead_iv_srtcp_all_zero_input_yield_zero_output()
88 89 90 91 92 93 94 95
{
    // Preconditions
    srtp_session_keys_t session_keys;
    v128_t init_vector;
    srtcp_hdr_t header;
    uint32_t sequence_num;

    // Postconditions
96
    srtp_err_status_t status;
97 98 99 100 101 102 103
    const v128_t zero_vector;
    memset((v128_t *)&zero_vector, 0, sizeof(v128_t));

    // Given
    memset(&session_keys, 0, sizeof(srtp_session_keys_t));
    memset(&init_vector, 0, sizeof(v128_t));
    memset(&header, 0, sizeof(srtcp_hdr_t));
104
    sequence_num = 0x0UL;
105 106

    // When
Geir Istad's avatar
Geir Istad committed
107 108
    status = srtp_calc_aead_iv_srtcp(&session_keys, &init_vector, sequence_num,
                                     &header);
109 110

    // Then
111
    TEST_CHECK(status == srtp_err_status_ok);
112 113 114 115 116 117 118 119 120 121 122 123
    TEST_CHECK(memcmp(&zero_vector, &init_vector, sizeof(v128_t)) == 0);
}

void srtp_calc_aead_iv_srtcp_seq_num_over_0x7FFFFFFF_bad_param()
{
    // Preconditions
    srtp_session_keys_t session_keys;
    v128_t init_vector;
    srtcp_hdr_t header;
    uint32_t sequence_num;

    // Postconditions
124
    srtp_err_status_t status;
125 126 127 128 129

    // Given
    memset(&session_keys, 0, sizeof(srtp_session_keys_t));
    memset(&init_vector, 0, sizeof(v128_t));
    memset(&header, 0, sizeof(srtcp_hdr_t));
130
    sequence_num = 0x7FFFFFFFUL + 0x1UL;
131 132

    // When
133 134
    status = srtp_calc_aead_iv_srtcp(&session_keys, &init_vector, sequence_num,
                                     &header);
135 136 137 138

    // Then
    TEST_CHECK(status == srtp_err_status_bad_param);
}
Geir Istad's avatar
Geir Istad committed
139 140 141 142 143 144

/*
 * Regression test for issue #256:
 * Srtcp IV calculation incorrectly masks high bit of sequence number for
 * little-endian platforms.
 * Ensure that for each valid sequence number where the most significant bit is
145
 * high that we get an expected and unique IV.
Geir Istad's avatar
Geir Istad committed
146
 */
147
void srtp_calc_aead_iv_srtcp_distinct_iv_per_sequence_number()
Geir Istad's avatar
Geir Istad committed
148 149
{
    // Preconditions
150
    // Test each significant bit high in each full byte.
151
    #define SAMPLE_COUNT (3)
Geir Istad's avatar
Geir Istad committed
152 153
    srtp_session_keys_t session_keys;
    srtcp_hdr_t header;
154 155 156 157 158 159
    v128_t output_iv[SAMPLE_COUNT];
    memset(&output_iv, 0, SAMPLE_COUNT * sizeof(v128_t));
    uint32_t sequence_num[SAMPLE_COUNT];
    sequence_num[0] = 0xFF;
    sequence_num[1] = 0xFF00;
    sequence_num[2] = 0xFF0000;
Geir Istad's avatar
Geir Istad committed
160 161

    // Postconditions
162 163 164 165 166
    v128_t final_iv[SAMPLE_COUNT];
    memset(&final_iv, 0, SAMPLE_COUNT * sizeof(v128_t));
    final_iv[0].v8[11] = 0xFF;
    final_iv[1].v8[10] = 0xFF;
    final_iv[2].v8[9] = 0xFF;
Geir Istad's avatar
Geir Istad committed
167 168 169 170 171 172

    // Given
    memset(&session_keys, 0, sizeof(srtp_session_keys_t));
    memset(&header, 0, sizeof(srtcp_hdr_t));

    // When
173 174 175 176 177 178
    size_t i = 0;
    for (i = 0; i < SAMPLE_COUNT; i++) {
        TEST_CHECK(srtp_calc_aead_iv_srtcp(&session_keys, &output_iv[i],
                                           sequence_num[i], &header)
                   == srtp_err_status_ok);
    }
179 180

    // Then all IVs are as expected
181 182 183
    for (i = 0; i < SAMPLE_COUNT; i++) {
        TEST_CHECK(memcmp(&final_iv[i], &output_iv[i], sizeof(v128_t)) == 0);
    }
184
    #undef SAMPLE_COUNT
Geir Istad's avatar
Geir Istad committed
185
}