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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
use std::marker::PhantomData; use libc; use ffi; use {Validity, Wrapper}; use error::{self, Error, Result}; use context::Context; use keys::{HashAlgorithm, KeyAlgorithm}; use notation::SignatureNotationIter; use utils::{self, StrResult}; pub unsafe trait OpResult: Clone + Wrapper { fn from_context(ctx: &Context) -> Option<Self>; } macro_rules! impl_result { ($Name:ident: $T:ty = $Constructor:path) => { #[derive(Debug)] pub struct $Name { raw: $T, } impl Drop for $Name { fn drop(&mut self) { unsafe { ffi::gpgme_result_unref(self.raw as *mut libc::c_void); } } } impl Clone for $Name { fn clone(&self) -> $Name { unsafe { ffi::gpgme_result_ref(self.raw as *mut libc::c_void); $Name { raw: self.raw } } } } unsafe impl Wrapper for $Name { type Raw = $T; unsafe fn from_raw(raw: $T) -> $Name { debug_assert!(!raw.is_null()); $Name { raw: raw } } fn as_raw(&self) -> $T { self.raw } } unsafe impl OpResult for $Name { fn from_context(ctx: &Context) -> Option<$Name> { unsafe { let result = $Constructor(ctx.as_raw()); if !result.is_null() { ffi::gpgme_result_ref(result as *mut libc::c_void); Some($Name::from_raw(result)) } else { None } } } } }; } macro_rules! impl_subresult { ($Name:ident: $T:ty, $IterName:ident, $Owner:ty) => { #[derive(Debug, Copy, Clone)] pub struct $Name<'a> { raw: $T, phantom: PhantomData<&'a $Owner>, } impl<'a> $Name<'a> { pub unsafe fn from_raw<'b>(raw: $T) -> $Name<'b> { $Name { raw: raw, phantom: PhantomData } } pub fn raw(&self) -> $T { self.raw } } #[derive(Debug, Copy, Clone)] pub struct $IterName<'a> { current: $T, phantom: PhantomData<&'a $Owner>, } impl<'a> $IterName<'a> { pub fn from_list<'b>(first: $T) -> $IterName<'b> { $IterName { current: first, phantom: PhantomData } } } impl<'a> Iterator for $IterName<'a> { list_iterator!($Name<'a>, $Name::from_raw); } }; } #[derive(Debug, Copy, Clone)] pub struct InvalidKey<'a, T: 'a> { raw: ffi::gpgme_invalid_key_t, owner: PhantomData<&'a T>, } impl<'a, T> InvalidKey<'a, T> { pub unsafe fn from_raw<'b>(raw: ffi::gpgme_invalid_key_t) -> InvalidKey<'b, T> { InvalidKey { raw: raw, owner: PhantomData, } } pub unsafe fn raw(&self) -> ffi::gpgme_invalid_key_t { self.raw } pub fn fingerprint(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).fpr) } } pub fn reason(&self) -> Option<Error> { unsafe { let reason = (*self.raw).reason; if reason != error::GPG_ERR_NO_ERROR { Some(Error::new(reason)) } else { None } } } } #[derive(Debug, Copy, Clone)] pub struct InvalidKeyIter<'a, T: 'a> { current: ffi::gpgme_invalid_key_t, owner: PhantomData<&'a T>, } impl<'a, T> InvalidKeyIter<'a, T> { pub unsafe fn from_list<'b>(first: ffi::gpgme_invalid_key_t) -> InvalidKeyIter<'b, T> { InvalidKeyIter { current: first, owner: PhantomData, } } } impl<'a, T> Iterator for InvalidKeyIter<'a, T> { type Item = InvalidKey<'a, T>; fn next(&mut self) -> Option<Self::Item> { let current = self.current; if !current.is_null() { unsafe { self.current = (*current).next; Some(InvalidKey::from_raw(current)) } } else { None } } } bitflags! { flags KeyListMode: ffi::gpgme_keylist_mode_t { const KEY_LIST_MODE_LOCAL = ffi::GPGME_KEYLIST_MODE_LOCAL, const KEY_LIST_MODE_EXTERN = ffi::GPGME_KEYLIST_MODE_EXTERN, const KEY_LIST_MODE_SIGS = ffi::GPGME_KEYLIST_MODE_SIGS, const KEY_LIST_MODE_SIG_NOTATIONS = ffi::GPGME_KEYLIST_MODE_SIG_NOTATIONS, const KEY_LIST_MODE_EPHEMERAL = ffi::GPGME_KEYLIST_MODE_EPHEMERAL, const KEY_LIST_MODE_VALIDATE = ffi::GPGME_KEYLIST_MODE_VALIDATE, } } impl_result!(KeyListResult: ffi::gpgme_keylist_result_t = ffi::gpgme_op_keylist_result); impl KeyListResult { pub fn truncated(&self) -> bool { unsafe { (*self.raw).truncated() } } } impl_result!(KeyGenerateResult: ffi::gpgme_genkey_result_t = ffi::gpgme_op_genkey_result); impl KeyGenerateResult { pub fn has_primary_key(&self) -> bool { unsafe { (*self.raw).primary() } } pub fn has_sub_key(&self) -> bool { unsafe { (*self.raw).sub() } } pub fn fingerprint(&self) -> StrResult { unsafe { utils::from_cstr((*self.raw).fpr) } } } impl_result!(ImportResult: ffi::gpgme_import_result_t = ffi::gpgme_op_import_result); impl ImportResult { pub fn considered(&self) -> u32 { unsafe { (*self.raw).considered as u32 } } pub fn no_user_id(&self) -> u32 { unsafe { (*self.raw).no_user_id as u32 } } pub fn imported(&self) -> u32 { unsafe { (*self.raw).imported as u32 } } pub fn imported_rsa(&self) -> u32 { unsafe { (*self.raw).imported_rsa as u32 } } pub fn unchanged(&self) -> u32 { unsafe { (*self.raw).unchanged as u32 } } pub fn new_user_ids(&self) -> u32 { unsafe { (*self.raw).new_user_ids as u32 } } pub fn new_subkeys(&self) -> u32 { unsafe { (*self.raw).new_sub_keys as u32 } } pub fn new_signatures(&self) -> u32 { unsafe { (*self.raw).new_signatures as u32 } } pub fn new_revocations(&self) -> u32 { unsafe { (*self.raw).new_revocations as u32 } } pub fn secret_read(&self) -> u32 { unsafe { (*self.raw).secret_read as u32 } } pub fn secret_imported(&self) -> u32 { unsafe { (*self.raw).secret_imported as u32 } } pub fn secret_unchanged(&self) -> u32 { unsafe { (*self.raw).secret_unchanged as u32 } } pub fn not_imported(&self) -> u32 { unsafe { (*self.raw).not_imported as u32 } } pub fn imports(&self) -> ImportStatusIter { unsafe { ImportStatusIter::from_list((*self.raw).imports) } } } bitflags! { flags ImportFlags: libc::c_uint { const IMPORT_NEW = ffi::GPGME_IMPORT_NEW, const IMPORT_UID = ffi::GPGME_IMPORT_UID, const IMPORT_SIG = ffi::GPGME_IMPORT_SIG, const IMPORT_SUBKEY = ffi::GPGME_IMPORT_SUBKEY, const IMPORT_SECRET = ffi::GPGME_IMPORT_SECRET, } } impl_subresult!(ImportStatus: ffi::gpgme_import_status_t, ImportStatusIter, ImportResult); impl<'a> ImportStatus<'a> { pub fn fingerprint(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).fpr) } } pub fn result(&self) -> Result<()> { unsafe { return_err!((*self.raw).result); Ok(()) } } pub fn status(&self) -> ImportFlags { unsafe { ImportFlags::from_bits_truncate((*self.raw).status) } } } bitflags! { flags ExportMode: ffi::gpgme_export_mode_t { const EXPORT_EXTERN = ffi::GPGME_EXPORT_MODE_EXTERN, const EXPORT_MINIMAL = ffi::GPGME_EXPORT_MODE_MINIMAL, const EXPORT_SECRET = ffi::GPGME_EXPORT_MODE_SECRET, const EXPORT_RAW = ffi::GPGME_EXPORT_MODE_RAW, const EXPORT_PKCS12 = ffi::GPGME_EXPORT_MODE_PKCS12, } } bitflags! { flags EncryptFlags: ffi::gpgme_encrypt_flags_t { const ENCRYPT_ALWAYS_TRUST = ffi::GPGME_ENCRYPT_ALWAYS_TRUST, const ENCRYPT_NO_ENCRYPT_TO = ffi::GPGME_ENCRYPT_NO_ENCRYPT_TO, const ENCRYPT_PREPARE = ffi::GPGME_ENCRYPT_PREPARE, const ENCRYPT_EXPECT_SIGN = ffi::GPGME_ENCRYPT_EXPECT_SIGN, const ENCRYPT_NO_COMPRESS= ffi::GPGME_ENCRYPT_NO_COMPRESS, } } impl_result!(EncryptResult: ffi::gpgme_encrypt_result_t = ffi::gpgme_op_encrypt_result); impl EncryptResult { pub fn invalid_recipients(&self) -> InvalidKeyIter<EncryptResult> { unsafe { InvalidKeyIter::from_list((*self.raw).invalid_recipients) } } } impl_result!(DecryptResult: ffi::gpgme_decrypt_result_t = ffi::gpgme_op_decrypt_result); impl DecryptResult { pub fn filename(&self) -> StrResult { unsafe { utils::from_cstr((*self.raw).file_name) } } pub fn unsupported_algorithm(&self) -> StrResult { unsafe { utils::from_cstr((*self.raw).unsupported_algorithm) } } pub fn wrong_key_usage(&self) -> bool { unsafe { (*self.raw).wrong_key_usage() } } pub fn recipients(&self) -> RecipientIter { unsafe { RecipientIter::from_list((*self.raw).recipients) } } } impl_subresult!(Recipient: ffi::gpgme_recipient_t, RecipientIter, DecryptResult); impl<'a> Recipient<'a> { pub fn key_id(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).keyid) } } pub fn algorithm(&self) -> KeyAlgorithm { unsafe { KeyAlgorithm::from_raw((*self.raw).pubkey_algo) } } pub fn status(&self) -> Result<()> { unsafe { return_err!((*self.raw).status); Ok(()) } } } ffi_enum_wrapper! { pub enum SignMode: ffi::gpgme_sig_mode_t { SIGN_MODE_NORMAL = ffi::GPGME_SIG_MODE_NORMAL, SIGN_MODE_DETACH = ffi::GPGME_SIG_MODE_DETACH, SIGN_MODE_CLEAR = ffi::GPGME_SIG_MODE_CLEAR, } } impl_result!(SignResult: ffi::gpgme_sign_result_t = ffi::gpgme_op_sign_result); impl SignResult { pub fn invalid_signers(&self) -> InvalidKeyIter<SignResult> { unsafe { InvalidKeyIter::from_list((*self.raw).invalid_signers) } } pub fn signatures(&self) -> NewSignatureIter { unsafe { NewSignatureIter::from_list((*self.raw).signatures) } } } impl_subresult!(NewSignature: ffi::gpgme_new_signature_t, NewSignatureIter, SignResult); impl<'a> NewSignature<'a> { pub fn fingerprint(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).fpr) } } pub fn kind(&self) -> SignMode { unsafe { SignMode::from_raw((*self.raw).sig_type) } } pub fn class(&self) -> u32 { unsafe { (*self.raw).sig_class as u32 } } pub fn timestamp(&self) -> i64 { unsafe { (*self.raw).timestamp as i64 } } pub fn key_algorithm(&self) -> KeyAlgorithm { unsafe { KeyAlgorithm::from_raw((*self.raw).pubkey_algo) } } pub fn hash_algorithm(&self) -> HashAlgorithm { unsafe { HashAlgorithm::from_raw((*self.raw).hash_algo) } } } impl_result!(VerifyResult: ffi::gpgme_verify_result_t = ffi::gpgme_op_verify_result); impl VerifyResult { pub fn filename(&self) -> StrResult { unsafe { utils::from_cstr((*self.raw).file_name) } } pub fn signatures(&self) -> SignatureIter { unsafe { SignatureIter::from_list((*self.raw).signatures) } } } bitflags! { flags SignatureSummary: ffi::gpgme_sigsum_t { const SIGNATURE_VALID = ffi::GPGME_SIGSUM_VALID, const SIGNATURE_GREEN = ffi::GPGME_SIGSUM_GREEN, const SIGNATURE_RED = ffi::GPGME_SIGSUM_RED, const SIGNATURE_KEY_REVOKED = ffi::GPGME_SIGSUM_KEY_REVOKED, const SIGNATURE_KEY_EXPIRED = ffi::GPGME_SIGSUM_KEY_EXPIRED, const SIGNATURE_SIG_EXPIRED = ffi::GPGME_SIGSUM_SIG_EXPIRED, const SIGNATURE_KEY_MISSING = ffi::GPGME_SIGSUM_KEY_MISSING, const SIGNATURE_CRL_MISSING = ffi::GPGME_SIGSUM_CRL_MISSING, const SIGNATURE_CRL_TOO_OLD = ffi::GPGME_SIGSUM_CRL_TOO_OLD, const SIGNATURE_BAD_POLICY = ffi::GPGME_SIGSUM_BAD_POLICY, const SIGNATURE_SYS_ERROR = ffi::GPGME_SIGSUM_SYS_ERROR, } } ffi_enum_wrapper! { pub enum PkaTrust: libc::c_uint { PKA_TRUST_NO_INFO = 0, PKA_TRUST_BAD = 1, PKA_TRUST_OKAY = 2, } } impl_subresult!(Signature: ffi::gpgme_signature_t, SignatureIter, VerifyResult); impl<'a> Signature<'a> { pub fn fingerprint(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).fpr) } } pub fn chain_model(&self) -> bool { unsafe { (*self.raw).chain_model() } } pub fn pka_trust(&self) -> PkaTrust { unsafe { PkaTrust::from_raw((*self.raw).pka_trust()) } } pub fn wrong_key_usage(&self) -> bool { unsafe { (*self.raw).wrong_key_usage() } } pub fn validity(&self) -> Validity { unsafe { Validity::from_raw((*self.raw).validity) } } pub fn validity_reason(&self) -> Option<Error> { unsafe { let reason = (*self.raw).validity_reason; if reason != error::GPG_ERR_NO_ERROR { Some(Error::new(reason)) } else { None } } } pub fn timestamp(&self) -> i64 { unsafe { (*self.raw).timestamp as i64 } } pub fn expires(&self) -> Option<i64> { let expires = unsafe { (*self.raw).exp_timestamp }; if expires > 0 { Some(expires as i64) } else { None } } pub fn key_algorithm(&self) -> KeyAlgorithm { unsafe { KeyAlgorithm::from_raw((*self.raw).pubkey_algo) } } pub fn hash_algorithm(&self) -> HashAlgorithm { unsafe { HashAlgorithm::from_raw((*self.raw).hash_algo) } } pub fn status(&self) -> Result<()> { unsafe { return_err!((*self.raw).status); Ok(()) } } pub fn summary(&self) -> SignatureSummary { unsafe { SignatureSummary::from_bits_truncate((*self.raw).summary as u32) } } pub fn pka_address(&self) -> StrResult<'a> { unsafe { utils::from_cstr((*self.raw).pka_address) } } pub fn notations(&self) -> SignatureNotationIter<'a, VerifyResult> { unsafe { SignatureNotationIter::from_list((*self.raw).notations) } } }