gpg-interface.hon commit doc: group pretty-format.txt placeholders descriptions (4261775)
   1#ifndef GPG_INTERFACE_H
   2#define GPG_INTERFACE_H
   3
   4struct strbuf;
   5
   6#define GPG_VERIFY_VERBOSE              1
   7#define GPG_VERIFY_RAW                  2
   8#define GPG_VERIFY_OMIT_STATUS  4
   9
  10struct signature_check {
  11        char *payload;
  12        char *gpg_output;
  13        char *gpg_status;
  14
  15        /*
  16         * possible "result":
  17         * 0 (not checked)
  18         * N (checked but no further result)
  19         * U (untrusted good)
  20         * G (good)
  21         * B (bad)
  22         */
  23        char result;
  24        char *signer;
  25        char *key;
  26        char *fingerprint;
  27        char *primary_key_fingerprint;
  28};
  29
  30void signature_check_clear(struct signature_check *sigc);
  31
  32/*
  33 * Look at GPG signed content (e.g. a signed tag object), whose
  34 * payload is followed by a detached signature on it.  Return the
  35 * offset where the embedded detached signature begins, or the end of
  36 * the data when there is no such signature.
  37 */
  38size_t parse_signature(const char *buf, size_t size);
  39
  40/*
  41 * Create a detached signature for the contents of "buffer" and append
  42 * it after "signature"; "buffer" and "signature" can be the same
  43 * strbuf instance, which would cause the detached signature appended
  44 * at the end.
  45 */
  46int sign_buffer(struct strbuf *buffer, struct strbuf *signature,
  47                const char *signing_key);
  48
  49/*
  50 * Run "gpg" to see if the payload matches the detached signature.
  51 * gpg_output, when set, receives the diagnostic output from GPG.
  52 * gpg_status, when set, receives the status output from GPG.
  53 */
  54int verify_signed_buffer(const char *payload, size_t payload_size,
  55                         const char *signature, size_t signature_size,
  56                         struct strbuf *gpg_output, struct strbuf *gpg_status);
  57
  58int git_gpg_config(const char *, const char *, void *);
  59void set_signing_key(const char *);
  60const char *get_signing_key(void);
  61int check_signature(const char *payload, size_t plen,
  62                    const char *signature, size_t slen,
  63                    struct signature_check *sigc);
  64void print_signature_buffer(const struct signature_check *sigc,
  65                            unsigned flags);
  66
  67#endif