/**
 * @file
 * Misc PGP helper routines
 *
 * @authors
 * Copyright (C) 2017 Pietro Cerutti <gahr@gahr.ch>
 * Copyright (C) 2017-2024 Richard Russon <rich@flatcap.org>
 *
 * @copyright
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MUTT_NCRYPT_PGPLIB_H
#define MUTT_NCRYPT_PGPLIB_H

#include <stdbool.h>
#include <time.h>
#include "mutt/lib.h"
#include "lib.h"

/**
 * struct PgpUid - PGP User ID
 */
struct PgpUid
{
  char *addr;
  short trust;
  int flags;
  struct PgpKeyInfo *parent; ///< Parent key
  struct PgpUid *next;       ///< Linked list
};
ARRAY_HEAD(PgpUidArray, struct PgpUid *);

/**
 * struct PgpKeyInfo - Information about a PGP key
 */
struct PgpKeyInfo
{
  char *keyid;
  char *fingerprint;
  struct PgpUid *address;
  KeyFlags flags;
  short keylen;
  time_t gen_time;
  int numalg;
  const char *algorithm;
  struct PgpKeyInfo *parent;
  struct PgpKeyInfo *next;
};

/**
 * ExpandoDataPgpKey - Expando UIDs for PGP Keys
 *
 * @sa ED_PGP_KEY, ExpandoDomain
 */
enum ExpandoDataPgpKey
{
  ED_PGK_DATE = 1,             ///< PgpKeyInfo.gen_time
  ED_PGK_KEY_ALGORITHM,        ///< PgpKeyInfo.algorithm
  ED_PGK_KEY_CAPABILITIES,     ///< PgpKeyInfo.flags, pgp_key_abilities()
  ED_PGK_KEY_FINGERPRINT,      ///< PgpKeyInfo.fingerprint
  ED_PGK_KEY_FLAGS,            ///< PgpKeyInfo.kflags, pgp_flags()
  ED_PGK_KEY_ID,               ///< PgpKeyInfo, pgp_this_keyid()
  ED_PGK_KEY_LENGTH,           ///< PgpKeyInfo.keylen
  ED_PGK_PKEY_ALGORITHM,       ///< pgp_principal_key(), PgpKeyInfo.algorithm
  ED_PGK_PKEY_CAPABILITIES,    ///< pgp_principal_key(), PgpKeyInfo.flags, pgp_key_abilities()
  ED_PGK_PKEY_FINGERPRINT,     ///< pgp_principal_key(), PgpKeyInfo.fingerprint
  ED_PGK_PKEY_FLAGS,           ///< pgp_principal_key(), PgpKeyInfo.kflags, pgp_flags()
  ED_PGK_PKEY_ID,              ///< pgp_principal_key(), PgpKeyInfo, pgp_this_keyid()
  ED_PGK_PKEY_LENGTH,          ///< pgp_principal_key(), PgpKeyInfo.keylen
  ED_PGK_PROTOCOL,             ///< PgpKeyInfo
};

const char *pgp_pkalgbytype(unsigned char type);

struct PgpUid *pgp_copy_uids(struct PgpUid *up, struct PgpKeyInfo *parent);

bool pgp_canencrypt(unsigned char type);
bool pgp_cansign(unsigned char type);

void pgp_key_free(struct PgpKeyInfo **kpp);

struct PgpKeyInfo *pgp_remove_key(struct PgpKeyInfo **klist, struct PgpKeyInfo *key);

struct PgpKeyInfo *pgp_keyinfo_new(void);

#endif /* MUTT_NCRYPT_PGPLIB_H */
