1 /* 2 * Copyright (c) 2018, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 19 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY 20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /** 29 * Allows to encrypt spinel frames sent between Application Processor (AP) and Network Co-Processor (NCP). 30 */ 31 32 namespace SpinelEncrypter { 33 34 /** 35 * Encrypts spinel frames before sending to AP/NCP. 36 * 37 * This method encrypts outbound frames in both directions, i.e. from AP to NCP and from NCP to AP. 38 * 39 * @param[in,out] aFrameBuf Pointer to buffer containing the frame, also where the encrypted frame will be placed. 40 * @param[in] aFrameSize Max number of bytes in frame buffer (max length of spinel frame + additional data for 41 * encryption). 42 * @param[in,out] aFrameLength Pointer to store frame length, on input value is set to frame length, 43 * on output changed to show the frame length after encryption. 44 * @return \c true on success, \c false otherwise. 45 */ 46 bool EncryptOutbound(unsigned char *aFrameBuf, size_t aFrameSize, size_t *aFrameLength); 47 48 /** 49 * Decrypts spinel frames received from AP/NCP. 50 * 51 * This method decrypts inbound frames in both directions, i.e. from AP to NCP and from NCP to AP. 52 * 53 * @param[in,out] aFrameBuf Pointer to buffer containing encrypted frame, also where the decrypted frame will be placed. 54 * @param[in] aFrameSize Max number of bytes in frame buffer (max length of spinel frame + additional data for 55 * encryption). 56 * @param[in,out] aFrameLength Pointer to store frame length, on input value is set to encrypted frame length, 57 * on output changed to show the frame length after decryption. 58 * @return \c true on success, \c false otherwise. 59 */ 60 bool DecryptInbound(unsigned char *aFrameBuf, size_t aFrameSize, size_t *aFrameLength); 61 62 } // namespace SpinelEncrypter 63
