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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
//! ASCII Armor.
//!
//! Wraps [`sequoia-openpgp::armor`].
//!
//! [`sequoia-openpgp::armor`]: ../../sequoia_openpgp/armor/index.html
use std::mem::size_of;
use std::ptr;
use std::slice;
use std::io::Write;
use libc::{self, uint8_t, c_char, c_int, size_t};
extern crate sequoia_openpgp;
use self::sequoia_openpgp::armor;
use super::io::{Reader, ReaderKind};
use Maybe;
use MoveIntoRaw;
use MoveResultIntoRaw;
use RefRaw;
use RefMutRaw;
/// Represents a (key, value) pair in an armor header.
#[repr(C)]
pub struct ArmorHeader {
key: *const c_char,
value: *const c_char,
}
fn int_to_kind(kind: c_int) -> Option<armor::Kind> {
match kind {
0 => None,
1 => Some(armor::Kind::Message),
2 => Some(armor::Kind::PublicKey),
3 => Some(armor::Kind::SecretKey),
4 => Some(armor::Kind::Signature),
5 => Some(armor::Kind::File),
_ => panic!("Bad kind: {}", kind),
}
}
fn kind_to_int(kind: Option<armor::Kind>) -> c_int {
match kind {
None => 0,
Some(armor::Kind::Message) => 1,
Some(armor::Kind::PublicKey) => 2,
Some(armor::Kind::SecretKey) => 3,
Some(armor::Kind::Signature) => 4,
Some(armor::Kind::File) => 5,
}
}
/// Constructs a new filter for the given type of data.
///
/// A filter that strips ASCII Armor from a stream of data.
///
/// # Example
///
/// ```c
/// #include <assert.h>
/// #include <error.h>
/// #include <stdio.h>
/// #include <stdlib.h>
/// #include <string.h>
///
/// #include <sequoia/openpgp.h>
///
/// const char *armored =
/// "-----BEGIN PGP ARMORED FILE-----\n"
/// "Key0: Value0\n"
/// "Key1: Value1\n"
/// "\n"
/// "SGVsbG8gd29ybGQh\n"
/// "=s4Gu\n"
/// "-----END PGP ARMORED FILE-----\n";
///
/// pgp_reader_t bytes = pgp_reader_from_bytes ((uint8_t *) armored, strlen (armored));
/// pgp_reader_t armor = pgp_armor_reader_new (bytes, PGP_ARMOR_KIND_ANY);
///
/// pgp_error_t err;
/// pgp_armor_header_t header;
/// size_t header_len;
/// header = pgp_armor_reader_headers (&err, armor, &header_len);
/// if (header == NULL)
/// error (1, 0, "Getting headers failed: %s", pgp_error_to_string (err));
///
/// assert (header_len == 2);
/// assert (strcmp (header[0].key, "Key0") == 0
/// && strcmp (header[0].value, "Value0") == 0);
/// assert (strcmp (header[1].key, "Key1") == 0
/// && strcmp (header[1].value, "Value1") == 0);
/// for (size_t i = 0; i < header_len; i++)
/// {
/// free (header[i].key);
/// free (header[i].value);
/// }
/// free (header);
///
/// char message[12];
/// if (pgp_reader_read (&err, armor, (uint8_t *) message, 12) < 0)
/// error (1, 0, "Reading failed: %s", pgp_error_to_string (err));
///
/// assert (pgp_armor_reader_kind (armor) == PGP_ARMOR_KIND_FILE);
/// assert (memcmp (message, "Hello world!", 12) == 0);
///
/// pgp_reader_free (armor);
/// pgp_reader_free (bytes);
/// ```
#[::sequoia_ffi_macros::extern_fn] #[no_mangle]
pub extern "system" fn pgp_armor_reader_new(inner: *mut Reader,
kind: c_int)
-> *mut Reader {
let inner = inner.ref_mut_raw();
let kind = int_to_kind(kind);
ReaderKind::Armored(armor::Reader::new(inner, kind)).move_into_raw()
}
/// Creates a `Reader` from a file.
#[::sequoia_ffi_macros::extern_fn] #[no_mangle]
pub extern "system" fn pgp_armor_reader_from_file(errp: Option<&mut *mut ::error::Error>,
filename: *const c_char,
kind: c_int)
-> Maybe<Reader> {
let filename = ffi_param_cstr!(filename).to_string_lossy().into_owned();
let kind = int_to_kind(kind);
armor::Reader::from_file(&filename, kind)
.map(|r| ReaderKind::Armored(r))
.map_err(|e| ::failure::Error::from(e))
.move_into_raw(errp)
}
/// Creates a `Reader` from a buffer.
///
/// # Example
///
/// ```c
/// #include <assert.h>
/// #include <error.h>
/// #include <stdio.h>
/// #include <stdlib.h>
/// #include <string.h>
///
/// #include <sequoia/openpgp.h>
///
/// const char *armored =
/// "-----BEGIN PGP ARMORED FILE-----\n"
/// "Key0: Value0\n"
/// "Key1: Value1\n"
/// "\n"
/// "SGVsbG8gd29ybGQh\n"
/// "=s4Gu\n"
/// "-----END PGP ARMORED FILE-----\n";
///
/// pgp_reader_t armor =
/// pgp_armor_reader_from_bytes ((uint8_t *) armored, strlen (armored),
/// PGP_ARMOR_KIND_ANY);
///
/// pgp_error_t err;
/// pgp_armor_header_t header;
/// size_t header_len;
/// header = pgp_armor_reader_headers (&err, armor, &header_len);
/// if (header == NULL)
/// error (1, 0, "Getting headers failed: %s", pgp_error_to_string (err));
///
/// assert (header_len == 2);
/// assert (strcmp (header[0].key, "Key0") == 0
/// && strcmp (header[0].value, "Value0") == 0);
/// assert (strcmp (header[1].key, "Key1") == 0
/// && strcmp (header[1].value, "Value1") == 0);
/// for (size_t i = 0; i < header_len; i++)
/// {
/// free (header[i].key);
/// free (header[i].value);
/// }
/// free (header);
///
/// char message[12];
/// if (pgp_reader_read (&err, armor, (uint8_t *) message, 12) < 0)
/// error (1, 0, "Reading failed: %s", pgp_error_to_string (err));
///
/// assert (pgp_armor_reader_kind (armor) == PGP_ARMOR_KIND_FILE);
/// assert (memcmp (message, "Hello world!", 12) == 0);
///
/// pgp_reader_free (armor);
/// ```
#[::sequoia_ffi_macros::extern_fn] #[no_mangle] pub extern "system"
fn pgp_armor_reader_from_bytes(b: *const uint8_t, len: size_t,
kind: c_int)
-> *mut Reader {
assert!(!b.is_null());
let buf = unsafe {
slice::from_raw_parts(b, len as usize)
};
let kind = int_to_kind(kind);
ReaderKind::Armored(armor::Reader::from_bytes(buf, kind)).move_into_raw()
}
/// Returns the kind of data this reader is for.
///
/// Useful if the kind of data is not known in advance. If the header
/// has not been encountered yet (try reading some data first!), this
/// function returns PGP_ARMOR_KIND_ANY.
///
/// # Example
///
/// See [this] example.
///
/// [this]: fn.pgp_armor_reader_new.html
#[::sequoia_ffi_macros::extern_fn] #[no_mangle]
pub extern "system" fn pgp_armor_reader_kind(reader: *const Reader)
-> c_int {
if let ReaderKind::Armored(ref armor_reader) = reader.ref_raw()
{
kind_to_int(armor_reader.kind())
} else {
panic!(
"FFI contract violation: Wrong parameter type: \
expected an armor reader")
}
}
/// Returns the armored headers.
///
/// The tuples contain a key and a value.
///
/// Note: if a key occurs multiple times, then there are multiple
/// entries in the vector with the same key; values with the same
/// key are *not* combined.
///
/// The returned array and the strings in the headers have been
/// allocated with `malloc`, and the caller is responsible for freeing
/// both the array and the strings.
///
/// # Example
///
/// See [this] example.
///
/// [this]: fn.pgp_armor_reader_new.html
#[::sequoia_ffi_macros::extern_fn] #[no_mangle]
pub extern "system" fn pgp_armor_reader_headers(errp: Option<&mut *mut ::error::Error>,
reader: *mut Reader,
len: *mut size_t)
-> *mut ArmorHeader {
ffi_make_fry_from_errp!(errp);
let len = ffi_param_ref_mut!(len);
let reader = if let ReaderKind::Armored(ref mut reader) = reader.ref_mut_raw() {
reader
} else {
panic!("FFI contract violation: Wrong parameter type: \
expected armor reader");
};
match reader.headers().map_err(|e| ::failure::Error::from(e)) {
Ok(headers) => {
// Allocate space for the result.
let buf = unsafe {
libc::calloc(headers.len(), size_of::<ArmorHeader>())
as *mut ArmorHeader
};
let sl = unsafe {
slice::from_raw_parts_mut(buf, headers.len())
};
for (i, (key, value)) in headers.iter().enumerate() {
|