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 2 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, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
  19  */
  20 #ifndef GNUPG_G10_CALL_AGENT_H
  21 #define GNUPG_G10_CALL_AGENT_H
  22
  23
  24 struct agent_card_info_s {
  25   int error;         /* private. */
  26   char *serialno;    /* malloced hex string. */
  27   char *disp_name;   /* malloced. */
  28   char *disp_lang;   /* malloced. */
  29   int  disp_sex;     /* 0 = unspecified, 1 = male, 2 = female */
  30   char *pubkey_url;  /* malloced. */
  31   char *login_data;  /* malloced. */
  32   char cafpr1valid;
  33   char cafpr2valid;
  34   char cafpr3valid;
  35   char cafpr1[20];
  36   char cafpr2[20];
  37   char cafpr3[20];
  38   char fpr1valid;
  39   char fpr2valid;
  40   char fpr3valid;
  41   char fpr1[20];
  42   char fpr2[20];
  43   char fpr3[20];
  44   unsigned long sig_counter;
  45   int chv1_cached;   /* True if a PIN is not required for each
  46                         signing.  Note that the gpg-agent might cache
  47                         it anyway. */
  48   int chvmaxlen[3];  /* Maximum allowed length of a CHV. */
  49   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
  50 };
  51
  52 struct agent_card_genkey_s {
  53   char fprvalid;
  54   char fpr[20];
  55   u32  created_at;
  56   gcry_mpi_t n;
  57   gcry_mpi_t e;
  58 };
  59
  60
  61 /* Release the card info structure. */
  62 void agent_release_card_info (struct agent_card_info_s *info);
  63
  64 /* Return card info. */
  65 int agent_learn (struct agent_card_info_s *info);
  66
  67 /* Update INFO with the attribute NAME. */
  68 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
  69
  70 /* Check whether the secret key for the key identified by HEXKEYGRIP
  71    is available.  Return 0 for yes or an error code. */
  72 int agent_havekey (const char *hexkeygrip);
  73
  74 /* Send a SETATTR command to the SCdaemon. */
  75 int agent_scd_setattr (const char *name,
  76                        const unsigned char *value, size_t valuelen);
  77
  78 /* Send a GENKEY command to the SCdaemon. */
  79 int agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force);
  80
  81 /* Send a PKSIGN command to the SCdaemon. */
  82 int agent_scd_pksign (const char *keyid, int hashalgo,
  83                       const unsigned char *indata, size_t indatalen,
  84                       char **r_buf, size_t *r_buflen);
  85
  86 /* Send a PKDECRYPT command to the SCdaemon. */
  87 int agent_scd_pkdecrypt (const char *serialno,
  88                          const unsigned char *indata, size_t indatalen,
  89                          char **r_buf, size_t *r_buflen);
  90
  91 /* Change the PIN of an OpenPGP card or reset the retry counter. */
  92 int agent_scd_change_pin (int chvno);
  93
  94 /* Send the CHECKPIN command to the SCdaemon. */
  95 int agent_scd_checkpin  (const char *serialno);
  96
  97
  98
  99 #endif /*GNUPG_G10_CALL_AGENT_H*/
 100