keyindex.h

   1 /*
   2  * keyindex.h - Routines to list an OpenPGP key.
   3  *
   4  * Copyright 2002-2008 Jonathan McDowell <noodles@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __KEYINDEX_H__
  20 #define __KEYINDEX_H__
  21
  22 #include <stdbool.h>
  23
  24 #include "keydb.h"
  25 #include "keystructs.h"
  26
  27 /**
  28  *      key_index - List a set of OpenPGP keys.
  29  *      @keys: The keys to display.
  30  *      @verbose: Should we list sigs as well?
  31  *      @fingerprint: List the fingerprint?
  32  *      @skshash: List the sks hash?
  33  *      @html: Should we tailor the output for HTML?
  34  *
  35  *      This function takes a list of OpenPGP public keys and displays an index
  36  *      of them. Useful for debugging or the keyserver Index function.
  37  */
  38 int key_index(struct onak_dbctx *dbctx,
  39                 struct openpgp_publickey *keys, bool verbose,
  40                 bool fingerprint, bool skshash, bool html);
  41
  42 /**
  43  *      mrkey_index - List a set of OpenPGP keys in the MRHKP format.
  44  *      @keys: The keys to display.
  45  *
  46  *      This function takes a list of OpenPGP public keys and displays a
  47  *      machine readable list of them.
  48  */
  49 int mrkey_index(struct openpgp_publickey *keys);
  50 #endif