AWS IoT Over-the-air Update  v3.1.0
Client library for AWS IoT OTA
ota_base64_private.h
Go to the documentation of this file.
1 /*
2  * AWS IoT Over-the-air Update v3.1.0
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
28 #ifndef OTA_BASE64_PRIVATE_H
29 #define OTA_BASE64_PRIVATE_H
30 
31 /* *INDENT-OFF* */
32 #ifdef __cplusplus
33  extern "C" {
34 #endif
35 /* *INDENT-ON* */
36 
37 /* Standard includes. */
38 #include <stdint.h>
39 #include <stdlib.h>
40 
45 typedef enum Base64Status
46 {
51 
56 
61 
67 
72 
77 
83 
89 
106 Base64Status_t base64Decode( uint8_t * pDest,
107  const size_t destLen,
108  size_t * pResultLen,
109  const uint8_t * pEncodedData,
110  const size_t encodedLen );
111 
112 /* *INDENT-OFF* */
113 #ifdef __cplusplus
114  }
115 #endif
116 /* *INDENT-ON* */
117 
118 #endif /* ifndef OTA_BASE64_PRIVATE_H */
base64Decode
Base64Status_t base64Decode(uint8_t *pDest, const size_t destLen, size_t *pResultLen, const uint8_t *pEncodedData, const size_t encodedLen)
Decode Base64 encoded data.
Definition: ota_base64.c:420
Base64InvalidBufferSize
@ Base64InvalidBufferSize
Provided buffer is too small.
Definition: ota_base64_private.h:76
Base64Status_t
Base64Status_t
The Base64 functionality return status.
Definition: ota_base64_private.h:46
Base64NullPointerInput
@ Base64NullPointerInput
Input parameter for pointer is null.
Definition: ota_base64_private.h:71
Base64NonZeroPadding
@ Base64NonZeroPadding
Padding bits inside of the encoded data are invalid because they are not zero.
Definition: ota_base64_private.h:82
Base64InvalidPaddingSymbol
@ Base64InvalidPaddingSymbol
Invalid number of padding symbols.
Definition: ota_base64_private.h:87
Base64InvalidSymbol
@ Base64InvalidSymbol
Invalid symbol in the encoded data.
Definition: ota_base64_private.h:55
Base64InvalidInputSize
@ Base64InvalidInputSize
Length of the encoded data is impossible to have been created with valid Base64 encoding.
Definition: ota_base64_private.h:66
Base64InvalidSymbolOrdering
@ Base64InvalidSymbolOrdering
A Base64 symbol is in an invalid location within the encoded data.
Definition: ota_base64_private.h:60
Base64Success
@ Base64Success
Base64 function success.
Definition: ota_base64_private.h:50