mirror of
https://github.com/uroni/urbackup_backend.git
synced 2025-10-26 11:36:50 +00:00
150 lines
5.2 KiB
C
Executable File
150 lines
5.2 KiB
C
Executable File
#ifndef AWS_COMMON_ENCODING_H
|
|
#define AWS_COMMON_ENCODING_H
|
|
|
|
/*
|
|
* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License").
|
|
* You may not use this file except in compliance with the License.
|
|
* A copy of the License is located at
|
|
*
|
|
* http://aws.amazon.com/apache2.0
|
|
*
|
|
* or in the "license" file accompanying this file. This file is distributed
|
|
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
* express or implied. See the License for the specific language governing
|
|
* permissions and limitations under the License.
|
|
*/
|
|
|
|
#include <aws/common/byte_buf.h>
|
|
#include <aws/common/byte_order.h>
|
|
#include <aws/common/common.h>
|
|
|
|
#include <memory.h>
|
|
|
|
AWS_EXTERN_C_BEGIN
|
|
|
|
/*
|
|
* computes the length necessary to store the result of aws_hex_encode().
|
|
* returns -1 on failure, and 0 on success. encoded_length will be set on
|
|
* success.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_hex_compute_encoded_len(size_t to_encode_len, size_t *encoded_length);
|
|
|
|
/*
|
|
* Base 16 (hex) encodes the contents of to_encode and stores the result in
|
|
* output. 0 terminates the result. Assumes the buffer is empty and does not resize on
|
|
* insufficient capacity.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_hex_encode(const struct aws_byte_cursor *AWS_RESTRICT to_encode, struct aws_byte_buf *AWS_RESTRICT output);
|
|
|
|
/*
|
|
* Base 16 (hex) encodes the contents of to_encode and appends the result in
|
|
* output. Does not 0-terminate. Grows the destination buffer dynamically if necessary.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_hex_encode_append_dynamic(
|
|
const struct aws_byte_cursor *AWS_RESTRICT to_encode,
|
|
struct aws_byte_buf *AWS_RESTRICT output);
|
|
|
|
/*
|
|
* computes the length necessary to store the result of aws_hex_decode().
|
|
* returns -1 on failure, and 0 on success. decoded_len will be set on success.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_hex_compute_decoded_len(size_t to_decode_len, size_t *decoded_len);
|
|
|
|
/*
|
|
* Base 16 (hex) decodes the contents of to_decode and stores the result in
|
|
* output. If output is NULL, output_size will be set to what the output_size
|
|
* should be.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_hex_decode(const struct aws_byte_cursor *AWS_RESTRICT to_decode, struct aws_byte_buf *AWS_RESTRICT output);
|
|
|
|
/*
|
|
* Computes the length necessary to store the output of aws_base64_encode call.
|
|
* returns -1 on failure, and 0 on success. encoded_length will be set on
|
|
* success.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_base64_compute_encoded_len(size_t to_encode_len, size_t *encoded_len);
|
|
|
|
/*
|
|
* Base 64 encodes the contents of to_encode and stores the result in output.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_base64_encode(const struct aws_byte_cursor *AWS_RESTRICT to_encode, struct aws_byte_buf *AWS_RESTRICT output);
|
|
|
|
/*
|
|
* Computes the length necessary to store the output of aws_base64_decode call.
|
|
* returns -1 on failure, and 0 on success. decoded_len will be set on success.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_base64_compute_decoded_len(const struct aws_byte_cursor *AWS_RESTRICT to_decode, size_t *decoded_len);
|
|
|
|
/*
|
|
* Base 64 decodes the contents of to_decode and stores the result in output.
|
|
*/
|
|
AWS_COMMON_API
|
|
int aws_base64_decode(const struct aws_byte_cursor *AWS_RESTRICT to_decode, struct aws_byte_buf *AWS_RESTRICT output);
|
|
|
|
/* Add a 64 bit unsigned integer to the buffer, ensuring network - byte order
|
|
* Assumes the buffer size is at least 8 bytes.
|
|
*/
|
|
AWS_STATIC_IMPL void aws_write_u64(uint64_t value, uint8_t *buffer);
|
|
|
|
/*
|
|
* Extracts a 64 bit unsigned integer from buffer. Ensures conversion from
|
|
* network byte order to host byte order. Assumes buffer size is at least 8
|
|
* bytes.
|
|
*/
|
|
AWS_STATIC_IMPL uint64_t aws_read_u64(const uint8_t *buffer);
|
|
|
|
/* Add a 32 bit unsigned integer to the buffer, ensuring network - byte order
|
|
* Assumes the buffer size is at least 4 bytes.
|
|
*/
|
|
AWS_STATIC_IMPL void aws_write_u32(uint32_t value, uint8_t *buffer);
|
|
|
|
/*
|
|
* Extracts a 32 bit unsigned integer from buffer. Ensures conversion from
|
|
* network byte order to host byte order. Assumes the buffer size is at least 4
|
|
* bytes.
|
|
*/
|
|
AWS_STATIC_IMPL uint32_t aws_read_u32(const uint8_t *buffer);
|
|
|
|
/* Add a 24 bit unsigned integer to the buffer, ensuring network - byte order
|
|
* return the new position in the buffer for the next operation.
|
|
* Note, since this uses uint32_t for storage, the 3 least significant bytes
|
|
* will be used. Assumes buffer is at least 3 bytes long.
|
|
*/
|
|
AWS_STATIC_IMPL void aws_write_u24(uint32_t value, uint8_t *buffer);
|
|
/*
|
|
* Extracts a 24 bit unsigned integer from buffer. Ensures conversion from
|
|
* network byte order to host byte order. Assumes buffer is at least 3 bytes
|
|
* long.
|
|
*/
|
|
AWS_STATIC_IMPL uint32_t aws_read_u24(const uint8_t *buffer);
|
|
|
|
/* Add a 16 bit unsigned integer to the buffer, ensuring network-byte order
|
|
* return the new position in the buffer for the next operation.
|
|
* Assumes buffer is at least 2 bytes long.
|
|
*/
|
|
AWS_STATIC_IMPL void aws_write_u16(uint16_t value, uint8_t *buffer);
|
|
/*
|
|
* Extracts a 16 bit unsigned integer from buffer. Ensures conversion from
|
|
* network byte order to host byte order. Assumes buffer is at least 2 bytes
|
|
* long.
|
|
*/
|
|
AWS_STATIC_IMPL uint16_t aws_read_u16(const uint8_t *buffer);
|
|
|
|
#ifndef AWS_NO_STATIC_IMPL
|
|
# include <aws/common/encoding.inl>
|
|
#endif /* AWS_NO_STATIC_IMPL */
|
|
|
|
AWS_EXTERN_C_END
|
|
|
|
#endif /* AWS_COMMON_ENCODING_H */
|