python: Fix writing to data buffers.
[gpgme.git] / lang / python / pyme / core.py
1 # $Id$
2 # Copyright (C) 2004,2008 Igor Belyi <belyi@users.sourceforge.net>
3 # Copyright (C) 2002 John Goerzen <jgoerzen@complete.org>
4 #
5 #    This library is free software; you can redistribute it and/or
6 #    modify it under the terms of the GNU Lesser General Public
7 #    License as published by the Free Software Foundation; either
8 #    version 2.1 of the License, or (at your option) any later version.
9 #
10 #    This library is distributed in the hope that it will be useful,
11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 #    Lesser General Public License for more details.
14 #
15 #    You should have received a copy of the GNU Lesser General Public
16 #    License along with this library; if not, write to the Free Software
17 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
18
19 # import generators for portability with python2.2
20
21
22 from . import pygpgme
23 from .errors import errorcheck
24 from . import errors
25 from .util import GpgmeWrapper
26
27 class Context(GpgmeWrapper):
28     """From the GPGME C documentation:
29
30     * All cryptographic operations in GPGME are performed within a
31     * context, which contains the internal state of the operation as well as
32     * configuration parameters.  By using several contexts you can run
33     * several cryptographic operations in parallel, with different
34     * configuration.
35
36     Thus, this is the place that you will usually start."""
37
38     def _getctype(self):
39         return 'gpgme_ctx_t'
40
41     def _getnameprepend(self):
42         return 'gpgme_'
43
44     def _errorcheck(self, name):
45         """This function should list all functions returning gpgme_error_t"""
46         if (name.startswith('gpgme_op_') and \
47             not name.endswith('_result')) or \
48             name == 'gpgme_signers_add' or \
49             name == 'gpgme_set_locale' or \
50             name == 'gpgme_set_keylist_mode' or \
51             name == 'gpgme_set_protocol':
52             return 1
53         return 0
54
55     def __init__(self, wrapped=None):
56         if wrapped:
57             self.wrapped = wrapped
58             self.own = False
59         else:
60             tmp = pygpgme.new_gpgme_ctx_t_p()
61             errorcheck(pygpgme.gpgme_new(tmp))
62             self.wrapped = pygpgme.gpgme_ctx_t_p_value(tmp)
63             pygpgme.delete_gpgme_ctx_t_p(tmp)
64             self.own = True
65         self.last_passcb = None
66         self.last_progresscb = None
67
68     def __del__(self):
69         if not pygpgme:
70             # At interpreter shutdown, pygpgme is set to NONE.
71             return
72
73         self._free_passcb()
74         self._free_progresscb()
75         if self.own and pygpgme.gpgme_release:
76             pygpgme.gpgme_release(self.wrapped)
77
78     def _free_passcb(self):
79         if self.last_passcb != None:
80             if pygpgme.pygpgme_clear_generic_cb:
81                 pygpgme.pygpgme_clear_generic_cb(self.last_passcb)
82             if pygpgme.delete_PyObject_p_p:
83                 pygpgme.delete_PyObject_p_p(self.last_passcb)
84             self.last_passcb = None
85
86     def _free_progresscb(self):
87         if self.last_progresscb != None:
88             if pygpgme.pygpgme_clear_generic_cb:
89                 pygpgme.pygpgme_clear_generic_cb(self.last_progresscb)
90             if pygpgme.delete_PyObject_p_p:
91                 pygpgme.delete_PyObject_p_p(self.last_progresscb)
92             self.last_progresscb = None
93
94     def op_keylist_all(self, *args, **kwargs):
95         self.op_keylist_start(*args, **kwargs)
96         key = self.op_keylist_next()
97         while key:
98             yield key
99             key = self.op_keylist_next()
100
101     def op_keylist_next(self):
102         """Returns the next key in the list created
103         by a call to op_keylist_start().  The object returned
104         is of type Key."""
105         ptr = pygpgme.new_gpgme_key_t_p()
106         try:
107             errorcheck(pygpgme.gpgme_op_keylist_next(self.wrapped, ptr))
108             key = pygpgme.gpgme_key_t_p_value(ptr)
109         except errors.GPGMEError as excp:
110             key = None
111             if excp.getcode() != errors.EOF:
112                 raise excp
113         pygpgme.delete_gpgme_key_t_p(ptr)
114         if key:
115             key.__del__ = lambda self: pygpgme.gpgme_key_unref(self)
116             return key
117
118     def get_key(self, fpr, secret):
119         """Return the key corresponding to the fingerprint 'fpr'"""
120         ptr = pygpgme.new_gpgme_key_t_p()
121         errorcheck(pygpgme.gpgme_get_key(self.wrapped, fpr, ptr, secret))
122         key = pygpgme.gpgme_key_t_p_value(ptr)
123         pygpgme.delete_gpgme_key_t_p(ptr)
124         if key:
125             key.__del__ = lambda self: pygpgme.gpgme_key_unref(self)
126             return key
127
128     def op_trustlist_all(self, *args, **kwargs):
129         self.op_trustlist_start(*args, **kwargs)
130         trust = self.ctx.op_trustlist_next()
131         while trust:
132             yield trust
133             trust = self.ctx.op_trustlist_next()
134
135     def op_trustlist_next(self):
136         """Returns the next trust item in the list created
137         by a call to op_trustlist_start().  The object returned
138         is of type TrustItem."""
139         ptr = pygpgme.new_gpgme_trust_item_t_p()
140         try:
141             errorcheck(pygpgme.gpgme_op_trustlist_next(self.wrapped, ptr))
142             trust = pygpgme.gpgme_trust_item_t_p_value(ptr)
143         except errors.GPGMEError as excp:
144             trust = None
145             if excp.getcode() != errors.EOF:
146                 raise
147         pygpgme.delete_gpgme_trust_item_t_p(ptr)
148         return trust
149
150     def set_passphrase_cb(self, func, hook=None):
151         """Sets the passphrase callback to the function specified by func.
152
153         When the system needs a passphrase, it will call func with three args:
154         hint, a string describing the key it needs the passphrase for;
155         desc, a string describing the passphrase it needs;
156         prev_bad, a boolean equal True if this is a call made after
157         unsuccessful previous attempt.
158
159         If hook has a value other than None it will be passed into the func
160         as a forth argument.
161
162         Please see the GPGME manual for more information.
163         """
164         self._free_passcb()
165         if func == None:
166             hookdata = None
167         else:
168             self.last_passcb = pygpgme.new_PyObject_p_p()
169             if hook == None:
170                 hookdata = func
171             else:
172                 hookdata = (func, hook)
173         pygpgme.pygpgme_set_passphrase_cb(self.wrapped, hookdata, self.last_passcb)
174
175     def set_progress_cb(self, func, hook=None):
176         """Sets the progress meter callback to the function specified by
177
178         This function will be called to provide an interactive update of
179         the system's progress.
180
181         Please see the GPGME manual for more information."""
182         self._free_progresscb()
183         if func == None:
184             hookdata = None
185         else:
186             self.last_progresscb = pygpgme.new_PyObject_p_p()
187             if hook == None:
188                 hookdata = func
189             else:
190                 hookdata = (func, hook)
191         pygpgme.pygpgme_set_progress_cb(self.wrapped, hookdata, self.last_progresscb)
192
193     def get_engine_info(self):
194         """Returns this context specific engine info"""
195         return pygpgme.gpgme_ctx_get_engine_info(self.wrapped)
196
197     def set_engine_info(self, proto, file_name, home_dir=None):
198         """Changes the configuration of the crypto engine implementing the
199     protocol 'proto' for the context. 'file_name' is the file name of
200     the executable program implementing this protocol. 'home_dir' is the
201     directory name of the configuration directory (engine's default is
202     used if omitted)."""
203         errorcheck(pygpgme.gpgme_ctx_set_engine_info(self.wrapped, proto, file_name, home_dir))
204
205     def wait(self, hang):
206         """Wait for asynchronous call to finish. Wait forever if hang is True
207
208         Return:
209             On an async call completion its return status.
210             On timeout - None.
211
212         Please read the GPGME manual for more information."""
213         ptr = pygpgme.new_gpgme_error_t_p()
214         context = pygpgme.gpgme_wait(self.wrapped, ptr, hang)
215         status = pygpgme.gpgme_error_t_p_value(ptr)
216         pygpgme.delete_gpgme_error_t_p(ptr)
217
218         if context == None:
219             errorcheck(status)
220             return None
221         else:
222             return status
223
224     def op_edit(self, key, func, fnc_value, out):
225         """Start key editing using supplied callback function"""
226         if key == None:
227             raise ValueError("op_edit: First argument cannot be None")
228         opaquedata = (func, fnc_value)
229         errorcheck(pygpgme.gpgme_op_edit(self.wrapped, key, opaquedata, out))
230
231 class Data(GpgmeWrapper):
232     """From the GPGME C manual:
233
234 * A lot of data has to be exchanged between the user and the crypto
235 * engine, like plaintext messages, ciphertext, signatures and information
236 * about the keys.  The technical details about exchanging the data
237 * information are completely abstracted by GPGME.  The user provides and
238 * receives the data via `gpgme_data_t' objects, regardless of the
239 * communication protocol between GPGME and the crypto engine in use.
240
241         This Data class is the implementation of the GpgmeData objects.
242
243         Please see the information about __init__ for instantiation."""
244
245     def _getctype(self):
246         return 'gpgme_data_t'
247
248     def _getnameprepend(self):
249         return 'gpgme_data_'
250
251     def _errorcheck(self, name):
252         """This function should list all functions returning gpgme_error_t"""
253         if name == 'gpgme_data_release_and_get_mem' or \
254                name == 'gpgme_data_get_encoding' or \
255                name == 'gpgme_data_seek':
256             return 0
257         return 1
258
259     def __init__(self, string = None, file = None, offset = None,
260                  length = None, cbs = None):
261         """Initialize a new gpgme_data_t object.
262
263         If no args are specified, make it an empty object.
264
265         If string alone is specified, initialize it with the data
266         contained there.
267
268         If file, offset, and length are all specified, file must
269         be either a filename or a file-like object, and the object
270         will be initialized by reading the specified chunk from the file.
271
272         If cbs is specified, it MUST be a tuple of the form:
273
274         ((read_cb, write_cb, seek_cb, release_cb), hook)
275
276         where func is a callback function taking two arguments (count,
277         hook) and returning a string of read data, or None on EOF.
278         This will supply the read() method for the system.
279
280         If file is specified without any other arguments, then
281         it must be a filename, and the object will be initialized from
282         that file.
283
284         Any other use will result in undefined or erroneous behavior."""
285         self.wrapped = None
286         self.last_readcb = None
287
288         if cbs != None:
289             self.new_from_cbs(*cbs)
290         elif string != None:
291             self.new_from_mem(string)
292         elif file != None and offset != None and length != None:
293             self.new_from_filepart(file, offset, length)
294         elif file != None:
295             if type(file) == type("x"):
296                 self.new_from_file(file)
297             else:
298                 self.new_from_fd(file)
299         else:
300             self.new()
301
302     def __del__(self):
303         if not pygpgme:
304             # At interpreter shutdown, pygpgme is set to NONE.
305             return
306
307         if self.wrapped != None and pygpgme.gpgme_data_release:
308             pygpgme.gpgme_data_release(self.wrapped)
309         self._free_readcb()
310
311     def _free_readcb(self):
312         if self.last_readcb != None:
313             if pygpgme.pygpgme_clear_generic_cb:
314                 pygpgme.pygpgme_clear_generic_cb(self.last_readcb)
315             if pygpgme.delete_PyObject_p_p:
316                 pygpgme.delete_PyObject_p_p(self.last_readcb)
317             self.last_readcb = None
318
319     def new(self):
320         tmp = pygpgme.new_gpgme_data_t_p()
321         errorcheck(pygpgme.gpgme_data_new(tmp))
322         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
323         pygpgme.delete_gpgme_data_t_p(tmp)
324
325     def new_from_mem(self, string, copy = 1):
326         tmp = pygpgme.new_gpgme_data_t_p()
327         errorcheck(pygpgme.gpgme_data_new_from_mem(tmp,string,len(string),copy))
328         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
329         pygpgme.delete_gpgme_data_t_p(tmp)
330
331     def new_from_file(self, filename, copy = 1):
332         tmp = pygpgme.new_gpgme_data_t_p()
333         errorcheck(pygpgme.gpgme_data_new_from_file(tmp, filename, copy))
334         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
335         pygpgme.delete_gpgme_data_t_p(tmp)
336
337     def new_from_cbs(self, funcs, hook):
338         """Argument funcs must be a 4 element tuple with callbacks:
339         (read_cb, write_cb, seek_cb, release_cb)"""
340         tmp = pygpgme.new_gpgme_data_t_p()
341         self._free_readcb()
342         self.last_readcb = pygpgme.new_PyObject_p_p()
343         hookdata = (funcs, hook)
344         pygpgme.pygpgme_data_new_from_cbs(tmp, hookdata, self.last_readcb)
345         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
346         pygpgme.delete_gpgme_data_t_p(tmp)
347
348     def new_from_filepart(self, file, offset, length):
349         """This wraps the GPGME gpgme_data_new_from_filepart() function.
350         The argument "file" may be:
351
352         1. a string specifying a file name, or
353         3. a a file-like object. supporting the fileno() call and the mode
354            attribute."""
355
356         tmp = pygpgme.new_gpgme_data_t_p()
357         filename = None
358         fp = None
359
360         if type(file) == type("x"):
361             filename = file
362         else:
363             fp = pygpgme.fdopen(file.fileno(), file.mode)
364             if fp == None:
365                 raise ValueError("Failed to open file from %s arg %s" % \
366                       (str(type(file)), str(file)))
367
368         errorcheck(pygpgme.gpgme_data_new_from_filepart(tmp, filename, fp,
369                                                       offset, length))
370         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
371         pygpgme.delete_gpgme_data_t_p(tmp)
372
373     def new_from_fd(self, file):
374         """This wraps the GPGME gpgme_data_new_from_fd() function.
375         The argument "file" may be a file-like object, supporting the fileno()
376         call and the mode attribute."""
377
378         tmp = pygpgme.new_gpgme_data_t_p()
379         fp = pygpgme.fdopen(file.fileno(), file.mode)
380         if fp == None:
381             raise ValueError("Failed to open file from %s arg %s" % \
382                   (str(type(file)), str(file)))
383         errorcheck(pygpgme.gpgme_data_new_from_fd(tmp, fp))
384         self.wrapped = pygpgme.gpgme_data_t_p_value(tmp)
385         pygpgme.delete_gpgme_data_t_p(tmp)
386
387     def new_from_stream(self, file):
388         """This wrap around gpgme_data_new_from_stream is an alias for
389         new_from_fd() method since in python there's not difference
390         between file stream and file descriptor"""
391         self.new_from_fd(file)
392
393     def write(self, buffer):
394         """Write buffer given as string or bytes.
395
396         If a string is given, it is implicitly encoded using UTF-8."""
397         return pygpgme.gpgme_data_write(self.wrapped, buffer)
398
399     def read(self, size = -1):
400         """Read at most size bytes, returned as bytes.
401
402         If the size argument is negative or omitted, read until EOF is reached.
403
404         Returns the data read, or the empty string if there was no data
405         to read before EOF was reached."""
406
407         if size == 0:
408             return ''
409
410         if size > 0:
411             return pygpgme.gpgme_data_read(self.wrapped, size)
412         else:
413             chunks = []
414             while 1:
415                 result = pygpgme.gpgme_data_read(self.wrapped, 4096)
416                 if len(result) == 0:
417                     break
418                 chunks.append(result)
419             return b''.join(chunks)
420
421 def pubkey_algo_name(algo):
422     return pygpgme.gpgme_pubkey_algo_name(algo)
423
424 def hash_algo_name(algo):
425     return pygpgme.gpgme_hash_algo_name(algo)
426
427 def get_protocol_name(proto):
428     return pygpgme.gpgme_get_protocol_name(proto)
429
430 def check_version(version=None):
431     return pygpgme.gpgme_check_version(version)
432
433 def engine_check_version (proto):
434     try:
435         errorcheck(pygpgme.gpgme_engine_check_version(proto))
436         return True
437     except errors.GPGMEError:
438         return False
439
440 def get_engine_info():
441     ptr = pygpgme.new_gpgme_engine_info_t_p()
442     try:
443         errorcheck(pygpgme.gpgme_get_engine_info(ptr))
444         info = pygpgme.gpgme_engine_info_t_p_value(ptr)
445     except errors.GPGMEError:
446         info = None
447     pygpgme.delete_gpgme_engine_info_t_p(ptr)
448     return info
449
450 def set_engine_info(proto, file_name, home_dir=None):
451     """Changes the default configuration of the crypto engine implementing
452     the protocol 'proto'. 'file_name' is the file name of
453     the executable program implementing this protocol. 'home_dir' is the
454     directory name of the configuration directory (engine's default is
455     used if omitted)."""
456     errorcheck(pygpgme.gpgme_set_engine_info(proto, file_name, home_dir))
457
458 def set_locale(category, value):
459     """Sets the default locale used by contexts"""
460     errorcheck(pygpgme.gpgme_set_locale(None, category, value))
461
462 def wait(hang):
463     """Wait for asynchronous call on any Context  to finish.
464     Wait forever if hang is True.
465
466     For finished anynch calls it returns a tuple (status, context):
467         status  - status return by asnynchronous call.
468         context - context which caused this call to return.
469
470     Please read the GPGME manual of more information."""
471     ptr = pygpgme.new_gpgme_error_t_p()
472     context = pygpgme.gpgme_wait(None, ptr, hang)
473     status = pygpgme.gpgme_error_t_p_value(ptr)
474     pygpgme.delete_gpgme_error_t_p(ptr)
475     if context == None:
476         errorcheck(status)
477     else:
478         context = Context(context)
479     return (status, context)
480