summaryrefslogtreecommitdiffstats
path: root/openpgp-ffi/src/armor.rs
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2019-01-17 17:54:30 +0100
committerJustus Winter <justus@sequoia-pgp.org>2019-01-17 17:54:30 +0100
commit72f7f83fa697ac44d962dc65ef9329dcfe6fd3e8 (patch)
tree3b2af100212cee4ae26e548d0535db705e5f616d /openpgp-ffi/src/armor.rs
parent3f58832474a4b270e136544016a401ef773ac065 (diff)
openpgp-ffi: Change prefix from 'sq' to 'pgp'.
- This change is the result of the following command, which can also be used to automatically convert existing users of Sequoia's C API: git grep -il sq_ | while read F ; do sed -E -i -e 's/sq_(arbitrary_writer_new|armor_reader_from_bytes|armor_reader_from_file|armor_reader_headers|armor_reader_kind|armor_reader_new|armor_writer_new|decrypt|encryptor_new|error_free|error_status|error_string|fingerprint_as_bytes|fingerprint_clone|fingerprint_equal|fingerprint_free|fingerprint_from_bytes|fingerprint_from_hex|fingerprint_hash|fingerprint_to_hex|fingerprint_to_keyid|fingerprint_to_string|keyid_clone|keyid_equal|keyid_free|keyid_from_bytes|keyid_from_hex|keyid_hash|keyid_to_hex|keyid_to_string|key_pair_as_signer|key_pair_free|key_pair_new|literal_writer_new|packet_free|packet_kind|packet_parser_buffer_unread_content|packet_parser_decrypt|packet_parser_eof_free|packet_parser_eof_is_message|packet_parser_finish|packet_parser_free|packet_parser_from_bytes|packet_parser_from_file|packet_parser_from_reader|packet_parser_next|packet_parser_packet|packet_parser_recurse|packet_parser_recursion_depth|packet_parser_result_eof|packet_parser_result_free|packet_parser_result_packet_parser|packet_parser_result_tag|packet_pile_clone|packet_pile_free|packet_pile_from_bytes|packet_pile_from_file|packet_pile_from_reader|packet_pile_serialize|packet_tag|pkesk_decrypt|pkesk_recipient|p_key_alive|p_key_alive_at|p_key_clone|p_key_creation_time|p_key_expired|p_key_expired_at|p_key_fingerprint|p_key_into_key_pair|p_key_keyid|p_key_public_key_algo|p_key_public_key_bits|reader_free|reader_from_bytes|reader_from_fd|reader_from_file|reader_read|revocation_status_free|revocation_status_variant|secret_cached|signature_alive|signature_alive_at|signature_can_authenticate|signature_can_certify|signature_can_encrypt_at_rest|signature_can_encrypt_for_transport|signature_can_sign|signature_expired|signature_expired_at|signature_free|signature_is_group_key|signature_is_split_key|signature_issuer|signature_issuer_fingerprint|signature_to_packet|signer_free|signer_new|signer_new_detached|skesk_decrypt|tag_to_string|tpk_alive|tpk_alive_at|tpk_builder_add_certification_subkey|tpk_builder_add_encryption_subkey|tpk_builder_add_signing_subkey|tpk_builder_add_userid|tpk_builder_autocrypt|tpk_builder_default|tpk_builder_free|tpk_builder_generate|tpk_builder_set_cipher_suite|tpk_clone|tpk_dump|tpk_equal|tpk_expired|tpk_expired_at|tpk_fingerprint|tpk_free|tpk_from_bytes|tpk_from_file|tpk_from_packet_parser|tpk_from_packet_pile|tpk_from_reader|tpk_into_tsk|tpk_is_tsk|tpk_key_iter|tpk_key_iter_free|tpk_key_iter_next|tpk_merge|tpk_merge_packets|tpk_primary|tpk_primary_user_id|tpk_revocation_status|tpk_revoke|tpk_revoke_in_place|tpk_serialize|tpk_set_expiry|tpk_user_id_binding_iter|tsk_free|tsk_into_tpk|tsk_new|tsk_serialize|tsk_tpk|user_attribute_value|user_id_binding_iter_free|user_id_binding_iter_next|user_id_binding_selfsig|user_id_binding_user_id|user_id_value|verification_result_code|verification_result_level|verification_results_at_level|verification_result_signature|verify|writer_alloc|writer_free|writer_from_bytes|writer_from_fd|writer_from_file|writer_stack_finalize|writer_stack_finalize_one|writer_stack_message|writer_stack_write|writer_stack_write_all|writer_write|reader|writer|packet_parser|packet_parser_result|packet_parser_eof|keyid|fingerprint|revocation_status|revocation_status_variant|armor_kind|armor_header|tag|unknown|signature|one_pass_sig|p_key|user_id|user_attribute|literal|compressed_data|pkesk|skesk|seip|mdc|packet|packet_pile|reason_for_revocation|user_id_binding|user_id_binding_iter|tpk_key_iter|tpk|tsk|tpk_builder|tpk_cipher_suite|public_key_algorithm|writer_stack|encryption_mode|secret|verification_results|verification_result|verification_result_code|sequoia_decrypt_get_public_keys_cb_t|sequoia_decrypt_get_secret_keys_cb_t|sequoia_decrypt_check_signatures_cb_t|mpi|signer|key_pair|p_key|status|error)/pgp_\1/g' -e 's/SQ_(ARMOR_KIND_ANY|ARMOR_KIND_FILE|ARMOR_KIND_FORCE_WIDTH|ARMOR_KIND_MESSAGE|ARMOR_KIND_PUBLICKEY|ARMOR_KIND_SECRETKEY|ARMOR_KIND_SIGNATURE|ENCRYPTION_MODE_AT_REST|ENCRYPTION_MODE_FOR_TRANSPORT|PUBLIC_KEY_ALGO_DSA|PUBLIC_KEY_ALGO_ECDH|PUBLIC_KEY_ALGO_ECDSA|PUBLIC_KEY_ALGO_EDDSA|PUBLIC_KEY_ALGO_ELGAMAL_ENCRYPT|PUBLIC_KEY_ALGO_ELGAMAL_ENCRYPT_SIGN|PUBLIC_KEY_ALGO_FORCE_WIDTH|PUBLIC_KEY_ALGO_RSA_ENCRYPT|PUBLIC_KEY_ALGO_RSA_ENCRYPT_SIGN|PUBLIC_KEY_ALGO_RSA_SIGN|REASON_FOR_REVOCATION_FORCE_WIDTH|REASON_FOR_REVOCATION_KEY_COMPROMISED|REASON_FOR_REVOCATION_KEY_RETIRED|REASON_FOR_REVOCATION_KEY_SUPERSEDED|REASON_FOR_REVOCATION_UID_RETIRED|REASON_FOR_REVOCATION_UNSPECIFIED|REVOCATION_STATUS_COULD_BE|REVOCATION_STATUS_FORCE_WIDTH|REVOCATION_STATUS_NOT_AS_FAR_AS_WE_KNOW|REVOCATION_STATUS_REVOKED|STATUS_BAD_SIGNATURE|STATUS_FORCE_WIDTH|STATUS_INDEX_OUT_OF_RANGE|STATUS_INVALID_ARGUMENT|STATUS_INVALID_OPERATION|STATUS_INVALID_PASSWORD|STATUS_INVALID_SESSION_KEY|STATUS_IO_ERROR|STATUS_MALFORMED_MESSAGE|STATUS_MALFORMED_PACKET|STATUS_MALFORMED_TPK|STATUS_MANIPULATED_MESSAGE|STATUS_MISSING_SESSION_KEY|STATUS_NETWORK_POLICY_VIOLATION|STATUS_SUCCESS|STATUS_UNKNOWN_ERROR|STATUS_UNSUPPORTED_AEAD_ALGORITHM|STATUS_UNSUPPORTED_ELLIPTIC_CURVE|STATUS_UNSUPPORTED_HASH_ALGORITHM|STATUS_UNSUPPORTED_PUBLICKEY_ALGORITHM|STATUS_UNSUPPORTED_SIGNATURE_TYPE|STATUS_UNSUPPORTED_SYMMETRIC_ALGORITHM|STATUS_UNSUPPORTED_TPK|TAG_COMPRESSED_DATA|TAG_LITERAL|TAG_MARKER|TAG_MDC|TAG_ONE_PASS_SIG|TAG_PKESK|TAG_PRIVATE|TAG_PUBLIC_KEY|TAG_PUBLIC_SUBKEY|TAG_RESERVED|TAG_SECRET_KEY|TAG_SECRET_SUBKEY|TAG_SED|TAG_SEIP|TAG_SIGNATURE|TAG_SKESK|TAG_TRUST|TAG_UNASSIGNED|TAG_USER_ATTRIBUTE|TAG_USER_ID|TPK_CIPHER_SUITE_CV|TPK_CIPHER_SUITE_FORCE_WIDTH|TPK_CIPHER_SUITE_RSA|VERIFICATION_RESULT_CODE_BAD_CHECKSUM|VERIFICATION_RESULT_CODE_FORCE_WIDTH|VERIFICATION_RESULT_CODE_GOOD_CHECKSUM|VERIFICATION_RESULT_CODE_MISSING_KEY)/PGP_\1/g' $F ; done
Diffstat (limited to 'openpgp-ffi/src/armor.rs')
-rw-r--r--openpgp-ffi/src/armor.rs72
1 files changed, 36 insertions, 36 deletions
diff --git a/openpgp-ffi/src/armor.rs b/openpgp-ffi/src/armor.rs
index d068737e..ada52bbd 100644
--- a/openpgp-ffi/src/armor.rs
+++ b/openpgp-ffi/src/armor.rs
@@ -71,20 +71,20 @@ fn kind_to_int(kind: Option<armor::Kind>) -> c_int {
/// int
/// main (int argc, char **argv)
/// {
-/// sq_error_t err;
-/// sq_reader_t bytes;
-/// sq_reader_t armor;
-/// sq_armor_kind_t kind;
+/// pgp_error_t err;
+/// pgp_reader_t bytes;
+/// pgp_reader_t armor;
+/// pgp_armor_kind_t kind;
/// char message[12];
-/// sq_armor_header_t *header;
+/// pgp_armor_header_t *header;
/// size_t header_len;
///
-/// bytes = sq_reader_from_bytes ((uint8_t *) armored, strlen (armored));
-/// armor = sq_armor_reader_new (bytes, SQ_ARMOR_KIND_ANY);
+/// bytes = pgp_reader_from_bytes ((uint8_t *) armored, strlen (armored));
+/// armor = pgp_armor_reader_new (bytes, PGP_ARMOR_KIND_ANY);
///
-/// header = sq_armor_reader_headers (&err, armor, &header_len);
+/// header = pgp_armor_reader_headers (&err, armor, &header_len);
/// if (header == NULL)
-/// error (1, 0, "Getting headers failed: %s", sq_error_string (err));
+/// error (1, 0, "Getting headers failed: %s", pgp_error_string (err));
///
/// assert (header_len == 2);
/// assert (strcmp (header[0].key, "Key0") == 0
@@ -98,21 +98,21 @@ fn kind_to_int(kind: Option<armor::Kind>) -> c_int {
/// }
/// free (header);
///
-/// kind = sq_armor_reader_kind (armor);
-/// assert (kind == SQ_ARMOR_KIND_FILE);
+/// kind = pgp_armor_reader_kind (armor);
+/// assert (kind == PGP_ARMOR_KIND_FILE);
///
-/// if (sq_reader_read (&err, armor, (uint8_t *) message, 12) < 0)
-/// error (1, 0, "Reading failed: %s", sq_error_string (err));
+/// if (pgp_reader_read (&err, armor, (uint8_t *) message, 12) < 0)
+/// error (1, 0, "Reading failed: %s", pgp_error_string (err));
///
/// assert (memcmp (message, "Hello world!", 12) == 0);
///
-/// sq_reader_free (armor);
-/// sq_reader_free (bytes);
+/// pgp_reader_free (armor);
+/// pgp_reader_free (bytes);
/// return 0;
/// }
/// ```
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_reader_new(inner: *mut Box<Read>,
+pub extern "system" fn pgp_armor_reader_new(inner: *mut Box<Read>,
kind: c_int)
-> *mut Box<Read> {
let inner = ffi_param_ref_mut!(inner);
@@ -123,7 +123,7 @@ pub extern "system" fn sq_armor_reader_new(inner: *mut Box<Read>,
/// Creates a `Reader` from a file.
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_reader_from_file(errp: Option<&mut *mut failure::Error>,
+pub extern "system" fn pgp_armor_reader_from_file(errp: Option<&mut *mut failure::Error>,
filename: *const c_char,
kind: c_int)
-> *mut Box<Read> {
@@ -138,7 +138,7 @@ pub extern "system" fn sq_armor_reader_from_file(errp: Option<&mut *mut failure:
/// Creates a `Reader` from a buffer.
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_reader_from_bytes(b: *const uint8_t, len: size_t,
+pub extern "system" fn pgp_armor_reader_from_bytes(b: *const uint8_t, len: size_t,
kind: c_int)
-> *mut Box<Read> {
assert!(!b.is_null());
@@ -154,15 +154,15 @@ pub extern "system" fn sq_armor_reader_from_bytes(b: *const uint8_t, len: size_t
///
/// 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 SQ_ARMOR_KIND_ANY.
+/// function returns PGP_ARMOR_KIND_ANY.
///
/// # Example
///
/// See [this] example.
///
-/// [this]: fn.sq_armor_reader_new.html
+/// [this]: fn.pgp_armor_reader_new.html
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_reader_kind(reader: *mut Box<Read>)
+pub extern "system" fn pgp_armor_reader_kind(reader: *mut Box<Read>)
-> c_int {
// We need to downcast `reader`. To do that, we need to do a
// little dance. We will momentarily take ownership of `reader`,
@@ -190,9 +190,9 @@ pub extern "system" fn sq_armor_reader_kind(reader: *mut Box<Read>)
///
/// See [this] example.
///
-/// [this]: fn.sq_armor_reader_new.html
+/// [this]: fn.pgp_armor_reader_new.html
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_reader_headers(errp: Option<&mut *mut failure::Error>,
+pub extern "system" fn pgp_armor_reader_headers(errp: Option<&mut *mut failure::Error>,
reader: *mut Box<Read>,
len: *mut size_t)
-> *mut ArmorHeader {
@@ -275,26 +275,26 @@ fn strdup(s: &str) -> *mut c_char {
/// {
/// void *buf = NULL;
/// size_t len = 0;
-/// sq_writer_t alloc;
-/// sq_writer_t armor;
-/// sq_error_t err;
+/// pgp_writer_t alloc;
+/// pgp_writer_t armor;
+/// pgp_error_t err;
///
/// char *message = "Hello world!";
-/// sq_armor_header_t header[2] = {
+/// pgp_armor_header_t header[2] = {
/// { "Key0", "Value0" },
/// { "Key1", "Value1" },
/// };
///
-/// alloc = sq_writer_alloc (&buf, &len);
-/// armor = sq_armor_writer_new (&err, alloc, SQ_ARMOR_KIND_FILE, header, 2);
+/// alloc = pgp_writer_alloc (&buf, &len);
+/// armor = pgp_armor_writer_new (&err, alloc, PGP_ARMOR_KIND_FILE, header, 2);
/// if (armor == NULL)
-/// error (1, 0, "Creating armor writer failed: %s", sq_error_string (err));
+/// error (1, 0, "Creating armor writer failed: %s", pgp_error_string (err));
///
-/// if (sq_writer_write (&err, armor, (uint8_t *) message, strlen (message)) < 0)
-/// error (1, 0, "Writing failed: %s", sq_error_string (err));
+/// if (pgp_writer_write (&err, armor, (uint8_t *) message, strlen (message)) < 0)
+/// error (1, 0, "Writing failed: %s", pgp_error_string (err));
//
-/// sq_writer_free (armor);
-/// sq_writer_free (alloc);
+/// pgp_writer_free (armor);
+/// pgp_writer_free (alloc);
///
/// assert (len == 114);
/// assert (memcmp (buf,
@@ -312,7 +312,7 @@ fn strdup(s: &str) -> *mut c_char {
/// }
/// ```
#[::ffi_catch_abort] #[no_mangle]
-pub extern "system" fn sq_armor_writer_new
+pub extern "system" fn pgp_armor_writer_new
(errp: Option<&mut *mut failure::Error>,
inner: *mut Box<Write>,
kind: c_int,
@@ -322,7 +322,7 @@ pub extern "system" fn sq_armor_writer_new
{
ffi_make_fry_from_errp!(errp);
let inner = ffi_param_ref_mut!(inner);
- let kind = int_to_kind(kind).expect("KIND must not be SQ_ARMOR_KIND_ANY");
+ let kind = int_to_kind(kind).expect("KIND must not be PGP_ARMOR_KIND_ANY");
let mut header_ = Vec::new();
if header_len > 0 {