trunk/Include/wptKeyCache.h

/* wptKeyCache.h
 *      Copyright (C) 2005, 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
 */
#ifndef WPT_KEYCACHE_H
#define WPT_KEYCACHE_H

#include <gpgme.h>

struct gpg_desig_rev_s;
typedef struct gpg_desig_rev_s *gpg_desig_rev_t;

/* key cache specific update flags. */
enum keycache_flag_t {
    KC_FLAG_ADD = 1,
    KC_FLAG_UPD = 2
};

/* key specifc attributes. */
enum keycache_attr_t {
    KC_ATTR_PREFSYM     = 11,
    KC_ATTR_PREFKSERV   = 24
};


/* contains the UTF8 decoded user id. */
struct native_uid_s {
    struct native_uid_s *next;
    unsigned int malloced:1;        /* 1 if the follow parts are actually
                                       malloced or just referenced pointer. */
    unsigned int revoked : 1;
    gpgme_validity_t validity;

    gpgme_key_sig_t signatures;

    char *uid;
    char *name;
    char *comment;
    char *email;
};


struct keycache_s {
    struct keycache_s *next;
    int flags;
    gpgme_key_t key;                    /* actual key context. */
    unsigned int default_key:1;         /* default signing key. */
    struct keycache_s *pubpart;         /* corresponding public key. */
    struct {
        unsigned int is_protected:1;    /* key is protected. */
        unsigned int divert_to_card:1;  /* secret key on card. */
        unsigned int has_desig_rev:1;   /* has desig. revokers. */
    } gloflags;
    struct {
        unsigned int   flags;
        unsigned char *d;           /* attribute (JPG) data. */
        unsigned int   len;         /* attribute data length. */
        gpgme_validity_t validity;  /* attribute id validity. */
    } attrib;
    unsigned char *sym_prefs;/* symmetric cipher preferences. */
    char *pref_keyserver;   /* if != NULL preferred keyserver. */
    char *card_type;        /* if != NULL key stored on smart card. */
    struct native_uid_s *uids;
    gpg_desig_rev_t rev;        /* if != NULL list of desig revokers. */
};

struct gpg_keycache_s {    
    struct keycache_s *item;
    struct keycache_s *tmp;
    int secret;
    int pos;
    void (*cb) (void*, const char*, int, int, int);
    void *cb_value;
    int cb_value2;
};
typedef struct gpg_keycache_s *gpg_keycache_t;

gpgme_error_t gpg_keycache_new (gpg_keycache_t * r_ctx);
void gpg_keycache_release (gpg_keycache_t ctx);
void gpg_keycache_set_cb (gpg_keycache_t ctx,
                            void (*cb)(void *, const char *, int, int, int),
                            void* cb_value1, int cb_value2);
void gpg_keycache_rewind (gpg_keycache_t ctx);
int gpg_keycache_get_size (gpg_keycache_t ctx);
gpgme_error_t gpg_keycache_add_key (gpg_keycache_t ctx, gpgme_key_t key, 
                                      void **opaque);
gpgme_error_t gpg_keycache_update_key (gpg_keycache_t ctx, int is_sec, 
                                         void *opaque, const char *keyid);
gpgme_error_t gpg_keycache_find_key (gpg_keycache_t ctx, const char *pattern,
                                       int flags, gpgme_key_t * r_key);
gpgme_error_t gpg_keycache_find_key2 (gpg_keycache_t ctx, 
                                      const char *pattern, int flags,
                                        gpgme_key_t *r_key, 
                                        struct keycache_s **r_item);
gpgme_error_t gpg_keycache_delete_key (gpg_keycache_t ctx, 
                                         const char * pattern);
gpgme_error_t gpg_keycache_init (gpg_keycache_t ctx, const char * pattern, 
                                   int secret);
gpgme_error_t gpg_keycache_next_key (gpg_keycache_t ctx, int flags,
                                       gpgme_key_t * r_key);
gpgme_error_t gpg_keycache_next_key2 (gpg_keycache_t ctx, int flags, 
                                     struct keycache_s **c, gpgme_key_t *r_key);
gpgme_error_t gpg_keycache_prepare (gpg_keycache_t ctx, 
                                      const char *pubring, 
                                      const char *secring);
gpgme_error_t gpg_keycache_prepare_single (gpg_keycache_t ctx, 
                                             const char *keyid,
                                             const char *pubr, 
                                             const char *secr);
gpgme_error_t gpg_keycache_sync (gpg_keycache_t pub, gpg_keycache_t sec);
gpgme_error_t gpg_keycache_next_updated_key (gpg_keycache_t ctx,
                                             struct keycache_s **r_obj,
                                             int *r_status);
gpgme_error_t gpg_keycache_set_default_key (gpg_keycache_t ctx, 
                                            const char *pattern);
gpgme_error_t gpg_keycache_get_default_key (gpg_keycache_t ctx,
                                            gpgme_key_t *r_key);
gpgme_error_t gpg_keycache_update_attr (struct keycache_s *item,
                                        int attr, int force);

#endif /*WPT_KEYCACHE_H*/
1	twoaday	38	/* wptKeyCache.h
2	twoaday	146	* Copyright (C) 2005, 2006 Timo Schulz
3	twoaday	38	*
4			* This file is part of WinPT.
5			*
6			* WinPT 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			* 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
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 WinPT; if not, write to the Free Software Foundation,
18			* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19			*/
20			#ifndef WPT_KEYCACHE_H
21			#define WPT_KEYCACHE_H
22
23	twoaday	205	#include <gpgme.h>
24
25	twoaday	208	struct gpg_desig_rev_s;
26			typedef struct gpg_desig_rev_s *gpg_desig_rev_t;
27
28	twoaday	205	/* key cache specific update flags. */
29	twoaday	151	enum keycache_flag_t {
30			KC_FLAG_ADD = 1,
31			KC_FLAG_UPD = 2
32			};
33
34	twoaday	182	/* key specifc attributes. */
35			enum keycache_attr_t {
36			KC_ATTR_PREFSYM = 11,
37			KC_ATTR_PREFKSERV = 24
38			};
39
40
41	twoaday	205	/* contains the UTF8 decoded user id. */
42			struct native_uid_s {
43			struct native_uid_s *next;
44			unsigned int malloced:1; /* 1 if the follow parts are actually
45			malloced or just referenced pointer. */
46			unsigned int revoked : 1;
47			gpgme_validity_t validity;
48
49	twoaday	208	gpgme_key_sig_t signatures;
50
51	twoaday	205	char *uid;
52			char *name;
53			char *comment;
54			char *email;
55			};
56
57
58	twoaday	38	struct keycache_s {
59	twoaday	167	struct keycache_s *next;
60	twoaday	38	int flags;
61			gpgme_key_t key; /* actual key context. */
62	twoaday	167	unsigned int default_key:1; /* default signing key. */
63	twoaday	38	struct keycache_s pubpart; / corresponding public key. */
64			struct {
65			unsigned int is_protected:1; /* key is protected. */
66			unsigned int divert_to_card:1; /* secret key on card. */
67			unsigned int has_desig_rev:1; /* has desig. revokers. */
68			} gloflags;
69			struct {
70	twoaday	133	unsigned int flags;
71	twoaday	38	unsigned char d; / attribute (JPG) data. */
72			unsigned int len; /* attribute data length. */
73			gpgme_validity_t validity; /* attribute id validity. */
74			} attrib;
75			unsigned char sym_prefs;/ symmetric cipher preferences. */
76	twoaday	182	char pref_keyserver; / if != NULL preferred keyserver. */
77	twoaday	38	char card_type; / if != NULL key stored on smart card. */
78	twoaday	205	struct native_uid_s *uids;
79	twoaday	208	gpg_desig_rev_t rev; /* if != NULL list of desig revokers. */
80	twoaday	38	};
81
82			struct gpg_keycache_s {
83			struct keycache_s *item;
84			struct keycache_s *tmp;
85			int secret;
86			int pos;
87	twoaday	167	void (cb) (void, const char*, int, int, int);
88	twoaday	38	void *cb_value;
89			int cb_value2;
90			};
91			typedef struct gpg_keycache_s *gpg_keycache_t;
92
93			gpgme_error_t gpg_keycache_new (gpg_keycache_t * r_ctx);
94			void gpg_keycache_release (gpg_keycache_t ctx);
95			void gpg_keycache_set_cb (gpg_keycache_t ctx,
96			void (cb)(void , const char *, int, int, int),
97	twoaday	167	void* cb_value1, int cb_value2);
98	twoaday	38	void gpg_keycache_rewind (gpg_keycache_t ctx);
99			int gpg_keycache_get_size (gpg_keycache_t ctx);
100			gpgme_error_t gpg_keycache_add_key (gpg_keycache_t ctx, gpgme_key_t key,
101			void **opaque);
102			gpgme_error_t gpg_keycache_update_key (gpg_keycache_t ctx, int is_sec,
103			void opaque, const char keyid);
104	twoaday	167	gpgme_error_t gpg_keycache_find_key (gpg_keycache_t ctx, const char *pattern,
105	twoaday	38	int flags, gpgme_key_t * r_key);
106	twoaday	167	gpgme_error_t gpg_keycache_find_key2 (gpg_keycache_t ctx,
107			const char *pattern, int flags,
108			gpgme_key_t *r_key,
109			struct keycache_s **r_item);
110	twoaday	38	gpgme_error_t gpg_keycache_delete_key (gpg_keycache_t ctx,
111			const char * pattern);
112			gpgme_error_t gpg_keycache_init (gpg_keycache_t ctx, const char * pattern,
113			int secret);
114			gpgme_error_t gpg_keycache_next_key (gpg_keycache_t ctx, int flags,
115			gpgme_key_t * r_key);
116	twoaday	205	gpgme_error_t gpg_keycache_next_key2 (gpg_keycache_t ctx, int flags,
117			struct keycache_s *c, gpgme_key_t r_key);
118	twoaday	38	gpgme_error_t gpg_keycache_prepare (gpg_keycache_t ctx,
119	twoaday	167	const char *pubring,
120			const char *secring);
121	twoaday	38	gpgme_error_t gpg_keycache_prepare_single (gpg_keycache_t ctx,
122			const char *keyid,
123			const char *pubr,
124			const char *secr);
125			gpgme_error_t gpg_keycache_sync (gpg_keycache_t pub, gpg_keycache_t sec);
126	twoaday	146	gpgme_error_t gpg_keycache_next_updated_key (gpg_keycache_t ctx,
127	twoaday	151	struct keycache_s **r_obj,
128			int *r_status);
129	twoaday	167	gpgme_error_t gpg_keycache_set_default_key (gpg_keycache_t ctx,
130			const char *pattern);
131			gpgme_error_t gpg_keycache_get_default_key (gpg_keycache_t ctx,
132			gpgme_key_t *r_key);
133	twoaday	182	gpgme_error_t gpg_keycache_update_attr (struct keycache_s *item,
134			int attr, int force);
135	twoaday	38
136			#endif /WPT_KEYCACHE_H/