g10/call-agent.h

   1 /* call-agent.h - Divert operations to the agent
   2  * Copyright (C) 2003 Free Software Foundation, Inc.
   3  *
   4  * This file is part of GnuPG.
   5  *
   6  * GnuPG is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GnuPG is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #ifndef GNUPG_G10_CALL_AGENT_H
  20 #define GNUPG_G10_CALL_AGENT_H
  21
  22
  23 struct agent_card_info_s
  24 {
  25   int error;         /* private. */
  26   char *apptype;     /* Malloced application type string.  */
  27   char *serialno;    /* malloced hex string. */
  28   char *disp_name;   /* malloced. */
  29   char *disp_lang;   /* malloced. */
  30   int  disp_sex;     /* 0 = unspecified, 1 = male, 2 = female */
  31   char *pubkey_url;  /* malloced. */
  32   char *login_data;  /* malloced. */
  33   char *private_do[4]; /* malloced. */
  34   char cafpr1valid;
  35   char cafpr2valid;
  36   char cafpr3valid;
  37   char cafpr1[20];
  38   char cafpr2[20];
  39   char cafpr3[20];
  40   char fpr1valid;
  41   char fpr2valid;
  42   char fpr3valid;
  43   char fpr1[20];
  44   char fpr2[20];
  45   char fpr3[20];
  46   u32  fpr1time;
  47   u32  fpr2time;
  48   u32  fpr3time;
  49   unsigned long sig_counter;
  50   int chv1_cached;   /* True if a PIN is not required for each
  51                         signing.  Note that the gpg-agent might cache
  52                         it anyway. */
  53   int is_v2;         /* True if this is a v2 card.  */
  54   int chvmaxlen[3];  /* Maximum allowed length of a CHV. */
  55   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
  56   struct {           /* Array with key attributes.  */
  57     int algo;              /* Algorithm identifier.  */
  58     unsigned int nbits;    /* Supported keysize.  */
  59   } key_attr[3];
  60 };
  61
  62 struct agent_card_genkey_s {
  63   char fprvalid;
  64   char fpr[20];
  65   u32  created_at;
  66   gcry_mpi_t n;
  67   gcry_mpi_t e;
  68 };
  69
  70
  71 /* Release the card info structure. */
  72 void agent_release_card_info (struct agent_card_info_s *info);
  73
  74 /* Return card info. */
  75 int agent_learn (struct agent_card_info_s *info);
  76
  77 /* Update INFO with the attribute NAME. */
  78 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
  79
  80 /* Send a SETATTR command to the SCdaemon. */
  81 int agent_scd_setattr (const char *name,
  82                        const unsigned char *value, size_t valuelen,
  83                        const char *serialno);
  84
  85 /* Send a WRITECERT command to the SCdaemon. */
  86 int agent_scd_writecert (const char *certidstr,
  87                           const unsigned char *certdata, size_t certdatalen);
  88
  89 /* Send a WRITEKEY command to the SCdaemon. */
  90 int agent_scd_writekey (int keyno, const char *serialno,
  91                         const unsigned char *keydata, size_t keydatalen);
  92
  93 /* Send a GENKEY command to the SCdaemon. */
  94 int agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force,
  95                       const char *serialno, u32 createtime);
  96
  97 /* Send a PKSIGN command to the SCdaemon. */
  98 int agent_scd_pksign (const char *keyid, int hashalgo,
  99                       const unsigned char *indata, size_t indatalen,
 100                       unsigned char **r_buf, size_t *r_buflen);
 101
 102 /* Send a PKDECRYPT command to the SCdaemon. */
 103 int agent_scd_pkdecrypt (const char *serialno,
 104                          const unsigned char *indata, size_t indatalen,
 105                          unsigned char **r_buf, size_t *r_buflen);
 106
 107 /* Send a READKEY command to the SCdaemon. */
 108 int agent_scd_readcert (const char *certidstr,
 109                         void **r_buf, size_t *r_buflen);
 110
 111 /* Change the PIN of an OpenPGP card or reset the retry counter. */
 112 int agent_scd_change_pin (int chvno, const char *serialno);
 113
 114 /* Send the CHECKPIN command to the SCdaemon. */
 115 int agent_scd_checkpin  (const char *serialno);
 116
 117 /* Dummy function, only implemented by gpg 1.4. */
 118 void agent_clear_pin_cache (const char *sn);
 119
 120
 121 /* Send the GET_PASSPHRASE command to the agent.  */
 122 gpg_error_t agent_get_passphrase (const char *cache_id,
 123                                   const char *err_msg,
 124                                   const char *prompt,
 125                                   const char *desc_msg,
 126                                   int repeat,
 127                                   int check,
 128                                   char **r_passphrase);
 129
 130 /* Send the CLEAR_PASSPHRASE command to the agent.  */
 131 gpg_error_t agent_clear_passphrase (const char *cache_id);
 132
 133
 134 #endif /*GNUPG_G10_CALL_AGENT_H*/
 135