diff --git a/bindings-gpgme.cabal b/bindings-gpgme.cabal --- a/bindings-gpgme.cabal +++ b/bindings-gpgme.cabal @@ -13,7 +13,7 @@ . For a higher-level library, see: -version: 0.1.8 +version: 0.2.0 license: BSD3 license-file: LICENSE maintainer: Reto @@ -29,7 +29,7 @@ ForeignFunctionInterface build-depends: base >= 3 && < 5, - bindings-DSL >= 1.0.16 && < 1.1 + bindings-DSL >= 1.0.16 && < 1.2 exposed-modules: Bindings.Gpgme c-sources: @@ -43,6 +43,6 @@ source-repository head type: git - location: git://github.com/rethab/bindings-dsl + location: https://github.com/rethab/bindings-dsl branch: master subdir: bindings-gpgme diff --git a/src/Bindings/Gpgme.hsc b/src/Bindings/Gpgme.hsc --- a/src/Bindings/Gpgme.hsc +++ b/src/Bindings/Gpgme.hsc @@ -40,7 +40,34 @@ #num GPGME_DATA_ENCODING_BINARY #num GPGME_DATA_ENCODING_BASE64 #num GPGME_DATA_ENCODING_ARMOR +#if GPGME_VERSION_NUMBER >= 0x010200 +#num GPGME_DATA_ENCODING_URL +#num GPGME_DATA_ENCODING_URLESC +#num GPGME_DATA_ENCODING_URL0 +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_DATA_ENCODING_MIME +#endif +-- * Data types +#if GPGME_VERSION_NUMBER >= 0x010403 +#integral_t gpgme_data_type_t +#num GPGME_DATA_TYPE_INVALID +#num GPGME_DATA_TYPE_UNKNOWN +#num GPGME_DATA_TYPE_PGP_SIGNED +#num GPGME_DATA_TYPE_PGP_OTHER +#num GPGME_DATA_TYPE_PGP_KEY +#num GPGME_DATA_TYPE_CMS_SIGNED +#num GPGME_DATA_TYPE_CMS_ENCRYPTED +#num GPGME_DATA_TYPE_CMS_OTHER +#num GPGME_DATA_TYPE_X509_CERT +#num GPGME_DATA_TYPE_PKCS12 +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_DATA_TYPE_PGP_ENCRYPTED +#num GPGME_DATA_TYPE_PGP_SIGNATURE +#endif +#endif + -- * Algorithms -- ** Public key algorithms #integral_t gpgme_pubkey_algo_t @@ -50,6 +77,13 @@ #num GPGME_PK_ELG_E #num GPGME_PK_DSA #num GPGME_PK_ELG +#num GPGME_PK_ECC +#num GPGME_PK_ECDSA +#num GPGME_PK_ECDH +#num GPGME_PK_EDDSA +#if GPGME_VERSION_NUMBER >= 0x011801 +#num GPGME_PK_KYBER +#endif -- ** Hash algorithms #integral_t gpgme_hash_algo_t @@ -67,12 +101,21 @@ #num GPGME_MD_CRC32 #num GPGME_MD_CRC32_RFC1510 #num GPGME_MD_CRC24_RFC2440 +#if GPGME_VERSION_NUMBER >= 0x010500 +#num GPGME_MD_SHA224 +#endif -- * Signature mode #integral_t gpgme_sig_mode_t #num GPGME_SIG_MODE_NORMAL #num GPGME_SIG_MODE_DETACH #num GPGME_SIG_MODE_CLEAR +#if GPGME_VERSION_NUMBER >= 0x011300 +#num GPGME_SIG_MODE_ARCHIVE +#endif +#if GPGME_VERSION_NUMBER >= 0x011800 +#num GPGME_SIG_MODE_FILE +#endif -- * Identity validity #integral_t gpgme_validity_t @@ -89,6 +132,17 @@ #num GPGME_PROTOCOL_CMS #num GPGME_PROTOCOL_GPGCONF #num GPGME_PROTOCOL_UNKNOWN +#if GPGME_VERSION_NUMBER >= 0x010200 +#num GPGME_PROTOCOL_ASSUAN +#endif +#if GPGME_VERSION_NUMBER >= 0x010300 +#num GPGME_PROTOCOL_G13 +#num GPGME_PROTOCOL_UISERVER +#num GPGME_PROTOCOL_DEFAULT +#endif +#if GPGME_VERSION_NUMBER >= 0x010500 +#num GPGME_PROTOCOL_SPAWN +#endif -- * Key list modes #integral_t gpgme_keylist_mode_t @@ -97,13 +151,44 @@ #num GPGME_KEYLIST_MODE_SIGS #num GPGME_KEYLIST_MODE_SIG_NOTATIONS #num GPGME_KEYLIST_MODE_VALIDATE +#if GPGME_VERSION_NUMBER >= 0x010200 +#num GPGME_KEYLIST_MODE_EPHEMERAL +#endif +#if GPGME_VERSION_NUMBER >= 0x010501 +#num GPGME_KEYLIST_MODE_WITH_SECRET +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_KEYLIST_MODE_WITH_TOFU +#endif +#if GPGME_VERSION_NUMBER >= 0x010b00 +#num GPGME_KEYLIST_MODE_LOCATE +#endif +#if GPGME_VERSION_NUMBER >= 0x010e00 +#num GPGME_KEYLIST_MODE_WITH_KEYGRIP +#endif +#if GPGME_VERSION_NUMBER >= 0x011200 +#num GPGME_KEYLIST_MODE_FORCE_EXTERN +#num GPGME_KEYLIST_MODE_LOCATE_EXTERNAL +#endif +#if GPGME_VERSION_NUMBER >= 0x011700 +#num GPGME_KEYLIST_MODE_WITH_V5FPR +#endif + +-- * Audit log flags #num GPGME_AUDITLOG_HTML #num GPGME_AUDITLOG_WITH_HELP +#if GPGME_VERSION_NUMBER >= 0x010c00 +#num GPGME_AUDITLOG_DEFAULT +#num GPGME_AUDITLOG_DIAG +#endif -- * Signature notations #integral_t gpgme_sig_notation_flags_t #num GPGME_SIG_NOTATION_HUMAN_READABLE #num GPGME_SIG_NOTATION_CRITICAL +#if GPGME_VERSION_NUMBER >= 0x020100 +#num GPGME_SIG_NOTATION_UNPROTECTED +#endif #starttype struct _gpgme_sig_notation #field next , Ptr <_gpgme_sig_notation> @@ -211,7 +296,50 @@ #stoptype #synonym_t gpgme_engine_info_t , Ptr <_gpgme_engine_info> +-- * Trust-on-first-use (TOFU) +#if GPGME_VERSION_NUMBER >= 0x010700 +#integral_t gpgme_tofu_policy_t +#num GPGME_TOFU_POLICY_NONE +#num GPGME_TOFU_POLICY_AUTO +#num GPGME_TOFU_POLICY_GOOD +#num GPGME_TOFU_POLICY_UNKNOWN +#num GPGME_TOFU_POLICY_BAD +#num GPGME_TOFU_POLICY_ASK + +-- The @validity@ and @policy@ members are C bitfields; read them with +-- 'c'gpgme_tofu_info_validity' and 'c'gpgme_tofu_info_policy'. +#starttype struct _gpgme_tofu_info +#field next , Ptr <_gpgme_tofu_info> +#field signcount , CUShort +#field encrcount , CUShort +#field signfirst , CULong +#field signlast , CULong +#field encrfirst , CULong +#field encrlast , CULong +#field description , CString +#stoptype +#synonym_t gpgme_tofu_info_t , Ptr <_gpgme_tofu_info> +#endif + +-- * Revocation keys +#if GPGME_VERSION_NUMBER >= 0x011800 +-- The @sensitive@ member is a C bitfield; read it with +-- 'c'gpgme_revocation_key_sensitive'. +#starttype struct _gpgme_revocation_key +#field next , Ptr <_gpgme_revocation_key> +#field pubkey_algo , +#field fpr , CString +#field key_class , CUInt +#stoptype +#synonym_t gpgme_revocation_key_t , Ptr <_gpgme_revocation_key> +#endif + -- * Keys +-- +-- The capability and status members of these structs (@revoked@, @expired@, +-- @can_encrypt@, ...) are C bitfields, which have no representation as record +-- fields here. They are exposed as the @c'gpgme_key_*@, @c'gpgme_subkey_*@, +-- @c'gpgme_user_id_*@ and @c'gpgme_key_sig_*@ accessors further down. #starttype struct _gpgme_subkey #field next , Ptr <_gpgme_subkey> #field pubkey_algo , @@ -224,6 +352,12 @@ #if GPGME_VERSION_NUMBER >= 0x010500 #field curve , CString #endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#field keygrip , CString +#endif +#if GPGME_VERSION_NUMBER >= 0x011700 +#field v5fpr , CString +#endif #stoptype #synonym_t gpgme_subkey_t , Ptr <_gpgme_subkey> @@ -240,6 +374,9 @@ #field comment , CString #field sig_class , CUInt #field notations , +#if GPGME_VERSION_NUMBER >= 0x011000 +#field trust_scope , CString +#endif #stoptype #synonym_t gpgme_key_sig_t , Ptr <_gpgme_key_sig> @@ -251,6 +388,16 @@ #field email , CString #field comment , CString #field signatures , +#if GPGME_VERSION_NUMBER >= 0x010700 +#field address , CString +#field tofu , +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +#field last_update , CULong +#endif +#if GPGME_VERSION_NUMBER >= 0x010e00 +#field uidhash , CString +#endif #stoptype #synonym_t gpgme_user_id_t , Ptr <_gpgme_user_id> @@ -263,6 +410,15 @@ #field subkeys , #field uids , #field keylist_mode , +#if GPGME_VERSION_NUMBER >= 0x010700 +#field fpr , CString +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +#field last_update , CULong +#endif +#if GPGME_VERSION_NUMBER >= 0x011800 +#field revocation_keys , +#endif #stoptype #synonym_t gpgme_key_t , Ptr <_gpgme_key> @@ -270,6 +426,13 @@ #callback_t gpgme_passphrase_cb_t , Ptr () -> CString -> CString -> CInt -> CInt -> IO #callback_t gpgme_progress_cb_t , Ptr () -> CString -> CInt -> CInt -> CInt -> IO () #callback_t gpgme_edit_cb_t , Ptr () -> -> CString -> CInt -> IO +#if GPGME_VERSION_NUMBER >= 0x010600 +#callback_t gpgme_status_cb_t , Ptr () -> CString -> CString -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +-- The replacement for the deprecated 'gpgme_edit_cb_t'. +#callback_t gpgme_interact_cb_t , Ptr () -> CString -> CString -> CInt -> IO +#endif -- * Creating and configuring contexts #ccall gpgme_new , Ptr -> IO @@ -304,6 +467,49 @@ #ccall gpgme_sig_notation_add , -> CString -> CString -> -> IO #ccall gpgme_sig_notation_get , -> IO +#if GPGME_VERSION_NUMBER >= 0x010403 +#ccall gpgme_signers_count , -> IO CUInt +#endif + +#if GPGME_VERSION_NUMBER >= 0x010600 +-- | Whether to run the engine without contacting the network. +#ccall gpgme_set_offline , -> CInt -> IO () +#ccall gpgme_get_offline , -> IO CInt +#ccall gpgme_set_status_cb , -> -> Ptr () -> IO () +#ccall gpgme_get_status_cb , -> Ptr -> Ptr (Ptr ()) -> IO () +#endif + +#if GPGME_VERSION_NUMBER >= 0x010700 +-- | The generic escape hatch for per-context options that have no dedicated +-- setter, e.g. @\"redraw\"@, @\"full-status\"@ or @\"export-filter\"@. +#ccall gpgme_set_ctx_flag , -> CString -> CString -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010800 +#ccall gpgme_get_ctx_flag , -> CString -> IO CString +-- | The address to embed as the sender of a signature, used by gpg to pick +-- the signing key and by the verifier to check it. +#ccall gpgme_set_sender , -> CString -> IO +#ccall gpgme_get_sender , -> IO CString +#endif + +#if GPGME_VERSION_NUMBER >= 0x010400 +-- | Set a flag on the library itself. Must be called before 'c'gpgme_check_version'. +#ccall gpgme_set_global_flag , CString -> CString -> IO CInt +#endif + +#if GPGME_VERSION_NUMBER >= 0x010700 +#ccall gpgme_pubkey_algo_string , -> IO CString +#endif +#if GPGME_VERSION_NUMBER >= 0x010701 +-- | Extract the mail address from a user ID. The result must be 'c'gpgme_free'd. +#ccall gpgme_addrspec_from_uid , CString -> IO CString +#endif + +#if GPGME_VERSION_NUMBER >= 0x010200 +#ccall gpgme_result_ref , Ptr () -> IO () +#ccall gpgme_result_unref , Ptr () -> IO () +#endif + -- * IO events #callback_t gpgme_io_cb_t , Ptr () -> CInt -> IO #callback_t gpgme_register_io_cb_t , Ptr () -> CInt -> CInt -> -> Ptr () -> Ptr (Ptr ()) -> IO @@ -313,7 +519,9 @@ #num GPGME_EVENT_START #num GPGME_EVENT_DONE #num GPGME_EVENT_NEXT_KEY +#if GPGME_VERSION_NUMBER < 0x020000 #num GPGME_EVENT_NEXT_TRUSTITEM +#endif #callback_t gpgme_event_io_cb_t , Ptr () -> -> Ptr () -> IO () @@ -366,6 +574,15 @@ #ccall gpgme_data_new_from_file , Ptr -> CString -> CInt -> IO #ccall gpgme_data_new_from_filepart , Ptr -> CString -> Ptr CFile -> -> CSize -> IO +#if GPGME_VERSION_NUMBER >= 0x010403 +-- | Guess what a buffer holds (a key, a signature, ciphertext, ...) without +-- running an operation on it. +#ccall gpgme_data_identify , -> CInt -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#ccall gpgme_data_set_flag , -> CString -> CString -> IO +#endif + -- * Key management #ccall gpgme_get_key , -> CString -> Ptr -> CInt -> IO #ccall gpgme_key_ref , -> IO () @@ -373,6 +590,11 @@ #ccall gpgme_key_release , -> IO () -- * Encryption + +-- The @next@ field below is typed as an embedded struct rather than a pointer. +-- That is wrong, but correcting it would change the type of the generated +-- @c'_gpgme_invalid_key'next@ accessor and break every existing caller, so it +-- is left as it is. Use 'c'gpgme_invalid_key_next' to walk the list. #starttype struct _gpgme_invalid_key #field next , <_gpgme_invalid_key> #field fpr , CString @@ -380,6 +602,11 @@ #stoptype #synonym_t gpgme_invalid_key_t , Ptr <_gpgme_invalid_key> +-- | The correctly typed successor of an invalid key, for walking the +-- @invalid_recipients@ and @invalid_signers@ lists. Returns @nullPtr@ at the +-- end of the list. +#cinline gpgme_invalid_key_next , -> IO + #starttype struct _gpgme_op_encrypt_result #field invalid_recipients , #stoptype @@ -389,12 +616,50 @@ #integral_t gpgme_encrypt_flags_t #num GPGME_ENCRYPT_ALWAYS_TRUST +#if GPGME_VERSION_NUMBER >= 0x010200 +#num GPGME_ENCRYPT_NO_ENCRYPT_TO +#endif +#if GPGME_VERSION_NUMBER >= 0x010300 +#num GPGME_ENCRYPT_PREPARE +#num GPGME_ENCRYPT_EXPECT_SIGN +#endif +#if GPGME_VERSION_NUMBER >= 0x010500 +#num GPGME_ENCRYPT_NO_COMPRESS +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_ENCRYPT_SYMMETRIC +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +#num GPGME_ENCRYPT_THROW_KEYIDS +#num GPGME_ENCRYPT_WRAP +#endif +#if GPGME_VERSION_NUMBER >= 0x010b00 +#num GPGME_ENCRYPT_WANT_ADDRESS +#endif +#if GPGME_VERSION_NUMBER >= 0x011300 +#num GPGME_ENCRYPT_ARCHIVE +#endif +#if GPGME_VERSION_NUMBER >= 0x011800 +#num GPGME_ENCRYPT_FILE +#num GPGME_ENCRYPT_ADD_RECP +#num GPGME_ENCRYPT_CHG_RECP +#endif #ccall gpgme_op_encrypt_start , -> Ptr -> -> -> -> IO #ccall gpgme_op_encrypt , -> Ptr -> -> -> -> IO #ccall gpgme_op_encrypt_sign_start , -> Ptr -> -> -> -> IO #ccall gpgme_op_encrypt_sign , -> Ptr -> -> -> -> IO +#if GPGME_VERSION_NUMBER >= 0x010b00 +-- | Like 'c'gpgme_op_encrypt', but the recipients may also be given as a +-- newline-separated string, which allows addressing keys gpg knows about +-- without looking them up first. +#ccall gpgme_op_encrypt_ext , -> Ptr -> CString -> -> -> -> IO +#ccall gpgme_op_encrypt_ext_start , -> Ptr -> CString -> -> -> -> IO +#ccall gpgme_op_encrypt_sign_ext , -> Ptr -> CString -> -> -> -> IO +#ccall gpgme_op_encrypt_sign_ext_start , -> Ptr -> CString -> -> -> -> IO +#endif + -- * Decryption #starttype struct _gpgme_recipient #field next , Ptr <_gpgme_recipient> @@ -408,6 +673,15 @@ #field unsupported_algorithm , CString #field recipients , #field file_name , CString +#if GPGME_VERSION_NUMBER >= 0x010800 +#field session_key , CString +#endif +#if GPGME_VERSION_NUMBER >= 0x010b00 +#field symkey_algo , CString +#endif +#if GPGME_VERSION_NUMBER >= 0x020100 +#field session_hash , CString +#endif #stoptype #synonym_t gpgme_decrypt_result_t , Ptr <_gpgme_op_decrypt_result> @@ -417,6 +691,25 @@ #ccall gpgme_op_decrypt_verify_start , -> -> -> IO #ccall gpgme_op_decrypt_verify , -> -> -> IO +#if GPGME_VERSION_NUMBER >= 0x010900 +#integral_t gpgme_decrypt_flags_t +#num GPGME_DECRYPT_VERIFY +#num GPGME_DECRYPT_UNWRAP +#if GPGME_VERSION_NUMBER >= 0x011300 +#num GPGME_DECRYPT_ARCHIVE +#endif +#if GPGME_VERSION_NUMBER >= 0x020000 +-- | Skip the actual decryption and only report the recipients. +#num GPGME_DECRYPT_LISTONLY +#endif +#if GPGME_VERSION_NUMBER >= 0x020100 +#num GPGME_DECRYPT_SESSION_HASH +#endif + +#ccall gpgme_op_decrypt_ext , -> -> -> -> IO +#ccall gpgme_op_decrypt_ext_start , -> -> -> -> IO +#endif + -- * Signing #starttype struct _gpgme_new_signature #field next , Ptr <_gpgme_new_signature> @@ -466,6 +759,11 @@ #field pubkey_algo , #field hash_algo , #field pka_address , CString +#if GPGME_VERSION_NUMBER >= 0x010700 +-- | The key that made the signature. Only filled in when the key is available +-- locally, so this may be @nullPtr@ even for a good signature. +#field key , +#endif #stoptype #synonym_t gpgme_signature_t , Ptr <_gpgme_signature> @@ -479,6 +777,13 @@ #ccall gpgme_op_verify_start , -> -> -> -> IO #ccall gpgme_op_verify , -> -> -> -> IO +#if GPGME_VERSION_NUMBER >= 0x011300 +#integral_t gpgme_verify_flags_t +#num GPGME_VERIFY_ARCHIVE +#ccall gpgme_op_verify_ext , -> -> -> -> -> IO +#ccall gpgme_op_verify_ext_start , -> -> -> -> -> IO +#endif + -- * Importing keys #num GPGME_IMPORT_NEW #num GPGME_IMPORT_UID @@ -510,20 +815,72 @@ #field skipped_new_keys , CInt #field not_imported , CInt #field imports , +#if GPGME_VERSION_NUMBER >= 0x010b00 +#field skipped_v3_keys , CInt +#endif #stoptype #synonym_t gpgme_import_result_t , Ptr <_gpgme_op_import_result> #ccall gpgme_op_import_result , -> IO #ccall gpgme_op_import_start , -> -> IO #ccall gpgme_op_import , -> -> IO + +-- The mode argument of the export operations is a bitmask of the +-- @GPGME_EXPORT_MODE_*@ constants below. #ccall gpgme_op_export_start , -> CString -> CUInt -> -> IO #ccall gpgme_op_export , -> CString -> CUInt -> -> IO #ccall gpgme_op_export_ext_start , -> Ptr CString -> CUInt -> -> IO #ccall gpgme_op_export_ext , -> Ptr CString -> CUInt -> -> IO +-- ** Export modes +#if GPGME_VERSION_NUMBER >= 0x010200 +#integral_t gpgme_export_mode_t +#num GPGME_EXPORT_MODE_EXTERN +#endif +#if GPGME_VERSION_NUMBER >= 0x010301 +#num GPGME_EXPORT_MODE_MINIMAL +#endif +#if GPGME_VERSION_NUMBER >= 0x010600 +#num GPGME_EXPORT_MODE_SECRET +#num GPGME_EXPORT_MODE_RAW +#num GPGME_EXPORT_MODE_PKCS12 +#endif +#if GPGME_VERSION_NUMBER >= 0x010e00 +#num GPGME_EXPORT_MODE_SSH +#endif +#if GPGME_VERSION_NUMBER >= 0x011100 +#num GPGME_EXPORT_MODE_SECRET_SUBKEY +#endif + +-- ** Importing and exporting by key, rather than by pattern +#if GPGME_VERSION_NUMBER >= 0x010200 +-- | The key arrays are @NULL@-terminated. +#ccall gpgme_op_import_keys , -> Ptr -> IO +#ccall gpgme_op_import_keys_start , -> Ptr -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010200 +#ccall gpgme_op_export_keys , -> Ptr -> -> -> IO +#ccall gpgme_op_export_keys_start , -> Ptr -> -> -> IO +#endif + +#if GPGME_VERSION_NUMBER >= 0x011100 +-- | Import keys from a keyserver, by key ID. +#ccall gpgme_op_receive_keys , -> Ptr CString -> IO +#ccall gpgme_op_receive_keys_start , -> Ptr CString -> IO +#endif + -- * Key generation and editing +-- +-- The @primary@, @sub@ and @uid@ members of the result are C bitfields; read +-- them with the @c'gpgme_genkey_result_*@ accessors further down. #starttype struct _gpgme_op_genkey_result #field fpr , CString +#if GPGME_VERSION_NUMBER >= 0x010700 +-- | Only populated when 'GPGME_CREATE_WANTPUB' / 'GPGME_CREATE_WANTSEC' were +-- passed to 'c'gpgme_op_createkey'. +#field pubkey , +#field seckey , +#endif #stoptype #synonym_t gpgme_genkey_result_t , Ptr <_gpgme_op_genkey_result> @@ -539,6 +896,93 @@ #ccall gpgme_op_card_edit_start , -> -> -> Ptr () -> -> IO #ccall gpgme_op_card_edit , -> -> -> Ptr () -> -> IO +-- ** Creating keys +-- +-- The modern replacement for 'c'gpgme_op_genkey' and its XML parameter string. +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_CREATE_SIGN +#num GPGME_CREATE_ENCR +#num GPGME_CREATE_CERT +#num GPGME_CREATE_AUTH +#num GPGME_CREATE_NOPASSWD +#num GPGME_CREATE_SELFSIGNED +#num GPGME_CREATE_NOSTORE +#num GPGME_CREATE_WANTPUB +#num GPGME_CREATE_WANTSEC +#num GPGME_CREATE_FORCE +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +#num GPGME_CREATE_NOEXPIRE +#endif +#if GPGME_VERSION_NUMBER >= 0x011800 +#num GPGME_CREATE_ADSK +#endif +#if GPGME_VERSION_NUMBER >= 0x020000 +#num GPGME_CREATE_GROUP +#endif + +#if GPGME_VERSION_NUMBER >= 0x010700 +#ccall gpgme_op_createkey , -> CString -> CString -> CULong -> CULong -> -> CUInt -> IO +#ccall gpgme_op_createkey_start , -> CString -> CString -> CULong -> CULong -> -> CUInt -> IO +#ccall gpgme_op_createsubkey , -> -> CString -> CULong -> CULong -> CUInt -> IO +#ccall gpgme_op_createsubkey_start , -> -> CString -> CULong -> CULong -> CUInt -> IO +#endif + +-- ** User IDs +#if GPGME_VERSION_NUMBER >= 0x010700 +#ccall gpgme_op_adduid , -> -> CString -> CUInt -> IO +#ccall gpgme_op_adduid_start , -> -> CString -> CUInt -> IO +#ccall gpgme_op_revuid , -> -> CString -> CUInt -> IO +#ccall gpgme_op_revuid_start , -> -> CString -> CUInt -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +-- | Set a flag such as @\"primary\"@ on one user ID of a key. +#ccall gpgme_op_set_uid_flag , -> -> CString -> CString -> CString -> IO +#ccall gpgme_op_set_uid_flag_start , -> -> CString -> CString -> CString -> IO +#endif + +-- ** Signing keys +#if GPGME_VERSION_NUMBER >= 0x010700 +#num GPGME_KEYSIGN_LOCAL +#num GPGME_KEYSIGN_LFSEP +#num GPGME_KEYSIGN_NOEXPIRE +#ccall gpgme_op_keysign , -> -> CString -> CULong -> CUInt -> IO +#ccall gpgme_op_keysign_start , -> -> CString -> CULong -> CUInt -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x011000 +#num GPGME_KEYSIGN_FORCE +#endif +#if GPGME_VERSION_NUMBER >= 0x010f00 +#num GPGME_REVSIG_LFSEP +#ccall gpgme_op_revsig , -> -> -> CString -> CUInt -> IO +#ccall gpgme_op_revsig_start , -> -> -> CString -> CUInt -> IO +#endif + +-- ** Changing key properties +#if GPGME_VERSION_NUMBER >= 0x010300 +-- | Change the passphrase of a key. +#ccall gpgme_op_passwd , -> -> CUInt -> IO +#ccall gpgme_op_passwd_start , -> -> CUInt -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010f00 +-- | @subfprs@ selects the subkeys to act on: @NULL@ for the primary key, +-- @\"*\"@ for all subkeys, or a list of fingerprints. +#ccall gpgme_op_setexpire , -> -> CULong -> CString -> CUInt -> IO +#ccall gpgme_op_setexpire_start , -> -> CULong -> CString -> CUInt -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x011800 +#ccall gpgme_op_setownertrust , -> -> CString -> IO +#ccall gpgme_op_setownertrust_start , -> -> CString -> IO +#endif +#if GPGME_VERSION_NUMBER >= 0x010700 +#ccall gpgme_op_tofu_policy , -> -> -> IO +#ccall gpgme_op_tofu_policy_start , -> -> -> IO + +-- | The replacement for the deprecated 'c'gpgme_op_edit'. +#ccall gpgme_op_interact , -> -> CUInt -> -> Ptr () -> -> IO +#ccall gpgme_op_interact_start , -> -> CUInt -> -> Ptr () -> -> IO +#endif + -- * Listing keys #starttype struct _gpgme_op_keylist_result #stoptype @@ -549,8 +993,14 @@ #ccall gpgme_op_keylist_ext_start , -> Ptr CString -> CInt -> CInt -> IO #ccall gpgme_op_keylist_next , -> Ptr -> IO #ccall gpgme_op_keylist_end , -> IO +#if GPGME_VERSION_NUMBER >= 0x010900 +-- | List the keys contained in a buffer, without importing them. +#ccall gpgme_op_keylist_from_data_start , -> -> CInt -> IO +#endif -- * Trust items +-- Trust items API was removed in GPGME 2.0 (deprecated since 1.14) +#if GPGME_VERSION_NUMBER < 0x020000 #starttype struct _gpgme_trust_item #field keyid , CString #field type , CInt @@ -566,6 +1016,8 @@ #ccall gpgme_op_trustlist_end , -> IO #ccall gpgme_trust_item_ref , -> IO () #ccall gpgme_trust_item_unref , -> IO () +#endif + #ccall gpgme_op_getauditlog_start , -> -> CUInt -> IO #ccall gpgme_op_getauditlog , -> -> CUInt -> IO @@ -668,3 +1120,180 @@ #ccall gpgme_io_read , CInt -> Ptr () -> CSize -> IO CSize #ccall gpgme_io_write , CInt -> Ptr () -> CSize -> IO CSize #ccall gpgme_io_writen , CInt -> Ptr () -> CSize -> IO CSize + +-- * Running arbitrary programs +#if GPGME_VERSION_NUMBER >= 0x010500 +#num GPGME_SPAWN_DETACHED +#num GPGME_SPAWN_ALLOW_SET_FG +#if GPGME_VERSION_NUMBER >= 0x010b00 +#num GPGME_SPAWN_SHOW_WINDOW +#endif +#ccall gpgme_op_spawn , -> CString -> Ptr CString -> -> -> -> CUInt -> IO +#ccall gpgme_op_spawn_start , -> CString -> Ptr CString -> -> -> -> CUInt -> IO +#endif + +-- * Random numbers +#if GPGME_VERSION_NUMBER >= 0x020000 +#integral_t gpgme_random_mode_t +#num GPGME_RANDOM_MODE_NORMAL +#num GPGME_RANDOM_MODE_ZBASE32 +#ccall gpgme_op_random_bytes , -> -> CString -> CSize -> IO +#ccall gpgme_op_random_value , -> CSize -> Ptr CSize -> IO +#endif + +-- * Software version database +#if GPGME_VERSION_NUMBER >= 0x010800 +-- The status members (@warning@, @update@, @urgent@, ...) are C bitfields; +-- read them with the @c'gpgme_query_swdb_result_*@ accessors below. +#starttype struct _gpgme_op_query_swdb_result +#field next , Ptr <_gpgme_op_query_swdb_result> +#field name , CString +#field iversion , CString +#field created , CULong +#field retrieved , CULong +#field version , CString +#field reldate , CULong +#stoptype +#synonym_t gpgme_query_swdb_result_t , Ptr <_gpgme_op_query_swdb_result> + +#ccall gpgme_op_query_swdb , -> CString -> CString -> CUInt -> IO +#ccall gpgme_op_query_swdb_result , -> IO +#endif + +-- * Miscellaneous +#ccall gpgme_op_import_ext , -> -> Ptr CInt -> IO + +#if GPGME_VERSION_NUMBER >= 0x010301 +#ccall gpgme_err_code_from_syserror , IO +-- gpgme_error_from_syserror is a static inline in gpgme.h, not a library +-- symbol, so it has to go through a wrapper like the other gpgme_err_* helpers. +#cinline gpgme_error_from_syserror , IO +#endif + +#if GPGME_VERSION_NUMBER >= 0x010a00 +-- | Query a gpg directory, e.g. @\"homedir\"@ or @\"sysconfdir\"@. The result +-- must be 'c'gpgme_free'd. +#ccall gpgme_op_conf_dir , -> CString -> Ptr CString -> IO +#endif + +-- * Bitfield accessors +-- +-- The C structs above carry most of their boolean state in bitfields, which +-- have no offset and therefore cannot be exposed as record fields. These +-- accessors read them through C, and are the only way to reach them. +-- Most are single-bit flags and return non-zero when set; @origin@, +-- @pka_trust@, @trust_depth@, @trust_value@ and the TOFU @validity@ and +-- @policy@ are wider bitfields whose value is returned as is. + +-- ** Keys +#cinline gpgme_key_revoked , -> IO CUInt +#cinline gpgme_key_expired , -> IO CUInt +#cinline gpgme_key_disabled , -> IO CUInt +#cinline gpgme_key_invalid , -> IO CUInt +#cinline gpgme_key_can_encrypt , -> IO CUInt +#cinline gpgme_key_can_sign , -> IO CUInt +#cinline gpgme_key_can_certify , -> IO CUInt +#cinline gpgme_key_can_authenticate , -> IO CUInt +#cinline gpgme_key_secret , -> IO CUInt +#cinline gpgme_key_is_qualified , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010900 +#cinline gpgme_key_origin , -> IO CUInt +#endif +#if GPGME_VERSION_NUMBER >= 0x011700 +-- | Unlike 'c'gpgme_key_can_encrypt', which reports what the key is capable of, +-- these report whether an unexpired, unrevoked subkey with that capability +-- exists. +#cinline gpgme_key_has_encrypt , -> IO CUInt +#cinline gpgme_key_has_sign , -> IO CUInt +#cinline gpgme_key_has_certify , -> IO CUInt +#cinline gpgme_key_has_authenticate , -> IO CUInt +#endif + +-- ** Subkeys +#cinline gpgme_subkey_revoked , -> IO CUInt +#cinline gpgme_subkey_expired , -> IO CUInt +#cinline gpgme_subkey_disabled , -> IO CUInt +#cinline gpgme_subkey_invalid , -> IO CUInt +#cinline gpgme_subkey_can_encrypt , -> IO CUInt +#cinline gpgme_subkey_can_sign , -> IO CUInt +#cinline gpgme_subkey_can_certify , -> IO CUInt +#cinline gpgme_subkey_can_authenticate , -> IO CUInt +#cinline gpgme_subkey_secret , -> IO CUInt +#cinline gpgme_subkey_is_qualified , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010300 +#cinline gpgme_subkey_is_cardkey , -> IO CUInt +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +#cinline gpgme_subkey_is_de_vs , -> IO CUInt +#endif +#if GPGME_VERSION_NUMBER >= 0x011400 +#cinline gpgme_subkey_can_renc , -> IO CUInt +#cinline gpgme_subkey_can_timestamp , -> IO CUInt +#cinline gpgme_subkey_is_group_owned , -> IO CUInt +#endif + +-- ** User IDs +#cinline gpgme_user_id_revoked , -> IO CUInt +#cinline gpgme_user_id_invalid , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010900 +#cinline gpgme_user_id_origin , -> IO CUInt +#endif + +-- ** Key signatures +#cinline gpgme_key_sig_revoked , -> IO CUInt +#cinline gpgme_key_sig_expired , -> IO CUInt +#cinline gpgme_key_sig_invalid , -> IO CUInt +#cinline gpgme_key_sig_exportable , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x011000 +#cinline gpgme_key_sig_trust_depth , -> IO CUInt +#cinline gpgme_key_sig_trust_value , -> IO CUInt +#endif + +-- ** Signatures +#cinline gpgme_signature_wrong_key_usage , -> IO CUInt +#cinline gpgme_signature_pka_trust , -> IO CUInt +#cinline gpgme_signature_chain_model , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010a00 +#cinline gpgme_signature_is_de_vs , -> IO CUInt +#endif + +-- ** Operation results +#cinline gpgme_decrypt_result_wrong_key_usage , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010a00 +#cinline gpgme_decrypt_result_is_de_vs , -> IO CUInt +#endif +#if GPGME_VERSION_NUMBER >= 0x010b00 +#cinline gpgme_decrypt_result_is_mime , -> IO CUInt +#cinline gpgme_verify_result_is_mime , -> IO CUInt +#endif +#if GPGME_VERSION_NUMBER >= 0x010c00 +#cinline gpgme_decrypt_result_legacy_cipher_nomdc , -> IO CUInt +#endif + +#cinline gpgme_genkey_result_primary , -> IO CUInt +#cinline gpgme_genkey_result_sub , -> IO CUInt +#if GPGME_VERSION_NUMBER >= 0x010700 +#cinline gpgme_genkey_result_uid , -> IO CUInt +#endif + +-- ** TOFU +#if GPGME_VERSION_NUMBER >= 0x010700 +#cinline gpgme_tofu_info_validity , -> IO CUInt +#cinline gpgme_tofu_info_policy , -> IO CUInt +#endif + +-- ** Revocation keys +#if GPGME_VERSION_NUMBER >= 0x011800 +#cinline gpgme_revocation_key_sensitive , -> IO CUInt +#endif + +-- ** Software version database +#if GPGME_VERSION_NUMBER >= 0x010800 +#cinline gpgme_query_swdb_result_warning , -> IO CUInt +#cinline gpgme_query_swdb_result_update , -> IO CUInt +#cinline gpgme_query_swdb_result_urgent , -> IO CUInt +#cinline gpgme_query_swdb_result_noinfo , -> IO CUInt +#cinline gpgme_query_swdb_result_unknown , -> IO CUInt +#cinline gpgme_query_swdb_result_tooold , -> IO CUInt +#cinline gpgme_query_swdb_result_error , -> IO CUInt +#endif diff --git a/src/inlines.c b/src/inlines.c --- a/src/inlines.c +++ b/src/inlines.c @@ -5,4 +5,122 @@ BC_INLINE1(gpgme_error,gpgme_err_code_t,gpgme_error_t) BC_INLINE1(gpgme_err_code,gpgme_error_t,gpgme_err_code_t) BC_INLINE1(gpgme_err_source,gpgme_error_t,gpgme_err_source_t) +#if GPGME_VERSION_NUMBER >= 0x010301 +/* Like the four above, this is a static inline in gpgme.h rather than a symbol + exported by libgpgme, so it needs a wrapper to be callable from Haskell. */ +BC_INLINE0(gpgme_error_from_syserror,gpgme_error_t) +#endif +/* The `next' member of struct _gpgme_invalid_key is bound as an embedded + struct rather than a pointer. That is wrong, but correcting it would change + the type of the generated accessor and break existing callers, so this + provides a correctly typed way to walk the list instead. */ +static gpgme_invalid_key_t +gpgme_invalid_key_next (gpgme_invalid_key_t v) { return v->next; } +BC_INLINE1(gpgme_invalid_key_next,gpgme_invalid_key_t,gpgme_invalid_key_t) + +/* bindings-DSL derives struct fields from offsetof, which bitfields do not + have. Every boolean member of the gpgme structs therefore has to be reached + through C. The version guards mirror those in Gpgme.hsc. */ +#define BC_GPGME_FLAG(name,type,member) \ + static unsigned int name (type v) { return v->member; } \ + BC_INLINE1(name,type,unsigned int) + +BC_GPGME_FLAG(gpgme_key_revoked,gpgme_key_t,revoked) +BC_GPGME_FLAG(gpgme_key_expired,gpgme_key_t,expired) +BC_GPGME_FLAG(gpgme_key_disabled,gpgme_key_t,disabled) +BC_GPGME_FLAG(gpgme_key_invalid,gpgme_key_t,invalid) +BC_GPGME_FLAG(gpgme_key_can_encrypt,gpgme_key_t,can_encrypt) +BC_GPGME_FLAG(gpgme_key_can_sign,gpgme_key_t,can_sign) +BC_GPGME_FLAG(gpgme_key_can_certify,gpgme_key_t,can_certify) +BC_GPGME_FLAG(gpgme_key_can_authenticate,gpgme_key_t,can_authenticate) +BC_GPGME_FLAG(gpgme_key_secret,gpgme_key_t,secret) +BC_GPGME_FLAG(gpgme_key_is_qualified,gpgme_key_t,is_qualified) +#if GPGME_VERSION_NUMBER >= 0x010900 +BC_GPGME_FLAG(gpgme_key_origin,gpgme_key_t,origin) +#endif +#if GPGME_VERSION_NUMBER >= 0x011700 +BC_GPGME_FLAG(gpgme_key_has_encrypt,gpgme_key_t,has_encrypt) +BC_GPGME_FLAG(gpgme_key_has_sign,gpgme_key_t,has_sign) +BC_GPGME_FLAG(gpgme_key_has_certify,gpgme_key_t,has_certify) +BC_GPGME_FLAG(gpgme_key_has_authenticate,gpgme_key_t,has_authenticate) +#endif + +BC_GPGME_FLAG(gpgme_subkey_revoked,gpgme_subkey_t,revoked) +BC_GPGME_FLAG(gpgme_subkey_expired,gpgme_subkey_t,expired) +BC_GPGME_FLAG(gpgme_subkey_disabled,gpgme_subkey_t,disabled) +BC_GPGME_FLAG(gpgme_subkey_invalid,gpgme_subkey_t,invalid) +BC_GPGME_FLAG(gpgme_subkey_can_encrypt,gpgme_subkey_t,can_encrypt) +BC_GPGME_FLAG(gpgme_subkey_can_sign,gpgme_subkey_t,can_sign) +BC_GPGME_FLAG(gpgme_subkey_can_certify,gpgme_subkey_t,can_certify) +BC_GPGME_FLAG(gpgme_subkey_can_authenticate,gpgme_subkey_t,can_authenticate) +BC_GPGME_FLAG(gpgme_subkey_secret,gpgme_subkey_t,secret) +BC_GPGME_FLAG(gpgme_subkey_is_qualified,gpgme_subkey_t,is_qualified) +#if GPGME_VERSION_NUMBER >= 0x010300 +BC_GPGME_FLAG(gpgme_subkey_is_cardkey,gpgme_subkey_t,is_cardkey) +#endif +#if GPGME_VERSION_NUMBER >= 0x010900 +BC_GPGME_FLAG(gpgme_subkey_is_de_vs,gpgme_subkey_t,is_de_vs) +#endif +#if GPGME_VERSION_NUMBER >= 0x011400 +BC_GPGME_FLAG(gpgme_subkey_can_renc,gpgme_subkey_t,can_renc) +BC_GPGME_FLAG(gpgme_subkey_can_timestamp,gpgme_subkey_t,can_timestamp) +BC_GPGME_FLAG(gpgme_subkey_is_group_owned,gpgme_subkey_t,is_group_owned) +#endif + +BC_GPGME_FLAG(gpgme_user_id_revoked,gpgme_user_id_t,revoked) +BC_GPGME_FLAG(gpgme_user_id_invalid,gpgme_user_id_t,invalid) +#if GPGME_VERSION_NUMBER >= 0x010900 +BC_GPGME_FLAG(gpgme_user_id_origin,gpgme_user_id_t,origin) +#endif + +BC_GPGME_FLAG(gpgme_key_sig_revoked,gpgme_key_sig_t,revoked) +BC_GPGME_FLAG(gpgme_key_sig_expired,gpgme_key_sig_t,expired) +BC_GPGME_FLAG(gpgme_key_sig_invalid,gpgme_key_sig_t,invalid) +BC_GPGME_FLAG(gpgme_key_sig_exportable,gpgme_key_sig_t,exportable) +#if GPGME_VERSION_NUMBER >= 0x011000 +BC_GPGME_FLAG(gpgme_key_sig_trust_depth,gpgme_key_sig_t,trust_depth) +BC_GPGME_FLAG(gpgme_key_sig_trust_value,gpgme_key_sig_t,trust_value) +#endif + +BC_GPGME_FLAG(gpgme_signature_wrong_key_usage,gpgme_signature_t,wrong_key_usage) +BC_GPGME_FLAG(gpgme_signature_pka_trust,gpgme_signature_t,pka_trust) +BC_GPGME_FLAG(gpgme_signature_chain_model,gpgme_signature_t,chain_model) +#if GPGME_VERSION_NUMBER >= 0x010a00 +BC_GPGME_FLAG(gpgme_signature_is_de_vs,gpgme_signature_t,is_de_vs) +#endif + +BC_GPGME_FLAG(gpgme_decrypt_result_wrong_key_usage,gpgme_decrypt_result_t,wrong_key_usage) +#if GPGME_VERSION_NUMBER >= 0x010a00 +BC_GPGME_FLAG(gpgme_decrypt_result_is_de_vs,gpgme_decrypt_result_t,is_de_vs) +#endif +#if GPGME_VERSION_NUMBER >= 0x010b00 +BC_GPGME_FLAG(gpgme_decrypt_result_is_mime,gpgme_decrypt_result_t,is_mime) +BC_GPGME_FLAG(gpgme_verify_result_is_mime,gpgme_verify_result_t,is_mime) +#endif +#if GPGME_VERSION_NUMBER >= 0x010c00 +BC_GPGME_FLAG(gpgme_decrypt_result_legacy_cipher_nomdc,gpgme_decrypt_result_t,legacy_cipher_nomdc) +#endif + +BC_GPGME_FLAG(gpgme_genkey_result_primary,gpgme_genkey_result_t,primary) +BC_GPGME_FLAG(gpgme_genkey_result_sub,gpgme_genkey_result_t,sub) +#if GPGME_VERSION_NUMBER >= 0x010700 +BC_GPGME_FLAG(gpgme_genkey_result_uid,gpgme_genkey_result_t,uid) + +BC_GPGME_FLAG(gpgme_tofu_info_validity,gpgme_tofu_info_t,validity) +BC_GPGME_FLAG(gpgme_tofu_info_policy,gpgme_tofu_info_t,policy) +#endif + +#if GPGME_VERSION_NUMBER >= 0x011800 +BC_GPGME_FLAG(gpgme_revocation_key_sensitive,gpgme_revocation_key_t,sensitive) +#endif + +#if GPGME_VERSION_NUMBER >= 0x010800 +BC_GPGME_FLAG(gpgme_query_swdb_result_warning,gpgme_query_swdb_result_t,warning) +BC_GPGME_FLAG(gpgme_query_swdb_result_update,gpgme_query_swdb_result_t,update) +BC_GPGME_FLAG(gpgme_query_swdb_result_urgent,gpgme_query_swdb_result_t,urgent) +BC_GPGME_FLAG(gpgme_query_swdb_result_noinfo,gpgme_query_swdb_result_t,noinfo) +BC_GPGME_FLAG(gpgme_query_swdb_result_unknown,gpgme_query_swdb_result_t,unknown) +BC_GPGME_FLAG(gpgme_query_swdb_result_tooold,gpgme_query_swdb_result_t,tooold) +BC_GPGME_FLAG(gpgme_query_swdb_result_error,gpgme_query_swdb_result_t,error) +#endif