trunk/Src/wptGPGME.cpp

/* wptGPGME.cpp - WinPT GPGME interface
 *      Copyright (C) 2001-2006 Timo Schulz
 *
 * This file is part of WinPT.
 *
 * WinPT 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.
 *  
 * WinPT 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 WinPT; if not, write to the Free Software Foundation, 
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <sys/types.h>
#include <windows.h>

#include "resource.h"
#include "wptNLS.h"
#include "wptGPG.h"
#include "wptErrors.h"
#include "wptTypes.h"
#include "wptW32API.h"
#include "wptVersion.h"
#include "wptCommonCtl.h"
#include "wptContext.h"
#include "wptRegistry.h"
#include "wptDlgs.h"

#include "openpgp.h"

BOOL CALLBACK  keycache_dlg_proc (HWND dlg, UINT msg, WPARAM wparam, LPARAM lparam);
void progress_cleanup (progress_filter_s * pfx);

/* Global GPG key cache contexts. */
static gpg_keycache_t pub = NULL;
static gpg_keycache_t sec = NULL;
static char *gpg_secring = NULL;


int
keycache_not_available (void)
{
    return pub == NULL;
}

/* Release both key cache objects. If @cleanup is 1,
   also release other global structs. */
void
keycache_release (int cleanup)
{
    int n = gpg_keycache_get_size (pub);
    char tmpbuf[64];

    /* XXX: update the value when the cache has changed. */
    sprintf (tmpbuf, "%d", n);
    set_reg_key (HKEY_CURRENT_USER, "Software\\WinPT", "nKeys", tmpbuf);

    if (pub) {
        gpg_keycache_release (pub); 
        pub = NULL;
    }
    if (sec) {
        gpg_keycache_release (sec);
        sec = NULL;
    }
    if (cleanup)
        safe_free (gpg_secring);
}


/* Update the key with the keyid @keyid in the key cache.
   If @is_sec is 1, the secret key cache is used. */
gpgme_error_t
keycache_update (int is_sec, const char *keyid)
{
    gpg_keycache_t ctx = pub;
    gpgme_error_t err;

    if (is_sec)
        ctx = sec;
    err = gpg_keycache_update_key (ctx, is_sec, pub, keyid);
    if (is_sec)
        gpg_keycache_prepare_single (ctx, keyid, NULL, gpg_secring);
    return err;
}


/* Initialize both cache contexts. Use @pubring for the public
   keyring and @secring for the secret keyring. */
gpgme_error_t
keycache_init (const char *pubring, const char *secring)
{
    struct progress_filter_s pfx;
    gpgme_error_t err;
    int val = 0;
    char *p;

    if (secring != NULL) {
        free_if_alloc (gpg_secring);
        gpg_secring = get_gnupg_keyring (0, NO_STRICT);
    }
    
    p = get_reg_entry (HKEY_CURRENT_USER, "Software\\WinPT", "nKeys");
    if (p && *p != ' ') {
        val = atoi (p);
        free_if_alloc (p);      
    }

    memset (&pfx, 0, sizeof (pfx));
    keycache_release (0); /* Release old contexts first. */

    err = gpg_keycache_new (&pub);
    if (err)
        return err;
    if (val != 0)
        gpg_keycache_set_cb (pub, progress_callback, &pfx, val);
    err = gpg_keycache_new (&sec);
    if (!err)
        err = gpg_keycache_init (pub, NULL, 0);
    if (!err)
        err = gpg_keycache_init (sec, NULL, 1);
    if (!err && pubring && *pubring)
        err = gpg_keycache_prepare (pub, pubring, NULL);
    if (!err && secring && * secring)
        err = gpg_keycache_prepare (sec, NULL, secring);
    if (!err)
        gpg_keycache_sync (pub, sec);
    if (val != 0)
        progress_cleanup (&pfx);
    return err;
}


/* Return the public cache context if @is_pub is set
   the secre cache context otherwise. */
gpg_keycache_t
keycache_get_ctx (int is_pub)
{
    gpg_keycache_t ctx;

    ctx = is_pub? pub : sec;
    if (!ctx)
        BUG (0);
    return ctx;
}


/* Get the GPG key with keyid @keyid from the cache. Return it 
   in @r_key on success. */
static gpgme_error_t
get_key_from_cache (const char *keyid, int secret, gpgme_key_t *r_key, 
                    struct keycache_s **c)
{
    gpg_keycache_t cache;
    gpgme_error_t err;
    int mode = secret? KEYCACHE_PRV : KEYCACHE_PUB;

    if (!keyid)
        return gpg_error (GPG_ERR_INV_VALUE);
    if (r_key)
        *r_key = NULL;
    cache = keycache_get_ctx (mode);
    if (!c)
        err = gpg_keycache_find_key (cache, keyid, 0, r_key);
    else
        err = gpg_keycache_find_key2 (cache, keyid, 0, r_key, c);
    return err;
}


/* Release the internal key structure.
   If allocated is 0, assume fixed cache item. */
void
winpt_release_pubkey (winpt_key_s *k)
{
    /*log_box ("debug", 0, "alloc %d", k->allocated);*/
    if (!k->allocated)
        return;
    gpg_keycache_item_release (k->ext);
    k->ext = NULL;
    k->allocated = 0;
}


/* Search the public key with @keyid as the keyid in the cache and
   return the item in @k. */
gpgme_error_t
winpt_get_pubkey (const char *keyid, winpt_key_s *k)
{
    gpgme_error_t err = gpg_error (GPG_ERR_NO_ERROR);
    
    if (pub)
        err = get_key_from_cache (keyid, 0, &k->ctx, &k->ext);
    else
        err = gpg_keycache_fetch_key (keyid, 0, &k->ctx, &k->ext);
    if (err)
        return err;
    k->is_v3 = k->ctx->subkeys->pubkey_algo == GPGME_PK_RSA && 
                strlen (k->ctx->subkeys->fpr) == 32;
    k->is_protected = k->ext->gloflags.is_protected;
    k->keyid = k->ctx->subkeys->keyid+8;
    k->uid = k->ext->uids->uid;
    k->allocated = pub? 0 : 1;
    return 0;
}


gpgme_error_t
winpt_get_seckey (const char *keyid, winpt_key_s *k)
{
    gpgme_error_t err;

    if (sec)
        err = get_key_from_cache (keyid, 1, &k->ctx, &k->ext);
    else
        err = gpg_keycache_fetch_key (keyid, 1, &k->ctx, &k->ext);
    if (err)
        return err;
    k->is_v3 = k->ctx->subkeys->pubkey_algo == GPGME_PK_RSA && 
                strlen (k->ctx->subkeys->fpr) == 32;
    k->is_protected = k->ext->gloflags.is_protected;
    k->keyid = k->ctx->subkeys->keyid+8;
    k->uid = k->ext->uids->uid;
    k->allocated = sec? 0 : 1;
    return 0;
}


gpgme_error_t
get_pubkey (const char *keyid, gpgme_key_t *ret_key)
{
    return get_key_from_cache (keyid, 0, ret_key, NULL);
}


gpgme_error_t
get_seckey (const char *keyid, gpgme_key_t *ret_skey)
{
    return get_key_from_cache (keyid, 1, ret_skey, NULL);
}


/* Map the signature summary in @sum to signature status table index. 
   Return value: index to table. */
static int
sigsum_to_index (gpgme_sigsum_t sum)
{
    if ((sum & GPGME_SIGSUM_VALID) && (sum & GPGME_SIGSUM_KEY_REVOKED))
        return 7;
    if ((sum & GPGME_SIGSUM_VALID) && (sum & GPGME_SIGSUM_SIG_EXPIRED))
        return 6;
    if (sum & GPGME_SIGSUM_GREEN)
        return 1;
    else if (sum & GPGME_SIGSUM_RED)
        return 2;
    else if (sum & GPGME_SIGSUM_KEY_MISSING)
        return 3;
    return 0;
}


/* Return a humand readable description for the signature status @sum. */
const char*
get_gpg_sigstat (gpgme_sigsum_t sum)
{
    const char *gpg_sigstat[] = {
        _("Error during verification process."),
        _("The signature is good."),
        _("The signature is BAD!"),
        _("The signature could not be checked due to a missing key."),
        _("No valid OpenPGP signature."),
        _("Signature Error"),
        _("Good Signature (Expired Key)"),
        _("Good Signature (Revoked Key)"),
        NULL
    };
    const unsigned int mask = 8;

    return gpg_sigstat[sigsum_to_index (sum) % mask];
}


bool
secret_key_available (void)
{
    if (!sec || gpg_keycache_get_size (sec) == 0)
        return false;
    return true;
}
1	/* wptGPGME.cpp - WinPT GPGME interface
2	* Copyright (C) 2001-2006 Timo Schulz
3	*
4	* This file is part of WinPT.
5	*
6	* WinPT is free software; you can redistribute it and/or
7	* modify it under the terms of the GNU General Public License
8	* as published by the Free Software Foundation; either version 2
9	* of the License, or (at your option) any later version.
10	*
11	* WinPT 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 GNU
14	* General Public License for more details.
15	*
16	* You should have received a copy of the GNU General Public License
17	* along with WinPT; if not, write to the Free Software Foundation,
18	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19	*/
20	#ifdef HAVE_CONFIG_H
21	#include <config.h>
22	#endif
23
24	#include <sys/types.h>
25	#include <windows.h>
26
27	#include "resource.h"
28	#include "wptNLS.h"
29	#include "wptGPG.h"
30	#include "wptErrors.h"
31	#include "wptTypes.h"
32	#include "wptW32API.h"
33	#include "wptVersion.h"
34	#include "wptCommonCtl.h"
35	#include "wptContext.h"
36	#include "wptRegistry.h"
37	#include "wptDlgs.h"
38
39	#include "openpgp.h"
40
41	BOOL CALLBACK keycache_dlg_proc (HWND dlg, UINT msg, WPARAM wparam, LPARAM lparam);
42	void progress_cleanup (progress_filter_s * pfx);
43
44	/* Global GPG key cache contexts. */
45	static gpg_keycache_t pub = NULL;
46	static gpg_keycache_t sec = NULL;
47	static char *gpg_secring = NULL;
48
49
50	int
51	keycache_not_available (void)
52	{
53	return pub == NULL;
54	}
55
56	/* Release both key cache objects. If @cleanup is 1,
57	also release other global structs. */
58	void
59	keycache_release (int cleanup)
60	{
61	int n = gpg_keycache_get_size (pub);
62	char tmpbuf[64];
63
64	/* XXX: update the value when the cache has changed. */
65	sprintf (tmpbuf, "%d", n);
66	set_reg_key (HKEY_CURRENT_USER, "Software\\WinPT", "nKeys", tmpbuf);
67
68	if (pub) {
69	gpg_keycache_release (pub);
70	pub = NULL;
71	}
72	if (sec) {
73	gpg_keycache_release (sec);
74	sec = NULL;
75	}
76	if (cleanup)
77	safe_free (gpg_secring);
78	}
79
80
81	/* Update the key with the keyid @keyid in the key cache.
82	If @is_sec is 1, the secret key cache is used. */
83	gpgme_error_t
84	keycache_update (int is_sec, const char *keyid)
85	{
86	gpg_keycache_t ctx = pub;
87	gpgme_error_t err;
88
89	if (is_sec)
90	ctx = sec;
91	err = gpg_keycache_update_key (ctx, is_sec, pub, keyid);
92	if (is_sec)
93	gpg_keycache_prepare_single (ctx, keyid, NULL, gpg_secring);
94	return err;
95	}
96
97
98	/* Initialize both cache contexts. Use @pubring for the public
99	keyring and @secring for the secret keyring. */
100	gpgme_error_t
101	keycache_init (const char pubring, const char secring)
102	{
103	struct progress_filter_s pfx;
104	gpgme_error_t err;
105	int val = 0;
106	char *p;
107
108	if (secring != NULL) {
109	free_if_alloc (gpg_secring);
110	gpg_secring = get_gnupg_keyring (0, NO_STRICT);
111	}
112
113	p = get_reg_entry (HKEY_CURRENT_USER, "Software\\WinPT", "nKeys");
114	if (p && *p != ' ') {
115	val = atoi (p);
116	free_if_alloc (p);
117	}
118
119	memset (&pfx, 0, sizeof (pfx));
120	keycache_release (0); /* Release old contexts first. */
121
122	err = gpg_keycache_new (&pub);
123	if (err)
124	return err;
125	if (val != 0)
126	gpg_keycache_set_cb (pub, progress_callback, &pfx, val);
127	err = gpg_keycache_new (&sec);
128	if (!err)
129	err = gpg_keycache_init (pub, NULL, 0);
130	if (!err)
131	err = gpg_keycache_init (sec, NULL, 1);
132	if (!err && pubring && *pubring)
133	err = gpg_keycache_prepare (pub, pubring, NULL);
134	if (!err && secring && * secring)
135	err = gpg_keycache_prepare (sec, NULL, secring);
136	if (!err)
137	gpg_keycache_sync (pub, sec);
138	if (val != 0)
139	progress_cleanup (&pfx);
140	return err;
141	}
142
143
144	/* Return the public cache context if @is_pub is set
145	the secre cache context otherwise. */
146	gpg_keycache_t
147	keycache_get_ctx (int is_pub)
148	{
149	gpg_keycache_t ctx;
150
151	ctx = is_pub? pub : sec;
152	if (!ctx)
153	BUG (0);
154	return ctx;
155	}
156
157
158	/* Get the GPG key with keyid @keyid from the cache. Return it
159	in @r_key on success. */
160	static gpgme_error_t
161	get_key_from_cache (const char keyid, int secret, gpgme_key_t r_key,
162	struct keycache_s **c)
163	{
164	gpg_keycache_t cache;
165	gpgme_error_t err;
166	int mode = secret? KEYCACHE_PRV : KEYCACHE_PUB;
167
168	if (!keyid)
169	return gpg_error (GPG_ERR_INV_VALUE);
170	if (r_key)
171	*r_key = NULL;
172	cache = keycache_get_ctx (mode);
173	if (!c)
174	err = gpg_keycache_find_key (cache, keyid, 0, r_key);
175	else
176	err = gpg_keycache_find_key2 (cache, keyid, 0, r_key, c);
177	return err;
178	}
179
180
181	/* Release the internal key structure.
182	If allocated is 0, assume fixed cache item. */
183	void
184	winpt_release_pubkey (winpt_key_s *k)
185	{
186	/log_box ("debug", 0, "alloc %d", k->allocated);/
187	if (!k->allocated)
188	return;
189	gpg_keycache_item_release (k->ext);
190	k->ext = NULL;
191	k->allocated = 0;
192	}
193
194
195	/* Search the public key with @keyid as the keyid in the cache and
196	return the item in @k. */
197	gpgme_error_t
198	winpt_get_pubkey (const char keyid, winpt_key_s k)
199	{
200	gpgme_error_t err = gpg_error (GPG_ERR_NO_ERROR);
201
202	if (pub)
203	err = get_key_from_cache (keyid, 0, &k->ctx, &k->ext);
204	else
205	err = gpg_keycache_fetch_key (keyid, 0, &k->ctx, &k->ext);
206	if (err)
207	return err;
208	k->is_v3 = k->ctx->subkeys->pubkey_algo == GPGME_PK_RSA &&
209	strlen (k->ctx->subkeys->fpr) == 32;
210	k->is_protected = k->ext->gloflags.is_protected;
211	k->keyid = k->ctx->subkeys->keyid+8;
212	k->uid = k->ext->uids->uid;
213	k->allocated = pub? 0 : 1;
214	return 0;
215	}
216
217
218	gpgme_error_t
219	winpt_get_seckey (const char keyid, winpt_key_s k)
220	{
221	gpgme_error_t err;
222
223	if (sec)
224	err = get_key_from_cache (keyid, 1, &k->ctx, &k->ext);
225	else
226	err = gpg_keycache_fetch_key (keyid, 1, &k->ctx, &k->ext);
227	if (err)
228	return err;
229	k->is_v3 = k->ctx->subkeys->pubkey_algo == GPGME_PK_RSA &&
230	strlen (k->ctx->subkeys->fpr) == 32;
231	k->is_protected = k->ext->gloflags.is_protected;
232	k->keyid = k->ctx->subkeys->keyid+8;
233	k->uid = k->ext->uids->uid;
234	k->allocated = sec? 0 : 1;
235	return 0;
236	}
237
238
239	gpgme_error_t
240	get_pubkey (const char keyid, gpgme_key_t ret_key)
241	{
242	return get_key_from_cache (keyid, 0, ret_key, NULL);
243	}
244
245
246	gpgme_error_t
247	get_seckey (const char keyid, gpgme_key_t ret_skey)
248	{
249	return get_key_from_cache (keyid, 1, ret_skey, NULL);
250	}
251
252
253
254	/* Map the signature summary in @sum to signature status table index.
255	Return value: index to table. */
256	static int
257	sigsum_to_index (gpgme_sigsum_t sum)
258	{
259	if ((sum & GPGME_SIGSUM_VALID) && (sum & GPGME_SIGSUM_KEY_REVOKED))
260	return 7;
261	if ((sum & GPGME_SIGSUM_VALID) && (sum & GPGME_SIGSUM_SIG_EXPIRED))
262	return 6;
263	if (sum & GPGME_SIGSUM_GREEN)
264	return 1;
265	else if (sum & GPGME_SIGSUM_RED)
266	return 2;
267	else if (sum & GPGME_SIGSUM_KEY_MISSING)
268	return 3;
269	return 0;
270	}
271
272
273	/* Return a humand readable description for the signature status @sum. */
274	const char*
275	get_gpg_sigstat (gpgme_sigsum_t sum)
276	{
277	const char *gpg_sigstat[] = {
278	_("Error during verification process."),
279	_("The signature is good."),
280	_("The signature is BAD!"),
281	_("The signature could not be checked due to a missing key."),
282	_("No valid OpenPGP signature."),
283	_("Signature Error"),
284	_("Good Signature (Expired Key)"),
285	_("Good Signature (Revoked Key)"),
286	NULL
287	};
288	const unsigned int mask = 8;
289
290	return gpg_sigstat[sigsum_to_index (sum) % mask];
291	}
292
293
294	bool
295	secret_key_available (void)
296	{
297	if (!sec \|\| gpg_keycache_get_size (sec) == 0)
298	return false;
299	return true;
300	}