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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
typedef enum MullvadApiErrorKind {
NoError = 0,
StringParsing = -1,
SocketAddressParsing = -2,
AsyncRuntimeInitialization = -3,
BadResponse = -4,
} MullvadApiErrorKind;
typedef struct DeviceIterator DeviceIterator;
/**
* A Mullvad API client that can be used via a C FFI.
*/
typedef struct FfiClient FfiClient;
/**
* MullvadApiErrorKind contains a description and an error kind. If the error kind is
* `MullvadApiErrorKind` is NoError, the pointer will be nil.
*/
typedef struct MullvadApiError {
char *description;
enum MullvadApiErrorKind kind;
} MullvadApiError;
typedef struct MullvadApiClient {
const struct FfiClient *ptr;
} MullvadApiClient;
typedef struct MullvadApiDeviceIterator {
struct DeviceIterator *ptr;
} MullvadApiDeviceIterator;
typedef struct MullvadApiDevice {
const char *name_ptr;
uint8_t id[16];
} MullvadApiDevice;
/**
* Initializes a Mullvad API client.
*
* # Safety
*
* * `client_ptr`: Must be a pointer to that is valid for the length of a `MullvadApiClient`
* struct.
*
* * `api_address`: pointer to nul-terminated UTF-8 string containing a socket address
* representation ("143.32.4.32:9090"), the port is mandatory.
*
* * `hostname`: pointer to a null-terminated UTF-8 string representing the hostname that will be
* used for TLS validation.
* * `disable_tls`: only valid when built for tests, can be ignored when consumed by Swift.
*/
struct MullvadApiError mullvad_api_client_initialize(struct MullvadApiClient *client_ptr,
const char *api_address_ptr,
const char *hostname,
bool disable_tls);
/**
* Removes all devices from a given account
*
* # Safety
*
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: pointer to nul-terminated UTF-8 string containing the account number of the
* account that will have all of it's devices removed.
*/
struct MullvadApiError mullvad_api_remove_all_devices(struct MullvadApiClient client_ptr,
const char *account_ptr);
/**
* Removes all devices from a given account
*
* # Safety
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: pointer to nul-terminated UTF-8 string containing the account number of the
* account that will have all of it's devices removed.
*
* * `expiry_unix_timestamp`: a pointer to a signed 64 bit integer. If this function returns no
* error, the expiry timestamp will be written to this pointer.
*/
struct MullvadApiError mullvad_api_get_expiry(struct MullvadApiClient client_ptr,
const char *account_str_ptr,
int64_t *expiry_unix_timestamp);
/**
* Gets a list of all devices associated with the specified account from the API.
*
* # Safety
*
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: pointer to nul-terminated UTF-8 string containing the account number of the
* account that will have all of it's devices removed.
*
* * `device_iter_ptr`: a pointer to a `device::MullvadApiDeviceIterator`. If this function doesn't
* return an error, the pointer will be initialized with a valid instance of
* `device::MullvadApiDeviceIterator`, which can be used to iterate through the devices.
*/
struct MullvadApiError mullvad_api_list_devices(struct MullvadApiClient client_ptr,
const char *account_str_ptr,
struct MullvadApiDeviceIterator *device_iter_ptr);
/**
* Adds a device to the specified account with the specified public key. Note that the device
* name, associated addresess and UUID are not returned.
*
* # Safety
*
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: pointer to nul-terminated UTF-8 string containing the account number of the
* account that will have a device added to ita device added to it.
*
* * `public_key_ptr`: a pointer to 32 bytes of a WireGuard public key that will be uploaded.
*
* * `new_device_ptr`: a pointer to enough memory to allocate a `MullvadApiDevice`. If this
* function doesn't return an error, it will be initialized.
*/
struct MullvadApiError mullvad_api_add_device(struct MullvadApiClient client_ptr,
const char *account_str_ptr,
const uint8_t *public_key_ptr,
struct MullvadApiDevice *new_device_ptr);
/**
* Creates a new account.
*
* # Safety
*
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: If a new account is created successfully, a pointer to an allocated C
* string containing the new account number will be written to this pointer. It must be freed via
* `mullvad_api_cstring_drop`.
*/
struct MullvadApiError mullvad_api_create_account(struct MullvadApiClient client_ptr,
const char **account_str_ptr);
/**
* Deletes the specified account.
*
* # Safety
*
* * `client_ptr`: Must be a valid, initialized instance of `MullvadApiClient`
*
* * `account_str_ptr`: Must be a null-terminated string representing the account to be deleted.
*/
struct MullvadApiError mullvad_api_delete_account(struct MullvadApiClient client_ptr,
const char *account_str_ptr);
void mullvad_api_client_drop(struct MullvadApiClient client);
/**
* Deallocates a CString returned by the Mullvad API client.
*
* # Safety
*
* `cstr_ptr` must be a pointer to a string allocated by another `mullvad_api` function.
*/
void mullvad_api_cstring_drop(char *cstr_ptr);
bool mullvad_api_device_iter_next(struct MullvadApiDeviceIterator iter,
struct MullvadApiDevice *device_ptr);
void mullvad_api_device_iter_drop(struct MullvadApiDeviceIterator iter);
void mullvad_api_device_drop(struct MullvadApiDevice device);
void mullvad_api_error_drop(struct MullvadApiError error);
|
