1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* Authors: Jeffrey Stedfast <fejj@ximian.com>
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This program 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 Lesser General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef CAMEL_CIPHER_CONTEXT_H
#define CAMEL_CIPHER_CONTEXT_H
#include <camel/camel-list-utils.h>
#include <camel/camel-session.h>
#include <camel/camel-exception.h>
#define CAMEL_CIPHER_CONTEXT_TYPE (camel_cipher_context_get_type ())
#define CAMEL_CIPHER_CONTEXT(obj) (CAMEL_CHECK_CAST((obj), CAMEL_CIPHER_CONTEXT_TYPE, CamelCipherContext))
#define CAMEL_CIPHER_CONTEXT_CLASS(k) (CAMEL_CHECK_CLASS_CAST ((k), CAMEL_CIPHER_CONTEXT_TYPE, CamelCipherContextClass))
#define CAMEL_IS_CIPHER_CONTEXT(o) (CAMEL_CHECK_TYPE((o), CAMEL_CIPHER_CONTEXT_TYPE))
G_BEGIN_DECLS
struct _CamelStream;
struct _CamelMimePart;
typedef struct _CamelCipherValidity CamelCipherValidity;
typedef struct _CamelCipherCertInfo CamelCipherCertInfo;
typedef enum {
CAMEL_CIPHER_HASH_DEFAULT,
CAMEL_CIPHER_HASH_MD2,
CAMEL_CIPHER_HASH_MD5,
CAMEL_CIPHER_HASH_SHA1,
CAMEL_CIPHER_HASH_RIPEMD160,
CAMEL_CIPHER_HASH_TIGER192,
CAMEL_CIPHER_HASH_HAVAL5160
} CamelCipherHash;
typedef enum _camel_cipher_validity_sign_t {
CAMEL_CIPHER_VALIDITY_SIGN_NONE,
CAMEL_CIPHER_VALIDITY_SIGN_GOOD,
CAMEL_CIPHER_VALIDITY_SIGN_BAD,
CAMEL_CIPHER_VALIDITY_SIGN_UNKNOWN,
CAMEL_CIPHER_VALIDITY_SIGN_NEED_PUBLIC_KEY
} camel_cipher_validity_sign_t;
typedef enum _camel_cipher_validity_encrypt_t {
CAMEL_CIPHER_VALIDITY_ENCRYPT_NONE,
CAMEL_CIPHER_VALIDITY_ENCRYPT_WEAK,
CAMEL_CIPHER_VALIDITY_ENCRYPT_ENCRYPTED, /* encrypted, unknown strenght */
CAMEL_CIPHER_VALIDITY_ENCRYPT_STRONG
} camel_cipher_validity_encrypt_t;
typedef enum _camel_cipher_validity_mode_t {
CAMEL_CIPHER_VALIDITY_SIGN,
CAMEL_CIPHER_VALIDITY_ENCRYPT
} camel_cipher_validity_mode_t;
struct _CamelCipherCertInfo {
struct _CamelCipherCertInfo *next;
struct _CamelCipherCertInfo *prev;
gchar *name; /* common name */
gchar *email;
gpointer cert_data; /* custom certificate data; can be NULL */
void (*cert_data_free) (gpointer cert_data); /* called to free cert_data; can be NULL only if cert_data is NULL */
gpointer (*cert_data_clone) (gpointer cert_data); /* called to clone cert_data; can be NULL only if cert_data is NULL */
};
struct _CamelCipherValidity {
struct _CamelCipherValidity *next;
struct _CamelCipherValidity *prev;
CamelDList children;
struct {
enum _camel_cipher_validity_sign_t status;
gchar *description;
CamelDList signers; /* CamelCipherCertInfo's */
} sign;
struct {
enum _camel_cipher_validity_encrypt_t status;
gchar *description;
CamelDList encrypters; /* CamelCipherCertInfo's */
} encrypt;
};
typedef struct _CamelCipherContext {
CamelObject parent_object;
struct _CamelCipherContextPrivate *priv;
CamelSession *session;
/* these MUST be set by implementors */
const gchar *sign_protocol;
const gchar *encrypt_protocol;
const gchar *key_protocol;
} CamelCipherContext;
typedef struct _CamelCipherContextClass {
CamelObjectClass parent_class;
CamelCipherHash (*id_to_hash)(CamelCipherContext *context, const gchar *id);
const gchar * (*hash_to_id)(CamelCipherContext *context, CamelCipherHash hash);
gint (*sign) (CamelCipherContext *context, const gchar *userid, CamelCipherHash hash,
struct _CamelMimePart *ipart, struct _CamelMimePart *opart, CamelException *ex);
CamelCipherValidity * (*verify) (CamelCipherContext *context, struct _CamelMimePart *ipart, CamelException *ex);
gint (*encrypt) (CamelCipherContext *context, const gchar *userid,
GPtrArray *recipients, struct _CamelMimePart *ipart, struct _CamelMimePart *opart,
CamelException *ex);
CamelCipherValidity *(*decrypt) (CamelCipherContext *context, struct _CamelMimePart *ipart, struct _CamelMimePart *opart,
CamelException *ex);
gint (*import_keys) (CamelCipherContext *context, struct _CamelStream *istream,
CamelException *ex);
gint (*export_keys) (CamelCipherContext *context, GPtrArray *keys,
struct _CamelStream *ostream, CamelException *ex);
} CamelCipherContextClass;
CamelType camel_cipher_context_get_type (void);
CamelCipherContext *camel_cipher_context_new (CamelSession *session);
void camel_cipher_context_construct (CamelCipherContext *context, CamelSession *session);
/* cipher context util routines */
CamelCipherHash camel_cipher_id_to_hash (CamelCipherContext *context, const gchar *id);
const gchar * camel_cipher_hash_to_id (CamelCipherContext *context, CamelCipherHash hash);
/* FIXME:
There are some inconsistencies here, the api's should probably handle CamelMimePart's as input/outputs,
Something that might generate a multipart/signed should do it as part of that processing, internally
to the cipher, etc etc. */
/* cipher routines */
gint camel_cipher_sign (CamelCipherContext *context, const gchar *userid, CamelCipherHash hash,
struct _CamelMimePart *ipart, struct _CamelMimePart *opart, CamelException *ex);
CamelCipherValidity *camel_cipher_verify (CamelCipherContext *context, struct _CamelMimePart *ipart, CamelException *ex);
gint camel_cipher_encrypt (CamelCipherContext *context, const gchar *userid,
GPtrArray *recipients, struct _CamelMimePart *ipart, struct _CamelMimePart *opart,
CamelException *ex);
CamelCipherValidity *camel_cipher_decrypt (CamelCipherContext *context, struct _CamelMimePart *ipart, struct _CamelMimePart *opart,
CamelException *ex);
/* key/certificate routines */
gint camel_cipher_import_keys (CamelCipherContext *context, struct _CamelStream *istream,
CamelException *ex);
gint camel_cipher_export_keys (CamelCipherContext *context, GPtrArray *keys,
struct _CamelStream *ostream, CamelException *ex);
/* CamelCipherValidity utility functions */
CamelCipherValidity *camel_cipher_validity_new (void);
void camel_cipher_validity_init (CamelCipherValidity *validity);
gboolean camel_cipher_validity_get_valid (CamelCipherValidity *validity);
void camel_cipher_validity_set_valid (CamelCipherValidity *validity, gboolean valid);
gchar *camel_cipher_validity_get_description (CamelCipherValidity *validity);
void camel_cipher_validity_set_description (CamelCipherValidity *validity, const gchar *description);
void camel_cipher_validity_clear (CamelCipherValidity *validity);
CamelCipherValidity *camel_cipher_validity_clone(CamelCipherValidity *vin);
void camel_cipher_validity_add_certinfo(CamelCipherValidity *vin, camel_cipher_validity_mode_t mode, const gchar *name, const gchar *email);
void camel_cipher_validity_add_certinfo_ex (
CamelCipherValidity *vin,
camel_cipher_validity_mode_t mode,
const gchar *name,
const gchar *email,
gpointer cert_data,
void (*cert_data_free) (gpointer cert_data),
gpointer (*cert_data_clone) (gpointer cert_data));
void camel_cipher_validity_envelope(CamelCipherValidity *parent, CamelCipherValidity *valid);
void camel_cipher_validity_free (CamelCipherValidity *validity);
/* utility functions */
gint camel_cipher_canonical_to_stream(CamelMimePart *part, guint32 flags, CamelStream *ostream);
G_END_DECLS
#endif /* CAMEL_CIPHER_CONTEXT_H */
|