g10/ does build again.
[gnupg.git] / 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 {
26   int error;         /* private. */
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 chvmaxlen[3];  /* Maximum allowed length of a CHV. */
54   int chvretry[3];   /* Allowed retries for the CHV; 0 = blocked. */
55 };
56
57 struct agent_card_genkey_s {
58   char fprvalid;
59   char fpr[20];
60   u32  created_at;
61   gcry_mpi_t n;
62   gcry_mpi_t e;
63 };
64
65
66 /* Release the card info structure. */
67 void agent_release_card_info (struct agent_card_info_s *info);
68
69 /* Return card info. */
70 int agent_learn (struct agent_card_info_s *info);
71
72 /* Update INFO with the attribute NAME. */
73 int agent_scd_getattr (const char *name, struct agent_card_info_s *info);
74
75 /* Check whether the secret key for the key identified by HEXKEYGRIP
76    is available.  Return 0 for yes or an error code. */
77 int agent_havekey (const char *hexkeygrip);
78
79 /* Send a SETATTR command to the SCdaemon. */
80 int agent_scd_setattr (const char *name,
81                        const unsigned char *value, size_t valuelen,
82                        const char *serialno);
83
84 /* Send a GENKEY command to the SCdaemon. */
85 int agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force,
86                       const char *serialno);
87
88 /* Send a PKSIGN command to the SCdaemon. */
89 int agent_scd_pksign (const char *keyid, int hashalgo,
90                       const unsigned char *indata, size_t indatalen,
91                       char **r_buf, size_t *r_buflen);
92
93 /* Send a PKDECRYPT command to the SCdaemon. */
94 int agent_scd_pkdecrypt (const char *serialno,
95                          const unsigned char *indata, size_t indatalen,
96                          char **r_buf, size_t *r_buflen);
97
98 /* Change the PIN of an OpenPGP card or reset the retry counter. */
99 int agent_scd_change_pin (int chvno, const char *serialno);
100
101 /* Send the CHECKPIN command to the SCdaemon. */
102 int agent_scd_checkpin  (const char *serialno);
103
104 /* Dummy function, only implemented by gpg 1.4. */
105 void agent_clear_pin_cache (const char *sn);
106
107
108 #endif /*GNUPG_G10_CALL_AGENT_H*/
109