python: Fix skipping tests if running with GnuPG < 2.1.12.
[gpgme.git] / lang / python / tests / t-callbacks.py
1 #!/usr/bin/env python
2
3 # Copyright (C) 2016 g10 Code GmbH
4 #
5 # This file is part of GPGME.
6 #
7 # GPGME is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
11 #
12 # GPGME is distributed in the hope that it will be useful, but WITHOUT
13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
15 # Public License for more details.
16 #
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this program; if not, see <http://www.gnu.org/licenses/>.
19
20 from __future__ import absolute_import, print_function, unicode_literals
21 del absolute_import, print_function, unicode_literals
22
23 import os
24 import gpg
25 import support
26 _ = support # to appease pyflakes.
27
28 c = gpg.Context()
29 c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
30
31 source = gpg.Data("Hallo Leute\n")
32 sink = gpg.Data()
33
34 # Valid passphrases, both as string and bytes.
35 for passphrase in ('foo', b'foo'):
36     def passphrase_cb(hint, desc, prev_bad, hook=None):
37         assert hook == passphrase
38         return hook
39
40     c.set_passphrase_cb(passphrase_cb, passphrase)
41     c.op_encrypt([], 0, source, sink)
42
43 # Returning an invalid type.
44 def passphrase_cb(hint, desc, prev_bad, hook=None):
45     return 0
46
47 c.set_passphrase_cb(passphrase_cb, None)
48 try:
49     c.op_encrypt([], 0, source, sink)
50 except Exception as e:
51     assert type(e) == TypeError
52     assert str(e) == "expected str or bytes from passphrase callback, got int"
53 else:
54     assert False, "Expected an error, got none"
55
56 # Raising an exception inside callback.
57 myException = Exception()
58 def passphrase_cb(hint, desc, prev_bad, hook=None):
59     raise myException
60
61 c.set_passphrase_cb(passphrase_cb, None)
62 try:
63     c.op_encrypt([], 0, source, sink)
64 except Exception as e:
65     assert e == myException
66 else:
67     assert False, "Expected an error, got none"
68
69 # Wrong kind of callback function.
70 def bad_passphrase_cb():
71     pass
72
73 c.set_passphrase_cb(bad_passphrase_cb, None)
74 try:
75     c.op_encrypt([], 0, source, sink)
76 except Exception as e:
77     assert type(e) == TypeError
78 else:
79     assert False, "Expected an error, got none"
80
81
82
83 # Test the progress callback.
84 parms = """<GnupgKeyParms format="internal">
85 Key-Type: RSA
86 Key-Length: 1024
87 Name-Real: Joe Tester
88 Name-Comment: with stupid passphrase
89 Name-Email: joe+gpg@example.org
90 Passphrase: Crypt0R0cks
91 Expire-Date: 2020-12-31
92 </GnupgKeyParms>
93 """
94
95 messages = []
96 def progress_cb(what, typ, current, total, hook=None):
97     assert hook == messages
98     messages.append(
99         "PROGRESS UPDATE: what = {}, type = {}, current = {}, total = {}"
100         .format(what, typ, current, total))
101
102 c = gpg.Context()
103 c.set_progress_cb(progress_cb, messages)
104 c.op_genkey(parms, None, None)
105 assert len(messages) > 0
106
107 # Test exception handling.
108 def progress_cb(what, typ, current, total, hook=None):
109     raise myException
110
111 c = gpg.Context()
112 c.set_progress_cb(progress_cb, None)
113 try:
114     c.op_genkey(parms, None, None)
115 except Exception as e:
116     assert e == myException
117 else:
118     assert False, "Expected an error, got none"
119
120
121 # Test the edit callback.
122 c = gpg.Context()
123 c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
124 c.set_passphrase_cb(lambda *args: "abc")
125 sink = gpg.Data()
126 alpha = c.get_key("A0FF4590BB6122EDEF6E3C542D727CC768697734", False)
127
128 cookie = object()
129 edit_cb_called = False
130 def edit_cb(status, args, hook):
131     global edit_cb_called
132     edit_cb_called = True
133     assert hook == cookie
134     return "quit" if args == "keyedit.prompt" else None
135 c.op_edit(alpha, edit_cb, cookie, sink)
136 assert edit_cb_called
137
138 # Test exceptions.
139 c = gpg.Context()
140 c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
141 c.set_passphrase_cb(lambda *args: "abc")
142 sink = gpg.Data()
143
144 def edit_cb(status, args):
145     raise myException
146 try:
147     c.op_edit(alpha, edit_cb, None, sink)
148 except Exception as e:
149     assert e == myException
150 else:
151     assert False, "Expected an error, got none"
152
153
154
155 # Test the status callback.
156 source = gpg.Data("Hallo Leute\n")
157 sink = gpg.Data()
158
159 status_cb_called = False
160 def status_cb(keyword, args, hook=None):
161     global status_cb_called
162     status_cb_called = True
163     assert hook == cookie
164
165 c = gpg.Context()
166 c.set_status_cb(status_cb, cookie)
167 c.set_ctx_flag("full-status", "1")
168 c.op_encrypt([alpha], gpg.constants.ENCRYPT_ALWAYS_TRUST, source, sink)
169 assert status_cb_called
170
171 # Test exceptions.
172 source = gpg.Data("Hallo Leute\n")
173 sink = gpg.Data()
174
175 def status_cb(keyword, args):
176     raise myException
177
178 c = gpg.Context()
179 c.set_status_cb(status_cb, None)
180 c.set_ctx_flag("full-status", "1")
181 try:
182     c.op_encrypt([alpha], gpg.constants.ENCRYPT_ALWAYS_TRUST, source, sink)
183 except Exception as e:
184     assert e == myException
185 else:
186     assert False, "Expected an error, got none"
187
188
189
190 # Test the data callbacks.
191 def read_cb(amount, hook=None):
192     assert hook == cookie
193     return 0
194 def release_cb(hook=None):
195     assert hook == cookie
196 data = gpg.Data(cbs=(read_cb, None, None, release_cb, cookie))
197 try:
198     data.read()
199 except Exception as e:
200     assert type(e) == TypeError
201 else:
202     assert False, "Expected an error, got none"
203
204 def read_cb(amount):
205     raise myException
206 data = gpg.Data(cbs=(read_cb, None, None, lambda: None))
207 try:
208     data.read()
209 except Exception as e:
210     assert e == myException
211 else:
212     assert False, "Expected an error, got none"
213
214
215 def write_cb(what, hook=None):
216     assert hook == cookie
217     return "wrong type"
218 data = gpg.Data(cbs=(None, write_cb, None, release_cb, cookie))
219 try:
220     data.write(b'stuff')
221 except Exception as e:
222     assert type(e) == TypeError
223 else:
224     assert False, "Expected an error, got none"
225
226 def write_cb(what):
227     raise myException
228 data = gpg.Data(cbs=(None, write_cb, None, lambda: None))
229 try:
230     data.write(b'stuff')
231 except Exception as e:
232     assert e == myException
233 else:
234     assert False, "Expected an error, got none"
235
236
237 def seek_cb(offset, whence, hook=None):
238     assert hook == cookie
239     return "wrong type"
240 data = gpg.Data(cbs=(None, None, seek_cb, release_cb, cookie))
241 try:
242     data.seek(0, os.SEEK_SET)
243 except Exception as e:
244     assert type(e) == TypeError
245 else:
246     assert False, "Expected an error, got none"
247
248 def seek_cb(offset, whence):
249     raise myException
250 data = gpg.Data(cbs=(None, None, seek_cb, lambda: None))
251 try:
252     data.seek(0, os.SEEK_SET)
253 except Exception as e:
254     assert e == myException
255 else:
256     assert False, "Expected an error, got none"