Blame lang/python/tests/t-callbacks.py

Packit d7e8d0
#!/usr/bin/env python
Packit d7e8d0
Packit d7e8d0
# Copyright (C) 2016 g10 Code GmbH
Packit d7e8d0
#
Packit d7e8d0
# This file is part of GPGME.
Packit d7e8d0
#
Packit d7e8d0
# GPGME is free software; you can redistribute it and/or modify it
Packit d7e8d0
# under the terms of the GNU General Public License as published by
Packit d7e8d0
# the Free Software Foundation; either version 2 of the License, or
Packit d7e8d0
# (at your option) any later version.
Packit d7e8d0
#
Packit d7e8d0
# GPGME is distributed in the hope that it will be useful, but WITHOUT
Packit d7e8d0
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
Packit d7e8d0
# or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
Packit d7e8d0
# Public License for more details.
Packit d7e8d0
#
Packit d7e8d0
# You should have received a copy of the GNU Lesser General Public
Packit d7e8d0
# License along with this program; if not, see <http://www.gnu.org/licenses/>.
Packit d7e8d0
Packit d7e8d0
from __future__ import absolute_import, print_function, unicode_literals
Packit d7e8d0
del absolute_import, print_function, unicode_literals
Packit d7e8d0
Packit d7e8d0
import os
Packit d7e8d0
import gpg
Packit d7e8d0
import support
Packit d7e8d0
_ = support # to appease pyflakes.
Packit d7e8d0
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
Packit d7e8d0
Packit d7e8d0
source = gpg.Data("Hallo Leute\n")
Packit d7e8d0
sink = gpg.Data()
Packit d7e8d0
Packit d7e8d0
# Valid passphrases, both as string and bytes.
Packit d7e8d0
for passphrase in ('foo', b'foo'):
Packit d7e8d0
    def passphrase_cb(hint, desc, prev_bad, hook=None):
Packit d7e8d0
        assert hook == passphrase
Packit d7e8d0
        return hook
Packit d7e8d0
Packit d7e8d0
    c.set_passphrase_cb(passphrase_cb, passphrase)
Packit d7e8d0
    c.op_encrypt([], 0, source, sink)
Packit d7e8d0
Packit d7e8d0
# Returning an invalid type.
Packit d7e8d0
def passphrase_cb(hint, desc, prev_bad, hook=None):
Packit d7e8d0
    return 0
Packit d7e8d0
Packit d7e8d0
c.set_passphrase_cb(passphrase_cb, None)
Packit d7e8d0
try:
Packit d7e8d0
    c.op_encrypt([], 0, source, sink)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert type(e) == TypeError
Packit d7e8d0
    assert str(e) == "expected str or bytes from passphrase callback, got int"
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
# Raising an exception inside callback.
Packit d7e8d0
myException = Exception()
Packit d7e8d0
def passphrase_cb(hint, desc, prev_bad, hook=None):
Packit d7e8d0
    raise myException
Packit d7e8d0
Packit d7e8d0
c.set_passphrase_cb(passphrase_cb, None)
Packit d7e8d0
try:
Packit d7e8d0
    c.op_encrypt([], 0, source, sink)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
# Wrong kind of callback function.
Packit d7e8d0
def bad_passphrase_cb():
Packit d7e8d0
    pass
Packit d7e8d0
Packit d7e8d0
c.set_passphrase_cb(bad_passphrase_cb, None)
Packit d7e8d0
try:
Packit d7e8d0
    c.op_encrypt([], 0, source, sink)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert type(e) == TypeError
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
# Test the progress callback.
Packit d7e8d0
parms = """<GnupgKeyParms format="internal">
Packit d7e8d0
Key-Type: RSA
Packit d7e8d0
Key-Length: 1024
Packit d7e8d0
Name-Real: Joe Tester
Packit d7e8d0
Name-Comment: with stupid passphrase
Packit d7e8d0
Name-Email: joe+gpg@example.org
Packit d7e8d0
Passphrase: Crypt0R0cks
Packit d7e8d0
Expire-Date: 2020-12-31
Packit d7e8d0
</GnupgKeyParms>
Packit d7e8d0
"""
Packit d7e8d0
Packit d7e8d0
messages = []
Packit d7e8d0
def progress_cb(what, typ, current, total, hook=None):
Packit d7e8d0
    assert hook == messages
Packit d7e8d0
    messages.append(
Packit d7e8d0
        "PROGRESS UPDATE: what = {}, type = {}, current = {}, total = {}"
Packit d7e8d0
        .format(what, typ, current, total))
Packit d7e8d0
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_progress_cb(progress_cb, messages)
Packit d7e8d0
c.op_genkey(parms, None, None)
Packit d7e8d0
assert len(messages) > 0
Packit d7e8d0
Packit d7e8d0
# Test exception handling.
Packit d7e8d0
def progress_cb(what, typ, current, total, hook=None):
Packit d7e8d0
    raise myException
Packit d7e8d0
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_progress_cb(progress_cb, None)
Packit d7e8d0
try:
Packit d7e8d0
    c.op_genkey(parms, None, None)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
# Test the edit callback.
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
Packit d7e8d0
c.set_passphrase_cb(lambda *args: "abc")
Packit d7e8d0
sink = gpg.Data()
Packit d7e8d0
alpha = c.get_key("A0FF4590BB6122EDEF6E3C542D727CC768697734", False)
Packit d7e8d0
Packit d7e8d0
cookie = object()
Packit d7e8d0
edit_cb_called = False
Packit d7e8d0
def edit_cb(status, args, hook):
Packit d7e8d0
    global edit_cb_called
Packit d7e8d0
    edit_cb_called = True
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
    return "quit" if args == "keyedit.prompt" else None
Packit d7e8d0
c.op_edit(alpha, edit_cb, cookie, sink)
Packit d7e8d0
assert edit_cb_called
Packit d7e8d0
Packit d7e8d0
# Test exceptions.
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_pinentry_mode(gpg.constants.PINENTRY_MODE_LOOPBACK)
Packit d7e8d0
c.set_passphrase_cb(lambda *args: "abc")
Packit d7e8d0
sink = gpg.Data()
Packit d7e8d0
Packit d7e8d0
def edit_cb(status, args):
Packit d7e8d0
    raise myException
Packit d7e8d0
try:
Packit d7e8d0
    c.op_edit(alpha, edit_cb, None, sink)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
# Test the status callback.
Packit d7e8d0
source = gpg.Data("Hallo Leute\n")
Packit d7e8d0
sink = gpg.Data()
Packit d7e8d0
Packit d7e8d0
status_cb_called = False
Packit d7e8d0
def status_cb(keyword, args, hook=None):
Packit d7e8d0
    global status_cb_called
Packit d7e8d0
    status_cb_called = True
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_status_cb(status_cb, cookie)
Packit d7e8d0
c.set_ctx_flag("full-status", "1")
Packit d7e8d0
c.op_encrypt([alpha], gpg.constants.ENCRYPT_ALWAYS_TRUST, source, sink)
Packit d7e8d0
assert status_cb_called
Packit d7e8d0
Packit d7e8d0
# Test exceptions.
Packit d7e8d0
source = gpg.Data("Hallo Leute\n")
Packit d7e8d0
sink = gpg.Data()
Packit d7e8d0
Packit d7e8d0
def status_cb(keyword, args):
Packit d7e8d0
    raise myException
Packit d7e8d0
Packit d7e8d0
c = gpg.Context()
Packit d7e8d0
c.set_status_cb(status_cb, None)
Packit d7e8d0
c.set_ctx_flag("full-status", "1")
Packit d7e8d0
try:
Packit d7e8d0
    c.op_encrypt([alpha], gpg.constants.ENCRYPT_ALWAYS_TRUST, source, sink)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
# Test the data callbacks.
Packit d7e8d0
def read_cb(amount, hook=None):
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
    return 0
Packit d7e8d0
def release_cb(hook=None):
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
data = gpg.Data(cbs=(read_cb, None, None, release_cb, cookie))
Packit d7e8d0
try:
Packit d7e8d0
    data.read()
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert type(e) == TypeError
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
def read_cb(amount):
Packit d7e8d0
    raise myException
Packit d7e8d0
data = gpg.Data(cbs=(read_cb, None, None, lambda: None))
Packit d7e8d0
try:
Packit d7e8d0
    data.read()
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
def write_cb(what, hook=None):
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
    return "wrong type"
Packit d7e8d0
data = gpg.Data(cbs=(None, write_cb, None, release_cb, cookie))
Packit d7e8d0
try:
Packit d7e8d0
    data.write(b'stuff')
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert type(e) == TypeError
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
def write_cb(what):
Packit d7e8d0
    raise myException
Packit d7e8d0
data = gpg.Data(cbs=(None, write_cb, None, lambda: None))
Packit d7e8d0
try:
Packit d7e8d0
    data.write(b'stuff')
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
Packit d7e8d0
def seek_cb(offset, whence, hook=None):
Packit d7e8d0
    assert hook == cookie
Packit d7e8d0
    return "wrong type"
Packit d7e8d0
data = gpg.Data(cbs=(None, None, seek_cb, release_cb, cookie))
Packit d7e8d0
try:
Packit d7e8d0
    data.seek(0, os.SEEK_SET)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert type(e) == TypeError
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"
Packit d7e8d0
Packit d7e8d0
def seek_cb(offset, whence):
Packit d7e8d0
    raise myException
Packit d7e8d0
data = gpg.Data(cbs=(None, None, seek_cb, lambda: None))
Packit d7e8d0
try:
Packit d7e8d0
    data.seek(0, os.SEEK_SET)
Packit d7e8d0
except Exception as e:
Packit d7e8d0
    assert e == myException
Packit d7e8d0
else:
Packit d7e8d0
    assert False, "Expected an error, got none"