diff options
author | Justus Winter <justus@sequoia-pgp.org> | 2019-01-17 17:54:30 +0100 |
---|---|---|
committer | Justus Winter <justus@sequoia-pgp.org> | 2019-01-17 17:54:30 +0100 |
commit | 72f7f83fa697ac44d962dc65ef9329dcfe6fd3e8 (patch) | |
tree | 3b2af100212cee4ae26e548d0535db705e5f616d /openpgp-ffi/include/sequoia/openpgp | |
parent | 3f58832474a4b270e136544016a401ef773ac065 (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/include/sequoia/openpgp')
-rw-r--r-- | openpgp-ffi/include/sequoia/openpgp/crypto.h | 16 | ||||
-rw-r--r-- | openpgp-ffi/include/sequoia/openpgp/error.h | 58 |
2 files changed, 37 insertions, 37 deletions
diff --git a/openpgp-ffi/include/sequoia/openpgp/crypto.h b/openpgp-ffi/include/sequoia/openpgp/crypto.h index 1c30fe3f..6e7fb0ca 100644 --- a/openpgp-ffi/include/sequoia/openpgp/crypto.h +++ b/openpgp-ffi/include/sequoia/openpgp/crypto.h @@ -1,7 +1,7 @@ #ifndef SEQUOIA_OPENPGP_CRYPTO_H #define SEQUOIA_OPENPGP_CRYPTO_H -typedef struct sq_mpi *sq_mpi_t; +typedef struct pgp_mpi *pgp_mpi_t; /*/ /// Creates a signature. @@ -11,12 +11,12 @@ typedef struct sq_mpi *sq_mpi_t; /// operations involving signing to use a variety of secret key /// storage mechanisms (e.g. smart cards). /*/ -typedef struct sq_signer *sq_signer_t; +typedef struct pgp_signer *pgp_signer_t; /*/ /// Frees a signer. /*/ -void sq_signer_free (sq_signer_t s); +void pgp_signer_free (pgp_signer_t s); /*/ /// A cryptographic key pair. @@ -24,20 +24,20 @@ void sq_signer_free (sq_signer_t s); /// A `KeyPair` is a combination of public and secret key. If both /// are available in memory, a `KeyPair` is a convenient /*/ -typedef struct sq_key_pair *sq_key_pair_t; +typedef struct pgp_key_pair *pgp_key_pair_t; /* Forward declaration. */ -typedef struct sq_p_key *sq_p_key_t; +typedef struct pgp_p_key *pgp_p_key_t; /*/ /// Creates a new key pair. /*/ -void sq_key_pair_new (sq_p_key_t public, sq_mpi_t secret); +void pgp_key_pair_new (pgp_p_key_t public, pgp_mpi_t secret); /*/ /// Frees a key pair. /*/ -void sq_key_pair_free (sq_key_pair_t kp); +void pgp_key_pair_free (pgp_key_pair_t kp); /*/ /// Creates a signer from a key pair. @@ -45,6 +45,6 @@ void sq_key_pair_free (sq_key_pair_t kp); /// Note that the returned object merely references the key pair, and /// must not outlive the key pair. /*/ -sq_signer_t sq_key_pair_as_signer (sq_key_pair_t kp); +pgp_signer_t pgp_key_pair_as_signer (pgp_key_pair_t kp); #endif /* SEQUOIA_OPENPGP_CRYPTO_H */ diff --git a/openpgp-ffi/include/sequoia/openpgp/error.h b/openpgp-ffi/include/sequoia/openpgp/error.h index dd42753c..d6fa2c5f 100644 --- a/openpgp-ffi/include/sequoia/openpgp/error.h +++ b/openpgp-ffi/include/sequoia/openpgp/error.h @@ -6,142 +6,142 @@ #include <limits.h> /* XXX: Reorder and name-space before release. */ -typedef enum sq_status { +typedef enum pgp_status { /*/ /// The operation was successful. /*/ - SQ_STATUS_SUCCESS = 0, + PGP_STATUS_SUCCESS = 0, /*/ /// An unknown error occurred. /*/ - SQ_STATUS_UNKNOWN_ERROR = -1, + PGP_STATUS_UNKNOWN_ERROR = -1, /*/ /// The network policy was violated by the given action. /*/ - SQ_STATUS_NETWORK_POLICY_VIOLATION = -2, + PGP_STATUS_NETWORK_POLICY_VIOLATION = -2, /*/ /// An IO error occurred. /*/ - SQ_STATUS_IO_ERROR = -3, + PGP_STATUS_IO_ERROR = -3, /*/ /// A given argument is invalid. /*/ - SQ_STATUS_INVALID_ARGUMENT = -15, + PGP_STATUS_INVALID_ARGUMENT = -15, /*/ /// The requested operation is invalid. /*/ - SQ_STATUS_INVALID_OPERATION = -4, + PGP_STATUS_INVALID_OPERATION = -4, /*/ /// The packet is malformed. /*/ - SQ_STATUS_MALFORMED_PACKET = -5, + PGP_STATUS_MALFORMED_PACKET = -5, /*/ /// Unsupported hash algorithm. /*/ - SQ_STATUS_UNSUPPORTED_HASH_ALGORITHM = -9, + PGP_STATUS_UNSUPPORTED_HASH_ALGORITHM = -9, /*/ /// Unsupported public key algorithm. /*/ - SQ_STATUS_UNSUPPORTED_PUBLICKEY_ALGORITHM = -18, + PGP_STATUS_UNSUPPORTED_PUBLICKEY_ALGORITHM = -18, /*/ /// Unsupported elliptic curve. /*/ - SQ_STATUS_UNSUPPORTED_ELLIPTIC_CURVE = -21, + PGP_STATUS_UNSUPPORTED_ELLIPTIC_CURVE = -21, /*/ /// Unsupported symmetric algorithm. /*/ - SQ_STATUS_UNSUPPORTED_SYMMETRIC_ALGORITHM = -10, + PGP_STATUS_UNSUPPORTED_SYMMETRIC_ALGORITHM = -10, /*/ /// Unsupported AEAD algorithm. /*/ - SQ_STATUS_UNSUPPORTED_AEAD_ALGORITHM = -26, + PGP_STATUS_UNSUPPORTED_AEAD_ALGORITHM = -26, /*/ /// Unsupport signature type. /*/ - SQ_STATUS_UNSUPPORTED_SIGNATURE_TYPE = -20, + PGP_STATUS_UNSUPPORTED_SIGNATURE_TYPE = -20, /*/ /// Invalid password. /*/ - SQ_STATUS_INVALID_PASSWORD = -11, + PGP_STATUS_INVALID_PASSWORD = -11, /*/ /// Invalid session key. /*/ - SQ_STATUS_INVALID_SESSION_KEY = -12, + PGP_STATUS_INVALID_SESSION_KEY = -12, /*/ /// Missing session key. /*/ - SQ_STATUS_MISSING_SESSION_KEY = -27, + PGP_STATUS_MISSING_SESSION_KEY = -27, /*/ /// Malformed TPK. /*/ - SQ_STATUS_MALFORMED_TPK = -13, + PGP_STATUS_MALFORMED_TPK = -13, /*/ /// Bad signature. /*/ - SQ_STATUS_BAD_SIGNATURE = -19, + PGP_STATUS_BAD_SIGNATURE = -19, /*/ /// Message has been manipulated. /*/ - SQ_STATUS_MANIPULATED_MESSAGE = -25, + PGP_STATUS_MANIPULATED_MESSAGE = -25, /*/ /// Malformed message. /*/ - SQ_STATUS_MALFORMED_MESSAGE = -22, + PGP_STATUS_MALFORMED_MESSAGE = -22, /*/ /// Index out of range. /*/ - SQ_STATUS_INDEX_OUT_OF_RANGE = -23, + PGP_STATUS_INDEX_OUT_OF_RANGE = -23, /*/ /// TPK not supported. /*/ - SQ_STATUS_UNSUPPORTED_TPK = -24, + PGP_STATUS_UNSUPPORTED_TPK = -24, /* Dummy value to make sure the enumeration has a defined size. Do not use this value. */ - SQ_STATUS_FORCE_WIDTH = INT_MAX, -} sq_status_t; + PGP_STATUS_FORCE_WIDTH = INT_MAX, +} pgp_status_t; /*/ /// Complex errors returned from Sequoia. /*/ -typedef struct sq_error *sq_error_t; +typedef struct pgp_error *pgp_error_t; /*/ /// Frees an error. /*/ -void sq_error_free (sq_error_t error); +void pgp_error_free (pgp_error_t error); /*/ /// Returns the error message. /// /// The returned value must be freed with `free(3)`. /*/ -char *sq_error_string (const sq_error_t err); +char *pgp_error_string (const pgp_error_t err); /*/ /// Returns the error status code. /*/ -sq_status_t sq_error_status (const sq_error_t err); +pgp_status_t pgp_error_status (const pgp_error_t err); #endif |