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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
/*____________________________________________________________________________
Copyright (C) 2002 PGP Corporation
All rights reserved.
$Id: pgpKeyServer.h,v 1.20 2004/01/23 08:12:49 dallen Exp $
____________________________________________________________________________*/
#ifndef Included_pgpKeyServer_h
#define Included_pgpKeyServer_h
#include "pgpOptionList.h"
#include "pgpErrors.h"
#include "pgpGroups.h"
#include "pgpTLS.h"
enum PGPKeyServerState_
{
kPGPKeyServerState_Invalid = 0,
kPGPKeyServerState_Opening = 1,
kPGPKeyServerState_Querying = 2,
kPGPKeyServerState_ReceivingResults = 3,
kPGPKeyServerState_ProcessingResults = 4,
kPGPKeyServerState_Uploading = 5,
kPGPKeyServerState_Deleting = 6,
kPGPKeyServerState_Disabling = 7,
kPGPKeyServerState_Closing = 8,
kPGPKeyServerState_TLSUnableToSecureConnection = 9,
kPGPKeyServerState_TLSConnectionSecured = 10,
PGP_ENUM_FORCE(PGPKeyServerState_)
};
PGPENUM_TYPEDEF(PGPKeyServerState_, PGPKeyServerState);
enum PGPKeyServerProtocol_
{
kPGPKeyServerProtocol_Invalid = 0,
kPGPKeyServerProtocol_LDAP = 1,
kPGPKeyServerProtocol_HTTP = 2,
kPGPKeyServerProtocol_LDAPS = 3,
kPGPKeyServerProtocol_HTTPS = 4,
PGP_ENUM_FORCE( PGPKeyServerProtocol_ )
};
PGPENUM_TYPEDEF( PGPKeyServerProtocol_, PGPKeyServerProtocol );
enum PGPKeyServerClass_
{
kPGPKeyServerClass_Invalid = 0,
kPGPKeyServerClass_PGP = 1,
kPGPKeyServerClass_LDAPX509 = 2,
kPGPKeyServerClass_LDAPPGP = 3, /* deprecated, use kPGPKeyServerClass_PGP instead */
/* CA types */
kPGPKeyServerClass_NetToolsCA = 10,
kPGPKeyServerClass_Verisign = 11,
kPGPKeyServerClass_Entrust = 12,
kPGPKeyServerClass_Netscape = 13,
kPGPKeyServerClass_Microsoft = 14,
PGP_ENUM_FORCE( PGPKeyServerClass_ )
};
PGPENUM_TYPEDEF( PGPKeyServerClass_, PGPKeyServerClass );
enum PGPKeyServerKeySpace_ /* These are only valid for LDAP keyservers */
{
kPGPKeyServerKeySpace_Invalid = 0,
kPGPKeyServerKeySpace_Default = 1,
kPGPKeyServerKeySpace_Normal = 2,
kPGPKeyServerKeySpace_Pending = 3,
PGP_ENUM_FORCE( PGPKeyServerKeySpace_ )
};
PGPENUM_TYPEDEF( PGPKeyServerKeySpace_, PGPKeyServerKeySpace );
enum PGPKeyServerAccessType_ /* These are only valid for LDAP keyservers */
{
kPGPKeyServerAccessType_Invalid = 0,
kPGPKeyServerAccessType_Default = 1,
kPGPKeyServerAccessType_Normal = 2,
kPGPKeyServerAccessType_Administrator = 3,
PGP_ENUM_FORCE( PGPKeyServerAccessType_ )
};
PGPENUM_TYPEDEF( PGPKeyServerAccessType_, PGPKeyServerAccessType );
enum PGPProxyServerType_
{
kPGPProxyServerType_Invalid = 0,
kPGPProxyServerType_HTTP = 1,
kPGPProxyServerType_HTTPS = 2,
PGP_ENUM_FORCE(PGPProxyServerType_)
};
PGPENUM_TYPEDEF(PGPProxyServerType_, PGPProxyServerType);
/* PGPKeyServerMonitorValues are null terminated linked lists.
The values member is a null terminated array of char*s.
*/
typedef struct PGPKeyServerMonitorValues
{
PGPChar8 * name;
PGPChar8 ** values;
struct PGPKeyServerMonitorValues * next;
} PGPKeyServerMonitorValues;
typedef struct PGPKeyServerMonitor
{
PGPKeyServerRef keyServerRef;
PGPKeyServerMonitorValues * valuesHead;
} PGPKeyServerMonitor;
typedef struct PGPKeyServerThreadStorage * PGPKeyServerThreadStorageRef;
# define kInvalidPGPKeyServerThreadStorageRef \
((PGPKeyServerThreadStorageRef) NULL)
#define PGPKeyServerThreadStorageRefIsValid(ref) \
((ref) != kInvalidPGPKeyServerThreadStorageRef)
PGP_BEGIN_C_DECLARATIONS
/* Use the idle event handler to receive periodic idle events during
network calls. Usually this is used only in non-preemptive multi-tasking
OSes to allow yielding in threads. Pre-emptive multi-tasking systems
should probably not use the call as it interrupts the efficient wait state
of threads waiting on network calls.
Idle event handlers need to be added on a per thread basis.
Returning an error from the idle event handler will cause the keyserver
to quit processing and to return a kPGPError_UserAbort. */
PGPError PGPSetKeyServerIdleEventHandler(
PGPEventHandlerProcPtr inCallback,
PGPUserValue inUserData);
PGPError PGPGetKeyServerIdleEventHandler(
PGPEventHandlerProcPtr * outCallback,
PGPUserValue * outUserData);
/* Network library options */
#undef PGPONetURL
PGPOptionListRef PGPONetURL(PGPContextRef context, const PGPChar8 *url);
#undef PGPONetHostName
PGPOptionListRef PGPONetHostName(PGPContextRef context,
const PGPChar8 *hostName, PGPUInt16 port);
PGPOptionListRef PGPONetHostAddress(PGPContextRef context,
PGPUInt32 hostAddress, PGPUInt16 port);
PGPOptionListRef PGPONetConnectTimeout(PGPContextRef context,
PGPUInt32 timeout);
PGPOptionListRef PGPONetReadTimeout(PGPContextRef context,
PGPUInt32 timeout);
PGPOptionListRef PGPONetWriteTimeout(PGPContextRef context,
PGPUInt32 timeout);
PGPOptionListRef PGPOKeyServerProtocol(PGPContextRef context,
PGPKeyServerProtocol serverProtocol);
PGPOptionListRef PGPOKeyServerKeySpace(PGPContextRef context,
PGPKeyServerKeySpace serverSpace);
#undef PGPOKeyServerKeyStoreDN
PGPOptionListRef PGPOKeyServerKeyStoreDN(PGPContextRef context,
const PGPChar8 *szKeyStoreDn);
PGPOptionListRef PGPOKeyServerAccessType(PGPContextRef context,
PGPKeyServerAccessType accessType);
PGPOptionListRef PGPOKeyServerCAKey(PGPContextRef context,
PGPKeyDBObjRef caKeyDBObjRef);
PGPOptionListRef PGPOKeyServerRequestKey(PGPContextRef context,
PGPKeyDBObjRef requestKeyDBObjRef);
PGPOptionListRef PGPOKeyServerSearchKey(PGPContextRef context,
PGPKeyDBObjRef searchKeyDBObjRef);
PGPOptionListRef PGPOKeyServerSearchFilter(PGPContextRef context,
PGPFilterRef searchFilter);
/* Static storage creation */
PGPError PGPKeyServerCreateThreadStorage(
PGPKeyServerThreadStorageRef * outPreviousStorage);
PGPError PGPKeyServerDisposeThreadStorage(
PGPKeyServerThreadStorageRef inPreviousStorage);
/* Initialize and close the keyserver library */
PGPError PGPKeyServerInit(void);
PGPError PGPKeyServerCleanup(void);
/* Creating and freeing a keyserver ref. */
PGPError PGPNewKeyServer(
PGPContextRef inContext,
PGPKeyServerClass inClass,
PGPKeyServerRef *outKeyServerRef,
PGPOptionListRef firstOption,
... );
PGPError PGPFreeKeyServer(PGPKeyServerRef inKeyServerRef);
PGPError PGPIncKeyServerRefCount(PGPKeyServerRef inKeyServerRef);
/* Set and get the keyserver's event handler. Note that returning an error
for a keyserver event will abort the current call. */
PGPError PGPSetKeyServerEventHandler(
PGPKeyServerRef inKeyServerRef,
PGPEventHandlerProcPtr inCallback,
PGPUserValue inUserData);
PGPError PGPGetKeyServerEventHandler(
PGPKeyServerRef inKeyServerRef,
PGPEventHandlerProcPtr * outCallback,
PGPUserValue * outUserData);
/* Canceling a call to a keyserver. This is the only call that can be made
to a keyserver that is currently in another call. Also, once you have
returned from a canceled call, you may only close the keyserver. */
PGPError PGPCancelKeyServerCall(PGPKeyServerRef inKeyServerRef);
/* Opening and closing the keyserver. A keyserver ref can be opened and
closed multiple times as necessary. */
PGPError PGPKeyServerOpen(PGPKeyServerRef inKeyServerRef,
PGPtlsSessionRef inTLSSessionRef);
PGPError PGPKeyServerClose(PGPKeyServerRef inKeyServerRef);
/* Get keyserver info. */
PGPError PGPGetKeyServerTLSSession(PGPKeyServerRef inKeyServerRef,
PGPtlsSessionRef * outTLSSessionRef);
PGPError PGPGetKeyServerProtocol(PGPKeyServerRef inKeyServerRef,
PGPKeyServerProtocol * outType);
PGPError PGPGetKeyServerAccessType(PGPKeyServerRef inKeyServerRef,
PGPKeyServerAccessType * outAccessType);
PGPError PGPGetKeyServerKeySpace(PGPKeyServerRef inKeyServerRef,
PGPKeyServerKeySpace * outKeySpace);
PGPError PGPGetKeyServerPort(PGPKeyServerRef inKeyServerRef,
PGPUInt16 * outPort);
#undef PGPGetKeyServerHostName
PGPError PGPGetKeyServerHostName(PGPKeyServerRef inKeyServerRef,
PGPChar8 ** outHostName); /* Use PGPFreeData to free */
PGPError PGPGetKeyServerAddress(PGPKeyServerRef inKeyServerRef,
PGPUInt32 * outAddress);
#undef PGPGetKeyServerPath
PGPError PGPGetKeyServerPath(PGPKeyServerRef inKeyServerRef,
PGPChar8 ** outPath); /* Use PGPFreeData to free */
PGPContextRef PGPGetKeyServerContext(PGPKeyServerRef inKeyServerRef);
/* If there was an error string returned from the server, you can get it with
this function. Note that if there is no string, the function will return
kPGPError_NoErr and *outErrorString will be NULL */
#undef PGPGetLastKeyServerErrorString
PGPError PGPGetLastKeyServerErrorString(
PGPKeyServerRef inKeyServerRef,
PGPChar8 ** outErrorString); /* Use PGPFreeData to free */
/* These functions may be used with both HTTP and LDAP keyservers */
PGPError PGPQueryKeyServer(PGPKeyServerRef inKeyServerRef,
PGPFilterRef inFilterRef,
PGPKeyDBRef *searchResultsDB);
PGPError PGPUploadToKeyServer(PGPKeyServerRef inKeyServerRef,
PGPKeySetRef inKeysToUpload,
PGPKeySetRef * outKeysThatFailed);
/* These functions may only be used with LDAP keyservers */
PGPError PGPDeleteFromKeyServer(PGPKeyServerRef inKeyServerRef,
PGPKeySetRef inKeysToDelete,
PGPKeySetRef * outKeysThatFailed);
PGPError PGPDisableFromKeyServer(PGPKeyServerRef inKeyServerRef,
PGPKeySetRef inKeysToDisable,
PGPKeySetRef * outKeysThatFailed);
PGPError PGPSendGroupsToServer(PGPKeyServerRef inKeyServerRef,
PGPGroupSetRef inGroupSetRef);
PGPError PGPRetrieveGroupsFromServer(
PGPKeyServerRef inKeyServerRef,
PGPGroupSetRef * outGroupSetRef);
PGPError PGPNewServerMonitor(PGPKeyServerRef inKeyServerRef,
PGPKeyServerMonitor ** outMonitor);
PGPError PGPFreeServerMonitor(PGPKeyServerMonitor * inMonitor);
/* X.509 Certificate Request functions */
PGPError PGPSendCertificateRequest(
PGPKeyServerRef inKeyServerRef,
PGPOptionListRef firstOption,
... );
PGPError PGPRetrieveCertificate(
PGPKeyServerRef inKeyServerRef,
PGPOptionListRef firstOption,
... );
PGPError PGPRetrieveCertificateRevocationList(
PGPKeyServerRef inKeyServerRef,
PGPOptionListRef firstOption,
... );
/* Queries HTTP proxy information. proxyAddress must be freed with PGPFreeData */
#undef PGPGetProxyServer
PGPError PGPGetProxyServer(
PGPContextRef context, PGPProxyServerType type,
PGPChar8 **proxyAddress, PGPUInt16 *proxyPort );
PGP_END_C_DECLARATIONS
#endif
|
