aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/restricted/aws/s2n/utils/s2n_blob.h
blob: 5361ff2f3227da7240a3fa79c91bb35cf8c41c19 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/* 
 * Copyright 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. 
 */ 
 
#pragma once 
 
#include <stdbool.h> 
#include <stdint.h> 
#include <stdbool.h> 
#include "utils/s2n_result.h" 
 
struct s2n_blob { 
    /* The data for the s2n_blob */ 
    uint8_t *data; 
 
    /* The size of the data */ 
    uint32_t size; 
 
    /* The amount of memory allocated for this blob (i.e. the amount of memory 
     * which needs to be freed when the blob is cleaned up). If this blob was 
     * created with s2n_blob_init(), this value is 0. If s2n_alloc() was called, 
     * this value will be greater than 0. 
     */ 
    uint32_t allocated; 
 
    /* Can this blob be resized */ 
    unsigned growable :1; 
}; 
 
 
extern bool s2n_blob_is_growable(const struct s2n_blob* b); 
extern S2N_RESULT s2n_blob_validate(const struct s2n_blob* b); 
extern int s2n_blob_init(struct s2n_blob *b, uint8_t * data, uint32_t size); 
extern int s2n_blob_zero(struct s2n_blob *b); 
extern int s2n_blob_char_to_lower(struct s2n_blob *b); 
extern int s2n_hex_string_to_bytes(const uint8_t *str, struct s2n_blob *blob); 
extern int s2n_blob_slice(const struct s2n_blob *b, struct s2n_blob *slice, uint32_t offset, uint32_t size); 
 
#define s2n_stack_blob(name, requested_size, maximum)			\ 
    size_t name ## _requested_size = (requested_size);			\ 
    uint8_t name ## _buf[(maximum)] = {0};				\ 
    lte_check(name ## _requested_size, (maximum));			\ 
    struct s2n_blob name = {0};						\ 
    GUARD(s2n_blob_init(&name, name ## _buf, name ## _requested_size)) 
 
#define S2N_BLOB_LABEL(name, str) \ 
    static uint8_t name##_data[] = str;   \ 
    const struct s2n_blob name = { .data = name##_data, .size = sizeof(name##_data) - 1 }; 
 
/* The S2N_BLOB_FROM_HEX macro creates a s2n_blob with the contents of a hex string. 
 * It is allocated on a stack so there no need to free after use. 
 * hex should be a const char[]. This function checks against using char*, 
 * because sizeof needs to refer to the buffer length rather than a pointer size */ 
#define S2N_BLOB_FROM_HEX( name, hex ) \ 
    s2n_stack_blob(name, (sizeof(hex) - 1) / 2, (sizeof(hex) - 1) / 2); \ 
    GUARD(s2n_hex_string_to_bytes((const uint8_t*)hex, &name));