Noise-C
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
util.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef NOISE_UTIL_H
24 #define NOISE_UTIL_H
25 
26 #include <stddef.h>
27 #include <stdint.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 int noise_init(void);
34 
35 #define noise_new(type) ((type *)noise_new_object(sizeof(type)))
36 void *noise_new_object(size_t size);
37 void noise_free(void *ptr, size_t size);
38 
39 void noise_clean(void *data, size_t size);
40 
41 int noise_is_equal(const void *s1, const void *s2, size_t size);
42 int noise_is_zero(const void *data, size_t size);
43 
45  (int fingerprint_type, char *buffer, size_t len,
46  const uint8_t *public_key, size_t public_key_len);
47 
48 #ifdef __cplusplus
49 };
50 #endif
51 
52 #endif
void noise_clean(void *data, size_t size)
Cleans a block of memory to destroy its contents.
Definition: util.c:170
size_t size
Total size of the structure.
Definition: internal.h:503
int noise_is_zero(const void *data, size_t size)
Determine if a block of memory consists of all zero bytes.
Definition: util.c:211
int noise_format_fingerprint(int fingerprint_type, char *buffer, size_t len, const uint8_t *public_key, size_t public_key_len)
Formats the fingerprint for a raw public key value.
Definition: util.c:246
void * noise_new_object(size_t size)
Allocates memory from the system for an object.
Definition: util.c:135
int noise_init(void)
Initializes the Noise-c library.
Definition: util.c:87
void noise_free(void *ptr, size_t size)
Destroys the contents of a block of memory and free it.
Definition: util.c:152
int noise_is_equal(const void *s1, const void *s2, size_t size)
Determine if two blocks of memory are equal in constant time.
Definition: util.c:188